SageInterface Namespace Reference

Description

Functions that are useful when operating on the AST.

The Sage III IR design attempts to be minimalist. Thus additional functionality is intended to be presented using separate higher level interfaces which work with the IR. This namespace collects functions that operate on the IR and support numerous types of operations that are common to general analysis and transformation of the AST.

Namespaces
namespace	Ada
	Contains Ada-specific functionality.

Classes
struct	const_int_expr_t
class	DeclarationSets
struct	DeferredTransformation
class	OutputLocalSymbolTables
struct	PreprocessingInfoData
class	StatementGenerator
	Interface for creating a statement whose computation writes its answer into a given variable. More...
struct	Transformation_Record
class	UniqueNameAttribute
	A persistent attribute to represent a unique name for an expression. More...

Typedefs
typedef bool(*	EquivalenceTestFunctionType) (SgNode *x, SgNode *y)

Functions
DeclarationSets *	buildDeclarationSets (SgNode *)
void	addMessageStatement (SgStatement *stmt, std::string message)
	Function to add "C" style comment to statement.
void	addComment (SgAsmStatement *stmt, const std::string &input_string)
SgAsmElfSection *	getSection (SgProject *project, const std::string &name)
SgAsmElfSection *	getSection (SgProject *project, size_t ptr)
SgAsmFunction *	getAsmFunction (SgAsmInstruction *asmInstruction)
	Traverses AST backwards up the tree along the "parent" edges to the SgAsmFunction.
SgAsmBlock *	getAsmBlock (SgAsmInstruction *asmInstruction)
	Traverses AST backwards up the tree along the "parent" edges to the SgAsmBlock.
SgAsmInterpretation *	getAsmInterpretation (SgAsmNode *asmNode)
	Traverses AST backwards up the tree along the "parent" edges to the SgAsmInterpretation.
std::string	generateUniqueName (size_t value, std::map< size_t, int > &usedOffsets, size_t &counter)
size_t	get_value (SgAsmValueExpression *asmValueExpression)
std::string	get_valueString (SgAsmValueExpression *asmValueExpression)
bool	isMovInstruction (SgAsmInstruction *asmInstruction)
bool	isInstructionKind (SgAsmInstruction *asmInstruction, Rose::BinaryAnalysis::X86InstructionKind instuctionKind)
bool	equivalenceTest (SgNode *x, SgNode *y)
std::vector< SgNode * >	flattenAST (SgNode *node)
std::vector< SgNode * >	matchAST (SgNode *node, std::vector< SgNode * > &listOfNodes, EquivalenceTestFunctionType equivalenceTest)
std::vector< SgNode * >	find (SgNode *astNode, SgNode *target, EquivalenceTestFunctionType equivalenceTest)
bool	isNOP (SgAsmInstruction *asmInstruction)
	Test an instruction for if it has no side-effect to the state (is so then it is a NOP). This is a more general test than if it is equivelent to the NOP memonic instruction.
bool	isNOP (const std::vector< SgAsmInstruction * > &asmInstructionList)
	Test a sequence of instructions for it they (as a set) have no side-effects to the state (is so then it is a NOP sequence).
std::vector< std::vector< SgAsmInstruction * > >	find_NOP_sequences (SgAsmBlock *asmBlock)
	find sequences of NOP instructions in a SgAsmBlock
void	insertInstruction (SgAsmInstruction *targetInstruction, SgAsmInstruction *newInstruction, bool insertBefore)
	Support for insertion of instruction relative to a target instruction.
void	insertInstructionBefore (SgAsmInstruction *targetInstruction, SgAsmInstruction *newInstruction)
	Insert a instruction before a target instruction.
void	removeInstruction (SgAsmStatement *instruction)
	Remove a instruction.
Source File Position
set Sg_File_Info for a SgNode
ROSE_DLL_API void	setOneSourcePositionForTransformation (SgNode *node)
	Set current node's source position as transformation generated.
ROSE_DLL_API void	setSourcePosition (SgNode *node)
	Set the source code positon for the current (input) node.
ROSE_DLL_API void	setSourcePositionAtRootAndAllChildren (SgNode *root)
	Set the source code positon for the subtree (including the root).
void	setSourcePositionAsTransformation (SgNode *node)
	DQ (5/1/2012): New function with improved name.
void	setSourcePositionPointersToNull (SgNode *node)
	Set the source code positon for the current (input) node.
ROSE_DLL_API void	setOneSourcePositionNull (SgNode *node)
	Set current node's source position as NULL.
ROSE_DLL_API void	setSourcePositionForTransformation (SgNode *root)
	Recursively set source position info(Sg_File_Info) as transformation generated.
ROSE_DLL_API bool	insideSystemHeader (SgLocatedNode *node)
	Set source position info(Sg_File_Info) as transformation generated for all SgNodes in memory pool.
ROSE_DLL_API bool	insideHeader (SgLocatedNode *node)
	Check if a node is from a header file.
Symbol tables
utility functions for symbol tables
ROSE_DLL_API SgSymbol *	lookupSymbolInParentScopesIgnoringAliasSymbols (const SgName &name, SgScopeStatement *currentScope=NULL, SgTemplateParameterPtrList *templateParameterList=NULL, SgTemplateArgumentPtrList *templateArgumentList=NULL)
	Find a symbol in current and ancestor scopes for a given variable name, starting from top of ScopeStack if currentscope is not given or NULL.
ROSE_DLL_API SgSymbol *	lookupSymbolInParentScopes (const SgName &name, SgScopeStatement *currentScope=NULL, SgTemplateParameterPtrList *templateParameterList=NULL, SgTemplateArgumentPtrList *templateArgumentList=NULL)
	Find a symbol in current and ancestor scopes for a given variable name, starting from top of ScopeStack if currentscope is not given or NULL.
ROSE_DLL_API SgVariableSymbol *	lookupVariableSymbolInParentScopes (const SgName &name, SgScopeStatement *currentScope=NULL)
	Find a symbol in current and ancestor scopes for a given variable name, starting from top of ScopeStack if currentscope is not given or NULL.
ROSE_DLL_API SgFunctionSymbol *	lookupFunctionSymbolInParentScopes (const SgName &functionName, SgScopeStatement *currentScope=NULL)
	look up the first matched function symbol in parent scopes given only a function name, starting from top of ScopeStack if currentscope is not given or NULL
ROSE_DLL_API SgFunctionSymbol *	lookupFunctionSymbolInParentScopes (const SgName &functionName, const SgType *t, SgScopeStatement *currentScope=NULL)
	look up function symbol in parent scopes given both name and function type, starting from top of ScopeStack if currentscope is not given or NULL
ROSE_DLL_API SgFunctionSymbol *	lookupTemplateFunctionSymbolInParentScopes (const SgName &functionName, SgFunctionType *ftype, SgTemplateParameterPtrList *tplparams, SgScopeStatement *currentScope=NULL)
	Find a symbol in current and ancestor scopes for a given variable name, starting from top of ScopeStack if currentscope is not given or NULL.
ROSE_DLL_API SgFunctionSymbol *	lookupTemplateMemberFunctionSymbolInParentScopes (const SgName &functionName, SgFunctionType *ftype, SgTemplateParameterPtrList *tplparams, SgScopeStatement *currentScope=NULL)
	Find a symbol in current and ancestor scopes for a given variable name, starting from top of ScopeStack if currentscope is not given or NULL.
ROSE_DLL_API SgTemplateVariableSymbol *	lookupTemplateVariableSymbolInParentScopes (const SgName &name, SgTemplateParameterPtrList *tplparams, SgTemplateArgumentPtrList *tplargs, SgScopeStatement *currentScope=NULL)
	Find a symbol in current and ancestor scopes for a given variable name, starting from top of ScopeStack if currentscope is not given or NULL.
ROSE_DLL_API SgClassSymbol *	lookupClassSymbolInParentScopes (const SgName &name, SgScopeStatement *currentScope=NULL, SgTemplateArgumentPtrList *templateArgumentList=NULL)
	Find a symbol in current and ancestor scopes for a given variable name, starting from top of ScopeStack if currentscope is not given or NULL.
ROSE_DLL_API SgTypedefSymbol *	lookupTypedefSymbolInParentScopes (const SgName &name, SgScopeStatement *currentScope=NULL)
	Find a symbol in current and ancestor scopes for a given variable name, starting from top of ScopeStack if currentscope is not given or NULL.
ROSE_DLL_API SgNonrealSymbol *	lookupNonrealSymbolInParentScopes (const SgName &name, SgScopeStatement *currentScope=NULL, SgTemplateParameterPtrList *templateParameterList=NULL, SgTemplateArgumentPtrList *templateArgumentList=NULL)
	Find a symbol in current and ancestor scopes for a given variable name, starting from top of ScopeStack if currentscope is not given or NULL.
ROSE_DLL_API SgTemplateClassSymbol *	lookupTemplateClassSymbolInParentScopes (const SgName &name, SgTemplateParameterPtrList *templateParameterList, SgTemplateArgumentPtrList *templateArgumentList, SgScopeStatement *cscope=NULL)
	Find a symbol in current and ancestor scopes for a given variable name, starting from top of ScopeStack if currentscope is not given or NULL.
ROSE_DLL_API SgEnumSymbol *	lookupEnumSymbolInParentScopes (const SgName &name, SgScopeStatement *currentScope=NULL)
	Find a symbol in current and ancestor scopes for a given variable name, starting from top of ScopeStack if currentscope is not given or NULL.
ROSE_DLL_API SgNamespaceSymbol *	lookupNamespaceSymbolInParentScopes (const SgName &name, SgScopeStatement *currentScope=NULL)
	Find a symbol in current and ancestor scopes for a given variable name, starting from top of ScopeStack if currentscope is not given or NULL.
ROSE_DLL_API int	set_name (SgInitializedName *initializedNameNode, SgName new_name)
	set_name of symbol in symbol table.
void	outputGlobalFunctionTypeSymbolTable ()
	Output function type symbols in global function type symbol table.
ROSE_DLL_API void	outputLocalSymbolTables (SgNode *node)
	Output the local symbol tables.
void	rebuildSymbolTable (SgScopeStatement *scope)
	Regenerate the symbol table.
void	clearUnusedVariableSymbols (SgNode *root=NULL)
	Clear those variable symbols with unknown type (together with initialized names) which are also not referenced by any variable references or declarations under root. If root is NULL, all symbols with unknown type will be deleted.
void	fixupReferencesToSymbols (const SgScopeStatement *this_scope, SgScopeStatement *copy_scope, SgCopyHelp &help)
	All the symbol table references in the copied AST need to be reset after rebuilding the copied scope's symbol table.
Class utilities
ROSE_DLL_API SgMemberFunctionDeclaration *	getDefaultDestructor (SgClassDeclaration *classDeclaration)
	Get the default destructor from the class declaration.
ROSE_DLL_API SgMemberFunctionDeclaration *	getDefaultConstructor (SgClassDeclaration *classDeclaration)
	Get the default constructor from the class declaration.
ROSE_DLL_API bool	templateDefinitionIsInClass (SgTemplateInstantiationMemberFunctionDecl *memberFunctionDeclaration)
	Return true if template definition is in the class, false if outside of class.
ROSE_DLL_API SgTemplateInstantiationMemberFunctionDecl *	buildForwardFunctionDeclaration (SgTemplateInstantiationMemberFunctionDecl *memberFunctionInstantiation)
	Generate a non-defining (forward) declaration from a defining function declaration.
ROSE_DLL_API bool	isStructDeclaration (SgNode *node)
	Check if a SgNode is a declaration for a structure.
ROSE_DLL_API bool	isUnionDeclaration (SgNode *node)
	Check if a SgNode is a declaration for a union.
ROSE_DLL_API bool	addDefaultConstructorIfRequired (SgClassType *classType, int physical_file_id=Sg_File_Info::TRANSFORMATION_FILE_ID)
	Get the default destructor from the class declaration.
Misc.
Not sure the classifications right now
void	recursivePrintCurrentAndParent (SgNode *n)
	Recursively print current and parent nodes. used within gdb to probe the context of a node.
void	saveToPDF (SgNode *node, std::string filename)
	Save AST into a pdf file. Start from a node to find its enclosing file node. The entire file's AST will be saved into a pdf.
void	saveToPDF (SgNode *node)
	Recursively print current and parent nodes. used within gdb to probe the context of a node.
void	printAST (SgNode *node)
	Pretty print AST horizontally, output to std output.
void	printAST (SgNode *node, const char *filename)
	Pretty print AST horizontally, output to a specified file, a simpiler interface than printAST2TextFile()
void	printAST2TextFile (SgNode *node, const char *filename, bool printType=true)
	Pretty print AST horizontally, output to a specified text file. If printType is set to false, don't print out type info.
void	printAST2TextFile (SgNode *node, std::string filename, bool printType=true)
	Pretty print AST horizontally, output to a specified text file. If printType is set to false, don't print out types info.
void	whereAmI (SgNode *node)
	Diagnostic function for tracing back through the parent list to understand at runtime where in the AST a failure happened.
std::string	extractPragmaKeyword (const SgPragmaDeclaration *)
	Extract a SgPragmaDeclaration's leading keyword . For example "#pragma omp parallel" has a keyword of "omp".
ROSE_DLL_API bool	isOmpStatement (SgNode *)
	Check if a node is SgOmp*Statement.
bool	isOverloaded (SgFunctionDeclaration *functionDeclaration)
	Return true if function is overloaded.
void	initializeIfStmt (SgIfStmt *ifstmt, SgStatement *conditional, SgStatement *true_body, SgStatement *false_body)
	Support function used for variable declarations in conditionals.
void	initializeSwitchStatement (SgSwitchStatement *switchStatement, SgStatement *item_selector, SgStatement *body)
	Support function used for variable declarations in conditionals.
void	initializeWhileStatement (SgWhileStmt *whileStatement, SgStatement *condition, SgStatement *body, SgStatement *else_body)
	Support function used for variable declarations in conditionals.
void	annotateExpressionsWithUniqueNames (SgProject *project)
	Generate unique names for expressions and attach the names as persistent attributes ("UniqueNameAttribute")
ROSE_DLL_API bool	isMain (const SgNode *node)
	Check if a SgNode is a main() function declaration.
std::string	generateUniqueName (const SgNode *node, bool ignoreDifferenceBetweenDefiningAndNondefiningDeclarations)
	Generate unique name from C and C++ constructs. The name may contain space.
std::string	generateUniqueVariableName (SgScopeStatement *scope, std::string baseName="temp")
	Generate a name like temp# that is unique in the current scope and any parent and children scopes.
std::string	declarationPositionString (const SgDeclarationStatement *declaration)
	Generate a unique string from the source file position information.
ROSE_DLL_API std::string	generateProjectName (const SgProject *project, bool supressSuffix=false)
	Added mechanism to generate project name from list of file names.
SgFunctionDeclaration *	getDeclarationOfNamedFunction (SgExpression *func)
	Given a SgExpression that represents a named function (or bound member function), return the mentioned function.
SgExpression *	forallMaskExpression (SgForAllStatement *stmt)
	Get the mask expression from the header of a SgForAllStatement.
void	addVarRefExpFromArrayDimInfo (SgNode *astNode, Rose_STL_Container< SgNode * > &NodeList_t)
	Find all SgPntrArrRefExp under astNode, then add SgVarRefExp (if any) of SgPntrArrRefExp's dim_info into NodeList_t.
void	clearMangledNameCache (SgGlobal *globalScope)
	Support for faster mangled name generation (caching avoids recomputation).
void	resetMangledNameCache (SgGlobal *globalScope)
	Recursively print current and parent nodes. used within gdb to probe the context of a node.
std::string	getMangledNameFromCache (SgNode *astNode)
	Recursively print current and parent nodes. used within gdb to probe the context of a node.
std::string	addMangledNameToCache (SgNode *astNode, const std::string &mangledName)
	Recursively print current and parent nodes. used within gdb to probe the context of a node.
SgDeclarationStatement *	getNonInstantiatonDeclarationForClass (SgTemplateInstantiationMemberFunctionDecl *memberFunctionInstantiation)
	Recursively print current and parent nodes. used within gdb to probe the context of a node.
void	setBaseTypeDefiningDeclaration (SgVariableDeclaration *var_decl, SgDeclarationStatement *base_decl)
	a better version for SgVariableDeclaration::set_baseTypeDefininingDeclaration(), handling all side effects automatically Used to have a struct declaration embedded into a variable declaration
bool	declarationPreceedsDefinition (SgDeclarationStatement *nonDefiningDeclaration, SgDeclarationStatement *definingDeclaration)
	Check if a defining declaration comes before of after the non-defining declaration.
bool	functionCallExpressionPreceedsDeclarationWhichAssociatesScope (SgFunctionCallExp *functionCall)
	Recursively print current and parent nodes. used within gdb to probe the context of a node.
ROSE_DLL_API std::vector< SgNode * >	astIntersection (SgNode *original, SgNode *copy, SgCopyHelp *help=NULL)
	Compute the intersection set for two ASTs.
ROSE_DLL_API SgNode *	deepCopyNode (const SgNode *subtree)
	Deep copy an arbitrary subtree.
template<typename NodeType >
NodeType *	deepCopy (const NodeType *subtree)
	A template function for deep copying a subtree. It is also used to create deepcopy functions with specialized parameter and return types. e.g SgExpression* copyExpression(SgExpression* e);.
ROSE_DLL_API SgExpression *	copyExpression (SgExpression *e)
	Deep copy an expression.
ROSE_DLL_API SgStatement *	copyStatement (SgStatement *s)
	Deep copy a statement.
ROSE_DLL_API SgVariableSymbol *	getFirstVarSym (SgVariableDeclaration *decl)
	Get the variable symbol for the first initialized name of a declaration stmt.
ROSE_DLL_API SgInitializedName *	getFirstInitializedName (SgVariableDeclaration *decl)
	Get the first initialized name of a declaration statement.
