Singleton for resolving path variables (DATA_DIR, USER_DIR, etc)

Public Member Functions
void	setDataPath (const DtFilename &dataPath)

void	setAppDataPath (const DtFilename &appDataPath)

void	setUserDataPath (const DtFilename &userDataPath)

void	setMakLuaPath (const DtFilename &makLuaPath)

DtFilename	dataPath ()

DtFilename	appDataPath ()

DtFilename	userDataPath ()

void	setAdditionalModelDefinitionPaths (const std::vector< DtFilename > &)

const std::vector< DtFilename > &	additionalModelDefinitionPaths () const

virtual DtString	resolvePath (const DtString &path) const

virtual std::string	resolvePathStdString (const std::string &path) const

virtual DtString	markupPath (const DtString &path) const

virtual std::string	markupPathStdString (const std::string &path) const

virtual void	setSharedSettingsDirectory (const DtFilename &)

virtual DtFilename	sharedSettingsDirectory ()

virtual DtFilename	sharedSettingsDirectory (const DtString &appName)

virtual void	setUseSharedSettingsDirectory (bool)

virtual bool	useSharedSettingsDirectory () const

virtual DtFilename	settingsDirectoryPathFor (const DtString &, bool andSetupFiles=true)

virtual DtFilename	settingsDirectory ()

virtual void	setUserSettingsDirectory (const DtFilename &)

virtual const DtFilename &	userSettingsDirectory ()

virtual DtFilename	resolveSettingsFile (const DtFilename &)

virtual DtFilename	backupsPath ()

virtual void	setApplication (const DtString &)

virtual const DtString &	application () const

virtual void	setVersionString (const DtString &version)

virtual const DtString &	versionString () const

virtual void	setApplicationRootName (const DtString &)

virtual const DtString &	applicationRootName () const

virtual void	setupUserSettingsDirectory (const DtFilename &userSettings, const DtFilename &rootPath, bool copyIfDateIsLater=true)

virtual void	setCopyIfDateIsLater (bool)

bool	copyIfDateIsLater () const

virtual DtFilename	sharedDataPath () const

virtual void	setSharedDataPath (const DtFilename &path)

virtual DtFilename	sharedDataRoot () const

virtual void	setSharedDataRoot (const DtFilename &path)

virtual DtString	sharedDataStem () const

virtual void	setSharedDataStem (const DtString &path)

virtual const DtFilename &	rawTerrainPath () const

virtual DtFilename	terrainPath () const

virtual void	setTerrainPath (const DtFilename &path)

virtual DtString	convertQuickIcon (const DtString &) const

virtual DtString	markupTerrainDirectory (const DtString &orig) const

Static Public Member Functions
static DtAppPathResolver &	Instance ()

Protected Member Functions
virtual void	replaceAll (std::string &searchText, const std::string &stringToFind, const std::string &stringToReplace) const

virtual void	setupSharedDataPath ()

	DtAppPathResolver ()

Protected Attributes
DtFilename	myDataPath

DtFilename	myAppDataPath

DtFilename	myUserDataPath

DtFilename	myMakLuaPath

DtFilename	mySharedSettingsDirectory

DtFilename	myUserSettingsDirectory

DtFilename	mySharedDataRoot

DtFilename	mySharedDataPath

DtFilename	myTerrainPath

DtString	mySharedDataStem

DtString	myApplicationRootName

bool	myUseSharedSettingsDirectory

DtString	myApplicationName

bool	myNeedsToSetupSettingsDirectory

std::vector< DtFilename >	myAdditonalModelDefinitionPaths

bool	myUserSetSettingsDirectory

bool	myCopyIfDateIsLater

DtString	myVersionString

Constructor & Destructor Documentation

makVrf::DtAppPathResolver::DtAppPathResolver ( )

protected

Member Function Documentation

static DtAppPathResolver& makVrf::DtAppPathResolver::Instance ( )

static

void makVrf::DtAppPathResolver::setDataPath ( const DtFilename & dataPath )

