Puma::MacroUnit Class Reference

#include <Puma/MacroUnit.h>

Inheritance diagram for Puma::MacroUnit:

Description

Specialized unit for preprocessor macro expansions.

Public Member Functions
	MacroUnit ()
	Construct an empty macro unit.
	MacroUnit (const Unit &unit)
	Construct a macro unit.
virtual	~MacroUnit ()
	Destructor.
virtual bool	isMacroExp () const
	Check if this is a macro expansion unit.
void	CallingUnit (Unit *unit)
	Set the unit containing the macro call.
Unit *	CallingUnit () const
	Get the unit containing the macro call.
void	MacroBegin (Token *token)
	Set the first token of the macro call in the calling unit.
void	MacroEnd (Token *token)
	Set the last token of the macro call in the calling unit.
Token *	MacroBegin () const
	Get the first token of the macro call in the calling unit.
Token *	MacroEnd () const
	Get the last token of the macro call in the calling unit.
Token *	ExpansionBegin (Token *token) const
	Get the first token of the whole macro expansion in the source file if the given token is the first token of this expansion or nested expansion (macro generated macro call).
Token *	ExpansionEnd (Token *token) const
	Get the last token of the whole macro expansion in the source file if the given token is the last token of this expansion or nested expansion (macro generated macro call).
Public Member Functions inherited from Puma::Unit
	Unit ()
	Constructor.
	Unit (const List &list)
	Copy-constructor.
virtual	~Unit ()
	Destructor.
virtual void	name (const char *name)
	Set the name of the unit (usually the file name).
char *	name () const
	Get the name of the unit (usually the file name).
virtual void	print (std::ostream &os) const
	Print the tokens of the unit on the given stream.
virtual bool	isFile () const
	Check if this is a unit for a file.
virtual bool	isTemplateInstance () const
	Check if this is a unit for a template instance.
UnitState &	state ()
	Get the state of the unit.
char *	toString () const
	Serialize the tokens of the unit.
Token *	first () const
	Get the first token in the unit.
Token *	last () const
	Get the last token in the unit.
Token *	next (const Token *token) const
	Get the next token of the given token.
Token *	prev (const Token *token) const
	Get the previous token of the given token.
Public Member Functions inherited from Puma::List
	List ()
	Constructor.
	List (const List &copy)
	Copy-constructor.
	~List ()
	Destructor.
List &	operator= (const List &copy)
	Assignment operator.
List &	operator+= (const List &list)
	Append the given list.
List	operator+ (const List &list)
	Create a new list containing the elements of this list followed by the elements of the given list.
void	clear ()
	Destroy the list elements.
void	append (ListElement &element)
	Append an element to the list.
void	prepend (ListElement &element)
	Prepend an element to the list.
void	insert (ListElement *at, ListElement &element)
	Insert an element at the given list position.
void	remove (ListElement *element)
	Remove the given element from the list.
void	kill (ListElement *from, ListElement *to=(ListElement *) 0)
	Remove and destroy all elements between the given list elements.
void	cut (List &out, ListElement *from, ListElement *to=(ListElement *) 0)
	Cut all elements between the given list elements.
List *	copy (ListElement *from=(ListElement *) 0, ListElement *to=(ListElement *) 0)
	Copy all elements between the given list elements.
void	paste (ListElement *at, const List &l)
	Insert copies of the elements of the given list at the given list position.
void	paste_before (ListElement *at, const List &l)
	Insert copies of the elements of the given list before the given list position.
void	move (ListElement *at, List &l)
	Insert the elements of the given list at the given list position.
void	move_before (ListElement *at, List &l)
	Insert the elements of the given list before the given list position.
bool	empty () const
	Check if the list is empty.
const ListElement *	first () const
	Get the first element in the list.
const ListElement *	last () const
	Get the last element in the list.
const ListElement *	next (const ListElement *element) const
	Get the next element of the given element.
const ListElement *	prev (const ListElement *element) const
	Get the previous element of the given element.
Public Member Functions inherited from Puma::Printable
virtual	~Printable ()
	Destructor.

Constructor & Destructor Documentation

MacroUnit() [1/2]

Puma::MacroUnit::MacroUnit ( )

inline

Construct an empty macro unit.

MacroUnit() [2/2]

Puma::MacroUnit::MacroUnit ( const Unit & unit )

inline

Construct a macro unit.

Parameters

unit	The unit containing the macro expansion.

~MacroUnit()

virtual Puma::MacroUnit::~MacroUnit ( )

inlinevirtual

Destructor.

Member Function Documentation

CallingUnit() [1/2]

Unit * Puma::MacroUnit::CallingUnit ( ) const

inline

Get the unit containing the macro call.

Returns

A pointer to the unit, or NULL if not set.

CallingUnit() [2/2]

void Puma::MacroUnit::CallingUnit ( Unit * unit )

inline

Set the unit containing the macro call.

Parameters

unit

The unit.

ExpansionBegin()

Token * Puma::MacroUnit::ExpansionBegin

(

Token *

token

)

const

Get the first token of the whole macro expansion in the source file if the given token is the first token of this expansion or nested expansion (macro generated macro call).

Parameters

token

The token.

Returns

The first token, or NULL otherwise.

ExpansionEnd()

Token * Puma::MacroUnit::ExpansionEnd

(

Token *

token

)

const

Get the last token of the whole macro expansion in the source file if the given token is the last token of this expansion or nested expansion (macro generated macro call).

Parameters

token

The token.

Returns

The last token, or NULL otherwise.

isMacroExp()

virtual bool Puma::MacroUnit::isMacroExp ( ) const

inlinevirtual

Check if this is a macro expansion unit.

Returns

Always returns true.

Reimplemented from Puma::Unit.

MacroBegin() [1/2]

Token * Puma::MacroUnit::MacroBegin ( ) const

inline

Get the first token of the macro call in the calling unit.

Returns

A pointer to the token.

MacroBegin() [2/2]

void Puma::MacroUnit::MacroBegin ( Token * token )

inline

Set the first token of the macro call in the calling unit.

Parameters

token

The first token.

MacroEnd() [1/2]

Token * Puma::MacroUnit::MacroEnd ( ) const

inline

Get the last token of the macro call in the calling unit.

Returns

A pointer to the token.

MacroEnd() [2/2]

void Puma::MacroUnit::MacroEnd ( Token * token )

inline

Set the last token of the macro call in the calling unit.

Parameters

token

The last token.