Description
This class represents the concept of a class definition in C++.
Class definitions are distinquished from class declaration by the definition of the member data and specification of inheritance (if any). Where class declarations can appear multiple times withouth a class definition (forward class declarations), the class definition may appear only once in an application. Within C++ there is the "One Time Definition Rule" which requires that within multiple compilation usints (typically separately compiled files), the definition of all classes of the name qualified name must be identical. Thus the class is considered to be defined only once.
Definition at line 127505 of file Cxx_Grammar.h.
Inheritance diagram for SgClassDefinition:
Collaboration diagram for SgClassDefinition:
Public Types | |
| enum | { static_variant = V_SgClassDefinition } |
| static variant value | |
| typedef SgScopeStatement | base_node_type |
 Public Types inherited from SgScopeStatement | |
| enum | { static_variant = V_SgScopeStatement } |
| static variant value | |
| typedef SgStatement | base_node_type |
| Public Types inherited from SgStatement | |
| enum | { static_variant = V_SgStatement } |
| static variant value | |
| typedef SgLocatedNode | base_node_type |
| Public Types inherited from SgLocatedNode | |
| enum | { static_variant = V_SgLocatedNode } |
| static variant value | |
| typedef SgNode | base_node_type |
| Public Types inherited from SgNode | |
| enum | { static_variant = V_SgNode } |
| static variant value | |
Public Member Functions | |
| virtual SgNode * | copy (SgCopyHelp &help) const override |
| Makes a copy (deap of shallow depending on SgCopyHelp). More... | |
| virtual void | append_member (SgDeclarationStatement *element) |
| virtual void | prepend_member (SgDeclarationStatement *element) |
| virtual void | append_inheritance (SgBaseClass *element) |
| virtual void | prepend_inheritance (SgBaseClass *element) |
| virtual SgName | get_qualified_name () const override |
| Returns SgName (a string) representing the name of the current scope. More... | |
| virtual SgName | get_mangled_name (void) const override |
| SgName | get_mangled_qualified_name (int &i) |
| Returns SgName (a string) representing the mangled name of the current scope. More... | |
| SgClassDeclaration * | get_declaration () const |
| returns the class declaration associated with this class decinition. More... | |
| void | set_declaration (SgClassDeclaration *new_val) |
| SgClassDefinition (Sg_File_Info *f, SgClassDeclaration *d) | |
| SgClassDefinition (SgClassDeclaration *d) | |
| virtual void | fixupCopy (SgNode *copy, SgCopyHelp &help) const |
| virtual std::string | class_name () const override |
| returns a string representing the class name | |
| virtual VariantT | variantT () const override |
| returns new style SageIII enum values | |
| void * | operator new (size_t size) |
| returns pointer to newly allocated IR node | |
| void | operator delete (void *pointer, size_t size) |
| deallocated memory for IR node (returns memory to memory pool for reuse) | |
| void | operator delete (void *pointer) |
| virtual std::vector< SgNode * > | get_traversalSuccessorContainer () override |
| container of pointers to AST successor nodes used in the traversal overridden in every class by generated implementation | |
| virtual std::vector< std::string > | get_traversalSuccessorNamesContainer () override |
| container of names of variables or container indices used used in the traversal to access AST successor nodes overridden in every class by generated implementation | |
| virtual size_t | get_numberOfTraversalSuccessors () override |
| return number of children in the traversal successor list | |
| virtual SgNode * | get_traversalSuccessorByIndex (size_t idx) override |
| index-based access to traversal successors by index number | |
| virtual size_t | get_childIndex (SgNode *child) override |
| index-based access to traversal successors by child node | |
| virtual RTIReturnType | roseRTI () override |
| return C++ Runtime-Time-Information | |
| virtual const char * | sage_class_name () const override ROSE_DEPRECATED_FUNCTION |
| void | executeVisitorMemberFunction (ROSE_VisitorPattern &visitor) |
| FOR INTERNAL USE Support for visitor pattern. | |
| virtual void | accept (ROSE_VisitorPattern &visitor) override |
| support for the classic visitor pattern done in GoF | |
| virtual bool | isInMemoryPool () override |
| FOR INTERNAL USE This is used in internal tests to verify that all IR nodes are allocated from the heap. More... | |
| virtual void | checkDataMemberPointersIfInMemoryPool () override |
| FOR INTERNAL USE This is used in internal tests to verify that all IR nodes are allocated from the heap. More... | |
| virtual std::vector< std::pair< SgNode *, std::string > > | returnDataMemberPointers () const override |
| FOR INTERNAL USE Returns STL vector of pairs of SgNode* and strings for use in AST tools More... | |
| virtual void | processDataMemberReferenceToPointers (ReferenceToPointerHandler *) override |
| FOR INTERNAL USE Processes pairs of references to SgNode* and strings for use in AST tools More... | |
| virtual long | getChildIndex (SgNode *childNode) const override |
| FOR INTERNAL USE Returns a unique index value for the childNode in the list of children at this IR node. More... | |
| SgClassDefinition (const SgClassDefinitionStorageClass &source) | |
| IR node constructor to support AST File I/O. | |
| SgClassDefinition * | addRegExpAttribute (std::string s, AstRegExAttribute *a) |
| Support for AST matching using regular expression. More... | |
| void | post_construction_initialization () override |
| Final initialization for constructors This function is called at the end of generated constructors to allow the specification writer to add special initialization functions or tests. Default is to do nothing. Otherwise it should be overridden in the spec file, in NewHeaderCode/NewOutlinedCode. | |
| const SgDeclarationStatementPtrList & | get_members () const |
| Returns a list to the data member declarations. More... | |
| SgDeclarationStatementPtrList & | get_members () |
| const SgBaseClassPtrList & | get_inheritances () const |
| Returns a list to the base classes. More... | |
| SgBaseClassPtrList & | get_inheritances () |
| unsigned int | get_packingAlignment () const |
| void | set_packingAlignment (unsigned int packingAlignment) |
| bool | get_isSequence () const |
| void | set_isSequence (bool isSequence) |
| bool | get_isPrivate () const |
| void | set_isPrivate (bool isPrivate) |
| bool | get_isAbstract () const |
| void | set_isAbstract (bool isAbstract) |
| virtual | ~SgClassDefinition () |
| This is the destructor. More... | |
| SgClassDefinition (Sg_File_Info *startOfConstruct) | |
| This is the constructor. More... | |
| Public Member Functions inherited from SgScopeStatement | |
| SgScopeStatement (Sg_File_Info *file_info=NULL) | |
| This is the constructor. More... | |
| size_t | count_symbol (const SgName &n) |
| return number of entries in symbol table for the specified name (note that it is sometime OK for there to be more than 1). | |
| size_t | count_alias_symbol (const SgName &n) |
| Count for alias symbols of a specific name, used in name qualification support. | |
| size_t | symbol_table_size () |
| Return the size of the symbol table. | |
| void | insert_symbol (const SgName &n, SgSymbol *s) |
| Puts a SgSymbol object into the local symbol table. More... | |
| int | lookup_symbol (const SgName &n, SgSymbol *s) const ROSE_DEPRECATED_FUNCTION |
| bool | symbol_exists (const SgName &, SgSymbol *sp) const |
| bool | symbol_exists (const SgName &name) const |
| bool | symbol_exists (const SgSymbol *sp) const |
| void | remove_symbol (SgSymbol *s) |
| SgSymbol * | lookup_symbol (const SgName &n, SgTemplateParameterPtrList *templateParameterList=NULL, SgTemplateArgumentPtrList *templateArgumentList=NULL) const |
| get the first symbol with name (note that "" is a valid name and is used for unnamed declarations) the input name is stored as internal state to support the use of next_XXX_symbol() member function. | |
| SgVariableSymbol * | lookup_var_symbol (const SgName &n) const ROSE_DEPRECATED_FUNCTION |
| SgVariableSymbol * | lookup_variable_symbol (const SgName &n) const |
| SgClassSymbol * | lookup_class_symbol (const SgName &n, SgTemplateArgumentPtrList *templateArgumentsList=NULL) const |
| SgNonrealSymbol * | lookup_nonreal_symbol (const SgName &n, SgTemplateParameterPtrList *templateParameterList=NULL, SgTemplateArgumentPtrList *templateArgumentsList=NULL) const |
| SgFunctionSymbol * | lookup_function_symbol (const SgName &n) const |
| SgFunctionSymbol * | lookup_function_symbol (const SgName &n, const SgType *t, SgTemplateArgumentPtrList *templateArgumentsList=NULL) const |
| SgTypedefSymbol * | lookup_typedef_symbol (const SgName &n) const |
| SgEnumSymbol * | lookup_enum_symbol (const SgName &n) const |
| SgEnumFieldSymbol * | lookup_enum_field_symbol (const SgName &n) const |
| SgLabelSymbol * | lookup_label_symbol (const SgName &n) const |
| SgNamespaceSymbol * | lookup_namespace_symbol (const SgName &n) const |
| SgTemplateClassSymbol * | lookup_template_class_symbol (const SgName &n, SgTemplateParameterPtrList *templateParameterList, SgTemplateArgumentPtrList *templateSpecializationArgumentList) const |
| SgTemplateTypedefSymbol * | lookup_template_typedef_symbol (const SgName &n) const |
| SgClassSymbol * | lookup_nontemplate_class_symbol (const SgName &n, SgTemplateArgumentPtrList *templateArgumentsList) const |
| SgTemplateFunctionSymbol * | lookup_template_function_symbol (const SgName &n, const SgType *t, SgTemplateParameterPtrList *templateParameterList) const |
| SgTemplateVariableSymbol * | lookup_template_variable_symbol (const SgName &n, SgTemplateParameterPtrList *templateParameterList, SgTemplateArgumentPtrList *templateArgumentsList) const |
| SgFunctionSymbol * | lookup_nontemplate_function_symbol (const SgName &n, const SgType *t, SgTemplateArgumentPtrList *templateArgumentsList=NULL) const |
| SgTemplateMemberFunctionSymbol * | lookup_template_member_function_symbol (const SgName &n, const SgType *t, SgTemplateParameterPtrList *templateParameterList) const |
| SgMemberFunctionSymbol * | lookup_nontemplate_member_function_symbol (const SgName &n, const SgType *t, SgTemplateArgumentPtrList *templateArgumentsList=NULL) const |
| SgAliasSymbol * | lookup_alias_symbol (const SgName &n, SgSymbol *sp) const |
| bool | hasAmbiguity (SgName &name, SgSymbol *symbol) |
| SgSymbol * | first_any_symbol () const |
| get the first symbol independent of name (lack of name is stored as internal state) | |
| SgVariableSymbol * | first_variable_symbol () const |
| SgClassSymbol * | first_class_symbol () const |
| SgFunctionSymbol * | first_function_symbol () const |
| SgTypedefSymbol * | first_typedef_symbol () const |
| SgEnumSymbol * | first_enum_symbol () const |
| SgEnumFieldSymbol * | first_enum_field_symbol () const |
| SgLabelSymbol * | first_label_symbol () const |
| SgNamespaceSymbol * | first_namespace_symbol () const |
| SgTemplateSymbol * | first_template_symbol () const |
| SgSymbol * | next_any_symbol () const |
| Only use after lookup_XXX_symbol(const SgName&) or after first_XXX_symbol() These functions use the stored state of the name or lack of name (from the lookup_XXX_symbol(const SgName&) or after first_XXX_symbol() member function) and return the next symbol. | |
| SgVariableSymbol * | next_variable_symbol () const |
| SgClassSymbol * | next_class_symbol () const |
| SgFunctionSymbol * | next_function_symbol () const |
| SgTypedefSymbol * | next_typedef_symbol () const |
| SgEnumSymbol * | next_enum_symbol () const |
| SgEnumFieldSymbol * | next_enum_field_symbol () const |
| SgLabelSymbol * | next_label_symbol () const |
| SgNamespaceSymbol * | next_namespace_symbol () const |
| SgTemplateSymbol * | next_template_symbol () const |
| void | print_symboltable (const std::string &str, std::ostream &os) |
| void | print_symboltable (const std::string &label, VariantT nodeType) |
| void | print_symboltable (const std::string &str) |
| bool | containsOnlyDeclarations () const |
| This function is used to indicate if either the getDeclarationList() or getStatementList() can be called to return a reference to the list of IR nodes (manipulation of the list is then possible). More... | |
| void | insertStatementInScope (SgStatement *newTransformationStatement, bool atTop) |
| SgDeclarationStatementPtrList & | getDeclarationList () |
| Gets reference to internal STL list of pointers to SgDeclarationStatement objects (only defined for scopes containing declarations, see bool containsOnlyDeclarations()). More... | |
| SgStatementPtrList & | getStatementList () |
| Gets reference to internal STL list of pointers to SgStatement objects (only defined for scopes containing declarations, see bool containsOnlyDeclarations()). More... | |
| const SgDeclarationStatementPtrList & | getDeclarationList () const |
| const SgStatementPtrList & | getStatementList () const |
| const SgStatementPtrList | generateStatementList () const |
| Generate s list of statements from either the existing list of statements or the list of declarations. More... | |
| bool | statementExistsInScope (SgStatement *statement) |
| Test for existence of statement is scope. | |
| bool | supportsDefiningFunctionDeclaration () |
| Reports if scope can support defining function declarations. Not all scopes permit function declarations. Any function prototype in a scope appropriate for a function definition triggers requirements for name qualification. This function returns true if the scope is appropriate for the definition of a function or member function (i.e. is a SgGlobal, SgClassDefinition, or SgNamespaceDefinitionStatement). More... | |
| unsigned int | generateUniqueStatementNumberForScope (SgStatement *statement) |
| Generate a unique number for the statement in the scope. | |
| bool | generateUniqueStatementNumberForScopeHelper (unsigned int &counter, SgStatement *statement) |
| Helper for generateUniqueStatementNumberForScope: return true if the element is found, incrementing the counter once for each element of tree up to either the element of the end of the sub-statements in the current statement. | |
| std::set< SgSymbol * > & | get_type_elaboration_list () |
| This list of symbols represent types that will require type elaboration when source code is generated. | |
| std::set< SgSymbol * > & | get_hidden_type_list () |
| This list of symbols represent types that will require name qualification when the type name is output. | |
| std::set< SgSymbol * > & | get_hidden_declaration_list () |
| This list of symbols represent declarations that will require name qualification when the identifier name is output. | |
| void | set_type_elaboration_list (const std::set< SgSymbol * > &type_elaboration_list) |
| void | set_hidden_type_list (const std::set< SgSymbol * > &hidden_type_list) |
| void | set_hidden_declaration_list (const std::set< SgSymbol * > &hidden_declaration_list) |
| void | append_statement (SgStatement *stmt) |
| Higher level function to handle statements and declarations is scopes. | |
| void | prepend_statement (SgStatement *stmt) |
| SgStatement * | firstStatement () const |
| SgStatement * | lastStatement () const |
| bool | isCaseInsensitive () const |
| Query of scope symbol table behavior (is symbol table behavior case sensitive (C/C++) or case insensitive (Fortran). | |
| void | setCaseInsensitive (bool b) |
| bool | isNamedScope () |
| Some scopes have associated names for purposed of name qualification. This returns true if the scope has a name, false if not. | |
| SgName | associatedScopeName () |
| Some scopes have associated names for purposed of name qualification. This generates the associated name. | |
| SgSymbolTable * | get_symbol_table () const |
| Returns a pointer to the locally strored SgSymbolTable. More... | |
| void | set_symbol_table (SgSymbolTable *symbol_table) |
| Sets the pointer to the locally strored SgSymbolTable. More... | |
| template<class T > | |
| SgFunctionSymbol * | find_symbol_by_type_of_function (const SgName &name, const SgType *func_type, SgTemplateParameterPtrList *templateParameterList, SgTemplateArgumentPtrList *templateArgumentList) |
| template<class T > | |
| SgSymbol * | find_symbol_from_declaration (const T *node) const |
| void * | operator new (size_t size) |
| returns pointer to newly allocated IR node | |
| void | operator delete (void *pointer, size_t size) |
| deallocated memory for IR node (returns memory to memory pool for reuse) | |
| void | operator delete (void *pointer) |
| void | executeVisitorMemberFunction (ROSE_VisitorPattern &visitor) |
| FOR INTERNAL USE Support for visitor pattern. | |
| SgScopeStatement (const SgScopeStatementStorageClass &source) | |
| IR node constructor to support AST File I/O. | |
| SgScopeStatement * | addRegExpAttribute (std::string s, AstRegExAttribute *a) |
| Support for AST matching using regular expression. More... | |
| SgTypeTable * | get_type_table () const |
| void | set_type_table (SgTypeTable *type_table) |
| SgPragma * | get_pragma () const |
| void | set_pragma (SgPragma *pragma) |
| virtual | ~SgScopeStatement () |
| This is the destructor. More... | |
| Public Member Functions inherited from SgStatement | |
| virtual SgScopeStatement * | get_scope (void) const |
| Returns scope of current statement. More... | |
| virtual void | setExtern () ROSE_DEPRECATED_FUNCTION |
| This function sets "extern" status for the current statement. More... | |
| virtual void | setStatic () ROSE_DEPRECATED_FUNCTION |
| This function sets "static" status for the current statement. More... | |
| void | insert_statement (SgStatement *target, SgStatement *newstmt, bool inFront=true) |
| This function inserts a single statement at the position indicated by target. More... | |
| void | insert_statement (SgStatement *target, const SgStatementPtrList &newstmtList, bool inFront=true) |
| This function inserts a list of statements at the position indicated by target. More... | |
| void | replace_statement (SgStatement *target, SgStatement *newstmt) |
| This function replaces the target statement with a single statement. More... | |
| void | replace_statement (SgStatement *target, const SgStatementPtrList &newstmtList) |
| This function replaces the target statement with a list of statements. More... | |
| void | remove_statement (SgStatement *) |
| This function removes the target statement from the AST. More... | |
| void | insert_statement_from_basicBlock (SgStatement *target, SgStatement *newstmt, bool inFront=true) |
| This function inserts a statement at the position indicated by target. If newstmt is a basicBlock, statements inside newstmt are extracted and then inserted. More... | |
| void | replace_statement_from_basicBlock (SgStatement *target, SgStatement *newstmt) |
| This function replaces the target statement with a new statement. If newstmt is a basicBlock, statements inside newstmt are extracted and then inserted. More... | |
| virtual int | replace_expression (SgExpression *original_expression, SgExpression *new_expression) |
| support general replace functions, used in statements that directly contain SgExpression IR nodes. | |
| virtual void | set_scope (SgScopeStatement *newScope) |
| Support for setting scopes (only meaningful on IR statements that store the scope explicitly). | |
| virtual bool | hasExplicitScope () const |
| Support for where the scope is explicitly required. | |
| virtual SgSymbol * | get_symbol_from_symbol_table () const |
| Get the associated symbol from the symbol table in the stored scope. More... | |
| virtual unsigned int | cfgIndexForEnd () const override |
| Determine the CFG index for the end of this construct. | |
| virtual bool | cfgIsIndexInteresting (unsigned int index) const override |
| Determine whether a particular CFG node index is "interesting" for this kind of node. | |
| virtual unsigned int | cfgFindChildIndex (SgNode *n) override |
| Find the index of n in this node's CFG children. | |
| virtual unsigned int | cfgFindNextChildIndex (SgNode *n) override |
| Find the index just after n in this node's CFG children. | |
| virtual std::vector< VirtualCFG::CFGEdge > | cfgOutEdges (unsigned int index) override |
| Find the out edges of a CFG node – internal version. | |
| virtual std::vector< VirtualCFG::CFGEdge > | cfgInEdges (unsigned int index) override |
| Find the in edges of a CFG node – internal version. | |
| virtual bool | isChildUsedAsLValue (const SgExpression *child) const |
| Virtual function to determine if the provided expression is used as an l-value within the cotext of this statement. More... | |
| virtual void | set_end_numeric_label (SgLabelRefExp *end_numeric_label) |
| virtual bool | has_end_numeric_label () const |
| bool | hasExplicitType () |
| Some statement store internal SgType pointers explicitly. This function is true if it has a data member that is a type (only applies to SgTypedefDeclaration). More... | |
| void * | operator new (size_t size) |
| returns pointer to newly allocated IR node | |
| void | operator delete (void *pointer, size_t size) |
| deallocated memory for IR node (returns memory to memory pool for reuse) | |
| void | operator delete (void *pointer) |
| void | executeVisitorMemberFunction (ROSE_VisitorPattern &visitor) |
| FOR INTERNAL USE Support for visitor pattern. | |
| SgStatement (const SgStatementStorageClass &source) | |
| IR node constructor to support AST File I/O. | |
| SgStatement * | addRegExpAttribute (std::string s, AstRegExAttribute *a) |
| Support for AST matching using regular expression. More... | |
| SgLabelRefExp * | get_numeric_label () const |
| void | set_numeric_label (SgLabelRefExp *numeric_label) |
| int | get_source_sequence_value () const |
| void | set_source_sequence_value (int source_sequence_value) |
| virtual | ~SgStatement () |
| This is the destructor. More... | |
| SgStatement (Sg_File_Info *startOfConstruct) | |
| This is the constructor. More... | |
| Public Member Functions inherited from SgLocatedNode | |
| const std::string & | getFilenameString () const |
| void | addToAttachedPreprocessingInfo (PreprocessingInfo *prepInfoPtr, PreprocessingInfo::RelativePositionType locationInList=PreprocessingInfo::after) |
| This function adds comment or CPP directives to the current IR node. More... | |
| void | insertToAttachedPreprocessingInfo (PreprocessingInfo *prepInfoPtr, PreprocessingInfo *anchorInfoPtr, bool insertAfter=true) |
| Insert prepInfo After (or before if last parameter is false) an anchor info ptr in the list of preprocessing info attached to the current node. This is useful to insert things in the middle. | |
| virtual Sg_File_Info * | get_file_info () const override |
| Interface function to implement original SAGE interface to SgFile_Info objects. More... | |
| virtual void | set_file_info (Sg_File_Info *X) |
| Access function calls set_startingConstruct(Sg_File_Info*) member function. | |
| void | setCompilerGenerated () |
| Allow IR nodes (mostly SgLocatedNode) to be marked as compiler generated. More... | |
| void | unsetCompilerGenerated () |
| bool | isCompilerGenerated () const |
| Simple test for if this is a compiler generated node. More... | |
| void | setTransformation () |
| Allow IR nodes (mostly SgLocatedNode) to be marked as a transformation. More... | |
| void | unsetTransformation () |
| bool | isTransformation () const |
| Simple test for if this is a part of a transformation. More... | |
| void | setFrontendSpecific () |
| Allow IR nodes (mostly SgLocatedNode) to be marked as front-end specific (generated by the front-end to support a specific backend compiler; e.g. GNU gcc and g++). More... | |
| void | unsetFrontendSpecific () |
| bool | isFrontendSpecific () const |
| Simple test for if this is a frontend specific IR node. More... | |
| void | setShared () |
| Allow IR nodes (mostly SgLocatedNode) to be marked as shared. More... | |
| void | unsetShared () |
| bool | isShared () const |
| Simple test for if this is a shared IR node. More... | |
| void | setSourcePositionUnavailableInFrontend () |
| Allow IR nodes (mostly SgLocatedNode) to be marked as to when the information was unavilable in the front-end (even if it typically is there are special cases). More... | |
| void | unsetSourcePositionUnavailableInFrontend () |
| void | setOutputInCodeGeneration () |
| Allow IR nodes (mostly SgLocatedNode) to be marked as to when the information was unavilable in the front-end (even if it typically is there are special cases). More... | |
| void | unsetOutputInCodeGeneration () |
| int | get_physical_file_id () |
| Allow IR nodes (mostly SgLocatedNode) to be queried for there physical file ID. More... | |
| AttachedPreprocessingInfoType *& | getAttachedPreprocessingInfo (void) |
| Computes the number of nodes in the defined subtree of the AST. More... | |
| Sg_File_Info * | generateMatchingFileInfo () |
| virtual void | addNewAttribute (std::string s, AstAttribute *a) override |
| Add a new attribute represented by the named string. | |
| virtual AstAttribute * | getAttribute (std::string s) const override |
| Returns attribute of name 's'. | |
| virtual void | updateAttribute (std::string s, AstAttribute *a) override |
| Replace existing attribute of name 's' with new AstAttribute. | |
| virtual void | setAttribute (std::string s, AstAttribute *a) override |
| This is a wrapper function with the following semantics: if no attribute of name 's' exists then addNewAttribute(s,a); is called, otherwise updateAttribute(s,a); is called. | |
| virtual void | removeAttribute (std::string s) override |
| Remove attribute of name 's' if present. | |
| virtual bool | attributeExists (std::string s) const override |
| Tests if attribute of name 's' is present. | |
| virtual int | numberOfAttributes () const override |
| Returns the number of attributes on this IR node. | |
| void * | operator new (size_t size) |
| returns pointer to newly allocated IR node | |
| void | operator delete (void *pointer, size_t size) |
| deallocated memory for IR node (returns memory to memory pool for reuse) | |
| void | operator delete (void *pointer) |
| void | executeVisitorMemberFunction (ROSE_VisitorPattern &visitor) |
| FOR INTERNAL USE Support for visitor pattern. | |
| SgLocatedNode (const SgLocatedNodeStorageClass &source) | |
| IR node constructor to support AST File I/O. | |
| SgLocatedNode * | addRegExpAttribute (std::string s, AstRegExAttribute *a) |
| Support for AST matching using regular expression. More... | |
| Sg_File_Info * | get_startOfConstruct () const override |
| New function interface for Sg_File_Info data stores starting location of contruct (typically the opening brace or first letter of keyword). | |
| void | set_startOfConstruct (Sg_File_Info *startOfConstruct) |
| This function sets the current source location position of the start of the current construct. More... | |
| Sg_File_Info * | get_endOfConstruct () const override |
| New function interface for Sg_File_Info data stores ending location of contruct (typically the closing brace). | |
| void | set_endOfConstruct (Sg_File_Info *endOfConstruct) |
| This function sets the current source location position of the end of the current construct. More... | |
| AttachedPreprocessingInfoType * | get_attachedPreprocessingInfoPtr () const |
| void | set_attachedPreprocessingInfoPtr (AttachedPreprocessingInfoType *attachedPreprocessingInfoPtr) |
| AstAttributeMechanism * | get_attributeMechanism () const override |
| FOR INTERNAL USE Access function; if an attribute exists then a pointer to it is returned, else error. More... | |
| void | set_attributeMechanism (AstAttributeMechanism *attributeMechanism) override |
| FOR INTERNAL USE Access function; sets poiner to value AstAttributeMechanism. More... | |
| bool | get_containsTransformationToSurroundingWhitespace () const |
| void | set_containsTransformationToSurroundingWhitespace (bool containsTransformationToSurroundingWhitespace) |
| virtual | ~SgLocatedNode () |
| This is the destructor. More... | |
| SgLocatedNode (Sg_File_Info *startOfConstruct=NULL) | |
| This is the constructor. More... | |
| Public Member Functions inherited from SgNode | |
| void * | operator new (size_t size) |
| returns pointer to newly allocated IR node | |
| void | operator delete (void *pointer, size_t size) |
| deallocated memory for IR node (returns memory to memory pool for reuse) | |
| void | operator delete (void *pointer) |
| void | executeVisitorMemberFunction (ROSE_VisitorPattern &visitor) |
| FOR INTERNAL USE Support for visitor pattern. | |
| SgNode (const SgNodeStorageClass &source) | |
| IR node constructor to support AST File I/O. | |
| SgNode * | addRegExpAttribute (std::string s, AstRegExAttribute *a) |
| Support for AST matching using regular expression. More... | |
| void | set_isModified (bool isModified) |
| All nodes in the AST contain a isModified flag used to track changes to the AST. More... | |
| void | set_containsTransformation (bool containsTransformation) |
| Many nodes can hide other AST nodes and we need to track when outer nodes contain modified nodes even if they are not themselves modified. More... | |
| bool | get_isModified () const |
| Acess function for isModified flag. More... | |
| bool | get_containsTransformation () const |
| Acess function for containsTransformation flag. More... | |
| bool | isChild (SgNode *node) const |
| Query function for if the input IR nodes is a child of the current IR node. | |
| virtual std::string | unparseToString (SgUnparse_Info *info) const |
| This function unparses the AST node (excluding comments and unnecessary white space) | |
| std::string | unparseToString () const |
| int | variant () const ROSE_DEPRECATED_FUNCTION |
| Older version function returns enum value "NODE". More... | |
| VirtualCFG::CFGNode | cfgForBeginning () |
| Returns the CFG node for just before this AST node. | |
| VirtualCFG::CFGNode | cfgForEnd () |
| Returns the CFG node for just after this AST node. | |
| int | numberOfNodesInSubtree () |
| Computes the number of nodes in the defined subtree of the AST. More... | |
| int | depthOfSubtree () |
| Computes the depth of the current defined subtree of the AST. More... | |
| SgNode * | get_freepointer () const |
| void | set_freepointer (SgNode *freepointer) |
| virtual | ~SgNode () |
| This is the destructor. More... | |
| SgNode () | |
| This is the constructor. More... | |
| void | set_parent (SgNode *parent) |
| All nodes in the AST contain a reference to a parent node. More... | |
| SgNode * | get_parent () const |
| Access function for parent node. More... | |
| std::string | unparseToCompleteString () |
| This function unparses the AST node (including comments and white space) More... | |
| bool | get_isVisited () const ROSE_DEPRECATED_FUNCTION |
| DOCS IN HEADER: Access function for p_isVisited flag used previously by the AST traversals. More... | |
| void | set_isVisited (bool isVisited) ROSE_DEPRECATED_FUNCTION |
| Access function for p_isVisited flag used previously by the AST traversals. More... | |
Static Public Member Functions | |
| static void | deleteMemoryPool () |
| static size_t | numberOfNodes () |
| Returns the total number of IR nodes of this type. | |
| static size_t | memoryUsage () |
| Returns the size in bytes of the total memory allocated for all IR nodes of this type. | |
| static void | traverseMemoryPoolNodes (ROSE_VisitTraversal &visit) |
| FOR INTERNAL USE Support for visitor pattern over all IR nodes by type of IR node. | |
| static void | traverseMemoryPoolVisitorPattern (ROSE_VisitorPattern &visitor) |
| FOR INTERNAL USE Support for visitor pattern. | |
| static void | visitRepresentativeNode (ROSE_VisitTraversal &visit) |
| FOR INTERNAL USE Support for type-based traversal. | |
| Static Public Member Functions inherited from SgScopeStatement | |
| static bool | isEquivalentScope (SgScopeStatement *scope1, SgScopeStatement *scope2) |
| static void | deleteMemoryPool () |
| static size_t | numberOfNodes () |
| Returns the total number of IR nodes of this type. | |
| static size_t | memoryUsage () |
| Returns the size in bytes of the total memory allocated for all IR nodes of this type. | |
| static void | traverseMemoryPoolNodes (ROSE_VisitTraversal &visit) |
| FOR INTERNAL USE Support for visitor pattern over all IR nodes by type of IR node. | |
| static void | traverseMemoryPoolVisitorPattern (ROSE_VisitorPattern &visitor) |
| FOR INTERNAL USE Support for visitor pattern. | |
| static void | visitRepresentativeNode (ROSE_VisitTraversal &visit) |
| FOR INTERNAL USE Support for type-based traversal. | |
| Static Public Member Functions inherited from SgStatement | |
| static void | deleteMemoryPool () |
| static size_t | numberOfNodes () |
| Returns the total number of IR nodes of this type. | |
| static size_t | memoryUsage () |
| Returns the size in bytes of the total memory allocated for all IR nodes of this type. | |
| static void | traverseMemoryPoolNodes (ROSE_VisitTraversal &visit) |
| FOR INTERNAL USE Support for visitor pattern over all IR nodes by type of IR node. | |
| static void | traverseMemoryPoolVisitorPattern (ROSE_VisitorPattern &visitor) |
| FOR INTERNAL USE Support for visitor pattern. | |
| static void | visitRepresentativeNode (ROSE_VisitTraversal &visit) |
| FOR INTERNAL USE Support for type-based traversal. | |
| Static Public Member Functions inherited from SgLocatedNode | |
| static void | deleteMemoryPool () |
| static size_t | numberOfNodes () |
| Returns the total number of IR nodes of this type. | |
| static size_t | memoryUsage () |
| Returns the size in bytes of the total memory allocated for all IR nodes of this type. | |
| static void | traverseMemoryPoolNodes (ROSE_VisitTraversal &visit) |
| FOR INTERNAL USE Support for visitor pattern over all IR nodes by type of IR node. | |
| static void | traverseMemoryPoolVisitorPattern (ROSE_VisitorPattern &visitor) |
| FOR INTERNAL USE Support for visitor pattern. | |
| static void | visitRepresentativeNode (ROSE_VisitTraversal &visit) |
| FOR INTERNAL USE Support for type-based traversal. | |
| Static Public Member Functions inherited from SgNode | |
| static void | deleteMemoryPool () |
| static size_t | numberOfNodes () |
| Returns the total number of IR nodes of this type. | |
| static size_t | memoryUsage () |
| Returns the size in bytes of the total memory allocated for all IR nodes of this type. | |
| static void | traverseMemoryPoolNodes (ROSE_VisitTraversal &visit) |
| FOR INTERNAL USE Support for visitor pattern over all IR nodes by type of IR node. | |
| static void | traverseMemoryPoolVisitorPattern (ROSE_VisitorPattern &visitor) |
| FOR INTERNAL USE Support for visitor pattern. | |
| static void | visitRepresentativeNode (ROSE_VisitTraversal &visit) |
| FOR INTERNAL USE Support for type-based traversal. | |
| static std::vector< std::string > | buildCommandLineToSubstituteTransformationFile (const std::vector< std::string > &argv, std::string newFileName) |
| Command line support for this compilation The command line is saved as a static variable so that it will be available to support the rewrite mechanism. More... | |
| static std::vector< VariantT > | getClassHierarchySubTreeFunction (VariantT v) |
| static void | getClassHierarchySubTreeFunction (VariantT v, std::vector< VariantT > &) |
| static std::map< SgNode *, std::string > & | get_globalMangledNameMap () |
| Access function for performance optimizing global mangled name map. More... | |
| static void | clearGlobalMangledNameMap () |
| Support to clear the performance optimizing global mangled name map. | |
| static std::map< std::string, int > & | get_shortMangledNameCache () |
| Access function for lower level optimizing of global mangled name map. More... | |
| static std::map< SgNode *, std::string > & | get_globalQualifiedNameMapForNames () |
| Access function for name qualification support (for names). More... | |
| static void | set_globalQualifiedNameMapForNames (const std::map< SgNode *, std::string > &X) |
| Access function for name qualification support (for names). More... | |
| static std::map< SgNode *, std::string > & | get_globalQualifiedNameMapForTypes () |
| Access function for name qualification support (for type). More... | |
| static void | set_globalQualifiedNameMapForTypes (const std::map< SgNode *, std::string > &X) |
| Access function for name qualification support (for type). More... | |
| static std::map< SgNode *, std::map< SgNode *, std::string > > & | get_globalQualifiedNameMapForMapsOfTypes () |
| Access function for name qualification support (for maps of types). More... | |
| static void | set_globalQualifiedNameMapForMapsOfTypes (const std::map< SgNode *, std::map< SgNode *, std::string > > &X) |
| Access function for name qualification support (for maps of types). More... | |
| static std::map< SgNode *, std::string > & | get_globalQualifiedNameMapForTemplateHeaders () |
| Access function for name qualification support (for template headers in template declarations). More... | |
| static void | set_globalQualifiedNameMapForTemplateHeaders (const std::map< SgNode *, std::string > &X) |
| Access function for name qualification support (for template headers in template declarations). More... | |
| static std::map< SgNode *, std::string > & | get_globalTypeNameMap () |
| Access function for name qualification support (for names of types). More... | |
| static void | set_globalTypeNameMap (const std::map< SgNode *, std::string > &X) |
| Access function for name qualification support (for names of types). More... | |
| static SgFunctionTypeTable * | get_globalFunctionTypeTable () |
| Access function for symbol table specific to function types. | |
| static void | set_globalFunctionTypeTable (SgFunctionTypeTable *globalFunctionTypeTable) |
| Access function for symbol table specific to function types. | |
| static SgTypeTable * | get_globalTypeTable () |
| Access function for symbol table specific to non-function types. | |
| static void | set_globalTypeTable (SgTypeTable *globalTypeTable) |
| Access function for symbol table specific to non-function types. | |
| static VariantT | variantFromPool (SgNode const *n) |
Protected Member Functions | |
| virtual bool | replace_child (SgStatement *, SgStatement *, bool extractListFromBasicBlock=false) override |
| Private supporting function for low level SageIII rewrite interface. More... | |
| virtual bool | insert_child (SgStatement *, SgStatement *, bool inFront=true, bool extractListFromBasicBlock=false) override |
| Private supporting function for low level SageIII rewrite interface. More... | |
Private Supporting Functions for Low-Level Rewrite Interface | |
Low-level Support for mutation of the AST. This is the lowest level of support for the mutation of the AST. | |
Protected Attributes | |
| SgDeclarationStatementPtrList | p_members |
| This the list of member declarations in the class. | |
| SgBaseClassPtrList | p_inheritances |
| This the list of base classes specificed in the class definition. | |
| unsigned int | p_packingAlignment |
| bool | p_isSequence |
| bool | p_isPrivate |
| bool | p_isAbstract |
| Protected Attributes inherited from SgScopeStatement | |
| SgSymbolTable * | p_symbol_table |
| This pointer is always valid and stores the symbl table. | |
| SgTypeTable * | p_type_table |
| std::set< SgSymbol * > | p_type_elaboration_list |
| std::set< SgSymbol * > | p_hidden_type_list |
| std::set< SgSymbol * > | p_hidden_declaration_list |
| SgPragma * | p_pragma |
| Protected Attributes inherited from SgStatement | |
| SgLabelRefExp * | p_numeric_label |
| int | p_source_sequence_value |
| Protected Attributes inherited from SgLocatedNode | |
| Sg_File_Info * | p_startOfConstruct |
| This pointer is always valid and stores the source position of the start of the current construct. | |
| Sg_File_Info * | p_endOfConstruct |
| This pointer is always valid and stores the source position of the end of the current construct. | |
| AttachedPreprocessingInfoType * | p_attachedPreprocessingInfoPtr |
| Holds comments and/or preprocessor directives located before or after the current statement of expression. | |
| AstAttributeMechanism * | p_attributeMechanism |
| bool | p_containsTransformationToSurroundingWhitespace |
| Protected Attributes inherited from SgNode | |
| SgNode * | p_parent |
| This is the pointer to the parent IR node in the AST. More... | |
| bool | p_isModified |
| Records if IR node has been modified (data members reset). More... | |
| bool | p_containsTransformation |
| SgNode * | p_freepointer |
| This is the pointer to the chain of previously freed objects. | |
Additional Inherited Members | |
| Static Protected Attributes inherited from SgNode | |
| static std::vector< std::tuple< unsigned char *, unsigned, VariantT > > | all_pools |
| static SgFunctionTypeTable * | p_globalFunctionTypeTable |
| Pointer to symbol table specific to function types. | |
| static SgTypeTable * | p_globalTypeTable |
| static std::map< SgNode *, std::string > | p_globalMangledNameMap |
| Cache of mangled names to avoid regeneration of previously build mangled names or parts of mangled names. This is a performance optimization. | |
| static std::map< std::string, int > | p_shortMangledNameCache |
| STL map used as a cache to shorten generated mangled names. This is mostly a space optimization ofr mangled names of templates. | |
| static std::map< SgNode *, std::string > | p_globalQualifiedNameMapForNames |
| static std::map< SgNode *, std::string > | p_globalQualifiedNameMapForTypes |
| static std::map< SgNode *, std::string > | p_globalQualifiedNameMapForTemplateHeaders |
| static std::map< SgNode *, std::string > | p_globalTypeNameMap |
| static std::map< SgNode *, std::map< SgNode *, std::string > > | p_globalQualifiedNameMapForMapsOfTypes |
Constructor & Destructor Documentation
◆ ~SgClassDefinition()
|
virtual |
This is the destructor.
There are a lot of things to delete, but nothing is deleted in this destructor.
◆ SgClassDefinition()
| SgClassDefinition::SgClassDefinition | ( | Sg_File_Info * | startOfConstruct = NULL | ) |
This is the constructor.
This constructor builds the SgClassDefinition base class.
- Parameters
-
startOfConstruct represents the position in the source code
Member Function Documentation
◆ copy()
|
overridevirtual |
Makes a copy (deap of shallow depending on SgCopyHelp).
- Returns
- Returns pointer to copy of SgClassDefinition.
Reimplemented from SgScopeStatement.
Reimplemented in SgTemplateClassDefinition, and SgTemplateInstantiationDefn.
◆ get_qualified_name()
|
overridevirtual |
Returns SgName (a string) representing the name of the current scope.
See discussion of qualified names in the documentation.
- Returns
- Returns SgName (a string).
Reimplemented from SgScopeStatement.
Reimplemented in SgTemplateClassDefinition, and SgTemplateInstantiationDefn.
◆ get_mangled_qualified_name()
| SgClassDefinition::get_mangled_qualified_name | ( | int & | i | ) |
◆ replace_child()
|
overrideprotectedvirtual |
Private supporting function for low level SageIII rewrite interface.
This function implements special semantics for the insertion of a collection of statements in a block. If extractListFromBasicBlock is true then the statements in the block are extracts and placed into the same scope as the target position.
- Returns
- Returns bool.
Reimplemented from SgStatement.
◆ insert_child()
|
overrideprotectedvirtual |
Private supporting function for low level SageIII rewrite interface.
This function implements special semantics for the insertion of a collection of
statements in a block. If extractListFromBasicBlock is true then the statements in the block are extracts and placed into the same scope as the target position.
- Returns
- Returns bool.
Reimplemented from SgStatement.
◆ get_declaration()
| SgClassDefinition::get_declaration | ( | ) | const |
returns the class declaration associated with this class decinition.
- Returns
- Returns SgClassDeclaration pointer.
◆ sage_class_name()
|
overridevirtual |
returns a C style string (char*) representing the class name
Reimplemented from SgScopeStatement.
Reimplemented in SgTemplateClassDefinition, and SgTemplateInstantiationDefn.
◆ isInMemoryPool()
|
overridevirtual |
FOR INTERNAL USE This is used in internal tests to verify that all IR nodes are allocated from the heap.
The AST File I/O depends upon the allocation of IR nodes being from the heap, stack based or global IR nodes should not appear in the AST if it will be written out to a file and read back in. To enforce this concept, this function implements a test to verify that the IR node can be found on the heap and is part of a larger test of the whole AST. This test must pass before the AST can be written out to a file. This is part of a compromise in the design of the AST File I/O to support binary streaming of data to files; for performance. It is also rather difficult, but possible, to build a useful AST with IR nodes allocated on the stack or frm global scope, this test filters out such cased from being used with the AST File I/O mechanism.
Reimplemented from SgScopeStatement.
Reimplemented in SgTemplateClassDefinition, and SgTemplateInstantiationDefn.
◆ checkDataMemberPointersIfInMemoryPool()
|
overridevirtual |
FOR INTERNAL USE This is used in internal tests to verify that all IR nodes are allocated from the heap.
The AST File I/O depends upon the allocation of IR nodes being from the heap, stack based or global IR nodes should not appear in the AST if it will be written out to a file and read back in. To enforce this concept, this function implements a test to verify that the IR node can be found on the heap and is part of a larger test of the whole AST. This test must pass before the AST can be written out to a file. This is part of a compromise in the design of the AST File I/O to support binary streaming of data to files; for performance. It is also rather difficult, but possible, to build a useful AST with IR nodes allocated on the stack or frm global scope, this test filters out such cased from being used with the AST File I/O mechanism.
Reimplemented from SgScopeStatement.
Reimplemented in SgTemplateClassDefinition, and SgTemplateInstantiationDefn.
◆ returnDataMemberPointers()
|
overridevirtual |
FOR INTERNAL USE Returns STL vector of pairs of SgNode* and strings for use in AST tools
This functions is part of general support for many possible tools to operate on the AST. The forms a list of ALL IR node pointers used by each IR node, and is a supperset of the get_traversalSuccessorContainer(). It is (I think) less than the set of pointers used by the AST file I/O. This is part of work implemented by Andreas, and support tools such as the AST graph generation.
- Warning
- This function can return unexpected data members and thus the order and the number of elements is unpredicable and subject to change.
- Returns
- STL vector of pairs of SgNode* and strings
Reimplemented from SgScopeStatement.
Reimplemented in SgTemplateClassDefinition, and SgTemplateInstantiationDefn.
◆ processDataMemberReferenceToPointers()
|
overridevirtual |
FOR INTERNAL USE Processes pairs of references to SgNode* and strings for use in AST tools
This functions similar to returnDataMemberPointers() except that it passes references to a handler object. As a result there is FAR more damage that can be done by using this function, but it is type-safe. This is provided for support of internal tools that operate on the AST, e.g the AST Merge mechanism.
- Warning
- This function can return unexpected data members and thus the order and the number of elements is unpredicable and subject to change.
Reimplemented from SgScopeStatement.
Reimplemented in SgTemplateClassDefinition, and SgTemplateInstantiationDefn.
◆ getChildIndex()
|
overridevirtual |
FOR INTERNAL USE Returns a unique index value for the childNode in the list of children at this IR node.
This function returns a unique value for the input childNode in set of children at this IR node. Note that a negative value indicates that the input node is not a child. This is the basis for the implementation of the isChild(SgNode*) member function. Data members that are NULL in the IR node are counted internally (so that this function returns value that could be statically defined, and so are not dynamically determined).
- Warning
- The mapping on children to integer values could change from release to release of ROSE.
- Returns
- long
Reimplemented from SgScopeStatement.
Reimplemented in SgTemplateClassDefinition, and SgTemplateInstantiationDefn.
◆ addRegExpAttribute()
| SgClassDefinition* SgClassDefinition::addRegExpAttribute | ( | std::string | s, |
| AstRegExAttribute * | a | ||
| ) |
Support for AST matching using regular expression.
This support is incomplete and the subject of current research to define RegEx trees to support inexact matching.
◆ get_members()
| SgClassDefinition::get_members | ( | ) | const |
Returns a list to the data member declarations.
Returns a const list to the data member declarations.
- Returns
- Returns an STL list by reference.
- Returns a const STL list by reference.
◆ get_inheritances()
| SgClassDefinition::get_inheritances | ( | ) | const |
Returns a list to the base classes.
Returns a const list to the base classes.
- Returns
- Returns an STL list by reference.
- Returns a const STL list by reference.
The documentation for this class was generated from the following files:
