SgThrowOp Class Reference

#include <Cxx_Grammar.h>

Inheritance diagram for SgThrowOp:

Inheritance graph
[legend]
Collaboration diagram for SgThrowOp:

Collaboration graph
[legend]
List of all members.

Detailed Description

This class represents the C++ throw expression (handled as a unary operator).

This class represents three different approaches to the use of the throw expression within a C++ program. 1) throw expression (with specified function) 2) throw exceoption specification (with list of types to throw) 3) rethrow current exception (specified as simply "throw;") The constructor takes the parameters required to empliment these three kinds of throws.

For internal use only.

We should perhaps define specialized constructors for each kind of throw.

Todo:
Make the "*PtrList" typed objects non-pointer data members (lists) instead of pointer to lists.
Todo:
Consider that get_type() returns a SgDefalutType and should return the SgType associated with the last expression in the list (research details of the list of pointers in the C++ throw operator).
See also:
Example:create an SgThrowOp object Example of using a SgThrowOp object

Example throw in C++ example


Public Types

typedef SgUnaryOp base_node_type
 unknown_throw = 0
 throw_expression
 rethrow
 static_variant = V_SgThrowOp
enum  e_throw_kind {
  unknown_throw = 0,
  throw_expression,
  rethrow
}
 Throw IR node can be used in three different ways. More...
enum  { static_variant = V_SgThrowOp }
 static variant value More...

Public Member Functions

virtual SgNodecopy (SgCopyHelp &help) const
SgTypeget_type () const
 get the type associated with this expression
unsigned int cfgIndexForEnd () const
 Determine the CFG index for the end of this construct.
std::vector< VirtualCFG::CFGEdgecfgOutEdges (unsigned int index)
 Find the out edges of a CFG node -- internal version.
std::vector< VirtualCFG::CFGEdgecfgInEdges (unsigned int index)
 Find the in edges of a CFG node -- internal version.
