#include <path_finder.hpp>
Public Types | |
typedef std::list< std::string > | string_list |
A list type returned by some functions. | |
Public Member Functions | |
path_finder (const std::string &path=std::string(), const std::string &ext=std::string(), const std::string &pathsep=":") | |
Creates object with the given path/extension list. | |
virtual | ~path_finder () |
std::string | path_string () const |
Returns a ":"-separated string of all paths added via add/path(). | |
void | path_separator (const std::string &sep) |
Sets the string used as a separator for the string-based variants of path(), extentions(), etc. | |
const std::string & | path_separator () const |
Returns the path separator string. | |
virtual size_t | path (const std::string &p) |
Sets the path to p, which should be a path_separator()-delimited string. | |
virtual size_t | path (const string_list &p) |
Sets the path to the given list of directories. | |
virtual void | add_path (const std::string &p) |
Adds p to the path. | |
virtual void | add_extension (const std::string &ext=std::string()) |
Adds a "search extension." Sample: finder.extension( ".txt:.TXT" ); Will now try all path combinations with the rightmost characters matching ".txt" or ".TXT" (in that order). | |
virtual size_t | extensions (const std::string &ext) |
like add_extension(), but overwrites extension list. | |
virtual size_t | extensions (const string_list &p) |
Sets the extensions list to the given list. | |
std::string | extensions_string () const |
Returns the path_separator()-delimited listed of file suffixes to use when searching for a path. | |
const string_list & | extensions () const |
Returns this object's extensions list. | |
string_list & | extensions () |
Non-const overload, intended for serialization. | |
std::string | find (const std::string &resourcename, bool check_cache=true) const |
Returns the full path of the given resource, provided it could be found using the available lookup paths/extensions and is readable. | |
void | clear_cache () |
Empties the hit-cache used by find(). | |
const string_list & | path () const |
Returns a list of all items added via add_path() and path(). | |
string_list & | path () |
Non-const overload, intended for serialization. | |
bool | empty () const |
Returns true if this object has no paths or extensions. | |
Static Public Member Functions | |
static std::string | join_list (const string_list &list, const std::string &separator) |
Helper function to collapse a list into a string. | |
static bool | is_accessible (const std::string &path) |
Returns true if path is readable. | |
static std::string | basename (const std::string &) |
Returns the "base name" of the given string: any part following the final directory separator character. | |
static std::string | dir_separator () |
Returns a platform-dependent path separator. |
Example:
path_finder p; p.path( "/lib:/usr/lib" ); p.extensions( ".a:.so" ); std::cout << p.find( "libz" ) << std::endl;
That would print an empty string if it finds nothing, or a string if it finds any of the following:
Maintainer's note:
This cide was one of my very first STL-based classes, and the implementation probably shows that very clearly. That said, it has worked well for me for some four years now without any appeciable maintenance. :)
Definition at line 47 of file path_finder.hpp.
|
A list type returned by some functions.
Definition at line 54 of file path_finder.hpp. |
|
Creates object with the given path/extension list.
|
|
|
|
Adds a "search extension." Sample: finder.extension( ".txt:.TXT" ); Will now try all path combinations with the rightmost characters matching ".txt" or ".TXT" (in that order). Be sure to include a period if you want that searched - that is so this class can be used to find non-files and those with non-traditional extensions, like "foo_EXT". |
|
Adds p to the path. May be path_separtor()-delimited. |
|
Returns the "base name" of the given string: any part following the final directory separator character.
|
|
Empties the hit-cache used by find().
|
|
Returns a platform-dependent path separator. This is set when the class is compiled. |
|
Returns true if this object has no paths or extensions.
|
|
Non-const overload, intended for serialization.
|
|
Returns this object's extensions list.
|
|
Sets the extensions list to the given list. Returns the number of entries in p. |
|
like add_extension(), but overwrites extension list. Returns the number of entries parsed from the string. Referenced by s11n::plugin::path_finder_s11n::operator()(). |
|
Returns the path_separator()-delimited listed of file suffixes to use when searching for a path.
|
|
Returns the full path of the given resource, provided it could be found using the available lookup paths/extensions and is readable. Note that this might return a relative path, especially if the resourcename passed to it immediately resolves to an existing resource. It returns an empty string if the resourcename cannot be found in the filesystem tree (or is otherwise unaccessible). If check_cache is false then this function ignores its lookup cache and searches again, otherwise it uses a cache. When caching it will always return the same result for any given resourcename. |
|
Returns true if path is readable.
|
|
Helper function to collapse a list into a string. This function was changed from a normal member to static member in s11n version 1.1.3. |
|
Non-const overload, intended for serialization.
|
|
Returns a list of all items added via add_path() and path().
|
|
Sets the path to the given list of directories. Returns the number of elements in the list. |
|
Sets the path to p, which should be a path_separator()-delimited string. Returns the number of path elements parsed from p. Referenced by s11n::plugin::path_finder_s11n::operator()(). |
|
Returns the path separator string. Default is ":"; |
|
Sets the string used as a separator for the string-based variants of path(), extentions(), etc.
|
|
Returns a ":"-separated string of all paths added via add/path().
|