ROSE  0.11.2.0
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 #ifdef ROSE_BUILD_BINARY_ANALYSIS_SUPPORT
112 
115 
118 #endif
119 
121  void addMessageStatement( SgStatement* stmt, std::string message );
122 
124  class UniqueNameAttribute : public AstAttribute
125  {
126  private:
127  std::string name;
128  public:
129  UniqueNameAttribute(std::string n="") {name =n; };
130  void set_name (std::string n) {name = n;};
131  std::string get_name () {return name;};
132  };
133 
134  //------------------------------------------------------------------------
136 
140 // DQ (8/5/2020): the "using namespace" directive will not hide existing visability of symbols in resolving visability.
141 // So we need to test if a symbol is visible exclusing matching alises due to using direectives before we can decide to
142 // persue name space qualification. This is best demonstrated by Cxx_tests/test2020_18.C, test2020_19.C, test2020_20.C,
143 // and test2020_21.C.
144  ROSE_DLL_API SgSymbol *lookupSymbolInParentScopesIgnoringAliasSymbols (const SgName & name, SgScopeStatement *currentScope = NULL, SgTemplateParameterPtrList* templateParameterList = NULL, SgTemplateArgumentPtrList* templateArgumentList = NULL);
145 
146 // DQ (8/21/2013): Modified to make newest function parameters be default arguments.
147 // 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.
149 // SgSymbol *lookupSymbolInParentScopes (const SgName & name, SgScopeStatement *currentScope=NULL);
150 // SgSymbol *lookupSymbolInParentScopes (const SgName & name, SgScopeStatement *currentScope, SgTemplateParameterPtrList* templateParameterList, SgTemplateArgumentPtrList* templateArgumentList);
151  ROSE_DLL_API SgSymbol *lookupSymbolInParentScopes (const SgName & name, SgScopeStatement *currentScope = NULL, SgTemplateParameterPtrList* templateParameterList = NULL, SgTemplateArgumentPtrList* templateArgumentList = NULL);
152 
153  // Liao 1/22/2008, used for get symbols for generating variable reference nodes
154  // ! Find a variable symbol in current and ancestor scopes for a given name
155  ROSE_DLL_API SgVariableSymbol *lookupVariableSymbolInParentScopes (const SgName & name, SgScopeStatement *currentScope=NULL);
156 
157  // DQ (11/24/2007): Functions moved from the Fortran support so that they could be called from within astPostProcessing.
159  ROSE_DLL_API SgFunctionSymbol *lookupFunctionSymbolInParentScopes (const SgName & functionName, SgScopeStatement *currentScope=NULL);
160 
161  // Liao, 1/24/2008, find exact match for a function
163  ROSE_DLL_API SgFunctionSymbol *lookupFunctionSymbolInParentScopes (const SgName & functionName,
164  const SgType* t,
165  SgScopeStatement *currentScope=NULL);
166 
167  ROSE_DLL_API SgFunctionSymbol *lookupTemplateFunctionSymbolInParentScopes (const SgName & functionName, SgFunctionType * ftype, SgTemplateParameterPtrList * tplparams, SgScopeStatement *currentScope=NULL);
168  ROSE_DLL_API SgFunctionSymbol *lookupTemplateMemberFunctionSymbolInParentScopes (const SgName & functionName, SgFunctionType * ftype, SgTemplateParameterPtrList * tplparams, SgScopeStatement *currentScope=NULL);
169 
170  ROSE_DLL_API SgTemplateVariableSymbol * lookupTemplateVariableSymbolInParentScopes (const SgName & name, SgTemplateParameterPtrList * tplparams, SgTemplateArgumentPtrList* tplargs, SgScopeStatement *currentScope=NULL);
171 
172 
173 // DQ (8/21/2013): Modified to make newest function parameters be default arguments.
174 // 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.
175 // DQ (5/7/2011): Added support for SgClassSymbol (used in name qualification support).
176 // SgClassSymbol* lookupClassSymbolInParentScopes (const SgName & name, SgScopeStatement *currentScope = NULL);
177  ROSE_DLL_API SgClassSymbol* lookupClassSymbolInParentScopes (const SgName & name, SgScopeStatement *currentScope = NULL, SgTemplateArgumentPtrList* templateArgumentList = NULL);
178  ROSE_DLL_API SgTypedefSymbol* lookupTypedefSymbolInParentScopes (const SgName & name, SgScopeStatement *currentScope = NULL);
179 
180  ROSE_DLL_API SgNonrealSymbol* lookupNonrealSymbolInParentScopes (const SgName & name, SgScopeStatement *currentScope = NULL, SgTemplateParameterPtrList* templateParameterList = NULL, SgTemplateArgumentPtrList* templateArgumentList = NULL);
181 #if 0
182  // DQ (8/13/2013): This function does not make since any more, now that we have made the symbol
183  // table handling more precise and we have to provide template parameters for any template lookup.
184  // We also have to know if we want to lookup template classes, template functions, or template
185  // member functions (since each have specific requirements).
186  SgTemplateSymbol* lookupTemplateSymbolInParentScopes (const SgName & name, SgScopeStatement *currentScope = NULL);
187 #endif
188 #if 0
189 // DQ (8/13/2013): I am not sure if we want this functions in place of lookupTemplateSymbolInParentScopes.
190 // Where these are called we might not know enough information about the template parameters or function
191 // types, for example.
192  SgTemplateClassSymbol* lookupTemplateClassSymbolInParentScopes (const SgName & name, SgScopeStatement *currentScope = NULL, SgTemplateParameterPtrList* templateParameterList = NULL, SgTemplateArgumentPtrList* templateArgumentList = NULL);
193  SgTemplateFunctionSymbol* lookupTemplateFunctionSymbolInParentScopes (const SgName & name, SgScopeStatement *currentScope = NULL, SgTemplateParameterPtrList* templateParameterList = NULL);
194  SgTemplateMemberFunctionSymbol* lookupTemplateMemberFunctionSymbolInParentScopes (const SgName & name, SgScopeStatement *currentScope = NULL, SgTemplateParameterPtrList* templateParameterList = NULL);
195 #endif
196 
197 // DQ (8/21/2013): Modified to make some of the newest function parameters be default arguments.
198 // DQ (8/13/2013): I am not sure if we want this functions in place of lookupTemplateSymbolInParentScopes.
199  ROSE_DLL_API SgTemplateClassSymbol* lookupTemplateClassSymbolInParentScopes (const SgName & name, SgTemplateParameterPtrList* templateParameterList, SgTemplateArgumentPtrList* templateArgumentList, SgScopeStatement *cscope = NULL);
200 
201  ROSE_DLL_API SgEnumSymbol* lookupEnumSymbolInParentScopes (const SgName & name, SgScopeStatement *currentScope = NULL);
202  ROSE_DLL_API SgNamespaceSymbol* lookupNamespaceSymbolInParentScopes(const SgName & name, SgScopeStatement *currentScope = NULL);
203 
204 // DQ (7/17/2011): Added function from cxx branch that I need here for the Java support.
205 // SgClassSymbol* lookupClassSymbolInParentScopes (const SgName & name, SgScopeStatement *cscope);
206 
215  // DQ (12/9/2004): Moved this function (by Alin Jula) from being a member of SgInitializedName
216  // to this location where it can be a part of the interface for the Sage III AST.
217  ROSE_DLL_API int set_name (SgInitializedName * initializedNameNode, SgName new_name);
218 
222 
223  // DQ (6/27/2005):
228  ROSE_DLL_API void outputLocalSymbolTables (SgNode * node);
229 
231  {
232  public:
233  void visit (SgNode * node);
234  };
240  // DQ (9/28/2005):
241  void rebuildSymbolTable (SgScopeStatement * scope);
242 
245  void clearUnusedVariableSymbols (SgNode* root = NULL);
246 
247  // DQ (3/1/2009):
249  void fixupReferencesToSymbols( const SgScopeStatement* this_scope, SgScopeStatement* copy_scope, SgCopyHelp & help );
250 
252 
253  //------------------------------------------------------------------------
255 
262  // DQ (9/21/2005): General function for extracting the name of declarations (when they have names)
263  std::string get_name (const SgNode * node);
264 
269  // DQ (6/13/2005): General function for extracting the name of declarations (when they have names)
270  std::string get_name (const SgStatement * stmt);
271 
276  std::string get_name (const SgExpression * expr);
277 
282  // DQ (6/13/2005): General function for extracting the name of declarations (when they have names)
283  std::string get_name (const SgDeclarationStatement * declaration);
284 
289  // DQ (6/13/2005): General function for extracting the name of declarations (when they have names)
290  std::string get_name (const SgScopeStatement * scope);
291 
296  // DQ (2/11/2007): Added this function to make debugging support more complete (useful for symbol table debugging support).
297  std::string get_name (const SgSymbol * symbol);
298 
303  std::string get_name (const SgType * type);
304 
305 
308  std::string get_name (const SgSupport * node);
309 
310 
313  std::string get_name (const SgLocatedNodeSupport * node);
314 
317  std::string get_name ( const SgC_PreprocessorDirectiveStatement* directive );
318 
321  std::string get_name ( const SgToken* token );
322 
323  // DQ (3/20/2016): Added to refactor some of the DSL infrastructure support.
333 
336  extern std::map<std::string,int> local_name_collision_map;
337  extern std::map<std::string,SgNode*> local_name_to_node_map;
338  extern std::map<SgNode*,std::string> local_node_to_name_map;
339 
343 
347 
349 
350  //------------------------------------------------------------------------
352 
357  // DQ (6/21/2005): Get the default destructor from the class declaration
359  classDeclaration);
360 
363  // DQ (6/22/2005): Get the default constructor from the class declaration
365  classDeclaration);
368  // DQ (8/27/2005):
370  * memberFunctionDeclaration);
371 
376  // DQ (9/17/2005):
379  (SgTemplateInstantiationMemberFunctionDecl * memberFunctionInstantiation);
380 
382  bool isStructDeclaration(SgNode * node);
384  bool isUnionDeclaration(SgNode * node);
385  #if 0
386  // DQ (8/28/2005): This is already a member function of the SgFunctionDeclaration
387  // (so that it can handle template functions and member functions)
388 
392  // DQ (8/27/2005):
393  bool isTemplateMemberFunction (SgTemplateInstantiationMemberFunctionDecl *
394  memberFunctionDeclaration);
395  #endif
396 
398 
399  //------------------------------------------------------------------------
401 
407 
409  void saveToPDF(SgNode* node, std::string filename);
410  void saveToPDF(SgNode* node); // enable calling from gdb
411 
413  void printAST (SgNode* node);
414 
416  void printAST2TextFile (SgNode* node, const char* filename);
417  void printAST2TextFile (SgNode* node, std::string filename);
418 
419  // DQ (2/12/2012): Added some diagnostic support.
421  void whereAmI(SgNode* node);
422 
424  std::string extractPragmaKeyword(const SgPragmaDeclaration *);
425 
427  ROSE_DLL_API bool isOmpStatement(SgNode* );
430  // DQ (8/27/2005):
431  bool isOverloaded (SgFunctionDeclaration * functionDeclaration);
432 
433 // DQ (2/14/2012): Added support function used for variable declarations in conditionals.
435  void initializeIfStmt(SgIfStmt *ifstmt, SgStatement* conditional, SgStatement * true_body, SgStatement * false_body);
436 
438  void initializeSwitchStatement(SgSwitchStatement* switchStatement,SgStatement *item_selector,SgStatement *body);
439 
441  void initializeWhileStatement(SgWhileStmt* whileStatement, SgStatement * condition, SgStatement *body, SgStatement *else_body);
442 
445 
447  ROSE_DLL_API bool isMain (const SgNode* node);
448  // DQ (6/22/2005):
459  std::string generateUniqueName ( const SgNode * node, bool ignoreDifferenceBetweenDefiningAndNondefiningDeclarations);
460 
463  std::string generateUniqueVariableName(SgScopeStatement* scope, std::string baseName = "temp");
464 
465  // DQ (8/10/2010): Added const to first parameter.
466  // DQ (3/10/2007):
468  std::string declarationPositionString (const SgDeclarationStatement * declaration);
469 
470  // DQ (1/20/2007):
472  ROSE_DLL_API std::string generateProjectName (const SgProject * project, bool supressSuffix = false );
473 
477 
480 
482  void addVarRefExpFromArrayDimInfo(SgNode * astNode, Rose_STL_Container<SgNode *>& NodeList_t);
483 
484  // DQ (10/6/2006): Added support for faster mangled name generation (caching avoids recomputation).
488 #ifndef SWIG
489 // DQ (3/10/2013): This appears to be a problem for the SWIG interface (undefined reference at link-time).
490  void clearMangledNameCache (SgGlobal * globalScope);
491  void resetMangledNameCache (SgGlobal * globalScope);
492 #endif
493 
494  std::string getMangledNameFromCache (SgNode * astNode);
495  std::string addMangledNameToCache (SgNode * astNode, const std::string & mangledName);
496 
498 
502 
503  // DQ (10/14/2006): This function tests the AST to see if for a non-defining declaration, the
504  // bool declarationPreceedsDefinition ( SgClassDeclaration* classNonDefiningDeclaration, SgClassDeclaration* classDefiningDeclaration );
506  bool declarationPreceedsDefinition (SgDeclarationStatement *nonDefiningDeclaration, SgDeclarationStatement *definingDeclaration);
507 
508  // DQ (10/19/2006): Function calls have interesting context dependent rules to determine if
509  // they are output with a global qualifier or not. Were this is true we have to avoid global
510  // qualifiers, since the function's scope has not been defined. This is an example of where
511  // qualification of function names in function calls are context dependent; an interesting
512  // example of where the C++ language is not friendly to source-to-source processing :-).
514 
519  ROSE_DLL_API std::vector < SgNode * >astIntersection (SgNode * original, SgNode * copy, SgCopyHelp * help = NULL);
520 
522  ROSE_DLL_API SgNode* deepCopyNode (const SgNode* subtree);
523 
525  template <typename NodeType>
526  NodeType* deepCopy (const NodeType* subtree) {
527  return dynamic_cast<NodeType*>(deepCopyNode(subtree));
528  }
529 
531  ROSE_DLL_API SgExpression* copyExpression(SgExpression* e);
532 
534  ROSE_DLL_API SgStatement* copyStatement(SgStatement* s);
535 
536 // from VarSym.cc in src/midend/astOutlining/src/ASTtools
539 
542 
544 ROSE_DLL_API void myRemoveStatement(SgStatement* stmt);
545 
546 ROSE_DLL_API bool isConstantTrue(SgExpression* e);
547 ROSE_DLL_API bool isConstantFalse(SgExpression* e);
548 
550 ROSE_DLL_API bool isCallToParticularFunction(const std::string& qualifiedName, size_t arity, SgExpression* e);
551 
553 bool ROSE_DLL_API isStatic(SgDeclarationStatement* stmt);
554 
556 ROSE_DLL_API void setStatic(SgDeclarationStatement* stmt);
557 
559 ROSE_DLL_API bool isExtern(SgDeclarationStatement* stmt);
560 
562 ROSE_DLL_API void setExtern(SgDeclarationStatement* stmt);
563 
567  public:
568  virtual ~StatementGenerator() {};
569  virtual SgStatement* generate(SgExpression* where_to_write_answer) = 0;
570 };
571 
575  bool isAssignmentStatement(SgNode* _s, SgExpression** lhs=NULL, SgExpression** rhs=NULL, bool* readlhs=NULL);
576 
578 ROSE_DLL_API SgInitializedName* convertRefToInitializedName(SgNode* current, bool coarseGrain=true);
579 
582 
584 ROSE_DLL_API SgNode* getSgNodeFromAbstractHandleString(const std::string& input_string);
585 
587 ROSE_DLL_API void dumpInfo(SgNode* node, std::string desc="");
588 
590 ROSE_DLL_API std::vector<SgDeclarationStatement*>
591 sortSgNodeListBasedOnAppearanceOrderInSource(const std::vector<SgDeclarationStatement*>& nodevec);
592 
593 // DQ (4/13/2013): We need these to support the unparing of operators defined by operator syntax or member function names.
595 // bool isPrefixOperator( const SgMemberFunctionRefExp* memberFunctionRefExp );
596 bool isPrefixOperator( SgExpression* exp );
597 
599 bool isPrefixOperatorName( const SgName & functionName );
600 
602 bool isPostfixOperator( SgExpression* exp );
603 
605 bool isIndexOperator( SgExpression* exp );
606 
607 // DQ (1/10/2014): Adding more general support for token based unparsing.
609 SgStatement* lastStatementOfScopeWithTokenInfo (SgScopeStatement* scope, std::map<SgNode*,TokenStreamSequenceToNodeMapping*> & tokenStreamSequenceMap);
610 
611 // DQ (8/12/2020): Check the access permissions of all defining and nodefining declarations.
613 
614 // DQ (8/14/2020): Check the symbol tables for specific scopes (debugging support).
615 void checkSymbolTables ( SgNode* );
616 
618 
619 //------------------------------------------------------------------------
621 
625 // std::string version(); // utility_functions.h, version number
628  ROSE_DLL_API bool is_Ada_language ();
629  ROSE_DLL_API bool is_C_language ();
630  ROSE_DLL_API bool is_Cobol_language ();
631  ROSE_DLL_API bool is_OpenMP_language ();
632  ROSE_DLL_API bool is_UPC_language ();
634  ROSE_DLL_API bool is_UPC_dynamic_threads();
635  ROSE_DLL_API bool is_C99_language ();
636  ROSE_DLL_API bool is_Cxx_language ();
637  ROSE_DLL_API bool is_Java_language ();
638  ROSE_DLL_API bool is_Jovial_language ();
639  ROSE_DLL_API bool is_Fortran_language ();
640  ROSE_DLL_API bool is_CAF_language ();
641  ROSE_DLL_API bool is_PHP_language();
642  ROSE_DLL_API bool is_Python_language();
643  ROSE_DLL_API bool is_Cuda_language();
644  ROSE_DLL_API bool is_OpenCL_language();
645  ROSE_DLL_API bool is_X10_language();
646  ROSE_DLL_API bool is_binary_executable();
647  ROSE_DLL_API bool is_mixed_C_and_Cxx_language ();
648  ROSE_DLL_API bool is_mixed_Fortran_and_C_language ();
649  ROSE_DLL_API bool is_mixed_Fortran_and_Cxx_language ();
650  ROSE_DLL_API bool is_mixed_Fortran_and_C_and_Cxx_language ();
651 
652  ROSE_DLL_API bool is_language_case_insensitive ();
654 
656 
657 //------------------------------------------------------------------------
659 
663  // DQ (10/5/2006): Added support for faster (non-quadratic) computation of unique
664  // labels for scopes in a function (as required for name mangling).
670  void resetScopeNumbers (SgFunctionDefinition * functionDeclaration);
671 
672  // DQ (10/5/2006): Added support for faster (non-quadratic) computation of unique
673  // labels for scopes in a function (as required for name mangling).
682  void clearScopeNumbers (SgFunctionDefinition * functionDefinition);
683 
684 
687 // SgNamespaceDefinitionStatement * getEnclosingNamespaceScope (SgNode * node);
688 
689  bool isPrototypeInScope (SgScopeStatement * scope,
690  SgFunctionDeclaration * functionDeclaration,
691  SgDeclarationStatement * startingAtDeclaration);
692 
694  bool ROSE_DLL_API isAncestor(SgNode* node1, SgNode* node2);
696 //------------------------------------------------------------------------
698 
702  void dumpPreprocInfo (SgLocatedNode* locatedNode);
704 
706 PreprocessingInfo * insertHeader(SgSourceFile * source_file, const std::string & header_file_name, bool isSystemHeader, bool asLastHeader);
707 
709 void insertHeader (SgStatement* stmt, PreprocessingInfo* newheader, bool asLastHeader);
710 
712 PreprocessingInfo * insertHeader(SgSourceFile * source_file, const std::string & header_file_name, bool isSystemHeader = false, PreprocessingInfo::RelativePositionType position = PreprocessingInfo::before);
713 
715 ROSE_DLL_API PreprocessingInfo* insertHeader(const std::string& filename, PreprocessingInfo::RelativePositionType position=PreprocessingInfo::after, bool isSystemHeader=false, SgScopeStatement* scope=NULL);
716 
718 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);
719 
721 ROSE_DLL_API void movePreprocessingInfo (SgStatement* stmt_src, SgStatement* stmt_dst, PreprocessingInfo::RelativePositionType src_position=PreprocessingInfo::undef,
722  PreprocessingInfo::RelativePositionType dst_position=PreprocessingInfo::undef, bool usePrepend= false);
723 
724 
726 ROSE_DLL_API void cutPreprocessingInfo (SgLocatedNode* src_node, PreprocessingInfo::RelativePositionType pos, AttachedPreprocessingInfoType& save_buf);
727 
729 ROSE_DLL_API void pastePreprocessingInfo (SgLocatedNode* dst_node, PreprocessingInfo::RelativePositionType pos, AttachedPreprocessingInfoType& saved_buf);
730 
733  const std::string & text,
734  PreprocessingInfo::RelativePositionType position=PreprocessingInfo::before);
735 
739 
742  SgSourceFile * source_file,
743  const std::string & content,
744  PreprocessingInfo::DirectiveType directive_type = PreprocessingInfo::C_StyleComment,
745  PreprocessingInfo::RelativePositionType position = PreprocessingInfo::before
746 );
747 
749  ROSE_DLL_API PreprocessingInfo* attachComment(SgLocatedNode* target, const std::string & content,
750  PreprocessingInfo::RelativePositionType position=PreprocessingInfo::before,
751  PreprocessingInfo::DirectiveType dtype= PreprocessingInfo::CpreprocessorUnknownDeclaration);
752 
753 // DQ (7/20/2008): I am not clear were I should put this function, candidates include: SgLocatedNode or SgInterface
755  ROSE_DLL_API void addTextForUnparser ( SgNode* astNode, std::string s, AstUnparseAttribute::RelativePositionType inputlocation );
756 
761 void guardNode(SgLocatedNode * target, std::string guard);
762 
764 
765 
766 //------------------------------------------------------------------------
768 
772 // ************************************************************************
773 // Newer versions of now depricated functions
774 // ************************************************************************
775 
776 // DQ (5/1/2012): This function queries the SageBuilder::SourcePositionClassification mode (stored in the SageBuilder
777 // interface) and used the specified mode to initialize the source position data (Sg_File_Info objects). This
778 // function is the only function that should be called directly (though in a namespace we can't define permissions).
780  ROSE_DLL_API void setSourcePosition(SgNode* node);
781 
782 // A better name might be "setSourcePositionForSubTree"
784  ROSE_DLL_API void setSourcePositionAtRootAndAllChildren(SgNode *root);
785 
788 
789 // DQ (5/1/2012): Newly renamed function (previous name preserved for backward compatability).
791 
792 // ************************************************************************
793 
794 
795 
796 // ************************************************************************
797 // Older deprecated functions
798 // ************************************************************************
799  // Liao, 1/8/2007, set file info. for a whole subtree as transformation generated
801  ROSE_DLL_API void setOneSourcePositionForTransformation(SgNode *node);
802 
804  ROSE_DLL_API void setOneSourcePositionNull(SgNode *node);
805 
807  ROSE_DLL_API void setSourcePositionForTransformation (SgNode * root);
808 
810 // ROSE_DLL_API void setSourcePositionForTransformation_memoryPool();
811 
813  ROSE_DLL_API bool insideSystemHeader (SgLocatedNode* node);
814 
816 // ROSE_DLL_API void setSourcePosition (SgLocatedNode * locatedNode);
817 // ************************************************************************
818 
820 
821 
822 //------------------------------------------------------------------------
824 
828 // from src/midend/astInlining/typeTraits.h
829 // src/midend/astUtil/astInterface/AstInterface.h
830 
833 
834 
838 ROSE_DLL_API bool isStrictIntegerType(SgType* t);
840 ROSE_DLL_API SgType* getFirstVarType(SgVariableDeclaration* decl);
841 
843 ROSE_DLL_API bool isDefaultConstructible(SgType* type);
844 
846 ROSE_DLL_API bool isCopyConstructible(SgType* type);
847 
849 ROSE_DLL_API bool isAssignable(SgType* type);
850 
851 #ifndef ROSE_USE_INTERNAL_FRONTEND_DEVELOPMENT
852 ROSE_DLL_API bool isPureVirtualClass(SgType* type, const ClassHierarchyWrapper& classHierarchy);
856 #endif
857 
859 ROSE_DLL_API bool hasTrivialDestructor(SgType* t);
860 
862 ROSE_DLL_API bool isNonconstReference(SgType* t);
863 
865 ROSE_DLL_API bool isReferenceType(SgType* t);
866 
868 ROSE_DLL_API bool isPointerType(SgType* t);
869 
875 ROSE_DLL_API bool isPointerToNonConstType(SgType* type);
876 
878 /* const char* p = "aa"; is not treated as having a const type. It is a pointer to const char.
879  * Similarly, neither for const int b[10]; or const int & c =10;
880  * The standard says, "A compound type is not cv-qualified by the cv-qualifiers (if any) of
881 the types from which it is compounded. Any cv-qualifiers applied to an array type affect the array element type, not the array type".
882  */
883 ROSE_DLL_API bool isConstType(SgType* t);
884 
887 
889 ROSE_DLL_API bool isVolatileType(SgType* t);
890 
892 ROSE_DLL_API bool isRestrictType(SgType* t);
893 
895 
897 ROSE_DLL_API bool isScalarType(SgType* t);
898 
902 ROSE_DLL_API bool isStrictIntegerType(SgType* t);
903 
905 ROSE_DLL_API bool isStructType(SgType* t);
906 
908 ROSE_DLL_API std::string mangleType(SgType* type);
909 
911 ROSE_DLL_API std::string mangleScalarType(SgType* type);
912 
914 ROSE_DLL_API std::string mangleModifierType(SgModifierType* type);
915 
917 ROSE_DLL_API size_t getArrayElementCount(SgArrayType* t);
918 
920 ROSE_DLL_API int getDimensionCount(SgType* t);
921 
923 ROSE_DLL_API SgType* getArrayElementType(SgType* t);
924 
926 ROSE_DLL_API SgType* getElementType(SgType* t);
927 
928 
945 std::vector<SgExpression*>
946 get_C_array_dimensions(const SgArrayType& arrtype);
947 
968 std::vector<SgExpression*>
969 get_C_array_dimensions(const SgArrayType& arrtype, const SgVarRefExp& varref);
970 
974 std::vector<SgExpression*>
975 get_C_array_dimensions(const SgArrayType& arrtype, SgInitializedName& initname);
976 
977 
979 ROSE_DLL_API bool isArrayReference(SgExpression* ref, SgExpression** arrayNameExp=NULL, std::vector<SgExpression*>** subscripts=NULL);
980 
981 
983 ROSE_DLL_API int collectVariableReferencesInArrayTypes (SgLocatedNode* root, Rose_STL_Container<SgNode*> & currentVarRefList);
985 
994 ROSE_DLL_API bool hasUpcSharedType(SgType* t, SgModifierType ** mod_type_out = NULL );
995 
997 
1000 ROSE_DLL_API bool isUpcSharedType(SgType* t, SgModifierType ** mod_type_out = NULL);
1001 
1003 ROSE_DLL_API bool isUpcSharedModifierType (SgModifierType* mod_type);
1004 
1006 ROSE_DLL_API bool isUpcSharedArrayType (SgArrayType* array_type);
1007 
1009 ROSE_DLL_API bool isUpcStrictSharedModifierType(SgModifierType* mode_type);
1010 
1012 ROSE_DLL_API size_t getUpcSharedBlockSize(SgModifierType* mod_type);
1013 
1015 ROSE_DLL_API size_t getUpcSharedBlockSize(SgType* t);
1016 
1018 ROSE_DLL_API bool isUpcPhaseLessSharedType (SgType* t);
1019 
1021 ROSE_DLL_API bool isUpcPrivateToSharedType(SgType* t);
1022 
1024 ROSE_DLL_API bool isUpcArrayWithThreads(SgArrayType* t);
1025 
1027 ROSE_DLL_API SgType* lookupNamedTypeInParentScopes(const std::string& type_name, SgScopeStatement* scope=NULL);
1028 
1029 // DQ (7/22/2014): Added support for comparing expression types in actual arguments with those expected from the formal function parameter types.
1031 ROSE_DLL_API SgType* getAssociatedTypeFromFunctionTypeList(SgExpression* actual_argument_expression);
1032 
1034 ROSE_DLL_API bool templateArgumentEquivalence(SgTemplateArgument * arg1, SgTemplateArgument * arg2);
1035 
1037 ROSE_DLL_API bool templateArgumentListEquivalence(const SgTemplateArgumentPtrList & list1, const SgTemplateArgumentPtrList & list2);
1038 
1040 ROSE_DLL_API bool isEquivalentType (const SgType* lhs, const SgType* rhs);
1041 
1042 
1045 ROSE_DLL_API bool isEquivalentFunctionType (const SgFunctionType* lhs, const SgFunctionType* rhs);
1046 
1048 
1049 //------------------------------------------------------------------------
1051 
1055 // by Jeremiah
1064 ROSE_DLL_API void addStepToLoopBody(SgScopeStatement* loopStmt, SgStatement* step);
1065 
1067 ROSE_DLL_API void convertForToWhile(SgForStatement* f);
1068 ROSE_DLL_API void convertAllForsToWhiles(SgNode* top);
1070 ROSE_DLL_API void changeContinuesToGotos(SgStatement* stmt, SgLabelStatement* label);
1071 
1073 ROSE_DLL_API SgInitializedName* getLoopIndexVariable(SgNode* loop);
1074 
1077 ROSE_DLL_API bool isLoopIndexVariable(SgInitializedName* ivar, SgNode* subtree_root);
1078 
1080 
1084 ROSE_DLL_API bool hasMultipleInitStatmentsOrExpressions (SgForStatement* for_loop);
1085 
1087 ROSE_DLL_API SgStatement* getLoopBody(SgScopeStatement* loop);
1088 
1089 ROSE_DLL_API void setLoopBody(SgScopeStatement* loop, SgStatement* body);
1090 
1092 ROSE_DLL_API SgStatement* getLoopCondition(SgScopeStatement* loop);
1093 
1095 ROSE_DLL_API void setLoopCondition(SgScopeStatement* loop, SgStatement* cond);
1096 
1100 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);
1101 
1103 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*/);
1104 
1106 ROSE_DLL_API void setLoopLowerBound(SgNode* loop, SgExpression* lb);
1107 
1109 ROSE_DLL_API void setLoopUpperBound(SgNode* loop, SgExpression* ub);
1110 
1112 ROSE_DLL_API void setLoopStride(SgNode* loop, SgExpression* stride);
1113 
1114 
1116 ROSE_DLL_API bool normalizeForLoopInitDeclaration(SgForStatement* loop);
1117 
1119 ROSE_DLL_API bool unnormalizeForLoopInitDeclaration(SgForStatement* loop);
1120 
1132 ROSE_DLL_API bool forLoopNormalization(SgForStatement* loop, bool foldConstant = true);
1133 
1137 ROSE_DLL_API bool normalizeForLoopTest(SgForStatement* loop);
1138 ROSE_DLL_API bool normalizeForLoopIncrement(SgForStatement* loop);
1139 
1141 ROSE_DLL_API bool doLoopNormalization(SgFortranDo* loop);
1142 
1144 ROSE_DLL_API bool loopUnrolling(SgForStatement* loop, size_t unrolling_factor);
1145 
1147 ROSE_DLL_API bool loopInterchange(SgForStatement* loop, size_t depth, size_t lexicoOrder);
1148 
1150 ROSE_DLL_API bool loopTiling(SgForStatement* loopNest, size_t targetLevel, size_t tileSize);
1151 
1152 //Winnie Loop Collapsing
1153 SgExprListExp * loopCollapsing(SgForStatement* target_loop, size_t collapsing_factor);
1154 
1156  SgForStatement * for_loop,
1157  SgVariableSymbol * & iterator,
1158  SgExpression * & lower_bound,
1159  SgExpression * & upper_bound,
1160  SgExpression * & stride
1161 );
1162 
1164 
1165 //------------------------------------------------------------------------
1167 
1171 template <typename NodeType>
1173 std::vector<NodeType*> querySubTree(SgNode* top, VariantT variant = (VariantT)NodeType::static_variant)
1174  {
1175 #if 0
1176  printf ("Top of SageInterface::querySubTree() \n");
1177 #endif
1178 
1179  Rose_STL_Container<SgNode*> nodes = NodeQuery::querySubTree(top,variant);
1180  std::vector<NodeType*> result(nodes.size(), NULL);
1181  int count = 0;
1182 #if 0
1183  printf ("In SageInterface::querySubTree(): before initialization loop \n");
1184 #endif
1185 
1186  for (Rose_STL_Container<SgNode*>::const_iterator i = nodes.begin(); i != nodes.end(); ++i, ++count)
1187  {
1188 #if 0
1189  printf ("In SageInterface::querySubTree(): in loop: count = %d \n",count);
1190 #endif
1191  NodeType* node = dynamic_cast<NodeType*>(*i);
1192  ROSE_ASSERT (node);
1193  result[count] = node;
1194  }
1195 #if 0
1196  printf ("Leaving SageInterface::querySubTree(): after initialization loop \n");
1197 #endif
1198 
1199  return result;
1200  }
1205  std::vector < SgFile * >generateFileList ();
1206 
1211 ROSE_DLL_API SgProject * getProject();
1212 
1214  SgProject * getProject(const SgNode * node);
1215 
1217 template <typename NodeType>
1218 static std::vector<NodeType*> getSgNodeListFromMemoryPool()
1219 {
1220  // This function uses a memory pool traversal specific to the SgFile IR nodes
1221  class MyTraversal : public ROSE_VisitTraversal
1222  {
1223  public:
1224  std::vector<NodeType*> resultlist;
1225  void visit ( SgNode* node)
1226  {
1227  NodeType* result = dynamic_cast<NodeType* > (node);
1228  ROSE_ASSERT(result!= NULL);
1229  if (result!= NULL)
1230  {
1231  resultlist.push_back(result);
1232  }
1233  };
1234  virtual ~MyTraversal() {}
1235  };
1236 
1237  MyTraversal my_traversal;
1238  NodeType::traverseMemoryPoolNodes(my_traversal);
1239  return my_traversal.resultlist;
1240 }
1241 
1242 
1245 ROSE_DLL_API SgFunctionDeclaration* findMain(SgNode* currentNode);
1246 
1248 SgStatement* findLastDeclarationStatement(SgScopeStatement * scope, bool includePragma = false);
1249 
1250  //midend/programTransformation/partialRedundancyElimination/pre.h
1252 std::vector<SgVariableSymbol*> getSymbolsUsedInExpression(SgExpression* expr);
1253 
1255 
1260 std::vector<SgBreakStmt*> findBreakStmts(SgStatement* code, const std::string& fortranLabel = "");
1261 
1263 
1268 std::vector<SgContinueStmt*> findContinueStmts(SgStatement* code, const std::string& fortranLabel = "");
1269 std::vector<SgGotoStatement*> findGotoStmts(SgStatement* scope, SgLabelStatement* l);
1270 std::vector<SgStatement*> getSwitchCases(SgSwitchStatement* sw);
1271 
1273 void collectVarRefs(SgLocatedNode* root, std::vector<SgVarRefExp* >& result);
1274 
1276 template <typename T>
1277 T* findDeclarationStatement(SgNode* root, std::string name, SgScopeStatement* scope, bool isDefining)
1278  {
1279  bool found = false;
1280 
1281 #if 0
1282  printf ("In findDeclarationStatement(): root = %p \n",root);
1283  printf ("In findDeclarationStatement(): name = %s \n",name.c_str());
1284  printf ("In findDeclarationStatement(): scope = %p \n",scope);
1285  printf ("In findDeclarationStatement(): isDefining = %s \n",isDefining ? "true" : "false");
1286 #endif
1287 
1288  // Do we really want a NULL pointer to be acceptable input to this function?
1289  // Maybe we should have an assertion that it is non-null?
1290  if (!root) return NULL;
1291 
1292  T* decl = dynamic_cast<T*>(root);
1293 
1294 #if 0
1295  printf ("In findDeclarationStatement(): decl = %p \n",decl);
1296 #endif
1297 
1298  if (decl != NULL)
1299  {
1300  if (scope)
1301  {
1302  if ((decl->get_scope() == scope) && (decl->search_for_symbol_from_symbol_table()->get_name() == name))
1303  {
1304  found = true;
1305  }
1306  }
1307  else // Liao 2/9/2010. We should allow NULL scope
1308  {
1309 #if 0
1310  // DQ (12/6/2016): Include this into the debugging code to aboid compiler warning about unused variable.
1311  SgSymbol* symbol = decl->search_for_symbol_from_symbol_table();
1312  printf ("In findDeclarationStatement(): decl->search_for_symbol_from_symbol_table() = %p \n",symbol);
1313  printf ("In findDeclarationStatement(): decl->search_for_symbol_from_symbol_table()->get_name() = %s \n",symbol->get_name().str());
1314 #endif
1315  if (decl->search_for_symbol_from_symbol_table()->get_name() == name)
1316  {
1317  found = true;
1318  }
1319  }
1320  }
1321 
1322  if (found)
1323  {
1324  if (isDefining)
1325  {
1326 #if 0
1327  printf ("In findDeclarationStatement(): decl->get_firstNondefiningDeclaration() = %p \n",decl->get_firstNondefiningDeclaration());
1328  printf ("In findDeclarationStatement(): decl->get_definingDeclaration() = %p \n",decl->get_definingDeclaration());
1329 #endif
1330  ROSE_ASSERT (decl->get_definingDeclaration() != NULL);
1331 #if 0
1332  printf ("In findDeclarationStatement(): returing decl->get_definingDeclaration() = %p \n",decl->get_definingDeclaration());
1333 #endif
1334  return dynamic_cast<T*> (decl->get_definingDeclaration());
1335  }
1336  else
1337  {
1338 #if 0
1339  printf ("In findDeclarationStatement(): returing decl = %p \n",decl);
1340 #endif
1341  return decl;
1342  }
1343  }
1344 
1345  std::vector<SgNode*> children = root->get_traversalSuccessorContainer();
1346 
1347 #if 0
1348  printf ("In findDeclarationStatement(): children.size() = %zu \n",children.size());
1349 #endif
1350 
1351  // DQ (4/10/2016): Note that if we are searching for a function member that has it's defining
1352  // declaration defined outside of the class then it will not be found in the child list.
1353  for (std::vector<SgNode*>::const_iterator i = children.begin(); i != children.end(); ++i)
1354  {
1355  T* target = findDeclarationStatement<T> (*i,name,scope,isDefining);
1356 
1357  if (target)
1358  {
1359  return target;
1360  }
1361  }
1362 
1363  return NULL;
1364  }
1366  SgFunctionDeclaration* findFunctionDeclaration(SgNode* root, std::string name, SgScopeStatement* scope, bool isDefining);
1367 
1368 #if 0 //TODO
1369  // 1. preorder traversal from current SgNode till find next SgNode of type V_SgXXX
1370  // until reach the end node
1371  SgNode* getNextSgNode( const SgNode* astSourceNode, VariantT=V_SgNode, SgNode* astEndNode=NULL);
1372 
1373  // 2. return all nodes of type VariantT following the source node
1374  std::vector<SgNode*> getAllNextSgNode( const SgNode* astSourceNode, VariantT=V_SgNode, SgNode* astEndNode=NULL);
1375 #endif
1376 
1378 
1379 //------------------------------------------------------------------------
1381 
1384 // remember to put const to all arguments.
1385 
1386 
1401 template <typename NodeType>
1402 NodeType* getEnclosingNode(const SgNode* astNode, const bool includingSelf = false)
1403  {
1404 #define DEBUG_GET_ENCLOSING_NODE 0
1405 
1406 #if 1
1407  // DQ (12/31/2019): This version does not detect a cycle that Robb's version detects in processing Cxx11_tests/test2016_23.C.
1408  // This will have to be investigated seperately from the issue I am working on currently.
1409 
1410  // DQ (10/20/2012): This is the older version of this implementation. Until I am sure that
1411  // the newer version (below) is what we want to use I will resolve this conflict by keeping
1412  // the previous version in place.
1413 
1414  if (NULL == astNode)
1415  {
1416  return NULL;
1417  }
1418 
1419  if ( (includingSelf ) && (dynamic_cast<const NodeType*>(astNode)) )
1420  {
1421  return const_cast<NodeType*>(dynamic_cast<const NodeType*> (astNode));
1422  }
1423 
1424  // DQ (3/5/2012): Check for reference to self...
1425  ROSE_ASSERT(astNode->get_parent() != astNode);
1426 
1427  SgNode* parent = astNode->get_parent();
1428 
1429  // DQ (3/5/2012): Check for loops that will cause infinite loops.
1430  SgNode* previouslySeenParent = parent;
1431  bool foundCycle = false;
1432  int counter = 0;
1433 
1434 #if DEBUG_GET_ENCLOSING_NODE
1435  printf ("In getEnclosingNode(): previouslySeenParent = %p = %s \n",previouslySeenParent,previouslySeenParent->class_name().c_str());
1436 #endif
1437 
1438  while ( (foundCycle == false) && (parent != NULL) && (!dynamic_cast<const NodeType*>(parent)) )
1439  {
1440  ROSE_ASSERT(parent->get_parent() != parent);
1441 
1442 #if DEBUG_GET_ENCLOSING_NODE
1443  printf (" --- parent = %p = %s \n",parent,parent->class_name().c_str());
1444  printf (" --- --- parent->get_parent() = %p = %s \n",parent->get_parent(),parent->get_parent()->class_name().c_str());
1445 #endif
1446 
1447 #if 1
1448  // DQ (1/8/2020): ROSE-82 (on RZ) This limit needs to be larger and increasing it to 500 was enough
1449  // for a specific code with a long chain of if-then-else nesting, So to make this sufficent for more
1450  // general code we have increased the lomit to 100,000. Note that 50 was not enough for real code,
1451  // but was enough for our regression tests.
1452  // DQ (12/30/2019): This is added to support detection of infinite loops over parent pointers.
1453  // if (counter >= 500)
1454  if (counter >= 100000)
1455  {
1456  printf ("Exiting: In getEnclosingNode(): loop limit exceeded: counter = %d \n",counter);
1457  ROSE_ASSERT(false);
1458  }
1459 #endif
1460  parent = parent->get_parent();
1461 
1462  // DQ (3/5/2012): Check for loops that will cause infinite loops.
1463  // ROSE_ASSERT(parent != previouslySeenParent);
1464  if (parent == previouslySeenParent)
1465  {
1466  foundCycle = true;
1467  }
1468  counter++;
1469 
1470  }
1471 
1472 #if DEBUG_GET_ENCLOSING_NODE
1473  printf ("previouslySeenParent = %p = %s \n",previouslySeenParent,previouslySeenParent->class_name().c_str());
1474 #endif
1475 
1476  parent = previouslySeenParent;
1477 
1478  SgDeclarationStatement* declarationStatement = isSgDeclarationStatement(parent);
1479  if (declarationStatement != NULL)
1480  {
1481 #if 0
1482  printf ("Found a SgDeclarationStatement \n");
1483 #endif
1484  SgDeclarationStatement* definingDeclaration = declarationStatement->get_definingDeclaration();
1485  SgDeclarationStatement* firstNondefiningDeclaration = declarationStatement->get_firstNondefiningDeclaration();
1486 
1487 #if 0
1488  printf (" --- declarationStatement = %p \n",declarationStatement);
1489  printf (" --- definingDeclaration = %p \n",definingDeclaration);
1490  if (definingDeclaration != NULL && definingDeclaration->get_parent() != NULL)
1491  printf (" --- definingDeclaration ->get_parent() = %p = %s \n",definingDeclaration->get_parent(),definingDeclaration->get_parent()->class_name().c_str());
1492  printf (" --- firstNondefiningDeclaration = %p \n",firstNondefiningDeclaration);
1493  if (firstNondefiningDeclaration != NULL && firstNondefiningDeclaration->get_parent() != NULL)
1494  printf (" --- firstNondefiningDeclaration ->get_parent() = %p = %s \n",firstNondefiningDeclaration->get_parent(),firstNondefiningDeclaration->get_parent()->class_name().c_str());
1495 #endif
1496  if (definingDeclaration != NULL && declarationStatement != firstNondefiningDeclaration)
1497  {
1498 #if 0
1499  printf ("Found a nondefining declaration so use the non-defining declaration instead \n");
1500 #endif
1501  // DQ (10/19/2012): Use the defining declaration instead.
1502  // parent = firstNondefiningDeclaration;
1503  parent = definingDeclaration;
1504  }
1505  }
1506 
1507 #if 0
1508  printf ("reset: previouslySeenParent = %p = %s \n",previouslySeenParent,previouslySeenParent->class_name().c_str());
1509 #endif
1510 
1511  // DQ (10/19/2012): This branch is just to document the cycle that was previously detected, it is for
1512  // debugging only. Thus it ony make sense for it to be executed when "(foundCycle == true)". However,
1513  // this will have to be revisited later since it appears clear that it is a problem for the binary analysis
1514  // work when it is visited for this case. Since the cycle is detected, but there is no assertion on the
1515  // cycle, we don't exit when a cycle is identified (which is the point of the code below).
1516  // Note also that I have fixed the code (above and below) to only chase pointers through defining
1517  // declarations (where they exist), this is important since non-defining declarations can be almost
1518  // anywhere (and thus chasing them can make it appear that there are cycles where there are none
1519  // (I think); test2012_234.C demonstrates an example of this.
1520  // DQ (10/9/2012): Robb has suggested this change to fix the binary analysis work.
1521  // if (foundCycle == true)
1522  if (foundCycle == false)
1523  {
1524 
1525 
1526  while ( (parent != NULL) && (!dynamic_cast<const NodeType*>(parent)) )
1527  {
1528  ROSE_ASSERT(parent->get_parent() != parent);
1529 #if 0
1530  printf ("In getEnclosingNode() (2nd try): parent = %p = %s \n",parent,parent->class_name().c_str());
1531  if (parent->get_file_info() != NULL)
1532  parent->get_file_info()->display("In getEnclosingNode() (2nd try): debug");
1533 #endif
1534  SgDeclarationStatement* declarationStatement = isSgDeclarationStatement(parent);
1535  if (declarationStatement != NULL)
1536  {
1537 #if DEBUG_GET_ENCLOSING_NODE
1538  printf ("Found a SgDeclarationStatement \n");
1539 #endif
1540  SgDeclarationStatement* definingDeclaration = declarationStatement->get_definingDeclaration();
1541  SgDeclarationStatement* firstNondefiningDeclaration = declarationStatement->get_firstNondefiningDeclaration();
1542 #if 0
1543  printf (" --- declarationStatement = %p = %s \n",declarationStatement,(declarationStatement != NULL) ? declarationStatement->class_name().c_str() : "null");
1544 
1545  printf (" --- definingDeclaration = %p \n",definingDeclaration);
1546  if (definingDeclaration != NULL && definingDeclaration->get_parent() != NULL)
1547  printf (" --- definingDeclaration ->get_parent() = %p = %s \n",definingDeclaration->get_parent(),definingDeclaration->get_parent()->class_name().c_str());
1548 
1549  printf (" --- firstNondefiningDeclaration = %p \n",firstNondefiningDeclaration);
1550  if (firstNondefiningDeclaration != NULL && firstNondefiningDeclaration->get_parent() != NULL)
1551  printf (" --- firstNondefiningDeclaration ->get_parent() = %p = %s \n",firstNondefiningDeclaration->get_parent(),firstNondefiningDeclaration->get_parent()->class_name().c_str());
1552 #endif
1553  if (definingDeclaration != NULL && declarationStatement != firstNondefiningDeclaration)
1554  {
1555 #if 0
1556  printf ("Found a nondefining declaration so use the firstNondefining declaration instead \n");
1557 #endif
1558  // DQ (10/19/2012): Use the defining declaration instead.
1559  // parent = firstNondefiningDeclaration;
1560  parent = definingDeclaration;
1561  }
1562  }
1563 
1564  parent = parent->get_parent();
1565 
1566 #if 1
1567  // DQ (3/5/2012): Check for loops that will cause infinite loops.
1568  ROSE_ASSERT(parent != previouslySeenParent);
1569 #else
1570  printf ("WARNING::WARNING::WARNING commented out assertion for parent != previouslySeenParent \n");
1571  if (parent == previouslySeenParent)
1572  break;
1573 #endif
1574  }
1575  }
1576 
1577  return const_cast<NodeType*>(dynamic_cast<const NodeType*> (parent));
1578 #else
1579  // DQ (10/20/2012): Using Robb's newer version with my modification to use the definingDeclaration rather than firstNondefiningDeclaration (below).
1580 
1581  // Find the parent of specified type, but watch out for cycles in the ancestry (which would cause an infinite loop).
1582  // Cast away const because isSg* functions aren't defined for const node pointers; and our return is not const.
1583  SgNode *node = const_cast<SgNode*>(!astNode || includingSelf ? astNode : astNode->get_parent());
1584  std::set<const SgNode*> seen; // nodes we've seen, in order to detect cycles
1585  while (node) {
1586  if (NodeType *found = dynamic_cast<NodeType*>(node))
1587  return found;
1588 
1589  // FIXME: Cycle detection could be moved elsewhere so we don't need to do it on every call. [RPM 2012-10-09]
1590  // DQ (12/30/2019): Provide more detail in error message.
1591  if (seen.insert(node).second == false)
1592  {
1593  printf ("Error: node is already in set and defines a cycle: node = %p = %s \n",node,node->class_name().c_str());
1594  std::set<const SgNode*>::const_iterator i = seen.begin();
1595  while (i != seen.end())
1596  {
1597  const SgNode* element = *i;
1598  printf (" --- seen element: element = %p = %s \n",element,element->class_name().c_str());
1599  i++;
1600  }
1601 
1602  printf ("Exiting after error! \n");
1603  ROSE_ASSERT(false);
1604  }
1605  // ROSE_ASSERT(seen.insert(node).second);
1606 
1607  // Traverse to parent (declaration statements are a special case)
1608  if (SgDeclarationStatement *declarationStatement = isSgDeclarationStatement(node)) {
1609  SgDeclarationStatement *definingDeclaration = declarationStatement->get_definingDeclaration();
1610  SgDeclarationStatement *firstNondefiningDeclaration = declarationStatement->get_firstNondefiningDeclaration();
1611  if (definingDeclaration && firstNondefiningDeclaration && declarationStatement != firstNondefiningDeclaration) {
1612  // DQ (10/19/2012): Use the defining declaration instead.
1613  // node = firstNondefiningDeclaration;
1614  node = definingDeclaration;
1615  }
1616  } else {
1617  node = node->get_parent();
1618  }
1619  }
1620  return NULL;
1621 #endif
1622  }
1623 
1625  ROSE_DLL_API SgSourceFile* getEnclosingSourceFile(SgNode* n, const bool includingSelf=false);
1626 
1628  ROSE_DLL_API SgScopeStatement* getScope(const SgNode* astNode);
1629 
1631  ROSE_DLL_API SgScopeStatement* getEnclosingScope(SgNode* n, const bool includingSelf=false);
1632 
1634  ROSE_DLL_API SgGlobal* getGlobalScope( const SgNode* astNode);
1635 
1636 
1638  ROSE_DLL_API SgFunctionDefinition* getEnclosingProcedure(SgNode* n, const bool includingSelf=false);
1639 
1640  ROSE_DLL_API SgFunctionDefinition* getEnclosingFunctionDefinition(SgNode* astNode, const bool includingSelf=false);
1641 
1643  ROSE_DLL_API SgStatement* getEnclosingStatement(SgNode* n);
1644 
1647 
1650 
1652  ROSE_DLL_API SgScopeStatement* findEnclosingLoop(SgStatement* s, const std::string& fortranLabel = "", bool stopOnSwitches = false);
1653 
1655  ROSE_DLL_API SgFunctionDeclaration * getEnclosingFunctionDeclaration (SgNode * astNode, const bool includingSelf=false);
1656  //roseSupport/utility_functions.h
1658  ROSE_DLL_API SgFile* getEnclosingFileNode (SgNode* astNode );
1659 
1662 
1664  ROSE_DLL_API SgClassDefinition* getEnclosingClassDefinition(SgNode* astnode, const bool includingSelf=false);
1665 
1667  ROSE_DLL_API SgClassDeclaration* getEnclosingClassDeclaration( SgNode* astNode );
1668 
1669  // DQ (2/7/2019): Adding support for name qualification of variable references associated with SgPointerMemberType function parameters.
1671  ROSE_DLL_API SgExprListExp* getEnclosingExprListExp(SgNode* astNode, const bool includingSelf = false);
1672 
1673  // DQ (2/7/2019): Need a function to return when an expression is in an expression subtree.
1674  // This is part of index evaluation ofr expressions in function argument lists, but likely usefule elsewhere as well.
1675  ROSE_DLL_API bool isInSubTree(SgExpression* subtree, SgExpression* exp);
1676 
1677  // DQ (2/7/2019): Need a function to return the SgFunctionDeclaration from a SgFunctionCallExp.
1678  ROSE_DLL_API SgFunctionDeclaration* getFunctionDeclaration ( SgFunctionCallExp* functionCallExp );
1679 
1680  // DQ (2/17/2019): Generalizing this support for SgVarRefExp and SgMemberFunctionRefExp nodes.
1681  // DQ (2/8/2019): Adding support for detecting when to use added name qualification for pointer-to-member expressions.
1682  ROSE_DLL_API bool isDataMemberReference(SgVarRefExp* varRefExp);
1683  // ROSE_DLL_API bool isAddressTaken(SgVarRefExp* varRefExp);
1684  ROSE_DLL_API bool isAddressTaken(SgExpression* refExp);
1685 
1686  // DQ (2/17/2019): Adding support for detecting when to use added name qualification for membr function references.
1687  ROSE_DLL_API bool isMemberFunctionMemberReference(SgMemberFunctionRefExp* memberFunctionRefExp);
1688 
1689  // DQ (2/15/2019): Adding support for detecting which class a member reference is being made from.
1690  // ROSE_DLL_API SgClassType* getClassTypeForDataMemberReference(SgVarRefExp* varRefExp);
1691  // ROSE_DLL_API std::list<SgClassType*> getClassTypeChainForDataMemberReference(SgVarRefExp* varRefExp);
1692  ROSE_DLL_API std::list<SgClassType*> getClassTypeChainForMemberReference(SgExpression* refExp);
1693 
1694  ROSE_DLL_API std::set<SgNode*> getFrontendSpecificNodes();
1695 
1696  // DQ (2/17/2019): Display the shared nodes in the AST for debugging.
1697  ROSE_DLL_API void outputSharedNodes( SgNode* node );
1698 
1699 
1700 // TODO
1701 #if 0
1702  SgNode * getEnclosingSgNode(SgNode* source,VariantT, SgNode* endNode=NULL);
1703  std::vector<SgNode *> getAllEnclosingSgNode(SgNode* source,VariantT, SgNode* endNode=NULL);
1704  SgVariableDeclaration* findVariableDeclaratin( const string& varname)
1705 
1707 
1708  // e.g. for some expression, find its parent statement
1709  SgStatement* getEnclosingStatement(const SgNode* astNode);
1710 
1711  SgSwitchStatement* getEnclosingSwitch(SgStatement* s);
1712  SgModuleStatement* getEnclosingModuleStatement( const SgNode* astNode);
1713 
1714  // used to build a variable reference for compiler generated code in current scope
1715  SgSymbol * findReachingDefinition (SgScopeStatement* startScope, SgName &name);
1716 #endif
1717 
1718 
1719 //------------------------------------------------------------------------
1721 
1724  // Liao, 1/9/2008
1728  ROSE_DLL_API SgGlobal * getFirstGlobalScope(SgProject *project);
1729 
1733  ROSE_DLL_API SgStatement* getLastStatement(SgScopeStatement *scope);
1734 
1736  ROSE_DLL_API SgStatement* getFirstStatement(SgScopeStatement *scope,bool includingCompilerGenerated=false);
1739 
1741  ROSE_DLL_API SgStatement* getNextStatement(SgStatement * currentStmt);
1742 
1744  ROSE_DLL_API SgStatement* getPreviousStatement(SgStatement * currentStmt, bool climbOutScope = true);
1745 #if 0 //TODO
1746  // preorder traversal from current SgNode till find next SgNode of type V_SgXXX
1747  SgNode* getNextSgNode( const SgNode* currentNode, VariantT=V_SgNode);
1748 #endif
1749 
1750  // DQ (11/15/2018): Adding support for traversals over the include file tree.
1752  void listHeaderFiles ( SgIncludeFile* includeFile );
1753 
1754 
1756 
1757 //------------------------------------------------------------------------
1759 
1762  ROSE_DLL_API bool isEqualToIntConst(SgExpression* e, int value);
1764 
1766 
1769  ROSE_DLL_API bool isSameFunction(SgFunctionDeclaration* func1, SgFunctionDeclaration* func2);
1770 
1772  ROSE_DLL_API bool isLastStatement(SgStatement* stmt);
1773 
1775 
1776 //------------------------------------------------------------------------
1778 
1784 // DQ (2/24/2009): Simple function to delete an AST subtree (used in outlining).
1786 ROSE_DLL_API void deleteAST(SgNode* node);
1787 
1790 
1791 // DQ (2/25/2009): Added new function to support outliner.
1793 ROSE_DLL_API void moveStatementsBetweenBlocks ( SgBasicBlock* sourceBlock, SgBasicBlock* targetBlock );
1794 
1796 ROSE_DLL_API void moveVariableDeclaration(SgVariableDeclaration* decl, SgScopeStatement* target_scope);
1798 ROSE_DLL_API void appendStatement(SgStatement *stmt, SgScopeStatement* scope=NULL);
1799 
1801 ROSE_DLL_API void appendStatement(SgStatement *stmt, SgForInitStatement* for_init_stmt);
1802 
1804 ROSE_DLL_API void appendStatementList(const std::vector<SgStatement*>& stmt, SgScopeStatement* scope=NULL);
1805 
1806 // DQ (2/6/2009): Added function to support outlining into separate file.
1808 ROSE_DLL_API void appendStatementWithDependentDeclaration( SgDeclarationStatement* decl, SgGlobal* scope, SgStatement* original_statement, bool excludeHeaderFiles );
1809 
1812 ROSE_DLL_API void prependStatement(SgStatement *stmt, SgScopeStatement* scope=NULL);
1813 
1815 ROSE_DLL_API void prependStatement(SgStatement *stmt, SgForInitStatement* for_init_stmt);
1816 
1819 ROSE_DLL_API void prependStatementList(const std::vector<SgStatement*>& stmt, SgScopeStatement* scope=NULL);
1820 
1824 ROSE_DLL_API bool hasSimpleChildrenList (SgScopeStatement* scope);
1825 
1827 ROSE_DLL_API void insertStatement(SgStatement *targetStmt, SgStatement* newStmt, bool insertBefore= true, bool autoMovePreprocessingInfo = true);
1828 
1830 //target's scope
1831 ROSE_DLL_API void insertStatementList(SgStatement *targetStmt, const std::vector<SgStatement*>& newStmts, bool insertBefore= true);
1832 
1834 ROSE_DLL_API void insertStatementBefore(SgStatement *targetStmt, SgStatement* newStmt, bool autoMovePreprocessingInfo = true);
1835 
1837 ROSE_DLL_API void insertStatementListBefore(SgStatement *targetStmt, const std::vector<SgStatement*>& newStmts);
1838 
1840 ROSE_DLL_API void insertStatementAfter(SgStatement *targetStmt, SgStatement* newStmt, bool autoMovePreprocessingInfo = true);
1841 
1843 ROSE_DLL_API void insertStatementListAfter(SgStatement *targetStmt, const std::vector<SgStatement*>& newStmt);
1844 
1846 ROSE_DLL_API void insertStatementAfterLastDeclaration(SgStatement* stmt, SgScopeStatement* scope);
1847 
1849 ROSE_DLL_API void insertStatementAfterLastDeclaration(std::vector<SgStatement*> stmt_list, SgScopeStatement* scope);
1850 
1852 // then the statement is inserted at the end of the scope.
1853 ROSE_DLL_API void insertStatementBeforeFirstNonDeclaration(SgStatement *newStmt, SgScopeStatement *scope,
1854  bool movePreprocessingInfo=true);
1855 
1857 //then the new statements are inserted at the end of the scope.
1858 ROSE_DLL_API void insertStatementListBeforeFirstNonDeclaration(const std::vector<SgStatement*> &newStmts, SgScopeStatement *scope);
1859 
1860 // 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.
1861 ROSE_DLL_API SgStatement* lastFrontEndSpecificStatement( SgGlobal* globalScope );
1862 
1864 ROSE_DLL_API void removeStatement(SgStatement* stmt, bool autoRelocatePreprocessingInfo = true);
1865 
1867 ROSE_DLL_API void deepDelete(SgNode* root);
1868 
1870 ROSE_DLL_API void replaceStatement(SgStatement* oldStmt, SgStatement* newStmt, bool movePreprocessinInfo = false);
1871 
1873 ROSE_DLL_API SgNode* replaceWithPattern (SgNode * anchor, SgNode* new_pattern);
1874 
1876 // Essentially replace variable a with b.
1877 ROSE_DLL_API void replaceVariableReferences(SgVariableSymbol* old_sym, SgVariableSymbol* new_sym, SgScopeStatement * scope );
1878 
1879 // 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.
1883 ROSE_DLL_API bool statementCanBeTransformed(SgStatement* stmt);
1884 
1885 
1896 std::pair<SgVariableDeclaration*, SgExpression* > createTempVariableForExpression(SgExpression* expression,
1897  SgScopeStatement* scope, bool initializeInDeclaration, SgAssignOp** reEvaluate = NULL);
1898 
1899 /* This function creates a temporary variable for a given expression in the given scope
1900  This is different from SageInterface::createTempVariableForExpression in that it does not
1901  try to be smart to create pointers to reference types and so on. The tempt is initialized to expression.
1902  The caller is responsible for setting the parent of SgVariableDeclaration since buildVariableDeclaration
1903  may not set_parent() when the scope stack is empty. See programTransformation/extractFunctionArgumentsNormalization/ExtractFunctionArguments.C for sample usage.
1904  @param expression Expression which will be replaced by a variable
1905  @param scope scope in which the temporary variable will be generated
1906 */
1907 
1908 std::pair<SgVariableDeclaration*, SgExpression*> createTempVariableAndReferenceForExpression
1909  (SgExpression* expression, SgScopeStatement* scope);
1910 
1912 
1919 
1921 ROSE_DLL_API void appendExpression(SgExprListExp *, SgExpression*);
1922 
1924 ROSE_DLL_API void appendExpressionList(SgExprListExp *, const std::vector<SgExpression*>&);
1925 
1927 template <class actualFunction>
1928 void setParameterList(actualFunction *func,SgFunctionParameterList *paralist) {
1929 
1930  // TODO consider the difference between C++ and Fortran
1931  // fixup the scope of arguments,no symbols for nondefining function declaration's arguments
1932 
1933  // DQ (11/25/2011): templated function so that we can handle both
1934  // SgFunctionDeclaration and SgTemplateFunctionDeclaration (and their associated member
1935  // function derived classes).
1936 
1937  ROSE_ASSERT(func != NULL);
1938  ROSE_ASSERT(paralist != NULL);
1939 
1940 #if 0
1941  // At this point we don't have cerr and endl defined, so comment this code out.
1942  // Warn to users if a paralist is being shared
1943  if (paralist->get_parent() !=NULL)
1944  {
1945  cerr << "Waring! Setting a used SgFunctionParameterList to function: "
1946  << (func->get_name()).getString()<<endl
1947  << " Sharing parameter lists can corrupt symbol tables!"<<endl
1948  << " Please use deepCopy() to get an exclusive parameter list for each function declaration!"<<endl;
1949  // ROSE_ASSERT(false);
1950  }
1951 #endif
1952 
1953  // Liao,2/5/2008 constructor of SgFunctionDeclaration will automatically generate SgFunctionParameterList, so be cautious when set new paralist!!
1954  if (func->get_parameterList() != NULL)
1955  {
1956  if (func->get_parameterList() != paralist)
1957  {
1958  delete func->get_parameterList();
1959  }
1960  }
1961 
1962  func->set_parameterList(paralist);
1963  paralist->set_parent(func);
1964 
1965  // DQ (5/15/2012): Need to set the declptr in each SgInitializedName IR node.
1966  // This is needed to support the AST Copy mechanism (at least). The files: test2005_150.C,
1967  // test2012_81.C and testcode2012_82.C demonstrate this problem.
1968  SgInitializedNamePtrList & args = paralist->get_args();
1969  for (SgInitializedNamePtrList::iterator i = args.begin(); i != args.end(); i++)
1970  {
1971  (*i)->set_declptr(func);
1972  }
1973  }
1974 
1976 ROSE_DLL_API void setPragma(SgPragmaDeclaration* decl, SgPragma *pragma);
1977 
1979 ROSE_DLL_API void replaceExpression(SgExpression* oldExp, SgExpression* newExp, bool keepOldExp=false);
1980 
1982 ROSE_DLL_API void replaceExpressionWithStatement(SgExpression* from,
1986 ROSE_DLL_API void replaceSubexpressionWithStatement(SgExpression* from,
1988 
1990 ROSE_DLL_API void setOperand(SgExpression* target, SgExpression* operand);
1991 
1993 ROSE_DLL_API void setLhsOperand(SgExpression* target, SgExpression* lhs);
1994 
1996 ROSE_DLL_API void setRhsOperand(SgExpression* target, SgExpression* rhs);
1997 
1999 ROSE_DLL_API void removeAllOriginalExpressionTrees(SgNode* top);
2000 
2001 // DQ (1/25/2010): Added support for directories
2003 ROSE_DLL_API void moveToSubdirectory ( std::string directoryName, SgFile* file );
2004 
2006 ROSE_DLL_API SgStatement* findSurroundingStatementFromSameFile(SgStatement* targetStmt, bool & surroundingStatementPreceedsTargetStatement);
2007 
2009 ROSE_DLL_API void moveCommentsToNewStatement(SgStatement* sourceStatement, const std::vector<int> & indexList, SgStatement* targetStatement, bool surroundingStatementPreceedsTargetStatement);
2010 
2011 // DQ (7/19/2015): This is required to support general unparsing of template instantations for the GNU g++
2012 // compiler which does not permit name qualification to be used to support the expression of the namespace
2013 // where a template instantiatoon would be places. Such name qualification would also sometimes require
2014 // global qualification which is also not allowed by the GNU g++ compiler. These issues appear to be
2015 // specific to the GNU compiler versions, at least versions 4.4 through 4.8.
2017 ROSE_DLL_API void moveDeclarationToAssociatedNamespace ( SgDeclarationStatement* declarationStatement );
2018 
2019 ROSE_DLL_API bool isTemplateInstantiationNode(SgNode* node);
2020 
2022 
2023 // DQ (12/1/2015): Adding support for fixup internal data struuctures that have references to statements (e.g. macro expansions).
2024 ROSE_DLL_API void resetInternalMapsForTargetStatement(SgStatement* sourceStatement);
2025 
2026 // DQ (6/7/2019): Add support for transforming function definitions to function prototypes in a subtree.
2027 // We might have to make this specific to a file (only traversing the functions in that file).
2036 
2037 // DQ (11/10/2019): Lower level support for convertFunctionDefinitionsToFunctionPrototypes().
2038 ROSE_DLL_API void replaceDefiningFunctionDeclarationWithFunctionPrototype ( SgFunctionDeclaration* functionDeclaration );
2039 ROSE_DLL_API std::vector<SgFunctionDeclaration*> generateFunctionDefinitionsList(SgNode* node);
2040 
2041 
2043 //------------------------------------------------------------------------
2045 
2052 
2058 ROSE_DLL_API int fixVariableReferences(SgNode* root, bool cleanUnusedSymbol=true);
2059 
2061 
2065 ROSE_DLL_API void fixVariableDeclaration(SgVariableDeclaration* varDecl, SgScopeStatement* scope);
2066 
2068 ROSE_DLL_API void fixStructDeclaration(SgClassDeclaration* structDecl, SgScopeStatement* scope);
2070 ROSE_DLL_API void fixClassDeclaration(SgClassDeclaration* classDecl, SgScopeStatement* scope);
2071 
2073 ROSE_DLL_API void fixNamespaceDeclaration(SgNamespaceDeclarationStatement* structDecl, SgScopeStatement* scope);
2074 
2075 
2077 ROSE_DLL_API void fixLabelStatement(SgLabelStatement* label_stmt, SgScopeStatement* scope);
2078 
2080 ROSE_DLL_API void setFortranNumericLabel(SgStatement* stmt, int label_value,
2081  SgLabelSymbol::label_type_enum label_type=SgLabelSymbol::e_start_label_type,
2082  SgScopeStatement* label_scope=NULL);
2083 
2085 ROSE_DLL_API int suggestNextNumericLabel(SgFunctionDefinition* func_def);
2086 
2088 ROSE_DLL_API void fixFunctionDeclaration(SgFunctionDeclaration* stmt, SgScopeStatement* scope);
2089 
2091 ROSE_DLL_API void fixTemplateDeclaration(SgTemplateDeclaration* stmt, SgScopeStatement* scope);
2092 
2094 ROSE_DLL_API void fixStatement(SgStatement* stmt, SgScopeStatement* scope);
2095 
2096 // DQ (6/11/2015): This reports the statements that are marked as transformed (used to debug the token-based unparsing).
2098 ROSE_DLL_API std::set<SgStatement*> collectTransformedStatements( SgNode* node );
2099 
2101 ROSE_DLL_API std::set<SgStatement*> collectModifiedStatements( SgNode* node );
2102 
2104 ROSE_DLL_API std::set<SgLocatedNode*> collectModifiedLocatedNodes( SgNode* node );
2105 
2106 // DQ (6/5/2019): Use the previously constructed set (above) to reset the IR nodes to be marked as isModified.
2108 ROSE_DLL_API void resetModifiedLocatedNodes(const std::set<SgLocatedNode*> & modifiedNodeSet);
2109 
2110 
2111 // DQ (10/23/2018): Report nodes that are marked as modified.
2112 ROSE_DLL_API void reportModifiedStatements(const std::string & label, SgNode* node);
2113 
2114 // DQ (3/22/2019): Translate CPP directives from attached preprocessor information to CPP Directive Declaration IR nodes.
2115 ROSE_DLL_API void translateToUseCppDeclarations( SgNode* n );
2116 
2117 ROSE_DLL_API void translateScopeToUseCppDeclarations( SgScopeStatement* scope );
2118 
2119 ROSE_DLL_API std::vector<SgC_PreprocessorDirectiveStatement*> translateStatementToUseCppDeclarations( SgStatement* statement, SgScopeStatement* scope);
2120 ROSE_DLL_API void printOutComments ( SgLocatedNode* locatedNode );
2121 ROSE_DLL_API bool skipTranslateToUseCppDeclaration( PreprocessingInfo* currentPreprocessingInfo );
2122 
2123 // DQ (12/2/2019): Debugging support.
2124 ROSE_DLL_API void outputFileIds( SgNode* node );
2125 
2126 
2128 
2130 
2136 
2137 //------------------------------------------------------------------------
2139 
2143 ROSE_DLL_API bool
2145 collectReadWriteRefs(SgStatement* stmt, std::vector<SgNode*>& readRefs, std::vector<SgNode*>& writeRefs, bool useCachedDefUse=false);
2146 
2148 ROSE_DLL_API bool collectReadWriteVariables(SgStatement* stmt, std::set<SgInitializedName*>& readVars, std::set<SgInitializedName*>& writeVars, bool coarseGrain=true);
2149 
2151 ROSE_DLL_API void collectReadOnlyVariables(SgStatement* stmt, std::set<SgInitializedName*>& readOnlyVars, bool coarseGrain=true);
2152 
2154 ROSE_DLL_API void collectReadOnlySymbols(SgStatement* stmt, std::set<SgVariableSymbol*>& readOnlySymbols, bool coarseGrain=true);
2155 
2157 ROSE_DLL_API bool isUseByAddressVariableRef(SgVarRefExp* ref);
2158 
2160 ROSE_DLL_API void collectUseByAddressVariableRefs (const SgStatement* s, std::set<SgVarRefExp* >& varSetB);
2161 
2162 #ifndef ROSE_USE_INTERNAL_FRONTEND_DEVELOPMENT
2163 ROSE_DLL_API LivenessAnalysis * call_liveness_analysis(SgProject* project, bool debug=false);
2165 
2167 ROSE_DLL_API void getLiveVariables(LivenessAnalysis * liv, SgForStatement* loop, std::set<SgInitializedName*>& liveIns, std::set<SgInitializedName*> & liveOuts);
2168 #endif
2169 
2171 ROSE_DLL_API void ReductionRecognition(SgForStatement* loop, std::set< std::pair <SgInitializedName*, OmpSupport::omp_construct_enum> > & results);
2172 
2174 
2175 ROSE_DLL_API void constantFolding(SgNode* r);
2176 
2178 
2180 ROSE_DLL_API int instrumentEndOfFunction(SgFunctionDeclaration * func, SgStatement* s);
2181 
2183 ROSE_DLL_API void removeJumpsToNextStatement(SgNode*);
2184 
2186 ROSE_DLL_API void removeUnusedLabels(SgNode* top);
2187 
2189 ROSE_DLL_API void removeConsecutiveLabels(SgNode* top);
2190 
2192 
2198 ROSE_DLL_API bool mergeDeclarationAndAssignment (SgVariableDeclaration* decl, SgExprStatement* assign_stmt, bool removeAssignStmt = true);
2199 
2200 
2202 ROSE_DLL_API bool mergeAssignmentWithDeclaration (SgExprStatement* assign_stmt, SgVariableDeclaration* decl, bool removeAssignStmt = true);
2203 
2205 
2208 ROSE_DLL_API bool mergeDeclarationWithAssignment (SgVariableDeclaration* decl, SgExprStatement* assign_stmt);
2209 
2211 
2216 
2218 ROSE_DLL_API int splitVariableDeclaration (SgScopeStatement* scope, bool topLevelOnly = true);
2219 
2221 
2228  ROSE_DLL_API SgAssignInitializer* splitExpression(SgExpression* from, std::string newName = "");
2229 
2231 ROSE_DLL_API void splitExpressionIntoBasicBlock(SgExpression* expr);
2232 
2234 ROSE_DLL_API void removeLabeledGotos(SgNode* top);
2235 
2237 ROSE_DLL_API void changeBreakStatementsToGotos(SgStatement* loopOrSwitch);
2238 
2241 
2244 
2247 
2250 
2253 
2256 
2259 
2262 
2264 ROSE_DLL_API SgBasicBlock* ensureBasicBlockAsFalseBodyOfIf(SgIfStmt* ifs, bool createEmptyBody = true);
2265 
2268 
2271 
2272 // DQ (1/18/2015): This is added to support better quality token-based unparsing.
2274 ROSE_DLL_API void cleanupNontransformedBasicBlockNode();
2275 
2276 // DQ (1/18/2015): This is added to support better quality token-based unparsing.
2278 ROSE_DLL_API void recordNormalizations(SgStatement* s);
2279 
2282 bool isBodyStatement (SgStatement* s);
2283 
2285 void changeAllBodiesToBlocks(SgNode* top, bool createEmptyBody = true);
2286 
2287 // The same as changeAllBodiesToBlocks(SgNode* top). Phased out.
2288 //void changeAllLoopBodiesToBlocks(SgNode* top);
2289 
2292 
2293 #if 0
2294 
2297 SgLocatedNode* ensureBasicBlockAsParent(SgStatement* s);
2298 #endif
2299 
2302 unsigned long long getIntegerConstantValue(SgValueExp* expr);
2303 
2305 std::vector<SgDeclarationStatement*> getDependentDeclarations (SgStatement* stmt );
2306 
2307 
2310 
2312 SgCommaOpExp *insertAfterUsingCommaOp (SgExpression* new_exp, SgExpression* anchor_exp, SgStatement** temp_decl = NULL, SgVarRefExp** temp_ref = NULL);
2313 
2314 
2344 std::pair<SgStatement*, SgInitializedName*>
2345 wrapFunction(SgFunctionDeclaration& definingDeclaration, SgName newName);
2346 
2352 template <class NameGen>
2353 std::pair<SgStatement*, SgInitializedName*>
2354 wrapFunction(SgFunctionDeclaration& definingDeclaration, NameGen nameGen)
2355 {
2356  return wrapFunction(definingDeclaration, nameGen(definingDeclaration.get_name()));
2357 }
2358 
2362 
2363 
2365 
2366 // DQ (6/7/2012): Unclear where this function should go...
2367  bool hasTemplateSyntax( const SgName & name );
2368 
2369 #if 0
2370 
2371 //------------------------AST dump, stringify-----------------------------
2372 //------------------------------------------------------------------------
2373  std::string buildOperatorString ( SgNode* astNode ); //transformationSupport.h
2374 
2375  // do we need these?
2376  std::string dump_node(const SgNode* astNode);
2377  std::string dump_tree(const SgNode* astNode);
2378 
2379  // or a friendly version of unparseToString(), as a memeber function
2380  std::string SgNode::toString(bool asSubTree=true); // dump node or subtree
2381 
2382 //----------------------------AST comparison------------------------------
2383 //------------------------------------------------------------------------
2384 // How to get generic functions for comparison?
2385  bool isNodeEqual(SgNode* node1, SgNode* node2); //?
2386  bool isTreeEqual(SgNode* tree1, SgNode* tree2);
2387 
2389  bool expressionTreeEqual(SgExpression*, SgExpression*);
2391  bool expressionTreeEqualStar(const SgExpressionPtrList&,
2392  const SgExpressionPtrList&);
2393 
2394 //----------------------AST verfication/repair----------------------------
2395 //------------------------------------------------------------------------
2396 // sanity check of AST subtree, any suggestions?
2397 // TODO
2398  verifySgNode(SgNode* node, bool subTree=true);
2399  //src/midend/astDiagnostics/AstConsistencyTests.h
2400  // AstTests::runAllTests(SgProject * )
2401 
2402  //src/midend/astUtil/astInterface/AstInterface.h.C
2403  //FixSgProject(SgProject &project)
2404  //FixSgTree(SgNode* r)
2405 
2406  //src/frontend/SageIII/astPostProcessing
2407  //AstPostProcessing(SgNode * node)
2408 
2409 //--------------------------AST modification------------------------------
2410 //------------------------------------------------------------------------
2411 // any operations changing AST tree, including
2412 // insert, copy, delete(remove), replace
2413 
2414  // insert before or after some point, argument list is consistent with LowLevelRewrite
2415  void insertAst(SgNode* targetPosition, SgNode* newNode, bool insertBefore=true);
2416 
2417  // previous examples
2418  //void myStatementInsert(SgStatement* target,...)
2419  // void AstInterfaceBase::InsertStmt(AstNodePtr const & orig, AstNodePtr const &n, bool insertbefore, bool extractfromBasicBlock)
2420 
2421  // copy
2422  // copy children of one basic block to another basic block
2423  //void appendStatementCopy (const SgBasicBlock* a, SgBasicBlock* b);
2424  void copyStatements (const SgBasicBlock* src, SgBasicBlock* dst);
2425 
2426  // delete (remove) a node or a whole subtree
2427  void removeSgNode(SgNode* targetNode); // need this?
2428  void removeSgNodeTree(SgNode* subtree); // need this?
2429 
2430  void removeStatement( SgStatement* targetStmt);
2431 
2432  //Move = delete + insert
2433  void moveAst (SgNode* src, SgNode* target); // need this?
2434  // similar to
2435  void moveStatements (SgBasicBlock* src, SgBasicBlock* target);
2436 
2437  // replace= delete old + insert new (via building or copying)
2438 
2439 // DQ (1/25/2010): This does not appear to exist as a definition anywhere in ROSE.
2440 // void replaceAst(SgNode* oldNode, SgNode* newNode);
2441 
2442  //void replaceChild(SgNode* parent, SgNode* from, SgNode* to);
2443  //bool AstInterface::ReplaceAst( const AstNodePtr& orig, const AstNodePtr& n)
2444 
2445 //--------------------------AST transformations---------------------------
2446 //------------------------------------------------------------------------
2447 // Advanced AST modifications through basic AST modifications
2448 // Might not be included in AST utitlity list, but listed here for the record.
2449 
2450  // extract statements/content from a scope
2451  void flattenBlocks(SgNode* n);
2452 
2453  //src/midend/astInlining/inlinerSupport.h
2454  void renameVariables(SgNode* n);
2455  void renameLabels(SgNode* n, SgFunctionDefinition* enclosingFunctionDefinition);
2456 
2457  void simpleCopyAndConstantPropagation(SgNode* top);
2458  void changeAllMembersToPublic(SgNode* n);
2459 
2460  void removeVariableDeclaration(SgInitializedName* initname);
2461 
2463  SgAssignOp* convertInitializerIntoAssignment(SgAssignInitializer* init);
2464 
2469  void pushTestIntoBody(LoopStatement* loopStmt);
2470 
2471  //programTransformation/finiteDifferencing/finiteDifferencing.h
2473  void moveForDeclaredVariables(SgNode* root);
2474 
2475 //------------------------ Is/Has functions ------------------------------
2476 //------------------------------------------------------------------------
2477 // misc. boolean functions
2478 // some of them could moved to SgXXX class as a member function
2479 
2480  bool isOverloaded (SgFunctionDeclaration * functionDeclaration);
2481 
2482  bool isSwitchCond (const SgStatement* s);
2483  bool isIfCond (const SgStatement* s);
2484  bool isWhileCond (const SgStatement* s);
2485  bool isStdNamespace (const SgScopeStatement* scope);
2486  bool isTemplateInst (const SgDeclarationStatement* decl);
2487 
2488 
2489  bool isCtor (const SgFunctionDeclaration* func);
2490  bool isDtor (const SgFunctionDeclaration* func);
2491 
2492  // src/midend/astInlining/typeTraits.h
2493  bool hasTrivialDestructor(SgType* t);
2494  ROSE_DLL_API bool isNonconstReference(SgType* t);
2495  ROSE_DLL_API bool isReferenceType(SgType* t);
2496 
2497  // generic ones, or move to the SgXXX class as a member function
2498 
2499  bool isConst(SgNode* node); // const type, variable, function, etc.
2500  // .... and more
2501 
2502  bool isConstType (const SgType* type);
2503  bool isConstFunction (const SgFunctionDeclaration* decl);
2504 
2505 
2506  bool isMemberVariable(const SgInitializedName & var);
2507  //bool isMemberVariable(const SgNode& in);
2508 
2509  bool isPrototypeInScope (SgScopeStatement * scope,
2510  SgFunctionDeclaration * functionDeclaration,
2511  SgDeclarationStatement * startingAtDeclaration);
2512 
2513  bool MayRedefined(SgExpression* expr, SgNode* root);
2514  // bool isPotentiallyModified(SgExpression* expr, SgNode* root); // inlinderSupport.h
2515  bool hasAddressTaken(SgExpression* expr, SgNode* root);
2516 
2517  //src/midend/astInlining/inlinerSupport.C
2518  // can also classified as topdown search
2519  bool containsVariableReference(SgNode* root, SgInitializedName* var);
2520 
2521  bool isDeclarationOf(SgVariableDeclaration* decl, SgInitializedName* var);
2522  bool isPotentiallyModifiedDuringLifeOf(SgBasicBlock* sc,
2523  SgInitializedName* toCheck,
2524  SgInitializedName* lifetime)
2525  //src/midend/programTransformation/partialRedundancyElimination/pre.h
2526  bool anyOfListPotentiallyModifiedIn(const std::vector<SgVariableSymbol*>& syms, SgNode* n);
2527 
2528 //------------------------ loop handling ---------------------------------
2529 //------------------------------------------------------------------------
2530  //get and set loop control expressions
2531  // 0: init expr, 1: condition expr, 2: stride expr
2532 
2533  SgExpression* getForLoopTripleValues(int valuetype,SgForStatement* forstmt );
2534  int setForLoopTripleValues(int valuetype,SgForStatement* forstmt, SgExpression* exp);
2535 
2536  bool isLoopIndexVarRef(SgForStatement* forstmt, SgVarRefExp *varref);
2537  SgInitializedName * getLoopIndexVar(SgForStatement* forstmt);
2538 
2539 //------------------------expressions-------------------------------------
2540 //------------------------------------------------------------------------
2541  //src/midend/programTransformation/partialRedundancyElimination/pre.h
2542  int countComputationsOfExpressionIn(SgExpression* expr, SgNode* root);
2543 
2544  //src/midend/astInlining/replaceExpressionWithStatement.h
2545  void replaceAssignmentStmtWithStatement(SgExprStatement* from, StatementGenerator* to);
2546 
2548  StatementGenerator* to);
2549  SgExpression* getRootOfExpression(SgExpression* n);
2550 
2551 //--------------------------preprocessing info. -------------------------
2552 //------------------------------------------------------------------------
2554  void cutPreprocInfo (SgBasicBlock* b,
2556  AttachedPreprocessingInfoType& save_buf);
2558  void pastePreprocInfoFront (AttachedPreprocessingInfoType& save_buf,
2559  SgStatement* s);
2561  void pastePreprocInfoBack (AttachedPreprocessingInfoType& save_buf,
2562  SgStatement* s);
2563 
2569  // a generic one for all
2571  void moveBeforePreprocInfo (SgStatement* src, SgStatement* dest);
2572  void moveInsidePreprocInfo (SgBasicBlock* src, SgBasicBlock* dest);
2573  void moveAfterPreprocInfo (SgStatement* src, SgStatement* dest);
2574 
2575 //--------------------------------operator--------------------------------
2576 //------------------------------------------------------------------------
2577  from transformationSupport.h, not sure if they should be included here
2578  /* return enum code for SAGE operators */
2579  operatorCodeType classifyOverloadedOperator(); // transformationSupport.h
2580 
2586  std::string stringifyOperator (std::string name);
2587 
2588 //--------------------------------macro ----------------------------------
2589 //------------------------------------------------------------------------
2590  std::string buildMacro ( std::string s ); //transformationSupport.h
2591 
2592 //--------------------------------access functions---------------------------
2593 //----------------------------------get/set sth.-----------------------------
2594 // several categories:
2595 * get/set a direct child/grandchild node or fields
2596 * get/set a property flag value
2597 * get a descendent child node using preorder searching
2598 * get an ancestor node using bottomup/reverse searching
2599 
2600  // SgName or string?
2601  std::string getFunctionName (SgFunctionCallExp* functionCallExp);
2602  std::string getFunctionTypeName ( SgFunctionCallExp* functionCallExpression );
2603 
2604  // do we need them anymore? or existing member functions are enought?
2605  // a generic one:
2606  std::string get_name (const SgNode* node);
2607  std::string get_name (const SgDeclarationStatement * declaration);
2608 
2609  // get/set some property: should moved to SgXXX as an inherent memeber function?
2610  // access modifier
2611  void setExtern (SgFunctionDeclartion*)
2612  void clearExtern()
2613 
2614  // similarly for other declarations and other properties
2616  void setPublic()
2617  void setPrivate()
2618 
2619 #endif
2620 
2621 // DQ (1/23/2013): Added support for generated a set of source sequence entries.
2622  std::set<unsigned int> collectSourceSequenceNumbers( SgNode* astNode );
2623 
2624 //--------------------------------Type Traits (C++)---------------------------
2625  bool HasNoThrowAssign(const SgType * const inputType);
2626  bool HasNoThrowCopy(const SgType * const inputType);
2627  bool HasNoThrowConstructor(const SgType * const inputType);
2628  bool HasTrivialAssign(const SgType * const inputType);
2629  bool HasTrivialCopy(const SgType * const inputType);
2630  bool HasTrivialConstructor(const SgType * const inputType);
2631  bool HasTrivialDestructor(const SgType * const inputType);
2632  bool HasVirtualDestructor(const SgType * const inputType);
2633  bool IsBaseOf(const SgType * const inputBaseType, const SgType * const inputDerivedType);
2634  bool IsAbstract(const SgType * const inputType);
2635  bool IsClass(const SgType * const inputType);
2636  bool IsEmpty(const SgType * const inputType);
2637  bool IsEnum(const SgType * const inputType);
2638  bool IsPod(const SgType * const inputType);
2639  bool IsPolymorphic(const SgType * const inputType);
2640  bool IsStandardLayout(const SgType * const inputType);
2641  bool IsLiteralType(const SgType * const inputType);
2642  bool IsTrivial(const SgType * const inputType);
2643  bool IsUnion(const SgType * const inputType);
2644  SgType * UnderlyingType(SgType *type);
2645 
2646 // DQ (3/2/2014): Added a new interface function (used in the snippet insertion support).
2647 // void supportForInitializedNameLists ( SgScopeStatement* scope, SgInitializedNamePtrList & variableList );
2648 
2649 // DQ (3/4/2014): Added support for testing two trees for equivalents using the AST iterators.
2650  bool isStructurallyEquivalentAST( SgNode* tree1, SgNode* tree2 );
2651 
2652 // JP (10/14/24): Moved code to evaluate a const integer expression (like in array size definitions) to SageInterface
2655  size_t value_;
2656  bool hasValue_;
2657  };
2660 
2661 // JP (9/17/14): Added function to test whether two SgType* are equivalent or not
2662  bool checkTypesAreEqual(SgType *typeA, SgType *typeB);
2663 
2664 //--------------------------------Java interface functions ---------------------
2665 #ifdef ROSE_BUILD_JAVA_LANGUAGE_SUPPORT
2666  ROSE_DLL_API std::string getTempDirectory(SgProject *project);
2667  ROSE_DLL_API void destroyTempDirectory(std::string);
2668  ROSE_DLL_API SgFile *processFile(SgProject *, std::string, bool unparse = false);
2669  ROSE_DLL_API std::string preprocessPackage(SgProject *, std::string);
2670  ROSE_DLL_API std::string preprocessImport(SgProject *, std::string);
2671  ROSE_DLL_API SgFile* preprocessCompilationUnit(SgProject *, std::string, std::string, bool unparse = true);
2672  ROSE_DLL_API SgClassDefinition *findJavaPackage(SgScopeStatement *, std::string);
2673  ROSE_DLL_API SgClassDefinition *findOrInsertJavaPackage(SgProject *, std::string, bool create_directory = false);
2674  ROSE_DLL_API SgClassDeclaration *findOrImportJavaClass(SgProject *, SgClassDefinition *package_definition, std::string);
2675  ROSE_DLL_API SgClassDeclaration *findOrImportJavaClass(SgProject *, std::string, std::string);
2676  ROSE_DLL_API SgClassDeclaration *findOrImportJavaClass(SgProject *, SgClassType *);
2677  ROSE_DLL_API SgMemberFunctionDeclaration *findJavaMain(SgClassDefinition *);
2678  ROSE_DLL_API SgMemberFunctionDeclaration *findJavaMain(SgClassType *);
2679 #endif // ROSE_BUILD_JAVA_LANGUAGE_SUPPORT
2680 
2681 
2682 
2683 // DQ (8/31/2016): Making this a template function so that we can have it work with user defined filters.
2685 
2691 template < class T >
2693  {
2694  // DQ (9/1/2016): This function is called in the Call graph generation to avoid filtering out EDG normalized
2695  // function template instnatiations (which come from normalized template functions and member functions).
2696  // Note that because of the EDG normailzation the membr function is moved outside of the class, and
2697  // thus marked as compiler generated. However the template instantiations are always marked as compiler
2698  // generated (if not specializations) and so we want to include a template instantiation that is marked
2699  // as compiler generated, but is from a template declaration that satisfyied a specific user defined filter.
2700  // The complexity of this detection is isolated here, but knowing that it must be called is more complex.
2701  // This function is call in the CG.C file of tests/nonsmoke/functional/roseTests/programAnalysisTests/testCallGraphAnalysis.
2702 
2703  bool retval = false;
2704 
2705 #define DEBUG_TEMPLATE_NORMALIZATION_DETECTION 0
2706 
2707 #if DEBUG_TEMPLATE_NORMALIZATION_DETECTION
2708  printf ("In isNormalizedTemplateInstantiation(): function = %p = %s = %s \n",function,function->class_name().c_str(),function->get_name().str());
2709 #endif
2710 
2711  // Test for this to be a template instantation (in which case it was marked as
2712  // compiler generated but we may want to allow it to be used in the call graph,
2713  // if it's template was a part was defined in the current directory).
2714  SgTemplateInstantiationFunctionDecl* templateInstantiationFunction = isSgTemplateInstantiationFunctionDecl(function);
2715  SgTemplateInstantiationMemberFunctionDecl* templateInstantiationMemberFunction = isSgTemplateInstantiationMemberFunctionDecl(function);
2716 
2717  if (templateInstantiationFunction != NULL)
2718  {
2719  // When the defining function has been normalized by EDG, only the non-defining declaration will have a source position.
2720  templateInstantiationFunction = isSgTemplateInstantiationFunctionDecl(templateInstantiationFunction->get_firstNondefiningDeclaration());
2721  SgTemplateFunctionDeclaration* templateFunctionDeclaration = templateInstantiationFunction->get_templateDeclaration();
2722  if (templateFunctionDeclaration != NULL)
2723  {
2724  retval = filter->operator()(templateFunctionDeclaration);
2725  }
2726  else
2727  {
2728  // Assume false.
2729  }
2730 
2731 #if DEBUG_TEMPLATE_NORMALIZATION_DETECTION
2732  printf (" --- case of templateInstantiationFunction: retval = %s \n",retval ? "true" : "false");
2733 #endif
2734  }
2735  else
2736  {
2737  if (templateInstantiationMemberFunction != NULL)
2738  {
2739  // When the defining function has been normalized by EDG, only the non-defining declaration will have a source position.
2740  templateInstantiationMemberFunction = isSgTemplateInstantiationMemberFunctionDecl(templateInstantiationMemberFunction->get_firstNondefiningDeclaration());
2741  SgTemplateMemberFunctionDeclaration* templateMemberFunctionDeclaration = templateInstantiationMemberFunction->get_templateDeclaration();
2742  if (templateMemberFunctionDeclaration != NULL)
2743  {
2744  retval = filter->operator()(templateMemberFunctionDeclaration);
2745  }
2746  else
2747  {
2748  // Assume false.
2749  }
2750 
2751 #if DEBUG_TEMPLATE_NORMALIZATION_DETECTION
2752  printf (" --- case of templateInstantiationMemberFunction: retval = %s \n",retval ? "true" : "false");
2753 #endif
2754  }
2755  }
2756 
2757  return retval;
2758  }
2759 
2760 void detectCycleInType(SgType * type, const std::string & from);
2761 
2762 // DQ (7/14/2020): Debugging support.
2763 void checkForInitializers( SgNode* node );
2764 
2765 }// end of namespace
2766 
2767 
2768 
2769 #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)
Recursively print current and parent nodes. used within gdb to probe the context of a node...
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 bool is_language_case_insensitive()
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...
void printAST(SgNode *node)
Pretty print AST horizontally, output to std output.
ROSE_DLL_API void replaceDefiningFunctionDeclarationWithFunctionPrototype(SgFunctionDeclaration *functionDeclaration)
Function to delete AST subtree's nodes only, users must take care of any dangling pointers...
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...
label_type_enum
Type of label used (fortran only)
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)
XXX This function operates on the new file used to support outlined function definitions. We use a copy of the file where the code will be outlined FROM, so that if there are references to declarations in the outlined code we can support the outpiled code with those references. This approach has the added advantage of also supporting the same include file tree as the original file where the outlined code is being taken from.
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...
void checkSymbolTables(SgNode *)
Recursively print current and parent nodes. used within gdb to probe the context of a node...
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...
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.
SgAsmInterpretation * getMainInterpretation(SgAsmGenericFile *file)
Find the main interpretation.
void printAST2TextFile(SgNode *node, const char *filename)
Pretty print AST horizontally, output to a specified text file.
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 SgSymbol * lookupSymbolInParentScopesIgnoringAliasSymbols(const SgName &name, SgScopeStatement *currentScope=NULL, SgTemplateParameterPtrList *templateParameterList=NULL, SgTemplateArgumentPtrList *templateArgumentList=NULL)
Find a symbol in current and ancestor scopes for a given variable name, starting from top of ScopeSta...
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)
Recursively print current and parent nodes. used within gdb to probe the context of a node...
SgDeclarationStatement * getNonInstantiatonDeclarationForClass(SgTemplateInstantiationMemberFunctionDecl *memberFunctionInstantiation)
Recursively print current and parent nodes. used within gdb to probe the context of a node...
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 std::set< SgNode * > getFrontendSpecificNodes()
Find a node by type using upward traversal.
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 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.
ROSE_DLL_API std::vector< SgFunctionDeclaration * > generateFunctionDefinitionsList(SgNode *node)
Function to delete AST subtree's nodes only, users must take care of any dangling pointers...
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:9052
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...
void checkAccessPermissions(SgNode *)
Recursively print current and parent nodes. used within gdb to probe the context of a node...
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)
Recursively print current and parent nodes. used within gdb to probe the context of a node...
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)
Recursively print current and parent nodes. used within gdb to probe the context of a node...
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.
ROSE_DLL_API void setFortranNumericLabel(SgStatement *stmt, int label_value, SgLabelSymbol::label_type_enum label_type=SgLabelSymbol::e_start_label_type, SgScopeStatement *label_scope=NULL)
Set a numerical label for a Fortran statement. The statement should have a enclosing function definit...
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:9311
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)
Recursively print current and parent nodes. used within gdb to probe the context of a node...
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...
void recursivePrintCurrentAndParent(SgNode *n)
Recursively print current and parent nodes. used within gdb to probe the context of a node...
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...
ROSE_DLL_API void outputFileIds(SgNode *node)
Connect variable reference to the right variable symbols when feasible, return the number of referenc...
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)
Recursively print current and parent nodes. used within gdb to probe the context of a node...
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.
ROSE_DLL_API bool language_may_contain_nondeclarations_in_scope()
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)
Recursively print current and parent nodes. used within gdb to probe the context of a node...
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...