xmltooling 1.6.4

xmltooling::PathResolver Class Reference

Resolves local filenames into absolute pathnames. More...

#include <xmltooling/util/PathResolver.h>

List of all members.

Public Types

enum  file_type_t {
  XMLTOOLING_LIB_FILE, XMLTOOLING_LOG_FILE, XMLTOOLING_XML_FILE, XMLTOOLING_RUN_FILE,
  XMLTOOLING_CFG_FILE, XMLTOOLING_CACHE_FILE
}
 

Types of file resources to resolve.

More...

Public Member Functions

virtual void setDefaultPackageName (const char *pkgname)
 Set the default package to use when resolving files.
virtual void setDefaultPrefix (const char *prefix)
 Set the default installation prefix to use when resolving files.
virtual void setLibDir (const char *dir)
 Set the lib directory to use when resolving files.
virtual void setLogDir (const char *dir)
 Set the log directory to use when resolving files.
virtual void setXMLDir (const char *dir)
 Set the XML directory to use when resolving files.
virtual void setRunDir (const char *dir)
 Set the run directory to use when resolving files.
virtual void setCfgDir (const char *dir)
 Set the config directory to use when resolving files.
virtual void setCacheDir (const char *dir)
 Set the cache directory to use when resolving files.
virtual const std::string & resolve (std::string &s, file_type_t filetype, const char *pkgname=nullptr, const char *prefix=nullptr) const
 Changes the input filename into an absolute pathname to the same file.

Detailed Description

Resolves local filenames into absolute pathnames.


Member Enumeration Documentation

Types of file resources to resolve.


Member Function Documentation

virtual const std::string& xmltooling::PathResolver::resolve ( std::string &  s,
file_type_t  filetype,
const char *  pkgname = nullptr,
const char *  prefix = nullptr 
) const [virtual]

Changes the input filename into an absolute pathname to the same file.

Parameters:
sfilename to resolve
filetypetype of file being resolved
pkgnameapplication package name to use in resolving the file (or nullptr for the default)
prefixinstallation prefix to use in resolving the file (or nullptr for the default)
Returns:
a const reference to the input string
virtual void xmltooling::PathResolver::setCacheDir ( const char *  dir) [virtual]

Set the cache directory to use when resolving files.

If relative, the default prefix will be prepended.

Parameters:
dirthe cache directory to use
virtual void xmltooling::PathResolver::setCfgDir ( const char *  dir) [virtual]

Set the config directory to use when resolving files.

If relative, the default prefix will be prepended.

Parameters:
dirthe config directory to use
virtual void xmltooling::PathResolver::setDefaultPackageName ( const char *  pkgname) [virtual]

Set the default package to use when resolving files.

Parameters:
pkgnamename of default package to use
virtual void xmltooling::PathResolver::setDefaultPrefix ( const char *  prefix) [virtual]

Set the default installation prefix to use when resolving files.

Parameters:
prefixname of default prefix to use
virtual void xmltooling::PathResolver::setLibDir ( const char *  dir) [virtual]

Set the lib directory to use when resolving files.

If relative, the default prefix will be prepended.

Parameters:
dirthe library directory to use
virtual void xmltooling::PathResolver::setLogDir ( const char *  dir) [virtual]

Set the log directory to use when resolving files.

If relative, the default prefix will be prepended.

Parameters:
dirthe log directory to use
virtual void xmltooling::PathResolver::setRunDir ( const char *  dir) [virtual]

Set the run directory to use when resolving files.

If relative, the default prefix will be prepended.

Parameters:
dirthe run directory to use
virtual void xmltooling::PathResolver::setXMLDir ( const char *  dir) [virtual]

Set the XML directory to use when resolving files.

If relative, the default prefix will be prepended.

Parameters:
dirthe XML directory to use

The documentation for this class was generated from the following file: