3 * Routines to abstract out path separator differences between MacOS
4 * and the rest of the world.
7 // Written by Curtis L. Olson, started April 1999.
9 // Copyright (C) 1999 Curtis L. Olson - http://www.flightgear.org/~curt
11 // This library is free software; you can redistribute it and/or
12 // modify it under the terms of the GNU Library General Public
13 // License as published by the Free Software Foundation; either
14 // version 2 of the License, or (at your option) any later version.
16 // This library is distributed in the hope that it will be useful,
17 // but WITHOUT ANY WARRANTY; without even the implied warranty of
18 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 // Library General Public License for more details.
21 // You should have received a copy of the GNU General Public License
22 // along with this program; if not, write to the Free Software
23 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
31 #include <sys/types.h>
33 #include <simgear/compiler.h>
36 #include <simgear/math/sg_types.hxx>
43 * A class to hide path separator difference across platforms and assist
44 * in managing file system path names.
46 * Paths can be input in any platform format and will be converted
47 * automatically to the proper format.
58 /** Default constructor */
61 /** Copy contructor */
62 SGPath(const SGPath& p);
64 SGPath& operator=(const SGPath& p);
67 * Construct a path based on the starting path provided.
68 * @param p initial path
70 SGPath( const std::string& p );
73 * Construct a path based on the starting path provided and a relative subpath
74 * @param p initial path
75 * @param r relative subpath
77 SGPath( const SGPath& p, const std::string& r );
83 * Set path to a new value
86 void set( const std::string& p );
87 SGPath& operator= ( const char* p ) { this->set(p); return *this; }
90 * Append another piece to the existing path. Inserts a path
91 * separator between the existing component and the new component.
92 * @param p additional path component */
93 void append( const std::string& p );
96 * Append a new piece to the existing path. Inserts a search path
97 * separator to the existing path and the new patch component.
98 * @param p additional path component */
99 void add( const std::string& p );
102 * Concatenate a string to the end of the path without inserting a
104 * @param p additional path suffix
106 void concat( const std::string& p );
109 * Get the file part of the path (everything after the last path sep)
110 * @return file string
112 std::string file() const;
115 * Get the directory part of the path.
116 * @return directory string
118 std::string dir() const;
121 * Get the base part of the path (everything but the extension.)
122 * @return the base string
124 std::string base() const;
127 * Get the extension part of the path (everything after the final ".")
128 * @return the extension string
130 std::string extension() const;
133 * Get the path string
134 * @return path string
136 std::string str() const { return path; }
139 * Get the path string
140 * @return path in "C" string (ptr to char array) form.
142 const char* c_str() const { return path.c_str(); }
145 * Get the path string in OS native form
147 std::string str_native() const;
150 * Determine if file exists by attempting to fopen it.
151 * @return true if file exists, otherwise returns false.
156 * Create the designated directory.
157 * @return 0 on success, or <0 on failure.
159 int create_dir(mode_t mode);
165 * Opposite sense to isAbsolute
167 bool isRelative() const { return !isAbsolute(); }
170 * Is this an absolute path?
171 * I.e starts with a directory seperator, or a single character + colon
173 bool isAbsolute() const;
176 * check for default constructed path
183 void validate() const;
185 mutable bool _cached;
186 mutable bool _exists;
188 mutable bool _isFile;
193 * Split a directory string into a list of it's parent directories.
195 string_list sgPathBranchSplit( const std::string &path );
198 * Split a directory search path into a vector of individual paths
200 string_list sgPathSplit( const std::string &search_path );
203 #endif // _SG_PATH_HXX