Classes
struct	ScopeSetter
	Functor setting the scope of a sage node to a specified (at Functor construction time) scope. More...

struct	VarRefBuilder
	Functor building a variable reference from an initialized name. More...

struct	InitNameCloner
	Functor copying an initialized name into a different scope. More...

struct	SageInserter
	Generic inserter for sage containers. More...

struct	ConstLike
	projects the constness of T1 on T2 More...

struct	ConstLike< const T1, T2 >

struct	DispatchHandler

struct	VisitDispatcher
	implementation for dispatcher objects ( invokes roseVisitor.handle(sgnode) ) More...

struct	VisitDispatcher< T * >
	implementation for dispatcher pointers ( invokes roseVisitor->handle(sgnode) ) More...

struct	DefaultHandler

struct	AncestorTypeFinder
	helper class for _ancestor More...

struct	TypeRecoveryHandler

Functions
template<class SageNode >
static SageNode *	cloneNode (const SageNode *n)
	returns a deep copy of a sage node More...

static void	_append (SgExprListExp &container, SgExpression *elem)
	unified interface for storing an element in a sage container More...

static void	_append (SgFunctionParameterList &container, SgInitializedName *elem)

template<class SageSequenceContainer >
SageInserter < SageSequenceContainer >	sage_inserter (SageSequenceContainer &cont)
	generates a SageInserter, adding elements at the end of a sequence More...

template<class T >
static void	unused (const T &)
	portable implementation to avoid compiler warnings for unused parameter. More...

template<class T >
T &	deref (T *ptr)
	dereferences an object (= checked dereference in debug mode) More...

static void	unexpected_node (const SgNode &n)

template<class SageNode >
static SageNode &	assume_sage_type (SgNode &n)
	unchecked down cast from SgNode to SageNode More...

template<class SageNode >
static const SageNode &	assume_sage_type (const SgNode &n)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...

template<class RoseVisitor , class SageNode >
static RoseVisitor	_dispatch (RoseVisitor rv, SageNode *n)
	for internal use (use dispatch instead) More...

template<class RoseVisitor >
RoseVisitor	dispatch (const RoseVisitor &rv, SgNode *n)
	uncovers the type of SgNode and passes it to an overloaded function handle in RoseVisitor. More...

template<class RoseVisitor >
RoseVisitor	dispatch (const RoseVisitor &rv, const SgNode *n)

template<class AncestorNode , class QualSgNode >
AncestorNode *	_ancestor (QualSgNode &n)
	implements the ancestor search More...

template<class AncestorNode >
AncestorNode *	ancestor (SgNode *n)
	finds an ancestor node with a given type More...

template<class AncestorNode >
const AncestorNode *	ancestor (const SgNode *n)

template<class AncestorNode >
AncestorNode &	ancestor (SgNode &n)

template<class AncestorNode >
const AncestorNode &	ancestor (const SgNode &n)

template<class SageNode >
SageNode *	assert_sage_type (SgNode *n)
	asserts that n has type SageNode More...

template<class SageNode >
const SageNode *	assert_sage_type (const SgNode *n)

static void	swap_parent (SgNode lhs, SgNode rhs)
	swaps the parent pointer of two nodes More...

static void	swap_parent (void , void )
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...

template<class SageNode , class SageChild >
void	swap_child (SageNode &lhs, SageNode &rhs, SageChild (SageNode::getter)() const, void(SageNode::setter)(SageChild ))
	swaps children (of equal kind) between two ancestor nodes of the same type More...

Function Documentation

template<class SageNode >

static SageNode* sg::cloneNode ( const SageNode * n)

inlinestatic

returns a deep copy of a sage node

allows NULL input nodes (in contrast to SageInterface::deepCopy)

Definition at line 21 of file sageFunctors.h.

References SageInterface::deepCopy().

Referenced by sg::InitNameCloner::operator()().

static void sg::_append	(	SgExprListExp &	container,
		SgExpression *	elem
	)

inlinestatic

unified interface for storing an element in a sage container

Note: internal use

Definition at line 31 of file sageFunctors.h.

References SageInterface::appendExpression().

Referenced by sg::SageInserter< SageSequenceContainer >::operator=().

static void sg::_append	(	SgFunctionParameterList &	container,
		SgInitializedName *	elem
	)

inlinestatic

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 38 of file sageFunctors.h.

References SageInterface::appendArg().

template<class SageSequenceContainer >

SageInserter<SageSequenceContainer> sg::sage_inserter ( SageSequenceContainer & cont)

generates a SageInserter, adding elements at the end of a sequence

Template Parameters

SageSequenceContainer,a sage container that supports appending an element

Definition at line 137 of file sageFunctors.h.

template<class T >

static void sg::unused ( const T & )

inlinestatic

portable implementation to avoid compiler warnings for unused parameter.

Definition at line 33 of file sageGeneric.h.

template<class T >

T& sg::deref ( T * ptr)

dereferences an object (= checked dereference in debug mode)

Definition at line 37 of file sageGeneric.h.

static void sg::unexpected_node ( const SgNode & n)

inlinestatic

Definition at line 60 of file sageGeneric.h.

References name, and unused().

Referenced by _dispatch(), and sg::TypeRecoveryHandler< SageNode >::handle().

template<class SageNode >

static SageNode& sg::assume_sage_type ( SgNode & n)

inlinestatic

unchecked down cast from SgNode to SageNode

Definition at line 103 of file sageGeneric.h.

template<class SageNode >

static const SageNode& sg::assume_sage_type ( const SgNode & n)

inlinestatic

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Note: overloaded to preserve constness

Definition at line 112 of file sageGeneric.h.

template<class RoseVisitor , class SageNode >

static RoseVisitor sg::_dispatch	(	RoseVisitor	rv,
		SageNode *	n
	)

