|
Utility functions for working with package assets. More...
Go to the source code of this file.
Functions | |
Package Relative Paths | |
Assets within package assets can be addressed via "package-relative" paths. For example, given a hypothetical package A package-relative path consists of two parts:
Examples:
| |
AR_API bool | ArIsPackageRelativePath (const std::string &path) |
Return true if path is a package-relative path, false otherwise. | |
AR_API std::string | ArJoinPackageRelativePath (const std::vector< std::string > &paths) |
Combines the given paths into a single package-relative path, nesting paths as necessary. | |
AR_API std::string | ArJoinPackageRelativePath (const std::pair< std::string, std::string > &paths) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
AR_API std::string | ArJoinPackageRelativePath (const std::string &packagePath, const std::string &packagedPath) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
AR_API std::pair< std::string, std::string > | ArSplitPackageRelativePathOuter (const std::string &path) |
Split package-relative path path into a (package path, packaged path) pair. | |
AR_API std::pair< std::string, std::string > | ArSplitPackageRelativePathInner (const std::string &path) |
Split package-relative path path into a (package path, packaged path) pair. | |
Utility functions for working with package assets.
Definition in file packageUtils.h.
AR_API bool ArIsPackageRelativePath | ( | const std::string & | path | ) |
Return true if path
is a package-relative path, false otherwise.
AR_API std::string ArJoinPackageRelativePath | ( | const std::pair< std::string, std::string > & | paths | ) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
AR_API std::string ArJoinPackageRelativePath | ( | const std::string & | packagePath, |
const std::string & | packagedPath | ||
) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
AR_API std::string ArJoinPackageRelativePath | ( | const std::vector< std::string > & | paths | ) |
Combines the given paths
into a single package-relative path, nesting paths as necessary.
AR_API std::pair< std::string, std::string > ArSplitPackageRelativePathInner | ( | const std::string & | path | ) |
Split package-relative path path
into a (package path, packaged path) pair.
If packageRelativePath
contains nested package-relative paths the package path will be the outermost package-relative path, and the packaged path will be the innermost packaged path.
AR_API std::pair< std::string, std::string > ArSplitPackageRelativePathOuter | ( | const std::string & | path | ) |
Split package-relative path path
into a (package path, packaged path) pair.
If packageRelativePath
contains nested package-relative paths the package path will be the outermost package path, and the packaged path will be the inner package-relative path.