#include <MacroCmd.h>

Inheritance diagram for MacroCmd:

[legend]

Collaboration diagram for MacroCmd:

[legend]

Public Member Functions
	MacroCmd ()

	MacroCmd (const std::string &name, MacroCmd *parent)

virtual	~MacroCmd ()

virtual void	execute ()
	Execute the macro command. More...

virtual Object *	makeInstance (const std::string &name, Statement &, const Parser *)
	Make a macro instance. More...

virtual Object *	makeTemplate (const std::string &, TokenStream &, Statement &)
	Make a macro template. More...

Public Member Functions inherited from Macro
	Macro (int size, const char name, const char help)
	Exemplar constructor. More...

	Macro (const std::string &name, Object *parent)
	Clone constructor. More...

virtual	~Macro ()

virtual Macro *	clone (const std::string &name)
	Make clone. More...

virtual const std::string	getCategory () const
	Return the object category as a string. More...

virtual bool	shouldTrace () const
	Trace flag. More...

virtual bool	shouldUpdate () const
	Update flag. More...

virtual void	parseActuals (Statement &)
	Parse actual arguments. More...

virtual void	parseFormals (Statement &)
	Parse formal arguments. More...

Public Member Functions inherited from Object
virtual	~Object ()

virtual bool	canReplaceBy (Object *object)
	Test if replacement is allowed. More...

void	copyAttributes (const Object &)
	Copy attributes from another object. More...

virtual Attribute *	findAttribute (const std::string &name)
	Find an attribute by name. More...

virtual const Attribute *	findAttribute (const std::string &name) const
	Find an attribute by name. More...

virtual void	parse (Statement &)
	Parse the object. More...

virtual void	parseShortcut (Statement &, bool eval=true)
	Parser for single-attribute commands. More...

virtual void	print (std::ostream &) const
	Print the object. More...

virtual void	printValue (std::ostream &) const

virtual void	printHelp (std::ostream &) const
	Print help. More...

virtual void	replace (Object oldObject, Object newObject)
	Replace references. More...

virtual void	update ()
	Update this object. More...

bool	isBuiltin () const
	True, if [b]this[/b] is a built-in object. More...

virtual bool	isShared () const
	Shared flag. More...

virtual void	setShared (bool)
	Set/reset shared flag. More...

void	setDirty (bool)
	Set/reset the [b]modified[/b] flag. More...

bool	isDirty () const
	True, if the [b]modified[/b] flag is set. More...

void	setFlag (bool)
	Flag/unflag this object, e. g. to control output of objects for. More...

bool	isFlagged () const
	True, if [b]this[/b] is flagged by setFlag(true). More...

const Object *	getBaseObject () const
	Return the object's base type object. More...

const std::string &	getOpalName () const
	Return object name. More...

Object *	getParent () const
	Return parent pointer. More...

bool	isTreeMember (const Object *subTree) const
	Test for tree membership. More...

void	setOpalName (const std::string &name)
	Set object name. More...

void	setParent (Object *)
	Set parent object. More...

void	clear ()
	Clear the occurrence counter. More...

int	increment ()
	Increment and return the occurrence counter. More...

int	occurrenceCount ()
	Return the occurrence counter. More...

void	registerReference (Invalidator *a)
	Register a reference to this object. More...

void	unregisterReference (Invalidator *a)
	Unegister a reference to this object. More...

void	registerOwnership (const AttributeHandler::OwnerType &itsClass) const

Public Member Functions inherited from RCObject
int	addReference () const
	Increment reference count. More...

int	removeReference () const
	Decrement the reference count. More...

bool	isShared () const
	Test for sharing. More...

Private Member Functions
	MacroCmd (const MacroCmd &)

void	operator= (const MacroCmd &)

Private Attributes
Pointer< MacroStream >	body

const Parser *	itsParser

Additional Inherited Members
Public Attributes inherited from Object
std::vector< Attribute >	itsAttr
	The object attributes. More...

