// TR2/boost filesystem (v3), but modified to remove exception handling and the
// path class.
//
-// All functions return an error_code and their actual work via the last out
-// argument. The out argument is defined if and only if errc::success is
-// returned. A function may return any error code in the generic or system
-// category. However, they shall be equivalent to any error conditions listed
-// in each functions respective documentation if the condition applies. [ note:
-// this does not guarantee that error_code will be in the set of explicitly
-// listed codes, but it does guarantee that if any of the explicitly listed
-// errors occur, the correct error_code will be used ]. All functions may
-// return errc::not_enough_memory if there is not enough memory to complete the
-// operation.
-//
//===----------------------------------------------------------------------===//
#ifndef LLVM_SUPPORT_PATHV2_H
#include "llvm/ADT/SmallString.h"
#include "llvm/ADT/Twine.h"
#include "llvm/Support/DataTypes.h"
-#include "llvm/Support/system_error.h"
#include <iterator>
namespace llvm {
/// The backwards traversal order is the reverse of forward traversal.
///
/// Iteration examples. Each component is separated by ',':
-/// / => /
-/// /foo => /,foo
-/// foo/ => foo,.
-/// /foo/bar => /,foo,bar
-/// ../ => ..,.
-/// C:\foo\bar => C:,/,foo,bar
-///
+/// @code
+/// / => /
+/// /foo => /,foo
+/// foo/ => foo,.
+/// /foo/bar => /,foo,bar
+/// ../ => ..,.
+/// C:\foo\bar => C:,/,foo,bar
+/// @endcode
class const_iterator {
- StringRef Path; //< The entire path.
- StringRef Component; //< The current component. Not necessarily in Path.
- size_t Position; //< The iterators current position within Path.
+ StringRef Path; ///< The entire path.
+ StringRef Component; ///< The current component. Not necessarily in Path.
+ size_t Position; ///< The iterators current position within Path.
// An end iterator has Position = Path.size() + 1.
- friend const_iterator begin(const StringRef &path);
- friend const_iterator end(const StringRef &path);
+ friend const_iterator begin(StringRef path);
+ friend const_iterator end(StringRef path);
public:
typedef const StringRef value_type;
/// @brief Get begin iterator over \a path.
/// @param path Input path.
/// @returns Iterator initialized with the first component of \a path.
-const_iterator begin(const StringRef &path);
+const_iterator begin(StringRef path);
/// @brief Get end iterator over \a path.
/// @param path Input path.
/// @returns Iterator initialized to the end of \a path.
-const_iterator end(const StringRef &path);
+const_iterator end(StringRef path);
/// @brief Get reverse begin iterator over \a path.
/// @param path Input path.
/// @returns Iterator initialized with the first reverse component of \a path.
-inline reverse_iterator rbegin(const StringRef &path) {
+inline reverse_iterator rbegin(StringRef path) {
return reverse_iterator(end(path));
}
/// @brief Get reverse end iterator over \a path.
/// @param path Input path.
/// @returns Iterator initialized to the reverse end of \a path.
-inline reverse_iterator rend(const StringRef &path) {
+inline reverse_iterator rend(StringRef path) {
return reverse_iterator(begin(path));
}
/// @name Lexical Modifiers
/// @{
-/// @brief Make \a path an absolute path.
-///
-/// Makes \a path absolute using the current directory if it is not already. An
-/// empty \a path will result in the current directory.
-///
-/// /absolute/path => /absolute/path
-/// relative/../path => <current-directory>/path
-///
-/// @param path A path that is modified to be an absolute path.
-/// @returns errc::success if \a path has been made absolute, otherwise a
-/// platform specific error_code.
-error_code make_absolute(SmallVectorImpl<char> &path);
-
-/// @brief Remove the last component from \a path if it exists.
+/// @brief Remove the last component from \a path unless it is the root dir.
///
-/// directory/filename.cpp => directory/
-/// directory/ => directory
+/// @code
+/// directory/filename.cpp => directory/
+/// directory/ => directory
+/// / => /
+/// @endcode
///
/// @param path A path that is modified to not have a file component.
-/// @returns errc::success if \a path's file name has been removed (or there was
-/// not one to begin with), otherwise a platform specific error_code.
-error_code remove_filename(SmallVectorImpl<char> &path);
+void remove_filename(SmallVectorImpl<char> &path);
/// @brief Replace the file extension of \a path with \a extension.
///
-/// ./filename.cpp => ./filename.extension
-/// ./filename => ./filename.extension
-/// ./ => ? TODO: decide what semantics this has.
+/// @code
+/// ./filename.cpp => ./filename.extension
+/// ./filename => ./filename.extension
+/// ./ => ./.extension
+/// @endcode
///
/// @param path A path that has its extension replaced with \a extension.
/// @param extension The extension to be added. It may be empty. It may also
/// optionally start with a '.', if it does not, one will be
/// prepended.
-/// @returns errc::success if \a path's extension has been replaced, otherwise a
-/// platform specific error_code.
-error_code replace_extension(SmallVectorImpl<char> &path,
- const Twine &extension);
+void replace_extension(SmallVectorImpl<char> &path, const Twine &extension);
/// @brief Append to path.
///
-/// /foo + bar/f => /foo/bar/f
-/// /foo/ + bar/f => /foo/bar/f
-/// foo + bar/f => foo/bar/f
+/// @code
+/// /foo + bar/f => /foo/bar/f
+/// /foo/ + bar/f => /foo/bar/f
+/// foo + bar/f => foo/bar/f
+/// @endcode
///
/// @param path Set to \a path + \a component.
-/// @param component The component to be appended to \a path.
-/// @returns errc::success if \a component has been appended to \a path,
-/// otherwise a platform specific error_code.
-error_code append(SmallVectorImpl<char> &path, const Twine &a,
- const Twine &b = "",
- const Twine &c = "",
- const Twine &d = "");
+/// @param a The component to be appended to \a path.
+void append(SmallVectorImpl<char> &path, const Twine &a,
+ const Twine &b = "",
+ const Twine &c = "",
+ const Twine &d = "");
/// @brief Append to path.
///
-/// /foo + [bar,f] => /foo/bar/f
-/// /foo/ + [bar,f] => /foo/bar/f
-/// foo + [bar,f] => foo/bar/f
+/// @code
+/// /foo + [bar,f] => /foo/bar/f
+/// /foo/ + [bar,f] => /foo/bar/f
+/// foo + [bar,f] => foo/bar/f
+/// @endcode
///
/// @param path Set to \a path + [\a begin, \a end).
/// @param begin Start of components to append.
/// @param end One past the end of components to append.
-/// @returns errc::success if [\a begin, \a end) has been appended to \a path,
-/// otherwise a platform specific error_code.
-error_code append(SmallVectorImpl<char> &path,
- const_iterator begin, const_iterator end);
+void append(SmallVectorImpl<char> &path,
+ const_iterator begin, const_iterator end);
/// @}
/// @name Transforms (or some other better name)
///
/// @param path A path that is transformed to native format.
/// @param result Holds the result of the transformation.
-/// @returns errc::success if \a path has been transformed and stored in result,
-/// otherwise a platform specific error_code.
-error_code native(const Twine &path, SmallVectorImpl<char> &result);
+void native(const Twine &path, SmallVectorImpl<char> &result);
/// @}
/// @name Lexical Observers
/// @{
-/// @brief Get the current path.
-///
-/// @param result Holds the current path on return.
-/// @results errc::success if the current path has been stored in result,
-/// otherwise a platform specific error_code.
-error_code current_path(SmallVectorImpl<char> &result);
-
-// The following are purely lexical.
-
/// @brief Get root name.
///
-/// //net/hello => //net
-/// c:/hello => c: (on Windows, on other platforms nothing)
-/// /hello => <empty>
+/// @code
+/// //net/hello => //net
+/// c:/hello => c: (on Windows, on other platforms nothing)
+/// /hello => <empty>
+/// @endcode
///
/// @param path Input path.
-/// @param result Set to the root name of \a path if it has one, otherwise "".
-/// @results errc::success if result has been successfully set, otherwise a
-/// platform specific error_code.
-error_code root_name(const StringRef &path, StringRef &result);
+/// @result The root name of \a path if it has one, otherwise "".
+const StringRef root_name(StringRef path);
/// @brief Get root directory.
///
-/// /goo/hello => /
-/// c:/hello => /
-/// d/file.txt => <empty>
+/// @code
+/// /goo/hello => /
+/// c:/hello => /
+/// d/file.txt => <empty>
+/// @endcode
///
/// @param path Input path.
-/// @param result Set to the root directory of \a path if it has one, otherwise
+/// @result The root directory of \a path if it has one, otherwise
/// "".
-/// @results errc::success if result has been successfully set, otherwise a
-/// platform specific error_code.
-error_code root_directory(const StringRef &path, StringRef &result);
-
+const StringRef root_directory(StringRef path);
+
/// @brief Get root path.
///
/// Equivalent to root_name + root_directory.
///
/// @param path Input path.
-/// @param result Set to the root path of \a path if it has one, otherwise "".
-/// @results errc::success if result has been successfully set, otherwise a
-/// platform specific error_code.
-error_code root_path(const StringRef &path, StringRef &result);
+/// @result The root path of \a path if it has one, otherwise "".
+const StringRef root_path(StringRef path);
/// @brief Get relative path.
///
-/// C:\hello\world => hello\world
-/// foo/bar => foo/bar
-/// /foo/bar => foo/bar
+/// @code
+/// C:\hello\world => hello\world
+/// foo/bar => foo/bar
+/// /foo/bar => foo/bar
+/// @endcode
///
/// @param path Input path.
-/// @param result Set to the path starting after root_path if one exists,
-/// otherwise "".
-/// @results errc::success if result has been successfully set, otherwise a
-/// platform specific error_code.
-error_code relative_path(const StringRef &path, StringRef &result);
+/// @result The path starting after root_path if one exists, otherwise "".
+const StringRef relative_path(StringRef path);
/// @brief Get parent path.
///
-/// / => <empty>
-/// /foo => /
-/// foo/../bar => foo/..
+/// @code
+/// / => <empty>
+/// /foo => /
+/// foo/../bar => foo/..
+/// @endcode
///
/// @param path Input path.
-/// @param result Set to the parent path of \a path if one exists, otherwise "".
-/// @results errc::success if result has been successfully set, otherwise a
-/// platform specific error_code.
-error_code parent_path(const StringRef &path, StringRef &result);
+/// @result The parent path of \a path if one exists, otherwise "".
+const StringRef parent_path(StringRef path);
/// @brief Get filename.
///
-/// /foo.txt => foo.txt
-/// . => .
-/// .. => ..
-/// / => /
+/// @code
+/// /foo.txt => foo.txt
+/// . => .
+/// .. => ..
+/// / => /
+/// @endcode
///
/// @param path Input path.
-/// @param result Set to the filename part of \a path. This is defined as the
-/// last component of \a path.
-/// @results errc::success if result has been successfully set, otherwise a
-/// platform specific error_code.
-error_code filename(const StringRef &path, StringRef &result);
+/// @result The filename part of \a path. This is defined as the last component
+/// of \a path.
+const StringRef filename(StringRef path);
/// @brief Get stem.
///
/// substring of filename ending at (but not including) the last dot. Otherwise
/// it is filename.
///
-/// /foo/bar.txt => bar
-/// /foo/bar => bar
-/// /foo/.txt => <empty>
-/// /foo/. => .
-/// /foo/.. => ..
+/// @code
+/// /foo/bar.txt => bar
+/// /foo/bar => bar
+/// /foo/.txt => <empty>
+/// /foo/. => .
+/// /foo/.. => ..
+/// @endcode
///
/// @param path Input path.
-/// @param result Set to the stem of \a path.
-/// @results errc::success if result has been successfully set, otherwise a
-/// platform specific error_code.
-error_code stem(const StringRef &path, StringRef &result);
+/// @result The stem of \a path.
+const StringRef stem(StringRef path);
/// @brief Get extension.
///
/// substring of filename starting at (and including) the last dot, and ending
/// at the end of \a path. Otherwise "".
///
-/// /foo/bar.txt => .txt
-/// /foo/bar => <empty>
-/// /foo/.txt => .txt
+/// @code
+/// /foo/bar.txt => .txt
+/// /foo/bar => <empty>
+/// /foo/.txt => .txt
+/// @endcode
///
/// @param path Input path.
-/// @param result Set to the extension of \a path.
-/// @results errc::success if result has been successfully set, otherwise a
-/// platform specific error_code.
-error_code extension(const StringRef &path, StringRef &result);
+/// @result The extension of \a path.
+const StringRef extension(StringRef path);
+
+/// @brief Check whether the given char is a path separator on the host OS.
+///
+/// @param value a character
+/// @result true if \a value is a path separator character on the host OS
+bool is_separator(char value);
+
+/// @brief Get the typical temporary directory for the system, e.g.,
+/// "/var/tmp" or "C:/TEMP"
+///
+/// @param erasedOnReboot Whether to favor a path that is erased on reboot
+/// rather than one that potentially persists longer. This parameter will be
+/// ignored if the user or system has set the typical environment variable
+/// (e.g., TEMP on Windows, TMPDIR on *nix) to specify a temporary directory.
+///
+/// @param result Holds the resulting path name.
+void system_temp_directory(bool erasedOnReboot, SmallVectorImpl<char> &result);
/// @brief Has root name?
///
/// root_name != ""
///
/// @param path Input path.
-/// @param result Set to true if the path has a root name, false otherwise.
-/// @results errc::success if result has been successfully set, otherwise a
-/// platform specific error_code.
-error_code has_root_name(const Twine &path, bool &result);
+/// @result True if the path has a root name, false otherwise.
+bool has_root_name(const Twine &path);
/// @brief Has root directory?
///
/// root_directory != ""
///
/// @param path Input path.
-/// @param result Set to true if the path has a root directory, false otherwise.
-/// @results errc::success if result has been successfully set, otherwise a
-/// platform specific error_code.
-error_code has_root_directory(const Twine &path, bool &result);
+/// @result True if the path has a root directory, false otherwise.
+bool has_root_directory(const Twine &path);
/// @brief Has root path?
///
/// root_path != ""
///
/// @param path Input path.
-/// @param result Set to true if the path has a root path, false otherwise.
-/// @results errc::success if result has been successfully set, otherwise a
-/// platform specific error_code.
-error_code has_root_path(const Twine &path, bool &result);
+/// @result True if the path has a root path, false otherwise.
+bool has_root_path(const Twine &path);
/// @brief Has relative path?
///
/// relative_path != ""
///
/// @param path Input path.
-/// @param result Set to true if the path has a relative path, false otherwise.
-/// @results errc::success if result has been successfully set, otherwise a
-/// platform specific error_code.
-error_code has_relative_path(const Twine &path, bool &result);
+/// @result True if the path has a relative path, false otherwise.
+bool has_relative_path(const Twine &path);
/// @brief Has parent path?
///
/// parent_path != ""
///
/// @param path Input path.
-/// @param result Set to true if the path has a parent path, false otherwise.
-/// @results errc::success if result has been successfully set, otherwise a
-/// platform specific error_code.
-error_code has_parent_path(const Twine &path, bool &result);
+/// @result True if the path has a parent path, false otherwise.
+bool has_parent_path(const Twine &path);
/// @brief Has filename?
///
/// filename != ""
///
/// @param path Input path.
-/// @param result Set to true if the path has a filename, false otherwise.
-/// @results errc::success if result has been successfully set, otherwise a
-/// platform specific error_code.
-error_code has_filename(const Twine &path, bool &result);
+/// @result True if the path has a filename, false otherwise.
+bool has_filename(const Twine &path);
/// @brief Has stem?
///
/// stem != ""
///
/// @param path Input path.
-/// @param result Set to true if the path has a stem, false otherwise.
-/// @results errc::success if result has been successfully set, otherwise a
-/// platform specific error_code.
-error_code has_stem(const Twine &path, bool &result);
+/// @result True if the path has a stem, false otherwise.
+bool has_stem(const Twine &path);
/// @brief Has extension?
///
/// extension != ""
///
/// @param path Input path.
-/// @param result Set to true if the path has a extension, false otherwise.
-/// @results errc::success if result has been successfully set, otherwise a
-/// platform specific error_code.
-error_code has_extension(const Twine &path, bool &result);
+/// @result True if the path has a extension, false otherwise.
+bool has_extension(const Twine &path);
/// @brief Is path absolute?
///
/// @param path Input path.
-/// @param result Set to true if the path is absolute, false if it is not.
-/// @results errc::success if result has been successfully set, otherwise a
-/// platform specific error_code.
-error_code is_absolute(const Twine &path, bool &result);
+/// @result True if the path is absolute, false if it is not.
+bool is_absolute(const Twine &path);
/// @brief Is path relative?
///
/// @param path Input path.
-/// @param result Set to true if the path is relative, false if it is not.
-/// @results errc::success if result has been successfully set, otherwise a
-/// platform specific error_code.
-error_code is_relative(const Twine &path, bool &result);
-// end purely lexical.
+/// @result True if the path is relative, false if it is not.
+bool is_relative(const Twine &path);
} // end namespace path
} // end namespace sys
projects / oota-llvm.git / blobdiff