dist/tools/fs.hpp

49 // The "path" class.
53 //! \brief A class to represent a path to a file.
55 //! The path class represents the route to a file or directory in the
60 //! It is important to note that the file pointed to by a path need not
63 class path {
65     //! \brief Internal representation of a path.
70     //! \brief Constructs a new path from a user-provided string.
73     //! code or by the user and constructs a new path object.  The string
79     explicit path(const std::string&);
82     //! \brief Destructor for the path class.
84     ~path(void);
87     //! \brief Returns a pointer to a C-style string representing this path.
92     //! \brief Returns a string representing this path.
98     //! \brief Returns the branch path of this path.
100     //! Calculates and returns the branch path of this path.  In other
103     path branch_path(void) const;
106     //! \brief Returns the leaf name of this path.
108     //! Calculates and returns the leaf name of this path.  In other words,
114     //! \brief Checks whether this path is absolute or not.
116     //! Returns a boolean indicating if this is an absolute path or not;
122     //! \brief Checks whether this path points to the root directory or not.
124     //! Returns a boolean indicating if this is path points to the root
132     //! \brief Converts the path to be absolute.
134     //! \pre The path was not absolute.
136     path to_absolute(void) const;
141     bool operator==(const path&) const;
146     bool operator!=(const path&) const;
149     //! \brief Concatenates a path with a string.
151     //! Constructs a new path object that is the concatenation of the
152     //! left-hand path with the right-hand string.  The string is normalized
153     //! before the concatenation, and a path delimiter is introduced between
156     path operator/(const std::string&) const;
159     //! \brief Concatenates a path with another path.
161     //! Constructs a new path object that is the concatenation of the
162     //! left-hand path with the right-hand one. A path delimiter is
165     path operator/(const path&) const;
168     //! \brief Checks if a path has to be sorted before another one
171     bool operator<(const path&) const;
210     explicit file_info(const path&);
309     //! Constructs a new directory object representing the given path.
313     directory(const path&);
329     std::unique_ptr< tools::fs::path > m_path;
332     temp_dir(const tools::fs::path&);
335     const tools::fs::path& get_path(void) const;
343 //! \brief Checks if the given path exists.
345 bool exists(const path&);
350 //! Given a program name (without slashes) looks for it in the path and
351 //! returns its full path name if found, otherwise an empty path.
356 //! \brief Checks if the given path exists, is accessible and is executable.
358 bool is_executable(const path&);
363 void remove(const path&);
368 void rmdir(const path&);
370 tools::fs::path change_directory(const tools::fs::path&);
371 void change_ownership(const tools::fs::path&, const std::pair< int, int >&);
372 void cleanup(const tools::fs::path&);
373 tools::fs::path get_current_dir(void);