ROSE  0.9.12.24
sageInterface.h
1 #ifndef ROSE_SAGE_INTERFACE
2 #define ROSE_SAGE_INTERFACE
3 
4 #include "sage3basic.hhh"
5 #include <stdint.h>
6 #include <utility>
7 
8 #include "rosePublicConfig.h" // for ROSE_BUILD_JAVA_LANGUAGE_SUPPORT
9 #include "OmpAttribute.h"
10 
11 
12 #if 0 // FMZ(07/07/2010): the argument "nextErrorCode" should be call-by-reference
13 SgFile* determineFileType ( std::vector<std::string> argv, int nextErrorCode, SgProject* project );
14 #else
15 SgFile* determineFileType ( std::vector<std::string> argv, int& nextErrorCode, SgProject* project );
16 #endif
17 
18 #ifndef ROSE_USE_INTERNAL_FRONTEND_DEVELOPMENT
19 #include "rewrite.h"
20 #endif
21 
22 // DQ (7/20/2008): Added support for unparsing abitrary strings in the unparser.
23 #include "astUnparseAttribute.h"
24 #include <set>
25 
26 #ifndef ROSE_USE_INTERNAL_FRONTEND_DEVELOPMENT
27 #include "LivenessAnalysis.h"
28 #include "abstract_handle.h"
29 #include "ClassHierarchyGraph.h"
30 #endif
31 
32 // DQ (8/19/2004): Moved from ROSE/src/midend/astRewriteMechanism/rewrite.h
34 ROSE_DLL_API std::string getVariantName (VariantT v);
35 
36 // DQ (12/9/2004): Qing, Rich and Dan have decided to start this namespace within ROSE
37 // This namespace is specific to interface functions that operate on the Sage III AST.
38 // The name was chosen so as not to conflict with other classes within ROSE.
39 // This will become the future home of many interface functions which operate on
40 // the AST and which are generally useful to users. As a namespace multiple files can be used
41 // to represent the compete interface and different developers may contribute interface
42 // functions easily.
43 
44 // Constructor handling: (We have sageBuilder.h now for this purpose, Liao 2/1/2008)
45 // We could add simpler layers of support for construction of IR nodes by
46 // hiding many details in "makeSg***()" functions. Such functions would
47 // return pointers to the associated Sg*** objects and would be able to hide
48 // many IR specific details, including:
49 // memory handling
50 // optional parameter settings not often required
51 // use of Sg_File_Info objects (and setting them as transformations)
52 //
53 // namespace AST_Interface (this name is taken already by some of Qing's work :-)
54 
56 #define TRANS_FILE Sg_File_Info::generateDefaultFileInfoForTransformationNode()
57 
58 
64 namespace SageInterface
65  {
66  // Liao 6/22/2016: keep records of loop init-stmt normalization, later help undo it to support autoPar.
68  {
69  // a lookup table to check if a for loop has been normalized for its c99-style init-stmt
70  std::map <SgForStatement* , bool > forLoopInitNormalizationTable;
71  // Detailed record about the original declaration (1st in the pair) and the normalization generated new declaration (2nd in the pair)
72  std::map <SgForStatement* , std::pair<SgVariableDeclaration*, SgVariableDeclaration*> > forLoopInitNormalizationRecord;
73  } ;
74 
75  ROSE_DLL_API extern Transformation_Record trans_records;
76 
77  // DQ (4/3/2014): Added general AST support separate from the AST.
78 
79  // Container and API for analysis information that is outside of the AST and as a result
80  // prevents frequent modification of the IR.
82  {
83  // DQ (4/3/2014): This stores all associated declarations as a map of sets.
84  // the key to the map is the first nondefining declaration and the elements of the set are
85  // all of the associated declarations (including the defining declaration).
86 
87  private:
89  std::map<SgDeclarationStatement*,std::set<SgDeclarationStatement*>* > declarationMap;
90 
91  public:
92  void addDeclaration(SgDeclarationStatement* decl);
93  const std::set<SgDeclarationStatement*>* getDeclarations(SgDeclarationStatement* decl);
94 
95  std::map<SgDeclarationStatement*,std::set<SgDeclarationStatement*>* > & getDeclarationMap();
96 
97  bool isLocatedInDefiningScope(SgDeclarationStatement* decl);
98 
99  };
100 
101  // DQ (4/3/2014): This constructs a data structure that holds analysis information about
102  // the AST that is separate from the AST. This is intended to be a general mechanism
103  // to support analysis information without constantly modifying the IR.
104  DeclarationSets* buildDeclarationSets(SgNode*);
105 
107 ROSE_DLL_API extern int gensym_counter;
108 
109 // tps : 28 Oct 2008 - support for finding the main interpretation
110  SgAsmInterpretation* getMainInterpretation(SgAsmGenericFile* file);
111 
114 
117 
119  void addMessageStatement( SgStatement* stmt, std::string message );
120 
122  class UniqueNameAttribute : public AstAttribute
123  {
124  private:
125  std::string name;
126  public:
127  UniqueNameAttribute(std::string n="") {name =n; };
128  void set_name (std::string n) {name = n;};
129  std::string get_name () {return name;};
130  };
131 
132 // DQ (3/2/2009): Added support for collectiong an merging the referenced symbols in the outlined
133 // function into the list used to edit the outlined code subtree to fixup references (from symbols
134 // in the original file to the symbols in the newer separate file).
135 // typedef rose_hash::unordered_map<SgNode*, SgNode*, hash_nodeptr> ReplacementMapType;
136 // void supplementReplacementSymbolMap ( const ReplacementMapTraversal::ReplacementMapType & inputReplacementMap );
137 
138 // CH (4/9/2010): Use boost::hash instead
139 //#ifdef _MSC_VER
140 #if 0
141 inline size_t hash_value(SgNode* t) {return (size_t)t;}
142 #endif
143 
144 #if 0
145 // DQ (8/3/2015): We expect that this is not used and is generating a warnings so we
146 // can best fix it by removing it.
147 struct hash_nodeptr
148  {
149 // CH (4/9/2010): Use boost::hash instead
150 //#ifndef _MSC_VER
151 #if 0
152  //rose_hash::hash<char*> hasher;
153 #endif
154  public:
155  size_t operator()(SgNode* node) const
156  {
157 // CH (4/9/2010): Use boost::hash instead
158 //#ifdef _MSC_VER
159  #if 0
160  return (size_t) hash_value(node);
161  #else
162  return (size_t) node;
163  #endif
164  }
165  };
166 
167 #ifndef SWIG
168 // DQ (3/10/2013): This appears to be a problem for the SWIG interface (undefined reference at link-time).
169  void supplementReplacementSymbolMap ( rose_hash::unordered_map<SgNode*, SgNode*, hash_nodeptr> & inputReplacementMap );
170 #endif
171 #endif
172 
173  //------------------------------------------------------------------------
175 
178  // Liao 1/22/2008, used for get symbols for generating variable reference nodes
179  // ! Find a variable symbol in current and ancestor scopes for a given name
180  ROSE_DLL_API SgVariableSymbol *lookupVariableSymbolInParentScopes (const SgName & name, SgScopeStatement *currentScope=NULL);
181 
182 // DQ (8/21/2013): Modified to make newest function parameters be default arguments.
183 // DQ (8/16/2013): For now we want to remove the use of default parameters and add the support for template parameters and template arguments.
185 // SgSymbol *lookupSymbolInParentScopes (const SgName & name, SgScopeStatement *currentScope=NULL);
186 // SgSymbol *lookupSymbolInParentScopes (const SgName & name, SgScopeStatement *currentScope, SgTemplateParameterPtrList* templateParameterList, SgTemplateArgumentPtrList* templateArgumentList);
187  ROSE_DLL_API SgSymbol *lookupSymbolInParentScopes (const SgName & name, SgScopeStatement *currentScope = NULL, SgTemplateParameterPtrList* templateParameterList = NULL, SgTemplateArgumentPtrList* templateArgumentList = NULL);
188 
189  // DQ (11/24/2007): Functions moved from the Fortran support so that they could be called from within astPostProcessing.
191  ROSE_DLL_API SgFunctionSymbol *lookupFunctionSymbolInParentScopes (const SgName & functionName, SgScopeStatement *currentScope=NULL);
192 
193  // Liao, 1/24/2008, find exact match for a function
195  ROSE_DLL_API SgFunctionSymbol *lookupFunctionSymbolInParentScopes (const SgName & functionName,
196  const SgType* t,
197  SgScopeStatement *currentScope=NULL);
198 
199  ROSE_DLL_API SgFunctionSymbol *lookupTemplateFunctionSymbolInParentScopes (const SgName & functionName, SgFunctionType * ftype, SgTemplateParameterPtrList * tplparams, SgScopeStatement *currentScope=NULL);
200  ROSE_DLL_API SgFunctionSymbol *lookupTemplateMemberFunctionSymbolInParentScopes (const SgName & functionName, SgFunctionType * ftype, SgTemplateParameterPtrList * tplparams, SgScopeStatement *currentScope=NULL);
201 
202  ROSE_DLL_API SgTemplateVariableSymbol * lookupTemplateVariableSymbolInParentScopes (const SgName & name, SgTemplateParameterPtrList * tplparams, SgTemplateArgumentPtrList* tplargs, SgScopeStatement *currentScope=NULL);
203 
204 
205 // DQ (8/21/2013): Modified to make newest function parameters be default arguments.
206 // DQ (8/16/2013): For now we want to remove the use of default parameters and add the support for template parameters and template arguments.
207 // DQ (5/7/2011): Added support for SgClassSymbol (used in name qualification support).
208 // SgClassSymbol* lookupClassSymbolInParentScopes (const SgName & name, SgScopeStatement *currentScope = NULL);
209  ROSE_DLL_API SgClassSymbol* lookupClassSymbolInParentScopes (const SgName & name, SgScopeStatement *currentScope = NULL, SgTemplateArgumentPtrList* templateArgumentList = NULL);
210  ROSE_DLL_API SgTypedefSymbol* lookupTypedefSymbolInParentScopes (const SgName & name, SgScopeStatement *currentScope = NULL);
211 
212  ROSE_DLL_API SgNonrealSymbol* lookupNonrealSymbolInParentScopes (const SgName & name, SgScopeStatement *currentScope = NULL, SgTemplateParameterPtrList* templateParameterList = NULL, SgTemplateArgumentPtrList* templateArgumentList = NULL);
213 #if 0
214  // DQ (8/13/2013): This function does not make since any more, now that we have made the symbol
215  // table handling more precise and we have to provide template parameters for any template lookup.
216  // We also have to know if we want to lookup template classes, template functions, or template
217  // member functions (since each have specific requirements).
218  SgTemplateSymbol* lookupTemplateSymbolInParentScopes (const SgName & name, SgScopeStatement *currentScope = NULL);
219 #endif
220 #if 0
221 // DQ (8/13/2013): I am not sure if we want this functions in place of lookupTemplateSymbolInParentScopes.
222 // Where these are called we might not know enough information about the template parameters or function
223 // types, for example.
224  SgTemplateClassSymbol* lookupTemplateClassSymbolInParentScopes (const SgName & name, SgScopeStatement *currentScope = NULL, SgTemplateParameterPtrList* templateParameterList = NULL, SgTemplateArgumentPtrList* templateArgumentList = NULL);
225  SgTemplateFunctionSymbol* lookupTemplateFunctionSymbolInParentScopes (const SgName & name, SgScopeStatement *currentScope = NULL, SgTemplateParameterPtrList* templateParameterList = NULL);
226  SgTemplateMemberFunctionSymbol* lookupTemplateMemberFunctionSymbolInParentScopes (const SgName & name, SgScopeStatement *currentScope = NULL, SgTemplateParameterPtrList* templateParameterList = NULL);
227 #endif
228 
229 // DQ (8/21/2013): Modified to make some of the newest function parameters be default arguments.
230 // DQ (8/13/2013): I am not sure if we want this functions in place of lookupTemplateSymbolInParentScopes.
231  ROSE_DLL_API SgTemplateClassSymbol* lookupTemplateClassSymbolInParentScopes (const SgName & name, SgTemplateParameterPtrList* templateParameterList, SgTemplateArgumentPtrList* templateArgumentList, SgScopeStatement *cscope = NULL);
232 
233  ROSE_DLL_API SgEnumSymbol* lookupEnumSymbolInParentScopes (const SgName & name, SgScopeStatement *currentScope = NULL);
234  ROSE_DLL_API SgNamespaceSymbol* lookupNamespaceSymbolInParentScopes(const SgName & name, SgScopeStatement *currentScope = NULL);
235 
236 // DQ (7/17/2011): Added function from cxx branch that I need here for the Java support.
237 // SgClassSymbol* lookupClassSymbolInParentScopes (const SgName & name, SgScopeStatement *cscope);
238 
247  // DQ (12/9/2004): Moved this function (by Alin Jula) from being a member of SgInitializedName
248  // to this location where it can be a part of the interface for the Sage III AST.
249  ROSE_DLL_API int set_name (SgInitializedName * initializedNameNode, SgName new_name);
250 
254 
255  // DQ (6/27/2005):
260  ROSE_DLL_API void outputLocalSymbolTables (SgNode * node);
261 
263  {
264  public:
265  void visit (SgNode * node);
266  };
272  // DQ (9/28/2005):
273  void rebuildSymbolTable (SgScopeStatement * scope);
274 
277  void clearUnusedVariableSymbols (SgNode* root = NULL);
278 
279  // DQ (3/1/2009):
281  void fixupReferencesToSymbols( const SgScopeStatement* this_scope, SgScopeStatement* copy_scope, SgCopyHelp & help );
282 
284 
285  //------------------------------------------------------------------------
287 
294  // DQ (9/21/2005): General function for extracting the name of declarations (when they have names)
295  std::string get_name (const SgNode * node);
296 
301  // DQ (6/13/2005): General function for extracting the name of declarations (when they have names)
302  std::string get_name (const SgStatement * stmt);
303 
308  std::string get_name (const SgExpression * expr);
309 
314  // DQ (6/13/2005): General function for extracting the name of declarations (when they have names)
315  std::string get_name (const SgDeclarationStatement * declaration);
316 
321  // DQ (6/13/2005): General function for extracting the name of declarations (when they have names)
322  std::string get_name (const SgScopeStatement * scope);
323 
328  // DQ (2/11/2007): Added this function to make debugging support more complete (useful for symbol table debugging support).
329  std::string get_name (const SgSymbol * symbol);
330 
335  std::string get_name (const SgType * type);
336 
337 
340  std::string get_name (const SgSupport * node);
341 
342 
345  std::string get_name (const SgLocatedNodeSupport * node);
346 
349  std::string get_name ( const SgC_PreprocessorDirectiveStatement* directive );
350 
353  std::string get_name ( const SgToken* token );
354 
355  // DQ (3/20/2016): Added to refactor some of the DSL infrastructure support.
365 
368  extern std::map<std::string,int> local_name_collision_map;
369  extern std::map<std::string,SgNode*> local_name_to_node_map;
370  extern std::map<SgNode*,std::string> local_node_to_name_map;
371 
375 
379 
381 
382  //------------------------------------------------------------------------
384 
389  // DQ (6/21/2005): Get the default destructor from the class declaration
391  classDeclaration);
392 
395  // DQ (6/22/2005): Get the default constructor from the class declaration
397  classDeclaration);
400  // DQ (8/27/2005):
402  * memberFunctionDeclaration);
403 
408  // DQ (9/17/2005):
411  (SgTemplateInstantiationMemberFunctionDecl * memberFunctionInstantiation);
412 
414  bool isStructDeclaration(SgNode * node);
416  bool isUnionDeclaration(SgNode * node);
417  #if 0
418  // DQ (8/28/2005): This is already a member function of the SgFunctionDeclaration
419  // (so that it can handle template functions and member functions)
420 
424  // DQ (8/27/2005):
425  bool isTemplateMemberFunction (SgTemplateInstantiationMemberFunctionDecl *
426  memberFunctionDeclaration);
427  #endif
428 
430 
431  //------------------------------------------------------------------------
433 
437  void saveToPDF(SgNode* node, std::string filename);
439  void saveToPDF(SgNode* node); // enable calling from gdb
440 
441  // DQ (2/12/2012): Added some diagnostic support.
443  void whereAmI(SgNode* node);
444 
446  std::string extractPragmaKeyword(const SgPragmaDeclaration *);
447 
449  ROSE_DLL_API bool isOmpStatement(SgNode* );
452  // DQ (8/27/2005):
453  bool isOverloaded (SgFunctionDeclaration * functionDeclaration);
454 
455 // DQ (2/14/2012): Added support function used for variable declarations in conditionals.
457  void initializeIfStmt(SgIfStmt *ifstmt, SgStatement* conditional, SgStatement * true_body, SgStatement * false_body);
458 
460  void initializeSwitchStatement(SgSwitchStatement* switchStatement,SgStatement *item_selector,SgStatement *body);
461 
463  void initializeWhileStatement(SgWhileStmt* whileStatement, SgStatement * condition, SgStatement *body, SgStatement *else_body);
464 
467 
469  ROSE_DLL_API bool isMain (const SgNode* node);
470  // DQ (6/22/2005):
481  std::string generateUniqueName ( const SgNode * node, bool ignoreDifferenceBetweenDefiningAndNondefiningDeclarations);
482 
485  std::string generateUniqueVariableName(SgScopeStatement* scope, std::string baseName = "temp");
486 
487  // DQ (8/10/2010): Added const to first parameter.
488  // DQ (3/10/2007):
490  std::string declarationPositionString (const SgDeclarationStatement * declaration);
491 
492  // DQ (1/20/2007):
494  ROSE_DLL_API std::string generateProjectName (const SgProject * project, bool supressSuffix = false );
495 
499 
502 
504  void addVarRefExpFromArrayDimInfo(SgNode * astNode, Rose_STL_Container<SgNode *>& NodeList_t);
505 
506  // DQ (10/6/2006): Added support for faster mangled name generation (caching avoids recomputation).
510 #ifndef SWIG
511 // DQ (3/10/2013): This appears to be a problem for the SWIG interface (undefined reference at link-time).
512  void clearMangledNameCache (SgGlobal * globalScope);
513  void resetMangledNameCache (SgGlobal * globalScope);
514 #endif
515 
516  std::string getMangledNameFromCache (SgNode * astNode);
517  std::string addMangledNameToCache (SgNode * astNode, const std::string & mangledName);
518 
520 
524 
525  // DQ (10/14/2006): This function tests the AST to see if for a non-defining declaration, the
526  // bool declarationPreceedsDefinition ( SgClassDeclaration* classNonDefiningDeclaration, SgClassDeclaration* classDefiningDeclaration );
528  bool declarationPreceedsDefinition (SgDeclarationStatement *nonDefiningDeclaration, SgDeclarationStatement *definingDeclaration);
529 
530  // DQ (10/19/2006): Function calls have interesting context dependent rules to determine if
531  // they are output with a global qualifier or not. Were this is true we have to avoid global
532  // qualifiers, since the function's scope has not been defined. This is an example of where
533  // qualification of function names in function calls are context dependent; an interesting
534  // example of where the C++ language is not friendly to source-to-source processing :-).
536 
541  ROSE_DLL_API std::vector < SgNode * >astIntersection (SgNode * original, SgNode * copy, SgCopyHelp * help = NULL);
542 
544  ROSE_DLL_API SgNode* deepCopyNode (const SgNode* subtree);
545 
547  template <typename NodeType>
548  NodeType* deepCopy (const NodeType* subtree) {
549  return dynamic_cast<NodeType*>(deepCopyNode(subtree));
550  }
551 
553  ROSE_DLL_API SgExpression* copyExpression(SgExpression* e);
554 
556  ROSE_DLL_API SgStatement* copyStatement(SgStatement* s);
557 
558 // from VarSym.cc in src/midend/astOutlining/src/ASTtools
561 
564 
566 ROSE_DLL_API void myRemoveStatement(SgStatement* stmt);
567 
568 ROSE_DLL_API bool isConstantTrue(SgExpression* e);
569 ROSE_DLL_API bool isConstantFalse(SgExpression* e);
570 
572 ROSE_DLL_API bool isCallToParticularFunction(const std::string& qualifiedName, size_t arity, SgExpression* e);
573 
575 bool ROSE_DLL_API isStatic(SgDeclarationStatement* stmt);
576 
578 ROSE_DLL_API void setStatic(SgDeclarationStatement* stmt);
579 
581 ROSE_DLL_API bool isExtern(SgDeclarationStatement* stmt);
582 
584 ROSE_DLL_API void setExtern(SgDeclarationStatement* stmt);
585 
589  public:
590  virtual ~StatementGenerator() {};
591  virtual SgStatement* generate(SgExpression* where_to_write_answer) = 0;
592 };
593 
597  bool isAssignmentStatement(SgNode* _s, SgExpression** lhs=NULL, SgExpression** rhs=NULL, bool* readlhs=NULL);
598 
600 ROSE_DLL_API SgInitializedName* convertRefToInitializedName(SgNode* current, bool coarseGrain=true);
601 
604 
606 ROSE_DLL_API SgNode* getSgNodeFromAbstractHandleString(const std::string& input_string);
607 
609 ROSE_DLL_API void dumpInfo(SgNode* node, std::string desc="");
610 
612 ROSE_DLL_API std::vector<SgDeclarationStatement*>
613 sortSgNodeListBasedOnAppearanceOrderInSource(const std::vector<SgDeclarationStatement*>& nodevec);
614 
615 // DQ (4/13/2013): We need these to support the unparing of operators defined by operator syntax or member function names.
617 // bool isPrefixOperator( const SgMemberFunctionRefExp* memberFunctionRefExp );
618 bool isPrefixOperator( SgExpression* exp );
619 
621 bool isPrefixOperatorName( const SgName & functionName );
622 
624 bool isPostfixOperator( SgExpression* exp );
625 
627 bool isIndexOperator( SgExpression* exp );
628 
629 // DQ (1/10/2014): Adding more general support for token based unparsing.
631 SgStatement* lastStatementOfScopeWithTokenInfo (SgScopeStatement* scope, std::map<SgNode*,TokenStreamSequenceToNodeMapping*> & tokenStreamSequenceMap);
632 
634 
635 //------------------------------------------------------------------------
637 
641 // std::string version(); // utility_functions.h, version number
644  ROSE_DLL_API bool is_Ada_language ();
645  ROSE_DLL_API bool is_C_language ();
646  ROSE_DLL_API bool is_Cobol_language ();
647  ROSE_DLL_API bool is_OpenMP_language ();
648  ROSE_DLL_API bool is_UPC_language ();
650  ROSE_DLL_API bool is_UPC_dynamic_threads();
651  ROSE_DLL_API bool is_C99_language ();
652  ROSE_DLL_API bool is_Cxx_language ();
653  ROSE_DLL_API bool is_Java_language ();
654  ROSE_DLL_API bool is_Jovial_language ();
655  ROSE_DLL_API bool is_Fortran_language ();
656  ROSE_DLL_API bool is_CAF_language ();
657  ROSE_DLL_API bool is_PHP_language();
658  ROSE_DLL_API bool is_Python_language();
659  ROSE_DLL_API bool is_Cuda_language();
660  ROSE_DLL_API bool is_OpenCL_language();
661  ROSE_DLL_API bool is_X10_language();
662  ROSE_DLL_API bool is_binary_executable();
663  ROSE_DLL_API bool is_mixed_C_and_Cxx_language ();
664  ROSE_DLL_API bool is_mixed_Fortran_and_C_language ();
665  ROSE_DLL_API bool is_mixed_Fortran_and_Cxx_language ();
666  ROSE_DLL_API bool is_mixed_Fortran_and_C_and_Cxx_language ();
668 
669 //------------------------------------------------------------------------
671 
675  // DQ (10/5/2006): Added support for faster (non-quadratic) computation of unique
676  // labels for scopes in a function (as required for name mangling).
682  void resetScopeNumbers (SgFunctionDefinition * functionDeclaration);
683 
684  // DQ (10/5/2006): Added support for faster (non-quadratic) computation of unique
685  // labels for scopes in a function (as required for name mangling).
694  void clearScopeNumbers (SgFunctionDefinition * functionDefinition);
695 
696 
699 // SgNamespaceDefinitionStatement * getEnclosingNamespaceScope (SgNode * node);
700 
701  bool isPrototypeInScope (SgScopeStatement * scope,
702  SgFunctionDeclaration * functionDeclaration,
703  SgDeclarationStatement * startingAtDeclaration);
704 
706  bool ROSE_DLL_API isAncestor(SgNode* node1, SgNode* node2);
708 //------------------------------------------------------------------------
710 
714  void dumpPreprocInfo (SgLocatedNode* locatedNode);
716 
718 PreprocessingInfo * insertHeader(SgSourceFile * source_file, const std::string & header_file_name, bool isSystemHeader, bool asLastHeader);
719 
721 void insertHeader (SgStatement* stmt, PreprocessingInfo* newheader, bool asLastHeader);
722 
724 PreprocessingInfo * insertHeader(SgSourceFile * source_file, const std::string & header_file_name, bool isSystemHeader = false, PreprocessingInfo::RelativePositionType position = PreprocessingInfo::before);
725 
727 ROSE_DLL_API PreprocessingInfo* insertHeader(const std::string& filename, PreprocessingInfo::RelativePositionType position=PreprocessingInfo::after, bool isSystemHeader=false, SgScopeStatement* scope=NULL);
728 
730 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);
731 
733 ROSE_DLL_API void movePreprocessingInfo (SgStatement* stmt_src, SgStatement* stmt_dst, PreprocessingInfo::RelativePositionType src_position=PreprocessingInfo::undef,
734  PreprocessingInfo::RelativePositionType dst_position=PreprocessingInfo::undef, bool usePrepend= false);
735 
736 
738 ROSE_DLL_API void cutPreprocessingInfo (SgLocatedNode* src_node, PreprocessingInfo::RelativePositionType pos, AttachedPreprocessingInfoType& save_buf);
739 
741 ROSE_DLL_API void pastePreprocessingInfo (SgLocatedNode* dst_node, PreprocessingInfo::RelativePositionType pos, AttachedPreprocessingInfoType& saved_buf);
742 
745  const std::string & text,
746  PreprocessingInfo::RelativePositionType position=PreprocessingInfo::before);
747 
751 
754  SgSourceFile * source_file,
755  const std::string & content,
756  PreprocessingInfo::DirectiveType directive_type = PreprocessingInfo::C_StyleComment,
757  PreprocessingInfo::RelativePositionType position = PreprocessingInfo::before
758 );
759 
761  ROSE_DLL_API PreprocessingInfo* attachComment(SgLocatedNode* target, const std::string & content,
762  PreprocessingInfo::RelativePositionType position=PreprocessingInfo::before,
763  PreprocessingInfo::DirectiveType dtype= PreprocessingInfo::CpreprocessorUnknownDeclaration);
764 
765 // DQ (11/25/2009): Added matching support for adding comments to SgAsm nodes.
766 // Build and attach comment
767 // void attachComment(SgAsmStatement* target, const std::string & content );
768 
769 // DQ (7/20/2008): I am not clear were I should put this function, candidates include: SgLocatedNode or SgInterface
771  ROSE_DLL_API void addTextForUnparser ( SgNode* astNode, std::string s, AstUnparseAttribute::RelativePositionType inputlocation );
772 
777 void guardNode(SgLocatedNode * target, std::string guard);
778 
780 
781 
782 //------------------------------------------------------------------------
784 
788 // ************************************************************************
789 // Newer versions of now depricated functions
790 // ************************************************************************
791 
792 // DQ (5/1/2012): This function queries the SageBuilder::SourcePositionClassification mode (stored in the SageBuilder
793 // interface) and used the specified mode to initialize the source position data (Sg_File_Info objects). This
794 // function is the only function that should be called directly (though in a namespace we can't define permissions).
796  ROSE_DLL_API void setSourcePosition(SgNode* node);
797 
798 // A better name might be "setSourcePositionForSubTree"
800  ROSE_DLL_API void setSourcePositionAtRootAndAllChildren(SgNode *root);
801 
804 
805 // DQ (5/1/2012): Newly renamed function (previous name preserved for backward compatability).
807 
808 // ************************************************************************
809 
810 
811 
812 // ************************************************************************
813 // Older deprecated functions
814 // ************************************************************************
815  // Liao, 1/8/2007, set file info. for a whole subtree as transformation generated
817  ROSE_DLL_API void setOneSourcePositionForTransformation(SgNode *node);
818 
820  ROSE_DLL_API void setOneSourcePositionNull(SgNode *node);
821 
823  ROSE_DLL_API void setSourcePositionForTransformation (SgNode * root);
824 
826 // ROSE_DLL_API void setSourcePositionForTransformation_memoryPool();
827 
829  ROSE_DLL_API bool insideSystemHeader (SgLocatedNode* node);
830 
832 // ROSE_DLL_API void setSourcePosition (SgLocatedNode * locatedNode);
833 // ************************************************************************
834 
836 
837 
838 //------------------------------------------------------------------------
840 
844 // from src/midend/astInlining/typeTraits.h
845 // src/midend/astUtil/astInterface/AstInterface.h
846 
849 
850 
854 ROSE_DLL_API bool isStrictIntegerType(SgType* t);
856 ROSE_DLL_API SgType* getFirstVarType(SgVariableDeclaration* decl);
857 
859 ROSE_DLL_API bool isDefaultConstructible(SgType* type);
860 
862 ROSE_DLL_API bool isCopyConstructible(SgType* type);
863 
865 ROSE_DLL_API bool isAssignable(SgType* type);
866 
867 #ifndef ROSE_USE_INTERNAL_FRONTEND_DEVELOPMENT
868 ROSE_DLL_API bool isPureVirtualClass(SgType* type, const ClassHierarchyWrapper& classHierarchy);
872 #endif
873 
875 ROSE_DLL_API bool hasTrivialDestructor(SgType* t);
876 
878 ROSE_DLL_API bool isNonconstReference(SgType* t);
879 
881 ROSE_DLL_API bool isReferenceType(SgType* t);
882 
884 ROSE_DLL_API bool isPointerType(SgType* t);
885 
891 ROSE_DLL_API bool isPointerToNonConstType(SgType* type);
892 
894 /* const char* p = "aa"; is not treated as having a const type. It is a pointer to const char.
895  * Similarly, neither for const int b[10]; or const int & c =10;
896  * The standard says, "A compound type is not cv-qualified by the cv-qualifiers (if any) of
897 the types from which it is compounded. Any cv-qualifiers applied to an array type affect the array element type, not the array type".
898  */
899 ROSE_DLL_API bool isConstType(SgType* t);
900 
903 
905 ROSE_DLL_API bool isVolatileType(SgType* t);
906 
908 ROSE_DLL_API bool isRestrictType(SgType* t);
909 
911 
913 ROSE_DLL_API bool isScalarType(SgType* t);
914 
918 ROSE_DLL_API bool isStrictIntegerType(SgType* t);
919 
921 ROSE_DLL_API bool isStructType(SgType* t);
922 
924 ROSE_DLL_API std::string mangleType(SgType* type);
925 
927 ROSE_DLL_API std::string mangleScalarType(SgType* type);
928 
930 ROSE_DLL_API std::string mangleModifierType(SgModifierType* type);
931 
933 ROSE_DLL_API size_t getArrayElementCount(SgArrayType* t);
934 
936 ROSE_DLL_API int getDimensionCount(SgType* t);
937 
939 ROSE_DLL_API SgType* getArrayElementType(SgType* t);
940 
942 ROSE_DLL_API SgType* getElementType(SgType* t);
943 
944 
961 std::vector<SgExpression*>
962 get_C_array_dimensions(const SgArrayType& arrtype);
963 
984 std::vector<SgExpression*>
985 get_C_array_dimensions(const SgArrayType& arrtype, const SgVarRefExp& varref);
986 
990 std::vector<SgExpression*>
991 get_C_array_dimensions(const SgArrayType& arrtype, SgInitializedName& initname);
992 
993 
995 ROSE_DLL_API bool isArrayReference(SgExpression* ref, SgExpression** arrayNameExp=NULL, std::vector<SgExpression*>** subscripts=NULL);
996 
997 
999 ROSE_DLL_API int collectVariableReferencesInArrayTypes (SgLocatedNode* root, Rose_STL_Container<SgNode*> & currentVarRefList);
1001 
1010 ROSE_DLL_API bool hasUpcSharedType(SgType* t, SgModifierType ** mod_type_out = NULL );
1011 
1013 
1016 ROSE_DLL_API bool isUpcSharedType(SgType* t, SgModifierType ** mod_type_out = NULL);
1017 
1019 ROSE_DLL_API bool isUpcSharedModifierType (SgModifierType* mod_type);
1020 
1022 ROSE_DLL_API bool isUpcSharedArrayType (SgArrayType* array_type);
1023 
1025 ROSE_DLL_API bool isUpcStrictSharedModifierType(SgModifierType* mode_type);
1026 
1028 ROSE_DLL_API size_t getUpcSharedBlockSize(SgModifierType* mod_type);
1029 
1031 ROSE_DLL_API size_t getUpcSharedBlockSize(SgType* t);
1032 
1034 ROSE_DLL_API bool isUpcPhaseLessSharedType (SgType* t);
1035 
1037 ROSE_DLL_API bool isUpcPrivateToSharedType(SgType* t);
1038 
1040 ROSE_DLL_API bool isUpcArrayWithThreads(SgArrayType* t);
1041 
1043 ROSE_DLL_API SgType* lookupNamedTypeInParentScopes(const std::string& type_name, SgScopeStatement* scope=NULL);
1044 
1045 // DQ (7/22/2014): Added support for comparing expression types in actual arguments with those expected from the formal function parameter types.
1047 ROSE_DLL_API SgType* getAssociatedTypeFromFunctionTypeList(SgExpression* actual_argument_expression);
1048 
1050 ROSE_DLL_API bool templateArgumentEquivalence(SgTemplateArgument * arg1, SgTemplateArgument * arg2);
1051 
1053 ROSE_DLL_API bool templateArgumentListEquivalence(const SgTemplateArgumentPtrList & list1, const SgTemplateArgumentPtrList & list2);
1054 
1056 ROSE_DLL_API bool isEquivalentType (const SgType* lhs, const SgType* rhs);
1057 
1058 
1061 ROSE_DLL_API bool isEquivalentFunctionType (const SgFunctionType* lhs, const SgFunctionType* rhs);
1062 
1064 
1065 //------------------------------------------------------------------------
1067 
1071 // by Jeremiah
1080 ROSE_DLL_API void addStepToLoopBody(SgScopeStatement* loopStmt, SgStatement* step);
1081 
1083 ROSE_DLL_API void convertForToWhile(SgForStatement* f);
1084 ROSE_DLL_API void convertAllForsToWhiles(SgNode* top);
1086 ROSE_DLL_API void changeContinuesToGotos(SgStatement* stmt, SgLabelStatement* label);
1087 
1089 ROSE_DLL_API SgInitializedName* getLoopIndexVariable(SgNode* loop);
1090 
1093 ROSE_DLL_API bool isLoopIndexVariable(SgInitializedName* ivar, SgNode* subtree_root);
1094 
1096 
1100 ROSE_DLL_API bool hasMultipleInitStatmentsOrExpressions (SgForStatement* for_loop);
1101 
1103 ROSE_DLL_API SgStatement* getLoopBody(SgScopeStatement* loop);
1104 
1105 ROSE_DLL_API void setLoopBody(SgScopeStatement* loop, SgStatement* body);
1106 
1108 ROSE_DLL_API SgStatement* getLoopCondition(SgScopeStatement* loop);
1109 
1111 ROSE_DLL_API void setLoopCondition(SgScopeStatement* loop, SgStatement* cond);
1112 
1116 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);
1117 
1119 ROSE_DLL_API bool isCanonicalDoLoop(SgFortranDo* loop,SgInitializedName** ivar/*=NULL*/, SgExpression** lb/*=NULL*/, SgExpression** ub/*=NULL*/, SgExpression** step/*=NULL*/, SgStatement** body/*=NULL*/, bool *hasIncrementalIterationSpace/*= NULL*/, bool* isInclusiveUpperBound/*=NULL*/);
1120 
1122 ROSE_DLL_API void setLoopLowerBound(SgNode* loop, SgExpression* lb);
1123 
1125 ROSE_DLL_API void setLoopUpperBound(SgNode* loop, SgExpression* ub);
1126 
1128 ROSE_DLL_API void setLoopStride(SgNode* loop, SgExpression* stride);
1129 
1130 
1132 ROSE_DLL_API bool normalizeForLoopInitDeclaration(SgForStatement* loop);
1133 
1135 ROSE_DLL_API bool unnormalizeForLoopInitDeclaration(SgForStatement* loop);
1136 
1148 ROSE_DLL_API bool forLoopNormalization(SgForStatement* loop, bool foldConstant = true);
1149 
1153 ROSE_DLL_API bool normalizeForLoopTest(SgForStatement* loop);
1154 ROSE_DLL_API bool normalizeForLoopIncrement(SgForStatement* loop);
1155 
1157 ROSE_DLL_API bool doLoopNormalization(SgFortranDo* loop);
1158 
1160 ROSE_DLL_API bool loopUnrolling(SgForStatement* loop, size_t unrolling_factor);
1161 
1163 ROSE_DLL_API bool loopInterchange(SgForStatement* loop, size_t depth, size_t lexicoOrder);
1164 
1166 ROSE_DLL_API bool loopTiling(SgForStatement* loopNest, size_t targetLevel, size_t tileSize);
1167 
1168 //Winnie Loop Collapsing
1169 SgExprListExp * loopCollapsing(SgForStatement* target_loop, size_t collapsing_factor);
1170 
1172  SgForStatement * for_loop,
1173  SgVariableSymbol * & iterator,
1174  SgExpression * & lower_bound,
1175  SgExpression * & upper_bound,
1176  SgExpression * & stride
1177 );
1178 
1180 
1181 //------------------------------------------------------------------------
1183 
1187 template <typename NodeType>
1189 std::vector<NodeType*> querySubTree(SgNode* top, VariantT variant = (VariantT)NodeType::static_variant)
1190  {
1191 #if 0
1192  printf ("Top of SageInterface::querySubTree() \n");
1193 #endif
1194 
1195  Rose_STL_Container<SgNode*> nodes = NodeQuery::querySubTree(top,variant);
1196  std::vector<NodeType*> result(nodes.size(), NULL);
1197  int count = 0;
1198 #if 0
1199  printf ("In SageInterface::querySubTree(): before initialization loop \n");
1200 #endif
1201 
1202  for (Rose_STL_Container<SgNode*>::const_iterator i = nodes.begin(); i != nodes.end(); ++i, ++count)
1203  {
1204 #if 0
1205  printf ("In SageInterface::querySubTree(): in loop: count = %d \n",count);
1206 #endif
1207  NodeType* node = dynamic_cast<NodeType*>(*i);
1208  ROSE_ASSERT (node);
1209  result[count] = node;
1210  }
1211 #if 0
1212  printf ("Leaving SageInterface::querySubTree(): after initialization loop \n");
1213 #endif
1214 
1215  return result;
1216  }
1221  std::vector < SgFile * >generateFileList ();
1222 
1227 ROSE_DLL_API SgProject * getProject();
1228 
1230  SgProject * getProject(const SgNode * node);
1231 
1233 template <typename NodeType>
1234 static std::vector<NodeType*> getSgNodeListFromMemoryPool()
1235 {
1236  // This function uses a memory pool traversal specific to the SgFile IR nodes
1237  class MyTraversal : public ROSE_VisitTraversal
1238  {
1239  public:
1240  std::vector<NodeType*> resultlist;
1241  void visit ( SgNode* node)
1242  {
1243  NodeType* result = dynamic_cast<NodeType* > (node);
1244  ROSE_ASSERT(result!= NULL);
1245  if (result!= NULL)
1246  {
1247  resultlist.push_back(result);
1248  }
1249  };
1250  virtual ~MyTraversal() {}
1251  };
1252 
1253  MyTraversal my_traversal;
1254  NodeType::traverseMemoryPoolNodes(my_traversal);
1255  return my_traversal.resultlist;
1256 }
1257 
1258 
1261 ROSE_DLL_API SgFunctionDeclaration* findMain(SgNode* currentNode);
1262 
1264 SgStatement* findLastDeclarationStatement(SgScopeStatement * scope, bool includePragma = false);
1265 
1266  //midend/programTransformation/partialRedundancyElimination/pre.h
1268 std::vector<SgVariableSymbol*> getSymbolsUsedInExpression(SgExpression* expr);
1269 
1271 
1276 std::vector<SgBreakStmt*> findBreakStmts(SgStatement* code, const std::string& fortranLabel = "");
1277 
1279 
1284 std::vector<SgContinueStmt*> findContinueStmts(SgStatement* code, const std::string& fortranLabel = "");
1285 std::vector<SgGotoStatement*> findGotoStmts(SgStatement* scope, SgLabelStatement* l);
1286 std::vector<SgStatement*> getSwitchCases(SgSwitchStatement* sw);
1287 
1289 void collectVarRefs(SgLocatedNode* root, std::vector<SgVarRefExp* >& result);
1290 
1292 template <typename T>
1293 T* findDeclarationStatement(SgNode* root, std::string name, SgScopeStatement* scope, bool isDefining)
1294  {
1295  bool found = false;
1296 
1297 #if 0
1298  printf ("In findDeclarationStatement(): root = %p \n",root);
1299  printf ("In findDeclarationStatement(): name = %s \n",name.c_str());
1300  printf ("In findDeclarationStatement(): scope = %p \n",scope);
1301  printf ("In findDeclarationStatement(): isDefining = %s \n",isDefining ? "true" : "false");
1302 #endif
1303 
1304  // Do we really want a NULL pointer to be acceptable input to this function?
1305  // Maybe we should have an assertion that it is non-null?
1306  if (!root) return NULL;
1307 
1308  T* decl = dynamic_cast<T*>(root);
1309 
1310 #if 0
1311  printf ("In findDeclarationStatement(): decl = %p \n",decl);
1312 #endif
1313 
1314  if (decl != NULL)
1315  {
1316  if (scope)
1317  {
1318  if ((decl->get_scope() == scope) && (decl->search_for_symbol_from_symbol_table()->get_name() == name))
1319  {
1320  found = true;
1321  }
1322  }
1323  else // Liao 2/9/2010. We should allow NULL scope
1324  {
1325 #if 0
1326  // DQ (12/6/2016): Include this into the debugging code to aboid compiler warning about unused variable.
1327  SgSymbol* symbol = decl->search_for_symbol_from_symbol_table();
1328  printf ("In findDeclarationStatement(): decl->search_for_symbol_from_symbol_table() = %p \n",symbol);
1329  printf ("In findDeclarationStatement(): decl->search_for_symbol_from_symbol_table()->get_name() = %s \n",symbol->get_name().str());
1330 #endif
1331  if (decl->search_for_symbol_from_symbol_table()->get_name() == name)
1332  {
1333  found = true;
1334  }
1335  }
1336  }
1337 
1338  if (found)
1339  {
1340  if (isDefining)
1341  {
1342 #if 0
1343  printf ("In findDeclarationStatement(): decl->get_firstNondefiningDeclaration() = %p \n",decl->get_firstNondefiningDeclaration());
1344  printf ("In findDeclarationStatement(): decl->get_definingDeclaration() = %p \n",decl->get_definingDeclaration());
1345 #endif
1346  ROSE_ASSERT (decl->get_definingDeclaration() != NULL);
1347 #if 0
1348  printf ("In findDeclarationStatement(): returing decl->get_definingDeclaration() = %p \n",decl->get_definingDeclaration());
1349 #endif
1350  return dynamic_cast<T*> (decl->get_definingDeclaration());
1351  }
1352  else
1353  {
1354 #if 0
1355  printf ("In findDeclarationStatement(): returing decl = %p \n",decl);
1356 #endif
1357  return decl;
1358  }
1359  }
1360 
1361  std::vector<SgNode*> children = root->get_traversalSuccessorContainer();
1362 
1363 #if 0
1364  printf ("In findDeclarationStatement(): children.size() = %zu \n",children.size());
1365 #endif
1366 
1367  // DQ (4/10/2016): Note that if we are searching for a function member that has it's defining
1368  // declaration defined outside of the class then it will not be found in the child list.
1369  for (std::vector<SgNode*>::const_iterator i = children.begin(); i != children.end(); ++i)
1370  {
1371  T* target = findDeclarationStatement<T> (*i,name,scope,isDefining);
1372 
1373  if (target)
1374  {
1375  return target;
1376  }
1377  }
1378 
1379  return NULL;
1380  }
1382  SgFunctionDeclaration* findFunctionDeclaration(SgNode* root, std::string name, SgScopeStatement* scope, bool isDefining);
1383 
1384 #if 0 //TODO
1385  // 1. preorder traversal from current SgNode till find next SgNode of type V_SgXXX
1386  // until reach the end node
1387  SgNode* getNextSgNode( const SgNode* astSourceNode, VariantT=V_SgNode, SgNode* astEndNode=NULL);
1388 
1389  // 2. return all nodes of type VariantT following the source node
1390  std::vector<SgNode*> getAllNextSgNode( const SgNode* astSourceNode, VariantT=V_SgNode, SgNode* astEndNode=NULL);
1391 #endif
1392 
1394 
1395 //------------------------------------------------------------------------
1397 
1400 // remember to put const to all arguments.
1401 
1402 
1417 template <typename NodeType>
1418 NodeType* getEnclosingNode(const SgNode* astNode, const bool includingSelf = false)
1419  {
1420 #if 1
1421  // DQ (10/20/2012): This is the older version of this implementation. Until I am sure that
1422  // the newer version (below) is what we want to use I will resolve this conflict by keeping
1423  // the previous version in place.
1424 
1425  if (NULL == astNode)
1426  {
1427  return NULL;
1428  }
1429 
1430  if ( (includingSelf ) && (dynamic_cast<const NodeType*>(astNode)) )
1431  {
1432  return const_cast<NodeType*>(dynamic_cast<const NodeType*> (astNode));
1433  }
1434 
1435  // DQ (3/5/2012): Check for reference to self...
1436  ROSE_ASSERT(astNode->get_parent() != astNode);
1437 
1438  SgNode* parent = astNode->get_parent();
1439 
1440  // DQ (3/5/2012): Check for loops that will cause infinite loops.
1441  SgNode* previouslySeenParent = parent;
1442  bool foundCycle = false;
1443  while ( (foundCycle == false) && (parent != NULL) && (!dynamic_cast<const NodeType*>(parent)) )
1444  {
1445  ROSE_ASSERT(parent->get_parent() != parent);
1446 #if 0
1447  printf ("In getEnclosingNode(): parent = %p = %s \n",parent,parent->class_name().c_str());
1448 #endif
1449  parent = parent->get_parent();
1450 
1451  // DQ (3/5/2012): Check for loops that will cause infinite loops.
1452  // ROSE_ASSERT(parent != previouslySeenParent);
1453  if (parent == previouslySeenParent)
1454  {
1455  foundCycle = true;
1456  }
1457  }
1458 
1459 #if 0
1460  printf ("previouslySeenParent = %p = %s \n",previouslySeenParent,previouslySeenParent->class_name().c_str());
1461 #endif
1462 
1463  parent = previouslySeenParent;
1464 
1465  SgDeclarationStatement* declarationStatement = isSgDeclarationStatement(parent);
1466  if (declarationStatement != NULL)
1467  {
1468 #if 0
1469  printf ("Found a SgDeclarationStatement \n");
1470 #endif
1471  SgDeclarationStatement* definingDeclaration = declarationStatement->get_definingDeclaration();
1472  SgDeclarationStatement* firstNondefiningDeclaration = declarationStatement->get_firstNondefiningDeclaration();
1473 
1474 #if 0
1475  printf (" --- declarationStatement = %p \n",declarationStatement);
1476  printf (" --- definingDeclaration = %p \n",definingDeclaration);
1477  if (definingDeclaration != NULL && definingDeclaration->get_parent() != NULL)
1478  printf (" --- definingDeclaration ->get_parent() = %p = %s \n",definingDeclaration->get_parent(),definingDeclaration->get_parent()->class_name().c_str());
1479  printf (" --- firstNondefiningDeclaration = %p \n",firstNondefiningDeclaration);
1480  if (firstNondefiningDeclaration != NULL && firstNondefiningDeclaration->get_parent() != NULL)
1481  printf (" --- firstNondefiningDeclaration ->get_parent() = %p = %s \n",firstNondefiningDeclaration->get_parent(),firstNondefiningDeclaration->get_parent()->class_name().c_str());
1482 #endif
1483  if (definingDeclaration != NULL && declarationStatement != firstNondefiningDeclaration)
1484  {
1485 #if 0
1486  printf ("Found a nondefining declaration so use the non-defining declaration instead \n");
1487 #endif
1488  // DQ (10/19/2012): Use the defining declaration instead.
1489  // parent = firstNondefiningDeclaration;
1490  parent = definingDeclaration;
1491  }
1492  }
1493 
1494 #if 0
1495  printf ("reset: previouslySeenParent = %p = %s \n",previouslySeenParent,previouslySeenParent->class_name().c_str());
1496 #endif
1497 
1498  // DQ (10/19/2012): This branch is just to document the cycle that was previously detected, it is for
1499  // debugging only. Thus it ony make sense for it to be executed when "(foundCycle == true)". However,
1500  // this will have to be revisited later since it appears clear that it is a problem for the binary analysis
1501  // work when it is visited for this case. Since the cycle is detected, but there is no assertion on the
1502  // cycle, we don't exit when a cycle is identified (which is the point of the code below).
1503  // Note also that I have fixed the code (above and below) to only chase pointers through defining
1504  // declarations (where they exist), this is important since non-defining declarations can be almost
1505  // anywhere (and thus chasing them can make it appear that there are cycles where there are none
1506  // (I think); test2012_234.C demonstrates an example of this.
1507  // DQ (10/9/2012): Robb has suggested this change to fix the binary analysis work.
1508  // if (foundCycle == true)
1509  if (foundCycle == false)
1510  {
1511 
1512 
1513  while ( (parent != NULL) && (!dynamic_cast<const NodeType*>(parent)) )
1514  {
1515  ROSE_ASSERT(parent->get_parent() != parent);
1516 #if 0
1517  printf ("In getEnclosingNode() (2nd try): parent = %p = %s \n",parent,parent->class_name().c_str());
1518  if (parent->get_file_info() != NULL)
1519  parent->get_file_info()->display("In getEnclosingNode() (2nd try): debug");
1520 #endif
1521  SgDeclarationStatement* declarationStatement = isSgDeclarationStatement(parent);
1522  if (declarationStatement != NULL)
1523  {
1524 #if 0
1525  printf ("Found a SgDeclarationStatement \n");
1526 #endif
1527  SgDeclarationStatement* definingDeclaration = declarationStatement->get_definingDeclaration();
1528  SgDeclarationStatement* firstNondefiningDeclaration = declarationStatement->get_firstNondefiningDeclaration();
1529 #if 0
1530  printf (" --- declarationStatement = %p = %s \n",declarationStatement,(declarationStatement != NULL) ? declarationStatement->class_name().c_str() : "null");
1531 
1532  printf (" --- definingDeclaration = %p \n",definingDeclaration);
1533  if (definingDeclaration != NULL && definingDeclaration->get_parent() != NULL)
1534  printf (" --- definingDeclaration ->get_parent() = %p = %s \n",definingDeclaration->get_parent(),definingDeclaration->get_parent()->class_name().c_str());
1535 
1536  printf (" --- firstNondefiningDeclaration = %p \n",firstNondefiningDeclaration);
1537  if (firstNondefiningDeclaration != NULL && firstNondefiningDeclaration->get_parent() != NULL)
1538  printf (" --- firstNondefiningDeclaration ->get_parent() = %p = %s \n",firstNondefiningDeclaration->get_parent(),firstNondefiningDeclaration->get_parent()->class_name().c_str());
1539 #endif
1540  if (definingDeclaration != NULL && declarationStatement != firstNondefiningDeclaration)
1541  {
1542 #if 0
1543  printf ("Found a nondefining declaration so use the firstNondefining declaration instead \n");
1544 #endif
1545  // DQ (10/19/2012): Use the defining declaration instead.
1546  // parent = firstNondefiningDeclaration;
1547  parent = definingDeclaration;
1548  }
1549  }
1550 
1551  parent = parent->get_parent();
1552 
1553 #if 1
1554  // DQ (3/5/2012): Check for loops that will cause infinite loops.
1555  ROSE_ASSERT(parent != previouslySeenParent);
1556 #else
1557  printf ("WARNING::WARNING::WARNING commented out assertion for parent != previouslySeenParent \n");
1558  if (parent == previouslySeenParent)
1559  break;
1560 #endif
1561  }
1562  }
1563 
1564  return const_cast<NodeType*>(dynamic_cast<const NodeType*> (parent));
1565 #else
1566  // DQ (10/20/2012): Using Robb's newer version with my modification to use the definingDeclaration rather than firstNondefiningDeclaration (below).
1567 
1568  // Find the parent of specified type, but watch out for cycles in the ancestry (which would cause an infinite loop).
1569  // Cast away const because isSg* functions aren't defined for const node pointers; and our return is not const.
1570  SgNode *node = const_cast<SgNode*>(!astNode || includingSelf ? astNode : astNode->get_parent());
1571  std::set<const SgNode*> seen; // nodes we've seen, in order to detect cycles
1572  while (node) {
1573  if (NodeType *found = dynamic_cast<NodeType*>(node))
1574  return found;
1575 
1576  // FIXME: Cycle detection could be moved elsewhere so we don't need to do it on every call. [RPM 2012-10-09]
1577  ROSE_ASSERT(seen.insert(node).second);
1578 
1579  // Traverse to parent (declaration statements are a special case)
1580  if (SgDeclarationStatement *declarationStatement = isSgDeclarationStatement(node)) {
1581  SgDeclarationStatement *definingDeclaration = declarationStatement->get_definingDeclaration();
1582  SgDeclarationStatement *firstNondefiningDeclaration = declarationStatement->get_firstNondefiningDeclaration();
1583  if (definingDeclaration && firstNondefiningDeclaration && declarationStatement != firstNondefiningDeclaration) {
1584  // DQ (10/19/2012): Use the defining declaration instead.
1585  // node = firstNondefiningDeclaration;
1586  node = definingDeclaration;
1587  }
1588  } else {
1589  node = node->get_parent();
1590  }
1591  }
1592  return NULL;
1593 #endif
1594  }
1595 
1597  ROSE_DLL_API SgSourceFile* getEnclosingSourceFile(SgNode* n, const bool includingSelf=false);
1598 
1600  ROSE_DLL_API SgScopeStatement* getScope(const SgNode* astNode);
1601 
1603  ROSE_DLL_API SgScopeStatement* getEnclosingScope(SgNode* n, const bool includingSelf=false);
1604 
1606  ROSE_DLL_API SgGlobal* getGlobalScope( const SgNode* astNode);
1607 
1608 
1610  ROSE_DLL_API SgFunctionDefinition* getEnclosingProcedure(SgNode* n, const bool includingSelf=false);
1611 
1612  ROSE_DLL_API SgFunctionDefinition* getEnclosingFunctionDefinition(SgNode* astNode, const bool includingSelf=false);
1613 
1615  ROSE_DLL_API SgStatement* getEnclosingStatement(SgNode* n);
1616 
1619 
1622 
1624  ROSE_DLL_API SgScopeStatement* findEnclosingLoop(SgStatement* s, const std::string& fortranLabel = "", bool stopOnSwitches = false);
1625 
1627  ROSE_DLL_API SgFunctionDeclaration * getEnclosingFunctionDeclaration (SgNode * astNode, const bool includingSelf=false);
1628  //roseSupport/utility_functions.h
1630  ROSE_DLL_API SgFile* getEnclosingFileNode (SgNode* astNode );
1631 
1634 
1636  ROSE_DLL_API SgClassDefinition* getEnclosingClassDefinition(SgNode* astnode, const bool includingSelf=false);
1637 
1639  ROSE_DLL_API SgClassDeclaration* getEnclosingClassDeclaration( SgNode* astNode );
1640 
1641  // DQ (2/7/2019): Adding support for name qualification of variable references associated with SgPointerMemberType function parameters.
1643  ROSE_DLL_API SgExprListExp* getEnclosingExprListExp(SgNode* astNode, const bool includingSelf = false);
1644 
1645  // DQ (2/7/2019): Need a function to return when an expression is in an expression subtree.
1646  // This is part of index evaluation ofr expressions in function argument lists, but likely usefule elsewhere as well.
1647  ROSE_DLL_API bool isInSubTree(SgExpression* subtree, SgExpression* exp);
1648 
1649  // DQ (2/7/2019): Need a function to return the SgFunctionDeclaration from a SgFunctionCallExp.
1650  ROSE_DLL_API SgFunctionDeclaration* getFunctionDeclaration ( SgFunctionCallExp* functionCallExp );
1651 
1652  // DQ (2/17/2019): Generalizing this support for SgVarRefExp and SgMemberFunctionRefExp nodes.
1653  // DQ (2/8/2019): Adding support for detecting when to use added name qualification for pointer-to-member expressions.
1654  ROSE_DLL_API bool isDataMemberReference(SgVarRefExp* varRefExp);
1655  // ROSE_DLL_API bool isAddressTaken(SgVarRefExp* varRefExp);
1656  ROSE_DLL_API bool isAddressTaken(SgExpression* refExp);
1657 
1658  // DQ (2/17/2019): Adding support for detecting when to use added name qualification for membr function references.
1659  ROSE_DLL_API bool isMemberFunctionMemberReference(SgMemberFunctionRefExp* memberFunctionRefExp);
1660 
1661  // DQ (2/15/2019): Adding support for detecting which class a member reference is being made from.
1662  // ROSE_DLL_API SgClassType* getClassTypeForDataMemberReference(SgVarRefExp* varRefExp);
1663  // ROSE_DLL_API std::list<SgClassType*> getClassTypeChainForDataMemberReference(SgVarRefExp* varRefExp);
1664  ROSE_DLL_API std::list<SgClassType*> getClassTypeChainForMemberReference(SgExpression* refExp);
1665 
1666 
1667  // DQ (2/17/2019): Display the shared nodes in the AST for debugging.
1668  ROSE_DLL_API void outputSharedNodes( SgNode* node );
1669 
1670 
1671 // TODO
1672 #if 0
1673  SgNode * getEnclosingSgNode(SgNode* source,VariantT, SgNode* endNode=NULL);
1674  std::vector<SgNode *> getAllEnclosingSgNode(SgNode* source,VariantT, SgNode* endNode=NULL);
1675  SgVariableDeclaration* findVariableDeclaratin( const string& varname)
1676 
1678 
1679  // e.g. for some expression, find its parent statement
1680  SgStatement* getEnclosingStatement(const SgNode* astNode);
1681 
1682  SgSwitchStatement* getEnclosingSwitch(SgStatement* s);
1683  SgModuleStatement* getEnclosingModuleStatement( const SgNode* astNode);
1684 
1685  // used to build a variable reference for compiler generated code in current scope
1686  SgSymbol * findReachingDefinition (SgScopeStatement* startScope, SgName &name);
1687 #endif
1688 
1689 
1690 //------------------------------------------------------------------------
1692 
1695  // Liao, 1/9/2008
1699  ROSE_DLL_API SgGlobal * getFirstGlobalScope(SgProject *project);
1700 
1704  ROSE_DLL_API SgStatement* getLastStatement(SgScopeStatement *scope);
1705 
1707  ROSE_DLL_API SgStatement* getFirstStatement(SgScopeStatement *scope,bool includingCompilerGenerated=false);
1710 
1712  ROSE_DLL_API SgStatement* getNextStatement(SgStatement * currentStmt);
1713 
1715  ROSE_DLL_API SgStatement* getPreviousStatement(SgStatement * currentStmt, bool climbOutScope = true);
1716 #if 0 //TODO
1717  // preorder traversal from current SgNode till find next SgNode of type V_SgXXX
1718  SgNode* getNextSgNode( const SgNode* currentNode, VariantT=V_SgNode);
1719 #endif
1720 
1721  // DQ (11/15/2018): Adding support for traversals over the include file tree.
1723  void listHeaderFiles ( SgIncludeFile* includeFile );
1724 
1725 
1727 
1728 //------------------------------------------------------------------------
1730 
1733  ROSE_DLL_API bool isEqualToIntConst(SgExpression* e, int value);
1735 
1737 
1740  ROSE_DLL_API bool isSameFunction(SgFunctionDeclaration* func1, SgFunctionDeclaration* func2);
1741 
1743  ROSE_DLL_API bool isLastStatement(SgStatement* stmt);
1744 
1746 
1747 //------------------------------------------------------------------------
1749 
1755 // DQ (2/24/2009): Simple function to delete an AST subtree (used in outlining).
1757 ROSE_DLL_API void deleteAST(SgNode* node);
1758 
1761 
1762 // DQ (2/25/2009): Added new function to support outliner.
1764 ROSE_DLL_API void moveStatementsBetweenBlocks ( SgBasicBlock* sourceBlock, SgBasicBlock* targetBlock );
1765 
1767 ROSE_DLL_API void moveVariableDeclaration(SgVariableDeclaration* decl, SgScopeStatement* target_scope);
1769 ROSE_DLL_API void appendStatement(SgStatement *stmt, SgScopeStatement* scope=NULL);
1770 
1772 ROSE_DLL_API void appendStatement(SgStatement *stmt, SgForInitStatement* for_init_stmt);
1773 
1775 ROSE_DLL_API void appendStatementList(const std::vector<SgStatement*>& stmt, SgScopeStatement* scope=NULL);
1776 
1777 // DQ (2/6/2009): Added function to support outlining into separate file.
1779 ROSE_DLL_API void appendStatementWithDependentDeclaration( SgDeclarationStatement* decl, SgGlobal* scope, SgStatement* original_statement, bool excludeHeaderFiles );
1780 
1783 ROSE_DLL_API void prependStatement(SgStatement *stmt, SgScopeStatement* scope=NULL);
1784 
1786 ROSE_DLL_API void prependStatement(SgStatement *stmt, SgForInitStatement* for_init_stmt);
1787 
1790 ROSE_DLL_API void prependStatementList(const std::vector<SgStatement*>& stmt, SgScopeStatement* scope=NULL);
1791 
1795 ROSE_DLL_API bool hasSimpleChildrenList (SgScopeStatement* scope);
1796 
1798 ROSE_DLL_API void insertStatement(SgStatement *targetStmt, SgStatement* newStmt, bool insertBefore= true, bool autoMovePreprocessingInfo = true);
1799 
1801 //target's scope
1802 ROSE_DLL_API void insertStatementList(SgStatement *targetStmt, const std::vector<SgStatement*>& newStmts, bool insertBefore= true);
1803 
1805 ROSE_DLL_API void insertStatementBefore(SgStatement *targetStmt, SgStatement* newStmt, bool autoMovePreprocessingInfo = true);
1806 
1808 ROSE_DLL_API void insertStatementListBefore(SgStatement *targetStmt, const std::vector<SgStatement*>& newStmts);
1809 
1811 ROSE_DLL_API void insertStatementAfter(SgStatement *targetStmt, SgStatement* newStmt, bool autoMovePreprocessingInfo = true);
1812 
1814 ROSE_DLL_API void insertStatementListAfter(SgStatement *targetStmt, const std::vector<SgStatement*>& newStmt);
1815 
1817 ROSE_DLL_API void insertStatementAfterLastDeclaration(SgStatement* stmt, SgScopeStatement* scope);
1818 
1820 ROSE_DLL_API void insertStatementAfterLastDeclaration(std::vector<SgStatement*> stmt_list, SgScopeStatement* scope);
1821 
1823 // then the statement is inserted at the end of the scope.
1824 ROSE_DLL_API void insertStatementBeforeFirstNonDeclaration(SgStatement *newStmt, SgScopeStatement *scope,
1825  bool movePreprocessingInfo=true);
1826 
1828 //then the new statements are inserted at the end of the scope.
1829 ROSE_DLL_API void insertStatementListBeforeFirstNonDeclaration(const std::vector<SgStatement*> &newStmts, SgScopeStatement *scope);
1830 
1831 // DQ (11/21/2018): We need to sometimes insert something after the last statement of the collection from rose_edg_required_macros_and_functions.h.
1832 ROSE_DLL_API SgStatement* lastFrontEndSpecificStatement( SgGlobal* globalScope );
1833 
1835 ROSE_DLL_API void removeStatement(SgStatement* stmt, bool autoRelocatePreprocessingInfo = true);
1836 
1838 ROSE_DLL_API void deepDelete(SgNode* root);
1839 
1841 ROSE_DLL_API void replaceStatement(SgStatement* oldStmt, SgStatement* newStmt, bool movePreprocessinInfo = false);
1842 
1844 ROSE_DLL_API SgNode* replaceWithPattern (SgNode * anchor, SgNode* new_pattern);
1845 
1847 // Essentially replace variable a with b.
1848 ROSE_DLL_API void replaceVariableReferences(SgVariableSymbol* old_sym, SgVariableSymbol* new_sym, SgScopeStatement * scope );
1849 
1850 // DQ (11/12/2018): Adding test to avoid issues that we can't test for in the unparsing of header files using the token based unparsing.
1854 ROSE_DLL_API bool statementCanBeTransformed(SgStatement* stmt);
1855 
1856 
1867 std::pair<SgVariableDeclaration*, SgExpression* > createTempVariableForExpression(SgExpression* expression,
1868  SgScopeStatement* scope, bool initializeInDeclaration, SgAssignOp** reEvaluate = NULL);
1869 
1870 /* This function creates a temporary variable for a given expression in the given scope
1871  This is different from SageInterface::createTempVariableForExpression in that it does not
1872  try to be smart to create pointers to reference types and so on. The tempt is initialized to expression.
1873  The caller is responsible for setting the parent of SgVariableDeclaration since buildVariableDeclaration
1874  may not set_parent() when the scope stack is empty. See programTransformation/extractFunctionArgumentsNormalization/ExtractFunctionArguments.C for sample usage.
1875  @param expression Expression which will be replaced by a variable
1876  @param scope scope in which the temporary variable will be generated
1877 */
1878 
1879 std::pair<SgVariableDeclaration*, SgExpression*> createTempVariableAndReferenceForExpression
1880  (SgExpression* expression, SgScopeStatement* scope);
1881 
1883 
1890 
1892 ROSE_DLL_API void appendExpression(SgExprListExp *, SgExpression*);
1893 
1895 ROSE_DLL_API void appendExpressionList(SgExprListExp *, const std::vector<SgExpression*>&);
1896 
1898 template <class actualFunction>
1899 void setParameterList(actualFunction *func,SgFunctionParameterList *paralist) {
1900 
1901  // TODO consider the difference between C++ and Fortran
1902  // fixup the scope of arguments,no symbols for nondefining function declaration's arguments
1903 
1904  // DQ (11/25/2011): templated function so that we can handle both
1905  // SgFunctionDeclaration and SgTemplateFunctionDeclaration (and their associated member
1906  // function derived classes).
1907 
1908  ROSE_ASSERT(func != NULL);
1909  ROSE_ASSERT(paralist != NULL);
1910 
1911 #if 0
1912  // At this point we don't have cerr and endl defined, so comment this code out.
1913  // Warn to users if a paralist is being shared
1914  if (paralist->get_parent() !=NULL)
1915  {
1916  cerr << "Waring! Setting a used SgFunctionParameterList to function: "
1917  << (func->get_name()).getString()<<endl
1918  << " Sharing parameter lists can corrupt symbol tables!"<<endl
1919  << " Please use deepCopy() to get an exclusive parameter list for each function declaration!"<<endl;
1920  // ROSE_ASSERT(false);
1921  }
1922 #endif
1923 
1924  // Liao,2/5/2008 constructor of SgFunctionDeclaration will automatically generate SgFunctionParameterList, so be cautious when set new paralist!!
1925  if (func->get_parameterList() != NULL)
1926  {
1927  if (func->get_parameterList() != paralist)
1928  {
1929  delete func->get_parameterList();
1930  }
1931  }
1932 
1933  func->set_parameterList(paralist);
1934  paralist->set_parent(func);
1935 
1936  // DQ (5/15/2012): Need to set the declptr in each SgInitializedName IR node.
1937  // This is needed to support the AST Copy mechanism (at least). The files: test2005_150.C,
1938  // test2012_81.C and testcode2012_82.C demonstrate this problem.
1939  SgInitializedNamePtrList & args = paralist->get_args();
1940  for (SgInitializedNamePtrList::iterator i = args.begin(); i != args.end(); i++)
1941  {
1942  (*i)->set_declptr(func);
1943  }
1944  }
1945 
1947 ROSE_DLL_API void setPragma(SgPragmaDeclaration* decl, SgPragma *pragma);
1948 
1950 ROSE_DLL_API void replaceExpression(SgExpression* oldExp, SgExpression* newExp, bool keepOldExp=false);
1951 
1953 ROSE_DLL_API void replaceExpressionWithStatement(SgExpression* from,
1957 ROSE_DLL_API void replaceSubexpressionWithStatement(SgExpression* from,
1959 
1961 ROSE_DLL_API void setOperand(SgExpression* target, SgExpression* operand);
1962 
1964 ROSE_DLL_API void setLhsOperand(SgExpression* target, SgExpression* lhs);
1965 
1967 ROSE_DLL_API void setRhsOperand(SgExpression* target, SgExpression* rhs);
1968 
1970 ROSE_DLL_API void removeAllOriginalExpressionTrees(SgNode* top);
1971 
1972 // DQ (1/25/2010): Added support for directories
1974 ROSE_DLL_API void moveToSubdirectory ( std::string directoryName, SgFile* file );
1975 
1977 ROSE_DLL_API SgStatement* findSurroundingStatementFromSameFile(SgStatement* targetStmt, bool & surroundingStatementPreceedsTargetStatement);
1978 
1980 ROSE_DLL_API void moveCommentsToNewStatement(SgStatement* sourceStatement, const std::vector<int> & indexList, SgStatement* targetStatement, bool surroundingStatementPreceedsTargetStatement);
1981 
1982 // DQ (7/19/2015): This is required to support general unparsing of template instantations for the GNU g++
1983 // compiler which does not permit name qualification to be used to support the expression of the namespace
1984 // where a template instantiatoon would be places. Such name qualification would also sometimes require
1985 // global qualification which is also not allowed by the GNU g++ compiler. These issues appear to be
1986 // specific to the GNU compiler versions, at least versions 4.4 through 4.8.
1988 ROSE_DLL_API void moveDeclarationToAssociatedNamespace ( SgDeclarationStatement* declarationStatement );
1989 
1990 ROSE_DLL_API bool isTemplateInstantiationNode(SgNode* node);
1991 
1993 
1994 // DQ (12/1/2015): Adding support for fixup internal data struuctures that have references to statements (e.g. macro expansions).
1995 ROSE_DLL_API void resetInternalMapsForTargetStatement(SgStatement* sourceStatement);
1996 
1997 // DQ (6/7/2019): Add support for transforming function definitions to function prototypes in a subtree.
1998 // We might have to make this specific to a file (only traversing the functions in that file).
2000 
2001 
2003 //------------------------------------------------------------------------
2005 
2012 
2018 ROSE_DLL_API int fixVariableReferences(SgNode* root, bool cleanUnusedSymbol=true);
2019 
2021 
2025 ROSE_DLL_API void fixVariableDeclaration(SgVariableDeclaration* varDecl, SgScopeStatement* scope);
2026 
2028 ROSE_DLL_API void fixStructDeclaration(SgClassDeclaration* structDecl, SgScopeStatement* scope);
2030 ROSE_DLL_API void fixClassDeclaration(SgClassDeclaration* classDecl, SgScopeStatement* scope);
2031 
2033 ROSE_DLL_API void fixNamespaceDeclaration(SgNamespaceDeclarationStatement* structDecl, SgScopeStatement* scope);
2034 
2035 
2037 ROSE_DLL_API void fixLabelStatement(SgLabelStatement* label_stmt, SgScopeStatement* scope);
2038 
2040 ROSE_DLL_API void setFortranNumericLabel(SgStatement* stmt, int label_value);
2041 
2043 ROSE_DLL_API int suggestNextNumericLabel(SgFunctionDefinition* func_def);
2044 
2046 ROSE_DLL_API void fixFunctionDeclaration(SgFunctionDeclaration* stmt, SgScopeStatement* scope);
2047 
2049 ROSE_DLL_API void fixTemplateDeclaration(SgTemplateDeclaration* stmt, SgScopeStatement* scope);
2050 
2052 ROSE_DLL_API void fixStatement(SgStatement* stmt, SgScopeStatement* scope);
2053 
2054 // DQ (6/11/2015): This reports the statements that are marked as transformed (used to debug the token-based unparsing).
2056 ROSE_DLL_API std::set<SgStatement*> collectTransformedStatements( SgNode* node );
2057 
2059 ROSE_DLL_API std::set<SgStatement*> collectModifiedStatements( SgNode* node );
2060 
2062 ROSE_DLL_API std::set<SgLocatedNode*> collectModifiedLocatedNodes( SgNode* node );
2063 
2064 // DQ (6/5/2019): Use the previously constructed set (above) to reset the IR nodes to be marked as isModified.
2066 ROSE_DLL_API void resetModifiedLocatedNodes(const std::set<SgLocatedNode*> & modifiedNodeSet);
2067 
2068 
2069 // DQ (10/23/2018): Report nodes that are marked as modified.
2070 ROSE_DLL_API void reportModifiedStatements(const std::string & label, SgNode* node);
2071 
2072 // DQ (3/22/2019): Translate CPP directives from attached preprocessor information to CPP Directive Declaration IR nodes.
2073 ROSE_DLL_API void translateToUseCppDeclarations( SgNode* n );
2074 
2075 ROSE_DLL_API void translateScopeToUseCppDeclarations( SgScopeStatement* scope );
2076 
2077 ROSE_DLL_API std::vector<SgC_PreprocessorDirectiveStatement*> translateStatementToUseCppDeclarations( SgStatement* statement, SgScopeStatement* scope);
2078 ROSE_DLL_API void printOutComments ( SgLocatedNode* locatedNode );
2079 ROSE_DLL_API bool skipTranslateToUseCppDeclaration( PreprocessingInfo* currentPreprocessingInfo );
2080 
2081 
2083 
2085 
2091 
2092 //------------------------------------------------------------------------
2094 
2098 ROSE_DLL_API bool
2100 collectReadWriteRefs(SgStatement* stmt, std::vector<SgNode*>& readRefs, std::vector<SgNode*>& writeRefs, bool useCachedDefUse=false);
2101 
2103 ROSE_DLL_API bool collectReadWriteVariables(SgStatement* stmt, std::set<SgInitializedName*>& readVars, std::set<SgInitializedName*>& writeVars, bool coarseGrain=true);
2104 
2106 ROSE_DLL_API void collectReadOnlyVariables(SgStatement* stmt, std::set<SgInitializedName*>& readOnlyVars, bool coarseGrain=true);
2107 
2109 ROSE_DLL_API void collectReadOnlySymbols(SgStatement* stmt, std::set<SgVariableSymbol*>& readOnlySymbols, bool coarseGrain=true);
2110 
2112 ROSE_DLL_API bool isUseByAddressVariableRef(SgVarRefExp* ref);
2113 
2115 ROSE_DLL_API void collectUseByAddressVariableRefs (const SgStatement* s, std::set<SgVarRefExp* >& varSetB);
2116 
2117 #ifndef ROSE_USE_INTERNAL_FRONTEND_DEVELOPMENT
2118 ROSE_DLL_API LivenessAnalysis * call_liveness_analysis(SgProject* project, bool debug=false);
2120 
2122 ROSE_DLL_API void getLiveVariables(LivenessAnalysis * liv, SgForStatement* loop, std::set<SgInitializedName*>& liveIns, std::set<SgInitializedName*> & liveOuts);
2123 #endif
2124 
2126 ROSE_DLL_API void ReductionRecognition(SgForStatement* loop, std::set< std::pair <SgInitializedName*, OmpSupport::omp_construct_enum> > & results);
2127 
2129 
2130 ROSE_DLL_API void constantFolding(SgNode* r);
2131 
2133 
2135 ROSE_DLL_API int instrumentEndOfFunction(SgFunctionDeclaration * func, SgStatement* s);
2136 
2138 ROSE_DLL_API void removeJumpsToNextStatement(SgNode*);
2139 
2141 ROSE_DLL_API void removeUnusedLabels(SgNode* top);
2142 
2144 ROSE_DLL_API void removeConsecutiveLabels(SgNode* top);
2145 
2147 
2153 ROSE_DLL_API bool mergeDeclarationAndAssignment (SgVariableDeclaration* decl, SgExprStatement* assign_stmt, bool removeAssignStmt = true);
2154 
2155 
2157 ROSE_DLL_API bool mergeAssignmentWithDeclaration (SgExprStatement* assign_stmt, SgVariableDeclaration* decl, bool removeAssignStmt = true);
2158 
2160 
2163 ROSE_DLL_API bool mergeDeclarationWithAssignment (SgVariableDeclaration* decl, SgExprStatement* assign_stmt);
2164 
2166 
2171 
2173 ROSE_DLL_API int splitVariableDeclaration (SgScopeStatement* scope, bool topLevelOnly = true);
2174 
2176 
2183  ROSE_DLL_API SgAssignInitializer* splitExpression(SgExpression* from, std::string newName = "");
2184 
2186 ROSE_DLL_API void splitExpressionIntoBasicBlock(SgExpression* expr);
2187 
2189 ROSE_DLL_API void removeLabeledGotos(SgNode* top);
2190 
2192 ROSE_DLL_API void changeBreakStatementsToGotos(SgStatement* loopOrSwitch);
2193 
2196 
2199 
2202 
2205 
2208 
2211 
2214 
2217 
2219 ROSE_DLL_API SgBasicBlock* ensureBasicBlockAsFalseBodyOfIf(SgIfStmt* ifs, bool createEmptyBody = true);
2220 
2223 
2226 
2227 // DQ (1/18/2015): This is added to support better quality token-based unparsing.
2229 ROSE_DLL_API void cleanupNontransformedBasicBlockNode();
2230 
2231 // DQ (1/18/2015): This is added to support better quality token-based unparsing.
2233 ROSE_DLL_API void recordNormalizations(SgStatement* s);
2234 
2237 bool isBodyStatement (SgStatement* s);
2238 
2240 void changeAllBodiesToBlocks(SgNode* top, bool createEmptyBody = true);
2241 
2242 // The same as changeAllBodiesToBlocks(SgNode* top). Phased out.
2243 //void changeAllLoopBodiesToBlocks(SgNode* top);
2244 
2247 
2248 #if 0
2249 
2252 SgLocatedNode* ensureBasicBlockAsParent(SgStatement* s);
2253 #endif
2254 
2257 unsigned long long getIntegerConstantValue(SgValueExp* expr);
2258 
2260 std::vector<SgDeclarationStatement*> getDependentDeclarations (SgStatement* stmt );
2261 
2262 
2265 
2267 SgCommaOpExp *insertAfterUsingCommaOp (SgExpression* new_exp, SgExpression* anchor_exp, SgStatement** temp_decl = NULL, SgVarRefExp** temp_ref = NULL);
2268 
2269 
2299 std::pair<SgStatement*, SgInitializedName*>
2300 wrapFunction(SgFunctionDeclaration& definingDeclaration, SgName newName);
2301 
2307 template <class NameGen>
2308 std::pair<SgStatement*, SgInitializedName*>
2309 wrapFunction(SgFunctionDeclaration& definingDeclaration, NameGen nameGen)
2310 {
2311  return wrapFunction(definingDeclaration, nameGen(definingDeclaration.get_name()));
2312 }
2313 
2317 
2318 
2320 
2321 // DQ (6/7/2012): Unclear where this function should go...
2322  bool hasTemplateSyntax( const SgName & name );
2323 
2324 #if 0
2325 
2326 //------------------------AST dump, stringify-----------------------------
2327 //------------------------------------------------------------------------
2328  std::string buildOperatorString ( SgNode* astNode ); //transformationSupport.h
2329 
2330  // do we need these?
2331  std::string dump_node(const SgNode* astNode);
2332  std::string dump_tree(const SgNode* astNode);
2333 
2334  // or a friendly version of unparseToString(), as a memeber function
2335  std::string SgNode::toString(bool asSubTree=true); // dump node or subtree
2336 
2337 //----------------------------AST comparison------------------------------
2338 //------------------------------------------------------------------------
2339 // How to get generic functions for comparison?
2340  bool isNodeEqual(SgNode* node1, SgNode* node2); //?
2341  bool isTreeEqual(SgNode* tree1, SgNode* tree2);
2342 
2344  bool expressionTreeEqual(SgExpression*, SgExpression*);
2346  bool expressionTreeEqualStar(const SgExpressionPtrList&,
2347  const SgExpressionPtrList&);
2348 
2349 //----------------------AST verfication/repair----------------------------
2350 //------------------------------------------------------------------------
2351 // sanity check of AST subtree, any suggestions?
2352 // TODO
2353  verifySgNode(SgNode* node, bool subTree=true);
2354  //src/midend/astDiagnostics/AstConsistencyTests.h
2355  // AstTests::runAllTests(SgProject * )
2356 
2357  //src/midend/astUtil/astInterface/AstInterface.h.C
2358  //FixSgProject(SgProject &project)
2359  //FixSgTree(SgNode* r)
2360 
2361  //src/frontend/SageIII/astPostProcessing
2362  //AstPostProcessing(SgNode * node)
2363 
2364 //--------------------------AST modification------------------------------
2365 //------------------------------------------------------------------------
2366 // any operations changing AST tree, including
2367 // insert, copy, delete(remove), replace
2368 
2369  // insert before or after some point, argument list is consistent with LowLevelRewrite
2370  void insertAst(SgNode* targetPosition, SgNode* newNode, bool insertBefore=true);
2371 
2372  // previous examples
2373  //void myStatementInsert(SgStatement* target,...)
2374  // void AstInterfaceBase::InsertStmt(AstNodePtr const & orig, AstNodePtr const &n, bool insertbefore, bool extractfromBasicBlock)
2375 
2376  // copy
2377  // copy children of one basic block to another basic block
2378  //void appendStatementCopy (const SgBasicBlock* a, SgBasicBlock* b);
2379  void copyStatements (const SgBasicBlock* src, SgBasicBlock* dst);
2380 
2381  // delete (remove) a node or a whole subtree
2382  void removeSgNode(SgNode* targetNode); // need this?
2383  void removeSgNodeTree(SgNode* subtree); // need this?
2384 
2385  void removeStatement( SgStatement* targetStmt);
2386 
2387  //Move = delete + insert
2388  void moveAst (SgNode* src, SgNode* target); // need this?
2389  // similar to
2390  void moveStatements (SgBasicBlock* src, SgBasicBlock* target);
2391 
2392  // replace= delete old + insert new (via building or copying)
2393 
2394 // DQ (1/25/2010): This does not appear to exist as a definition anywhere in ROSE.
2395 // void replaceAst(SgNode* oldNode, SgNode* newNode);
2396 
2397  //void replaceChild(SgNode* parent, SgNode* from, SgNode* to);
2398  //bool AstInterface::ReplaceAst( const AstNodePtr& orig, const AstNodePtr& n)
2399 
2400 //--------------------------AST transformations---------------------------
2401 //------------------------------------------------------------------------
2402 // Advanced AST modifications through basic AST modifications
2403 // Might not be included in AST utitlity list, but listed here for the record.
2404 
2405  // extract statements/content from a scope
2406  void flattenBlocks(SgNode* n);
2407 
2408  //src/midend/astInlining/inlinerSupport.h
2409  void renameVariables(SgNode* n);
2410  void renameLabels(SgNode* n, SgFunctionDefinition* enclosingFunctionDefinition);
2411 
2412  void simpleCopyAndConstantPropagation(SgNode* top);
2413  void changeAllMembersToPublic(SgNode* n);
2414 
2415  void removeVariableDeclaration(SgInitializedName* initname);
2416 
2418  SgAssignOp* convertInitializerIntoAssignment(SgAssignInitializer* init);
2419 
2424  void pushTestIntoBody(LoopStatement* loopStmt);
2425 
2426  //programTransformation/finiteDifferencing/finiteDifferencing.h
2428  void moveForDeclaredVariables(SgNode* root);
2429 
2430 //------------------------ Is/Has functions ------------------------------
2431 //------------------------------------------------------------------------
2432 // misc. boolean functions
2433 // some of them could moved to SgXXX class as a member function
2434 
2435  bool isOverloaded (SgFunctionDeclaration * functionDeclaration);
2436 
2437  bool isSwitchCond (const SgStatement* s);
2438  bool isIfCond (const SgStatement* s);
2439  bool isWhileCond (const SgStatement* s);
2440  bool isStdNamespace (const SgScopeStatement* scope);
2441  bool isTemplateInst (const SgDeclarationStatement* decl);
2442 
2443 
2444  bool isCtor (const SgFunctionDeclaration* func);
2445  bool isDtor (const SgFunctionDeclaration* func);
2446 
2447  // src/midend/astInlining/typeTraits.h
2448  bool hasTrivialDestructor(SgType* t);
2449  ROSE_DLL_API bool isNonconstReference(SgType* t);
2450  ROSE_DLL_API bool isReferenceType(SgType* t);
2451 
2452  // generic ones, or move to the SgXXX class as a member function
2453 
2454  bool isConst(SgNode* node); // const type, variable, function, etc.
2455  // .... and more
2456 
2457  bool isConstType (const SgType* type);
2458  bool isConstFunction (const SgFunctionDeclaration* decl);
2459 
2460 
2461  bool isMemberVariable(const SgInitializedName & var);
2462  //bool isMemberVariable(const SgNode& in);
2463 
2464  bool isPrototypeInScope (SgScopeStatement * scope,
2465  SgFunctionDeclaration * functionDeclaration,
2466  SgDeclarationStatement * startingAtDeclaration);
2467 
2468  bool MayRedefined(SgExpression* expr, SgNode* root);
2469  // bool isPotentiallyModified(SgExpression* expr, SgNode* root); // inlinderSupport.h
2470  bool hasAddressTaken(SgExpression* expr, SgNode* root);
2471 
2472  //src/midend/astInlining/inlinerSupport.C
2473  // can also classified as topdown search
2474  bool containsVariableReference(SgNode* root, SgInitializedName* var);
2475 
2476  bool isDeclarationOf(SgVariableDeclaration* decl, SgInitializedName* var);
2477  bool isPotentiallyModifiedDuringLifeOf(SgBasicBlock* sc,
2478  SgInitializedName* toCheck,
2479  SgInitializedName* lifetime)
2480  //src/midend/programTransformation/partialRedundancyElimination/pre.h
2481  bool anyOfListPotentiallyModifiedIn(const std::vector<SgVariableSymbol*>& syms, SgNode* n);
2482 
2483 //------------------------ loop handling ---------------------------------
2484 //------------------------------------------------------------------------
2485  //get and set loop control expressions
2486  // 0: init expr, 1: condition expr, 2: stride expr
2487 
2488  SgExpression* getForLoopTripleValues(int valuetype,SgForStatement* forstmt );
2489  int setForLoopTripleValues(int valuetype,SgForStatement* forstmt, SgExpression* exp);
2490 
2491  bool isLoopIndexVarRef(SgForStatement* forstmt, SgVarRefExp *varref);
2492  SgInitializedName * getLoopIndexVar(SgForStatement* forstmt);
2493 
2494 //------------------------expressions-------------------------------------
2495 //------------------------------------------------------------------------
2496  //src/midend/programTransformation/partialRedundancyElimination/pre.h
2497  int countComputationsOfExpressionIn(SgExpression* expr, SgNode* root);
2498 
2499  //src/midend/astInlining/replaceExpressionWithStatement.h
2500  void replaceAssignmentStmtWithStatement(SgExprStatement* from, StatementGenerator* to);
2501 
2503  StatementGenerator* to);
2504  SgExpression* getRootOfExpression(SgExpression* n);
2505 
2506 //--------------------------preprocessing info. -------------------------
2507 //------------------------------------------------------------------------
2509  void cutPreprocInfo (SgBasicBlock* b,
2511  AttachedPreprocessingInfoType& save_buf);
2513  void pastePreprocInfoFront (AttachedPreprocessingInfoType& save_buf,
2514  SgStatement* s);
2516  void pastePreprocInfoBack (AttachedPreprocessingInfoType& save_buf,
2517  SgStatement* s);
2518 
2524  // a generic one for all
2526  void moveBeforePreprocInfo (SgStatement* src, SgStatement* dest);
2527  void moveInsidePreprocInfo (SgBasicBlock* src, SgBasicBlock* dest);
2528  void moveAfterPreprocInfo (SgStatement* src, SgStatement* dest);
2529 
2530 //--------------------------------operator--------------------------------
2531 //------------------------------------------------------------------------
2532  from transformationSupport.h, not sure if they should be included here
2533  /* return enum code for SAGE operators */
2534  operatorCodeType classifyOverloadedOperator(); // transformationSupport.h
2535 
2541  std::string stringifyOperator (std::string name);
2542 
2543 //--------------------------------macro ----------------------------------
2544 //------------------------------------------------------------------------
2545  std::string buildMacro ( std::string s ); //transformationSupport.h
2546 
2547 //--------------------------------access functions---------------------------
2548 //----------------------------------get/set sth.-----------------------------
2549 // several categories:
2550 * get/set a direct child/grandchild node or fields
2551 * get/set a property flag value
2552 * get a descendent child node using preorder searching
2553 * get an ancestor node using bottomup/reverse searching
2554 
2555  // SgName or string?
2556  std::string getFunctionName (SgFunctionCallExp* functionCallExp);
2557  std::string getFunctionTypeName ( SgFunctionCallExp* functionCallExpression );
2558 
2559  // do we need them anymore? or existing member functions are enought?
2560  // a generic one:
2561  std::string get_name (const SgNode* node);
2562  std::string get_name (const SgDeclarationStatement * declaration);
2563 
2564  // get/set some property: should moved to SgXXX as an inherent memeber function?
2565  // access modifier
2566  void setExtern (SgFunctionDeclartion*)
2567  void clearExtern()
2568 
2569  // similarly for other declarations and other properties
2571  void setPublic()
2572  void setPrivate()
2573 
2574 #endif
2575 
2576 // DQ (1/23/2013): Added support for generated a set of source sequence entries.
2577  std::set<unsigned int> collectSourceSequenceNumbers( SgNode* astNode );
2578 
2579 //--------------------------------Type Traits (C++)---------------------------
2580  bool HasNoThrowAssign(const SgType * const inputType);
2581  bool HasNoThrowCopy(const SgType * const inputType);
2582  bool HasNoThrowConstructor(const SgType * const inputType);
2583  bool HasTrivialAssign(const SgType * const inputType);
2584  bool HasTrivialCopy(const SgType * const inputType);
2585  bool HasTrivialConstructor(const SgType * const inputType);
2586  bool HasTrivialDestructor(const SgType * const inputType);
2587  bool HasVirtualDestructor(const SgType * const inputType);
2588  bool IsBaseOf(const SgType * const inputBaseType, const SgType * const inputDerivedType);
2589  bool IsAbstract(const SgType * const inputType);
2590  bool IsClass(const SgType * const inputType);
2591  bool IsEmpty(const SgType * const inputType);
2592  bool IsEnum(const SgType * const inputType);
2593  bool IsPod(const SgType * const inputType);
2594  bool IsPolymorphic(const SgType * const inputType);
2595  bool IsStandardLayout(const SgType * const inputType);
2596  bool IsLiteralType(const SgType * const inputType);
2597  bool IsTrivial(const SgType * const inputType);
2598  bool IsUnion(const SgType * const inputType);
2599  SgType * UnderlyingType(SgType *type);
2600 
2601 // DQ (3/2/2014): Added a new interface function (used in the snippet insertion support).
2602 // void supportForInitializedNameLists ( SgScopeStatement* scope, SgInitializedNamePtrList & variableList );
2603 
2604 // DQ (3/4/2014): Added support for testing two trees for equivalents using the AST iterators.
2605  bool isStructurallyEquivalentAST( SgNode* tree1, SgNode* tree2 );
2606 
2607 // JP (10/14/24): Moved code to evaluate a const integer expression (like in array size definitions) to SageInterface
2610  size_t value_;
2611  bool hasValue_;
2612  };
2615 
2616 // JP (9/17/14): Added function to test whether two SgType* are equivalent or not
2617  bool checkTypesAreEqual(SgType *typeA, SgType *typeB);
2618 
2619 //--------------------------------Java interface functions ---------------------
2620 #ifdef ROSE_BUILD_JAVA_LANGUAGE_SUPPORT
2621  ROSE_DLL_API std::string getTempDirectory(SgProject *project);
2622  ROSE_DLL_API void destroyTempDirectory(std::string);
2623  ROSE_DLL_API SgFile *processFile(SgProject *, std::string, bool unparse = false);
2624  ROSE_DLL_API std::string preprocessPackage(SgProject *, std::string);
2625  ROSE_DLL_API std::string preprocessImport(SgProject *, std::string);
2626  ROSE_DLL_API SgFile* preprocessCompilationUnit(SgProject *, std::string, std::string, bool unparse = true);
2627  ROSE_DLL_API SgClassDefinition *findJavaPackage(SgScopeStatement *, std::string);
2628  ROSE_DLL_API SgClassDefinition *findOrInsertJavaPackage(SgProject *, std::string, bool create_directory = false);
2629  ROSE_DLL_API SgClassDeclaration *findOrImportJavaClass(SgProject *, SgClassDefinition *package_definition, std::string);
2630  ROSE_DLL_API SgClassDeclaration *findOrImportJavaClass(SgProject *, std::string, std::string);
2631  ROSE_DLL_API SgClassDeclaration *findOrImportJavaClass(SgProject *, SgClassType *);
2632  ROSE_DLL_API SgMemberFunctionDeclaration *findJavaMain(SgClassDefinition *);
2633  ROSE_DLL_API SgMemberFunctionDeclaration *findJavaMain(SgClassType *);
2634 #endif // ROSE_BUILD_JAVA_LANGUAGE_SUPPORT
2635 
2636 
2637 
2638 // DQ (8/31/2016): Making this a template function so that we can have it work with user defined filters.
2640 
2646 template < class T >
2648  {
2649  // DQ (9/1/2016): This function is called in the Call graph generation to avoid filtering out EDG normalized
2650  // function template instnatiations (which come from normalized template functions and member functions).
2651  // Note that because of the EDG normailzation the membr function is moved outside of the class, and
2652  // thus marked as compiler generated. However the template instantiations are always marked as compiler
2653  // generated (if not specializations) and so we want to include a template instantiation that is marked
2654  // as compiler generated, but is from a template declaration that satisfyied a specific user defined filter.
2655  // The complexity of this detection is isolated here, but knowing that it must be called is more complex.
2656  // This function is call in the CG.C file of tests/nonsmoke/functional/roseTests/programAnalysisTests/testCallGraphAnalysis.
2657 
2658  bool retval = false;
2659 
2660 #define DEBUG_TEMPLATE_NORMALIZATION_DETECTION 0
2661 
2662 #if DEBUG_TEMPLATE_NORMALIZATION_DETECTION
2663  printf ("In isNormalizedTemplateInstantiation(): function = %p = %s = %s \n",function,function->class_name().c_str(),function->get_name().str());
2664 #endif
2665 
2666  // Test for this to be a template instantation (in which case it was marked as
2667  // compiler generated but we may want to allow it to be used in the call graph,
2668  // if it's template was a part was defined in the current directory).
2669  SgTemplateInstantiationFunctionDecl* templateInstantiationFunction = isSgTemplateInstantiationFunctionDecl(function);
2670  SgTemplateInstantiationMemberFunctionDecl* templateInstantiationMemberFunction = isSgTemplateInstantiationMemberFunctionDecl(function);
2671 
2672  if (templateInstantiationFunction != NULL)
2673  {
2674  // When the defining function has been normalized by EDG, only the non-defining declaration will have a source position.
2675  templateInstantiationFunction = isSgTemplateInstantiationFunctionDecl(templateInstantiationFunction->get_firstNondefiningDeclaration());
2676  SgTemplateFunctionDeclaration* templateFunctionDeclaration = templateInstantiationFunction->get_templateDeclaration();
2677  if (templateFunctionDeclaration != NULL)
2678  {
2679  retval = filter->operator()(templateFunctionDeclaration);
2680  }
2681  else
2682  {
2683  // Assume false.
2684  }
2685 
2686 #if DEBUG_TEMPLATE_NORMALIZATION_DETECTION
2687  printf (" --- case of templateInstantiationFunction: retval = %s \n",retval ? "true" : "false");
2688 #endif
2689  }
2690  else
2691  {
2692  if (templateInstantiationMemberFunction != NULL)
2693  {
2694  // When the defining function has been normalized by EDG, only the non-defining declaration will have a source position.
2695  templateInstantiationMemberFunction = isSgTemplateInstantiationMemberFunctionDecl(templateInstantiationMemberFunction->get_firstNondefiningDeclaration());
2696  SgTemplateMemberFunctionDeclaration* templateMemberFunctionDeclaration = templateInstantiationMemberFunction->get_templateDeclaration();
2697  if (templateMemberFunctionDeclaration != NULL)
2698  {
2699  retval = filter->operator()(templateMemberFunctionDeclaration);
2700  }
2701  else
2702  {
2703  // Assume false.
2704  }
2705 
2706 #if DEBUG_TEMPLATE_NORMALIZATION_DETECTION
2707  printf (" --- case of templateInstantiationMemberFunction: retval = %s \n",retval ? "true" : "false");
2708 #endif
2709  }
2710  }
2711 
2712  return retval;
2713  }
2714 
2715 void detectCycleInType(SgType * type, const std::string & from);
2716 
2717 }// end of namespace
2718 
2719 #endif
std::string extractPragmaKeyword(const SgPragmaDeclaration *)
Extract a SgPragmaDeclaration's leading keyword . For example "#pragma omp parallel" has a keyword of...
ROSE_DLL_API void constantFolding(SgNode *r)
Constant folding an AST subtree rooted at 'r' (replacing its children with their constant values...
ROSE_DLL_API SgStatement * findSurroundingStatementFromSameFile(SgStatement *targetStmt, bool &surroundingStatementPreceedsTargetStatement)
Supporting function to comment relocation in insertStatement() and removeStatement().
ROSE_DLL_API SgFunctionDeclaration * findFirstDefiningFunctionDecl(SgScopeStatement *scope)
Find the first defining function declaration statement in a scope.
This class represents the notion of an initializer for a variable declaration or expression in a func...
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 bool is_mixed_Fortran_and_C_and_Cxx_language()
ROSE_DLL_API size_t getUpcSharedBlockSize(SgModifierType *mod_type)
Get the block size of a UPC shared modifier type.
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...
This class represents the concept of a scope in C++ (e.g. global scope, fuction scope, etc.).
ROSE_DLL_API void insertStatementListAfter(SgStatement *targetStmt, const std::vector< SgStatement * > &newStmt)
Insert a list of statements after a target statement.
This class represents the concept of an instantiation of member function template or a member functio...
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.
A persistent attribute to represent a unique name for an expression.
ROSE_DLL_API SgFile * getEnclosingFileNode(SgNode *astNode)
get the SgFile node from current node
This class represents the concept of a class declaration statement. It includes the concept of an ins...
bool declarationPreceedsDefinition(SgDeclarationStatement *nonDefiningDeclaration, SgDeclarationStatement *definingDeclaration)
Check if a defining declaration comes before of after the non-defining declaration.
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.
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 tru...
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 membe...
ROSE_DLL_API SgStatement * getEnclosingStatement(SgNode *n)
Find the closest enclosing statement, including the given node.
std::string generateUniqueNameForUseAsIdentifier(SgDeclarationStatement *declaration)
Generate a useful name to support construction of identifiers from declarations.
ROSE_DLL_API SgScopeStatement * getEnclosingScope(SgNode *n, const bool includingSelf=false)
Get the enclosing scope from a node n.
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.
This class represents the concept of a declaration list.
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...
ROSE_DLL_API SgVariableSymbol * getFirstVarSym(SgVariableDeclaration *decl)
Get the variable symbol for the first initialized name of a declaration stmt.
ROSE_DLL_API void insertStatementBefore(SgStatement *targetStmt, SgStatement *newStmt, bool autoMovePreprocessingInfo=true)
Insert a statement before a target statement.
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'...
ROSE_DLL_API bool isUpcSharedModifierType(SgModifierType *mod_type)
Check if a modifier type is a UPC shared type.
ROSE_DLL_API std::string mangleType(SgType *type)
Generate a mangled string for a given type based on Itanium C++ ABI.
ROSE_DLL_API SgExprStatement * splitVariableDeclaration(SgVariableDeclaration *decl)
Split a variable declaration with an rhs assignment into two statements: a declaration and an assignm...
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 ...
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 bool is_Fortran_language()
ROSE_DLL_API void removeAllOriginalExpressionTrees(SgNode *top)
Set original expression trees to NULL for SgValueExp or SgCastExp expressions, so you can change the ...
ROSE_DLL_API bool isAddressTaken(SgExpression *refExp)
Find a node by type using upward traversal.
ROSE_DLL_API void insertStatementListBefore(SgStatement *targetStmt, const std::vector< SgStatement * > &newStmts)
Insert a list of statements before a target statement.
ROSE_DLL_API bool hasTrivialDestructor(SgType *t)
Does a type have a trivial (built-in) destructor?
ROSE_DLL_API void setOneSourcePositionNull(SgNode *node)
Set current node's source position as NULL.
bool isPostfixOperator(SgExpression *exp)
Is an overloaded operator a postfix operator. (e.g. ).
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.
std::string getMangledNameFromCache(SgNode *astNode)
Save AST into a pdf file. Start from a node to find its enclosing file node. The entire file's AST wi...
ROSE_DLL_API SgFunctionDefinition * getEnclosingFunctionDefinition(SgNode *astNode, const bool includingSelf=false)
Find a node by type using upward traversal.
ROSE_DLL_API SgClassDeclaration * getEnclosingClassDeclaration(SgNode *astNode)
Get the closest class declaration enclosing the specified AST node,.
ROSE_DLL_API bool is_Ada_language()
ROSE_DLL_API SgBasicBlock * ensureBasicBlockAsBodyOfOmpBodyStmt(SgOmpBodyStatement *ompbodyStmt)
Check if the body of a SgOmpBodyStatement is a SgBasicBlock, create one if not.
This class represents the concept of a C or C++ statement which contains a expression.
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 AbstractHandle::abstract_handle * buildAbstractHandle(SgNode *)
Build an abstract handle from an AST node, reuse previously built handle when possible.
std::string generateUniqueName(const SgNode *node, bool ignoreDifferenceBetweenDefiningAndNondefiningDeclarations)
Generate unique name from C and C++ constructs. The name may contain space.
ROSE_DLL_API std::string mangleModifierType(SgModifierType *type)
Generated mangled modifier types, include const, volatile,according to Itanium C++ ABI...
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).
This class represents a source file for a project (which may contian many source files and or directo...
ROSE_DLL_API void removeLabeledGotos(SgNode *top)
Remove labeled goto statements.
This class represents the variable declaration or variable initialization withn a for loop...
ROSE_DLL_API bool isInSubTree(SgExpression *subtree, SgExpression *exp)
Find a node by type using upward traversal.
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...
bool templateDefinitionIsInClass(SgTemplateInstantiationMemberFunctionDecl *memberFunctionDeclaration)
Return true if template definition is in the class, false if outside of class.
ROSE_DLL_API SgMemberFunctionDeclaration * getDefaultConstructor(SgClassDeclaration *classDeclaration)
Get the default constructor from the class declaration.
ROSE_DLL_API bool normalizeForLoopTest(SgForStatement *loop)
Normalize a for loop's test expression ix is normalized to i>= (x...
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 pa...
void initializeIfStmt(SgIfStmt *ifstmt, SgStatement *conditional, SgStatement *true_body, SgStatement *false_body)
Support function used for variable declarations in conditionals.
Class for traversing the AST.
bool isTemplateInstantiationFromTemplateDeclarationSatisfyingFilter(SgFunctionDeclaration *function, T *filter)
This function detects template instantiations that are relevant when filters are used.
void guardNode(SgLocatedNode *target, std::string guard)
Add preproccessor guard around a given node.
This class represents the rhs of a variable declaration which includes an optional assignment (e...
ROSE_DLL_API SgBasicBlock * ensureBasicBlockAsBodyOfSwitch(SgSwitchStatement *ws)
Check if the body of a 'switch' statement is a SgBasicBlock, create one if not.
ROSE_DLL_API bool is_Java_language()
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 bo...
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 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-dec...
ROSE_DLL_API SgFunctionDeclaration * getFunctionDeclaration(SgFunctionCallExp *functionCallExp)
Find a node by type using upward traversal.
This class represents the base class for all types.
SgType * removeConst(SgType *t)
Remove const (if present) from a type. stripType() cannot do this because it removes all modifiers...
ROSE_DLL_API SgNode * deepCopyNode(const SgNode *subtree)
Deep copy an arbitrary subtree.
This class represents the concept of a do-while statement.
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...
struct const_int_expr_t evaluateConstIntegerExpression(SgExpression *expr)
The function tries to evaluate const integer expressions (such as are used in array dimension sizes)...
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.
This class represents the concept of a class name within the compiler.
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...
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 SgBasicBlock * ensureBasicBlockAsTrueBodyOfIf(SgIfStmt *ifs)
Check if the true body of a 'if' statement is a SgBasicBlock, create one if not.
SgMemberFunctionDeclaration * getDefaultDestructor(SgClassDeclaration *classDeclaration)
Get the default destructor from the class declaration.
ROSE_DLL_API bool isUpcArrayWithThreads(SgArrayType *t)
Is a UPC array with dimension of X*THREADS.
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 ...
ROSE_DLL_API void appendExpressionList(SgExprListExp *, const std::vector< SgExpression * > &)
Append an expression list to a SgExprListExp, set the parent pointers also.
ROSE_DLL_API std::string mangleScalarType(SgType *type)
Generate mangled scalar type names according to Itanium C++ ABI, the input type should pass isScalarT...
void set_parent(SgNode *parent)
All nodes in the AST contain a reference to a parent node.
void setSourcePositionPointersToNull(SgNode *node)
Set the source code positon for the current (input) node.
ROSE_DLL_API bool isEquivalentFunctionType(const SgFunctionType *lhs, const SgFunctionType *rhs)
Test if two types are equivalent SgFunctionType nodes.
std::vector< SgVariableSymbol * > getSymbolsUsedInExpression(SgExpression *expr)
Find referenced symbols within an expression.
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 ScopeSta...
ROSE_DLL_API void setLhsOperand(SgExpression *target, SgExpression *lhs)
set left hand operand for binary expressions, transparently downcasting target expressions when neces...
This class represents the notion of a declared variable.
ROSE_DLL_API void setSourcePositionAtRootAndAllChildren(SgNode *root)
Set the source code positon for the subtree (including the root).
ROSE_DLL_API std::string generateProjectName(const SgProject *project, bool supressSuffix=false)
Added mechanism to generate project name from list of file names.
bool isBodyStatement(SgStatement *s)
Check if a statement is a (true or false) body of a container-like parent, such as For...
ROSE_DLL_API SgVariableSymbol * prependArg(SgFunctionParameterList *, SgInitializedName *)
Prepend an argument to SgFunctionParameterList.
NodeType * deepCopy(const NodeType *subtree)
A template function for deep copying a subtree. It is also used to create deepcopy functions with spe...
This class represents the concept of a member function declaration statement.
This class represents the concept of a C and C++ case option (used within a switch statement)...
SgBasicBlock * ensureBasicBlockAsBodyOfDefaultOption(SgDefaultOptionStmt *cs)
Check if the body of a 'default option' statement is a SgBasicBlock, create one if not...
This class represents the concept of a function declaration statement.
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...
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 wi...
ROSE_DLL_API bool isOmpStatement(SgNode *)
Check if a node is SgOmp*Statement.
ROSE_DLL_API void convertFunctionDefinitionsToFunctionPrototypes(SgNode *node)
Function to delete AST subtree's nodes only, users must take care of any dangling pointers...
bool isStructDeclaration(SgNode *node)
Check if a SgNode is a declaration for a structure.
ROSE_DLL_API bool is_mixed_Fortran_and_Cxx_language()
Interface for creating a statement whose computation writes its answer into a given variable...
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...
This class represents the concept of a scope in C++ (e.g. global scope, fuction scope, etc.).
SgType * getBoolType(SgNode *n)
Get the right bool type according to C or C++ language input.
ROSE_DLL_API SgSourceFile * getEnclosingSourceFile(SgNode *n, const bool includingSelf=false)
Find enclosing source file node.
ROSE_DLL_API bool is_Python_language()
bool ROSE_DLL_API isStatic(SgDeclarationStatement *stmt)
Check if a declaration has a "static' modifier.
unsigned long long getIntegerConstantValue(SgValueExp *expr)
Get the constant value from a constant integer expression; abort on everything else.
This class represents the concept of a C and C++ expression list.
void clearScopeNumbers(SgFunctionDefinition *functionDefinition)
Clears the cache of scope,integer pairs for the input function.
ROSE_DLL_API void setStatic(SgDeclarationStatement *stmt)
Set a declaration as static.
ROSE_DLL_API void outputLocalSymbolTables(SgNode *node)
Output the local symbol tables.
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 ...
ROSE_DLL_API void printOutComments(SgLocatedNode *locatedNode)
Connect variable reference to the right variable symbols when feasible, return the number of referenc...
std::string get_name(const SgNode *node)
Generate a useful name to describe the SgNode.
ROSE_DLL_API bool is_binary_executable()
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 ScopeSta...
PreprocessingInfo * insertHeader(SgSourceFile *source_file, const std::string &header_file_name, bool isSystemHeader, bool asLastHeader)
Insert #include "filename" or #include (system header) onto the global scope of a source f...
std::vector< SgBreakStmt * > findBreakStmts(SgStatement *code, const std::string &fortranLabel="")
Find break statements inside a particular statement, stopping at nested loops or switches.
ROSE_DLL_API void setSourcePositionForTransformation(SgNode *root)
Recursively set source position info(Sg_File_Info) as transformation generated.
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 SgStatement * getLoopBody(SgScopeStatement *loop)
Routines to get and set the body of a loop.
std::vector< SgFile * > generateFileList()
Returns STL vector of SgFile IR node pointers.
std::string generateUniqueNameForUseAsIdentifier_support(SgDeclarationStatement *declaration)
Global map of name collisions to support generateUniqueNameForUseAsIdentifier() function.
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...
ROSE_DLL_API int set_name(SgInitializedName *initializedNameNode, SgName new_name)
set_name of symbol in symbol table.
void changeAllBodiesToBlocks(SgNode *top, bool createEmptyBody=true)
Fix up ifs, loops, while, switch, Catch, OmpBodyStatement, etc. to have blocks as body components...
ROSE_DLL_API bool isPointerType(SgType *t)
Is this type a pointer type? (Handles typedefs correctly)
bool isOverloaded(SgFunctionDeclaration *functionDeclaration)
Return true if function is overloaded.
ROSE_DLL_API SgNode * getSgNodeFromAbstractHandleString(const std::string &input_string)
Obtain a matching SgNode from an abstract handle string.
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 void deleteExpressionTreeWithOriginalExpressionSubtrees(SgNode *root)
Special purpose function for deleting AST expression tress containing valid original expression trees...
ROSE_DLL_API bool isCopyConstructible(SgType *type)
Is a type copy constructible? This may not quite work properly.
This class represents the base class of a numbr of IR nodes that don't otherwise fit into the existin...
Definition: Cxx_Grammar.h:9951
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 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-s...
ROSE_DLL_API bool isStructType(SgType *t)
Check if a type is a struct type (a special SgClassType in ROSE)
void resetScopeNumbers(SgFunctionDefinition *functionDeclaration)
Assigns unique numbers to each SgScopeStatement of a function.
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...
SgExpression * forallMaskExpression(SgForAllStatement *stmt)
Get the mask expression from the header of a SgForAllStatement.
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 bool isSameFunction(SgFunctionDeclaration *func1, SgFunctionDeclaration *func2)
Check if two function declarations refer to the same one. Two function declarations are the same when...
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 bool isConstantTrue(SgExpression *e)
Save AST into a pdf file. Start from a node to find its enclosing file node. The entire file's AST wi...
SgDeclarationStatement * getNonInstantiatonDeclarationForClass(SgTemplateInstantiationMemberFunctionDecl *memberFunctionInstantiation)
Save AST into a pdf file. Start from a node to find its enclosing file node. The entire file's AST wi...
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 referenc...
ROSE_DLL_API int getDimensionCount(SgType *t)
Get the number of dimensions of an array type.
void visit(SgNode *node)
this method is called at every traversed node.
RelativePositionType
MK: Enum type to store if the directive goes before or after the corresponding line of source code...
void clearMangledNameCache(SgGlobal *globalScope)
Support for faster mangled name generation (caching avoids recomputation).
void whereAmI(SgNode *node)
Diagnostic function for tracing back through the parent list to understand at runtime where in the AS...
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 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 void removeUnusedLabels(SgNode *top)
Remove labels which are not targets of any goto statements.
SgBasicBlock * makeSingleStatementBodyToBlock(SgStatement *singleStmt)
Make a single statement body to be a basic block. Its parent is if, while, catch, or upc_forall etc...
ROSE_DLL_API SgInitializer * getInitializerOfExpression(SgExpression *n)
Get the initializer containing an expression if it is within an initializer.
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 bool is_OpenMP_language()
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...
This class represents the notion of an expression. Expressions are derived from SgLocatedNodes, since similar to statement, expressions have a concrete location within the user's source code.
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 ScopeSta...
ROSE_DLL_API bool is_UPC_language()
ROSE_DLL_API SgBasicBlock * ensureBasicBlockAsBodyOfUpcForAll(SgUpcForAllStatement *fs)
Check if the body of a 'upc_forall' statement is a SgBasicBlock, create one if not.
void outputGlobalFunctionTypeSymbolTable()
Output function type symbols in global function type symbol table.
ROSE_DLL_API bool insideSystemHeader(SgLocatedNode *node)
Set source position info(Sg_File_Info) as transformation generated for all SgNodes in memory pool...
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< SgContinueStmt * > findContinueStmts(SgStatement *code, const std::string &fortranLabel="")
Find all continue statements inside a particular statement, stopping at nested loops.
void setBaseTypeDefiningDeclaration(SgVariableDeclaration *var_decl, SgDeclarationStatement *base_decl)
a better version for SgVariableDeclaration::set_baseTypeDefininingDeclaration(), handling all side ef...
ROSE_DLL_API void setFortranNumericLabel(SgStatement *stmt, int label_value)
Set a numerical label for a Fortran statement. The statement should have a enclosing function definit...
ROSE_DLL_API bool templateArgumentListEquivalence(const SgTemplateArgumentPtrList &list1, const SgTemplateArgumentPtrList &list2)
Verify that 2 SgTemplateArgumentPtrList are equivalent.
const SgInitializedNamePtrList & get_args() const
Access function for p_args.
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 mergeAssignmentWithDeclaration(SgExprStatement *assign_stmt, SgVariableDeclaration *decl, bool removeAssignStmt=true)
Merge an assignment into its upstream declaration statement. Callers should make sure the merge is se...
This class represents the concept of a name within the compiler.
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.
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.
void dumpPreprocInfo(SgLocatedNode *locatedNode)
Dumps a located node's preprocessing information.
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 void replaceSubexpressionWithStatement(SgExpression *from, SageInterface::StatementGenerator *to)
Similar to replaceExpressionWithStatement, but with more restrictions.
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 ScopeSta...
SgCommaOpExp * insertBeforeUsingCommaOp(SgExpression *new_exp, SgExpression *anchor_exp)
Insert an expression (new_exp )before another expression (anchor_exp) has possible side effects...
ROSE_DLL_API bool is_Cobol_language()
Supporting class from copy mechanism within ROSE.
Definition: Cxx_Grammar.h:8713
ROSE_DLL_API void setSourcePosition(SgNode *node)
Set the source code positon for the current (input) node.
ROSE_DLL_API bool isPureVirtualClass(SgType *type, const ClassHierarchyWrapper &classHierarchy)
Check if a class type is a pure virtual class.
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 ...
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 f...
ROSE_DLL_API SgGlobal * getFirstGlobalScope(SgProject *project)
return the first global scope under current project
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 fixStructDeclaration(SgClassDeclaration *structDecl, SgScopeStatement *scope)
Fix symbols, parent and scope pointers. Used internally within appendStatment(), insertStatement() et...
ROSE_DLL_API SgType * getFirstVarType(SgVariableDeclaration *decl)
Get the data type of the first initialized name of a declaration statement.
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 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 int collectVariableReferencesInArrayTypes(SgLocatedNode *root, Rose_STL_Container< SgNode * > &currentVarRefList)
Collect variable references in array types. The default NodeQuery::querySubTree() will miss variables...
This class represents the concept of a class definition in C++.
This class represents strings within the IR nodes.
ROSE_DLL_API bool isMemberFunctionMemberReference(SgMemberFunctionRefExp *memberFunctionRefExp)
Find a node by type using upward traversal.
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...
void resetMangledNameCache(SgGlobal *globalScope)
Save AST into a pdf file. Start from a node to find its enclosing file node. The entire file's AST wi...
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 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 bo...
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...
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 bool isMain(const SgNode *node)
Check if a SgNode is a main() function declaration.
ROSE_DLL_API void setExtern(SgDeclarationStatement *stmt)
Set a declaration as extern.
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...
std::vector< SgStatement * > getSwitchCases(SgSwitchStatement *sw)
Query a subtree to get all nodes of a given type, with an appropriate downcast.
void setSourcePositionAsTransformation(SgNode *node)
DQ (5/1/2012): New function with improved name.
bool isPrototypeInScope(SgScopeStatement *scope, SgFunctionDeclaration *functionDeclaration, SgDeclarationStatement *startingAtDeclaration)
Assigns unique numbers to each SgScopeStatement of a function.
Functions that are useful when operating on the AST.
Definition: sageBuilder.h:25
ROSE_DLL_API bool doLoopNormalization(SgFortranDo *loop)
Normalize a Fortran Do loop. Make the default increment expression (1) explicit.
ROSE_DLL_API bool isConstantFalse(SgExpression *e)
Save AST into a pdf file. Start from a node to find its enclosing file node. The entire file's AST wi...
ROSE_DLL_API bool isExtern(SgDeclarationStatement *stmt)
Check if a declaration has an "extern" modifier.
ROSE_DLL_API SgFunctionDeclaration * findMain(SgNode *currentNode)
top-down traversal from current node to find the main() function declaration
ROSE_DLL_API SgInitializedName * getFirstInitializedName(SgVariableDeclaration *decl)
Get the first initialized name of a declaration statement.
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 ...
ROSE_DLL_API bool is_UPC_dynamic_threads()
Check if dynamic threads compilation is used for UPC programs.
ROSE_DLL_API void translateScopeToUseCppDeclarations(SgScopeStatement *scope)
Connect variable reference to the right variable symbols when feasible, return the number of referenc...
ROSE_DLL_API void cleanupNontransformedBasicBlockNode()
Remove unused basic block IR nodes added as part of normalization.
ROSE_DLL_API void setOperand(SgExpression *target, SgExpression *operand)
Set operands for expressions with single operand, such as unary expressions. handle file info...
ROSE_DLL_API bool isVolatileType(SgType *t)
Is this a volatile type?
ROSE_DLL_API SgAssignInitializer * splitExpression(SgExpression *from, std::string newName="")
Replace an expression with a temporary variable and an assignment statement.
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 expre...
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_* gener...
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...
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.
This class represents the concept of a namespace name within the compiler.
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).
SgBasicBlock * ensureBasicBlockAsBodyOfCaseOption(SgCaseOptionStmt *cs)
Check if the body of a 'case option' statement is a SgBasicBlock, create one if not.
ROSE_DLL_API std::list< SgClassType * > getClassTypeChainForMemberReference(SgExpression *refExp)
Find a node by type using upward traversal.
This class represents the base class for all IR nodes within Sage III.
Definition: Cxx_Grammar.h:8968
This class represents the concept of a catch within a try-catch construct used in C++ exception handl...
uint64_t getAsmConstant(SgAsmValueExpression *e)
Get the unsigned value of a disassembled constant.
This class represents the notion of an value (expression value).
This class represents the concept of a variable name within the compiler (a shared container for the ...
This class represents the concept of an instantiation of function template.
bool isPrefixOperatorName(const SgName &functionName)
Check for proper names of possible prefix operators (used in isPrefixOperator()). ...
bool isUnionDeclaration(SgNode *node)
Check if a SgNode is a declaration for a union.
ROSE_DLL_API std::set< SgStatement * > collectTransformedStatements(SgNode *node)
This collects the statements that are marked as transformed (useful in debugging).
NodeType * getEnclosingNode(const SgNode *astNode, const bool includingSelf=false)
Find a node by type using upward traversal.
ROSE_DLL_API bool is_Jovial_language()
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...
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.
SgTemplateMemberFunctionDeclaration * get_templateDeclaration() const
Returns pointer to SgTemplateDeclaration from which instantiation is generated.
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.
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 appropri...
ROSE_DLL_API SgClassDefinition * getEnclosingClassDefinition(SgNode *astnode, const bool includingSelf=false)
Get the closest class definition enclosing the specified AST node,.
std::map< std::string, SgNode * > local_name_to_node_map
Global map of name collisions to support generateUniqueNameForUseAsIdentifier() function.
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...
SgStatement * lastStatementOfScopeWithTokenInfo(SgScopeStatement *scope, std::map< SgNode *, TokenStreamSequenceToNodeMapping * > &tokenStreamSequenceMap)
Used to support token unparsing (when the output the trailing token sequence).
ROSE_DLL_API bool unnormalizeForLoopInitDeclaration(SgForStatement *loop)
Undo the normalization of for loop's C99 init declaration. Previous record of normalization is used t...
ROSE_DLL_API bool is_OpenCL_language()
ROSE_DLL_API bool normalizeForLoopInitDeclaration(SgForStatement *loop)
Normalize loop init stmt by promoting the single variable declaration statement outside of the for lo...
ROSE_DLL_API bool isLastStatement(SgStatement *stmt)
Check if a statement is the last statement within its closed scope.
ROSE_DLL_API SgType * getAssociatedTypeFromFunctionTypeList(SgExpression *actual_argument_expression)
Get the type of the associated argument expression from the function type.
ROSE_DLL_API SgBasicBlock * ensureBasicBlockAsBodyOfFor(SgForStatement *fs)
Check if the body of a 'for' statement is a SgBasicBlock, create one if not.
std::vector< SgExpression * > get_C_array_dimensions(const SgArrayType &arrtype)
returns the array dimensions in an array as defined for arrtype
This class represents the concept of a block (not a basic block from control flow analysis)...
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 referenc...
This class represents the concept of a C++ namespace declaration.
ROSE_DLL_API SgFunctionDefinition * getEnclosingProcedure(SgNode *n, const bool includingSelf=false)
Find the function definition.
ROSE_DLL_API SgFunctionDeclaration * getEnclosingFunctionDeclaration(SgNode *astNode, const bool includingSelf=false)
Find the enclosing function declaration, including its derived instances like isSgProcedureHeaderStat...
This class represents the notion of a statement.
For preprocessing information including source comments, #include , #if, #define, etc...
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 cutPrepro...
ROSE_DLL_API bool is_C_language()
ROSE_DLL_API SgStatement * lastFrontEndSpecificStatement(SgGlobal *globalScope)
Function to delete AST subtree's nodes only, users must take care of any dangling pointers...
This class represents the concept of a namespace definition.
This class represents the concept of a for loop.
ROSE_DLL_API SgStatement * getLastStatement(SgScopeStatement *scope)
get the last statement within a scope, return NULL if it does not exit
void clearUnusedVariableSymbols(SgNode *root=NULL)
Clear those variable symbols with unknown type (together with initialized names) which are also not r...
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 bool skipTranslateToUseCppDeclaration(PreprocessingInfo *currentPreprocessingInfo)
Connect variable reference to the right variable symbols when feasible, return the number of referenc...
ROSE_DLL_API void resetInternalMapsForTargetStatement(SgStatement *sourceStatement)
Function to delete AST subtree's nodes only, users must take care of any dangling pointers...
SgDeclarationStatement * get_definingDeclaration() const
This is an access function for the SgDeclarationStatement::p_definingDeclaration data member (see tha...
ROSE_DLL_API void recordNormalizations(SgStatement *s)
Record where normalization have been done so that we can preform denormalizations as required for the...
ROSE_DLL_API SgInitializedName * getLoopIndexVariable(SgNode *loop)
Return the loop index variable for a for loop.
ROSE_DLL_API bool is_X10_language()
ROSE_DLL_API bool statementCanBeTransformed(SgStatement *stmt)
If header file unparsing and token-based unparsing are used, then some statements in header files use...
This class represents a type for all functions.
void annotateExpressionsWithUniqueNames(SgProject *project)
Generate unique names for expressions and attach the names as persistent attributes ("UniqueNameAttri...
SgInitializedName & getFirstVariable(SgVariableDeclaration &vardecl)
convenience function that returns the first initialized name in a list of variable declarations...
ROSE_DLL_API bool isCallToParticularFunction(SgFunctionDeclaration *decl, SgExpression *e)
Save AST into a pdf file. Start from a node to find its enclosing file node. The entire file's AST wi...
This class represents the concept of a namespace definition.
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...
ROSE_DLL_API SgStatement * copyStatement(SgStatement *s)
Deep copy a statement.
void addMessageStatement(SgStatement *stmt, std::string message)
Function to add "C" style comment to statement.
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 bool isScalarType(SgType *t)
Is this a scalar type?
This class represents the concept of a C Assembler statement (untested).
ROSE_DLL_API void appendExpression(SgExprListExp *, SgExpression *)
Append an expression to a SgExprListExp, set the parent pointer also.
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.
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.
bool isIndexOperator(SgExpression *exp)
Is an overloaded operator an index operator (also referred to as call or subscript operators)...
ROSE_DLL_API bool hasSimpleChildrenList(SgScopeStatement *scope)
Check if a scope statement has a simple children statement list so insert additional statements under...
ROSE_DLL_API bool isNonconstReference(SgType *t)
Is this type a non-constant reference type? (Handles typedefs correctly)
This class represents the concept of a C or C++ default case within a switch statement.
ROSE_DLL_API bool templateArgumentEquivalence(SgTemplateArgument *arg1, SgTemplateArgument *arg2)
Verify that 2 SgTemplateArgument are equivalent (same type, same expression, or same template declara...
This class represents the concept of an "if" construct.
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 ScopeSta...
to specify a construct using a specifier Can be used alone or with parent handles when relative speci...
ROSE_DLL_API void fixVariableDeclaration(SgVariableDeclaration *varDecl, SgScopeStatement *scope)
Patch up symbol, scope, and parent information when a SgVariableDeclaration's scope is known...
virtual std::string class_name() const
returns a string representing the class name
ROSE_DLL_API void deleteAST(SgNode *node)
Function to delete AST subtree's nodes only, users must take care of any dangling pointers...
std::vector< SgGotoStatement * > findGotoStmts(SgStatement *scope, SgLabelStatement *l)
Query a subtree to get all nodes of a given type, with an appropriate downcast.
virtual std::vector< SgNode * > get_traversalSuccessorContainer()
container of pointers to AST successor nodes used in the traversal overridden in every class by gener...
ROSE_DLL_API SgScopeStatement * getScope(const SgNode *astNode)
Get the closest scope from astNode. Return astNode if it is already a scope.
void setParameterList(actualFunction *func, SgFunctionParameterList *paralist)
Set parameter list for a function declaration, considering existing parameter list etc...
This class represents the concept of a template declaration.
ROSE_DLL_API void fixClassDeclaration(SgClassDeclaration *classDecl, SgScopeStatement *scope)
Fix symbols, parent and scope pointers. Used internally within appendStatment(), insertStatement() et...
ROSE_DLL_API bool forLoopNormalization(SgForStatement *loop, bool foldConstant=true)
Normalize a for loop, return true if successful.
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 ScopeSta...
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...
This class represents the notion of an expression or statement which has a position within the source...
ROSE_DLL_API bool isReferenceType(SgType *t)
Is this type a const or non-const reference type? (Handles typedefs correctly)
This class represents template argument within the use of a template to build an instantiation.
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...
This class represents the variable refernece in expressions.
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 ...
This class represents the concept of a do-while statement.
ROSE_DLL_API std::vector< SgNode * > astIntersection(SgNode *original, SgNode *copy, SgCopyHelp *help=NULL)
Compute the intersection set for two ASTs.
ROSE_DLL_API bool isUpcPrivateToSharedType(SgType *t)
Is a UPC private-to-shared pointer? SgPointerType comes first compared to SgModifierType with UPC inf...
void initializeSwitchStatement(SgSwitchStatement *switchStatement, SgStatement *item_selector, SgStatement *body)
Support function used for variable declarations in conditionals.
ROSE_DLL_API int fixVariableReferences(SgNode *root, bool cleanUnusedSymbol=true)
Connect variable reference to the right variable symbols when feasible, return the number of referenc...
std::map< std::string, int > local_name_collision_map
Global map of name collisions to support generateUniqueNameForUseAsIdentifier() function.
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 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 ScopeSta...
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_* g...
ROSE_DLL_API bool isDefaultConstructible(SgType *type)
Is a type default constructible? This may not quite work properly.
ROSE_DLL_API void wrapAllTemplateInstantiationsInAssociatedNamespaces(SgProject *root)
Function to delete AST subtree's nodes only, users must take care of any dangling pointers...
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 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 ScopeSta...
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...
Base class for values.
SgTemplateInstantiationMemberFunctionDecl * buildForwardFunctionDeclaration(SgTemplateInstantiationMemberFunctionDecl *memberFunctionInstantiation)
Generate a non-defining (forward) declaration from a defining function declaration.
ROSE_DLL_API bool mergeDeclarationWithAssignment(SgVariableDeclaration *decl, SgExprStatement *assign_stmt)
Merge a declaration statement into a matching followed variable assignment. Callers should make sure ...
void computeUniqueNameForUseAsIdentifier(SgNode *astNode)
Traversal to set the global map of names to node and node to names.collisions to support generateUniq...
ROSE_DLL_API bool isAssignable(SgType *type)
Is a type assignable? This may not quite work properly.
ROSE_DLL_API void setLoopLowerBound(SgNode *loop, SgExpression *lb)
Set the lower bound of a loop header for (i=lb; ...)
ROSE_DLL_API SgProject * getProject()
Get the current SgProject IR Node.
This class represents the member function being called and must be assembled in the SgFunctionCall wi...
ROSE_DLL_API bool is_PHP_language()
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 void splitExpressionIntoBasicBlock(SgExpression *expr)
Split long expressions into blocks of statements.
void initializeWhileStatement(SgWhileStmt *whileStatement, SgStatement *condition, SgStatement *body, SgStatement *else_body)
Support function used for variable declarations in conditionals.
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 i...
ROSE_DLL_API void removeConsecutiveLabels(SgNode *top)
Remove consecutive labels.
ROSE_DLL_API void setOneSourcePositionForTransformation(SgNode *root)
Set current node's source position as transformation generated.
ROSE_DLL_API void moveDeclarationToAssociatedNamespace(SgDeclarationStatement *declarationStatement)
Relocate the declaration to be explicitly represented in its associated namespace (required for some ...
ROSE_DLL_API void setRhsOperand(SgExpression *target, SgExpression *rhs)
set left hand operand for binary expression
SgNode * get_parent() const
Access function for parent node.
ROSE_DLL_API void myRemoveStatement(SgStatement *stmt)
A special purpose statement removal function, originally from inlinerSupport.h, Need Jeremiah's atten...
bool functionCallExpressionPreceedsDeclarationWhichAssociatesScope(SgFunctionCallExp *functionCall)
Save AST into a pdf file. Start from a node to find its enclosing file node. The entire file's AST wi...
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 int gensym_counter
An internal counter for generating unique SgName.
ROSE_DLL_API void outputSharedNodes(SgNode *node)
Find a node by type using upward traversal.
ROSE_DLL_API bool isEqualToIntConst(SgExpression *e, int value)
Check if a SgIntVal node has a given value.
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...
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 sta...
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 SgSwitchStatement * findEnclosingSwitch(SgStatement *s)
Find the closest switch outside a given statement (normally used for case and default statements) ...
ROSE_DLL_API bool is_Cxx_language()
ROSE_DLL_API bool isDataMemberReference(SgVarRefExp *varRefExp)
Find a node by type using upward traversal.
void rebuildSymbolTable(SgScopeStatement *scope)
Regenerate the symbol table.
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 f...
ROSE_DLL_API bool isConstType(SgType *t)
Is this a const type?
ROSE_DLL_API LivenessAnalysis * call_liveness_analysis(SgProject *project, bool debug=false)
Call liveness analysis on an entire project.
SgFunctionDeclaration * getDeclarationOfNamedFunction(SgExpression *func)
Given a SgExpression that represents a named function (or bound member function), return the mentione...
ROSE_DLL_API bool isRestrictType(SgType *t)
Is this a restrict type?
ROSE_DLL_API bool is_C99_language()
This class represents a source project, with a list of SgFile objects and global information about th...
ROSE_DLL_API SgStatement * getNextStatement(SgStatement *currentStmt)
Get next statement within the same scope of current statement.
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 ch...
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 ta...
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 ...
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 de...
virtual std::string class_name() const ROSE_OVERRIDE
returns a string representing the class name
ROSE_DLL_API SgVariableSymbol * appendArg(SgFunctionParameterList *, SgInitializedName *)
Append an argument to SgFunctionParameterList, transparently set parent,scope, and symbols for argume...
ROSE_DLL_API bool isTemplateInstantiationNode(SgNode *node)
Function to delete AST subtree's nodes only, users must take care of any dangling pointers...
ROSE_DLL_API bool is_mixed_Fortran_and_C_language()
SgNamespaceDefinitionStatement * enclosingNamespaceScope(SgDeclarationStatement *declaration)
Find the enclosing namespace of a declaration.
ROSE_DLL_API bool is_CAF_language()
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 translateToUseCppDeclarations(SgNode *n)
Connect variable reference to the right variable symbols when feasible, return the number of referenc...
void collectVarRefs(SgLocatedNode *root, std::vector< SgVarRefExp * > &result)
Collect all variable references in a subtree.
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 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()
std::string declarationPositionString(const SgDeclarationStatement *declaration)
Generate a unique string from the source file position information.
This class represents the concept of a C or C++ variable declaration.
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 std::vector< SgDeclarationStatement * > sortSgNodeListBasedOnAppearanceOrderInSource(const std::vector< SgDeclarationStatement * > &nodevec)
Reorder a list of declaration statements based on their appearance order in source files...
std::map< SgNode *, std::string > local_node_to_name_map
Global map of name collisions to support generateUniqueNameForUseAsIdentifier() function.
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 ScopeSta...
Represents an interpretation of a binary container.
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 ...
This class represents the concept of a C or C++ label statement.
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 statemen...
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 po...
SgDeclarationStatement * get_firstNondefiningDeclaration() const
This is an access function for the SgDeclarationStatement::p_firstNondefiningDeclaration data member ...
ROSE_DLL_API void dumpInfo(SgNode *node, std::string desc="")
Dump information about a SgNode for debugging.
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...
ROSE_DLL_API void fixNamespaceDeclaration(SgNamespaceDeclarationStatement *structDecl, SgScopeStatement *scope)
Fix symbols, parent and scope pointers. Used internally within appendStatment(), insertStatement() et...
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 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.
This class represents the concept of a C++ function call (which is an expression).
void reset_name_collision_map()
Reset map variables used to support generateUniqueNameForUseAsIdentifier() function.
Base class for binary files.
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...
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 bool is_Cuda_language()
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 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 ScopeSta...
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 fri...
std::string addMangledNameToCache(SgNode *astNode, const std::string &mangledName)
Save AST into a pdf file. Start from a node to find its enclosing file node. The entire file's AST wi...
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) ...
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 ScopeSta...
This class represents the concept of a declaration statement.
virtual SgName get_name() const =0
Access function for getting name from declarations or types internally.
This class represents the concept of a switch.
ROSE_DLL_API SgExpression * copyExpression(SgExpression *e)
Deep copy an expression.
int64_t getAsmSignedConstant(SgAsmValueExpression *e)
Get the signed value of a disassembled constant.
ROSE_DLL_API bool isUpcPhaseLessSharedType(SgType *t)
Is UPC phase-less shared type? Phase-less means block size of the first SgModifierType with UPC infor...
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...
void listHeaderFiles(SgIncludeFile *includeFile)
return path prefix for subtree of include files.
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-decl...
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 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...
ROSE_DLL_API void replaceMacroCallsWithExpandedStrings(SgPragmaDeclaration *target)
Check if a pragma declaration node has macro calls attached, if yes, replace macro calls within the p...
ROSE_DLL_API bool is_mixed_C_and_Cxx_language()
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 su...