-
-
Notifications
You must be signed in to change notification settings - Fork 31
/
linkfile.h
100 lines (83 loc) · 2.95 KB
/
linkfile.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
/** @file linkfile.h Symbolic link.
*
* @authors Copyright (c) 2014 Jaakko Keränen <jaakko.keranen@iki.fi>
*
* @par License
* LGPL: http://www.gnu.org/licenses/lgpl.html
*
* <small>This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation; either version 3 of the License, or (at your
* option) any later version. This program is distributed in the hope that it
* will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty
* of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser
* General Public License for more details. You should have received a copy of
* the GNU Lesser General Public License along with this program; if not, see:
* http://www.gnu.org/licenses</small>
*/
#ifndef LIBDENG2_LINKFILE_H
#define LIBDENG2_LINKFILE_H
#include "../File"
namespace de {
/**
* Symbolic link that points to another file in the file system.
*
* Overrides the filesys::Node path navigation and child finding so that these operations
* are carried out using the folder that the link points to.
*
* @todo Currently only supports links to folders, not to individual files. Linking to
* files would require refactoring filesys::Node and File so that more functionality is
* virtualized and therefore can be redirected by LinkFile. -jk
*
* @ingroup fs
*/
class LinkFile : public File
{
public:
LinkFile(String const &name = "");
~LinkFile();
/**
* Sets the link target of this file.
*
* @param file Target file. This file will observe the target file for deletion.
*/
void setTarget(File const &file);
/**
* Returns the file's target. This is used for indirection when descending into
* subfolders, to implement symbolic links.
*
* The target is used when locating a file from a folder using a path. The
* file system index does not contain any of the apparent contents under, say,
* a linked folder.
*
* @see LinkFile
*/
File const &target() const;
/// @copydoc target()
File &target();
Folder const *targetFolder() const;
Folder *targetFolder();
/**
* Determines if the link is broken, i.e., does not point to any other file.
*/
bool isBroken() const;
String describe() const;
// filesys::Node overrides:
Node const *tryFollowPath(PathRef const &path) const;
Node const *tryGetChild(String const &name) const;
public:
/**
* Creates a new link to an existing file.
*
* @param file Target file.
* @param linkName Name of the created link file. If empty, the target file's
* name is used as the link's name.
*
* @return New LinkFile instance. Caller gets ownership.
*/
static LinkFile *newLinkToFile(File const &file, String linkName = "");
private:
DENG2_PRIVATE(d)
};
} // namespace de
#endif // LIBDENG2_LINKFILE_H