void makVrf::DtAppPathResolver::setAppDataPath ( const DtFilename & appDataPath )

void makVrf::DtAppPathResolver::setUserDataPath ( const DtFilename & userDataPath )

void makVrf::DtAppPathResolver::setMakLuaPath ( const DtFilename & makLuaPath )

DtFilename makVrf::DtAppPathResolver::dataPath ( )

DtFilename makVrf::DtAppPathResolver::appDataPath ( )

DtFilename makVrf::DtAppPathResolver::userDataPath ( )

void makVrf::DtAppPathResolver::setAdditionalModelDefinitionPaths ( const std::vector< DtFilename > & )

const std::vector<DtFilename>& makVrf::DtAppPathResolver::additionalModelDefinitionPaths ( ) const

virtual DtString makVrf::DtAppPathResolver::resolvePath ( const DtString & path ) const

virtual

Substitute values into string.

virtual std::string makVrf::DtAppPathResolver::resolvePathStdString ( const std::string & path ) const

virtual

virtual DtString makVrf::DtAppPathResolver::markupPath ( const DtString & path ) const

virtual

If values of variables are contained in string, substitute variable names.

virtual std::string makVrf::DtAppPathResolver::markupPathStdString ( const std::string & path ) const

virtual

virtual void makVrf::DtAppPathResolver::setSharedSettingsDirectory ( const DtFilename & )

virtual

This will set where the shared settings are to be found. This will be the same as the directory used for settings if useSharedSettingsDirectory is true, else this will be the directory references when needing to copy settings file to the user directory.

virtual DtFilename makVrf::DtAppPathResolver::sharedSettingsDirectory ( )

virtual

The shared settings directory will be a concatenation of the shared settings directory root and the application name.

virtual DtFilename makVrf::DtAppPathResolver::sharedSettingsDirectory ( const DtString & appName )

virtual

virtual void makVrf::DtAppPathResolver::setUseSharedSettingsDirectory ( bool )

virtual

Whether or not the call to settingsDirectory() returns the shared or user directory. Default is to return the user directory.

virtual bool makVrf::DtAppPathResolver::useSharedSettingsDirectory ( ) const

virtual

virtual DtFilename makVrf::DtAppPathResolver::settingsDirectoryPathFor	(	const DtString &	,
		bool	andSetupFiles = `true`
	)

virtual

Returns the settings directory for the given name with the given settings directory path. Will create all the necessary files if the directory does not exist.

virtual DtFilename makVrf::DtAppPathResolver::settingsDirectory ( )

virtual

The settings directory to use. Note that the first time this method is called, this will look at the shared settings flag, and, if that is false, will look at the shared settings directory and copy any necessary files to the user settings directory.

virtual void makVrf::DtAppPathResolver::setUserSettingsDirectory ( const DtFilename & )

virtual

Override the initial setting of the user settings directory. This must be the first call made if you wish to actually effect what settings directory is used.

virtual const DtFilename& makVrf::DtAppPathResolver::userSettingsDirectory ( )

virtual

virtual DtFilename makVrf::DtAppPathResolver::resolveSettingsFile ( const DtFilename & )

virtual

Given the value of settings directory, return a proper path to the settings file.

virtual DtFilename makVrf::DtAppPathResolver::backupsPath ( )

virtual

Given the current settings directory, append backups to that to store backups for settings. If the directory does not exist it will be created.

virtual void makVrf::DtAppPathResolver::setApplication ( const DtString & )

virtual

Sets up the application name and version. By default the application name is vrforces and the version is the current value of the MAJOR and MINOR version defines in versions.h.

virtual const DtString& makVrf::DtAppPathResolver::application ( ) const

virtual

virtual void makVrf::DtAppPathResolver::setVersionString ( const DtString & version )

virtual

virtual const DtString& makVrf::DtAppPathResolver::versionString ( ) const

virtual

virtual void makVrf::DtAppPathResolver::setApplicationRootName ( const DtString & )

virtual

The root to create the settings under. Default is vrforces.

