|
VideoTools
|
|
VideoTools
|
A Path object represents a file system path. More...
#include <gpath.h>
Public Member Functions | |
| Path () | |
| Default constructor for a zero-length path. More... | |
| Path (const std::string &path) | |
| Implicit constructor from a string. | |
| Path (const char *path) | |
| Implicit constructor from a c-style string. | |
| Path (const Path &path, const std::string &tail) | |
| Constructor with an implicit pathAppend(). | |
| Path (const Path &path, const std::string &tail_1, const std::string &tail_2) | |
| Constructor with two implicit pathAppend()s. | |
| Path (const Path &other) | |
| Copy constructor. | |
| ~Path () | |
| Destructor. | |
| std::string | str () const |
| Returns the path string. | |
| bool | simple () const |
| Returns true if the path has a single component (ignoring "." parts), ie. More... | |
| std::string | basename () const |
| Returns the rightmost part of the path, ignoring "." parts. More... | |
| Path | dirname () const |
| Returns the path without the rightmost part, ignoring "." parts. More... | |
| std::string | extension () const |
| Returns the path's basename extension, ie. More... | |
| Path | withExtension (const std::string &ext) const |
| Returns the path with the new basename extension. More... | |
| Path | withoutExtension () const |
| Returns a path without the basename extension, if any. More... | |
| bool | isAbsolute () const |
| Returns !isRelative(). | |
| bool | isRelative () const |
| Returns true if the path is a relative path. | |
| void | pathAppend (const std::string &tail) |
| Appends a filename or a relative path to this path. | |
| StringArray | split () const |
| Spits the path into a list of component parts (ignoring "." parts unless the whole path is "."). More... | |
| Path | collapsed () const |
| Returns the path with "foo/.." and "." parts removed, so far as is possible without changing the meaning of the path. More... | |
| void | swap (Path &other) |
| Swaps this with other. | |
| Path & | operator= (const Path &other) |
| Assignment operator. | |
| bool | operator== (const Path &path) const |
| Comparison operator. | |
| bool | operator!= (const Path &path) const |
| Comparison operator. | |
Static Public Member Functions | |
| static Path | join (const StringArray &parts) |
| Builds a path from a set of parts. More... | |
| static Path | join (const Path &p1, const Path &p2) |
| Joins two paths together. The second should be a relative path. | |
| static Path | difference (const Path &p1, const Path &p2) |
| Returns the relative path from p1 to p2. More... | |
| static Path | nullDevice () |
| Returns the path of the "/dev/null" special file, or equivalent. | |
| static void | setPosixStyle () |
| Sets posix mode for testing purposes. | |
| static void | setWindowsStyle () |
| Sets windows mode for testing purposes. | |
| static bool | less (const Path &a, const Path &b) |
| Compares two paths, with simple eight-bit lexicographical comparisons of each path component. More... | |
Friends | |
| class | G::PathImp |
A Path object represents a file system path.
The class is concerned with path syntax, not file system i/o.
A full path is made up of a root, a set of directories, and a filename. The posix root is just a forward slash, but on Windows the root can be complex, possibly including non-splitting separator characters. The filename may have an extension part, which is to the right of the right-most dot.
The path separator is used between directories and filename, but only between the root and the first directory if the root does not itself end in a separator character.
A windows drive-letter root may end with a separator character or not; if there is no separator character at the end of the drive-letter root then the path is relative to the drive's current working directory.
Path components of "." are ignored by simple(), basename(), and dirname(). Path components of ".." are retained but can be eliminated if they are collapsed(). Path components of "." are eliminated by split(), except in the degenerate case.
This class is agnostic on the choice of utf8 or eight-bit characters since the delimiters are all seven-bit ascii. On Windows it might make sense to obtain paths from the win32 api as multi-byte and convert immediately to utf8 before wrapping in G::Path.
Both posix and windows behaviours are available at run-time; the default behaviour is the native behaviour, but this can be overridden, typically for testing purposes.
The posix path separator character is the forward-slash; on Windows it is a back-slash, but with all forward-slashes converted to back-slashes immediately on input.
| G::Path::Path | ( | ) |
| std::string G::Path::basename | ( | ) | const |
Returns the rightmost part of the path, ignoring "." parts.
For a directory path this may be "..", but see also collapsed().
| G::Path G::Path::collapsed | ( | ) | const |
Returns the relative path from p1 to p2.
Returns the empty path if p2 is not under p1. Returns "." if p1 and p2 are the same. Input paths are collapsed(). Empty input paths are treated as ".".
| G::Path G::Path::dirname | ( | ) | const |
| std::string G::Path::extension | ( | ) | const |
|
static |
| bool G::Path::simple | ( | ) | const |
| G::StringArray G::Path::split | ( | ) | const |
| G::Path G::Path::withExtension | ( | const std::string & | ext | ) | const |
| G::Path G::Path::withoutExtension | ( | ) | const |
Returns a path without the basename extension, if any.
As a special case, a basename() that starts with a dot is replaced by a single dot. Prefer withExtension() where appropriate to avoid this.
1.8.6 
