Panda3D
|
This class stores a list of directories that can be searched, in order, to locate a particular file. More...
#include "dSearchPath.h"
Classes | |
class | Results |
Public Member Functions | |
DSearchPath (const DSearchPath ©)=default | |
DSearchPath (const Filename &directory) | |
DSearchPath (const std::string &path, const std::string &separator=std::string()) | |
DSearchPath (DSearchPath &&from)=default | |
void | append_directory (const Filename &directory) |
Adds a new directory to the end of the search list. More... | |
void | append_path (const DSearchPath &path) |
Adds all of the directories listed in the search path to the end of the search list. More... | |
void | append_path (const std::string &path, const std::string &separator=std::string()) |
Adds all of the directories listed in the search path to the end of the search list. More... | |
void | clear () |
Removes all the directories from the search list. More... | |
Results | find_all_files (const Filename &filename) const |
This variant of find_all_files() returns the new Results object, instead of filling on in on the parameter list. More... | |
size_t | find_all_files (const Filename &filename, Results &results) const |
Searches all the directories in the search list for the indicated file, in order. More... | |
Filename | find_file (const Filename &filename) const |
Searches all the directories in the search list for the indicated file, in order. More... | |
const Filename & | get_directory (size_t n) const |
size_t | get_num_directories () const |
bool | is_empty () const |
Returns true if the search list is empty, false otherwise. More... | |
DSearchPath & | operator= (const DSearchPath ©)=default |
DSearchPath & | operator= (DSearchPath &&from)=default |
void | output (std::ostream &out, const std::string &separator=std::string()) const |
void | prepend_directory (const Filename &directory) |
Adds a new directory to the front of the search list. More... | |
void | prepend_path (const DSearchPath &path) |
Adds all of the directories listed in the search path to the beginning of the search list. More... | |
void | write (std::ostream &out, int indent_level=0) const |
Static Public Member Functions | |
static Filename | search_path (const Filename &filename, const std::string &path, const std::string &separator=std::string()) |
A quick-and-easy way to search a searchpath for a file when you don't feel like building or keeping around a DSearchPath object. More... | |
Public Attributes | |
get_directory | |
Returns the nth directory on the search list. More... | |
get_num_directories | |
Returns the number of directories on the search list. More... | |
This class stores a list of directories that can be searched, in order, to locate a particular file.
It is normally constructed by passing it a traditional searchpath-style string, e.g. a list of directory names delimited by spaces or colons, but it can also be built up explicitly.
Definition at line 28 of file dSearchPath.h.
void DSearchPath::append_directory | ( | const Filename & | directory | ) |
Adds a new directory to the end of the search list.
Definition at line 146 of file dSearchPath.cxx.
Referenced by append_path(), and FltHeader::convert_path().
void DSearchPath::append_path | ( | const DSearchPath & | path | ) |
Adds all of the directories listed in the search path to the end of the search list.
Definition at line 193 of file dSearchPath.cxx.
void DSearchPath::append_path | ( | const std::string & | path, |
const std::string & | separator = std::string() |
||
) |
Adds all of the directories listed in the search path to the end of the search list.
Definition at line 163 of file dSearchPath.cxx.
References append_directory(), and Filename::from_os_specific().
Referenced by FltHeader::convert_path().
void DSearchPath::clear | ( | ) |
Removes all the directories from the search list.
Definition at line 138 of file dSearchPath.cxx.
|
inline |
This variant of find_all_files() returns the new Results object, instead of filling on in on the parameter list.
This is a little more convenient to call from Python.
Definition at line 37 of file dSearchPath.I.
size_t DSearchPath::find_all_files | ( | const Filename & | filename, |
DSearchPath::Results & | results | ||
) | const |
Searches all the directories in the search list for the indicated file, in order.
Fills up the results list with *all* of the matching filenames found, if any. Returns the number of matches found.
It is the responsibility of the the caller to clear the results list first; otherwise, the newly-found files will be appended to the list.
Definition at line 283 of file dSearchPath.cxx.
References DSearchPath::Results::add_file(), Filename::exists(), Filename::is_fully_qualified(), and Filename::is_local().
Searches all the directories in the search list for the indicated file, in order.
Returns the full matching pathname of the first match if found, or the empty string if not found.
Definition at line 243 of file dSearchPath.cxx.
References Filename::exists(), Filename::is_fully_qualified(), and Filename::is_local().
Referenced by Filename::resolve_filename().
bool DSearchPath::is_empty | ( | ) | const |
Returns true if the search list is empty, false otherwise.
Definition at line 216 of file dSearchPath.cxx.
void DSearchPath::prepend_directory | ( | const Filename & | directory | ) |
Adds a new directory to the front of the search list.
Definition at line 154 of file dSearchPath.cxx.
void DSearchPath::prepend_path | ( | const DSearchPath & | path | ) |
Adds all of the directories listed in the search path to the beginning of the search list.
Definition at line 203 of file dSearchPath.cxx.
|
inlinestatic |
A quick-and-easy way to search a searchpath for a file when you don't feel like building or keeping around a DSearchPath object.
This simply constructs a temporary DSearchPath based on the indicated path string, and searches that.
Definition at line 50 of file dSearchPath.I.
const Filename & DSearchPath::get_directory |
Returns the nth directory on the search list.
Definition at line 76 of file dSearchPath.h.
size_t DSearchPath::get_num_directories |
Returns the number of directories on the search list.
Definition at line 76 of file dSearchPath.h.
Referenced by VirtualFileSystem::find_all_files(), and Filename::find_on_searchpath().