SgClassDeclaration¶
This class represents the concept of a class declaration statement. It includes the
Synopsis¶
Declared in <src/frontend/SageIII/Cxx_Grammar.h> (not stored in Git)
class [[visibility("default")]] SgClassDeclaration
: public SgDeclarationStatement Description¶
concept of an instantiated class template as well.
- See also: Example of using a SgClassDeclaration object
Data members
SgClassDeclaration::p_name¶
This is the name of the class or instantiated class template
- Internal: The value held is not shared within the Sage III AST.
SgClassDeclaration::p_class_type¶
Enum value classifying this as a class,struct,or union.
- Internal: The enum type is also defined in this class.
SgClassDeclaration::p_type¶
This is the type used in the declaration (SgClassType).
SgClassDeclaration::p_definition¶
This is the class definition (alway a valid pointer, except for explicitly marked forward declarations). When this is a defining or nondefining declartion the p_definition pointer is always valid. However, as a separate rule, all forward declarations are both makred explicit as forward declarations AND have a NULL value for their p_definition pointer.
- Internal: The declaration associated with the definition is the defining declaration and may not be the same as that pointed to by the "this" pointer.
SgClassDeclaration::p_from_template¶
This records if the class declaration is associated with a template. This boolean value is set to true if this is a non-template class nested in a templated class. We have an explicit IR node for template classes, but this is only flag to indicate that several template specific rules apply to the declaration of this class if the value is true. For example, the class will not be output unless it is transformed, then the required specialization is required for the parent templated class.
- Internal: It is set internally and there is no need for it to be set by the user!
Member functions
`SgClassDeclaration::SgClassDeclaration ( Sg_File_Info* startOfConstruct¶
= NULL,` SgName name = SgdefaultName, int class_type = 0, SgClassType *type=NULL, SgClassDefinition *definition=NULL) This is the only constructor. This constructor builds the SgClassDeclaration base class. but has some specific side-effects (some of which have been removed in the latest work). It is however still that case that if the definition is provided then it's declaration will be changed to the declaration being constructed (a warning message it output if this happens and this side-effect will be removed soon).
- Param
startOfConstruct: represents the position in the source code - See also: Example:create an SgClassDeclaration object
Base Classes¶
| Name | Description |
|---|---|
SgDeclarationStatement | This class represents the concept of a declaration statement. |
Type Aliases¶
| Name |
|---|
base_node_type |
Enums¶
| Name | Description |
|---|---|
Unnamed enum | static variant value |
class_types | A declaration can be of either class, struct, union, or ... |
Member Functions¶
| Name | Description |
|---|---|
SgClassDeclarationSgClassDeclaration( SgName name, SgClassDeclaration::class_types class_type, SgClassType* type, SgClassDefinition* definition); [constructor] | Constructors |
~SgClassDeclarationvirtual ~SgClassDeclaration(); [destructor] [virtual] | Destructor |
acceptvirtual void accept(ROSE_VisitorPattern& visitor) override; [virtual] | support for the classic visitor pattern done in GoF |
appendDestructorOwnedNodesvirtual void appendDestructorOwnedNodes(std::vector<SgNode*>& nodes) const override; [virtual] | |
cfgInEdgesvirtual std::vector<VirtualCFG::CFGEdge> cfgInEdges(unsigned int index) override; [virtual] | |
cfgIndexForEndvirtual unsigned int cfgIndexForEnd() const override; [virtual] | |
cfgOutEdgesvirtual std::vector<VirtualCFG::CFGEdge> cfgOutEdges(unsigned int index) override; [virtual] | |
class_namevirtual std::string class_name() const override; [virtual] | returns a string representing the class name |
copyvirtual SgNode* copy(SgCopyHelp& help) const override; [virtual] | |
fixupCopy_referencesvirtual void fixupCopy_references( SgNode* copy, SgCopyHelp& help) const override; [virtual] | |
fixupCopy_scopesvirtual void fixupCopy_scopes( SgNode* copy, SgCopyHelp& help) const override; [virtual] | |
fixupCopy_symbolsvirtual void fixupCopy_symbols( SgNode* copy, SgCopyHelp& help) const override; [virtual] | |
get_childIndexvirtual size_t get_childIndex(SgNode* child) const override; [virtual] | index-based access to traversal successors by child node |
get_class_typeSgClassDeclaration::class_types get_class_type() const; | |
get_definitionSgClassDefinition* get_definition() const; | |
get_from_templatebool get_from_template() const; | |
get_global_qualification_requiredbool get_global_qualification_required() const; | |
get_isAutonomousDeclarationbool get_isAutonomousDeclaration() const; | |
get_isUnNamedbool get_isUnNamed() const; | |
get_lambda_expressionSgLambdaExp* get_lambda_expression() const; | |
get_mangled_namevirtual SgName get_mangled_name() const override; [virtual] | |
get_nameSgName get_name() const; | |
get_name_qualification_lengthint get_name_qualification_length() const; | |
get_numberOfTraversalSuccessorsvirtual size_t get_numberOfTraversalSuccessors() const override; [virtual] | return number of children in the traversal successor list |
get_qualified_namevirtual SgName get_qualified_name() const; [virtual] | |
get_scopevirtual SgScopeStatement* get_scope() const override; [virtual] | |
get_sourceSpelledTemplateHeadersSgTemplateParameterListPtrList const& get_sourceSpelledTemplateHeaders() const; | |
get_specializationSgDeclarationStatement::template_specialization_enum get_specialization() const; | |
get_symbol_from_symbol_tablevirtual SgSymbol* get_symbol_from_symbol_table() const override; [virtual] | |
get_traversalSuccessorByIndexvirtual SgNode* get_traversalSuccessorByIndex(size_t idx) const override; [virtual] | index-based access to traversal successors by index number |
get_traversalSuccessorContainervirtual std::vector<SgNode*> get_traversalSuccessorContainer() const override; [virtual] | container of pointers to AST successor nodes used in the traversal overridden in every class by generated implementation |
get_traversalSuccessorIsListElementvirtual std::vector<bool> get_traversalSuccessorIsListElement() const override; [virtual] | |
get_traversalSuccessorNamesContainervirtual std::vector<std::string> get_traversalSuccessorNamesContainer() const override; [virtual] | 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 |
get_typeSgClassType* get_type() const; | |
get_type_elaboration_requiredbool get_type_elaboration_required() const; | |
hasExplicitScopevirtual bool hasExplicitScope() const override; [virtual] | Support for where the scope is explicitly required |
isPartialSpecializationbool isPartialSpecialization() const; | |
isSpecializationbool isSpecialization() const; | |
operator deletevoid operator delete( void* pointer, size_t size); | deallocated memory for IR node (returns memory to memory pool for reuse) |
operator newvoid* operator new(size_t size); | returns pointer to newly allocated IR node |
post_construction_initializationvirtual void post_construction_initialization() override; [virtual] | |
processDataMemberReferenceToPointersvirtual void processDataMemberReferenceToPointers(ReferenceToPointerHandler*) override; [virtual] | Pass references to stored node pointers to a handler. |
returnDataMemberPointersvirtual std::vector<std::pair<SgNode*, std::string>> returnDataMemberPointers() const override; [virtual] | Return the node pointers stored in this node's data members. |
roseRTIvirtual RTIReturnType roseRTI() override; [virtual] | return C++ Runtime-Time-Information |
sage_class_namevirtual char const* sage_class_name() const override; [virtual] | returns a C style string (char*) representing the class name |
set_class_typevoid set_class_type(SgClassDeclaration::class_types class_type); | |
set_definitionvoid set_definition(SgClassDefinition* definition); | |
set_from_templatevoid set_from_template(bool from_template); | |
set_global_qualification_requiredvoid set_global_qualification_required(bool global_qualification_required); | |
set_isAutonomousDeclarationvoid set_isAutonomousDeclaration(bool isAutonomousDeclaration); | |
set_isUnNamedvoid set_isUnNamed(bool isUnNamed); | |
set_lambda_expressionvoid set_lambda_expression(SgLambdaExp* lambda_expression); | |
set_namevoid set_name(SgName name); | |
set_name_qualification_lengthvoid set_name_qualification_length(int name_qualification_length); | |
set_scopevirtual void set_scope(SgScopeStatement* scope) override; [virtual] | |
set_specializationvoid set_specialization(SgDeclarationStatement::template_specialization_enum specialization); | |
set_typevoid set_type(SgClassType* type); | |
set_type_elaboration_requiredvoid set_type_elaboration_required(bool type_elaboration_required); | |
variantTvirtual VariantT variantT() const override; [virtual] | returns new style SageIII enum values |
Static Member Functions¶
| Name | Description |
|---|---|
memoryUsagestatic size_t memoryUsage(); | Returns the size in bytes of the total memory allocated for all IR nodes of this type |
numberOfNodesstatic size_t numberOfNodes(); | Returns the total number of IR nodes of this type |
traverseMemoryPoolNodesstatic void traverseMemoryPoolNodes(ROSE_VisitTraversal& visit); | FOR INTERNAL USE Support for visitor pattern over all IR nodes by type of IR node. |
traverseMemoryPoolVisitorPatternstatic void traverseMemoryPoolVisitorPattern(ROSE_VisitorPattern& visitor); | FOR INTERNAL USE Support for visitor pattern. |
visitRepresentativeNodestatic void visitRepresentativeNode(ROSE_VisitTraversal& visit); | FOR INTERNAL USE Support for type-based traversal. |
Static Data Members¶
| Name | Description |
|---|---|
free_slots | Free slots, each numbered pool_index * pool_size + slot_index. The last entry is allocated next. |
pool_live_flags | |
pool_size | |
pools |
Protected Member Functions¶
| Name |
|---|
compute_classDefinitionSgClassDefinition* compute_classDefinition() const; |
replace_childvirtual bool replace_child( SgStatement*, SgStatement*, bool extractListFromBasicBlock = false) override; [virtual] |
Protected Data Members¶
Friends¶
| Name | Description |
|---|---|
isSgClassDeclaration | Casts pointer from base class to derived class (for const pointers) |
isSgClassDeclaration | Casts pointer from base class to derived class |
Derived Classes¶
| Name | Description |
|---|---|
SgDerivedTypeStatement | |
SgModuleStatement | |
SgTemplateClassDeclaration | |
SgTemplateInstantiationDecl | This class represents the concept of an instantiated class template. |
Created with MrDocs