Path.h

/*
 * Copyright (C) 2006-2014 Marc Boris Duerner
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 * 
 * As a special exception, you may use this file as part of a free
 * software library without restriction. Specifically, if other files
 * instantiate templates or use macros or inline functions from this
 * file, or you compile this file and link it with other files to
 * produce an executable, this file does not by itself cause the
 * resulting executable to be covered by the GNU General Public
 * License. This exception does not however invalidate any other
 * reasons why the executable file might be covered by the GNU Library
 * General Public License.
 * 
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */

#ifndef Pt_System_Path_h
#define Pt_System_Path_h

#include <Pt/System/Api.h>
#include <Pt/String.h>
#include <Pt/Types.h>
#include <string>

namespace Pt {

namespace System {

class PathImpl;

class PT_SYSTEM_API Path
{
    public:
        Path();

        Path(const Path& p);

        // TODO: explicit? Path p = "x"; not allowed?

        explicit Path(const Pt::String& s);

        explicit Path(const char* s);

        explicit Path(const char* s, std::size_t n);

        ~Path();

        // Assignments

        Path& assign(const Path& p);

        Path& assign(const Pt::String& s);

        Path& assign(const char* s);

        Path& assign(const char* s, std::size_t n);

        Path& operator=(const Path& p)
        { return assign(p); }

        Path& operator=(const Pt::String& s)
        { return assign(s); }

        Path& operator=(const char* s)
        { return assign(s); }

        // Appends

        Path& append(const Path& p);

        Path& append(const Pt::String& s);

        Path& append(const char* s);

        Path& append(const char* s, std::size_t n);

        Path& operator/=(const Path& p)
        { return append(p); }

        Path& operator/=(const Pt::String& s)
        { return append(s); }

        Path& operator/=(const char* s)
        { return append(s); }

        // Concatenation

        Path& concat(const Path& p);

        Path& concat(const Pt::String& s);

        Path& concat(const char* s);

        Path& concat(const char* s, std::size_t n);

        Path& operator+=(const Path& p)
        { return concat(p); }
        
        Path& operator+=(const Pt::String& s)
        { return concat(s); }

        Path& operator+=(const char* s)
        { return concat(s); }

        // Modifiers

        void clear();

        // Query

        bool empty() const;

        // TODO: return Path objects
        
        Pt::String fileName() const;

        Pt::String dirName() const;

        Pt::String baseName() const;

        Pt::String extension() const;

        // Comparison

        int compare(const Path& p) const;

        // Conversion

        Pt::String toString() const;

        std::string toLocal() const;

        // Others

        static Pt::String dirsep();

        static Pt::String curdir();

        static Pt::String updir();

        // Implementation

        const PathImpl* impl() const
        { return _impl; }

        PathImpl* impl()
        { return _impl; }

    private:
        PathImpl* _impl;
        std::string _pathData;
};

inline Path operator/(const Path& a, const Path& b)
{ 
    return Path(a) /= b;
}

inline Path operator/(const Path& a, const Pt::String& b)
{ 
    return Path(a) /= b;
}

inline Path operator/(const Path& a, const char* b)
{ 
    return Path(a) /= b;
}

inline bool operator==(const Path& a, const Path& b)
{ 
    return a.compare(b) == 0; 
}

inline bool operator!=(const Path& a, const Path& b)
{ 
    return a.compare(b) != 0; 
}

inline bool operator<(const Path& a, const Path& b)
{ 
    return a.compare(b) < 0;
}

} // namespace System

} // namespace Pt

#endif // Pt_System_Path_h