path.h

Go to the documentation of this file.

 
#ifndef _A_UTILS_UTIL_FILESYSTEM_PATH_INCLUDED_
#define _A_UTILS_UTIL_FILESYSTEM_PATH_INCLUDED_
 
#include <a_util/preprocessor/deprecated.h>
 
#include <memory>
#include <stdexcept>
#include <string>
 
namespace a_util {
namespace filesystem {
// forward declarations
class Path;
Path getWorkingDirectory();

class PathException : public std::runtime_error {
public:
    PathException(const std::string& message);
};

class Path {
public:
    typedef enum {
        PS_ForwardSlash = 0,  
        PS_BackwardSlash = 1, 
        PS_Native = 2         
    } PathSeparator;
 
public:
    Path();

    Path(const Path& path);

    Path& operator=(const Path& path);

    Path(const std::string& path);

    Path(const char* path);

    ~Path();

    operator std::string() const;

    std::string toString(PathSeparator separator = PS_Native) const;

    bool setPath(const std::string& path);

    Path& append(const Path& path);

    DEV_ESSENTIAL_DEPRECATED("Use Path::getRootName() instead.")
    Path getRoot() const; // expected-note {{'getRoot' has been explicitly marked deprecated here}}

    Path getRootName() const;

    Path getRootPath() const;

    Path getParent() const;

    Path getLastElement() const;

    std::string getExtension() const;

    Path& appendToBasename(const std::string& str);

    Path& replaceExtension(const std::string& extension);

    Path& removeLastElement();

    Path& makeCanonical();

    Path& makeAbsolute();

    Path& makeAbsolute(Path base_path);

    Path& makeRelative();

    Path& makeRelative(Path input_path);
 
    // Makes the current path relative to a specified parent directory (default: working directory)
    // @note If the path is already relative, no changes are made!
    // @param [in] oParent The parent directory
    // @return Returns *this, to be able to chain additional method calls
    // Path& MakeRelative(const Path& oParent = filesystem::getWorkingDirectory());
 
    // Makes the current path absolute, using a specified parent directory (default: working
    // directory)
    // @note If the path is already absolute, no changes are made!
    // @param [in] oParent The parent directory
    // @return Returns *this, to be able to chain additional method calls
    // Path& MakeAbsolute(const Path& oParent = filesystem::getWorkingDirectory());

    bool isRelative() const;

    bool isAbsolute() const;

    bool isBaseOf(const Path& path) const;

    bool isEmpty() const;

    Path& Clear();
 
private:
    class Implementation;
    std::unique_ptr<Implementation> _impl;
    friend bool operator==(const Path& lhs, const Path& rhs);
};

bool operator==(const Path& lhs, const Path& rhs);

bool operator!=(const Path& lhs, const Path& rhs);

std::ostream& operator<<(std::ostream& os, const Path& p);

Path operator+(const Path& a, const Path& b);
 
} // namespace filesystem
} // namespace a_util
 
#endif // _A_UTILS_UTIL_FILESYSTEM_PATH_INCLUDED_