#include <WsfGrammarInterface.hpp>

Inheritance diagram for WsfGrammarExtension:

[legend]

Collaboration diagram for WsfGrammarExtension:

[legend]

Public Member Functions
	WsfGrammarExtension ()
int	ProcessCommandLine (WsfStandardApplication::Options &aOptions, int aArgc, char *aArgv[]) override
void	ProcessCommandLineCommands () override
void	AddGrammarFile (const std::string &aGrammarFilePath)
int	AddGrammarDirectory (const std::string &aGrammarDirectoryPath)
	Adds all files with the .ag extension to the grammar text.
void	AddGrammarText (const std::string &aGrammarText)
const std::string &	GetGrammarText ()
	Returns the WSF grammar text.
Public Member Functions inherited from WsfApplicationExtension
	WsfApplicationExtension ()
	Constructor.
	~WsfApplicationExtension () override
WsfApplication &	GetApplication () const
virtual void	PrintCommandLineArguments () const
virtual void	PrintGrammar (std::ostream &aOut)
virtual void	AddedToApplication (WsfApplication &aApplication)
virtual void	ScenarioCreated (WsfScenario &aScenario)
virtual void	SimulationCreated (WsfSimulation &aSimulation)
Public Member Functions inherited from WsfExtension
virtual	~WsfExtension ()=default
const std::string &	GetExtensionName () const

Static Public Member Functions
static WsfGrammarExtension *	Find (WsfApplication &aApplication)

Additional Inherited Members
Protected Member Functions inherited from WsfExtension
void	InitializeExtensionName (const std::string &aName)

Detailed Description

Manages grammar files for the application. Tests the WSF parser if it is included in the build.

Constructor & Destructor Documentation

◆ WsfGrammarExtension()

WsfGrammarExtension::WsfGrammarExtension ( )

Referenced by Find().

Member Function Documentation

◆ AddGrammarDirectory()

int WsfGrammarExtension::AddGrammarDirectory ( const std::string & aGrammarDirectoryPath )

Adds all files with the .ag extension to the grammar text.

References AddGrammarFile().

◆ AddGrammarFile()

void WsfGrammarExtension::AddGrammarFile ( const std::string & aGrammarFilePath )

Adds a file containing grammar text to the grammar input. Applications and WSF libraries should add grammar for processing input commands with either AddGrammarText() or AddGrammarFile()

Referenced by AddGrammarDirectory().

◆ AddGrammarText()

void WsfGrammarExtension::AddGrammarText ( const std::string & aGrammarText )

Adds a block of grammar text to the grammar input. Applications and WSF libraries should add grammar for processing input commands with either AddGrammarText() or AddGrammarFile()

◆ Find()

WsfGrammarExtension * WsfGrammarExtension::Find ( WsfApplication & aApplication )

static

References WsfApplication::FindExtension(), WsfApplicationExtension::WsfApplication, and WsfGrammarExtension().

Referenced by WsfGrammarCheckExtension::FileLoaded().

◆ GetGrammarText()

const std::string & WsfGrammarExtension::GetGrammarText ( )

Returns the WSF grammar text.

Referenced by WsfGrammarCheckExtension::FileLoaded().

◆ ProcessCommandLine()

int WsfGrammarExtension::ProcessCommandLine	(	WsfStandardApplication::Options &	aOptions,
		int	aArgc,
		char *	aArgv[] )

overridevirtual

Called by WsfApplication::ProcessCommandLine to examine the current argument and process if necessary. If the application extension recognizes the argument, this method should return the number of entries processed.

Parameters

aOptions	The application options used to start the application
aArgc	The number of arguments remaining in the argument list.
aArgv	Any array of the arguments remaining in the argument list.

Returns: The number of arguments processed.

Reimplemented from WsfApplicationExtension.

References WsfStandardApplication::cWRITE_GRAMMAR, and WsfStandardApplication::Options::mRunMode.

◆ ProcessCommandLineCommands()

void WsfGrammarExtension::ProcessCommandLineCommands ( )