include/llvm/Support/PathV2.h

   1 //===- llvm/Support/PathV2.h - Path Operating System Concept ----*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  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
  12 // path class.
  13 //
  14 //===----------------------------------------------------------------------===//
  15
  16 #ifndef LLVM_SUPPORT_PATHV2_H
  17 #define LLVM_SUPPORT_PATHV2_H
  18
  19 #include "llvm/ADT/SmallString.h"
  20 #include "llvm/ADT/Twine.h"
  21 #include "llvm/Support/DataTypes.h"
  22 #include <iterator>
  23
  24 namespace llvm {
  25 namespace sys {
  26 namespace path {
  27
  28 /// @name Lexical Component Iterator
  29 /// @{
  30
  31 /// @brief Path iterator.
  32 ///
  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.
  40 ///
  41 /// Iteration examples. Each component is separated by ',':
  42 /// /          => /
  43 /// /foo       => /,foo
  44 /// foo/       => foo,.
  45 /// /foo/bar   => /,foo,bar
  46 /// ../        => ..,.
  47 /// C:\foo\bar => C:,/,foo,bar
  48 ///
  49 class const_iterator {
  50   StringRef Path;      //< The entire path.
  51   StringRef Component; //< The current component. Not necessarily in Path.
  52   size_t    Position;  //< The iterators current position within Path.
  53
  54   // An end iterator has Position = Path.size() + 1.
  55   friend const_iterator begin(StringRef path);
  56   friend const_iterator end(StringRef path);
  57
  58 public:
  59   typedef const StringRef value_type;
  60   typedef ptrdiff_t difference_type;
  61   typedef value_type &reference;
  62   typedef value_type *pointer;
  63   typedef std::bidirectional_iterator_tag iterator_category;
  64
  65   reference operator*() const { return Component; }
  66   pointer   operator->() const { return &Component; }
  67   const_iterator &operator++();    // preincrement
  68   const_iterator &operator++(int); // postincrement
  69   const_iterator &operator--();    // predecrement
  70   const_iterator &operator--(int); // postdecrement
  71   bool operator==(const const_iterator &RHS) const;
  72   bool operator!=(const const_iterator &RHS) const;
  73
  74   /// @brief Difference in bytes between this and RHS.
  75   ptrdiff_t operator-(const const_iterator &RHS) const;
  76 };
  77
  78 typedef std::reverse_iterator<const_iterator> reverse_iterator;
  79
  80 /// @brief Get begin iterator over \a path.
  81 /// @param path Input path.
  82 /// @returns Iterator initialized with the first component of \a path.
  83 const_iterator begin(StringRef path);
  84
  85 /// @brief Get end iterator over \a path.
  86 /// @param path Input path.
  87 /// @returns Iterator initialized to the end of \a path.
  88 const_iterator end(StringRef path);
  89
  90 /// @brief Get reverse begin iterator over \a path.
  91 /// @param path Input path.
  92 /// @returns Iterator initialized with the first reverse component of \a path.
  93 inline reverse_iterator rbegin(StringRef path) {
  94   return reverse_iterator(end(path));
  95 }
  96
  97 /// @brief Get reverse end iterator over \a path.
  98 /// @param path Input path.
  99 /// @returns Iterator initialized to the reverse end of \a path.
 100 inline reverse_iterator rend(StringRef path) {
 101   return reverse_iterator(begin(path));
 102 }
 103
 104 /// @}
 105 /// @name Lexical Modifiers
 106 /// @{
 107
 108 /// @brief Remove the last component from \a path unless it is the root dir.
 109 ///
 110 /// directory/filename.cpp => directory/
 111 /// directory/             => directory
 112 /// /                      => /
 113 ///
 114 /// @param path A path that is modified to not have a file component.
 115 void remove_filename(SmallVectorImpl<char> &path);
 116
 117 /// @brief Replace the file extension of \a path with \a extension.
 118 ///
 119 /// ./filename.cpp => ./filename.extension
 120 /// ./filename     => ./filename.extension
 121 /// ./             => ./.extension
 122 ///
 123 /// @param path A path that has its extension replaced with \a extension.
 124 /// @param extension The extension to be added. It may be empty. It may also
 125 ///                  optionally start with a '.', if it does not, one will be
 126 ///                  prepended.
 127 void replace_extension(SmallVectorImpl<char> &path, const Twine &extension);
 128
 129 /// @brief Append to path.
 130 ///
 131 /// /foo  + bar/f => /foo/bar/f
 132 /// /foo/ + bar/f => /foo/bar/f
 133 /// foo   + bar/f => foo/bar/f
 134 ///
 135 /// @param path Set to \a path + \a component.
 136 /// @param component The component to be appended to \a path.
 137 void append(SmallVectorImpl<char> &path, const Twine &a,
 138                                          const Twine &b = "",
 139                                          const Twine &c = "",
 140                                          const Twine &d = "");
 141
 142 /// @brief Append to path.
 143 ///
 144 /// /foo  + [bar,f] => /foo/bar/f
 145 /// /foo/ + [bar,f] => /foo/bar/f
 146 /// foo   + [bar,f] => foo/bar/f
 147 ///
 148 /// @param path Set to \a path + [\a begin, \a end).
 149 /// @param begin Start of components to append.
 150 /// @param end One past the end of components to append.
 151 void append(SmallVectorImpl<char> &path,
 152             const_iterator begin, const_iterator end);
 153
 154 /// @}
 155 /// @name Transforms (or some other better name)
 156 /// @{
 157
 158 /// Convert path to the native form. This is used to give paths to users and
 159 /// operating system calls in the platform's normal way. For example, on Windows
 160 /// all '/' are converted to '\'.
 161 ///
 162 /// @param path A path that is transformed to native format.
 163 /// @param result Holds the result of the transformation.
 164 void native(const Twine &path, SmallVectorImpl<char> &result);
 165
 166 /// @}
 167 /// @name Lexical Observers
 168 /// @{
 169
 170 /// @brief Get root name.
 171 ///
 172 /// //net/hello => //net
 173 /// c:/hello    => c: (on Windows, on other platforms nothing)
 174 /// /hello      => <empty>
 175 ///
 176 /// @param path Input path.
 177 /// @result The root name of \a path if it has one, otherwise "".
 178 const StringRef root_name(StringRef path);
 179
 180 /// @brief Get root directory.
 181 ///
 182 /// /goo/hello => /
 183 /// c:/hello   => /
 184 /// d/file.txt => <empty>
 185 ///
 186 /// @param path Input path.
 187 /// @result The root directory of \a path if it has one, otherwise
 188 ///               "".
 189 const StringRef root_directory(StringRef path);
 190
 191 /// @brief Get root path.
 192 ///
 193 /// Equivalent to root_name + root_directory.
 194 ///
 195 /// @param path Input path.
 196 /// @result The root path of \a path if it has one, otherwise "".
 197 const StringRef root_path(StringRef path);
 198
 199 /// @brief Get relative path.
 200 ///
 201 /// C:\hello\world => hello\world
 202 /// foo/bar        => foo/bar
 203 /// /foo/bar       => foo/bar
 204 ///
 205 /// @param path Input path.
 206 /// @result The path starting after root_path if one exists, otherwise "".
 207 const StringRef relative_path(StringRef path);
 208
 209 /// @brief Get parent path.
 210 ///
 211 /// /          => <empty>
 212 /// /foo       => /
 213 /// foo/../bar => foo/..
 214 ///
 215 /// @param path Input path.
 216 /// @result The parent path of \a path if one exists, otherwise "".
 217 const StringRef parent_path(StringRef path);
 218
 219 /// @brief Get filename.
 220 ///
 221 /// /foo.txt    => foo.txt
 222 /// .          => .
 223 /// ..         => ..
 224 /// /          => /
 225 ///
 226 /// @param path Input path.
 227 /// @result The filename part of \a path. This is defined as the last component
 228 ///         of \a path.
 229 const StringRef filename(StringRef path);
 230
 231 /// @brief Get stem.
 232 ///
 233 /// If filename contains a dot but not solely one or two dots, result is the
 234 /// substring of filename ending at (but not including) the last dot. Otherwise
 235 /// it is filename.
 236 ///
 237 /// /foo/bar.txt => bar
 238 /// /foo/bar     => bar
 239 /// /foo/.txt    => <empty>
 240 /// /foo/.       => .
 241 /// /foo/..      => ..
 242 ///
 243 /// @param path Input path.
 244 /// @result The stem of \a path.
 245 const StringRef stem(StringRef path);
 246
 247 /// @brief Get extension.
 248 ///
 249 /// If filename contains a dot but not solely one or two dots, result is the
 250 /// substring of filename starting at (and including) the last dot, and ending
 251 /// at the end of \a path. Otherwise "".
 252 ///
 253 /// /foo/bar.txt => .txt
 254 /// /foo/bar     => <empty>
 255 /// /foo/.txt    => .txt
 256 ///
 257 /// @param path Input path.
 258 /// @result The extension of \a path.
 259 const StringRef extension(StringRef path);
 260
 261 /// @brief Has root name?
 262 ///
 263 /// root_name != ""
 264 ///
 265 /// @param path Input path.
 266 /// @result True if the path has a root name, false otherwise.
 267 bool has_root_name(const Twine &path);
 268
 269 /// @brief Has root directory?
 270 ///
 271 /// root_directory != ""
 272 ///
 273 /// @param path Input path.
 274 /// @result True if the path has a root directory, false otherwise.
 275 bool has_root_directory(const Twine &path);
 276
 277 /// @brief Has root path?
 278 ///
 279 /// root_path != ""
 280 ///
 281 /// @param path Input path.
 282 /// @result True if the path has a root path, false otherwise.
 283 bool has_root_path(const Twine &path);
 284
 285 /// @brief Has relative path?
 286 ///
 287 /// relative_path != ""
 288 ///
 289 /// @param path Input path.
 290 /// @result True if the path has a relative path, false otherwise.
 291 bool has_relative_path(const Twine &path);
 292
 293 /// @brief Has parent path?
 294 ///
 295 /// parent_path != ""
 296 ///
 297 /// @param path Input path.
 298 /// @result True if the path has a parent path, false otherwise.
 299 bool has_parent_path(const Twine &path);
 300
 301 /// @brief Has filename?
 302 ///
 303 /// filename != ""
 304 ///
 305 /// @param path Input path.
 306 /// @result True if the path has a filename, false otherwise.
 307 bool has_filename(const Twine &path);
 308
 309 /// @brief Has stem?
 310 ///
 311 /// stem != ""
 312 ///
 313 /// @param path Input path.
 314 /// @result True if the path has a stem, false otherwise.
 315 bool has_stem(const Twine &path);
 316
 317 /// @brief Has extension?
 318 ///
 319 /// extension != ""
 320 ///
 321 /// @param path Input path.
 322 /// @result True if the path has a extension, false otherwise.
 323 bool has_extension(const Twine &path);
 324
 325 /// @brief Is path absolute?
 326 ///
 327 /// @param path Input path.
 328 /// @result True if the path is absolute, false if it is not.
 329 bool is_absolute(const Twine &path);
 330
 331 /// @brief Is path relative?
 332 ///
 333 /// @param path Input path.
 334 /// @result True if the path is relative, false if it is not.
 335 bool is_relative(const Twine &path);
 336
 337 } // end namespace path
 338 } // end namespace sys
 339 } // end namespace llvm
 340
 341 #endif