Protected Member Functions inherited from Object
	Object (int size, const char name, const char help)
	Constructor for exemplars. More...

	Object (const std::string &name, Object *parent)
	Constructor for clones. More...

Protected Member Functions inherited from RCObject
	RCObject ()
	Default constructor. More...

	RCObject (const RCObject &)
	Copy constructor. More...

virtual	~RCObject ()=0

RCObject &	operator= (const RCObject &right)

Protected Attributes inherited from Macro
std::vector< std::string >	formals
	The formal argument list. More...

std::vector< std::vector< Token > >	actuals
	The actual argument list. More...

Protected Attributes inherited from Object
bool	builtin
	Built-in flag. More...

bool	modified
	Dirty flag. More...

bool	flagged
	Object flag. More...

Detailed Description

Definition at line 35 of file MacroCmd.h.

Constructor & Destructor Documentation

◆ MacroCmd() [1/3]

MacroCmd::MacroCmd ( )

Definition at line 34 of file MacroCmd.cpp.

Referenced by makeInstance(), and makeTemplate().

◆ MacroCmd() [2/3]

MacroCmd::MacroCmd	(	const std::string &	name,
		MacroCmd *	parent
	)

Definition at line 42 of file MacroCmd.cpp.

References body, and name.

◆ ~MacroCmd()

MacroCmd::~MacroCmd ( )

virtual

Definition at line 48 of file MacroCmd.cpp.

◆ MacroCmd() [3/3]

MacroCmd::MacroCmd ( const MacroCmd & )

private

Member Function Documentation

◆ execute()

void MacroCmd::execute ( )

virtual

Execute the macro command.

Reimplemented from Object.

Definition at line 52 of file MacroCmd.cpp.

References body, itsParser, Parser::run(), and MacroStream::start().

Here is the call graph for this function:

◆ makeInstance()

Object * MacroCmd::makeInstance	(	const std::string &	name,
		Statement &	statement,
		const Parser *	parser
	)

virtual

Make a macro instance.

Reimplemented from Object.

Definition at line 58 of file MacroCmd.cpp.

References Macro::actuals, MacroStream::append(), body, Macro::formals, Token::getWord(), Token::isEOF(), Token::isWord(), itsParser, MacroCmd(), name, Macro::parseActuals(), MacroStream::readToken(), and MacroStream::start().

Here is the call graph for this function:

◆ makeTemplate()

Object * MacroCmd::makeTemplate	(	const std::string &	name,
		TokenStream &	,
		Statement &	statement
	)

virtual

Make a macro template.

Reimplemented from Object.

Definition at line 101 of file MacroCmd.cpp.

References MacroStream::append(), Statement::atEnd(), body, Statement::delimiter(), Statement::getCurrent(), Token::isDel(), Statement::keyword(), MacroCmd(), name, Macro::parseFormals(), and PAssert.

Here is the call graph for this function:

◆ operator=()

void MacroCmd::operator= ( const MacroCmd & )

private

Member Data Documentation

◆ body

Pointer<MacroStream> MacroCmd::body

private

Definition at line 64 of file MacroCmd.h.

Referenced by execute(), MacroCmd(), makeInstance(), and makeTemplate().

◆ itsParser

const Parser* MacroCmd::itsParser

private

Definition at line 67 of file MacroCmd.h.

Referenced by execute(), and makeInstance().

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

/Users/gsell/src/OPAL/src/src/OpalParser/MacroCmd.h
/Users/gsell/src/OPAL/src/src/OpalParser/MacroCmd.cpp

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MacroCmd() [1/3]

◆ MacroCmd() [2/3]

◆ ~MacroCmd()

◆ MacroCmd() [3/3]

Member Function Documentation

◆ execute()

◆ makeInstance()

◆ makeTemplate()

◆ operator=()

Member Data Documentation

◆ body

◆ itsParser