ROSE_DLL_API void	myRemoveStatement (SgStatement *stmt)
	A special purpose statement removal function, originally from inlinerSupport.h, Need Jeremiah's attention to refine it. Please don't use it for now.
ROSE_DLL_API bool	isConstantTrue (SgExpression *e)
	Check if a bool or int constant expression evaluates to be a true value.
ROSE_DLL_API bool	isConstantFalse (SgExpression *e)
	Check if a bool or int constant expression evaluates to be a false value.
ROSE_DLL_API bool	isCallToParticularFunction (SgFunctionDeclaration *decl, SgExpression *e)
	Recursively print current and parent nodes. used within gdb to probe the context of a node.
ROSE_DLL_API bool	isCallToParticularFunction (const std::string &qualifiedName, size_t arity, SgExpression *e)
	Recursively print current and parent nodes. used within gdb to probe the context of a node.
bool ROSE_DLL_API	isStatic (SgDeclarationStatement *stmt)
	Check if a declaration has a "static' modifier.
ROSE_DLL_API void	setStatic (SgDeclarationStatement *stmt)
	Set a declaration as static.
ROSE_DLL_API bool	isExtern (SgDeclarationStatement *stmt)
	Check if a declaration has an "extern" modifier.
ROSE_DLL_API void	setExtern (SgDeclarationStatement *stmt)
	Set a declaration as extern.
ROSE_DLL_API bool ROSE_DLL_API	isMutable (SgInitializedName *name)
	True if an SgInitializedName is "mutable' (has storage modifier set)
ROSE_DLL_API bool ROSE_DLL_API	isJovialOutParam (SgInitializedName *name)
	True if a parameter name is a Jovial output parameter.
ROSE_DLL_API std::vector< SgInitializedName * >	getInParameters (const SgInitializedNamePtrList &params)
	Get a vector of Jovial input parameters from the function parameter list (may work for Fortran in the future)
ROSE_DLL_API std::vector< SgInitializedName * >	getOutParameters (const SgInitializedNamePtrList &params)
	Get a vector of Jovial output parameters from the function parameter list (may work for Fortran in the future)
ROSE_DLL_API bool	isAssignmentStatement (SgNode *_s, SgExpression **lhs=NULL, SgExpression **rhs=NULL, bool *readlhs=NULL)
	Check if a SgNode _s is an assignment statement (any of =,+=,-=,&=,/=, ^=, etc)
ROSE_DLL_API SgInitializedName *	convertRefToInitializedName (SgNode *current, bool coarseGrain=true)
	Variable references can be introduced by SgVarRef, SgPntrArrRefExp, SgInitializedName, SgMemberFunctionRef etc. For Dot and Arrow Expressions, their lhs is used to obtain SgInitializedName (coarse grain) by default. Otherwise, fine-grain rhs is used.
ROSE_DLL_API AbstractHandle::abstract_handle *	buildAbstractHandle (SgNode *)
	Build an abstract handle from an AST node, reuse previously built handle when possible.
ROSE_DLL_API SgNode *	getSgNodeFromAbstractHandleString (const std::string &input_string)
	Obtain a matching SgNode from an abstract handle string.
ROSE_DLL_API void	dumpInfo (SgNode *node, std::string desc="")
	Dump information about a SgNode for debugging.
ROSE_DLL_API std::vector< SgDeclarationStatement * >	sortSgNodeListBasedOnAppearanceOrderInSource (const std::vector< SgDeclarationStatement * > &nodevec)
	Reorder a list of declaration statements based on their appearance order in source files.
ROSE_DLL_API bool	isPrefixOperator (SgExpression *exp)
	Is an overloaded operator a prefix operator (e.g. address operator X * operator&(), dereference operator X & operator*(), unary plus operator X & operator+(), etc.
ROSE_DLL_API bool	isPrefixOperatorName (const SgName &functionName)
	Check for proper names of possible prefix operators (used in isPrefixOperator()).
ROSE_DLL_API bool	isPostfixOperator (SgExpression *exp)
	Is an overloaded operator a postfix operator. (e.g. ).
ROSE_DLL_API bool	isIndexOperator (SgExpression *exp)
	Is an overloaded operator an index operator (also referred to as call or subscript operators). (e.g. X & operator()() or X & operator[]()).
ROSE_DLL_API SgStatement *	lastStatementOfScopeWithTokenInfo (SgScopeStatement *scope, std::map< SgNode *, TokenStreamSequenceToNodeMapping * > &tokenStreamSequenceMap)
	Used to support token unparsing (when the output the trailing token sequence).
ROSE_DLL_API void	checkAccessPermissions (SgNode *)
	Recursively print current and parent nodes. used within gdb to probe the context of a node.
ROSE_DLL_API void	checkSymbolTables (SgNode *)
	Recursively print current and parent nodes. used within gdb to probe the context of a node.
ROSE_DLL_API void	markSubtreeToBeUnparsed (SgNode *root, int physical_file_id)
	Recursively print current and parent nodes. used within gdb to probe the context of a node.
ROSE_DLL_API void	markNodeToBeUnparsed (SgNode *node, int physical_file_id)
	Recursively print current and parent nodes. used within gdb to probe the context of a node.
ROSE_DLL_API void	markSubtreeToBeUnparsedTreeTraversal (SgNode *root, int physical_file_id)
	Recursively print current and parent nodes. used within gdb to probe the context of a node.
ROSE_DLL_API bool	findFirstSgCastExpMarkedAsTransformation (SgNode *n, const std::string &s)
	Recursively print current and parent nodes. used within gdb to probe the context of a node.
AST properties
version, language properties of current AST.
ROSE_DLL_API bool	is_Ada_language ()
ROSE_DLL_API bool	is_C_language ()
ROSE_DLL_API bool	is_OpenMP_language ()
ROSE_DLL_API bool	is_UPC_language ()
ROSE_DLL_API bool	is_UPC_dynamic_threads ()
ROSE_DLL_API bool	is_C99_language ()
ROSE_DLL_API bool	is_Cxx_language ()
ROSE_DLL_API bool	is_Java_language ()
ROSE_DLL_API bool	is_Jovial_language ()
ROSE_DLL_API bool	is_Jvm_language ()
ROSE_DLL_API bool	is_Fortran_language ()
ROSE_DLL_API bool	is_CAF_language ()
ROSE_DLL_API bool	is_PHP_language ()
ROSE_DLL_API bool	is_Python_language ()
ROSE_DLL_API bool	is_Cuda_language ()
ROSE_DLL_API bool	is_OpenCL_language ()
ROSE_DLL_API bool	is_binary_executable ()
ROSE_DLL_API bool	is_mixed_C_and_Cxx_language ()
ROSE_DLL_API bool	is_mixed_Fortran_and_C_language ()
ROSE_DLL_API bool	is_mixed_Fortran_and_Cxx_language ()
ROSE_DLL_API bool	is_mixed_Fortran_and_C_and_Cxx_language ()
ROSE_DLL_API bool	is_language_case_insensitive ()
ROSE_DLL_API bool	language_may_contain_nondeclarations_in_scope ()
Scope
void	resetScopeNumbers (SgFunctionDefinition *functionDeclaration)
	Assigns unique numbers to each SgScopeStatement of a function.
void	clearScopeNumbers (SgFunctionDefinition *functionDefinition)
	Clears the cache of scope,integer pairs for the input function.
SgNamespaceDefinitionStatement *	enclosingNamespaceScope (SgDeclarationStatement *declaration)
	Find the enclosing namespace of a declaration.
bool	isPrototypeInScope (SgScopeStatement *scope, SgFunctionDeclaration *functionDeclaration, SgDeclarationStatement *startingAtDeclaration)
	Assigns unique numbers to each SgScopeStatement of a function.
bool ROSE_DLL_API	isAncestor (SgNode *node1, SgNode *node2)
	check if node1 is a strict ancestor of node 2. (a node is not considered its own ancestor)
Preprocessing Information
#if-#else-#end, comments, #include, etc
void	dumpPreprocInfo (SgLocatedNode *locatedNode)
	Dumps a located node's preprocessing information.
ROSE_DLL_API PreprocessingInfo *	findHeader (SgSourceFile *source_file, const std::string &header_file_name, bool isSystemHeader)
	Find the preprocessingInfo node representing #include <header.h> or #include "header.h" within a source file. Return NULL if not found.
ROSE_DLL_API PreprocessingInfo *	insertHeader (SgSourceFile *source_file, const std::string &header_file_name, bool isSystemHeader, bool asLastHeader)
	Insert #include "filename" or #include <filename> (system header) onto the global scope of a source file, add to be the last #include .. by default among existing headers, Or as the first header. Recommended for use.
ROSE_DLL_API void	insertHeader (SgStatement *stmt, PreprocessingInfo *newheader, bool asLastHeader)
	Insert a new header right before stmt, if there are existing headers attached to stmt, insert it as the last or first header as specified by asLastHeader.
ROSE_DLL_API PreprocessingInfo *	insertHeader (SgSourceFile *source_file, const std::string &header_file_name, bool isSystemHeader=false, PreprocessingInfo::RelativePositionType position=PreprocessingInfo::before)
	Insert #include "filename" or #include <filename> (system header) onto the global scope of a source file.
ROSE_DLL_API PreprocessingInfo *	insertHeader (const std::string &filename, PreprocessingInfo::RelativePositionType position=PreprocessingInfo::after, bool isSystemHeader=false, SgScopeStatement *scope=NULL)
	Insert #include "filename" or #include <filename> (system header) into the global scope containing the current scope, right after other #include XXX.
ROSE_DLL_API void	moveUpPreprocessingInfo (SgStatement *stmt_dst, SgStatement *stmt_src, PreprocessingInfo::RelativePositionType src_position=PreprocessingInfo::undef, PreprocessingInfo::RelativePositionType dst_position=PreprocessingInfo::undef, bool usePrepend=false)
	Identical to movePreprocessingInfo(), except for the stale name and confusing order of parameters. It will be deprecated soon.
ROSE_DLL_API void	movePreprocessingInfo (SgStatement *stmt_src, SgStatement *stmt_dst, PreprocessingInfo::RelativePositionType src_position=PreprocessingInfo::undef, PreprocessingInfo::RelativePositionType dst_position=PreprocessingInfo::undef, bool usePrepend=false)
	Move preprocessing information of stmt_src to stmt_dst, Only move preprocessing information from the specified source-relative position to a specified target position, otherwise move all preprocessing information with position information intact. The preprocessing information is appended to the existing preprocessing information list of the target node by default. Prepending is used if usePreprend is set to true. Optionally, the relative position can be adjust after the moving using dst_position.
ROSE_DLL_API void	cutPreprocessingInfo (SgLocatedNode *src_node, PreprocessingInfo::RelativePositionType pos, AttachedPreprocessingInfoType &save_buf)
	Cut preprocessing information from a source node and save it into a buffer. Used in combination of pastePreprocessingInfo(). The cut-paste operation is similar to moveUpPreprocessingInfo() but it is more flexible in that the destination node can be unknown during the cut operation.
ROSE_DLL_API void	pastePreprocessingInfo (SgLocatedNode *dst_node, PreprocessingInfo::RelativePositionType pos, AttachedPreprocessingInfoType &saved_buf)
	Paste preprocessing information from a buffer to a destination node. Used in combination of cutPreprocessingInfo()
ROSE_DLL_API PreprocessingInfo *	attachArbitraryText (SgLocatedNode *target, const std::string &text, PreprocessingInfo::RelativePositionType position=PreprocessingInfo::before)
	Attach an arbitrary string to a located node. A workaround to insert irregular statements or vendor-specific attributes.
ROSE_DLL_API void	replaceMacroCallsWithExpandedStrings (SgPragmaDeclaration *target)
	Check if a pragma declaration node has macro calls attached, if yes, replace macro calls within the pragma string with expanded strings. This only works if -rose:wave is turned on.
PreprocessingInfo *	attachComment (SgSourceFile *source_file, const std::string &content, PreprocessingInfo::DirectiveType directive_type=PreprocessingInfo::C_StyleComment, PreprocessingInfo::RelativePositionType position=PreprocessingInfo::before)
	Build and attach comment onto the global scope of a source file.
ROSE_DLL_API PreprocessingInfo *	attachComment (SgLocatedNode *target, const std::string &content, PreprocessingInfo::RelativePositionType position=PreprocessingInfo::before, PreprocessingInfo::DirectiveType dtype=PreprocessingInfo::CpreprocessorUnknownDeclaration)
	Build and attach comment, comment style is inferred from the language type of the target node if not provided.
ROSE_DLL_API void	addTextForUnparser (SgNode *astNode, std::string s, AstUnparseAttribute::RelativePositionType inputlocation)
	Add a string to be unparsed to support code generation for back-end specific tools or compilers.
void	guardNode (SgLocatedNode *target, std::string guard)
	Add preproccessor guard around a given node.
ROSE_DLL_API int	moveUpInnerDanglingIfEndifDirective (SgLocatedNode *lnode)
	Dumps a located node's preprocessing information.
ROSE_DLL_API int	eraseNullPreprocessingInfo (SgLocatedNode *lnode)
	Dumps a located node's preprocessing information.
ROSE_DLL_API void	preOrderCollectPreprocessingInfo (SgNode *current, std::vector< PreprocessingInfo * > &infoList, int depth)
	Dumps a located node's preprocessing information.
Data types
Set the source position of SgLocatedNode to Sg_File_Info::generateDefaultFileInfo(). These nodes WILL be unparsed. Not for transformation usage.
SgType *	getBoolType (SgNode *n)
	Get the right bool type according to C or C++ language input.
ROSE_DLL_API bool	isStrictIntegerType (SgType *t)
	Check if a type is an integral type, only allowing signed/unsigned short, int, long, long long. /! /! There is another similar function named SgType::isIntegerType(), which allows additional types char, wchar, and bool to be treated as integer types.
ROSE_DLL_API SgType *	getFirstVarType (SgVariableDeclaration *decl)
	Get the data type of the first initialized name of a declaration statement.
ROSE_DLL_API bool	isDefaultConstructible (SgType *type)
	Is a type default constructible? This may not quite work properly.
ROSE_DLL_API bool	isCopyConstructible (SgType *type)
	Is a type copy constructible? This may not quite work properly.
ROSE_DLL_API bool	isAssignable (SgType *type)
	Is a type assignable? This may not quite work properly.
ROSE_DLL_API bool	isPureVirtualClass (SgType *type, const ClassHierarchyWrapper &classHierarchy)
	Check if a class type is a pure virtual class.
ROSE_DLL_API bool	hasTrivialDestructor (SgType *t)
	Does a type have a trivial (built-in) destructor?
ROSE_DLL_API bool	isNonconstReference (SgType *t)
	Is this type a non-constant reference type? (Handles typedefs correctly)
ROSE_DLL_API bool	isReferenceType (SgType *t)
	Is this type a const or non-const reference type? (Handles typedefs correctly)
ROSE_DLL_API bool	isPointerType (SgType *t)
	Is this type a pointer type? (Handles typedefs correctly)
ROSE_DLL_API bool	isPointerToNonConstType (SgType *type)
	Is this a pointer to a non-const type? Note that this function will return true for const pointers pointing to non-const types.
ROSE_DLL_API bool	isConstType (SgType *t)
	Is this a const type?
SgType *	removeConst (SgType *t)
	Remove const (if present) from a type. stripType() cannot do this because it removes all modifiers.
ROSE_DLL_API bool	isVolatileType (SgType *t)
	Is this a volatile type?
ROSE_DLL_API bool	isRestrictType (SgType *t)
	Is this a restrict type?
ROSE_DLL_API bool	isScalarType (SgType *t)
	Is this a scalar type?
ROSE_DLL_API bool	isStructType (SgType *t)
	Check if a type is a struct type (a special SgClassType in ROSE). Typedef and modifier types are not stripped off. Only direct struct type is returned as true.
ROSE_DLL_API std::string	mangleType (SgType *type)
	Generate a mangled string for a given type based on Itanium C++ ABI.
ROSE_DLL_API std::string	mangleScalarType (SgType *type)
	Generate mangled scalar type names according to Itanium C++ ABI, the input type should pass isScalarType() in ROSE.
ROSE_DLL_API std::string	mangleModifierType (SgModifierType *type)
	Generated mangled modifier types, include const, volatile,according to Itanium C++ ABI, with extension to handle UPC shared types.
ROSE_DLL_API size_t	getArrayElementCount (SgArrayType *t)
	Calculate the number of elements of an array type: dim1* dim2*... , assume element count is 1 for int a[]; Strip off THREADS if it is a UPC array.
ROSE_DLL_API int	getDimensionCount (SgType *t)
	Get the number of dimensions of an array type.
ROSE_DLL_API SgType *	getArrayElementType (SgType *t)
	Get the element type of an array. It recursively find the base type for multi-dimension array types.
ROSE_DLL_API SgType *	getElementType (SgType *t)
	Get the element type of an array, pointer or string, or NULL if not applicable. This function only check one level base type. No recursion.
std::vector< SgExpression * >	get_C_array_dimensions (const SgArrayType &arrtype)
	returns the array dimensions in an array as defined for arrtype
std::vector< SgExpression * >	get_C_array_dimensions (const SgArrayType &arrtype, const SgVarRefExp &varref)
	returns the array dimensions in an array as defined for arrtype
std::vector< SgExpression * >	get_C_array_dimensions (const SgArrayType &arrtype, SgInitializedName &initname)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
ROSE_DLL_API bool	isArrayReference (SgExpression *ref, SgExpression **arrayNameExp=NULL, std::vector< SgExpression * > **subscripts=NULL)
	Check if an expression is an array access (SgPntrArrRefExp). If so, return its name expression and subscripts if requested. Users can use convertRefToInitializedName() to get the possible name. It does not check if the expression is a top level SgPntrArrRefExp.
ROSE_DLL_API int	collectVariableReferencesInArrayTypes (SgLocatedNode *root, Rose_STL_Container< SgNode * > &currentVarRefList)
	Collect variable references in array types. The default NodeQuery::querySubTree() will miss variables referenced in array type's index list. e.g. double *buffer = new double[numItems] ;.
ROSE_DLL_API bool	hasUpcSharedType (SgType *t, SgModifierType **mod_type_out=NULL)
	Has a UPC shared type of any kinds (shared-to-shared, private-to-shared, shared-to-private, shared scalar/array)? An optional parameter, mod_type_out, stores the first SgModifierType with UPC access information.
ROSE_DLL_API bool	isUpcSharedType (SgType *t, SgModifierType **mod_type_out=NULL)
	Check if a type is a UPC shared type, including shared array, shared pointers etc. Exclude private pointers to shared types. Optionally return the modifier type with the UPC shared property.
ROSE_DLL_API bool	isUpcSharedModifierType (SgModifierType *mod_type)
	Check if a modifier type is a UPC shared type.
ROSE_DLL_API bool	isUpcSharedArrayType (SgArrayType *array_type)
	Check if an array type is a UPC shared type. ROSE AST represents a UPC shared array as regular array of elements of UPC shared Modifier Type. Not directly a UPC shared Modifier Type of an array.
ROSE_DLL_API bool	isUpcStrictSharedModifierType (SgModifierType *mode_type)
	Check if a shared UPC type is strict memory consistency or not. Return false if it is relaxed. (So isUpcRelaxedSharedModifierType() is not necessary.)
ROSE_DLL_API size_t	getUpcSharedBlockSize (SgModifierType *mod_type)
	Get the block size of a UPC shared modifier type.
ROSE_DLL_API size_t	getUpcSharedBlockSize (SgType *t)
	Get the block size of a UPC shared type, including Modifier types and array of modifier types (shared arrays)
ROSE_DLL_API bool	isUpcPhaseLessSharedType (SgType *t)
	Is UPC phase-less shared type? Phase-less means block size of the first SgModifierType with UPC information is 1 or 0/unspecified. Also return false if the type is not a UPC shared type.
ROSE_DLL_API bool	isUpcPrivateToSharedType (SgType *t)
	Is a UPC private-to-shared pointer? SgPointerType comes first compared to SgModifierType with UPC information. Input type must be any of UPC shared types first.
ROSE_DLL_API bool	isUpcArrayWithThreads (SgArrayType *t)
	Is a UPC array with dimension of X*THREADS.
ROSE_DLL_API SgType *	lookupNamedTypeInParentScopes (const std::string &type_name, SgScopeStatement *scope=NULL)
	Lookup a named type based on its name, bottomup searching from a specified scope. Note name collison might be allowed for c (not C++) between typedef and enum/struct. Only the first matched named type will be returned in this case. typedef is returned as it is, not the base type it actually refers to.
ROSE_DLL_API SgType *	getAssociatedTypeFromFunctionTypeList (SgExpression *actual_argument_expression)
	Get the type of the associated argument expression from the function type.
ROSE_DLL_API bool	templateArgumentEquivalence (SgTemplateArgument *arg1, SgTemplateArgument *arg2)
	Verify that 2 SgTemplateArgument are equivalent (same type, same expression, or same template declaration)
ROSE_DLL_API bool	templateArgumentListEquivalence (const SgTemplateArgumentPtrList &list1, const SgTemplateArgumentPtrList &list2)
	Verify that 2 SgTemplateArgumentPtrList are equivalent.
ROSE_DLL_API bool	isEquivalentType (const SgType *lhs, const SgType *rhs)
	Test for equivalence of types independent of access permissions (private or protected modes for members of classes).
ROSE_DLL_API SgFunctionType *	findFunctionType (SgType *return_type, SgFunctionParameterTypeList *typeList)
	Find the function type matching a function signature plus a given return type.
ROSE_DLL_API bool	isEquivalentFunctionType (const SgFunctionType *lhs, const SgFunctionType *rhs)
	Test if two types are equivalent SgFunctionType nodes.
Loop handling
ROSE_DLL_API void	addStepToLoopBody (SgScopeStatement *loopStmt, SgStatement *step)
	Add a step statement to the end of a loop body Add a new label to the end of the loop, with the step statement after it; then change all continue statements in the old loop body into jumps to the label.
ROSE_DLL_API void	moveForStatementIncrementIntoBody (SgForStatement *f)
	Add a step statement to the end of a loop body Add a new label to the end of the loop, with the step statement after it; then change all continue statements in the old loop body into jumps to the label.
ROSE_DLL_API void	convertForToWhile (SgForStatement *f)
	Add a step statement to the end of a loop body Add a new label to the end of the loop, with the step statement after it; then change all continue statements in the old loop body into jumps to the label.
ROSE_DLL_API void	convertAllForsToWhiles (SgNode *top)
	Add a step statement to the end of a loop body Add a new label to the end of the loop, with the step statement after it; then change all continue statements in the old loop body into jumps to the label.
ROSE_DLL_API void	changeContinuesToGotos (SgStatement *stmt, SgLabelStatement *label)
	Change continue statements in a given block of code to gotos to a label.
ROSE_DLL_API SgInitializedName *	getLoopIndexVariable (SgNode *loop)
	Return the loop index variable for a for loop.
ROSE_DLL_API bool	isLoopIndexVariable (SgInitializedName *ivar, SgNode *subtree_root)
	Check if a SgInitializedName is used as a loop index within a AST subtree This function will use a bottom-up traverse starting from the subtree_root to find all enclosing loops and check if ivar is used as an index for either of them.
ROSE_DLL_API bool	hasMultipleInitStatmentsOrExpressions (SgForStatement *for_loop)
	Check if a for loop uses C99 style initialization statement with multiple expressions like for (int i=0, j=0; ..) or for (i=0,j=0;...)
ROSE_DLL_API SgStatement *	getLoopBody (SgScopeStatement *loop)
	Routines to get and set the body of a loop.
ROSE_DLL_API void	setLoopBody (SgScopeStatement *loop, SgStatement *body)
	Add a step statement to the end of a loop body Add a new label to the end of the loop, with the step statement after it; then change all continue statements in the old loop body into jumps to the label.
ROSE_DLL_API SgStatement *	getLoopCondition (SgScopeStatement *loop)
	Routines to get the condition of a loop. It recognize While-loop, For-loop, and Do-While-loop.
ROSE_DLL_API void	setLoopCondition (SgScopeStatement *loop, SgStatement *cond)
	Set the condition statement of a loop, including While-loop, For-loop, and Do-While-loop.
ROSE_DLL_API bool	isCanonicalForLoop (SgNode *loop, SgInitializedName **ivar=NULL, SgExpression **lb=NULL, SgExpression **ub=NULL, SgExpression **step=NULL, SgStatement **body=NULL, bool *hasIncrementalIterationSpace=NULL, bool *isInclusiveUpperBound=NULL)
	Check if a for-loop has a canonical form, return loop index, bounds, step, and body if requested.
ROSE_DLL_API bool	isCanonicalDoLoop (SgFortranDo *loop, SgInitializedName **ivar, SgExpression **lb, SgExpression **ub, SgExpression **step, SgStatement **body, bool *hasIncrementalIterationSpace, bool *isInclusiveUpperBound)
	Check if a Fortran Do loop has a complete canonical form: Do I=1, 10, 1.
ROSE_DLL_API void	setLoopLowerBound (SgNode *loop, SgExpression *lb)
	Set the lower bound of a loop header for (i=lb; ...)
ROSE_DLL_API void	setLoopUpperBound (SgNode *loop, SgExpression *ub)
	Set the upper bound of a loop header,regardless the condition expression type. for (i=lb; i op up, ...)
ROSE_DLL_API void	setLoopStride (SgNode *loop, SgExpression *stride)
	Set the stride(step) of a loop 's incremental expression, regardless the expression types (i+=s; i= i+s, etc)
ROSE_DLL_API bool	normalizeForLoopInitDeclaration (SgForStatement *loop)
	Normalize loop init stmt by promoting the single variable declaration statement outside of the for loop header's init statement, e.g. for (int i=0;) becomes int i_x; for (i_x=0;..) and rewrite the loop with the new index variable, if necessary.
ROSE_DLL_API bool	unnormalizeForLoopInitDeclaration (SgForStatement *loop)
	Undo the normalization of for loop's C99 init declaration. Previous record of normalization is used to ease the reverse transformation.
ROSE_DLL_API bool	forLoopNormalization (SgForStatement *loop, bool foldConstant=true)
	Normalize a for loop, return true if successful.
ROSE_DLL_API bool	normalizeForLoopTest (SgForStatement *loop)
	Normalize a for loop's test expression i<x is normalized to i<= (x-1) and i>x is normalized to i>= (x+1)
ROSE_DLL_API bool	normalizeForLoopIncrement (SgForStatement *loop)
	Add a step statement to the end of a loop body Add a new label to the end of the loop, with the step statement after it; then change all continue statements in the old loop body into jumps to the label.
ROSE_DLL_API bool	doLoopNormalization (SgFortranDo *loop)
	Normalize a Fortran Do loop. Make the default increment expression (1) explicit.
ROSE_DLL_API bool	loopUnrolling (SgForStatement *loop, size_t unrolling_factor)
	Unroll a target loop with a specified unrolling factor. It handles steps larger than 1 and adds a fringe loop if the iteration count is not evenly divisible by the unrolling factor.
ROSE_DLL_API bool	loopInterchange (SgForStatement *loop, size_t depth, size_t lexicoOrder)
	Interchange/permutate a n-level perfectly-nested loop rooted at 'loop' using a lexicographical order number within (0,depth!).
ROSE_DLL_API bool	loopTiling (SgForStatement *loopNest, size_t targetLevel, size_t tileSize)
	Tile the n-level (starting from 1) loop of a perfectly nested loop nest using tiling size s.
SgExprListExp *	loopCollapsing (SgForStatement *target_loop, size_t collapsing_factor)
	Add a step statement to the end of a loop body Add a new label to the end of the loop, with the step statement after it; then change all continue statements in the old loop body into jumps to the label.
bool	getForLoopInformations (SgForStatement *for_loop, SgVariableSymbol *&iterator, SgExpression *&lower_bound, SgExpression *&upper_bound, SgExpression *&stride)
	Add a step statement to the end of a loop body Add a new label to the end of the loop, with the step statement after it; then change all continue statements in the old loop body into jumps to the label.
Topdown search
Top-down traversal from current node to find a node of a specified type
template<typename NodeType >
std::vector< NodeType * >	querySubTree (SgNode *top, VariantT variant=(VariantT) NodeType::static_variant)
	Query a subtree to get all nodes of a given type, with an appropriate downcast.
std::vector< SgFile * >	generateFileList ()
	Returns STL vector of SgFile IR node pointers.
ROSE_DLL_API SgProject *	getProject ()
	Get the current SgProject IR Node.
SgProject *	getProject (const SgNode *node)
void	serialize (SgNode *node, std::string &prefix, bool hasRemaining, std::ostringstream &out, std::string &edgeLabel)
	we have two serialize() functions, one for a single node, the other for a list of pointers
template<typename T >
void	serialize_list (T &plist, std::string T_name, std::string &prefix, bool hasRemaining, std::ostringstream &out, std::string &edgeLabel)
	Query a subtree to get all nodes of a given type, with an appropriate downcast.
ROSE_DLL_API SgFunctionDeclaration *	findMain (SgNode *currentNode)
	top-down traversal from current node to find the main() function declaration
SgStatement *	findLastDeclarationStatement (SgScopeStatement *scope, bool includePragma=false)
	Find the last declaration statement within a scope (if any). This is often useful to decide where to insert another variable declaration statement. Pragma declarations are not treated as a declaration by default in this context.
std::vector< SgVariableSymbol * >	getSymbolsUsedInExpression (SgExpression *expr)
	Find referenced symbols within an expression.
std::vector< SgBreakStmt * >	findBreakStmts (SgStatement *code, const std::string &fortranLabel="")
	Find break statements inside a particular statement, stopping at nested loops or switches.
std::vector< SgContinueStmt * >	findContinueStmts (SgStatement *code, const std::string &fortranLabel="")
	Find all continue statements inside a particular statement, stopping at nested loops.
std::vector< SgGotoStatement * >	findGotoStmts (SgStatement *scope, SgLabelStatement *l)
	Query a subtree to get all nodes of a given type, with an appropriate downcast.
std::vector< SgStatement * >	getSwitchCases (SgSwitchStatement *sw)
	Query a subtree to get all nodes of a given type, with an appropriate downcast.
void	collectVarRefs (SgLocatedNode *root, std::vector< SgVarRefExp * > &result)
	Collect all variable references in a subtree.
template<typename T >
T *	findDeclarationStatement (SgNode *root, std::string name, SgScopeStatement *scope, bool isDefining)
	Topdown traverse a subtree from root to find the first declaration given its name, scope (optional, can be NULL), and defining or nondefining flag.
SgFunctionDeclaration *	findFunctionDeclaration (SgNode *root, std::string name, SgScopeStatement *scope, bool isDefining)
	Topdown traverse a subtree from root to find the first function declaration matching the given name, scope (optional, can be NULL), and defining or nondefining flag. This is an instantiation of findDeclarationStatement<T>.
Bottom up search
Backwards traverse through the AST to find a node, findEnclosingXXX()
template<typename NodeType >
NodeType *	getEnclosingNode (const SgNode *astNode, const bool includingSelf=false)
	Find a node by type using upward traversal.
ROSE_DLL_API SgSourceFile *	getEnclosingSourceFile (SgNode *n, const bool includingSelf=false)
	Find enclosing source file node.
ROSE_DLL_API SgScopeStatement *	getScope (const SgNode *astNode)
	Get the closest scope from astNode. Return astNode if it is already a scope.
ROSE_DLL_API SgScopeStatement *	getEnclosingScope (SgNode *n, const bool includingSelf=false)
	Get the enclosing scope from a node n.
ROSE_DLL_API SgGlobal *	getGlobalScope (const SgNode *astNode)
	Traverse back through a node's parents to find the enclosing global scope.
ROSE_DLL_API bool	hasSameGlobalScope (SgStatement *statement_1, SgStatement *statement_2)
	This is supporting the recognition of functions in header files from two different ASTs.
ROSE_DLL_API SgFunctionDefinition *	getEnclosingProcedure (SgNode *n, const bool includingSelf=false)
	Find the function definition.
ROSE_DLL_API SgFunctionDefinition *	getEnclosingFunctionDefinition (SgNode *astNode, const bool includingSelf=false)
	Find a node by type using upward traversal.
ROSE_DLL_API SgStatement *	getEnclosingStatement (SgNode *n)
	Find the closest enclosing statement, including the given node.
ROSE_DLL_API SgSwitchStatement *	findEnclosingSwitch (SgStatement *s)
	Find the closest switch outside a given statement (normally used for case and default statements)
ROSE_DLL_API SgOmpClauseBodyStatement *	findEnclosingOmpClauseBodyStatement (SgStatement *s)
	Find enclosing OpenMP clause body statement from s. If s is already one, return it directly.
ROSE_DLL_API SgScopeStatement *	findEnclosingLoop (SgStatement *s, const std::string &fortranLabel="", bool stopOnSwitches=false)
	Find the closest loop outside the given statement; if fortranLabel is not empty, the Fortran label of the loop must be equal to it.
ROSE_DLL_API SgFunctionDeclaration *	getEnclosingFunctionDeclaration (SgNode *astNode, const bool includingSelf=false)
	Find the enclosing function declaration, including its derived instances like isSgProcedureHeaderStatement, isSgProgramHeaderStatement, and isSgMemberFunctionDeclaration.
ROSE_DLL_API SgFile *	getEnclosingFileNode (SgNode *astNode)
	get the SgFile node from current node
ROSE_DLL_API SgInitializer *	getInitializerOfExpression (SgExpression *n)
	Get the initializer containing an expression if it is within an initializer.
ROSE_DLL_API SgClassDefinition *	getEnclosingClassDefinition (SgNode *astnode, const bool includingSelf=false)
	Get the closest class definition enclosing the specified AST node,.
ROSE_DLL_API SgClassDeclaration *	getEnclosingClassDeclaration (SgNode *astNode)
	Get the closest class declaration enclosing the specified AST node,.
ROSE_DLL_API SgExprListExp *	getEnclosingExprListExp (SgNode *astNode, const bool includingSelf=false)
	Get the enclosing SgExprListExp (used as part of function argument index evaluation in subexpressions).
ROSE_DLL_API bool	isInSubTree (SgExpression *subtree, SgExpression *exp)
	Find a node by type using upward traversal.
ROSE_DLL_API SgFunctionDeclaration *	getFunctionDeclaration (SgFunctionCallExp *functionCallExp)
	Find a node by type using upward traversal.
ROSE_DLL_API bool	isDataMemberReference (SgVarRefExp *varRefExp)
	Find a node by type using upward traversal.
ROSE_DLL_API bool	isAddressTaken (SgExpression *refExp)
	Find a node by type using upward traversal.
ROSE_DLL_API bool	isMemberFunctionMemberReference (SgMemberFunctionRefExp *memberFunctionRefExp)
	Find a node by type using upward traversal.
ROSE_DLL_API std::list< SgClassType * >	getClassTypeChainForMemberReference (SgExpression *refExp)
	Find a node by type using upward traversal.
ROSE_DLL_API std::set< SgNode * >	getFrontendSpecificNodes ()
	Find a node by type using upward traversal.
ROSE_DLL_API void	outputSharedNodes (SgNode *node)
	Find a node by type using upward traversal.
ROSE_DLL_API void	displayScope (SgScopeStatement *scope)
	Find a node by type using upward traversal.
AST Walk and Traversal
ROSE_DLL_API SgGlobal *	getFirstGlobalScope (SgProject *project)
	return the first global scope under current project
ROSE_DLL_API SgStatement *	getLastStatement (SgScopeStatement *scope)
	get the last statement within a scope, return NULL if it does not exit
ROSE_DLL_API SgStatement *	getFirstStatement (SgScopeStatement *scope, bool includingCompilerGenerated=false)
	Get the first statement within a scope, return NULL if it does not exist. Skip compiler-generated statement by default. Count transformation-generated ones, but excluding those which are not to be outputted in unparsers.
ROSE_DLL_API SgFunctionDeclaration *	findFirstDefiningFunctionDecl (SgScopeStatement *scope)
	Find the first defining function declaration statement in a scope.
ROSE_DLL_API SgStatement *	getNextStatement (SgStatement *currentStmt)
	Get next statement within the same scope of current statement.
ROSE_DLL_API SgStatement *	getPreviousStatement (SgStatement *currentStmt, bool climbOutScope=true)
	Get previous statement of the current statement. It may return a previous statement of a parent scope by default (climbOutScope is true), otherwise only a previous statement of the same scope is returned.
ROSE_DLL_API void	listHeaderFiles (SgIncludeFile *includeFile)
	return path prefix for subtree of include files.
ROSE_DLL_API bool	scopeHasStatementsFromSameFile (SgScopeStatement *scope)
	This function supports the token-based unparsing when used with unparsing of header files to know when the scope can be unparsed via it's token stream, even though a statement from a header file may contain a transformation. returns true if there is a statement in the scope that has to be unparsed (is from the same file as the scope). returns false if the scope is empty or contains only statements associated with one or more header files.
AST Comparison
Compare AST nodes, subtree, etc
ROSE_DLL_API bool	isEqualToIntConst (SgExpression *e, int value)
	Check if a SgIntVal node has a given value.
ROSE_DLL_API bool	isSameFunction (SgFunctionDeclaration *func1, SgFunctionDeclaration *func2)
	Check if two function declarations refer to the same one. Two function declarations are the same when they are a) identical, b) same name in C c) same qualified named and mangled name in C++. A nondefining (prototype) declaration and a defining declaration of a same function are treated as the same.
ROSE_DLL_API bool	isLastStatement (SgStatement *stmt)
	Check if a statement is the last statement within its closed scope.
AST insert, removal, and replacement
Add, remove,and replace AST scope->append_statement(), exprListExp->append_expression() etc. are not enough to handle side effect of parent pointers, symbol tables, preprocessing info, defining/nondefining pointers etc.
ROSE_DLL_API void	deleteAST (SgNode *node)
	Function to delete AST subtree's nodes only, users must take care of any dangling pointers, symbols or types that result.
ROSE_DLL_API void	deleteAllNodes ()
	Function to delete AST subtree's nodes only, users must take care of any dangling pointers, symbols or types that result.
ROSE_DLL_API void	checkSgNodePointers ()
	Function to delete AST subtree's nodes only, users must take care of any dangling pointers, symbols or types that result.
ROSE_DLL_API void	deleteExpressionTreeWithOriginalExpressionSubtrees (SgNode *root)
	Special purpose function for deleting AST expression tress containing valid original expression trees in constant folded expressions (for internal use only).
ROSE_DLL_API void	moveStatementsBetweenBlocks (SgBasicBlock *sourceBlock, SgBasicBlock *targetBlock)
	Move statements in first block to the second block (preserves order and rebuilds the symbol table).
ROSE_DLL_API void	moveStatementsBetweenBlocks (SgAdaPackageSpec *sourceBlock, SgNamespaceDefinitionStatement *targetBlock)
	Move statements in Ada's package spec into C++ namespace's definition.
ROSE_DLL_API void	moveStatementsBetweenBlocks (SgAdaPackageBody *sourceBlock, SgNamespaceDefinitionStatement *targetBlock)
	Move statements in Ada's package body into C++ namespace's definition.
ROSE_DLL_API void	moveStatementsBetweenBlocks (SgNamespaceDefinitionStatement *sourceBlock, SgNamespaceDefinitionStatement *targetBlock)
	Move statements between C++ namespace's definitions.
ROSE_DLL_API bool	isLambdaFunction (SgFunctionDeclaration *func)
	Check if a function declaration is a C++11 lambda function.
ROSE_DLL_API bool	isLambdaCapturedVariable (SgVarRefExp *varRef)
	check if a variable reference is this->a[i] inside of a lambda function
ROSE_DLL_API void	moveVariableDeclaration (SgVariableDeclaration *decl, SgScopeStatement *target_scope)
	Move a variable declaration to a new scope, handle symbol, special scopes like For loop, etc.
ROSE_DLL_API void	appendStatement (SgStatement *stmt, SgScopeStatement *scope=NULL)
	Append a statement to the end of the current scope, handle side effect of appending statements, e.g. preprocessing info, defining/nondefining pointers etc.
ROSE_DLL_API void	appendStatement (SgStatement *stmt, SgForInitStatement *for_init_stmt)
	Append a statement to the end of SgForInitStatement.
ROSE_DLL_API void	appendStatementList (const std::vector< SgStatement * > &stmt, SgScopeStatement *scope=NULL)
	Append a list of statements to the end of the current scope, handle side effect of appending statements, e.g. preprocessing info, defining/nondefining pointers etc.
ROSE_DLL_API void	appendStatementWithDependentDeclaration (SgDeclarationStatement *decl, SgGlobal *scope, SgStatement *original_statement, bool excludeHeaderFiles)
	Append a copy ('decl') of a function ('original_statement') into a 'scope', include any referenced declarations required if the scope is within a compiler generated file. All referenced declarations, including those from headers, are inserted if excludeHeaderFiles is set to true (the new file will not have any headers).
ROSE_DLL_API void	prependStatement (SgStatement *stmt, SgScopeStatement *scope=NULL)
	Prepend a statement to the beginning of the current scope, handling side effects as appropriate.
ROSE_DLL_API void	prependStatement (SgStatement *stmt, SgForInitStatement *for_init_stmt)
	Prepend a statement to the beginning of SgForInitStatement.
ROSE_DLL_API void	prependStatementList (const std::vector< SgStatement * > &stmt, SgScopeStatement *scope=NULL)
	prepend a list of statements to the beginning of the current scope, handling side effects as appropriate
ROSE_DLL_API bool	hasSimpleChildrenList (SgScopeStatement *scope)
	Check if a scope statement has a simple children statement list so insert additional statements under the scope is straightforward and unambiguous .
ROSE_DLL_API void	insertStatement (SgStatement *targetStmt, SgStatement *newStmt, bool insertBefore=true, bool autoMovePreprocessingInfo=true)
	Insert a statement before or after the target statement within the target's scope. Move around preprocessing info automatically.
ROSE_DLL_API void	insertStatementList (SgStatement *targetStmt, const std::vector< SgStatement * > &newStmts, bool insertBefore=true)
	Insert a list of statements before or after the target statement within the.
ROSE_DLL_API void	insertStatementBefore (SgStatement *targetStmt, SgStatement *newStmt, bool autoMovePreprocessingInfo=true)
	Insert a statement before a target statement.
ROSE_DLL_API void	insertStatementListBefore (SgStatement *targetStmt, const std::vector< SgStatement * > &newStmts)
	Insert a list of statements before a target statement.
ROSE_DLL_API void	insertStatementAfter (SgStatement *targetStmt, SgStatement *newStmt, bool autoMovePreprocessingInfo=true)
	Insert a statement after a target statement, Move around preprocessing info automatically by default.
ROSE_DLL_API void	insertStatementListAfter (SgStatement *targetStmt, const std::vector< SgStatement * > &newStmt)
	Insert a list of statements after a target statement.
ROSE_DLL_API void	insertStatementAfterLastDeclaration (SgStatement *stmt, SgScopeStatement *scope)
	Insert a statement after the last declaration within a scope. The statement will be prepended to the scope if there is no declaration statement found.
ROSE_DLL_API void	insertStatementAfterLastDeclaration (std::vector< SgStatement * > stmt_list, SgScopeStatement *scope)
	Insert a list of statements after the last declaration within a scope. The statement will be prepended to the scope if there is no declaration statement found.
ROSE_DLL_API void	insertStatementBeforeFirstNonDeclaration (SgStatement *newStmt, SgScopeStatement *scope, bool movePreprocessingInfo=true)
	Insert a statement before the first non-declaration statement in a scope. If the scope has no non-declaration statements.
ROSE_DLL_API void	insertStatementListBeforeFirstNonDeclaration (const std::vector< SgStatement * > &newStmts, SgScopeStatement *scope)
	Insert statements before the first non-declaration statement in a scope. If the scope has no non-declaration statements.
ROSE_DLL_API SgStatement *	lastFrontEndSpecificStatement (SgGlobal *globalScope)
	Function to delete AST subtree's nodes only, users must take care of any dangling pointers, symbols or types that result.
ROSE_DLL_API void	removeStatement (SgStatement *stmt, bool autoRelocatePreprocessingInfo=true)
	Remove a statement from its attach point of the AST. Automatically keep its associated preprocessing information at the original place after the removal. The statement is still in memory and it is up to the users to decide if the removed one will be inserted somewhere else or released from memory (deleteAST()).
ROSE_DLL_API void	deepDelete (SgNode *root)
	Deep delete a sub AST tree. It uses postorder traversal to delete each child node. Users must take care of any dangling pointers, symbols or types that result. This is identical to deleteAST()
ROSE_DLL_API void	replaceStatement (SgStatement *oldStmt, SgStatement *newStmt, bool movePreprocessinInfo=false)
	Replace a statement with another. Move preprocessing information from oldStmt to newStmt if requested.
ROSE_DLL_API SgNode *	replaceWithPattern (SgNode *anchor, SgNode *new_pattern)
	Replace an anchor node with a specified pattern subtree with optional SgVariantExpression. All SgVariantExpression in the pattern will be replaced with copies of the anchor node.
ROSE_DLL_API void	replaceVariableReferences (SgVariableSymbol *old_sym, SgVariableSymbol *new_sym, SgScopeStatement *scope)
	Replace all variable references to an old symbol in a scope to being references to a new symbol.
ROSE_DLL_API bool	statementCanBeTransformed (SgStatement *stmt)
	If header file unparsing and token-based unparsing are used, then some statements in header files used with the same name and different include syntax can't be transformed.
std::pair< SgVariableDeclaration *, SgExpression * >	createTempVariableForExpression (SgExpression *expression, SgScopeStatement *scope, bool initializeInDeclaration, SgAssignOp **reEvaluate=NULL)
	Given an expression, generates a temporary variable whose initializer optionally evaluates that expression.
std::pair< SgVariableDeclaration *, SgExpression * >	createTempVariableAndReferenceForExpression (SgExpression *expression, SgScopeStatement *scope)
	Function to delete AST subtree's nodes only, users must take care of any dangling pointers, symbols or types that result.
ROSE_DLL_API SgVariableSymbol *	appendArg (SgFunctionParameterList *, SgInitializedName *)
	Append an argument to SgFunctionParameterList, transparently set parent,scope, and symbols for arguments when possible.
ROSE_DLL_API SgVariableSymbol *	prependArg (SgFunctionParameterList *, SgInitializedName *)
	Prepend an argument to SgFunctionParameterList.
ROSE_DLL_API void	appendExpression (SgExprListExp *, SgExpression *)
	Append an expression to a SgExprListExp, set the parent pointer also.
ROSE_DLL_API void	appendExpressionList (SgExprListExp *, const std::vector< SgExpression * > &)
	Append an expression list to a SgExprListExp, set the parent pointers also.
template<class actualFunction >
void	setParameterList (actualFunction *func, SgFunctionParameterList *paralist)
	Set parameter list for a function declaration, considering existing parameter list etc.
ROSE_DLL_API void	setPragma (SgPragmaDeclaration *decl, SgPragma *pragma)
	Set a pragma of a pragma declaration. handle memory release for preexisting pragma, and set parent pointer.
ROSE_DLL_API void	replaceExpression (SgExpression *oldExp, SgExpression *newExp, bool keepOldExp=false)
	Replace an expression with another, used for variable reference substitution and others. the old expression can be deleted (default case) or kept.
ROSE_DLL_API void	replaceExpressionWithStatement (SgExpression *from, SageInterface::StatementGenerator *to)
	Replace a given expression with a list of statements produced by a generator.
ROSE_DLL_API void	replaceSubexpressionWithStatement (SgExpression *from, SageInterface::StatementGenerator *to)
	Similar to replaceExpressionWithStatement, but with more restrictions.
ROSE_DLL_API void	setOperand (SgExpression *target, SgExpression *operand)
	Set operands for expressions with single operand, such as unary expressions. handle file info, lvalue, pointer downcasting, parent pointer etc.
ROSE_DLL_API void	setLhsOperand (SgExpression *target, SgExpression *lhs)
	set left hand operand for binary expressions, transparently downcasting target expressions when necessary
ROSE_DLL_API void	setRhsOperand (SgExpression *target, SgExpression *rhs)
	set left hand operand for binary expression
ROSE_DLL_API void	removeAllOriginalExpressionTrees (SgNode *top)
	Set original expression trees to NULL for SgValueExp or SgCastExp expressions, so you can change the value and have it unparsed correctly.
ROSE_DLL_API void	moveToSubdirectory (std::string directoryName, SgFile *file)
	Move file to be generated in a subdirectory (will be generated by the unparser).
ROSE_DLL_API SgStatement *	findSurroundingStatementFromSameFile (SgStatement *targetStmt, bool &surroundingStatementPreceedsTargetStatement)
	Supporting function to comment relocation in insertStatement() and removeStatement().
ROSE_DLL_API void	moveCommentsToNewStatement (SgStatement *sourceStatement, const std::vector< int > &indexList, SgStatement *targetStatement, bool surroundingStatementPreceedsTargetStatement)
	Relocate comments and CPP directives from one statement to another.
ROSE_DLL_API void	moveDeclarationToAssociatedNamespace (SgDeclarationStatement *declarationStatement)
	Relocate the declaration to be explicitly represented in its associated namespace (required for some backend compilers to process template instantiations).
ROSE_DLL_API bool	isTemplateInstantiationNode (SgNode *node)
	Function to delete AST subtree's nodes only, users must take care of any dangling pointers, symbols or types that result.
ROSE_DLL_API void	wrapAllTemplateInstantiationsInAssociatedNamespaces (SgProject *root)
	Function to delete AST subtree's nodes only, users must take care of any dangling pointers, symbols or types that result.
ROSE_DLL_API void	resetInternalMapsForTargetStatement (SgStatement *sourceStatement)
	Function to delete AST subtree's nodes only, users must take care of any dangling pointers, symbols or types that result.
ROSE_DLL_API void	convertFunctionDefinitionsToFunctionPrototypes (SgNode *node)
	XXX This function operates on the new file used to support outlined function definitions. We use a copy of the file where the code will be outlined FROM, so that if there are references to declarations in the outlined code we can support the outpiled code with those references. This approach has the added advantage of also supporting the same include file tree as the original file where the outlined code is being taken from.
ROSE_DLL_API SgFunctionDeclaration *	replaceDefiningFunctionDeclarationWithFunctionPrototype (SgFunctionDeclaration *functionDeclaration)
	Function to delete AST subtree's nodes only, users must take care of any dangling pointers, symbols or types that result.
ROSE_DLL_API std::vector< SgFunctionDeclaration * >	generateFunctionDefinitionsList (SgNode *node)
	Function to delete AST subtree's nodes only, users must take care of any dangling pointers, symbols or types that result.
ROSE_DLL_API SgFunctionDeclaration *	buildFunctionPrototype (SgFunctionDeclaration *functionDeclaration)
	Function to delete AST subtree's nodes only, users must take care of any dangling pointers, symbols or types that result.
AST repair, fix, and postprocessing.
Mostly used internally when some AST pieces are built without knowing their target scope/parent, especially during bottom-up construction of AST. The associated symbols, parent and scope pointers cannot be set on construction then. A set of utility functions are provided to patch up scope, parent, symbol for them when the target scope/parent become know.
ROSE_DLL_API int	fixVariableReferences (SgNode *root, bool cleanUnusedSymbol=true)
	Connect variable reference to the right variable symbols when feasible, return the number of references being fixed.
ROSE_DLL_API void	fixVariableDeclaration (SgVariableDeclaration *varDecl, SgScopeStatement *scope)
	Patch up symbol, scope, and parent information when a SgVariableDeclaration's scope is known.
ROSE_DLL_API void	fixStructDeclaration (SgClassDeclaration *structDecl, SgScopeStatement *scope)
	Fix symbols, parent and scope pointers. Used internally within appendStatment(), insertStatement() etc when a struct declaration was built without knowing its target scope.
ROSE_DLL_API void	fixClassDeclaration (SgClassDeclaration *classDecl, SgScopeStatement *scope)
	Fix symbols, parent and scope pointers. Used internally within appendStatment(), insertStatement() etc when a class declaration was built without knowing its target scope.
ROSE_DLL_API void	fixNamespaceDeclaration (SgNamespaceDeclarationStatement *structDecl, SgScopeStatement *scope)
	Fix symbols, parent and scope pointers. Used internally within appendStatment(), insertStatement() etc when a namespace declaration was built without knowing its target scope.
ROSE_DLL_API void	fixLabelStatement (SgLabelStatement *label_stmt, SgScopeStatement *scope)
	Fix symbol table for SgLabelStatement. Used Internally when the label is built without knowing its target scope. Both parameters cannot be NULL.
ROSE_DLL_API void	setFortranNumericLabel (SgStatement *stmt, int label_value, SgLabelSymbol::label_type_enum label_type=SgLabelSymbol::e_start_label_type, SgScopeStatement *label_scope=NULL)
	Set a numerical label for a Fortran statement. The statement should have a enclosing function definition already. SgLabelSymbol and SgLabelRefExp are created transparently as needed.
ROSE_DLL_API int	suggestNextNumericLabel (SgFunctionDefinition *func_def)
	Suggest next usable (non-conflicting) numeric label value for a Fortran function definition scope.
ROSE_DLL_API void	fixFunctionDeclaration (SgFunctionDeclaration *stmt, SgScopeStatement *scope)
	Fix the symbol table and set scope (only if scope in declaration is not already set).
ROSE_DLL_API void	fixTemplateDeclaration (SgTemplateDeclaration *stmt, SgScopeStatement *scope)
	Fix the symbol table and set scope (only if scope in declaration is not already set).
ROSE_DLL_API void	fixStatement (SgStatement *stmt, SgScopeStatement *scope)
	A wrapper containing fixes (fixVariableDeclaration(),fixStructDeclaration(), fixLabelStatement(), etc) for all kinds statements. Should be used before attaching the statement into AST.
ROSE_DLL_API std::set< SgStatement * >	collectTransformedStatements (SgNode *node)
	This collects the statements that are marked as transformed (useful in debugging).
ROSE_DLL_API std::set< SgStatement * >	collectModifiedStatements (SgNode *node)
	This collects the statements that are marked as modified (a flag automatically set by all set_* generated functions) (useful in debugging).
ROSE_DLL_API std::set< SgLocatedNode * >	collectModifiedLocatedNodes (SgNode *node)
	This collects the SgLocatedNodes that are marked as modified (a flag automatically set by all set_* generated functions) (useful in debugging).
ROSE_DLL_API void	resetModifiedLocatedNodes (const std::set< SgLocatedNode * > &modifiedNodeSet)
	Use the set of IR nodes and set the isModified flag in each IR node to true.
ROSE_DLL_API void	reportModifiedStatements (const std::string &label, SgNode *node)
	Connect variable reference to the right variable symbols when feasible, return the number of references being fixed.
ROSE_DLL_API void	reportModifiedLocatedNodes (const std::string &label, SgNode *node)
	Connect variable reference to the right variable symbols when feasible, return the number of references being fixed.
ROSE_DLL_API void	translateToUseCppDeclarations (SgNode *n)
	Connect variable reference to the right variable symbols when feasible, return the number of references being fixed.
ROSE_DLL_API void	translateScopeToUseCppDeclarations (SgScopeStatement *scope)
	Connect variable reference to the right variable symbols when feasible, return the number of references being fixed.
ROSE_DLL_API std::vector< SgC_PreprocessorDirectiveStatement * >	translateStatementToUseCppDeclarations (SgStatement *statement, SgScopeStatement *scope)
	Connect variable reference to the right variable symbols when feasible, return the number of references being fixed.
ROSE_DLL_API void	printOutComments (SgLocatedNode *locatedNode)
	Connect variable reference to the right variable symbols when feasible, return the number of references being fixed.
ROSE_DLL_API bool	skipTranslateToUseCppDeclaration (PreprocessingInfo *currentPreprocessingInfo)
	Connect variable reference to the right variable symbols when feasible, return the number of references being fixed.
ROSE_DLL_API void	outputFileIds (SgNode *node)
	Connect variable reference to the right variable symbols when feasible, return the number of references being fixed.
ROSE_DLL_API void	updateDefiningNondefiningLinks (SgFunctionDeclaration *func, SgScopeStatement *scope)
	Update defining and nondefining links due to a newly introduced function declaration. Should be used after inserting the function into a scope.
Advanced AST transformations, analyses, and optimizations
Some complex but commonly used AST transformations.
ROSE_DLL_API bool	collectReadWriteRefs (SgStatement *stmt, std::vector< SgNode * > &readRefs, std::vector< SgNode * > &writeRefs, bool useCachedDefUse=false)
	Collect all read and write references within stmt, which can be a function, a scope statement, or a single statement. Note that a reference can be both read and written, like i++.
ROSE_DLL_API bool	collectReadWriteVariables (SgStatement *stmt, std::set< SgInitializedName * > &readVars, std::set< SgInitializedName * > &writeVars, bool coarseGrain=true)
	Collect unique variables which are read or written within a statement. Note that a variable can be both read and written. The statement can be either of a function, a scope, or a single line statement. For accesses to members of aggregate data, we return the coarse grain aggregate mem obj by default.
ROSE_DLL_API void	collectReadOnlyVariables (SgStatement *stmt, std::set< SgInitializedName * > &readOnlyVars, bool coarseGrain=true)
	Collect read only variables within a statement. The statement can be either of a function, a scope, or a single line statement. For accesses to members of aggregate data, we return the coarse grain aggregate mem obj by default.
ROSE_DLL_API void	collectReadOnlySymbols (SgStatement *stmt, std::set< SgVariableSymbol * > &readOnlySymbols, bool coarseGrain=true)
	Collect read only variable symbols within a statement. The statement can be either of a function, a scope, or a single line statement. For accesses to members of aggregate data, we return the coarse grain aggregate mem obj by default.
ROSE_DLL_API bool	isUseByAddressVariableRef (SgVarRefExp *ref)
	Check if a variable reference is used by its address: including &a expression and foo(a) when type2 foo(Type& parameter) in C++.
ROSE_DLL_API void	collectUseByAddressVariableRefs (const SgStatement *s, std::set< SgVarRefExp * > &varSetB)
	Collect variable references involving use by address: including &a expression and foo(a) when type2 foo(Type& parameter) in C++.
ROSE_DLL_API LivenessAnalysis *	call_liveness_analysis (SgProject *project, bool debug=false)
	Call liveness analysis on an entire project.
ROSE_DLL_API void	getLiveVariables (LivenessAnalysis *liv, SgForStatement *loop, std::set< SgInitializedName * > &liveIns, std::set< SgInitializedName * > &liveOuts)
	get liveIn and liveOut variables for a for loop from liveness analysis result liv.
ROSE_DLL_API void	ReductionRecognition (SgForStatement *loop, std::set< std::pair< SgInitializedName *, OmpSupport::omp_construct_enum > > &results)
	Recognize and collect reduction variables and operations within a C/C++ loop, following OpenMP 3.0 specification for allowed reduction variable types and operation types.
ROSE_DLL_API void	constantFolding (SgNode *r)
	Constant folding an AST subtree rooted at 'r' (replacing its children with their constant values, if applicable). Please be advised that constant folding on floating point computation may decrease the accuracy of floating point computations!
ROSE_DLL_API int	instrumentEndOfFunction (SgFunctionDeclaration *func, SgStatement *s)
	Instrument(Add a statement, often a function call) into a function right before the return points, handle multiple return statements (with duplicated statement s) and return expressions with side effects. Return the number of statements inserted.
ROSE_DLL_API void	removeJumpsToNextStatement (SgNode *)
	Remove jumps whose label is immediately after the jump. Used to clean up inlined code fragments.
ROSE_DLL_API void	removeUnusedLabels (SgNode *top, bool keepChild=false)
	Remove labels which are not targets of any goto statements: its child statement is also removed by default.
ROSE_DLL_API std::set< SgLabelStatement * >	findUnusedLabels (SgNode *top)
	Find unused labels which are not targets of any goto statements.
ROSE_DLL_API void	removeConsecutiveLabels (SgNode *top)
	Remove consecutive labels.
ROSE_DLL_API bool	mergeDeclarationAndAssignment (SgVariableDeclaration *decl, SgExprStatement *assign_stmt, bool removeAssignStmt=true)
	Merge a variable assignment statement into a matching variable declaration statement. Callers should make sure the merge is semantically correct (by not introducing compilation errors). This function simply does the merge transformation, without eligibility check.
ROSE_DLL_API bool	mergeAssignmentWithDeclaration (SgExprStatement *assign_stmt, SgVariableDeclaration *decl, bool removeAssignStmt=true)
	Merge an assignment into its upstream declaration statement. Callers should make sure the merge is semantically correct.
ROSE_DLL_API bool	mergeDeclarationWithAssignment (SgVariableDeclaration *decl, SgExprStatement *assign_stmt)
	Merge a declaration statement into a matching followed variable assignment. Callers should make sure the merge is semantically correct (by not introducing compilation errors). This function simply does the merge transformation, without eligibility check.
ROSE_DLL_API SgExprStatement *	splitVariableDeclaration (SgVariableDeclaration *decl)
	Split a variable declaration with an rhs assignment into two statements: a declaration and an assignment.
ROSE_DLL_API int	splitVariableDeclaration (SgScopeStatement *scope, bool topLevelOnly=true)
	Split declarations within a scope into declarations and assignment statements, by default only top level declarations are considered. Return the number of declarations split.
ROSE_DLL_API SgAssignInitializer *	splitExpression (SgExpression *from, std::string newName="")
	Replace an expression with a temporary variable and an assignment statement.
ROSE_DLL_API void	splitExpressionIntoBasicBlock (SgExpression *expr)
	Split long expressions into blocks of statements.
ROSE_DLL_API void	removeLabeledGotos (SgNode *top)
	Remove labeled goto statements.
ROSE_DLL_API void	changeBreakStatementsToGotos (SgStatement *loopOrSwitch)
	If the given statement contains any break statements in its body, add a new label below the statement and change the breaks into gotos to that new label.
ROSE_DLL_API SgBasicBlock *	ensureBasicBlockAsBodyOfFor (SgForStatement *fs)
	Check if the body of a 'for' statement is a SgBasicBlock, create one if not.
ROSE_DLL_API SgBasicBlock *	ensureBasicBlockAsBodyOfUpcForAll (SgUpcForAllStatement *fs)
	Check if the body of a 'upc_forall' statement is a SgBasicBlock, create one if not.
ROSE_DLL_API SgBasicBlock *	ensureBasicBlockAsBodyOfWhile (SgWhileStmt *ws)
	Check if the body of a 'while' statement is a SgBasicBlock, create one if not.
ROSE_DLL_API SgBasicBlock *	ensureBasicBlockAsBodyOfDoWhile (SgDoWhileStmt *ws)
	Check if the body of a 'do .. while' statement is a SgBasicBlock, create one if not.
ROSE_DLL_API SgBasicBlock *	ensureBasicBlockAsBodyOfSwitch (SgSwitchStatement *ws)
	Check if the body of a 'switch' statement is a SgBasicBlock, create one if not.
SgBasicBlock *	ensureBasicBlockAsBodyOfCaseOption (SgCaseOptionStmt *cs)
	Check if the body of a 'case option' statement is a SgBasicBlock, create one if not.
SgBasicBlock *	ensureBasicBlockAsBodyOfDefaultOption (SgDefaultOptionStmt *cs)
	Check if the body of a 'default option' statement is a SgBasicBlock, create one if not.
ROSE_DLL_API SgBasicBlock *	ensureBasicBlockAsTrueBodyOfIf (SgIfStmt *ifs)
	Check if the true body of a 'if' statement is a SgBasicBlock, create one if not.
ROSE_DLL_API SgBasicBlock *	ensureBasicBlockAsFalseBodyOfIf (SgIfStmt *ifs, bool createEmptyBody=true)
	Check if the false body of a 'if' statement is a SgBasicBlock, create one if not when the flag is true.
ROSE_DLL_API SgBasicBlock *	ensureBasicBlockAsBodyOfCatch (SgCatchOptionStmt *cos)
	Check if the body of a 'catch' statement is a SgBasicBlock, create one if not.
ROSE_DLL_API SgBasicBlock *	ensureBasicBlockAsBodyOfOmpBodyStmt (SgOmpBodyStatement *ompbodyStmt)
	Check if the body of a SgOmpBodyStatement is a SgBasicBlock, create one if not.
ROSE_DLL_API void	cleanupNontransformedBasicBlockNode ()
	Remove unused basic block IR nodes added as part of normalization.
ROSE_DLL_API void	recordNormalizations (SgStatement *s)
	Record where normalization have been done so that we can preform denormalizations as required for the token-based unparsing to generate minimal diffs.
ROSE_DLL_API int	normalizeArrowExpWithAddressOfLeftOperand (SgNode *root, bool transformationGeneratedOnly=true)
	Convert all code within root matching the patern of (&left)->right, and translate them into left.right. Return the number of matches of the pattern. Be default, only transformation generated nodes will be normalized.
bool	isBodyStatement (SgStatement *s)
	Check if a statement is a (true or false) body of a container-like parent, such as For, Upc_forall, Do-while, switch, If, Catch, OmpBodyStmt, etc.
void	changeAllBodiesToBlocks (SgNode *top, bool createEmptyBody=true)
	Fix up ifs, loops, while, switch, Catch, OmpBodyStatement, etc. to have blocks as body components. It also adds an empty else body to if statements that don't have them.
SgBasicBlock *	makeSingleStatementBodyToBlock (SgStatement *singleStmt)
	Make a single statement body to be a basic block. Its parent is if, while, catch, or upc_forall etc.
unsigned long long	getIntegerConstantValue (SgValueExp *expr)
	Get the constant value from a constant integer expression; abort on everything else.
std::vector< SgDeclarationStatement * >	getDependentDeclarations (SgStatement *stmt)
	Get a statement's dependent declarations which declares the types used in the statement. The returned vector of declaration statements are sorted according to their appearance order in the original AST. Any reference to a class or template class from a namespace will treated as a reference to the enclosing namespace.
SgCommaOpExp *	insertBeforeUsingCommaOp (SgExpression *new_exp, SgExpression *anchor_exp)
	Insert an expression (new_exp )before another expression (anchor_exp) has possible side effects, without changing the original semantics. This is achieved by using a comma operator: (new_exp, anchor_exp). The comma operator is returned.
SgCommaOpExp *	insertAfterUsingCommaOp (SgExpression *new_exp, SgExpression *anchor_exp, SgStatement **temp_decl=NULL, SgVarRefExp **temp_ref=NULL)
	Insert an expression (new_exp ) after another expression (anchor_exp) has possible side effects, without changing the original semantics. This is done by using two comma operators: type T1; ... ((T1 = anchor_exp, new_exp),T1) )... , where T1 is a temp variable saving the possible side effect of anchor_exp. The top level comma op exp is returned. The reference to T1 in T1 = anchor_exp is saved in temp_ref.
std::pair< SgStatement *, SgInitializedName * >	wrapFunction (SgFunctionDeclaration &definingDeclaration, SgName newName)
	moves the body of a function f to a new function f; f's body is replaced with code that forwards the call to f.
template<class NameGen >
std::pair< SgStatement *, SgInitializedName * >	wrapFunction (SgFunctionDeclaration &definingDeclaration, NameGen nameGen)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
SgInitializedName &	getFirstVariable (SgVariableDeclaration &vardecl)
	convenience function that returns the first initialized name in a list of variable declarations.
bool	hasTemplateSyntax (const SgName &name)
	Collect all read and write references within stmt, which can be a function, a scope statement, or a single statement. Note that a reference can be both read and written, like i++.
std::set< unsigned int >	collectSourceSequenceNumbers (SgNode *astNode)
	Collect all read and write references within stmt, which can be a function, a scope statement, or a single statement. Note that a reference can be both read and written, like i++.
bool	HasNoThrowAssign (const SgType *const inputType)
	Collect all read and write references within stmt, which can be a function, a scope statement, or a single statement. Note that a reference can be both read and written, like i++.
bool	HasNoThrowCopy (const SgType *const inputType)
	Collect all read and write references within stmt, which can be a function, a scope statement, or a single statement. Note that a reference can be both read and written, like i++.
bool	HasNoThrowConstructor (const SgType *const inputType)
	Collect all read and write references within stmt, which can be a function, a scope statement, or a single statement. Note that a reference can be both read and written, like i++.
bool	HasTrivialAssign (const SgType *const inputType)
	Collect all read and write references within stmt, which can be a function, a scope statement, or a single statement. Note that a reference can be both read and written, like i++.
bool	HasTrivialCopy (const SgType *const inputType)
	Collect all read and write references within stmt, which can be a function, a scope statement, or a single statement. Note that a reference can be both read and written, like i++.
bool	HasTrivialConstructor (const SgType *const inputType)
	Collect all read and write references within stmt, which can be a function, a scope statement, or a single statement. Note that a reference can be both read and written, like i++.
bool	HasTrivialDestructor (const SgType *const inputType)
	Collect all read and write references within stmt, which can be a function, a scope statement, or a single statement. Note that a reference can be both read and written, like i++.
bool	HasVirtualDestructor (const SgType *const inputType)
	Collect all read and write references within stmt, which can be a function, a scope statement, or a single statement. Note that a reference can be both read and written, like i++.
bool	IsBaseOf (const SgType *const inputBaseType, const SgType *const inputDerivedType)
	Collect all read and write references within stmt, which can be a function, a scope statement, or a single statement. Note that a reference can be both read and written, like i++.
bool	IsAbstract (const SgType *const inputType)
	Collect all read and write references within stmt, which can be a function, a scope statement, or a single statement. Note that a reference can be both read and written, like i++.
bool	IsClass (const SgType *const inputType)
	strip off typedef and modifer types, then check if a type is a class type, excluding union type.
bool	IsEmpty (const SgType *const inputType)
	Collect all read and write references within stmt, which can be a function, a scope statement, or a single statement. Note that a reference can be both read and written, like i++.
bool	IsEnum (const SgType *const inputType)
	Collect all read and write references within stmt, which can be a function, a scope statement, or a single statement. Note that a reference can be both read and written, like i++.
bool	IsPod (const SgType *const inputType)
	Collect all read and write references within stmt, which can be a function, a scope statement, or a single statement. Note that a reference can be both read and written, like i++.
bool	IsPolymorphic (const SgType *const inputType)
	Collect all read and write references within stmt, which can be a function, a scope statement, or a single statement. Note that a reference can be both read and written, like i++.
bool	IsStandardLayout (const SgType *const inputType)
	Collect all read and write references within stmt, which can be a function, a scope statement, or a single statement. Note that a reference can be both read and written, like i++.
bool	IsLiteralType (const SgType *const inputType)
	Collect all read and write references within stmt, which can be a function, a scope statement, or a single statement. Note that a reference can be both read and written, like i++.
bool	IsTrivial (const SgType *const inputType)
	Collect all read and write references within stmt, which can be a function, a scope statement, or a single statement. Note that a reference can be both read and written, like i++.
bool	IsUnion (const SgType *const inputType)
	Collect all read and write references within stmt, which can be a function, a scope statement, or a single statement. Note that a reference can be both read and written, like i++.
SgType *	UnderlyingType (SgType *type)
	Collect all read and write references within stmt, which can be a function, a scope statement, or a single statement. Note that a reference can be both read and written, like i++.
bool	isStructurallyEquivalentAST (SgNode *tree1, SgNode *tree2)
	Collect all read and write references within stmt, which can be a function, a scope statement, or a single statement. Note that a reference can be both read and written, like i++.
struct const_int_expr_t	evaluateConstIntegerExpression (SgExpression *expr)
	The function tries to evaluate const integer expressions (such as are used in array dimension sizes). It follows variable symbols, and requires constness.
bool	checkTypesAreEqual (SgType *typeA, SgType *typeB)
	Collect all read and write references within stmt, which can be a function, a scope statement, or a single statement. Note that a reference can be both read and written, like i++.
ROSE_DLL_API std::string	getTempDirectory (SgProject *project)
	Collect all read and write references within stmt, which can be a function, a scope statement, or a single statement. Note that a reference can be both read and written, like i++.
ROSE_DLL_API void	destroyTempDirectory (std::string)
	Collect all read and write references within stmt, which can be a function, a scope statement, or a single statement. Note that a reference can be both read and written, like i++.
ROSE_DLL_API SgFile *	processFile (SgProject *, std::string, bool unparse=false)
	Collect all read and write references within stmt, which can be a function, a scope statement, or a single statement. Note that a reference can be both read and written, like i++.
ROSE_DLL_API std::string	preprocessPackage (SgProject *, std::string)
	Collect all read and write references within stmt, which can be a function, a scope statement, or a single statement. Note that a reference can be both read and written, like i++.
ROSE_DLL_API std::string	preprocessImport (SgProject *, std::string)
	Collect all read and write references within stmt, which can be a function, a scope statement, or a single statement. Note that a reference can be both read and written, like i++.
ROSE_DLL_API SgFile *	preprocessCompilationUnit (SgProject *, std::string, std::string, bool unparse=true)
	Collect all read and write references within stmt, which can be a function, a scope statement, or a single statement. Note that a reference can be both read and written, like i++.
ROSE_DLL_API SgClassDefinition *	findJavaPackage (SgScopeStatement *, std::string)
	Collect all read and write references within stmt, which can be a function, a scope statement, or a single statement. Note that a reference can be both read and written, like i++.
ROSE_DLL_API SgClassDefinition *	findOrInsertJavaPackage (SgProject *, std::string, bool create_directory=false)
	Collect all read and write references within stmt, which can be a function, a scope statement, or a single statement. Note that a reference can be both read and written, like i++.
ROSE_DLL_API SgClassDeclaration *	findOrImportJavaClass (SgProject *, SgClassDefinition *package_definition, std::string)
	Collect all read and write references within stmt, which can be a function, a scope statement, or a single statement. Note that a reference can be both read and written, like i++.
ROSE_DLL_API SgClassDeclaration *	findOrImportJavaClass (SgProject *, std::string, std::string)
	Collect all read and write references within stmt, which can be a function, a scope statement, or a single statement. Note that a reference can be both read and written, like i++.
ROSE_DLL_API SgClassDeclaration *	findOrImportJavaClass (SgProject *, SgClassType *)
	Collect all read and write references within stmt, which can be a function, a scope statement, or a single statement. Note that a reference can be both read and written, like i++.
ROSE_DLL_API SgMemberFunctionDeclaration *	findJavaMain (SgClassDefinition *)
	Collect all read and write references within stmt, which can be a function, a scope statement, or a single statement. Note that a reference can be both read and written, like i++.
ROSE_DLL_API SgMemberFunctionDeclaration *	findJavaMain (SgClassType *)
	Collect all read and write references within stmt, which can be a function, a scope statement, or a single statement. Note that a reference can be both read and written, like i++.
template<class T >
bool	isTemplateInstantiationFromTemplateDeclarationSatisfyingFilter (SgFunctionDeclaration *function, T *filter)
	This function detects template instantiations that are relevant when filters are used.
void	detectCycleInType (SgType *type, const std::string &from)
	Collect all read and write references within stmt, which can be a function, a scope statement, or a single statement. Note that a reference can be both read and written, like i++.
void	checkForInitializers (SgNode *node)
	Collect all read and write references within stmt, which can be a function, a scope statement, or a single statement. Note that a reference can be both read and written, like i++.
void	clearSharedGlobalScopes (SgProject *project)
	Collect all read and write references within stmt, which can be a function, a scope statement, or a single statement. Note that a reference can be both read and written, like i++.

Variables
ROSE_DLL_API Transformation_Record	trans_records
ROSE_DLL_API int	gensym_counter
	An internal counter for generating unique SgName.

Stringify
Generate a useful string (name) to describe a SgNode
std::map< std::string, int >	local_name_collision_map
	Global map of name collisions to support generateUniqueNameForUseAsIdentifier() function.
std::map< std::string, SgNode * >	local_name_to_node_map
	Global map of name collisions to support generateUniqueNameForUseAsIdentifier() function.
std::map< SgNode *, std::string >	local_node_to_name_map
	Global map of name collisions to support generateUniqueNameForUseAsIdentifier() function.
std::string	get_name (const SgNode *node)
	Generate a useful name to describe the SgNode.
std::string	get_name (const SgStatement *stmt)
	Generate a useful name to describe the declaration.
std::string	get_name (const SgExpression *expr)
	Generate a useful name to describe the expression.
std::string	get_name (const SgDeclarationStatement *declaration)
	Generate a useful name to describe the declaration.
std::string	get_name (const SgScopeStatement *scope)
	Generate a useful name to describe the scope.
std::string	get_name (const SgSymbol *symbol)
	Generate a useful name to describe the SgSymbol.
std::string	get_name (const SgType *type)
	Generate a useful name to describe the SgType.
std::string	get_name (const SgSupport *node)
	Generate a useful name to describe the SgSupport IR node.
std::string	get_name (const SgLocatedNodeSupport *node)
	Generate a useful name to describe the SgLocatedNodeSupport IR node.
std::string	get_name (const SgC_PreprocessorDirectiveStatement *directive)
	Generate a useful name to describe the SgC_PreprocessorDirectiveStatement IR node.
std::string	get_name (const SgToken *token)
	Generate a useful name to describe the SgToken IR node.
SgNamedType *	getDeclaredType (const SgDeclarationStatement *declaration)
	Returns the type introduced by a declaration.
std::string	generateUniqueNameForUseAsIdentifier (SgDeclarationStatement *declaration)
	Generate a useful name to support construction of identifiers from declarations.
std::string	generateUniqueNameForUseAsIdentifier_support (SgDeclarationStatement *declaration)
	Global map of name collisions to support generateUniqueNameForUseAsIdentifier() function.
void	computeUniqueNameForUseAsIdentifier (SgNode *astNode)
	Traversal to set the global map of names to node and node to names.collisions to support generateUniqueNameForUseAsIdentifier() function.
void	reset_name_collision_map ()
	Reset map variables used to support generateUniqueNameForUseAsIdentifier() function.

Typedef Documentation

EquivalenceTestFunctionType

typedef bool(* SageInterface::EquivalenceTestFunctionType) (SgNode *x, SgNode *y)

Definition at line 38 of file sageInterfaceAsm.h.

Function Documentation

set_name()

ROSE_DLL_API int SageInterface::set_name	(	SgInitializedName *	initializedNameNode,
		SgName	new_name
	)

set_name of symbol in symbol table.

This function extracts the symbol from the relavant symbol table, changes the name (at the declaration) and reinserts it into the symbol table.

outputLocalSymbolTables()

ROSE_DLL_API void SageInterface::outputLocalSymbolTables

(

SgNode *

node

)

Output the local symbol tables.

\implementation Each symbol table is output with the file infor where it is located in the source code.

rebuildSymbolTable()

void SageInterface::rebuildSymbolTable

(

SgScopeStatement *

scope

)

Regenerate the symbol table.

\implementation current symbol table must be NULL pointer before calling this function (for safety, but is this a good idea?)

getDeclaredType()

SgNamedType * SageInterface::getDeclaredType

(

const SgDeclarationStatement *

declaration

)

Returns the type introduced by a declaration.

Note

If the type is not an SgNamedType, nullptr is returned

generateUniqueNameForUseAsIdentifier()

std::string SageInterface::generateUniqueNameForUseAsIdentifier

(

SgDeclarationStatement *

declaration

)

Generate a useful name to support construction of identifiers from declarations.

This function permits names to be generated that will be unique across translation units (a specific requirement different from the context of the get_name() functions above).

generateUniqueName()

std::string SageInterface::generateUniqueName	(	const SgNode *	node,
		bool	ignoreDifferenceBetweenDefiningAndNondefiningDeclarations
	)

Generate unique name from C and C++ constructs. The name may contain space.

This is support for the AST merge, but is generally useful as a more general mechanism than name mangling which is more closely ties to the generation of names to support link-time function name resolution. This is more general than common name mangling in that it resolves more relevant differences between C and C++ declarations. (e.g. the type within the declaration: "struct { int:8; } foo;").

\implementation current work does not support expressions.

generateUniqueVariableName()

std::string SageInterface::generateUniqueVariableName	(	SgScopeStatement *	scope,
		std::string	baseName = "temp"
	)

Generate a name like temp# that is unique in the current scope and any parent and children scopes.

# is a unique integer counter.

Parameters

baseName

the word to be included in the variable names.

astIntersection()

ROSE_DLL_API std::vector< SgNode * > SageInterface::astIntersection	(	SgNode *	original,
		SgNode *	copy,
		SgCopyHelp *	help = NULL
	)

Compute the intersection set for two ASTs.

This is part of a test done by the copy function to compute those IR nodes in the copy that still reference the original AST.

deepCopy()

template<typename NodeType >

NodeType * SageInterface::deepCopy

(

const NodeType *

subtree

)

A template function for deep copying a subtree. It is also used to create deepcopy functions with specialized parameter and return types. e.g SgExpression* copyExpression(SgExpression* e);.

Definition at line 559 of file sageInterface.h.

References deepCopyNode().

isAssignmentStatement()

ROSE_DLL_API bool SageInterface::isAssignmentStatement	(	SgNode *	_s,
		SgExpression **	lhs = NULL,
		SgExpression **	rhs = NULL,
		bool *	readlhs = NULL
	)

Check if a SgNode _s is an assignment statement (any of =,+=,-=,&=,/=, ^=, etc)

Return the left hand, right hand expressions and if the left hand variable is also being read

is_Ada_language()

ROSE_DLL_API bool SageInterface::is_Ada_language ( )

inline

Brief These traverse the memory pool of SgFile IR nodes and determine what languages are in use!

Definition at line 695 of file sageInterface.h.

Referenced by setParameterList().

is_C_language()

ROSE_DLL_API bool SageInterface::is_C_language ( )

inline

Brief These traverse the memory pool of SgFile IR nodes and determine what languages are in use!

Definition at line 696 of file sageInterface.h.

is_OpenMP_language()

ROSE_DLL_API bool SageInterface::is_OpenMP_language ( )

inline

Brief These traverse the memory pool of SgFile IR nodes and determine what languages are in use!

Definition at line 697 of file sageInterface.h.

is_UPC_language()

ROSE_DLL_API bool SageInterface::is_UPC_language ( )

inline

Brief These traverse the memory pool of SgFile IR nodes and determine what languages are in use!

Definition at line 698 of file sageInterface.h.

is_UPC_dynamic_threads()

ROSE_DLL_API bool SageInterface::is_UPC_dynamic_threads ( )

inline

Brief These traverse the memory pool of SgFile IR nodes and determine what languages are in use!

Definition at line 699 of file sageInterface.h.

is_C99_language()

ROSE_DLL_API bool SageInterface::is_C99_language ( )

inline

Brief These traverse the memory pool of SgFile IR nodes and determine what languages are in use!

Definition at line 700 of file sageInterface.h.

is_Cxx_language()

ROSE_DLL_API bool SageInterface::is_Cxx_language ( )

inline

Brief These traverse the memory pool of SgFile IR nodes and determine what languages are in use!

Definition at line 701 of file sageInterface.h.

is_Java_language()

ROSE_DLL_API bool SageInterface::is_Java_language ( )

inline

Brief These traverse the memory pool of SgFile IR nodes and determine what languages are in use!

Definition at line 702 of file sageInterface.h.

is_Jovial_language()

ROSE_DLL_API bool SageInterface::is_Jovial_language ( )

inline

Brief These traverse the memory pool of SgFile IR nodes and determine what languages are in use!

Definition at line 703 of file sageInterface.h.

is_Jvm_language()

ROSE_DLL_API bool SageInterface::is_Jvm_language ( )

inline

Brief These traverse the memory pool of SgFile IR nodes and determine what languages are in use!

Definition at line 704 of file sageInterface.h.

is_Fortran_language()

ROSE_DLL_API bool SageInterface::is_Fortran_language ( )

inline

Brief These traverse the memory pool of SgFile IR nodes and determine what languages are in use!

Definition at line 705 of file sageInterface.h.

is_CAF_language()

ROSE_DLL_API bool SageInterface::is_CAF_language ( )

inline

Brief These traverse the memory pool of SgFile IR nodes and determine what languages are in use!

Definition at line 706 of file sageInterface.h.

is_PHP_language()

ROSE_DLL_API bool SageInterface::is_PHP_language ( )

inline

Brief These traverse the memory pool of SgFile IR nodes and determine what languages are in use!

Definition at line 707 of file sageInterface.h.

is_Python_language()

ROSE_DLL_API bool SageInterface::is_Python_language ( )

inline

Brief These traverse the memory pool of SgFile IR nodes and determine what languages are in use!

Definition at line 708 of file sageInterface.h.

is_Cuda_language()

ROSE_DLL_API bool SageInterface::is_Cuda_language ( )

inline

Brief These traverse the memory pool of SgFile IR nodes and determine what languages are in use!

Definition at line 709 of file sageInterface.h.

is_OpenCL_language()

ROSE_DLL_API bool SageInterface::is_OpenCL_language ( )

inline

Brief These traverse the memory pool of SgFile IR nodes and determine what languages are in use!

Definition at line 710 of file sageInterface.h.

is_binary_executable()

ROSE_DLL_API bool SageInterface::is_binary_executable ( )

inline

Brief These traverse the memory pool of SgFile IR nodes and determine what languages are in use!

Definition at line 711 of file sageInterface.h.

is_mixed_C_and_Cxx_language()

ROSE_DLL_API bool SageInterface::is_mixed_C_and_Cxx_language

(

)

Brief These traverse the memory pool of SgFile IR nodes and determine what languages are in use!

is_mixed_Fortran_and_C_language()

ROSE_DLL_API bool SageInterface::is_mixed_Fortran_and_C_language

(

)

Brief These traverse the memory pool of SgFile IR nodes and determine what languages are in use!

is_mixed_Fortran_and_Cxx_language()

ROSE_DLL_API bool SageInterface::is_mixed_Fortran_and_Cxx_language

(

)

Brief These traverse the memory pool of SgFile IR nodes and determine what languages are in use!

is_mixed_Fortran_and_C_and_Cxx_language()

ROSE_DLL_API bool SageInterface::is_mixed_Fortran_and_C_and_Cxx_language

(

)

Brief These traverse the memory pool of SgFile IR nodes and determine what languages are in use!

is_language_case_insensitive()

ROSE_DLL_API bool SageInterface::is_language_case_insensitive

(

)

Brief These traverse the memory pool of SgFile IR nodes and determine what languages are in use!

language_may_contain_nondeclarations_in_scope()

ROSE_DLL_API bool SageInterface::language_may_contain_nondeclarations_in_scope

(

)

Brief These traverse the memory pool of SgFile IR nodes and determine what languages are in use!

resetScopeNumbers()

void SageInterface::resetScopeNumbers

(

SgFunctionDefinition *

functionDeclaration

)

Assigns unique numbers to each SgScopeStatement of a function.

This is used to provide unique names for variables and types defined is different nested scopes of a function (used in mangled name generation).

clearScopeNumbers()

void SageInterface::clearScopeNumbers

(

SgFunctionDefinition *

functionDefinition

)

Clears the cache of scope,integer pairs for the input function.

This is used to clear the cache of computed unique labels for scopes in a function. This function should be called after any transformation on a function that might effect the allocation of scopes and cause the existing unique numbers to be incorrect. This is part of support to provide unique names for variables and types defined is different nested scopes of a function (used in mangled name generation).

isPrototypeInScope()

bool SageInterface::isPrototypeInScope	(	SgScopeStatement *	scope,
		SgFunctionDeclaration *	functionDeclaration,
		SgDeclarationStatement *	startingAtDeclaration
	)

Assigns unique numbers to each SgScopeStatement of a function.

This is used to provide unique names for variables and types defined is different nested scopes of a function (used in mangled name generation).

guardNode()

void SageInterface::guardNode	(	SgLocatedNode *	target,
		std::string	guard
	)

Add preproccessor guard around a given node.

It surrounds the node with "#if guard" and "#endif"

insideSystemHeader()

ROSE_DLL_API bool SageInterface::insideSystemHeader

(

SgLocatedNode *

node

)

Set source position info(Sg_File_Info) as transformation generated for all SgNodes in memory pool.

Check if a node is from a system header file

isStrictIntegerType()

ROSE_DLL_API bool SageInterface::isStrictIntegerType

(

SgType *

t

)

Check if a type is an integral type, only allowing signed/unsigned short, int, long, long long. /! /! There is another similar function named SgType::isIntegerType(), which allows additional types char, wchar, and bool to be treated as integer types.

Check if a type is an integral type, only allowing signed/unsigned short, int, long, long long.

There is another similar function named SgType::isIntegerType(), which allows additional types char, wchar, and bool.

isPureVirtualClass()

ROSE_DLL_API bool SageInterface::isPureVirtualClass	(	SgType *	type,
		const ClassHierarchyWrapper &	classHierarchy
	)

Check if a class type is a pure virtual class.

True means that there is at least one pure virtual function that has not been overridden. In the case of an incomplete class type (forward declaration), this function returns false.

isPointerToNonConstType()

ROSE_DLL_API bool SageInterface::isPointerToNonConstType

(

SgType *

type

)

Is this a pointer to a non-const type? Note that this function will return true for const pointers pointing to non-const types.

For example, (int* const y) points to a modifiable int, so this function returns true. Meanwhile, it returns false for (int const * x) and (int const * const x) because these types point to a const int. Also, only the outer layer of nested pointers is unwrapped. So the function returns true for (const int ** y), but returns false for const (int * const * x)

isScalarType()

ROSE_DLL_API bool SageInterface::isScalarType

(

SgType *

t

)

Is this a scalar type?

We define the following SgType as scalar types: char, short, int, long , void, Wchar, Float, double, long long, string, bool, complex, imaginary

get_C_array_dimensions() [1/3]

std::vector< SgExpression * > SageInterface::get_C_array_dimensions

(

const SgArrayType &

arrtype

)

returns the array dimensions in an array as defined for arrtype

Parameters

arrtype

the type of a C/C++ array

Returns

an array that contains an expression indicating each dimension's size. OWNERSHIP of the expressions is TRANSFERED TO the CALLER (which becomes responsible for freeing the expressions). Note, the first entry of the array is a SgNullExpression, iff the first array dimension was not specified.

int x[] = { 1, 2, 3 };

note, the expression does not have to be a constant

int x[i*5];

Postcondition

return-value.empty() == false

return-value[*] != NULL (no nullptr in the returned vector)

get_C_array_dimensions() [2/3]

std::vector< SgExpression * > SageInterface::get_C_array_dimensions	(	const SgArrayType &	arrtype,
		const SgVarRefExp &	varref
	)

returns the array dimensions in an array as defined for arrtype

Parameters

arrtype	the type of a C/C++ array
varref	a reference to an array variable (the variable of type arrtype)

Returns

an array that contains an expression indicating each dimension's size. OWNERSHIP of the expressions is TRANSFERED TO the CALLER (which becomes responsible for freeing the expressions). If the first array dimension was not specified an expression that indicates that size is generated.

int x[][3] = { 1, 2, 3, 4, 5, 6 };

the entry for the first dimension will be:

// 3 ... size of 2nd dimension
sizeof(x) / (sizeof(int) * 3)

Precondition

arrtype is the array-type of varref

Postcondition

return-value.empty() == false

return-value[*] != NULL (no nullptr in the returned vector)

!isSgNullExpression(return-value[*])

get_C_array_dimensions() [3/3]

std::vector< SgExpression * > SageInterface::get_C_array_dimensions	(	const SgArrayType &	arrtype,
		SgInitializedName &	initname
	)

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

Note

see get_C_array_dimensions for SgVarRefExp for details.

hasUpcSharedType()

ROSE_DLL_API bool SageInterface::hasUpcSharedType	(	SgType *	t,
		SgModifierType **	mod_type_out = NULL
	)

Has a UPC shared type of any kinds (shared-to-shared, private-to-shared, shared-to-private, shared scalar/array)? An optional parameter, mod_type_out, stores the first SgModifierType with UPC access information.

Note: we classify private-to-shared as 'has shared' type for convenience here. It is indeed a private type in strict sense. AST graph for some examples:

• shared scalar: SgModifierType -->base type
• shared array: SgArrayType --> SgModiferType --> base type
• shared to shared: SgModifierType --> SgPointerType --> SgModifierType ->SgTypeInt
• shared to private: SgModifierType --> SgPointerType --> base type
• private to shared: SgPointerType --> SgModifierType --> base type

isUpcSharedType()

ROSE_DLL_API bool SageInterface::isUpcSharedType	(	SgType *	t,
		SgModifierType **	mod_type_out = NULL
	)

Check if a type is a UPC shared type, including shared array, shared pointers etc. Exclude private pointers to shared types. Optionally return the modifier type with the UPC shared property.

ROSE uses SgArrayType of SgModifierType to represent shared arrays, not SgModifierType points to SgArrayType. Also typedef may cause a chain of nodes before reach the actual SgModifierType with UPC shared property.

isEquivalentFunctionType()

ROSE_DLL_API bool SageInterface::isEquivalentFunctionType	(	const SgFunctionType *	lhs,
		const SgFunctionType *	rhs
	)

Test if two types are equivalent SgFunctionType nodes.

This is necessary for template function types They may differ in one SgTemplateType pointer but identical otherwise.

addStepToLoopBody()

ROSE_DLL_API void SageInterface::addStepToLoopBody	(	SgScopeStatement *	loopStmt,
		SgStatement *	step
	)

Add a step statement to the end of a loop body Add a new label to the end of the loop, with the step statement after it; then change all continue statements in the old loop body into jumps to the label.

For example: while (a < 5) {if (a < -3) continue;} (adding "a++" to end) becomes while (a < 5) {if (a < -3) goto label; label: a++;}

moveForStatementIncrementIntoBody()

ROSE_DLL_API void SageInterface::moveForStatementIncrementIntoBody

(

SgForStatement *

f

)

Add a step statement to the end of a loop body Add a new label to the end of the loop, with the step statement after it; then change all continue statements in the old loop body into jumps to the label.

For example: while (a < 5) {if (a < -3) continue;} (adding "a++" to end) becomes while (a < 5) {if (a < -3) goto label; label: a++;}

convertForToWhile()

ROSE_DLL_API void SageInterface::convertForToWhile

(

SgForStatement *

f

)

Add a step statement to the end of a loop body Add a new label to the end of the loop, with the step statement after it; then change all continue statements in the old loop body into jumps to the label.

For example: while (a < 5) {if (a < -3) continue;} (adding "a++" to end) becomes while (a < 5) {if (a < -3) goto label; label: a++;}

convertAllForsToWhiles()

ROSE_DLL_API void SageInterface::convertAllForsToWhiles

(

SgNode *

top

)

Add a step statement to the end of a loop body Add a new label to the end of the loop, with the step statement after it; then change all continue statements in the old loop body into jumps to the label.

For example: while (a < 5) {if (a < -3) continue;} (adding "a++" to end) becomes while (a < 5) {if (a < -3) goto label; label: a++;}

hasMultipleInitStatmentsOrExpressions()

ROSE_DLL_API bool SageInterface::hasMultipleInitStatmentsOrExpressions

(

SgForStatement *

for_loop

)

Check if a for loop uses C99 style initialization statement with multiple expressions like for (int i=0, j=0; ..) or for (i=0,j=0;...)

for (int i=0, j=0; ..) is stored as two variable declarations under SgForInitStatement's init_stmt member for (i=0,j=0;...) is stored as a single expression statement, with comma expression (i=0,j=0).

setLoopBody()

ROSE_DLL_API void SageInterface::setLoopBody	(	SgScopeStatement *	loop,
		SgStatement *	body
	)

Add a step statement to the end of a loop body Add a new label to the end of the loop, with the step statement after it; then change all continue statements in the old loop body into jumps to the label.

For example: while (a < 5) {if (a < -3) continue;} (adding "a++" to end) becomes while (a < 5) {if (a < -3) goto label; label: a++;}

isCanonicalForLoop()

ROSE_DLL_API bool SageInterface::isCanonicalForLoop	(	SgNode *	loop,
		SgInitializedName **	ivar = NULL,
		SgExpression **	lb = NULL,
		SgExpression **	ub = NULL,
		SgExpression **	step = NULL,
		SgStatement **	body = NULL,
		bool *	hasIncrementalIterationSpace = NULL,
		bool *	isInclusiveUpperBound = NULL
	)

Check if a for-loop has a canonical form, return loop index, bounds, step, and body if requested.

A canonical form is defined as : one initialization statement, a test expression, and an increment expression , loop index variable should be of an integer type. IsInclusiveUpperBound is true when <= or >= is used for loop condition

forLoopNormalization()

ROSE_DLL_API bool SageInterface::forLoopNormalization	(	SgForStatement *	loop,
		bool	foldConstant = true
	)

Normalize a for loop, return true if successful.

Generated constants will be fold by default.

Translations are : For the init statement: for (int i=0;... ) becomes int i; for (i=0;..) For test expression: i<x is normalized to i<= (x-1) and i>x is normalized to i>= (x+1) For increment expression: i++ is normalized to i+=1 and i– is normalized to i+=-1 i-=s is normalized to i+= -s

normalizeForLoopIncrement()

ROSE_DLL_API bool SageInterface::normalizeForLoopIncrement

(

SgForStatement *

loop

)

Add a step statement to the end of a loop body Add a new label to the end of the loop, with the step statement after it; then change all continue statements in the old loop body into jumps to the label.

For example: while (a < 5) {if (a < -3) continue;} (adding "a++" to end) becomes while (a < 5) {if (a < -3) goto label; label: a++;}

loopCollapsing()

SgExprListExp * SageInterface::loopCollapsing	(	SgForStatement *	target_loop,
		size_t	collapsing_factor
	)

Add a step statement to the end of a loop body Add a new label to the end of the loop, with the step statement after it; then change all continue statements in the old loop body into jumps to the label.

For example: while (a < 5) {if (a < -3) continue;} (adding "a++" to end) becomes while (a < 5) {if (a < -3) goto label; label: a++;}

getForLoopInformations()

bool SageInterface::getForLoopInformations	(	SgForStatement *	for_loop,
		SgVariableSymbol *&	iterator,
		SgExpression *&	lower_bound,
		SgExpression *&	upper_bound,
		SgExpression *&	stride
	)

Add a step statement to the end of a loop body Add a new label to the end of the loop, with the step statement after it; then change all continue statements in the old loop body into jumps to the label.

For example: while (a < 5) {if (a < -3) continue;} (adding "a++" to end) becomes while (a < 5) {if (a < -3) goto label; label: a++;}

querySubTree()

template<typename NodeType >

std::vector< NodeType * > SageInterface::querySubTree	(	SgNode *	top,
		VariantT	variant = (VariantT)NodeType::static_variant
	)

Query a subtree to get all nodes of a given type, with an appropriate downcast.

Definition at line 1300 of file sageInterface.h.

generateFileList()

std::vector< SgFile * > SageInterface::generateFileList

(

)

Returns STL vector of SgFile IR node pointers.

Demonstrates use of restricted traversal over just SgFile IR nodes.

getProject() [1/2]

ROSE_DLL_API SgProject * SageInterface::getProject

(

)

Get the current SgProject IR Node.

The library should never have more than one project and it asserts such. If no project has been created yet then this function returns the null pointer.

getProject() [2/2]

SgProject * SageInterface::getProject

(

const SgNode *

node

)

Returns

the project associated with a node

serialize_list()

template<typename T >

void SageInterface::serialize_list	(	T &	plist,
		std::string	T_name,
		std::string &	prefix,
		bool	hasRemaining,
		std::ostringstream &	out,
		std::string &	edgeLabel
	)

Query a subtree to get all nodes of a given type, with an appropriate downcast.

Definition at line 1375 of file sageInterface.h.

findBreakStmts()

std::vector< SgBreakStmt * > SageInterface::findBreakStmts	(	SgStatement *	code,
		const std::string &	fortranLabel = ""
	)

Find break statements inside a particular statement, stopping at nested loops or switches.

loops or switch statements defines their own contexts for break statements. The function will stop immediately if run on a loop or switch statement. If fortranLabel is non-empty, breaks (EXITs) to that label within nested loops are included in the returned list.

findContinueStmts()

std::vector< SgContinueStmt * > SageInterface::findContinueStmts	(	SgStatement *	code,
		const std::string &	fortranLabel = ""
	)

Find all continue statements inside a particular statement, stopping at nested loops.

Nested loops define their own contexts for continue statements. The function will stop immediately if run on a loop statement. If fortranLabel is non-empty, continues (CYCLEs) to that label within nested loops are included in the returned list.

findDeclarationStatement()

template<typename T >

T * SageInterface::findDeclarationStatement	(	SgNode *	root,
		std::string	name,
		SgScopeStatement *	scope,
		bool	isDefining
	)

Topdown traverse a subtree from root to find the first declaration given its name, scope (optional, can be NULL), and defining or nondefining flag.

Definition at line 1445 of file sageInterface.h.

References SgSymbol::get_name(), and SgNode::get_traversalSuccessorContainer().

getEnclosingNode()

template<typename NodeType >

NodeType * SageInterface::getEnclosingNode	(	const SgNode *	astNode,
		const bool	includingSelf = false
	)

Find a node by type using upward traversal.

Traverse backward through a specified node's ancestors, starting with the node's parent and progressing to more distant ancestors, to find the first node matching the specified or derived type. If includingSelf is true then the starting node, astNode, is returned if its type matches, otherwise the search starts at the parent of astNode.

For the purposes of this function, the parent (P) of an SgDeclarationStatement node (N) is considered to be the first non-defining declaration of N if N has both a defining declaration and a first non-defining declaration and the defining declaration is different than the first non-defining declaration.

If no ancestor of the requisite type of subtypes is found then this function returns a null pointer.

If astNode is the null pointer, then the return value is a null pointer. That is, if there is no node, then there cannot be an enclosing node of the specified type.

Definition at line 1570 of file sageInterface.h.

References SgNode::class_name(), SgDeclarationStatement::get_definingDeclaration(), SgNode::get_file_info(), SgDeclarationStatement::get_firstNondefiningDeclaration(), and SgNode::get_parent().

getEnclosingFunctionDefinition()

ROSE_DLL_API SgFunctionDefinition * SageInterface::getEnclosingFunctionDefinition	(	SgNode *	astNode,
		const bool	includingSelf = false
	)

Find a node by type using upward traversal.

Traverse backward through a specified node's ancestors, starting with the node's parent and progressing to more distant ancestors, to find the first node matching the specified or derived type. If includingSelf is true then the starting node, astNode, is returned if its type matches, otherwise the search starts at the parent of astNode.

For the purposes of this function, the parent (P) of an SgDeclarationStatement node (N) is considered to be the first non-defining declaration of N if N has both a defining declaration and a first non-defining declaration and the defining declaration is different than the first non-defining declaration.

If no ancestor of the requisite type of subtypes is found then this function returns a null pointer.

If astNode is the null pointer, then the return value is a null pointer. That is, if there is no node, then there cannot be an enclosing node of the specified type.

isInSubTree()

ROSE_DLL_API bool SageInterface::isInSubTree	(	SgExpression *	subtree,
		SgExpression *	exp
	)

Find a node by type using upward traversal.

Traverse backward through a specified node's ancestors, starting with the node's parent and progressing to more distant ancestors, to find the first node matching the specified or derived type. If includingSelf is true then the starting node, astNode, is returned if its type matches, otherwise the search starts at the parent of astNode.

For the purposes of this function, the parent (P) of an SgDeclarationStatement node (N) is considered to be the first non-defining declaration of N if N has both a defining declaration and a first non-defining declaration and the defining declaration is different than the first non-defining declaration.

If no ancestor of the requisite type of subtypes is found then this function returns a null pointer.

If astNode is the null pointer, then the return value is a null pointer. That is, if there is no node, then there cannot be an enclosing node of the specified type.

getFunctionDeclaration()

ROSE_DLL_API SgFunctionDeclaration * SageInterface::getFunctionDeclaration

(

SgFunctionCallExp *

functionCallExp

)

Find a node by type using upward traversal.

Traverse backward through a specified node's ancestors, starting with the node's parent and progressing to more distant ancestors, to find the first node matching the specified or derived type. If includingSelf is true then the starting node, astNode, is returned if its type matches, otherwise the search starts at the parent of astNode.

For the purposes of this function, the parent (P) of an SgDeclarationStatement node (N) is considered to be the first non-defining declaration of N if N has both a defining declaration and a first non-defining declaration and the defining declaration is different than the first non-defining declaration.

If no ancestor of the requisite type of subtypes is found then this function returns a null pointer.

If astNode is the null pointer, then the return value is a null pointer. That is, if there is no node, then there cannot be an enclosing node of the specified type.

isDataMemberReference()

ROSE_DLL_API bool SageInterface::isDataMemberReference

(

SgVarRefExp *

varRefExp

)

Find a node by type using upward traversal.

Traverse backward through a specified node's ancestors, starting with the node's parent and progressing to more distant ancestors, to find the first node matching the specified or derived type. If includingSelf is true then the starting node, astNode, is returned if its type matches, otherwise the search starts at the parent of astNode.

For the purposes of this function, the parent (P) of an SgDeclarationStatement node (N) is considered to be the first non-defining declaration of N if N has both a defining declaration and a first non-defining declaration and the defining declaration is different than the first non-defining declaration.

If no ancestor of the requisite type of subtypes is found then this function returns a null pointer.

If astNode is the null pointer, then the return value is a null pointer. That is, if there is no node, then there cannot be an enclosing node of the specified type.

isAddressTaken()

ROSE_DLL_API bool SageInterface::isAddressTaken

(

SgExpression *

refExp

)

Find a node by type using upward traversal.

Traverse backward through a specified node's ancestors, starting with the node's parent and progressing to more distant ancestors, to find the first node matching the specified or derived type. If includingSelf is true then the starting node, astNode, is returned if its type matches, otherwise the search starts at the parent of astNode.

For the purposes of this function, the parent (P) of an SgDeclarationStatement node (N) is considered to be the first non-defining declaration of N if N has both a defining declaration and a first non-defining declaration and the defining declaration is different than the first non-defining declaration.

If no ancestor of the requisite type of subtypes is found then this function returns a null pointer.

If astNode is the null pointer, then the return value is a null pointer. That is, if there is no node, then there cannot be an enclosing node of the specified type.

isMemberFunctionMemberReference()

ROSE_DLL_API bool SageInterface::isMemberFunctionMemberReference

(

SgMemberFunctionRefExp *

memberFunctionRefExp

)

Find a node by type using upward traversal.

Traverse backward through a specified node's ancestors, starting with the node's parent and progressing to more distant ancestors, to find the first node matching the specified or derived type. If includingSelf is true then the starting node, astNode, is returned if its type matches, otherwise the search starts at the parent of astNode.

For the purposes of this function, the parent (P) of an SgDeclarationStatement node (N) is considered to be the first non-defining declaration of N if N has both a defining declaration and a first non-defining declaration and the defining declaration is different than the first non-defining declaration.

If no ancestor of the requisite type of subtypes is found then this function returns a null pointer.

If astNode is the null pointer, then the return value is a null pointer. That is, if there is no node, then there cannot be an enclosing node of the specified type.

getClassTypeChainForMemberReference()

ROSE_DLL_API std::list< SgClassType * > SageInterface::getClassTypeChainForMemberReference

(

SgExpression *

refExp

)

Find a node by type using upward traversal.

Traverse backward through a specified node's ancestors, starting with the node's parent and progressing to more distant ancestors, to find the first node matching the specified or derived type. If includingSelf is true then the starting node, astNode, is returned if its type matches, otherwise the search starts at the parent of astNode.

For the purposes of this function, the parent (P) of an SgDeclarationStatement node (N) is considered to be the first non-defining declaration of N if N has both a defining declaration and a first non-defining declaration and the defining declaration is different than the first non-defining declaration.

If no ancestor of the requisite type of subtypes is found then this function returns a null pointer.

If astNode is the null pointer, then the return value is a null pointer. That is, if there is no node, then there cannot be an enclosing node of the specified type.

getFrontendSpecificNodes()

ROSE_DLL_API std::set< SgNode * > SageInterface::getFrontendSpecificNodes

(

)

Find a node by type using upward traversal.

Traverse backward through a specified node's ancestors, starting with the node's parent and progressing to more distant ancestors, to find the first node matching the specified or derived type. If includingSelf is true then the starting node, astNode, is returned if its type matches, otherwise the search starts at the parent of astNode.

For the purposes of this function, the parent (P) of an SgDeclarationStatement node (N) is considered to be the first non-defining declaration of N if N has both a defining declaration and a first non-defining declaration and the defining declaration is different than the first non-defining declaration.

If no ancestor of the requisite type of subtypes is found then this function returns a null pointer.

If astNode is the null pointer, then the return value is a null pointer. That is, if there is no node, then there cannot be an enclosing node of the specified type.

outputSharedNodes()

ROSE_DLL_API void SageInterface::outputSharedNodes

(

SgNode *

node

)

Find a node by type using upward traversal.

Traverse backward through a specified node's ancestors, starting with the node's parent and progressing to more distant ancestors, to find the first node matching the specified or derived type. If includingSelf is true then the starting node, astNode, is returned if its type matches, otherwise the search starts at the parent of astNode.

For the purposes of this function, the parent (P) of an SgDeclarationStatement node (N) is considered to be the first non-defining declaration of N if N has both a defining declaration and a first non-defining declaration and the defining declaration is different than the first non-defining declaration.

If no ancestor of the requisite type of subtypes is found then this function returns a null pointer.

If astNode is the null pointer, then the return value is a null pointer. That is, if there is no node, then there cannot be an enclosing node of the specified type.

displayScope()

ROSE_DLL_API void SageInterface::displayScope

(

SgScopeStatement *

scope

)

Find a node by type using upward traversal.

Traverse backward through a specified node's ancestors, starting with the node's parent and progressing to more distant ancestors, to find the first node matching the specified or derived type. If includingSelf is true then the starting node, astNode, is returned if its type matches, otherwise the search starts at the parent of astNode.

For the purposes of this function, the parent (P) of an SgDeclarationStatement node (N) is considered to be the first non-defining declaration of N if N has both a defining declaration and a first non-defining declaration and the defining declaration is different than the first non-defining declaration.

If no ancestor of the requisite type of subtypes is found then this function returns a null pointer.

If astNode is the null pointer, then the return value is a null pointer. That is, if there is no node, then there cannot be an enclosing node of the specified type.

isSameFunction()

ROSE_DLL_API bool SageInterface::isSameFunction	(	SgFunctionDeclaration *	func1,
		SgFunctionDeclaration *	func2
	)

Check if two function declarations refer to the same one. Two function declarations are the same when they are a) identical, b) same name in C c) same qualified named and mangled name in C++. A nondefining (prototype) declaration and a defining declaration of a same function are treated as the same.

There is a similar function bool compareFunctionDeclarations(SgFunctionDeclaration *f1, SgFunctionDeclaration *f2) from Classhierarchy.C

hasSimpleChildrenList()

ROSE_DLL_API bool SageInterface::hasSimpleChildrenList

(

SgScopeStatement *

scope

)

Check if a scope statement has a simple children statement list so insert additional statements under the scope is straightforward and unambiguous .

for example, SgBasicBlock has a simple statement list while IfStmt does not.

statementCanBeTransformed()

ROSE_DLL_API bool SageInterface::statementCanBeTransformed

(

SgStatement *

stmt

)

If header file unparsing and token-based unparsing are used, then some statements in header files used with the same name and different include syntax can't be transformed.

This is currently because there is no way to generally test the resulting transformed code generated by ROSE.

createTempVariableForExpression()

std::pair< SgVariableDeclaration *, SgExpression * > SageInterface::createTempVariableForExpression	(	SgExpression *	expression,
		SgScopeStatement *	scope,
		bool	initializeInDeclaration,
		SgAssignOp **	reEvaluate = NULL
	)

Given an expression, generates a temporary variable whose initializer optionally evaluates that expression.

Then, the var reference expression returned can be used instead of the original expression. The temporary variable created can be reassigned to the expression by the returned SgAssignOp; this can be used when the expression the variable represents needs to be evaluated. NOTE: This handles reference types correctly by using pointer types for the temporary.

Parameters

expression	Expression which will be replaced by a variable
scope	scope in which the temporary variable will be generated
reEvaluate	an assignment op to reevaluate the expression. Leave NULL if not needed

Returns

declaration of the temporary variable, and a a variable reference expression to use instead of the original expression.

appendArg()

ROSE_DLL_API SgVariableSymbol * SageInterface::appendArg	(	SgFunctionParameterList *	,
		SgInitializedName *
	)

Append an argument to SgFunctionParameterList, transparently set parent,scope, and symbols for arguments when possible.

We recommend to build SgFunctionParameterList before building a function declaration However, it is still allowed to append new arguments for existing function declarations.

setParameterList()

template<class actualFunction >

void SageInterface::setParameterList	(	actualFunction *	func,
		SgFunctionParameterList *	paralist
	)

Set parameter list for a function declaration, considering existing parameter list etc.

Definition at line 2196 of file sageInterface.h.

References SgFunctionParameterList::get_args(), SgNode::get_parent(), is_Ada_language(), and SgNode::set_parent().

replaceSubexpressionWithStatement()

ROSE_DLL_API void SageInterface::replaceSubexpressionWithStatement	(	SgExpression *	from,
		SageInterface::StatementGenerator *	to
	)

Similar to replaceExpressionWithStatement, but with more restrictions.

Assumptions: from is not within the test of a loop or ifStmt, not currently traversing from or the statement it is in

fixVariableReferences()

ROSE_DLL_API int SageInterface::fixVariableReferences	(	SgNode *	root,
		bool	cleanUnusedSymbol = true
	)

Connect variable reference to the right variable symbols when feasible, return the number of references being fixed.

In AST translation, it is possible to build a variable reference before the variable is being declared. buildVarRefExp() will use fake initialized name and symbol as placeholders to get the work done. Users should call fixVariableReference() when AST is complete and all variable declarations are in place.

fixVariableDeclaration()

ROSE_DLL_API void SageInterface::fixVariableDeclaration	(	SgVariableDeclaration *	varDecl,
		SgScopeStatement *	scope
	)

Patch up symbol, scope, and parent information when a SgVariableDeclaration's scope is known.

It is possible to build a variable declaration without knowing its scope information during bottom-up construction of AST, though top-down construction is recommended in general. In this case, we have to patch up symbol table, scope and parent information when the scope is known. This function is usually used internally within appendStatment(), insertStatement().

reportModifiedStatements()

ROSE_DLL_API void SageInterface::reportModifiedStatements	(	const std::string &	label,
		SgNode *	node
	)

Connect variable reference to the right variable symbols when feasible, return the number of references being fixed.

In AST translation, it is possible to build a variable reference before the variable is being declared. buildVarRefExp() will use fake initialized name and symbol as placeholders to get the work done. Users should call fixVariableReference() when AST is complete and all variable declarations are in place.

reportModifiedLocatedNodes()

ROSE_DLL_API void SageInterface::reportModifiedLocatedNodes	(	const std::string &	label,
		SgNode *	node
	)

Connect variable reference to the right variable symbols when feasible, return the number of references being fixed.

In AST translation, it is possible to build a variable reference before the variable is being declared. buildVarRefExp() will use fake initialized name and symbol as placeholders to get the work done. Users should call fixVariableReference() when AST is complete and all variable declarations are in place.

translateToUseCppDeclarations()

ROSE_DLL_API void SageInterface::translateToUseCppDeclarations

(

SgNode *

n

)

Connect variable reference to the right variable symbols when feasible, return the number of references being fixed.

In AST translation, it is possible to build a variable reference before the variable is being declared. buildVarRefExp() will use fake initialized name and symbol as placeholders to get the work done. Users should call fixVariableReference() when AST is complete and all variable declarations are in place.

translateScopeToUseCppDeclarations()

ROSE_DLL_API void SageInterface::translateScopeToUseCppDeclarations

(

SgScopeStatement *

scope

)

Connect variable reference to the right variable symbols when feasible, return the number of references being fixed.

In AST translation, it is possible to build a variable reference before the variable is being declared. buildVarRefExp() will use fake initialized name and symbol as placeholders to get the work done. Users should call fixVariableReference() when AST is complete and all variable declarations are in place.

translateStatementToUseCppDeclarations()

ROSE_DLL_API std::vector< SgC_PreprocessorDirectiveStatement * > SageInterface::translateStatementToUseCppDeclarations	(	SgStatement *	statement,
		SgScopeStatement *	scope
	)

Connect variable reference to the right variable symbols when feasible, return the number of references being fixed.

In AST translation, it is possible to build a variable reference before the variable is being declared. buildVarRefExp() will use fake initialized name and symbol as placeholders to get the work done. Users should call fixVariableReference() when AST is complete and all variable declarations are in place.

printOutComments()

ROSE_DLL_API void SageInterface::printOutComments

(

SgLocatedNode *

locatedNode

)

Connect variable reference to the right variable symbols when feasible, return the number of references being fixed.

In AST translation, it is possible to build a variable reference before the variable is being declared. buildVarRefExp() will use fake initialized name and symbol as placeholders to get the work done. Users should call fixVariableReference() when AST is complete and all variable declarations are in place.

skipTranslateToUseCppDeclaration()

ROSE_DLL_API bool SageInterface::skipTranslateToUseCppDeclaration

(

PreprocessingInfo *

currentPreprocessingInfo

)

Connect variable reference to the right variable symbols when feasible, return the number of references being fixed.

In AST translation, it is possible to build a variable reference before the variable is being declared. buildVarRefExp() will use fake initialized name and symbol as placeholders to get the work done. Users should call fixVariableReference() when AST is complete and all variable declarations are in place.

outputFileIds()

ROSE_DLL_API void SageInterface::outputFileIds

(

SgNode *

node

)

Connect variable reference to the right variable symbols when feasible, return the number of references being fixed.

In AST translation, it is possible to build a variable reference before the variable is being declared. buildVarRefExp() will use fake initialized name and symbol as placeholders to get the work done. Users should call fixVariableReference() when AST is complete and all variable declarations are in place.

updateDefiningNondefiningLinks()

ROSE_DLL_API void SageInterface::updateDefiningNondefiningLinks	(	SgFunctionDeclaration *	func,
		SgScopeStatement *	scope
	)

Update defining and nondefining links due to a newly introduced function declaration. Should be used after inserting the function into a scope.

This function not only set the defining and nondefining links of the newly introduced function declaration inside a scope, but also update other same function declarations' links accordingly if there are any. Assumption: The function has already inserted/appended/prepended into the scope before calling this function.

constantFolding()

ROSE_DLL_API void SageInterface::constantFolding

(

SgNode *

r

)

Constant folding an AST subtree rooted at 'r' (replacing its children with their constant values, if applicable). Please be advised that constant folding on floating point computation may decrease the accuracy of floating point computations!

It is a wrapper function for ConstantFolding::constantFoldingOptimization(). Note that only r's children are replaced with their corresponding constant values, not the input SgNode r itself. You have to call this upon an expression's parent node if you want to fold the expression.

instrumentEndOfFunction()

ROSE_DLL_API int SageInterface::instrumentEndOfFunction	(	SgFunctionDeclaration *	func,
		SgStatement *	s
	)

Instrument(Add a statement, often a function call) into a function right before the return points, handle multiple return statements (with duplicated statement s) and return expressions with side effects. Return the number of statements inserted.

Useful when adding a runtime library call to terminate the runtime system right before the end of a program, especially for OpenMP and UPC runtime systems. Return with complex expressions with side effects are rewritten using an additional assignment statement.

mergeDeclarationAndAssignment()

ROSE_DLL_API bool SageInterface::mergeDeclarationAndAssignment	(	SgVariableDeclaration *	decl,
		SgExprStatement *	assign_stmt,
		bool	removeAssignStmt = true
	)

Merge a variable assignment statement into a matching variable declaration statement. Callers should make sure the merge is semantically correct (by not introducing compilation errors). This function simply does the merge transformation, without eligibility check.

e.g. int i; i=10; becomes int i=10; the original i=10 will be deleted after the merge if success, return true, otherwise return false (e.g. variable declaration does not match or already has an initializer) The original assignment stmt will be removed by default This function is a bit ambiguous about the merge direction, to be phased out.

mergeDeclarationWithAssignment()

ROSE_DLL_API bool SageInterface::mergeDeclarationWithAssignment	(	SgVariableDeclaration *	decl,
		SgExprStatement *	assign_stmt
	)

Merge a declaration statement into a matching followed variable assignment. Callers should make sure the merge is semantically correct (by not introducing compilation errors). This function simply does the merge transformation, without eligibility check.

e.g. int i; i=10; becomes int i=10; the original int i; will be deleted after the merge

splitVariableDeclaration()

ROSE_DLL_API SgExprStatement * SageInterface::splitVariableDeclaration

(

SgVariableDeclaration *

decl

)

Split a variable declaration with an rhs assignment into two statements: a declaration and an assignment.

Return the generated assignment statement, if any e.g. int i =10; becomes int i; i=10; This can be seen as a normalization of declarations

splitExpression()

ROSE_DLL_API SgAssignInitializer * SageInterface::splitExpression	(	SgExpression *	from,
		std::string	newName = ""
	)

Replace an expression with a temporary variable and an assignment statement.

Add a new temporary variable to contain the value of 'from'. Change reference to 'from' to use this new variable. Assumptions: (1)'from' is not within the test of a loop or 'if'; (2)not currently traversing 'from' or the statement it is in. Return value: the new temp variable declaration's assign initializer containing the from expression.

getIntegerConstantValue()

unsigned long long SageInterface::getIntegerConstantValue

(

SgValueExp *

expr

)

Get the constant value from a constant integer expression; abort on everything else.

Note that signed long longs are converted to unsigned.

wrapFunction() [1/2]

std::pair< SgStatement *, SgInitializedName * > SageInterface::wrapFunction	(	SgFunctionDeclaration &	definingDeclaration,
		SgName	newName
	)

moves the body of a function f to a new function f; f's body is replaced with code that forwards the call to f.

Returns

a pair indicating the statement containing the call of f and an initialized name refering to the temporary variable holding the result of f. In case f returns void the initialized name is NULL.

Parameters

definingDeclaration

the defining function declaration of f

newName

the name of function f \details f's new body becomes { f(...); } and { int res = f<tt>(...); return res; } for functions returning void and a value, respectively. two function declarations are inserted in f's enclosing scope \code result_type f(...); <— (1) result_type f (...) { forward call to f} result_type f(...) { original code } <— (2) Calls to f are not updated, thus in the transformed code all calls will continue calling f (this is also true for recursive function calls from within the body of f). After the function has created the wrapper, definingDeclaration becomes the wrapper function The definition of f is the next entry in the statement list; the forward declaration of f` is the previous entry in the statement list.

Precondition

definingDeclaration must be a defining declaration of a free standing function. typeid(SgFunctionDeclaration) == typeid(definingDeclaration) i.e., this function is NOT implemented for class member functions, template functions, procedures, etc.

Referenced by wrapFunction().

wrapFunction() [2/2]

template<class NameGen >

std::pair< SgStatement *, SgInitializedName * > SageInterface::wrapFunction	(	SgFunctionDeclaration &	definingDeclaration,
		NameGen	nameGen
	)

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

Template Parameters

NameGen

functor that generates a new name based on the old name. interface: SgName nameGen(const SgName&)

Parameters

nameGen

name generator

see wrapFunction for details

Definition at line 2657 of file sageInterface.h.

References wrapFunction().

isTemplateInstantiationFromTemplateDeclarationSatisfyingFilter()

template<class T >

bool SageInterface::isTemplateInstantiationFromTemplateDeclarationSatisfyingFilter	(	SgFunctionDeclaration *	function,
		T *	filter
	)

This function detects template instantiations that are relevant when filters are used.

EDG normalizes some in-class template functions and member functions to be redefined outside of a class. this causes the associated template instantiations to be declared outside of the class, and to be marked as compiler generated (since the compiler generated form outside of the class declaration). ROSE captures the function definitions, but in the new location (defined outside of the class declaration). This can confuse some simple tests for template instantiations that are a part of definitions in a file, thus we have this function to detect this specific normalization.

Definition at line 2996 of file sageInterface.h.

References SgFunctionDeclaration::class_name(), SgDeclarationStatement::get_firstNondefiningDeclaration(), SgTemplateInstantiationMemberFunctionDecl::get_templateDeclaration(), and SgTemplateInstantiationFunctionDecl::get_templateDeclaration().