WsfParseIndex Class Reference

#include <WsfParseIndex.hpp>

Collaboration diagram for WsfParseIndex:

Public Member Functions
	WsfParseIndex (WsfParseDefinitions *aDefinitionsPtr)
	~WsfParseIndex ()
void	AddFilePath (const std::string &aPath)
void	DefinePathVariable (const std::string &aVariableName, const std::string &aValue)
void	UndefinePathVariable (const std::string &aVariableName)
void	ResetFilePath ()
void	Clear ()
std::string	SubstitutePathVariables (const std::string &aString) const
bool	HasInclude (const std::string &aFullPath) const
	Returns 'true' if aFullPath has already been included.
size_t	AddInclude (const UtStringRef &aFullPath)
	Add an included file.
const std::vector< UtStringRef > &	GetIncludePath () const
const std::map< UtStringRef, size_t > &	GetIncludes () const
void	SetParseVariable (const std::string &aName, const UtTextDocumentRange &aValue)
const UtTextDocumentRange &	GetParseVariable (const std::string &aName)
void	ClearParseVariable (const std::string &aName)
void	LoadCurrentType (WsfParseType *aCurrentType)
void	UnloadCurrentType ()
WsfParseType *	GetCurrentType ()
int	GenerateName ()

Public Attributes
WsfParseType	mUserTypes

Detailed Description

WsfParseIndex stores a minimal set of information required to continue parsing a wsf core file. Prior to parsing, this should be empty.

Warning: Future code may utilize a hash of this data to do partial re-parsing. Try not to do anything which would prevent that.

Constructor & Destructor Documentation

WsfParseIndex()

WsfParseIndex::WsfParseIndex

(

WsfParseDefinitions *

aDefinitionsPtr

)

References mUserTypes.

~WsfParseIndex()

WsfParseIndex::~WsfParseIndex

(

)

Member Function Documentation

AddFilePath()

void WsfParseIndex::AddFilePath

(

const std::string &

aPath

)

References SubstitutePathVariables().

AddInclude()

size_t WsfParseIndex::AddInclude ( const UtStringRef & aFullPath )

inline

Add an included file.

Clear()

void WsfParseIndex::Clear

(

)

References mUserTypes, and ResetFilePath().

ClearParseVariable()

void WsfParseIndex::ClearParseVariable ( const std::string & aName )

inline

DefinePathVariable()

void WsfParseIndex::DefinePathVariable	(	const std::string &	aVariableName,
		const std::string &	aValue )

GenerateName()

int WsfParseIndex::GenerateName ( )

inline

Referenced by WsfParseTypeLoadRule::GenerateName().

GetCurrentType()

WsfParseType * WsfParseIndex::GetCurrentType ( )

inline

Referenced by WsfParseTypeLoadRule::FindLoadType(), WsfParseTypeCommandRule::Read(), and WsfParseTypeLoadRule::Read().

GetIncludePath()

const std::vector< UtStringRef > & WsfParseIndex::GetIncludePath ( ) const

inline

GetIncludes()

const std::map< UtStringRef, size_t > & WsfParseIndex::GetIncludes ( ) const

inline

GetParseVariable()

const UtTextDocumentRange & WsfParseIndex::GetParseVariable ( const std::string & aName )

inline

HasInclude()

bool WsfParseIndex::HasInclude ( const std::string & aFullPath ) const

inline

Returns 'true' if aFullPath has already been included.

LoadCurrentType()

void WsfParseIndex::LoadCurrentType ( WsfParseType * aCurrentType )

inline

Referenced by WsfParseTypeLoadRule::Read().

ResetFilePath()

void WsfParseIndex::ResetFilePath

(

)

Referenced by Clear().

SetParseVariable()

void WsfParseIndex::SetParseVariable ( const std::string & aName, const UtTextDocumentRange & aValue )

inline

SubstitutePathVariables()

std::string WsfParseIndex::SubstitutePathVariables

(

const std::string &

aString

)

const

Referenced by AddFilePath(), and WsfParseQuotedStringRule::SetFileReference().

UndefinePathVariable()

void WsfParseIndex::UndefinePathVariable

(

const std::string &

aVariableName

)

UnloadCurrentType()

void WsfParseIndex::UnloadCurrentType ( )

inline

Referenced by WsfParseTypeLoadRule::Resolve(), and WsfParseTypeLoadRule::Undo().

Member Data Documentation

mUserTypes

WsfParseType WsfParseIndex::mUserTypes

Referenced by Clear(), WsfParseTypeLoadRule::FindLoadType(), WsfParseTypeLoadRule::Read(), and WsfParseIndex().

---

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

• WsfParseIndex.hpp
• WsfParseIndex.cpp