wizard::RunEnvManager Class Reference

#include <RunEnvManager.hpp>

Static Public Member Functions
static bool	Initialize (const UtPath &aBinPath, std::string &aErrorString)
static std::string	GetVersionString (bool aDate=true)
static void	SetVersion (int aMajor, int aMinor, int aPatch)
static const UtPath &	GetInstallRootDir ()
static const UtPath &	GetBinDir ()
static const UtPath &	GetDemosDir ()
static const UtPath &	GetTrainingDir ()
static const UtPath &	GetScenariosDir ()
static const UtPath &	GetDocumentationDir ()
static const UtPath &	GetDataDir ()
static const UtPath &	GetGrammarDir ()
static bool	HasDeveloperPaths ()
static std::vector< UtPath >	GetDemoSearchPaths ()
static std::string	DocumentationURL_Static (const std::string &aPageName, const std::string &aAnchor=std::string())
static std::string	DocumentationURL (const std::string &aPageName, const std::string &aAnchor=std::string())
static UtPath	Search (const std::vector< UtPath > &aPathsToSearch, const UtPath &aRelativePath, bool aTargetIsDirectory)
	Search for a file in a list of directories. returns an empty path if the file is not found.
static UtPath	RelativePath (const std::vector< UtPath > &aPathsToSearch, const UtPath &aFullPath)
	Complimentary to Search(), this yields the best relative path given a search path.
static UtPath	FindCriticalResource (const std::string &aFileRelativePath)
static std::string	GetSimpleVersionString ()

Member Function Documentation

DocumentationURL()

std::string wizard::RunEnvManager::DocumentationURL ( const std::string & aPageName, const std::string & aAnchor = std::string() )

static

References DocumentationURL_Static().

Referenced by wizard::BrowserWidget::LinkClicked(), and wizard::DocumentationInterpretter::LookupDocumentationUrl().

DocumentationURL_Static()

std::string wizard::RunEnvManager::DocumentationURL_Static ( const std::string & aPageName, const std::string & aAnchor = std::string() )

static

References GetDocumentationDir().

Referenced by DocumentationURL().

FindCriticalResource()

UtPath wizard::RunEnvManager::FindCriticalResource ( const std::string & aFileRelativePath )

static

References GetDataDir().

GetBinDir()

const UtPath & wizard::RunEnvManager::GetBinDir ( )

static

Referenced by wizard::Runner::run().

GetDataDir()

const UtPath & wizard::RunEnvManager::GetDataDir ( )

static

Referenced by wizard::WsfExecution::DebugSettingsString(), FindCriticalResource(), and wizard::Runner::run().

GetDemosDir()

const UtPath & wizard::RunEnvManager::GetDemosDir ( )

static

GetDemoSearchPaths()

std::vector< UtPath > wizard::RunEnvManager::GetDemoSearchPaths ( )

static

GetDocumentationDir()

const UtPath & wizard::RunEnvManager::GetDocumentationDir ( )

static

Referenced by wizard::WsfExe::BeginBuildDoc(), and DocumentationURL_Static().

GetGrammarDir()

const UtPath & wizard::RunEnvManager::GetGrammarDir ( )

static

Referenced by wizard::WsfExeManager::GetDefaultGrammar().

GetInstallRootDir()

const UtPath & wizard::RunEnvManager::GetInstallRootDir ( )

static

GetScenariosDir()

const UtPath & wizard::RunEnvManager::GetScenariosDir ( )

static

GetSimpleVersionString()

std::string wizard::RunEnvManager::GetSimpleVersionString ( )

static

Referenced by GetVersionString().

GetTrainingDir()

const UtPath & wizard::RunEnvManager::GetTrainingDir ( )

static

GetVersionString()

std::string wizard::RunEnvManager::GetVersionString ( bool aDate = true )

static

References GetSimpleVersionString().

HasDeveloperPaths()

bool wizard::RunEnvManager::HasDeveloperPaths ( )

static

Initialize()

bool wizard::RunEnvManager::Initialize ( const UtPath & aBinPath, std::string & aErrorString )

static

References ok.

Referenced by wizard::Runner::run().

RelativePath()

UtPath wizard::RunEnvManager::RelativePath ( const std::vector< UtPath > & aPathsToSearch, const UtPath & aFullPath )

static

Complimentary to Search(), this yields the best relative path given a search path.

Search()

UtPath wizard::RunEnvManager::Search ( const std::vector< UtPath > & aPathsToSearch, const UtPath & aRelativePath, bool aTargetIsDirectory )

static

Search for a file in a list of directories. returns an empty path if the file is not found.

SetVersion()

void wizard::RunEnvManager::SetVersion ( int aMajor, int aMinor, int aPatch )

static

Referenced by wizard_main().

---

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

• RunEnvManager.hpp
• RunEnvManager.cpp