Newer
Older
// -*- tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
// vi: set et ts=4 sw=2 sts=2:
#ifndef DUNE_COMMON_PATH_HH
#define DUNE_COMMON_PATH_HH
#include <string>
namespace Dune {
/**
* @addtogroup Path Filesystem Paths
* @ingroup Common
* @{
*/
/**
* @file
* @author Jö Fahlke <jorrit@jorrit.de>
*/
//! concatenate two paths
/**
* \param base The base path.
* \param p The path to concatenate onto base.
*
* If p is an absolute path, return p. Otherwise return the
* string-concatenation of base and path, possibly with a '/' in between, if
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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
* necessary.
*
* Some examples:
* <table>
* <tr><th> base </th><th> p </th><th> result </th></tr>
* <tr><td> anything </td><td> "/abs/path" </td><td> "/abs/path" </td></tr>
* <tr><td> "a" </td><td> "b" </td><td> "a/b" </td></tr>
* <tr><td> "/a" </td><td> "b" </td><td> "/a/b" </td></tr>
* <tr><td> "a/" </td><td> "b" </td><td> "a/b" </td></tr>
* <tr><td> "a" </td><td> "b/" </td><td> "a/b/" </td></tr>
* <tr><td> ".." </td><td> "b" </td><td> "../b" </td></tr>
* <tr><td> "a" </td><td> ".." </td><td> "a/.." </td></tr>
* <tr><td> "." </td><td> "b" </td><td> "./b" </td></tr>
* <tr><td> "a" </td><td> "." </td><td> "a/." </td></tr>
* <tr><td> "" </td><td> "b" </td><td> "b" </td></tr>
* <tr><td> "a" </td><td> "" </td><td> "a" </td></tr>
* <tr><td> "" </td><td> "" </td><td> "" </td></tr>
* </table>
*
* If both base and p are sanitized as per processPath(), and if p does not
* contain any leading "../", then the result will also be sanitized.
*/
std::string concatPaths(const std::string& base, const std::string& p);
//! sanitize a path for further processing
/**
* Sanitize the path as far as possible to make further processing easier.
* The resulting path has the following properties:
* <ul>
* <li> The path is a series of components, each followed by a single '/'.
* <li> An absolute path starts with an empty component followed by a '/',
* so its first charachter will be '/'. This is the only case where an
* empty component can occur.
* <li> The path does not contain any component ".". Any such component in
* the input is removed.
* <li> A ".." component may only occur in the following case: A relative
* path may contain a series of ".." in the beginning. Any other
* occurances of ".." int eh input is collapsed with a preceding
* component or simply removed if it is at the beginning of an absolute
* path.
* </ul>
*
* \note The result is really meant for processing only since it has two
* unusual properties: First, any path denoting the current directory
* in the input, such as "." will result in an empty path "". Second,
* any non-empty result path will have a trailing '/'. For other
* uses, prettyPath() may be more appropriate.
*
* Some examples:
* <table>
* <tr><th> p </th><th> result </th></tr>
* <tr><td> "" </td><td> "" </td></tr>
* <tr><td> "." </td><td> "" </td></tr>
* <tr><td> "./" </td><td> "" </td></tr>
* <tr><td> "a/.." </td><td> "" </td></tr>
* <tr><td> ".." </td><td> "../" </td></tr>
* <tr><td> "../a" </td><td> "../a/" </td></tr>
* <tr><td> "a" </td><td> "a/" </td></tr>
* <tr><td> "a//" </td><td> "a/" </td></tr>
* <tr><td> "a///b" </td><td> "a/b/" </td></tr>
* <tr><td> "/" </td><td> "/" </td></tr>
* <tr><td> "/." </td><td> "/" </td></tr>
* <tr><td> "/.." </td><td> "/" </td></tr>
* <tr><td> "/a/.." </td><td> "/" </td></tr>
* <tr><td> "/a" </td><td> "/a/" </td></tr>
* <tr><td> "/a/" </td><td> "/a/" </td></tr>
* <tr><td> "/../a/" </td><td> "/a/" </td></tr>
* </table>
*/
std::string processPath(const std::string& p);
//! check whether the given path indicates that it is a directory
/**
* In particular the following kinds of paths indicate a directory:
* <ul>
* <li> The empty path (denotes the current directory),
* <li> any path with a trailing '/',
* <li> any path whose last component is "." or "..".
* </ul>
*/
bool pathIndicatesDirectory(const std::string& p);
//! pretty print path
/**
* \param p Path to pretty-print.
* \param isDirectory Whether to append a '/' to make clear this is a
* directory.
*
* Pretty print the path. This removes any duplicate '/' and any
* superfluous occurances of ".." and ".". The resulting path will have a
* trailing '/' if it is the root path or if isDirectory is true. It will
* however not have a trailing '/' if it is otherwise clear that it is a
* directory -- i.e. if its last component is "." or "..".
*
* Some examples:
* <table>
* <tr><th> p </th><th> isDirectory </th><th> result </th></tr>
* <tr><td> "" </td><td> anything </td><td> "." </td></tr>
* <tr><td> "." </td><td> anything </td><td> "." </td></tr>
* <tr><td> "./" </td><td> anything </td><td> "." </td></tr>
* <tr><td> "a/.." </td><td> anything </td><td> "." </td></tr>
* <tr><td> ".." </td><td> anything </td><td> ".." </td></tr>
* <tr><td> "../a" </td><td> true </td><td> "../a/" </td></tr>
* <tr><td> "../a" </td><td> false </td><td> "../a" </td></tr>
* <tr><td> "a" </td><td> true </td><td> "a/" </td></tr>
* <tr><td> "a" </td><td> false </td><td> "a" </td></tr>
* <tr><td> "a//" </td><td> true </td><td> "a/" </td></tr>
* <tr><td> "a//" </td><td> false </td><td> "a" </td></tr>
* <tr><td> "a///b" </td><td> true </td><td> "a/b/" </td></tr>
* <tr><td> "a///b" </td><td> false </td><td> "a/b" </td></tr>
* <tr><td> "/" </td><td> anything </td><td> "/" </td></tr>
* <tr><td> "/." </td><td> anything </td><td> "/" </td></tr>
* <tr><td> "/.." </td><td> anything </td><td> "/" </td></tr>
* <tr><td> "/a/.." </td><td> anything </td><td> "/" </td></tr>
* <tr><td> "/a" </td><td> true </td><td> "/a/" </td></tr>
* <tr><td> "/a" </td><td> false </td><td> "/a" </td></tr>
* <tr><td> "/a/" </td><td> true </td><td> "/a/" </td></tr>
* <tr><td> "/a/" </td><td> false </td><td> "/a" </td></tr>
* <tr><td> "/../a/" </td><td> true </td><td> "/a/" </td></tr>
* <tr><td> "/../a/" </td><td> false </td><td> "/a" </td></tr>
* </table>
*/
std::string prettyPath(const std::string& p, bool isDirectory);
//! pretty print path
/**
* \param p Path to pretty-print.
*
* This is like prettyPath(const std::string& p, bool isDirectory) with
* isDirectory automatically determined using pathIndicatesDirectory(p).
*/
std::string prettyPath(const std::string& p);
//! compute a relative path between two paths
/**
* \param newbase Base path for the resulting relative path.
* \param p Path re sulting path should resolve to, when taken
* reltively to newbase.
*
* Compute a relative path from newbase to p. newbase is assumed to be a
* directory. p and newbase should either both be absolute, or both be
* relative. In the latter case they are assumed to both be relative to
* the same unspecified directory. The has the form of something sanitized
* by processPath().
*
* \throw NotImplemented The condition that newbase and p must both be
* relative or both be absolute does not hold.
* \throw NotImplemented After sanitization newbase has more leading ".."
* components than p.
*/
std::string relativePath(const std::string& newbase, const std::string& p);
/** @} group Path */
}
#endif // DUNE_COMMON_PATH_HH