Skip to content

SgCaseOptionStmt

This class represents the concept of a C and C++ case option (used within a switch statement).

Synopsis

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

class [[visibility("default")]] SgCaseOptionStmt
    : public SgStatement

Description

  • See also: Example of using a SgCaseOptionStmt object

Data members

SgCaseOptionStmt::p_key_range_end

This pointer points to the last constant in the range when a gnu range case label is used.

  • Internal: We can't represent the range a ... b as an expression in C or C++ so we need to explicitly store the start and end of the range where it is used as a case label. The p_key is the start of the range.

SgCaseOptionStmt::p_body

This pointer points to a SgStatement object.

Member functions

SgCaseOptionStmt::get_key() const

Returns the case label expression.

  • Internal: This should always be a valid pointer.
  • Return: Returns pointer to SgExpression.

SgCaseOptionStmt::set_key(SgExpression* key)

Sets the case label expression.

  • Return: Returns void.

SgCaseOptionStmt::get_body() const

Returns pointer to a SgStatement object.

  • Internal: This should always be a valid pointer.
  • Return: Returns pointer to SgStatement.

SgCaseOptionStmt::set_body(SgStatement* body)

Access function for p_body.

  • Return: Returns void.

Base Classes

Name Description
SgStatement This class represents the notion of a statement.

Type Aliases

Name
base_node_type

Enums

Name Description
Unnamed enum static variant value

Member Functions

Name Description
SgCaseOptionStmt
SgCaseOptionStmt( SgExpression* key, SgStatement* body); [constructor]
Constructors
~SgCaseOptionStmt
virtual ~SgCaseOptionStmt(); [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]
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]
get_body
SgStatement* get_body() const;
get_case_construct_name
std::string get_case_construct_name() const;
get_childIndex
virtual size_t get_childIndex(SgNode* child) const override; [virtual]
index-based access to traversal successors by child node
get_key
SgExpression* get_key() const;
get_key_range_end
SgExpression* get_key_range_end() const;
get_numberOfTraversalSuccessors
virtual size_t get_numberOfTraversalSuccessors() const override; [virtual]
return number of children in the traversal successor list
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]
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_body
void set_body(SgStatement* body);
set_case_construct_name
void set_case_construct_name(std::string case_construct_name);
set_key
void set_key(SgExpression* key);
set_key_range_end
void set_key_range_end(SgExpression* key_range_end);
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
cfgFindChildIndex
virtual unsigned int cfgFindChildIndex(SgNode* n) override; [virtual]
cfgInEdges
virtual std::vector<VirtualCFG::CFGEdge> cfgInEdges(unsigned int index) override; [virtual]
cfgIndexForEnd
virtual unsigned int cfgIndexForEnd() const override; [virtual]
cfgIsIndexInteresting
virtual bool cfgIsIndexInteresting(unsigned int) const override; [virtual]
cfgOutEdges
virtual std::vector<VirtualCFG::CFGEdge> cfgOutEdges(unsigned int index) 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]
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_body
p_case_construct_name
p_key
p_key_range_end

Friends

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

Created with MrDocs