1 //===- llvm/Support/Path.h - Path Operating System Concept ------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file declares the llvm::sys::path namespace. It is designed after
11 // TR2/boost filesystem (v3), but modified to remove exception handling and the
14 //===----------------------------------------------------------------------===//
16 #ifndef LLVM_SUPPORT_PATH_H
17 #define LLVM_SUPPORT_PATH_H
19 #include "llvm/ADT/SmallString.h"
20 #include "llvm/ADT/Twine.h"
21 #include "llvm/Support/DataTypes.h"
28 /// @name Lexical Component Iterator
31 /// @brief Path iterator.
33 /// This is a bidirectional iterator that iterates over the individual
34 /// components in \a path. The forward traversal order is as follows:
35 /// * The root-name element, if present.
36 /// * The root-directory element, if present.
37 /// * Each successive filename element, if present.
38 /// * Dot, if one or more trailing non-root slash characters are present.
39 /// The backwards traversal order is the reverse of forward traversal.
41 /// Iteration examples. Each component is separated by ',':
46 /// /foo/bar => /,foo,bar
48 /// C:\foo\bar => C:,/,foo,bar
50 class const_iterator {
51 StringRef Path; ///< The entire path.
52 StringRef Component; ///< The current component. Not necessarily in Path.
53 size_t Position; ///< The iterators current position within Path.
55 // An end iterator has Position = Path.size() + 1.
56 friend const_iterator begin(StringRef path);
57 friend const_iterator end(StringRef path);
60 typedef const StringRef value_type;
61 typedef ptrdiff_t difference_type;
62 typedef value_type &reference;
63 typedef value_type *pointer;
64 typedef std::bidirectional_iterator_tag iterator_category;
66 reference operator*() const { return Component; }
67 pointer operator->() const { return &Component; }
68 const_iterator &operator++(); // preincrement
69 const_iterator &operator++(int); // postincrement
70 const_iterator &operator--(); // predecrement
71 const_iterator &operator--(int); // postdecrement
72 bool operator==(const const_iterator &RHS) const;
73 bool operator!=(const const_iterator &RHS) const;
75 /// @brief Difference in bytes between this and RHS.
76 ptrdiff_t operator-(const const_iterator &RHS) const;
79 typedef std::reverse_iterator<const_iterator> reverse_iterator;
81 /// @brief Get begin iterator over \a path.
82 /// @param path Input path.
83 /// @returns Iterator initialized with the first component of \a path.
84 const_iterator begin(StringRef path);
86 /// @brief Get end iterator over \a path.
87 /// @param path Input path.
88 /// @returns Iterator initialized to the end of \a path.
89 const_iterator end(StringRef path);
91 /// @brief Get reverse begin iterator over \a path.
92 /// @param path Input path.
93 /// @returns Iterator initialized with the first reverse component of \a path.
94 inline reverse_iterator rbegin(StringRef path) {
95 return reverse_iterator(end(path));
98 /// @brief Get reverse end iterator over \a path.
99 /// @param path Input path.
100 /// @returns Iterator initialized to the reverse end of \a path.
101 inline reverse_iterator rend(StringRef path) {
102 return reverse_iterator(begin(path));
106 /// @name Lexical Modifiers
109 /// @brief Remove the last component from \a path unless it is the root dir.
112 /// directory/filename.cpp => directory/
113 /// directory/ => directory
114 /// filename.cpp => <empty>
118 /// @param path A path that is modified to not have a file component.
119 void remove_filename(SmallVectorImpl<char> &path);
121 /// @brief Replace the file extension of \a path with \a extension.
124 /// ./filename.cpp => ./filename.extension
125 /// ./filename => ./filename.extension
126 /// ./ => ./.extension
129 /// @param path A path that has its extension replaced with \a extension.
130 /// @param extension The extension to be added. It may be empty. It may also
131 /// optionally start with a '.', if it does not, one will be
133 void replace_extension(SmallVectorImpl<char> &path, const Twine &extension);
135 /// @brief Append to path.
138 /// /foo + bar/f => /foo/bar/f
139 /// /foo/ + bar/f => /foo/bar/f
140 /// foo + bar/f => foo/bar/f
143 /// @param path Set to \a path + \a component.
144 /// @param a The component to be appended to \a path.
145 void append(SmallVectorImpl<char> &path, const Twine &a,
148 const Twine &d = "");
150 /// @brief Append to path.
153 /// /foo + [bar,f] => /foo/bar/f
154 /// /foo/ + [bar,f] => /foo/bar/f
155 /// foo + [bar,f] => foo/bar/f
158 /// @param path Set to \a path + [\a begin, \a end).
159 /// @param begin Start of components to append.
160 /// @param end One past the end of components to append.
161 void append(SmallVectorImpl<char> &path,
162 const_iterator begin, const_iterator end);
165 /// @name Transforms (or some other better name)
168 /// Convert path to the native form. This is used to give paths to users and
169 /// operating system calls in the platform's normal way. For example, on Windows
170 /// all '/' are converted to '\'.
172 /// @param path A path that is transformed to native format.
173 /// @param result Holds the result of the transformation.
174 void native(const Twine &path, SmallVectorImpl<char> &result);
176 /// Convert path to the native form in place. This is used to give paths to
177 /// users and operating system calls in the platform's normal way. For example,
178 /// on Windows all '/' are converted to '\'.
180 /// @param path A path that is transformed to native format.
181 void native(SmallVectorImpl<char> &path);
184 /// @name Lexical Observers
187 /// @brief Get root name.
190 /// //net/hello => //net
191 /// c:/hello => c: (on Windows, on other platforms nothing)
192 /// /hello => <empty>
195 /// @param path Input path.
196 /// @result The root name of \a path if it has one, otherwise "".
197 const StringRef root_name(StringRef path);
199 /// @brief Get root directory.
204 /// d/file.txt => <empty>
207 /// @param path Input path.
208 /// @result The root directory of \a path if it has one, otherwise
210 const StringRef root_directory(StringRef path);
212 /// @brief Get root path.
214 /// Equivalent to root_name + root_directory.
216 /// @param path Input path.
217 /// @result The root path of \a path if it has one, otherwise "".
218 const StringRef root_path(StringRef path);
220 /// @brief Get relative path.
223 /// C:\hello\world => hello\world
224 /// foo/bar => foo/bar
225 /// /foo/bar => foo/bar
228 /// @param path Input path.
229 /// @result The path starting after root_path if one exists, otherwise "".
230 const StringRef relative_path(StringRef path);
232 /// @brief Get parent path.
237 /// foo/../bar => foo/..
240 /// @param path Input path.
241 /// @result The parent path of \a path if one exists, otherwise "".
242 const StringRef parent_path(StringRef path);
244 /// @brief Get filename.
247 /// /foo.txt => foo.txt
253 /// @param path Input path.
254 /// @result The filename part of \a path. This is defined as the last component
256 const StringRef filename(StringRef path);
260 /// If filename contains a dot but not solely one or two dots, result is the
261 /// substring of filename ending at (but not including) the last dot. Otherwise
265 /// /foo/bar.txt => bar
267 /// /foo/.txt => <empty>
272 /// @param path Input path.
273 /// @result The stem of \a path.
274 const StringRef stem(StringRef path);
276 /// @brief Get extension.
278 /// If filename contains a dot but not solely one or two dots, result is the
279 /// substring of filename starting at (and including) the last dot, and ending
280 /// at the end of \a path. Otherwise "".
283 /// /foo/bar.txt => .txt
284 /// /foo/bar => <empty>
285 /// /foo/.txt => .txt
288 /// @param path Input path.
289 /// @result The extension of \a path.
290 const StringRef extension(StringRef path);
292 /// @brief Check whether the given char is a path separator on the host OS.
294 /// @param value a character
295 /// @result true if \a value is a path separator character on the host OS
296 bool is_separator(char value);
298 /// @brief Get the typical temporary directory for the system, e.g.,
299 /// "/var/tmp" or "C:/TEMP"
301 /// @param erasedOnReboot Whether to favor a path that is erased on reboot
302 /// rather than one that potentially persists longer. This parameter will be
303 /// ignored if the user or system has set the typical environment variable
304 /// (e.g., TEMP on Windows, TMPDIR on *nix) to specify a temporary directory.
306 /// @param result Holds the resulting path name.
307 void system_temp_directory(bool erasedOnReboot, SmallVectorImpl<char> &result);
309 /// @brief Has root name?
313 /// @param path Input path.
314 /// @result True if the path has a root name, false otherwise.
315 bool has_root_name(const Twine &path);
317 /// @brief Has root directory?
319 /// root_directory != ""
321 /// @param path Input path.
322 /// @result True if the path has a root directory, false otherwise.
323 bool has_root_directory(const Twine &path);
325 /// @brief Has root path?
329 /// @param path Input path.
330 /// @result True if the path has a root path, false otherwise.
331 bool has_root_path(const Twine &path);
333 /// @brief Has relative path?
335 /// relative_path != ""
337 /// @param path Input path.
338 /// @result True if the path has a relative path, false otherwise.
339 bool has_relative_path(const Twine &path);
341 /// @brief Has parent path?
343 /// parent_path != ""
345 /// @param path Input path.
346 /// @result True if the path has a parent path, false otherwise.
347 bool has_parent_path(const Twine &path);
349 /// @brief Has filename?
353 /// @param path Input path.
354 /// @result True if the path has a filename, false otherwise.
355 bool has_filename(const Twine &path);
361 /// @param path Input path.
362 /// @result True if the path has a stem, false otherwise.
363 bool has_stem(const Twine &path);
365 /// @brief Has extension?
369 /// @param path Input path.
370 /// @result True if the path has a extension, false otherwise.
371 bool has_extension(const Twine &path);
373 /// @brief Is path absolute?
375 /// @param path Input path.
376 /// @result True if the path is absolute, false if it is not.
377 bool is_absolute(const Twine &path);
379 /// @brief Is path relative?
381 /// @param path Input path.
382 /// @result True if the path is relative, false if it is not.
383 bool is_relative(const Twine &path);
385 } // end namespace path
386 } // end namespace sys
387 } // end namespace llvm