virtual std::string class_name () const
 Copies AST (whole subtree, depending on the SgCopyHelp class returns a string representing the class name.
virtual VariantT variantT () const
 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 ()
 FOR INTERNAL USE within ROSE traverals mechanism only.
virtual std::vector< std::string > get_traversalSuccessorNamesContainer ()
 FOR INTERNAL USE within ROSE traverals mechanism only.
virtual size_t get_numberOfTraversalSuccessors ()
virtual SgNodeget_traversalSuccessorByIndex (size_t idx)
virtual size_t get_childIndex (SgNode *child)
virtual RTIReturnType roseRTI ()
 FOR INTERNAL USE Access to Runtime Type Information (RTI) for this IR nodes.
virtual const char * sage_class_name () const ROSE_DEPRECATED_FUNCTION
void executeVisitorMemberFunction (ROSE_VisitorPattern &visitor)
 FOR INTERNAL USE Support for visitor pattern.
virtual void accept (ROSE_VisitorPattern &visitor)
 DXN (08/09/2010): support for the classic visitor pattern done in GoF.
virtual bool isInMemoryPool ()
 FOR INTERNAL USE This is used in internal tests to verify that all IR nodes are allocated from the heap.
virtual void checkDataMemberPointersIfInMemoryPool ()
 FOR INTERNAL USE This is used in internal tests to verify that all IR nodes are allocated from the heap.
virtual std::vector< std::pair<
SgNode *, std::string > > 
returnDataMemberPointers () const
 FOR INTERNAL USE Returns STL vector of pairs of SgNode* and strings for use in AST tools
virtual void processDataMemberReferenceToPointers (ReferenceToPointerHandler *)
 FOR INTERNAL USE Processes pairs of references to SgNode* and strings for use in AST tools
virtual long getChildIndex (SgNode *childNode) const
 FOR INTERNAL USE Returns a unique index value for the childNode in the list of children at this IR node.
 SgThrowOp (const SgThrowOpStorageClass &source)
SgThrowOpaddRegExpAttribute (std::string s, AstRegExAttribute *a)
 Support for AST matching using regular expression.
void post_construction_initialization ()
 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.
int precedence () const
 return precedence (scale of 0-10, as I recall)
SgThrowOp::e_throw_kind get_throwKind () const
void set_throwKind (SgThrowOp::e_throw_kind throwKind)
virtual ~SgThrowOp ()
 This is the destructor.
 SgThrowOp (Sg_File_Info *startOfConstruct, SgExpression *operand_i=NULL, SgType *expression_type=NULL, SgThrowOp::e_throw_kind throwKind=SgThrowOp::unknown_throw)
 SgThrowOp (SgExpression *operand_i, SgType *expression_type, SgThrowOp::e_throw_kind throwKind)

Static Public Member Functions

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.
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.

Protected Attributes

SgThrowOp::e_throw_kind p_throwKind
 This enum value classifies the throw as either of three different kinds.

Friends

class AST_FILE_IO
class SgThrowOpStorageClass
class AstSpecificDataManagingClass
class AstSpecificDataManagingClassStorageClass
SgThrowOpisSgThrowOp (SgNode *s)
 Casts pointer from base class to derived class.
const SgThrowOpisSgThrowOp (const SgNode *s)
 Casts pointer from base class to derived class (for const pointers).
SgThrowOpSgThrowOp_getPointerFromGlobalIndex (unsigned long globalIndex)
 Constructor for use by AST File I/O MechanismTypedef used for low level memory access. Typedef used to hold memory addresses as values. Methods to find the pointer to a global and local index.
unsigned long SgThrowOp_getNumberOfValidNodesAndSetGlobalIndexInFreepointer (unsigned long)
 Get the size of the memory pool.
void SgThrowOp_clearMemoryPool ()
void SgThrowOp_extendMemoryPoolForFileIO (unsigned long)
void SgThrowOp_getNextValidPointer (std::pair< SgThrowOp *, std::vector< unsigned char * >::const_iterator > &)
void SgThrowOp_resetValidFreepointers ()


Member Typedef Documentation

typedef SgUnaryOp SgThrowOp::base_node_type

Reimplemented from SgUnaryOp.


Member Enumeration Documentation

enum SgThrowOp::e_throw_kind

Throw IR node can be used in three different ways.

Enumerator:
unknown_throw 
throw_expression  throw expression (takes an expression)
rethrow  rethow expression (as in \"rethrow;\")

anonymous enum

static variant value

Enumerator:
static_variant 


Constructor & Destructor Documentation

SgThrowOp::SgThrowOp ( const SgThrowOpStorageClass &  source  ) 

SgThrowOp::~SgThrowOp (  )  [virtual]

This is the destructor.

Only the Sg_File_Info object can be deleted in this object.

SgThrowOp::SgThrowOp ( Sg_File_Info startOfConstruct,
SgExpression operand_i = NULL,
SgType expression_type = NULL,
SgThrowOp::e_throw_kind  throwKind = SgThrowOp::unknown_throw 
)

SgThrowOp::SgThrowOp ( SgExpression operand_i,
SgType expression_type,
SgThrowOp::e_throw_kind  throwKind 
)


Member Function Documentation

virtual SgNode* SgThrowOp::copy ( SgCopyHelp help  )  const [virtual]

Reimplemented from SgUnaryOp.

SgType* SgThrowOp::get_type (  )  const [virtual]

get the type associated with this expression

This function is the correct user function to call to get the type (note that get_expression_type() is for internal use only).

Returns:
Returns pointer to SgType (base class for all possible types)

Reimplemented from SgUnaryOp.

unsigned int SgThrowOp::cfgIndexForEnd (  )  const [virtual]

Determine the CFG index for the end of this construct.

Reimplemented from SgUnaryOp.

std::vector<VirtualCFG::CFGEdge> SgThrowOp::cfgOutEdges ( unsigned int  index  )  [virtual]

Find the out edges of a CFG node -- internal version.

Reimplemented from SgUnaryOp.

std::vector<VirtualCFG::CFGEdge> SgThrowOp::cfgInEdges ( unsigned int  index  )  [virtual]

Find the in edges of a CFG node -- internal version.

Reimplemented from SgUnaryOp.

virtual std::string SgThrowOp::class_name (  )  const [virtual]

Copies AST (whole subtree, depending on the SgCopyHelp class returns a string representing the class name.

Reimplemented from SgUnaryOp.

virtual VariantT SgThrowOp::variantT (  )  const [virtual]

returns new style SageIII enum values

Reimplemented from SgUnaryOp.

void* SgThrowOp::operator new ( size_t  size  ) 

returns pointer to newly allocated IR node

Reimplemented from SgUnaryOp.

void SgThrowOp::operator delete ( void *  pointer,
size_t  size 
)

deallocated memory for IR node (returns memory to memory pool for reuse)

Reimplemented from SgUnaryOp.

void SgThrowOp::operator delete ( void *  pointer  ) 

Reimplemented from SgUnaryOp.

static size_t SgThrowOp::numberOfNodes (  )  [static]

Returns the total number of IR nodes of this type.

Reimplemented from SgUnaryOp.

static size_t SgThrowOp::memoryUsage (  )  [static]

Returns the size in bytes of the total memory allocated for all IR nodes of this type.

Reimplemented from SgUnaryOp.

virtual std::vector<SgNode*> SgThrowOp::get_traversalSuccessorContainer (  )  [virtual]

FOR INTERNAL USE within ROSE traverals mechanism only.

This function builds and returns a copy of ordered container holding pointers to children of this node in a traversal. It is associated with the definition of a tree that is travered by the AST traversal mechanism; a tree that is embeded in the AST (which is a more general graph). This function is used within the implementation of the AST traversal and has a semantics may change in subtle ways that makes it difficult to use in user code. It can return unexpected data members and thus the order and the number of elements is unpredicable and subject to change.

Warning:
This function can return unexpected data members and thus the order and the number of elements is unpredicable and subject to change.
Returns:
Returns ordered STL Container of pointers to children nodes in AST.

Reimplemented from SgUnaryOp.

virtual std::vector<std::string> SgThrowOp::get_traversalSuccessorNamesContainer (  )  [virtual]

FOR INTERNAL USE within ROSE traverals mechanism only.

This function builds and returns a copy of ordered container holding strings used to name data members that are traversed in the IR node. It is associated with the definition of a tree that is travered by the AST traversal mechanism; a tree that is embeded in the AST (which is a more general graph). This function is used within the implementation of the AST traversal and has a semantics may change in subtle ways that makes it difficult to use in user code. It can return unexpected data members and thus the order and the number of elements is unpredicable and subject to change.

Warning:
This function can return unexpected data members and thus the order and the number of elements is unpredicable and subject to change.
Each string is a name of a member variable holding a pointer to a child in the AST. The names are the same as used in the generated enums for accessing attributes in a traversal. The order is the same in which they are traversed and the same in which the access enums are defined. Therefore this method can be used to get the corresponding name (string) of an access enum which allows to produce more meaningful messages for attribute computations.

Returns:
Returns ordered STL container of names (strings) of access names to children nodes in AST.

Reimplemented from SgUnaryOp.

virtual size_t SgThrowOp::get_numberOfTraversalSuccessors (  )  [virtual]

Reimplemented from SgUnaryOp.

virtual SgNode* SgThrowOp::get_traversalSuccessorByIndex ( size_t  idx  )  [virtual]

Reimplemented from SgUnaryOp.

virtual size_t SgThrowOp::get_childIndex ( SgNode child  )  [virtual]

Reimplemented from SgUnaryOp.

virtual RTIReturnType SgThrowOp::roseRTI (  )  [virtual]

FOR INTERNAL USE Access to Runtime Type Information (RTI) for this IR nodes.

This function provides runtime type information for accessing the structure of the current node. It is useful for generating code which would dump out or rebuild IR nodes.

Returns:
Returns a RTIReturnType object (runtime type information).

Reimplemented from SgUnaryOp.

virtual const char* SgThrowOp::sage_class_name (  )  const [virtual]

returns a C style string (char*) representing the class name

Reimplemented from SgUnaryOp.

void SgThrowOp::executeVisitorMemberFunction ( ROSE_VisitorPattern visitor  ) 

FOR INTERNAL USE Support for visitor pattern.

Reimplemented from SgUnaryOp.

virtual void SgThrowOp::accept ( ROSE_VisitorPattern visitor  )  [virtual]

DXN (08/09/2010): support for the classic visitor pattern done in GoF.

Reimplemented from SgUnaryOp.

static void SgThrowOp::traverseMemoryPoolNodes ( ROSE_VisitTraversal visit  )  [static]

FOR INTERNAL USE Support for visitor pattern.

Reimplemented from SgUnaryOp.

static void SgThrowOp::traverseMemoryPoolVisitorPattern ( ROSE_VisitorPattern visitor  )  [static]

FOR INTERNAL USE Support for visitor pattern.

Reimplemented from SgUnaryOp.

static void SgThrowOp::visitRepresentativeNode ( ROSE_VisitTraversal visit  )  [static]

FOR INTERNAL USE Support for type-based traversal.

Reimplemented from SgUnaryOp.

virtual bool SgThrowOp::isInMemoryPool (  )  [virtual]

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 SgUnaryOp.

virtual void SgThrowOp::checkDataMemberPointersIfInMemoryPool (  )  [virtual]

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 SgUnaryOp.

virtual std::vector<std::pair<SgNode*,std::string> > SgThrowOp::returnDataMemberPointers (  )  const [virtual]

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 SgUnaryOp.

virtual void SgThrowOp::processDataMemberReferenceToPointers ( ReferenceToPointerHandler *   )  [virtual]

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 SgUnaryOp.

virtual long SgThrowOp::getChildIndex ( SgNode childNode  )  const [virtual]

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 SgUnaryOp.

SgThrowOp* SgThrowOp::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.

Reimplemented from SgUnaryOp.

void SgThrowOp::post_construction_initialization (  )  [virtual]

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.

Reimplemented from SgUnaryOp.

int SgThrowOp::precedence (  )  const [inline, virtual]

return precedence (scale of 0-10, as I recall)

Reimplemented from SgExpression.

SgThrowOp::e_throw_kind SgThrowOp::get_throwKind (  )  const

void SgThrowOp::set_throwKind ( SgThrowOp::e_throw_kind  throwKind  ) 


Friends And Related Function Documentation

friend class AST_FILE_IO [friend]

Reimplemented from SgUnaryOp.

friend class SgThrowOpStorageClass [friend]

friend class AstSpecificDataManagingClass [friend]

Reimplemented from SgUnaryOp.

friend class AstSpecificDataManagingClassStorageClass [friend]

Reimplemented from SgUnaryOp.

SgThrowOp::isSgThrowOp ( SgNode s  )  [friend]

Casts pointer from base class to derived class.

This functions returns a SgThrowOp pointer for any input of a pointer to an object derived from a SgThrowOp.

Returns:
Returns valid pointer to SgThrowOp if input is derived from a SgThrowOp.

SgThrowOp::isSgThrowOp ( const SgNode s  )  [friend]

Casts pointer from base class to derived class (for const pointers).

This functions returns a SgThrowOp pointer for any input of a pointer to an object derived from a SgThrowOp.

Returns:
Returns valid pointer to SgThrowOp if input is derived from a SgThrowOp.

SgThrowOp* SgThrowOp_getPointerFromGlobalIndex ( unsigned long  globalIndex  )  [friend]

Constructor for use by AST File I/O MechanismTypedef used for low level memory access. Typedef used to hold memory addresses as values. Methods to find the pointer to a global and local index.

unsigned long SgThrowOp_getNumberOfValidNodesAndSetGlobalIndexInFreepointer ( unsigned  long  )  [friend]

Get the size of the memory pool.

It actually returns the size of the whole blocks allocated, no matter they contain valid pointers or not.

void SgThrowOp_clearMemoryPool (  )  [friend]

void SgThrowOp_extendMemoryPoolForFileIO ( unsigned  long  )  [friend]

void SgThrowOp_getNextValidPointer ( std::pair< SgThrowOp *, std::vector< unsigned char * >::const_iterator > &   )  [friend]

void SgThrowOp_resetValidFreepointers (  )  [friend]


Member Data Documentation

SgThrowOp::p_throwKind [protected]

This enum value classifies the throw as either of three different kinds.

This variable is used to classify the throw and either: #) throw expression (with specified function) #) throw exceoption specification (with list of types to throw) #) rethrow current exception (specified as simply "throw;") which are used internally to guide the unparsing and interogation of the IR node.


The documentation for this class was generated from the following files:
Generated on Tue Jan 31 05:43:31 2012 for ROSE by  doxygen 1.4.7