wizard::GrammarDocumentation Class Reference

#include <GrammarDocumentation.hpp>

Classes
struct	CommandFormatData
struct	CommandFormatGroup
struct	PageCommand
struct	PageData

Public Types
typedef std::vector< std::string >	StringList

Public Member Functions
void	Process (WsfParseDefinitions &aDefinitions, const std::string &aWikiIndexFile)
bool	FindDocumentation (WsfParseNode *aNodePtr, std::string &aPageLink, std::string &aAnchor)
std::string	GetPageName (std::string aPageLink)
CommandFormatGroup *	FindCommandFormatGroup (WsfParseRule *aReaderPtr)

Public Attributes
std::map< std::string, CommandFormatGroup >	mRuleCommandData
std::map< WsfParseRule *, std::string >	mReaderToRuleName
std::map< WsfParseRule *, WsfParseRule * >	mReaderToRule
std::map< std::string, std::string >	mPageTitleToLink
std::map< std::string, std::string >	mPageLinkToName
UtPath	mDocumentationDir

Member Typedef Documentation

StringList

typedef std::vector<std::string> wizard::GrammarDocumentation::StringList

Member Function Documentation

FindCommandFormatGroup()

wizard::GrammarDocumentation::CommandFormatGroup * wizard::GrammarDocumentation::FindCommandFormatGroup

(

WsfParseRule *

aReaderPtr

)

References mReaderToRule, mReaderToRuleName, and mRuleCommandData.

Referenced by FindDocumentation().

FindDocumentation()

bool wizard::GrammarDocumentation::FindDocumentation	(	WsfParseNode *	aNodePtr,
		std::string &	aPageLink,
		std::string &	aAnchor )

References WsfParseNode::cTYPE_REFERENCE_NODE, FindCommandFormatGroup(), wizard::ParseUtil::FindReferenceType(), WsfParseNode::GetFlags(), WsfParseNode::GetParent(), WsfParseNode::Left(), wizard::GrammarDocumentation::CommandFormatGroup::mCommands, mPageTitleToLink, WsfParseNode::mRulePtr, and WsfParseNode::mValue.

Referenced by wizard::DocumentationInterpretter::FindDocumentation(), wizard::CommandDocumentation::FindDocumentationUrl(), and wizard::CommandDocumentation::PeekDocumentationText().

GetPageName()

std::string wizard::GrammarDocumentation::GetPageName

(

std::string

aPageLink

)

References mPageLinkToName.

Process()

void wizard::GrammarDocumentation::Process	(	WsfParseDefinitions &	aDefinitions,
		const std::string &	aWikiIndexFile )

References WsfParseRule::cALTERNATE, WsfParseRule::cLITERAL, CompareTitleToRuleName(), WsfParseRule::cRECURRENCE, GetAllAlternates(), WsfParseDefinitions::GetFullRuleName(), WsfParseDefinitions::GetGlobalRule(), WsfParseDefinitions::GetRoot(), WsfParseRule::GetSubordinateRule(), wizard::GrammarDocumentation::PageCommand::mAnchor, wizard::GrammarDocumentation::CommandFormatGroup::mCommands, wizard::GrammarDocumentation::PageData::mCommands, mDocumentationDir, wizard::GrammarDocumentation::PageCommand::mFormat, wizard::GrammarDocumentation::PageData::mLink, wizard::GrammarDocumentation::CommandFormatGroup::mName, mPageLinkToName, wizard::GrammarDocumentation::PageCommand::mPagePtr, mPageTitleToLink, wizard::GrammarDocumentation::CommandFormatData::mReaderPtr, mReaderToRule, mReaderToRuleName, mRuleCommandData, wizard::GrammarDocumentation::PageData::mRuleReferences, wizard::GrammarDocumentation::CommandFormatData::mSubCommands, WsfParseLiteral::mText, wizard::GrammarDocumentation::PageData::mTitle, wizard::GrammarDocumentation::CommandFormatData::mWords, and WsfParseRule::Type().

Member Data Documentation

mDocumentationDir

UtPath wizard::GrammarDocumentation::mDocumentationDir

Referenced by wizard::WsfScriptData::FindScriptTypeDocumentation(), wizard::CommandDocumentation::PageURL(), wizard::CommandDocumentation::PeekDocumentationText(), and Process().

mPageLinkToName

std::map<std::string, std::string> wizard::GrammarDocumentation::mPageLinkToName

Referenced by GetPageName(), and Process().

mPageTitleToLink

std::map<std::string, std::string> wizard::GrammarDocumentation::mPageTitleToLink

Referenced by FindDocumentation(), and Process().

mReaderToRule

std::map<WsfParseRule*, WsfParseRule*> wizard::GrammarDocumentation::mReaderToRule

Referenced by FindCommandFormatGroup(), and Process().

mReaderToRuleName

std::map<WsfParseRule*, std::string> wizard::GrammarDocumentation::mReaderToRuleName

Referenced by FindCommandFormatGroup(), and Process().

mRuleCommandData

std::map<std::string, CommandFormatGroup> wizard::GrammarDocumentation::mRuleCommandData

Referenced by FindCommandFormatGroup(), and Process().

---

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

• GrammarDocumentation.hpp
• GrammarDocumentation.cpp