PathName.hpp

Go to the documentation of this file.

/*---------------------------------------------------------------------\
|                                                                      |
|                     _     _   _   _     __     _                     |
|                    | |   | | | \_/ |   /  \   | |                    |
|                    | |   | | | |_| |  / /\ \  | |                    |
|                    | |__ | | | | | | / ____ \ | |__                  |
|                    |____||_| |_| |_|/ /    \ \|____|                 |
|                                                                      |
|                             core library                             |
|                                                                      |
|                                         (C) SUSE Linux Products GmbH |
\----------------------------------------------------------------------/

  File:       PathName.hpp

  Maintainer: Michael Calmer

/----------------------------------------------------------------------\
|                                                                      |
|                      __   __    ____ _____ ____                      |
|                      \ \ / /_ _/ ___|_   _|___ \                     |
|                       \ V / _` \___ \ | |   __) |                    |
|                        | | (_| |___) || |  / __/                     |
|                        |_|\__,_|____/ |_| |_____|                    |
|                                                                      |
|                               core system                            |
|                                                        (C) SuSE GmbH |
\----------------------------------------------------------------------/

   File:       Pathname.h

   Author:     Michael Andres <ma@suse.de>
   Maintainer: Michael Andres <ma@suse.de>

/-*/
#ifndef CA_MGM_PATH_PATHNAME_HPP
#define CA_MGM_PATH_PATHNAME_HPP

#include <ca-mgm/config.h>
#include <ca-mgm/String.hpp>
#include <list>
#include <iosfwd>

#define  FILENAME_SEPARATOR   "/"
#define  FILENAME_SEPARATOR_C '/'

// -------------------------------------------------------------------
namespace CA_MGM_NAMESPACE
{
namespace path
{

// -------------------------------------------------------------------
class PathName
{
public:
    typedef std::list<std::string> List;

    PathName();

    PathName(const PathName       &path);

    PathName(const PathName::List &list);

    PathName(const std::string &name);
    PathName(const char           *name);

    virtual ~PathName();

    PathName & operator= (const PathName &path);

    PathName & operator+=(const PathName &path);

    std::string          toString() const;
    std::string          asString() const { return toString(); }

    PathName::List          toList()   const;

    std::string          prefix()   const;

    bool                    empty()    const;

    bool                    absolute() const;

    bool                    relative() const;

    PathName                dirName()      const;

    static PathName         dirName(const PathName &path);

    std::string          baseName()     const;

    static std::string   baseName(const PathName &path);

    PathName                absoluteName() const;

    static PathName         absoluteName(const PathName &path);

    PathName                relativeName() const;

    static PathName         relativeName(const PathName &path);

    PathName                cat(const PathName &add) const;

    static PathName         cat(const PathName &path,
                                const PathName &add);
    PathName                extend(const std::string &ext) const;

    static PathName         extend(const PathName       &path,
                                   const std::string &ext);

    bool                    equal(const PathName &rpath) const;

    static bool             equal(const PathName &lpath,
                                  const PathName &rpath);

protected:
    void                    assign(const std::string &path);

    void                    assign(const PathName::List &list);

private:
    size_t          m_prefix;
    std::string  m_name;
};


// -------------------------------------------------------------------
inline bool
operator==(const PathName &lname, const PathName &rname)
{
    return PathName::equal( lname, rname);
}


// -------------------------------------------------------------------
inline bool
operator!=(const PathName &lname, const PathName &rname)
{
    return !PathName::equal( lname, rname);
}


// -------------------------------------------------------------------
inline PathName
operator+ (const PathName &lname, const PathName &rname)
{
    return PathName::cat( lname, rname);
}


// -------------------------------------------------------------------
extern std::ostream &
operator<<(std::ostream &ostr, const PathName &path);


// -------------------------------------------------------------------
}       // End of namespace path
}       // End of namespace CA_MGM_NAMESPACE

#endif  // CA_MGM_PATH_PATHNAME_HPP
// vim: set ts=8 sts=4 sw=4 ai et: