src/common/Path.h

/***************************************************************************
 *                                                                         *
 *   Copyright (C) 2007-2014 Christian Schoenebeck                         *
 *                                                                         *
 *   This library 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 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   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 General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this library; if not, write to the Free Software           *
 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston,                 *
 *   MA  02111-1307  USA                                                   *
 ***************************************************************************/

#ifndef LS_PATH_H
#define LS_PATH_H

#include <vector>
#include <string>

namespace LinuxSampler {

/** @brief Portable Path Abstraction
 *
 * Correct path and file names are dependent to the underlying OS and FS.
 * Especially the set of forbidden characters (and their encodings / escape
 * sequences) in path and file names differ on the various systems. This
 * class is meant as a portable wrapper to circumvent these problems by
 * storing the file names in its raw, human readable (intended) form and
 * provides OS specific methods like @c toPosix() for converting the path into
 * the correct encoding, as expected by the respective system.
 *
 * This class is currently only used internally by the LSCP parser. A lot
 * generalization work would have to be done to use this class as a overall
 * replacement for all @c char* / @c std::string file name arguments in the
 * sampler or even its C++ API. Probably we'll use something like
 * @c boost::filesystem::path instead of this class in future.
 */
class Path {
public:
    /**
     * Default constructor.
     */
    Path();

    /**
     * Creates a path object according to the local system's path conventions.
     * @see fromPosix(), fromWindows(), fromDbPath()
     */
    Path(std::string path);

    /**
     * Concatenate exactly one path node or filename to the end of this Path
     * object. This can be used to build up a full qualified path, directory
     * by directory.
     *
     * @param Name - name of the path node's name or filename in it's raw,
     *               human readable/expected form
     */
    void appendNode(std::string Name);

    /**
     * Sets the hardware drive of the path, for systems that use the concept
     * of drives in absolute pathes (i.e. Windows).
     */
    void setDrive(const char& Drive);

    /**
     * Convert this Path into the correct encoding as expected by POSIX
     * compliant system calls.
     */
    std::string toPosix() const;

    /**
     * Convert this Path into the correct encoding as expected
     * by the instruments database implementation.
     */
    std::string toDbPath() const;

    /**
     * Convert this Path into the correct encoding as expected and needed
     * for LSCP responses.
     */
    std::string toLscp() const;

    /**
     * Convert this Path into the correct encoding as expected by Windows
     * operating systems.
     */
    std::string toWindows() const;

    /**
     * Concatenate two paths.
     */
    Path operator+(const Path& p);

    /**
     * Concatenate two paths.
     */
    Path operator+(const Path* p);

    /**
     * Create a Path object from a POSIX path / filename string.
     */
    static Path fromPosix(std::string path);

    /**
     * Create a Path object from a DB path.
     */
    static Path fromDbPath(std::string path);

    /**
     * Create a Path object from a Windows path / filename string.
     */
    static Path fromWindows(std::string path);

    /**
     * Returns the name of the file or directory represented by
     * this path in abstract/raw form. This is the last name in
     * the path's name sequence.
     */
    std::string getName();

    /**
     * Returns the name of the file or directory
     * represented by the specified path in abstract/raw form.
     * This is the last name in the path's name sequence.
     */
    static std::string getName(std::string path);

    /**
     * Returns the path with the last name
     * of the path's name sequence stripped off.
     */
    std::string stripLastName();

    /**
     * Returns the path with the last name
     * of the path's name sequence stripped off.
     */
    static std::string stripLastName(std::string path);

    /**
     * Returns the last name in the path's name sequence
     * of this path with the file extension stripped off.
     */
    std::string getBaseName();

    /**
     * Returns the last name in the path's name sequence
     * of the specified path with the file extension stripped off.
     */
    static std::string getBaseName(std::string path);

    /**
     * Returns true if the path is reflecting an absolute path, false if it is
     * rather a relative path.
     */
    bool isAbsolute() const;

private:
    std::vector<std::string> elements; ///< stores the path names raw = unencoded, each element is one node of the path
    char                     drive;
    bool                     absolute;
};

} // namespace LinuxSampler

