gpath.h

Go to the documentation of this file.

//
// Copyright (C) 2001-2013 Graeme Walker <graeme_walker@users.sourceforge.net>
// 
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
// 
// This program 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 General Public License for more details.
// 
// You should have received a copy of the GNU General Public License
// along with this program.  If not, see <http://www.gnu.org/licenses/>.
// ===

#ifndef G_PATH_H
#define G_PATH_H

#include "gdef.h"
#include "gstrings.h"
#include <string>
#include <iostream>

namespace G
{
        class Path ;
}

class G::Path 
{
public:
        Path() ;

        Path( const std::string & path ) ;

        Path( const char * path ) ;

        Path( const Path & path , const std::string & tail ) ;

        Path( const Path & path , const std::string & tail_1 , const std::string & tail_2 ) ;

        Path( const Path & other ) ;

        ~Path() ;

        bool simple() const ;

        std::string str() const ;

        std::string basename() const ;

        Path dirname() const ;

        std::string extension() const ;

        void removeExtension() ;

        bool isAbsolute() const ;

        bool isRelative() const ;

        bool hasDriveLetter() const ;

        Path & operator=( const Path & other ) ;

        void pathAppend( const std::string & tail ) ;

        static G::Path join( const G::Path & p1 , const G::Path & p2 ) ;

        Strings split( bool no_dot = true ) const ;

        bool operator==( const Path & path ) const ;

        bool operator!=( const Path & path ) const ;

private:
        void set( const std::string & path ) ;
        void normalise() ;
        void clear() ;
        static std::string slashString() ;
        static std::string doubleSlashString() ;
        std::string driveString() const ;
        std::string::size_type slashAt() const ;
        bool hasNoSlash() const ;
        std::string withoutTail() const ;
        bool hasNetworkDrive() const ;
        std::string dirnameImp() const ;

private:
        std::string m_str ;
        std::string m_extension ;
        std::string::size_type m_dot ;
} ;

namespace G
{
        inline
        std::ostream & operator<<( std::ostream & stream , const Path & path )
        {
                return stream << path.str() ;
        }

        inline
        Path & operator+=( Path & p , const std::string & str )
        {
                p.pathAppend( str ) ;
                return p ;
        }

        inline
        Path operator+( const Path & p , const std::string & str )
        {
                Path result( p ) ;
                result.pathAppend( str ) ;
                return result ;
        }
}

#endif