virtual const DtString& makVrf::DtAppPathResolver::applicationRootName ( ) const

virtual

virtual void makVrf::DtAppPathResolver::setupUserSettingsDirectory	(	const DtFilename &	userSettings,
		const DtFilename &	rootPath,
		bool	copyIfDateIsLater = `true`
	)

virtual

Copies files from shared to user directory. This will only copy files that don't exist in the settings user settings directory.

virtual void makVrf::DtAppPathResolver::setCopyIfDateIsLater ( bool )

virtual

If a file already exists in the user setting directory, copy it from the shared if the shared date is later. Default is false.

bool makVrf::DtAppPathResolver::copyIfDateIsLater ( ) const

inline

virtual DtFilename makVrf::DtAppPathResolver::sharedDataPath ( ) const

virtual

Get the shared data directory. The shared directory can be referenced in other directories using The macro string "$(SHARED_DATA_DIR)".

virtual void makVrf::DtAppPathResolver::setSharedDataPath ( const DtFilename & path )

virtual

virtual DtFilename makVrf::DtAppPathResolver::sharedDataRoot ( ) const

virtual

virtual void makVrf::DtAppPathResolver::setSharedDataRoot ( const DtFilename & path )

virtual

virtual DtString makVrf::DtAppPathResolver::sharedDataStem ( ) const

virtual

virtual void makVrf::DtAppPathResolver::setSharedDataStem ( const DtString & path )

virtual

virtual const DtFilename& makVrf::DtAppPathResolver::rawTerrainPath ( ) const

virtual

Returns the unresolved terrain path.

virtual DtFilename makVrf::DtAppPathResolver::terrainPath ( ) const

virtual

Returns the resolved terrain pathf.

virtual void makVrf::DtAppPathResolver::setTerrainPath ( const DtFilename & path )

virtual

virtual DtString makVrf::DtAppPathResolver::convertQuickIcon ( const DtString & ) const

virtual

Given what was the filename of a quick icon (global plan/scenario event), convert it to a new possible location if it does not exist in the given.

virtual DtString makVrf::DtAppPathResolver::markupTerrainDirectory ( const DtString & orig ) const

virtual

Tries to convert a terrain path to the shared data location.

virtual void makVrf::DtAppPathResolver::replaceAll	(	std::string &	searchText,
		const std::string &	stringToFind,
		const std::string &	stringToReplace
	)		const

protectedvirtual

virtual void makVrf::DtAppPathResolver::setupSharedDataPath ( )

protectedvirtual

Member Data Documentation

DtFilename makVrf::DtAppPathResolver::myDataPath

protected

DtFilename makVrf::DtAppPathResolver::myAppDataPath

protected

DtFilename makVrf::DtAppPathResolver::myUserDataPath

protected

DtFilename makVrf::DtAppPathResolver::myMakLuaPath

protected

DtFilename makVrf::DtAppPathResolver::mySharedSettingsDirectory

protected

DtFilename makVrf::DtAppPathResolver::myUserSettingsDirectory

protected

DtFilename makVrf::DtAppPathResolver::mySharedDataRoot

protected

DtFilename makVrf::DtAppPathResolver::mySharedDataPath

protected

DtFilename makVrf::DtAppPathResolver::myTerrainPath

protected

DtString makVrf::DtAppPathResolver::mySharedDataStem

protected

DtString makVrf::DtAppPathResolver::myApplicationRootName

protected

bool makVrf::DtAppPathResolver::myUseSharedSettingsDirectory

protected

DtString makVrf::DtAppPathResolver::myApplicationName

protected

bool makVrf::DtAppPathResolver::myNeedsToSetupSettingsDirectory

protected

std::vector<DtFilename> makVrf::DtAppPathResolver::myAdditonalModelDefinitionPaths

protected

bool makVrf::DtAppPathResolver::myUserSetSettingsDirectory

protected

bool makVrf::DtAppPathResolver::myCopyIfDateIsLater

protected

DtString makVrf::DtAppPathResolver::myVersionString

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrfutil/appPathResolver.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation