Sg_File_Info
This class represents the location of the code associated with the IR node in the
Synopsis
Declared in <src/frontend/SageIII/Cxx_Grammar.h>
class Sg_File_Info
: public SgSupportBase Classes
Name |
Description |
This class represents the base class of a numbr of IR nodes that don't otherwise fit |
Friends
Name |
Description |
|
Casts pointer from base class to derived class (for const pointers) |
|
Casts pointer from base class to derived class |
|
|
|
|
|
|
|
|
|
|
|
Non-Member Functions
Name |
Description |
This does all post‐processing fixup and translation of the Sage III AST. |
|
Fixups transformations that have added template instantiations or caused template instantiations to be output so that there is a proper prototype declaration before the template instantation is called. |
|
Change all members in a program to be public. There should really be a smarter procedure for this that only changes members used by inlined code. |
|
Checks whether appropriate nodes of an AST are marked as compiler‐generated. |
|
Checks whether appropriate nodes of an AST are marked as front‐end specific. |
|
Checks whether the physical source position information is consistant in the Sg_File_Info object |
|
Check for consistancy of isTransformation flags for nodes marked as a transformation. |
|
Combined procedure for cleaning up code after inlining. Does not do variable renaming or block flattening, however. |
|
Detect nodes marked as transformations (should not be present coming out of the frontend translation). |
|
Traverse the AST |
|
Find all variables referenced in a region |
|
Workaround for ROSE bug. Should be used whenever expressions in a program are modified. |
|
Fixup all SgDeclarationStatement to have a consistant scope (between the defining and all non‐defining declarations). |
|
Fixup all SgDeclarationStatement references to defining and non‐defining declarations. |
|
Fixup global and local symbol tables. |
|
Fixup C++ symbol tables to use aliasing symbols for using declarations. |
|
Fixup definingDeclaration and firstNondefiningDeclaration pointers in SgDeclarationStatement. |
|
Checks and fixes up inconsistanties in the settings of Sg_File_Info flags (e.g. isTransformation flag) in the Sg_File_Info object |
|
Fixup Fortran array vs. function references. |
|
Fixup Fortran Use declarations. |
|
Fixup specific pointers in the AST that we would like to not have be NULL. |
|
Fixup known macros that reference themselves and cause recursive macro expansion in the generated (unparsed) code. |
|
Fixup the storage access of all compiler‐generated forward declarations (non‐defining declarations) to match that of the defining declaration. |
|
Fixups template specializations generated by ROSE from template instantiations. |
|
Flatten nested blocks of code in a program. This code requires that variable names in the region being processed are already distinct, and it may extend variable lifetimes to the end of the outer block of code. |
|
Get the statement of an expression. Somewhat smarter than the standard version of this routine, but needs to be merged. |
|
Initialize explicit scopes (support function should not be called). |
|
Initialize explicit scopes (located only at specific IR nodes). |
|
Insert Fortran "CONTAINS" statement. |
|
Internal routine to check whether a given variable declaration is a member variable. |
|
Casts pointer from base class to derived class (for const pointers) |
|
Casts pointer from base class to derived class |
|
Casts pointer from base class to derived class (for const pointers) |
|
Casts pointer from base class to derived class |
|
Casts pointer from base class to derived class |
|
Casts pointer from base class to derived class (for const pointers) |
|
Mark an AST subtree as compiler generated (used for instatiated templates generated by ROSE as specializations). |
|
Mark an backend specific functions as compiler generated. |
|
Mark an AST subtree as compiler generated and to be output in the source file (code generation phase). |
|
Mark relavant expressions as l‐values explicitly. |
|
Mark any template instatiations that are overloaded (we can't output these since g++ can't resolve them). |
|
Mark an AST subtree to be unparsed using an alternative file (for multi‐file unparsing). |
|
Fixups template instantiations generated by ROSE from template declarations. |
|
Fixups transformations (which are often marked at a high level and need to be marked properly through their subtree). |
|
Move variables declared in a for statement to just outside that statement. |
|
Postprocessing that is not likely to be handled in the legacy frontend/Sage III translation. |
|
Fixup template instantiations to unmark them for output followingsemantics of gnu template options |
|
Propagate hidden list information for variables, types, and class elaboration. |
|
Change all variable and label references to point to new symbols, created to point to the matching declaration found in the program. This needs to be moved into somewhere in FixSgTree. |
|
Remove all null statements (those with only an integer constant or a null expression) |
|
Remove unused variables in a scope |
|
Rename all labels in a block of code. |
|
Rename all variables in a block of code, and ensure that all variable references point to the correct declarations. |
|
Replace a child of a node. |
|
This function acts in two different ways |
|
Interface function to reset parent pointers. |
|
This traversal calles ResetParentPointersInMemoryPool Memory Pool traversal. |
|
This is a top level function not called recursively. |
|
Sets names of template classes (calls custom traversal). |
|
In code with declarations such as "int foo = bar", where foo and bar are not modified, replace "foo" with "bar" and remove the declaration |
|
Do a simple form of finite differencing on all functions contained within root (which should be a project, file, or function definition). |
|
This is a top level function not called recursively. |
|
Create a deep‐copy of an SgNode |
|
Returns 'true' if this node is contained in a C99‐only project. |
|
Returns a newly allocated file info object for transformation nodes. |
|
Reset source position as transformation for the current node only |
|
|
Reset source position as transformation recursively |
**** The function Result querySubTree ( SgNode * subTree, _Result (__x)(SgNode_,_Arg), Arg x_arg, AstQueryNamespace::QueryDepth defineQueryType =AstQueryNamespace::AllNodes ) will query the subtree of the IR node in the first argument for nodessatisfying the criteria specified in and returned by the function pointer inthe second argument.** |
|
** The function Result querySubTree ( SgNode * subTree, _Result (__x)(SgNode_), AstQueryNamespace::QueryDepth defineQueryType =AstQueryNamespace::AllNodes )* will query the subtree of the IR node in the first argument for nodessatisfying the criteria specified in and returned by the function pointer inthe second argument.** |
|
**** The function std::list<ListElement> querySubTree<ListElement>(SgNode* node,Predicate& _pred) will query the subtree of the IR node in the first argumentfor nodes satisfying the criteria specified in and returned by the predicatein the second argument.** |
|
Collect non‐local variables that are read and written within the given ast. This is a wrapper of the ComputeAstSideEffects function to provide a more convenient user interface. Returns true if the returned variables are guaranteed to be complete; returns false otherwise. |
|
Returns the collection of memory references modified, read, and invoked (as function calls) as potential side effects of running the given ast, inside the given scope. |
|
Extracts the '#if' directive structure from a project. |
|
Checks if the functionDeclaration (node) matches functionType |
|
This is the external interface of constant folding: |
|
**** |
|
**** |
|
**** |
|
**** |
|
** The function NodeQuerySynthesizedAttributeType queryMemoryPool ( SgNode * subTree, Result (*x)(SgNode*,_Arg), Arg x_arg, VariantVector ){ will on every node of the memory pool which has a corresponding variant inVariantVector performa the action specified by the second argument and returna NodeQuerySynthesizedAttributeType.* |
|
** The function Result queryMemoryPool ( SgNode * subTree, SgNode, TypeOfQueryTypeTwoParameters, VariantVector* ){ will on every node of the memory pool which has a corresponding variant inVariantVector performa the predefined action specified by the second argumentand return a NodeQuerySynthesizedAttributeType.** |
|
** The function Result queryMemoryPool ( SgNode * subTree, _Result (__x)(SgNode_), VariantVector* ){ will on every node of the memory pool which has a corresponding variant inVariantVector performa the action specified by the second argument and returna NodeQuerySynthesizedAttributeType.** |
|
**** |
|
**** |
|
**** |
|
The function querySubTree (SgNode * subTree, VariantVector targetVariantVector, AstQueryNamespace::QueryDepth defineQueryType =AstQueryNamespace::AllNodes); reutnrs a list of all SgNodes us the ASTsub‐tree of the variable 'subTree' conforming to the variants inVariantVector.***** |
|
**** |
|
**** |
|
**** |
|
**** |
|
**** |
|
**** |
|
**** |
|
A helper function to generate implicit or explicit task for either omp parallel or omp task |
|
Find an enclosing parallel region or function definition's body |
|
Replace references to oldVar within root with references to newVar, return the number of references replaced. |
|
Replace variable references within root based on a map from old symbols to new symbols |
|
Replace all variable references in a set by pointers to the variable |
|
Translate omp atomic |
|
Translate omp barrier |
|
Translate omp critical |
|
Translate omp flush |
|
Translate omp for or omp do loops |
|
Translate omp master |
|
Translate omp metadirective |
|
Translate the ordered directive (not the ordered clause) |
|
Translate omp parallel |
|
Translate omp sections |
|
Translate omp simd |
|
Translate omp single |
|
Translate "omp target" |
|
Translate "omp target data" |
|
Translate omp for or omp do loops affected by the "omp target" directive, using naive 1‐to‐1 mapping Liao 1/28/2013 |
|
Translate omp for or omp do loops affected by the "omp target" directive, using a round robin‐scheduler Liao 7/10/2014 |
|
Translate omp parallel under "omp target" |
|
Translate omp task |
|
Translate omp taskwait |
|
Translate omp threadprivate |
|
Translate omp tile |
|
Translate omp unroll |
|
Helper Function to process Left Hand Side of an Expression |
|
Helper Function to process Right Hand Side of an Expression |
|
Error checking the inserted snippet AST. |
|
Sharing IR nodes requires that the file id be added to the fileIDsToUnparse held in the Sg_File_Info object. |
|
Add a string to be unparsed to support code generation for back‐end specific tools or compilers. |
|
Find all SgPntrArrRefExp under astNode, then add SgVarRefExp (if any) of SgPntrArrRefExp's dim_info into NodeList_t |
|
Compute the intersection set for two ASTs. |
|
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. |
|
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. |
|
This collects the SgLocatedNodes that are marked as modified (a flag automatically set by all set_* generated functions) (useful in debugging). |
|
This collects the statements that are marked as modified (a flag automatically set by all set_* generated functions) (useful in debugging). |
|
This collects the statements that are marked as transformed (useful in debugging). |
|
Traversal to set the global map of names to node and node to names.collisions to support generateUniqueNameForUseAsIdentifier() function. |
|
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. |
|
|
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. |
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. |
|
Deep copy an arbitrary subtree |
|
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() |
|
|
Special purpose function for deleting AST expression tress containing valid original expression trees in constant folded expressions (for internal use only). |
Dump information about a SgNode for debugging |
|
Topdown traverse a subtree from root to find the first declaration given its name, scope (optional, can be NULL), and defining or nondefining flag. |
|
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>. |
|
top‐down traversal from current node to find the main() function declaration |
|
Find unused labels which are not targets of any goto statements |
|
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. |
|
Generate unique name from C and C++ constructs. The name may contain space. |
|
Get the enclosing type of this associated node, not used other than in ./src/backend/unparser/nameQualificationSupport.C |
|
Get the right bool type according to C or C++ language input |
|
Get the closest class declaration enclosing the specified AST node, |
|
Get the closest class definition enclosing the specified AST node, |
|
Get the enclosing SgExprListExp (used as part of function argument index evaluation in subexpressions). |
|
get the SgFile node from current node |
|
Find the enclosing function declaration, including its derived instances like isSgProcedureHeaderStatement, isSgProgramHeaderStatement, and isSgMemberFunctionDeclaration. |
|
Get the closest module statement enclosing the specified AST node, |
|
Find a node by type using upward traversal. |
|
Find the function definition |
|
Get the enclosing scope from a node n |
|
Find enclosing source file node |
|
Find the closest enclosing statement, including the given node |
|
Traverse back through a node's parents to find the enclosing global scope |
|
Return the loop index variable for a for loop |
|
Get the closest scope from astNode. Return astNode if it is already a scope. |
|
Get the enclosing TemplateDeclaration statement |
|
Generate a useful name to describe the SgNode |
|
Generate a useful name to describe the SgSupport IR node |
|
check if node1 is a strict ancestor of node 2. (a node is not considered its own ancestor) |
|
Check if a SgNode _s is an assignment statement (any of =,+=,‐=,&=,/=, ˆ=, etc) |
|
Check if a for‐loop has a canonical form, return loop index, bounds, step, and body if requested |
|
Check if a SgNode is a main() function declaration |
|
Check if a node is SgOmp*Statement |
|
Check if a SgNode is a declaration for a structure |
|
Check if a SgNode is a declaration for a union |
|
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. |
|
Output the local symbol tables. |
|
Pretty print AST horizontally, output to std output. |
|
Pretty print AST horizontally, output to a specified file, a simpiler interface than printAST2TextFile() |
|
Pretty print AST horizontally, output to a specified text file. If printType is set to false, don't print out type info. |
|
Pretty print AST horizontally, output to a specified text file. If printType is set to false, don't print out types info. |
|
Query a subtree to get all nodes of a given type, with an appropriate downcast. |
|
Recursively print current and parent nodes. used within gdb to probe the context of a node. |
|
Set original expression trees to NULL for SgValueExp or SgCastExp expressions, so you can change the value and have it unparsed correctly. |
|
Remove consecutive labels |
|
Remove jumps whose label is immediately after the jump. Used to clean up inlined code fragments. |
|
Remove labeled goto statements |
|
Remove labels which are not targets of any goto statements: its child statement is also removed by default. |
|
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. |
|
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. |
|
we have two serialize() functions, one for a single node, the other for a list of pointers |
|
Set the lower bound of a loop header for (i=lb; ...) |
|
Set the stride(step) of a loop 's incremental expression, regardless the expression types (i+=s; i= i+s, etc) |
|
Set the upper bound of a loop header,regardless the condition expression type. for (i=lb; i op up, ...) |
|
Set current node's source position as transformation generated |
|
Set current node's source position as NULL |
|
Set the source code positon for the current (input) node. |
|
DQ (5/1/2012): New function with improved name. |
|
Set the source code positon for the subtree (including the root). |
|
Recursively set source position info(Sg_File_Info) as transformation generated |
|
Diagnostic function for tracing back through the parent list to understand at runtime where in the AST a failure happened. |
|
returns location (consisting of filename, line, column) Abbreviates fileName if too long, max file name length can be set |
|
this function should only be called for a node in the subtree of a SgFunctionDefinition node. For a given 'node' it determines the correspondnig functionDefinition node when searching upwards in the AST for such a SgFunctionDefinition node. It is useful as a simple lookup function from inside the AST subtree of a SgFunctionDefinition. Returns 0 if no SgFunctionDefinition is found (e.g. global scope). |
|
computes for a given node the index number of it from the parent. e.g. node1(node2,node3,node4) : node4 has index 2 (starting at 0) For the root node of an AST (e.g. SgProject) this function returns ‐1. |
|
determines all VarRefExp in the subtree of 'node'. The order in the vector corresponds to the traversal order on the AST. |
|
returns the function declaration statement found for a given function symbol. |
|
returns the declaration statement found for a given variable symbol. |
|
returns the root node representing the AST of the condition of If, While, DoWhile, For, CondOperator, switch. |
|
returns the child of SgExpressionRoot (which is guaranteed to be unique and to exist) |
|
returns the child of SgExprStatement (which is guaranteed to be unique and to exist) |
|
returns the root node representing the AST of the false branch of If, CondOperator. |
|
returns the first child of an arbitrary AST node (throws exception if numChildren==0) |
|
returns the first Statement of SgBasicBlock (throws exception if numChildren==0) |
|
returns the incr/derc‐expr of For. |
|
returns the initializer‐list of For. |
|
return a function‐call's argument list |
|
return a function‐definition's list of formal paramters |
|
returns function name of SgFunctionDefinition, SgFunctionDeclaration, SgFunctionCall. |
|
return a function‐definition's return type |
|
returns the label name of a SgLabelStatement without trailing ":" |
|
returns the last Statement of SgBasicBlock (throws exception if numChildren==0) |
|
return lhs of a binary node (if it is not a binary node it throws an exception) |
|
returns the root node representing the AST of the loop body of While, DoWhile, For. |
|
returns the parent of a node. Essentially a wrapper function of the ROSE get_parent() function, but throws an exception if no parent exists. For SgProject node no exception is thrown if no parent exists because it is the root node of a ROSE AST. |
|
return rhs of a binary node (if it is not a binary node it throws an exception) |
|
returns the root node representing the AST of the true branch of If, CondOperator. |
|
returns the child of a SgUnaryExp (which is guaranteed to be unique and to exist) |
|
checks whether the expression 'node' represents an assignment to an array's element considers all assignment operators and arrays of any size |
|
checks whether the node 'node' is the root node of the AST by using the get_parent function. |
|
is true if 'node' is the root node of the AST representing the condition of If, While, DoWhile, For, switch, CondExp. |
|
is true if 'node' is the root node of the AST representing the condition of If, While, DoWhile, For, switch. |
|
is true if 'node' is the root node of the AST representing If, While, DoWhile, For, switch. |
|
is true if 'node' is the root node of the AST representing If, While, DoWhile, For, switch, CondExp. |
|
determines whether a node is the root node of an AST representing the inc‐expr in a SgForStatement. This function is helpful to deal with this special case in the ROSE AST where an expression does not have a root node which can be easily determined to be a root node of an expression (i.e. here it can be any binary or unary node in constrast to all other expressions in the ROSE AST which are either a SgExprStatement or have a SgExpressionRoot node. |
|
Determines whether a provided function declaration is a forward declaration |
|
checks whether a SgVariableSymbol is representing a function parameter (this does not apply for forward declarations) |
|
checks whether 'elem' is the last child (in traversal order) of node 'parent'. |
|
is true if 'node' is the root node of the AST representing the condition of a Loop construct (While, DoWhile, For). |
|
is true if 'node' is the root node of the AST representing a Loop construct (While, DoWhile, For). |
|
returns true for Expr‐‐ and Expr‐‐, otherwise false; |
|
returns true for ‐‐Expr and ++Expr, otherwise false. |
|
checks whether a SgVariableSymbol is representing a variable in |
|
returns line, column, and unparsed node in one string. |
|
returns a std::pair of line and column number. If no file info exists at this node it returns (‐1,‐1). |
|
returns location (consisting of filename, line, column) and source code of unparsed node in one string. Abbreviates fileName and unparsed source if too long (defaults are 30,20) |
|
returns location (consisting of filename, line, column) |
|
returns a set of SgNode where each node is a break node, but properly excludes all nested loops. |
|
matches C and C++ function calls (also ctor and dtor) |
|
returns a string representing the node (excluding the subtree) |
|
returns the number of children as int (intentionally not as t_size) ensures that the number of children fits into an int, otherwise throws exception. |
|
replaces the ast with root 'node' with the string 's'. The string is attached to the AST and the unparser uses string s instead of unparsing this substree. This function can be used to generate C++ extensions. |
|
computes for a given node at which scope nesting level this node is in its AST |
|
computes for a given node at which scope nesting level this node is in its AST |
|
returns filename+line+column information of AST fragment in format "filename:line:column". Used for generating readable output |
|
returns filename as stored in AST node. Used for generating readable output. |
|
returns filename followed by line:column in one string. Used for generating readable output. |
|
returns filename followed by line, separator, and column in one string. Used for generating readable output. |
|
collects all case labels from the switch it started in (excludes nested switch stmts). This function also works for Duff's device code where 'case' labels can be inside nested loop/if constructs. |
|
returns the default stmt if it exists. Otherwise return 0 and can be used to test whether a default stmt exists in a given switch stmt. This function also works for Duff's device code. code where 'default' labels can be inside nested loop/if constructs. |
|
Creates a long unique variable name for a given node of type SgVariableDeclaration or SgVarRefExp |
|
returns the string representing the condition (removes trailing ';') |
|
Assign Ids and save current File Info. |
|
The first CFG node for a construct (before the construct starts to execute) |
|
The last CFG node for a construct (after the entire construct has finished executing). This node may not actually be reached if, for example, a goto causes a loop to be exited in the middle |
|
Dump the filtered dot graph of a virtual control flow graph starting from SgNode (start) |
|
Dump the full dot graph of a virtual control flow graph starting from SgNode (start) |
|
Dump a CFG with only interesting nodes for a SgNode |
|
Returns CFG node for just before start |
|
* CALL‐BACK FUNCTIONS FOR cfgRWTransaction::transform() ** |
|
/ SgExpression that is that/ assignment (effectively a type cast) or NULL otherwise |
|
finds an ancestor node with a given type |
|
asserts that n has type SageNode |
|
unchecked down cast from SgNode to SageNode |
|
tests pattern for an assert |
|
|
tests pattern SgExprStatement(SgAssignOp(VarRefExp,FunctionCallExp)) and returns pointer to FunctionCallExp otherwise 0. |
tests pattern SgExprStatement(FunctionCallExp) and returns pointer to FunctionCallExp, otherwise 0. |
|
tests several patterns and returns pointer to FunctionCallExp inside that matched pattern, otherwise 0. |
|
|
tests pattern for function call in variable declaration and returns pointer to FunctionCallExp otherwise 0. |
tests pattern SgReturnStmt(FunctionCallExp) and returns pointer to FunctionCallExp, otherwise 0. |
|
tests pattern SgFunctionCall(...) where the name of the function is fprintf with 3 params |
|
tests pattern SgFunctionCall(...) where the name of the function is printf with 2 params |
|
tests pattern SgFunctionCall(...) where the name of the function is scanf with 2 params |
|
|
checks variable declaration with function call, returns variable declaration. Otherwise 0. e.g. int x=f(); |
|
checks variable declaration with function call, returns both in a pair, or a with (0,0). |
Get the function definition containing a given node |
|
Do partial redundancy elimination on all functions within the scope n. |
Description
original source code. This object is used to represent the starting and the ending position of the source code associated with some IR nodes (in other cases the endOfConstruct returnes the same data as the startOfConstruct). Classification of the IR nodes is included in this object and applies to: ‐ SgStatements ‐ SgExpression ‐ SgInitializedName ‐ SgFile (and maybe SgDirectory) ‐ Perhaps also SgTemplateArguments, SgTemplateParameters, SgBaseClass classifications are: ‐ e_transformation The IR node is part of a transformation. The transformation may be assigned to a file, in which case the file id references the file (default is the source file, that reachable from the scope where the transformation is done). ‐ e_compiler_generated The IR node may be part of a compiler generated IR nodes (or subtree, in which case all IR nodes in the subtree are marked as compiler generated). Compiler generated IR nodes include: ‐# implicit casts ‐# instantiated templates (not explicitly specialized) ‐# non‐explicit return statements in main function. ‐# (... complete this list) ‐ e_output_in_code_generation ‐# Used to explicitly makr any compiler generated IR nodes for output (forces template instaiations to be output in the generated source if transformed). ‐ e_shared Marks IR nodes as shared (set by AST merge mechanism). Note that SgTypes and SgSymbols don't have a Sg_File_Info object, but are ALWAYS shared. (multiple classifications can co‐exist). Note that p_filename is correctly initialized in the Sg_File_Info object for a SgGlobal, but the p_line and p_col are set to 0 (zero). All other IR nodes have valid Sg_File_Info objects with correct p_filename and p_line and p_col set to nonzero values. A few IR nodes in the AST will have a default value of their Sg_File_Info nodes with p_filename set to "NULL_FILE" and p_line and p_col set to 0 (zero). These are increasingly rare to find in the AST, but since some IR nodes can't be associated with their source position in the AST they persist. ‐ Internal: A pointer for this object is in the SgNode, but it is only valid for SgLocatedNodes and the SgInitializedName. The get_File_Info() member function (and associated get_startOfConstruct() and get_endOfConstruct() member functions) are implemented in the SgNode, for uniformity, but return NULL for all but the SgLocatedNodes and the SgInitializedName IR nodes. ‐ Todo: isOutputInCodeGeneration() is orthogonal to isCompilerGenerated and isTransformation(). Currently IR nodes that are marked as isTransformation() are output, but these need to be marked as also being isOutputInCodeGeneration() so that orthogonality of the concepts is maintained. ‐ Todo: It is possible to call get_file_info() on a SgFileInfo object and this needs to be fixed because it does not make any sense. This is because get_file_info is defined as a virtual function on SgNode. Not sure this is a great design, but maybe it just needs a local implementation of a private get_file_info() member function so that it can't be called (can be hidden). ‐ Todo: Should there be a simpler way to copy a SgFileInfo object than: "new Sg_File_Info(*fileInfo);" or "fileInfo‐>copy();"; likely not! ‐ Todo: Define the subset of IR nodes which would all have: ‐# Sg_File_Info ‐# AstAttributeMechanism ‐# SgNode (parent pointer) This will make the documentation more intuative. The argument supporting this is that we operate on those IR nodes that correspond to the visual representation of the source code (so we can exclude SgSymbols, and SgTypes). Having the same subset of IR nodes permits a simpler documentation of the API and intuition as to where it applies. A likely subset would be: ‐# SgLocatedNodes ‐# SgFile ‐# SgDirectory (questionable) ‐# SgInitializedName ‐# SgBaseClass ‐# SgTemplateArgument ‐# SgTemplateParameter ‐ Todo: Remove the functions: isCompilerGeneratedNodeToBeUnparsed(), setCompilerGeneratedNodeToBeUnparsed(), and unsetCompilerGeneratedNodeToBeUnparsed() from where they are called. ‐ Todo: Consider putting the endOfConstruct information into the single Sg_File_Info object. Currently the SgLocatedNode stores two Sg_File_Info objects, one for the beginning and the end of each construct. This would save significant space in the AST. Additional information in the Sg_File_Info could be: ‐ offset from starting line number to the end of construct ‐ flag for if end of construct is located in the same file as the start of construct ‐ Todo: Consider using "short int" instead of "int" for the file_id, line, and col (and maybe the classificationBitField) to reduce the size of the data structure. Padding is not a significant issue since data structures are allocated in contiguious memory (except for padding to at least the nearest byte if bit field widths are used. ‐ See also: Example of using a Sg_File_Info object
Data members
#### Sg_File_Info::p_filename This is the filename of the location of the source code for this IR node. Note that the filename of the start of a construct CAN be different from the start of the language construct (#include can be used to do this). The name of the file also the included the full path to the file in the directory structure. The value of this variable is always a valid pointer if the classification is not isTransformed or isCompilerGenerated. If IR node is compiler generated for a transformation then value is set to either "compilerGenerated" or "transformation", but should be considered to be undefined. ‐ Internal: This name is often quite long and likely is a significantly redundent piece of information stored for each IR node (twice, considering a Sg_File_Info object is used for the start and end of each IR node (where it is used, e.g. SgLocatedNodes and the SgInitializedName IR nodes).
#### Sg_File_Info::p_file_id This is a key that maps integers to file names, it prevents redundent storage of filename strings. This is part of a mechanism to reduce the memory requirements of the IR (to support whole program analysis in ROSE). The values are keys to an STL map which relates file ids to file name strings, allowing a more compressed representation of the filename data in the Sg_File_Info object. There are two maps, one for finding the filename string from a file id integer (p_fileidtoname_map), and another for the reverse map (p_nametofileid_map). ‐ Internal: We will in the future limit the range of this value (expect a signed short int: 16 bits, 32K = 32768 files plus negative values for special cases).
#### Sg_File_Info::p_line This is the line number of the location of the source code for this IR node. This information is useful in the heuristics of attaching comments to IR nodes (SgStatement and SgExpression IR nodes). The value of this variable is always greater than or equal to zero. In the case of isCompilerGenerated() == true or isTransformation() == true then value is INT_MAX‐1. This value if define for this case so that all comments will be attached before the associated statement. ‐ Internal: We will in the future limit the range of this value (expect a short int: 20 bits, 1000K = 1,048,576 lines per file).
#### Sg_File_Info::p_col This is the column number of the location of the source code for this IR node. This information is useful in the heuristics of attaching comments to IR nodes (SgStatement and SgExpression IR nodes). The value of this variable is always greater than or equal to zero. If IR node is compiler generated for a transformation then value is set to INT_MAX‐1. ‐ Internal: We will in the future limit the range of this value (expect a short int: 16 bits, 64K = 65536 charaters per line).
#### Sg_File_Info::p_classificationBitField This is mechanism for classification of the IR node. IR nodes use this mechanism to classify themselves as either part of a transformation or compiler generated (other enum values of Sg_File_Info::classifier are not used). ‐ Internal: We will in the future limit the range of this value (expect an unsigned char: 8 bits, 64K = 65536 charaters per line).
#### Sg_File_Info::p_fileIDsToUnparse This set contains a list of all file ids for which the accompanying IR node should be unparsed. This is part of the AST Merge mechanism. This set contains a list of file ids. During unparsing, if we encounter a node with this Sg_File_Info object, we only want to unparse this file if the file we are currently unparsing is in this list. ‐ Internal: NOTE: This set should be empty unless the node is marked as shared
#### std::map< int, std::string > Sg_File_Info::p_fileidtoname_map This is a static STL map of file id (integers) to file names (strings).
#### std::map< std::string, int > Sg_File_Info::p_nametofileid_map This is a static STL map of file names (strings) to file id (integers).
#### int Sg_File_Info::p_max_file_id This current number of unique files in use within ROSE. ‐ Internal: Whey do we need this value? ‐ Todo: Verify that we really need this value.
#### int Sg_File_Info::p_cur_file This is a static variable which used to be used by the unparser. ‐ Internal: This is no longer needed, and not used, I think. ‐ Deprecated: This data member will be removed at some point.
#### int Sg_File_Info::p_cur_line This is a static variable which used to be used by the unparser. ‐ Internal: This is no longer needed, and not used, I think. ‐ Deprecated: This data member will be removed at some point.
#### Sg_File_Info::p_isPartOfTransformation This is a depreicated variable, previously used to indicate if an IR node was part of a transformation. ‐ Internal: This variable is redundant with the information stored in the p_classificationBitField. ‐ Deprecated: This data member will be removed at some point.
Member functions
#### Sg_File_Info::Sg_File_Info() This is the less useful default constructor. This constructor builds the Sg_File_Info base class. ‐ Internal: This constructor should be deprecated since we don't want it to be used. It's presence is historical, since it was previously used a lot (inappropriately). Before it is removed we likely need a constructor that can take a Sg_File_Info::classifier enum value. ‐ See also: Example:create an Sg_File_Info object
#### Sg_File_Info::Sg_File_Info ( const char *filename, int line=0, int col=0 ) This is the more useful constructor. This constructor builds the Sg_File_Info base class. ‐ See also: Example:create an Sg_File_Info object
#### Sg_File_Info::Sg_File_Info(const Sg_File_Info & X) This the copy constructor (deep copy made). ‐ Internal: This constructor does a deep copy of all data in the Sg_File_Info object. ‐ See also: Example:create an Sg_File_Info object
#### Sg_File_Info::~Sg_File_Info() This is the destructor. There is nothing to delete in this object.
#### Sg_File_Info::isSg_File_Info (SgNode *s) Cast function (from derived class to Sg_File_Info pointer). This functions returns a Sg_File_Info pointer for any input of a pointer to an object derived from a Sg_File_Info. ‐ Return: Returns valid pointer to Sg_File_Info if input is derived from a SgLocatedNode.
#### Sg_File_Info::isSg_File_Info (const SgNode *s) Cast function (from derived class to Sg_File_Info pointer). This functions returns a Sg_File_Info pointer for any input of a pointer to an object derived from a Sg_File_Info. ‐ Return: Returns valid pointer to Sg_File_Info if input is derived from a SgLocatedNode.
#### Sg_File_Info::set_line ( int line ) This function sets the line number of the construct's association with source code in the source file named by p_filename. ‐ Return: Returns an integer.
#### Sg_File_Info::set_filename (char* filename) This function sets the filename of the construct's association with source code. ‐ Internal: This function should be updated to take and return a string. Likely we can implement an overloaded function with takes and resturns a string and preserve this function (deprecated) for a period of time. ‐ Return: Returns char* (will return C++ string at some point later)
#### Sg_File_Info::output () Output function, deprecated. ‐ Return: Returns void ‐ Deprecated: This function is replaced by the display(char*) function.
#### Sg_File_Info::set_isPartOfTransformation (bool isPartOfTransformation) This function marks an IR nodes as being part of a transformation, this function is deprecated. ‐ Return: Returns void. ‐ Deprecated: This function is deprecated.
#### Sg_File_Info::get_isPartOfTransformation () This function indicates of the IR nodes is part of a transformation. ‐ Return: Returns bool ‐ Deprecated: This function is deprecated.
#### Sg_File_Info::get_filename () const Returns filename of source code associated with IR node. The filename returned is manipulated under some contitions: ‐ if isTransformation() is true then "transformation" is returned as the filename. ‐ if isCompilerGenerated() is true then "comilerGenerated" is returned as the filename. ‐ if isCompilerGeneratedNodeToBeUnparsed() is true then "comilerGenerated" is returned as the filename. ‐ Internal: For debugging purposes it is an error to ask for the filename from any IR node for which hasPositionInSource() == false. ‐ Return: Returns char* (will return C++ string in the future).
#### Sg_File_Info::get_line () const Returns the line number of the associated code for this IR node. ‐ Return: Returns integer.
#### Sg_File_Info::get_col () const Returns the column number of the associated code for this IR node. ‐ Return: Returns integer
#### Sg_File_Info::get_raw_filename () const Returns filename of source code associated with IR node. The filename is not manipulated! The value of p_filename is returned whatever the IR node classification. ‐ Internal: This is useful for debugging. ‐ Return: Returns a C++ string object.
#### Sg_File_Info::get_raw_line () const Returns the line number of the associated code for this IR node. ‐ Return: Returns integer.
#### Sg_File_Info::get_raw_col () const Returns the column number of the associated code for this IR node. ‐ Return: Returns
#### Sg_File_Info::hasPositionInSource() const No earthly idea what this function does! ‐ Todo: figure out what this does, it appears to be called in two places (attachment of comments and CPP directives (attachPreprocessingInfo.C) and marking template specializations for output (markTemplateSpecializationsForOutput.C)). ‐ Return: Returns bool.
#### Sg_File_Info::generateDefaultFileInfo() Static function to return new Sg_File_Info object set to default values. ‐ Return: Returns pointer to Sg_File_Info.
#### Sg_File_Info::generateDefaultFileInfoForTransformationNode() Static function to return new Sg_File_Info object set to default values appropriate for transformations. This function calls setOutputInCodeGeneration() and sets the file_id to be TRANSFORMATION_FILE_ID. ‐ Return: Returns pointer to Sg_File_Info.
#### Sg_File_Info::generateFileInfoForTransformationNode( int file_id ) Static function to return new Sg_File_Info object set to default values appropriate for transformations that are not in the source file. Static function which allows specification of transformation with assignement to a specific file (where it would be unparsed). This function will call setOutputInCodeGeneration() and sets the file_id to a non‐negative value. This function is useful when transformation to a program happen within a header file (e.g. including a header file as part of a transformation). Setting the file_id to the current source file should have the same result (semantics) as Sg_File_Info::generateDefaultFileInfoForTransformationNode(). ‐ Return: Returns pointer to Sg_File_Info.
#### Sg_File_Info::generateFileInfoForTransformationNode( string filename ) Static function to return new Sg_File_Info object set to default values appropriate for transformations that are not in the source file. Function similar to previous function, but takes a filename to support new files that have not ben seen previously (e.g. new header file). ‐ Return: Returns pointer to Sg_File_Info.
#### Sg_File_Info::generateDefaultFileInfoForCompilerGeneratedNode() Static function to return new Sg_File_Info object set to default values appropriate for compiler generated code. ‐ Return: Returns pointer to Sg_File_Info.
#### Sg_File_Info::hasPositionInSource() const Abstracts query as to if an IR node maps back to the source code (evolving set of reasons whey this can be false). There are several reasons why an IR node might NOT have a mapping back to the source code: ‐ could be a part of a transformation (isTransformation() == true) ‐ could be a compiler generated statement or expression (isCompilerGenerated() == true) ‐ could be compiler generated and marked for output by the unparser (isCompilerGeneratedNodeToBeUnparsed() == true) ‐ Internal: This is an evolving set of reasons, so abstracting it as a member function is helpful. ‐ Return: Returns bool.
#### Sg_File_Info::isTransformation() const Returns true only if part of a transformation. ‐ Return: Returns bool.
#### Sg_File_Info::isCompilerGenerated() const Returns true only if compiler generated (either by the front‐end or by ROSE). ‐ Internal: We do not presently distinguish between compiler generated code from EDG or by ROSE. For example template instatiations are not marked as compiler generated by EDG, but if ROSE generates specializations from instatioated templates then they are marked by ROSE as being compiler generated. ‐ Return: Returns bool.
#### Sg_File_Info::isCompilerGeneratedNodeToBeUnparsed() const Returns true only if compiler generated and required to be unparsed in generated code. ‐ Internal: Templates instatiated by ROSE are marked as compiler generated, but only those instatiated templates that are used in the source file are required and so only those must be unparsed in the generated code. ‐ Deprecated: This now calls isOutputInCodeGeneration(), and will be removed soon. ‐ Return: Returns bool.
#### Sg_File_Info::isOutputInCodeGeneration() const Returns true only if required to be unparsed in generated code. ‐ Internal: Templates instatiated by ROSE are marked as compiler generated, but only those instatiated templates that are used in the source file are required and so only those must be unparsed in the generated code. Note that currently all transformed IR nodes are implicitly considered to be marked as outputInCodeGeneration, but this will be made an explicit requirement in the future. ‐ Return: Returns bool.
#### Sg_File_Info::isShared() const Returns true only if shared internally (either by the front‐end or by ROSE). ‐ Internal: This is a new classification supporting the AST merge mechanism. Currently numerous types of IR nodes that are shared (SgType, SgSymbol, many non‐defining declarations, etc.) are not explicitly marked as shared. This may be correct in a future release (requires more thought). ‐ Return: Returns bool.
#### Sg_File_Info::unsetTransformation() If the IR node is a transformation it marks it false (zeros transformation marker bit internally). ‐ Return: Returns void.
#### Sg_File_Info::setTransformation() Marks an IR node to be a transformation if it is not one already. ‐ Return: Returns void.
#### Sg_File_Info::unsetCompilerGenerated() Unmarks IR node as compiler generated. ‐ Return: Returns void.
#### Sg_File_Info::setCompilerGenerated() Marks IR node as compiler generated. ‐ Return: Returns void.
#### Sg_File_Info::unsetCompilerGeneratedNodeToBeUnparsed() Unmarks IR node as compiler generated but required in the generated source (e.g. requied templates). ‐ Deprecated: This now calls unsetOutputInCodeGeneration(), and will be removed soon. ‐ Return: Returns void.
#### Sg_File_Info::setCompilerGeneratedNodeToBeUnparsed() Marks IR node as compiler generated but required in the generated source (e.g. requied templates). ‐ Deprecated: This now calls setOutputInCodeGeneration(), and will be removed soon. ‐ Return: Returns void.
#### Sg_File_Info::unsetOutputInCodeGeneration() Unmarks IR node as compiler generated but required in the generated source (e.g. requied templates). ‐ Return: Returns void.
#### Sg_File_Info::setOutputInCodeGeneration() Marks IR node as compiler generated but required in the generated source (e.g. requied templates). ‐ Return: Returns void.
#### Sg_File_Info::unsetShared() Unmarks IR node as shared. ‐ Return: Returns void.
#### Sg_File_Info::setShared() Marks IR node as shared. ‐ Return: Returns void.
#### bool Sg_File_Info::ok() Checks internal consistancy of data. This function verifies: ‐# filename pointer is valid ‐# if not compiler generaated then line number > 0 Defined to be used in tests: ROSE_ASSERT(statement‐>get_file_info()‐>ok()); ‐ Return: Returns bool.
#### Sg_File_Info::display( const string label ) This function outputs the internal data to stdout, for debugging. ‐ Return: Returns void.
#### bool Sg_File_Info::operator== ( const Sg_File_Info & X, const Sg_File_Info & Y ) This relational operator tests two Sg_File_Info objects for equal position information. ‐ Return: Returns bool.
#### bool Sg_File_Info::operator!= ( const Sg_File_Info & X, const Sg_File_Info & Y ) This relational operator tests two Sg_File_Info objects for unequal position information. ‐ Return: Returns bool.
#### Sg_File_Info::operator> ( const Sg_File_Info & X, const Sg_File_Info & Y ) This relational operator tests two Sg_File_Info objects for X being after Y in the same file. ‐ Return: Returns bool.
#### Sg_File_Info::operator< ( const Sg_File_Info & X, const Sg_File_Info & Y ) This relational operator tests two Sg_File_Info objects for X being before Y in the same file. ‐ Return: Returns bool.
#### Sg_File_Info::operator>= ( const Sg_File_Info & X, const Sg_File_Info & Y ) This relational operator tests two Sg_File_Info objects for X being at the same position or after Y in the same file. ‐ Return: Returns bool.
#### Sg_File_Info::operator<= ( const Sg_File_Info & X, const Sg_File_Info & Y ) This relational operator tests two Sg_File_Info objects for X being at the same position or before Y in the same file. ‐ Return: Returns bool.
Created with MrDocs