inlinestatic

for internal use (use dispatch instead)

Definition at line 147 of file sageGeneric.h.

Referenced by dispatch().

template<class RoseVisitor >

RoseVisitor sg::dispatch	(	const RoseVisitor &	rv,
		SgNode *	n
	)

inline

uncovers the type of SgNode and passes it to an overloaded function handle in RoseVisitor.

Template Parameters

RoseVisitor the visitor that will be called back with the recovered type information. The handle function with the most suitable SgNode type will get invoked.

Parameters

rv	an instance of a rose visitor; note that the argument is essentially passed by value (similar to STL's for_each).
n	a Sage node

Returns: a copy of the RoseVisitor object

The following code has two classes.

Counter counts the number of all expression and statement nodes. It implements handlers for SgNode (not interesting nodes), for SgExpression and SgStatement (to count the nodes).
Traversal inherits from ASTTraversal and contains a counter. The dispatch function is invoked using a Counter object and a pointer to an AST node. Since the counter object is passed by value we need to store back the result (similar to std::for_each).
struct Counter

{

size_t expr;

size_t decl;

Counter() : expr(0), decl(0) {}

void handle(const SgNode&) {}

void handle(const SgExpression&) { ++expr; }

void handle(const SgStatement&) { ++stmt; }

};

struct Traversal : ASTTraversal

{

Counter ctr;

void visit(SgNode* n)

{

ctr = sg::dispatch(ctr, n);

}

void run(SgNode& root)

{

traverse(&root, preorder);

std::cout << "Expr/Stmt ratio = " << ratio(ctr.expr, ctr.stmt) << std::endl;

}

static

float ratio(float a, float b) { return a/b; }

};

Alternatively, the dispatch function takes a pointer to a handler object. In this case, the counter object is passed as pointer, and ctr is manipulated directly (no need to store back the result).
void visit(SgNode* n)

{

sg::dispatch(&ctr, n);

}

Definition at line 2790 of file sageGeneric.h.

References _dispatch().

Referenced by _ancestor(), _dispatch(), and assert_sage_type().

template<class RoseVisitor >

RoseVisitor sg::dispatch	(	const RoseVisitor &	rv,
		const SgNode *	n
	)

inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 2799 of file sageGeneric.h.

References _dispatch().

template<class AncestorNode , class QualSgNode >

AncestorNode* sg::_ancestor ( QualSgNode & n)

implements the ancestor search

see comments for AncestorTypeFinder

Definition at line 2842 of file sageGeneric.h.

References dispatch().

template<class AncestorNode >

AncestorNode* sg::ancestor ( SgNode * n)

finds an ancestor node with a given type

the function family comes in four variants:

SgNode* -> AncestorNode* ( result can be NULL )
const SgNode* -> const AncestorNode* ( result can be NULL )
SgNode& -> AncestorNode& ( assert(false) when an ancestor of the specified type cannot be found )
const SgNode& -> const AncestorNode& ( assert(false) when an ancestor of the specified type cannot be found )
const SgStatement* enclosingStatement(const SgExpression* e) { return sg::ancestor<SgStatement>(e); }

Definition at line 2868 of file sageGeneric.h.

Referenced by DominatorTreesAndDominanceFrontiers::TemplatedDominatorTree< CFGFilterFunction >::depthFirstSearch(), DominatorTreesAndDominanceFrontiers::TemplatedDominatorTree< CFGFilterFunction >::eval(), DominatorTreesAndDominanceFrontiers::TemplatedDominatorTree< CFGFilterFunction >::init(), and DominatorTreesAndDominanceFrontiers::TemplatedDominatorTree< CFGFilterFunction >::link().

template<class AncestorNode >

const AncestorNode* sg::ancestor ( const SgNode * n)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 2877 of file sageGeneric.h.

template<class AncestorNode >

AncestorNode& sg::ancestor ( SgNode & n)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 2886 of file sageGeneric.h.

template<class AncestorNode >

const AncestorNode& sg::ancestor ( const SgNode & n)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 2896 of file sageGeneric.h.

template<class SageNode >

SageNode* sg::assert_sage_type ( SgNode * n)

asserts that n has type SageNode

the ROSE assert in the following example holds b/c assert_sage_type aborts if the input node is not a SgStatement

SgStatement* stmt = assert_sage_type<SgStatement>(expr.get_parent());

ROSE_ASSERT(stmt);

Definition at line 2929 of file sageGeneric.h.

References dispatch().

template<class SageNode >

const SageNode* sg::assert_sage_type ( const SgNode * n)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 2936 of file sageGeneric.h.

References dispatch().

static void sg::swap_parent	(	SgNode *	lhs,
		SgNode *	rhs
	)

inlinestatic

swaps the parent pointer of two nodes

Note: internal use

Definition at line 2944 of file sageGeneric.h.

References SgNode::get_parent(), and SgNode::set_parent().

Referenced by swap_child().

static void sg::swap_parent	(	void *	,
		void *
	)

inlinestatic

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Note: for non sage nodes (nodes without a parent) e.g., Rose_Containers

Definition at line 2956 of file sageGeneric.h.

template<class SageNode , class SageChild >

void sg::swap_child	(	SageNode &	lhs,
		SageNode &	rhs,
		SageChild (SageNode::)() const	getter,
		void(SageNode::)(SageChild )	setter
	)

swaps children (of equal kind) between two ancestor nodes of the same type

Template Parameters

SageNode	the parent node type
SageChild	the child node type

Parameters

lhs	one parent node
rhs	another parent node
getter	the getter function to extract the child from lhs (and rhs)
setter	the setter function to store the child in lhs (and rhs)

Definition at line 2966 of file sageGeneric.h.

References swap_parent().

Classes

Functions

Function Documentation