Skip to content

SgClassDefinition

This class represents the concept of a class definition in C++.

Synopsis

Declared in <src/frontend/SageIII/Cxx_Grammar.h> (not stored in Git)

class [[visibility("default")]] SgClassDefinition
    : public SgScopeStatement

Description

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.

  • Internal: This is a base class for the SgTemplateInstantiationDefn statements.

Data members

SgClassDefinition::p_members

This the list of member declarations in the class.

SgClassDefinition::p_inheritances

This the list of base classes specificed in the class definition.

  • Internal: The order of base classes can be important.

Member functions

SgClassDefinition::copy(const SgCopyHelp & help)

Makes a copy (deap of shallow depending on SgCopyHelp).

  • Return: Returns pointer to copy of SgClassDefinition.

SgClassDefinition::get_members()

Returns a list to the data member declarations.

  • Return: Returns an STL list by reference.

SgClassDefinition::get_members() const

Returns a const list to the data member declarations.

  • Return: Returns a const STL list by reference.

SgClassDefinition::get_inheritances()

Returns a list to the base classes.

  • Return: Returns an STL list by reference.

SgClassDefinition::get_inheritances() const

Returns a const list to the base classes.

  • Return: Returns a const STL list by reference.

SgClassDefinition::get_qualified_name() const

Returns SgName (a string) representing the name of the current scope. See discussion of qualified names in the documentation.

  • Return: Returns SgName (a string).

SgClassDefinition::get_declaration()

returns the class declaration associated with this class decinition.

  • Return: Returns SgClassDeclaration pointer.

Base Classes

Name Description
SgScopeStatement This class represents the concept of a scope in C++ (e.g. global scope, fuction scope, etc.).

Type Aliases

Name
base_node_type

Enums

Name Description
Unnamed enum static variant value
source_member_role_enum

Member Functions

Name Description
SgClassDefinition
SgClassDefinition(); [constructor]
Constructors
~SgClassDefinition
virtual ~SgClassDefinition(); [destructor] [virtual]
Destructor
accept
virtual void accept(ROSE_VisitorPattern& visitor) override; [virtual]
support for the classic visitor pattern done in GoF
appendDestructorOwnedNodes
virtual void appendDestructorOwnedNodes(std::vector<SgNode*>& nodes) const override; [virtual]
append_inheritance
virtual void append_inheritance(SgBaseClass* element); [virtual]
append_member
virtual void append_member(SgDeclarationStatement* element); [virtual]
class_name
virtual std::string class_name() const override; [virtual]
returns a string representing the class name
copy
virtual SgNode* copy(SgCopyHelp& help) const override; [virtual]
fixupCopy_references
virtual void fixupCopy_references( SgNode* copy, SgCopyHelp& help) const override; [virtual]
fixupCopy_scopes
virtual void fixupCopy_scopes( SgNode* copy, SgCopyHelp& help) const override; [virtual]
fixupCopy_symbols
virtual void fixupCopy_symbols( SgNode* copy, SgCopyHelp& help) const override; [virtual]
get_childIndex
virtual size_t get_childIndex(SgNode* child) const override; [virtual]
index-based access to traversal successors by child node
get_construction_physical_output_owner
SgScopeStatement* get_construction_physical_output_owner() const;
get_declaration
SgClassDeclaration* get_declaration() const;
get_inheritances
SgBaseClassPtrList const& get_inheritances() const;
get_isPrivate
bool get_isPrivate() const;
get_isSequence
bool get_isSequence() const;
get_mangled_name
virtual SgName get_mangled_name() const override; [virtual]
get_members
SgDeclarationStatementPtrList const& get_members() const;
get_numberOfTraversalSuccessors
virtual size_t get_numberOfTraversalSuccessors() const override; [virtual]
return number of children in the traversal successor list
get_qualified_name
virtual SgName get_qualified_name() const override; [virtual]
get_source_member_roles
SgUnsignedCharList get_source_member_roles() const;
get_traversalSuccessorByIndex
virtual SgNode* get_traversalSuccessorByIndex(size_t idx) const override; [virtual]
index-based access to traversal successors by index number
get_traversalSuccessorContainer
virtual 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_traversalSuccessorIsListElement
virtual std::vector<bool> get_traversalSuccessorIsListElement() const override; [virtual]
get_traversalSuccessorNamesContainer
virtual 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
operator delete
void operator delete( void* pointer, size_t size);
deallocated memory for IR node (returns memory to memory pool for reuse)
operator new
void* operator new(size_t size);
returns pointer to newly allocated IR node
post_construction_initialization
virtual void post_construction_initialization() override; [virtual]
prepend_inheritance
virtual void prepend_inheritance(SgBaseClass* element); [virtual]
prepend_member
virtual void prepend_member(SgDeclarationStatement* element); [virtual]
processDataMemberReferenceToPointers
virtual void processDataMemberReferenceToPointers(ReferenceToPointerHandler*) override; [virtual]
Pass references to stored node pointers to a handler.
returnDataMemberPointers
virtual std::vector<std::pair<SgNode*, std::string>> returnDataMemberPointers() const override; [virtual]
Return the node pointers stored in this node's data members.
roseRTI
virtual RTIReturnType roseRTI() override; [virtual]
return C++ Runtime-Time-Information
sage_class_name
virtual char const* sage_class_name() const override; [virtual]
returns a C style string (char*) representing the class name
set_construction_physical_output_owner
void set_construction_physical_output_owner(SgScopeStatement* construction_physical_output_owner);
set_declaration
void set_declaration(SgClassDeclaration* new_val);
set_isPrivate
void set_isPrivate(bool isPrivate);
set_isSequence
void set_isSequence(bool isSequence);
set_source_member_roles
void set_source_member_roles(SgUnsignedCharList source_member_roles);
variantT
virtual VariantT variantT() const override; [virtual]
returns new style SageIII enum values

Static Member Functions

Name Description
memoryUsage
static size_t memoryUsage();
Returns the size in bytes of the total memory allocated for all IR nodes of this type
numberOfNodes
static size_t numberOfNodes();
Returns the total number of IR nodes of this type
traverseMemoryPoolNodes
static void traverseMemoryPoolNodes(ROSE_VisitTraversal& visit);
FOR INTERNAL USE Support for visitor pattern over all IR nodes by type of IR node.
traverseMemoryPoolVisitorPattern
static void traverseMemoryPoolVisitorPattern(ROSE_VisitorPattern& visitor);
FOR INTERNAL USE Support for visitor pattern.
visitRepresentativeNode
static 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
insert_child
virtual bool insert_child( SgStatement*, SgStatement*, bool inFront = true, bool extractListFromBasicBlock = false) override; [virtual]
replace_child
virtual bool replace_child( SgStatement*, SgStatement*, bool extractListFromBasicBlock = false) override; [virtual]

Protected Data Members

Name
p_construction_physical_output_owner
p_inheritances
p_isPrivate
p_isSequence
p_members
p_source_member_roles

Friends

Name Description
isSgClassDefinition Casts pointer from base class to derived class (for const pointers)
isSgClassDefinition Casts pointer from base class to derived class

Derived Classes

Name Description
SgTemplateClassDefinition
SgTemplateInstantiationDefn This class represents the concept of a class definition in C++.

Created with MrDocs