#endif // LS_PATH_H
1	schoenebeck	1332	/***************************************************************************
2			* *
3	schoenebeck	2529	* Copyright (C) 2007-2014 Christian Schoenebeck *
4	schoenebeck	1332	* *
5			* This library is free software; you can redistribute it and/or modify *
6			* it under the terms of the GNU General Public License as published by *
7			* the Free Software Foundation; either version 2 of the License, or *
8			* (at your option) any later version. *
9			* *
10			* This library is distributed in the hope that it will be useful, *
11			* but WITHOUT ANY WARRANTY; without even the implied warranty of *
12			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
13			* GNU General Public License for more details. *
14			* *
15			* You should have received a copy of the GNU General Public License *
16			* along with this library; if not, write to the Free Software *
17			* Foundation, Inc., 59 Temple Place, Suite 330, Boston, *
18			* MA 02111-1307 USA *
19			***************************************************************************/
20
21			#ifndef LS_PATH_H
22			#define LS_PATH_H
23
24			#include <vector>
25			#include <string>
26
27			namespace LinuxSampler {
28
29			/** @brief Portable Path Abstraction
30			*
31			* Correct path and file names are dependent to the underlying OS and FS.
32			* Especially the set of forbidden characters (and their encodings / escape
33			* sequences) in path and file names differ on the various systems. This
34			* class is meant as a portable wrapper to circumvent these problems by
35			* storing the file names in its raw, human readable (intended) form and
36			* provides OS specific methods like @c toPosix() for converting the path into
37			* the correct encoding, as expected by the respective system.
38			*
39			* This class is currently only used internally by the LSCP parser. A lot
40			* generalization work would have to be done to use this class as a overall
41			* replacement for all @c char* / @c std::string file name arguments in the
42			* sampler or even its C++ API. Probably we'll use something like
43			* @c boost::filesystem::path instead of this class in future.
44			*/
45			class Path {
46			public:
47	schoenebeck	2529	/**
48			* Default constructor.
49			*/
50	schoenebeck	1471	Path();
51
52	schoenebeck	1332	/**
53	schoenebeck	2529	* Creates a path object according to the local system's path conventions.
54			* @see fromPosix(), fromWindows(), fromDbPath()
55			*/
56			Path(std::string path);
57
58			/**
59	schoenebeck	1332	* Concatenate exactly one path node or filename to the end of this Path
60			* object. This can be used to build up a full qualified path, directory
61			* by directory.
62			*
63			* @param Name - name of the path node's name or filename in it's raw,
64			* human readable/expected form
65			*/
66			void appendNode(std::string Name);
67
68			/**
69	schoenebeck	1471	* Sets the hardware drive of the path, for systems that use the concept
70			* of drives in absolute pathes (i.e. Windows).
71			*/
72			void setDrive(const char& Drive);
73
74			/**
75	schoenebeck	1332	* Convert this Path into the correct encoding as expected by POSIX
76			* compliant system calls.
77			*/
78	schoenebeck	1471	std::string toPosix() const;
79	schoenebeck	1332
80			/**
81	iliev	1345	* Convert this Path into the correct encoding as expected
82			* by the instruments database implementation.
83			*/
84	schoenebeck	1471	std::string toDbPath() const;
85	iliev	1345
86			/**
87	schoenebeck	1399	* Convert this Path into the correct encoding as expected and needed
88			* for LSCP responses.
89			*/
90	schoenebeck	1471	std::string toLscp() const;
91	schoenebeck	1399
92			/**
93	schoenebeck	1471	* Convert this Path into the correct encoding as expected by Windows
94			* operating systems.
95			*/
96			std::string toWindows() const;
97
98			/**
99	schoenebeck	1332	* Concatenate two paths.
100			*/
101			Path operator+(const Path& p);
102
103			/**
104			* Concatenate two paths.
105			*/
106			Path operator+(const Path* p);
107
108	schoenebeck	1399	/**
109			* Create a Path object from a POSIX path / filename string.
110			*/
111			static Path fromPosix(std::string path);
112
113	iliev	1403	/**
114			* Create a Path object from a DB path.
115			*/
116			static Path fromDbPath(std::string path);
117
118	schoenebeck	1471	/**
119			* Create a Path object from a Windows path / filename string.
120			*/
121	senoner	1481	static Path fromWindows(std::string path);
122	schoenebeck	1471
123	iliev	1782	/**
124			* Returns the name of the file or directory represented by
125			* this path in abstract/raw form. This is the last name in
126			* the path's name sequence.
127			*/
128			std::string getName();
129
130			/**
131			* Returns the name of the file or directory
132			* represented by the specified path in abstract/raw form.
133			* This is the last name in the path's name sequence.
134			*/
135			static std::string getName(std::string path);
136
137			/**
138	iliev	2012	* Returns the path with the last name
139			* of the path's name sequence stripped off.
140			*/
141			std::string stripLastName();
142
143			/**
144			* Returns the path with the last name
145			* of the path's name sequence stripped off.
146			*/
147			static std::string stripLastName(std::string path);
148
149			/**
150	iliev	1782	* Returns the last name in the path's name sequence
151			* of this path with the file extension stripped off.
152			*/
153			std::string getBaseName();
154
155			/**
156			* Returns the last name in the path's name sequence
157			* of the specified path with the file extension stripped off.
158			*/
159			static std::string getBaseName(std::string path);
160
161	schoenebeck	2529	/**
162			* Returns true if the path is reflecting an absolute path, false if it is
163			* rather a relative path.
164			*/
165			bool isAbsolute() const;
166
167	schoenebeck	1332	private:
168			std::vector<std::string> elements; ///< stores the path names raw = unencoded, each element is one node of the path
169	schoenebeck	1471	char drive;
170	schoenebeck	2529	bool absolute;
171	schoenebeck	1332	};
172
173			} // namespace LinuxSampler
174
175			#endif // LS_PATH_H