SgUnaryOp Class Reference

#include <Cxx_Grammar.h>

Inheritance diagram for SgUnaryOp:

Inheritance graph
[legend]
Collaboration diagram for SgUnaryOp:

Collaboration graph
[legend]
List of all members.

Detailed Description

This class represents the notion of a unary operator. It is derived from a SgExpression because operators are expressions.

There are no uses of this IR node anywhere. All expressions are derived from this IR node to build derived classes. Example unary operators include unary minus, unary plus, the address operator, etc.

For internal use only.

This is a base class for all unary operators.

See also:
Example of using a SgUnaryOp object


Public Types

typedef SgExpression base_node_type
 prefix = 0
 postfix
 static_variant = V_SgUnaryOp
enum  Sgop_mode {
  prefix = 0,
  postfix
}
 Enum value defines operators as prefix or postfix, as appropriate, e.g. operator++(). More...
enum  { static_variant = V_SgUnaryOp }
 static variant value More...

Public Member Functions

virtual SgNodecopy (SgCopyHelp &help) const
int length () const ROSE_DEPRECATED_FUNCTION
 Returns number of operands (virtual function).
bool empty () const ROSE_DEPRECATED_FUNCTION
 Returns true if number of operands is zero, else false.
SgExpressionget_next (int &n) const ROSE_DEPRECATED_FUNCTION
 Returns next operand (virtual function).
int replace_expression (SgExpression *, SgExpression *) ROSE_DEPRECATED_FUNCTION
 Replace an expression child of this node with another one.
SgExpressionget_operand () const
 returns SgExpression pointer to the operand associated with this unary operator.
void set_operand (SgExpression *exp)
 This function allows the p_operand pointer to be set (used internally).
SgTypeget_type () const
 get the type associated with this expression
virtual unsigned int cfgIndexForEnd () const
 Determine the CFG index for the end of this construct.
virtual std::vector< VirtualCFG::CFGEdgecfgOutEdges (unsigned int index)
 Find the out edges of a CFG node -- internal version.
virtual 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.
 SgUnaryOp (const SgUnaryOpStorageClass &source)
SgUnaryOpaddRegExpAttribute (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.
SgExpressionget_operand_i () const
 returns SgExpression pointer to the operand associated with this unary operator.
void set_operand_i (SgExpression *operand_i)
 This function allows the p_operand_i pointer to be set (used internally).
SgUnaryOp::Sgop_mode get_mode () const
 Get the prefix/postfix mode of the operator.
void set_mode (SgUnaryOp::Sgop_mode mode)
 Set the mode (prefix/postfix) associated with this operator.
virtual ~SgUnaryOp ()
 This is the destructor.
 SgUnaryOp (Sg_File_Info *startOfConstruct, SgExpression *operand_i=NULL, SgType *expression_type=NULL)
 This is the constructor.
 SgUnaryOp (SgExpression *operand_i, SgType *expression_type)

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

SgExpressionp_operand_i
 This is the operand associated with the unary operator.
SgTypep_expression_type
 This SgType is the type of the operator (function type).
SgUnaryOp::Sgop_mode p_mode
 This SgType is the type of the operator (function type).

Friends

class AST_FILE_IO
class SgUnaryOpStorageClass
class AstSpecificDataManagingClass
class AstSpecificDataManagingClassStorageClass
SgUnaryOpisSgUnaryOp (SgNode *s)
 Casts pointer from base class to derived class.
const SgUnaryOpisSgUnaryOp (const SgNode *s)
 Casts pointer from base class to derived class (for const pointers).
SgUnaryOpSgUnaryOp_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 SgUnaryOp_getNumberOfValidNodesAndSetGlobalIndexInFreepointer (unsigned long)
 Get the size of the memory pool.
void SgUnaryOp_clearMemoryPool ()
void SgUnaryOp_extendMemoryPoolForFileIO (unsigned long)
void SgUnaryOp_getNextValidPointer (std::pair< SgUnaryOp *, std::vector< unsigned char * >::const_iterator > &)
void SgUnaryOp_resetValidFreepointers ()


Member Typedef Documentation

typedef SgExpression SgUnaryOp::base_node_type

Reimplemented from SgExpression.

Reimplemented in SgExpressionRoot, SgMinusOp, SgUnaryAddOp, SgNotOp, SgPointerDerefExp, SgAddressOfOp, SgMinusMinusOp, SgPlusPlusOp, SgBitComplementOp, SgCastExp, SgThrowOp, SgRealPartOp, SgImagPartOp, SgConjugateOp, and SgUserDefinedUnaryOp.


Member Enumeration Documentation

enum SgUnaryOp::Sgop_mode

Enum value defines operators as prefix or postfix, as appropriate, e.g. operator++().

This enum type provides support for specification of prefix/postfix operators such as operator++() using a simpler mechanism thatn that provided by C++. See C++ standard for details of specification of prefix and postfix operators.

For internal use only.

There should be an additional value added to support unknown setting (with value 0)

Enumerator:
prefix 
postfix  Postfix Operator Specifier

anonymous enum

static variant value

Enumerator:
static_variant 


Constructor & Destructor Documentation

SgUnaryOp::SgUnaryOp ( const SgUnaryOpStorageClass &  source  ) 

SgUnaryOp::~SgUnaryOp (  )  [virtual]

This is the destructor.

Only the Sg_File_Info object can be deleted in this object.

SgUnaryOp::SgUnaryOp ( Sg_File_Info startOfConstruct = NULL,
SgExpression operand_i = NULL,
SgType expression_type = NULL 
)

This is the constructor.

This constructor builds the SgUnaryOp base class.

Parameters:
startOfConstruct represents the position in the source code
operand represents the operand to which the operator is applied
expression_type represents the type of the return value of the operator
See also:
Example:create an SgUnaryOp object

SgUnaryOp::SgUnaryOp ( SgExpression operand_i,
SgType expression_type 
)


Member Function Documentation

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

Reimplemented from SgExpression.

Reimplemented in SgExpressionRoot, SgMinusOp, SgUnaryAddOp, SgNotOp, SgPointerDerefExp, SgAddressOfOp, SgMinusMinusOp, SgPlusPlusOp, SgBitComplementOp, SgCastExp, SgThrowOp, SgRealPartOp, SgImagPartOp, SgConjugateOp, and SgUserDefinedUnaryOp.

SgUnaryOp::length (  )  const

Returns number of operands (virtual function).

Returns number of operands (all unary operators return value = 1). This function is not used and is not a defined part a minumal interface for Sage III.

Deprecated:
This function is not used.
Returns:
Returns int

SgUnaryOp::empty (  )  const

Returns true if number of operands is zero, else false.

This function returns boolean value given by (length() == 0). This function is not used and is not a defined part a minumal interface for Sage III.

Deprecated:
This function is not used.
Returns:
Returns bool

SgUnaryOp::get_next ( int &  n  )  const

Returns next operand (virtual function).

This function returns the next operand and is part of an older iterator interface within Sage II which didn't use STL, but implemented iterators for the operands (since their is only one for a unary operator and two for a binary operator we don't support such an iterator interface within Sage III. The goal of Sage III is a minimal easily maintained interface. This function is not used and is not a defined part a minumal interface for Sage III.

Deprecated:
This function is not used.
Returns:
Returns int

int SgUnaryOp::replace_expression ( SgExpression ,
SgExpression  
) [virtual]

Replace an expression child of this node with another one.

It contains all the base functionality for the construction, manipulation, and unparsing support.

Reimplemented from SgExpression.

SgUnaryOp::get_operand (  )  const

returns SgExpression pointer to the operand associated with this unary operator.

Returns:
Returns SgExpression pointer.

SgUnaryOp::set_operand ( SgExpression operand  ) 

This function allows the p_operand pointer to be set (used internally).

This function is mostly used internally and is only required to support editing of existing SgUnaryOp objects.

Parameters:
operand - sets value of internal p_operand pointer.
Returns:
Returns void.

SgType* SgUnaryOp::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 SgExpression.

Reimplemented in SgNotOp, SgPointerDerefExp, SgAddressOfOp, SgCastExp, SgThrowOp, and SgUserDefinedUnaryOp.

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

Determine the CFG index for the end of this construct.

Reimplemented from SgExpression.

Reimplemented in SgThrowOp.

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

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

Reimplemented from SgExpression.

Reimplemented in SgThrowOp.

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

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

Reimplemented from SgExpression.

Reimplemented in SgThrowOp.

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

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

Reimplemented from SgExpression.

Reimplemented in SgExpressionRoot, SgMinusOp, SgUnaryAddOp, SgNotOp, SgPointerDerefExp, SgAddressOfOp, SgMinusMinusOp, SgPlusPlusOp, SgBitComplementOp, SgCastExp, SgThrowOp, SgRealPartOp, SgImagPartOp, SgConjugateOp, and SgUserDefinedUnaryOp.

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

returns new style SageIII enum values

Reimplemented from SgExpression.

Reimplemented in SgExpressionRoot, SgMinusOp, SgUnaryAddOp, SgNotOp, SgPointerDerefExp, SgAddressOfOp, SgMinusMinusOp, SgPlusPlusOp, SgBitComplementOp, SgCastExp, SgThrowOp, SgRealPartOp, SgImagPartOp, SgConjugateOp, and SgUserDefinedUnaryOp.

void* SgUnaryOp::operator new ( size_t  size  ) 

returns pointer to newly allocated IR node

Reimplemented from SgExpression.

Reimplemented in SgExpressionRoot, SgMinusOp, SgUnaryAddOp, SgNotOp, SgPointerDerefExp, SgAddressOfOp, SgMinusMinusOp, SgPlusPlusOp, SgBitComplementOp, SgCastExp, SgThrowOp, SgRealPartOp, SgImagPartOp, SgConjugateOp, and SgUserDefinedUnaryOp.

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

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

Reimplemented from SgExpression.

Reimplemented in SgExpressionRoot, SgMinusOp, SgUnaryAddOp, SgNotOp, SgPointerDerefExp, SgAddressOfOp, SgMinusMinusOp, SgPlusPlusOp, SgBitComplementOp, SgCastExp, SgThrowOp, SgRealPartOp, SgImagPartOp, SgConjugateOp, and SgUserDefinedUnaryOp.

void SgUnaryOp::operator delete ( void *  pointer  ) 

Reimplemented from SgExpression.

Reimplemented in SgExpressionRoot, SgMinusOp, SgUnaryAddOp, SgNotOp, SgPointerDerefExp, SgAddressOfOp, SgMinusMinusOp, SgPlusPlusOp, SgBitComplementOp, SgCastExp, SgThrowOp, SgRealPartOp, SgImagPartOp, SgConjugateOp, and SgUserDefinedUnaryOp.

static size_t SgUnaryOp::numberOfNodes (  )  [static]

Returns the total number of IR nodes of this type.

Reimplemented from SgExpression.

Reimplemented in SgExpressionRoot, SgMinusOp, SgUnaryAddOp, SgNotOp, SgPointerDerefExp, SgAddressOfOp, SgMinusMinusOp, SgPlusPlusOp, SgBitComplementOp, SgCastExp, SgThrowOp, SgRealPartOp, SgImagPartOp, SgConjugateOp, and SgUserDefinedUnaryOp.

static size_t SgUnaryOp::memoryUsage (  )  [static]

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

Reimplemented from SgExpression.

Reimplemented in SgExpressionRoot, SgMinusOp, SgUnaryAddOp, SgNotOp, SgPointerDerefExp, SgAddressOfOp, SgMinusMinusOp, SgPlusPlusOp, SgBitComplementOp, SgCastExp, SgThrowOp, SgRealPartOp, SgImagPartOp, SgConjugateOp, and SgUserDefinedUnaryOp.

virtual std::vector<SgNode*> SgUnaryOp::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 SgExpression.

Reimplemented in SgExpressionRoot, SgMinusOp, SgUnaryAddOp, SgNotOp, SgPointerDerefExp, SgAddressOfOp, SgMinusMinusOp, SgPlusPlusOp, SgBitComplementOp, SgCastExp, SgThrowOp, SgRealPartOp, SgImagPartOp, SgConjugateOp, and SgUserDefinedUnaryOp.

virtual std::vector<std::string> SgUnaryOp::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 SgExpression.

Reimplemented in SgExpressionRoot, SgMinusOp, SgUnaryAddOp, SgNotOp, SgPointerDerefExp, SgAddressOfOp, SgMinusMinusOp, SgPlusPlusOp, SgBitComplementOp, SgCastExp, SgThrowOp, SgRealPartOp, SgImagPartOp, SgConjugateOp, and SgUserDefinedUnaryOp.

virtual size_t SgUnaryOp::get_numberOfTraversalSuccessors (  )  [virtual]

Reimplemented from SgExpression.

Reimplemented in SgExpressionRoot, SgMinusOp, SgUnaryAddOp, SgNotOp, SgPointerDerefExp, SgAddressOfOp, SgMinusMinusOp, SgPlusPlusOp, SgBitComplementOp, SgCastExp, SgThrowOp, SgRealPartOp, SgImagPartOp, SgConjugateOp, and SgUserDefinedUnaryOp.

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

Reimplemented from SgExpression.

Reimplemented in SgExpressionRoot, SgMinusOp, SgUnaryAddOp, SgNotOp, SgPointerDerefExp, SgAddressOfOp, SgMinusMinusOp, SgPlusPlusOp, SgBitComplementOp, SgCastExp, SgThrowOp, SgRealPartOp, SgImagPartOp, SgConjugateOp, and SgUserDefinedUnaryOp.

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

Reimplemented from SgExpression.

Reimplemented in SgExpressionRoot, SgMinusOp, SgUnaryAddOp, SgNotOp, SgPointerDerefExp, SgAddressOfOp, SgMinusMinusOp, SgPlusPlusOp, SgBitComplementOp, SgCastExp, SgThrowOp, SgRealPartOp, SgImagPartOp, SgConjugateOp, and SgUserDefinedUnaryOp.

virtual RTIReturnType SgUnaryOp::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 SgExpression.

Reimplemented in SgExpressionRoot, SgMinusOp, SgUnaryAddOp, SgNotOp, SgPointerDerefExp, SgAddressOfOp, SgMinusMinusOp, SgPlusPlusOp, SgBitComplementOp, SgCastExp, SgThrowOp, SgRealPartOp, SgImagPartOp, SgConjugateOp, and SgUserDefinedUnaryOp.

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

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

Reimplemented from SgExpression.

Reimplemented in SgExpressionRoot, SgMinusOp, SgUnaryAddOp, SgNotOp, SgPointerDerefExp, SgAddressOfOp, SgMinusMinusOp, SgPlusPlusOp, SgBitComplementOp, SgCastExp, SgThrowOp, SgRealPartOp, SgImagPartOp, SgConjugateOp, and SgUserDefinedUnaryOp.

void SgUnaryOp::executeVisitorMemberFunction ( ROSE_VisitorPattern visitor  ) 

FOR INTERNAL USE Support for visitor pattern.

Reimplemented from SgExpression.

Reimplemented in SgExpressionRoot, SgMinusOp, SgUnaryAddOp, SgNotOp, SgPointerDerefExp, SgAddressOfOp, SgMinusMinusOp, SgPlusPlusOp, SgBitComplementOp, SgCastExp, SgThrowOp, SgRealPartOp, SgImagPartOp, SgConjugateOp, and SgUserDefinedUnaryOp.

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

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

Reimplemented from SgExpression.

Reimplemented in SgExpressionRoot, SgMinusOp, SgUnaryAddOp, SgNotOp, SgPointerDerefExp, SgAddressOfOp, SgMinusMinusOp, SgPlusPlusOp, SgBitComplementOp, SgCastExp, SgThrowOp, SgRealPartOp, SgImagPartOp, SgConjugateOp, and SgUserDefinedUnaryOp.

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

FOR INTERNAL USE Support for visitor pattern.

Reimplemented from SgExpression.

Reimplemented in SgExpressionRoot, SgMinusOp, SgUnaryAddOp, SgNotOp, SgPointerDerefExp, SgAddressOfOp, SgMinusMinusOp, SgPlusPlusOp, SgBitComplementOp, SgCastExp, SgThrowOp, SgRealPartOp, SgImagPartOp, SgConjugateOp, and SgUserDefinedUnaryOp.

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

FOR INTERNAL USE Support for visitor pattern.

Reimplemented from SgExpression.

Reimplemented in SgExpressionRoot, SgMinusOp, SgUnaryAddOp, SgNotOp, SgPointerDerefExp, SgAddressOfOp, SgMinusMinusOp, SgPlusPlusOp, SgBitComplementOp, SgCastExp, SgThrowOp, SgRealPartOp, SgImagPartOp, SgConjugateOp, and SgUserDefinedUnaryOp.

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

FOR INTERNAL USE Support for type-based traversal.

Reimplemented from SgExpression.

Reimplemented in SgExpressionRoot, SgMinusOp, SgUnaryAddOp, SgNotOp, SgPointerDerefExp, SgAddressOfOp, SgMinusMinusOp, SgPlusPlusOp, SgBitComplementOp, SgCastExp, SgThrowOp, SgRealPartOp, SgImagPartOp, SgConjugateOp, and SgUserDefinedUnaryOp.

virtual bool SgUnaryOp::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 SgExpression.

Reimplemented in SgExpressionRoot, SgMinusOp, SgUnaryAddOp, SgNotOp, SgPointerDerefExp, SgAddressOfOp, SgMinusMinusOp, SgPlusPlusOp, SgBitComplementOp, SgCastExp, SgThrowOp, SgRealPartOp, SgImagPartOp, SgConjugateOp, and SgUserDefinedUnaryOp.

virtual void SgUnaryOp::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 SgExpression.

Reimplemented in SgExpressionRoot, SgMinusOp, SgUnaryAddOp, SgNotOp, SgPointerDerefExp, SgAddressOfOp, SgMinusMinusOp, SgPlusPlusOp, SgBitComplementOp, SgCastExp, SgThrowOp, SgRealPartOp, SgImagPartOp, SgConjugateOp, and SgUserDefinedUnaryOp.

virtual std::vector<std::pair<SgNode*,std::string> > SgUnaryOp::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 SgExpression.

Reimplemented in SgExpressionRoot, SgMinusOp, SgUnaryAddOp, SgNotOp, SgPointerDerefExp, SgAddressOfOp, SgMinusMinusOp, SgPlusPlusOp, SgBitComplementOp, SgCastExp, SgThrowOp, SgRealPartOp, SgImagPartOp, SgConjugateOp, and SgUserDefinedUnaryOp.

virtual void SgUnaryOp::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 SgExpression.

Reimplemented in SgExpressionRoot, SgMinusOp, SgUnaryAddOp, SgNotOp, SgPointerDerefExp, SgAddressOfOp, SgMinusMinusOp, SgPlusPlusOp, SgBitComplementOp, SgCastExp, SgThrowOp, SgRealPartOp, SgImagPartOp, SgConjugateOp, and SgUserDefinedUnaryOp.

virtual long SgUnaryOp::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 SgExpression.

Reimplemented in SgExpressionRoot, SgMinusOp, SgUnaryAddOp, SgNotOp, SgPointerDerefExp, SgAddressOfOp, SgMinusMinusOp, SgPlusPlusOp, SgBitComplementOp, SgCastExp, SgThrowOp, SgRealPartOp, SgImagPartOp, SgConjugateOp, and SgUserDefinedUnaryOp.

SgUnaryOp* SgUnaryOp::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 SgExpression.

Reimplemented in SgExpressionRoot, SgMinusOp, SgUnaryAddOp, SgNotOp, SgPointerDerefExp, SgAddressOfOp, SgMinusMinusOp, SgPlusPlusOp, SgBitComplementOp, SgCastExp, SgThrowOp, SgRealPartOp, SgImagPartOp, SgConjugateOp, and SgUserDefinedUnaryOp.

void SgUnaryOp::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 SgExpression.

Reimplemented in SgExpressionRoot, SgMinusOp, SgUnaryAddOp, SgNotOp, SgPointerDerefExp, SgAddressOfOp, SgMinusMinusOp, SgPlusPlusOp, SgBitComplementOp, SgCastExp, SgThrowOp, SgRealPartOp, SgImagPartOp, SgConjugateOp, and SgUserDefinedUnaryOp.

SgUnaryOp::get_operand_i (  )  const

returns SgExpression pointer to the operand associated with this unary operator.

Deprecated:
This function is not used.
Returns:
Returns SgExpression pointer.

SgUnaryOp::set_operand_i ( SgExpression operand  ) 

This function allows the p_operand_i pointer to be set (used internally).

This function is mostly used internally and is only required to support editing of existing SgUnaryOp objects.

Deprecated:
This function is not used.
Parameters:
operand - sets value of internal p_operand pointer.
Returns:
Returns void.

SgUnaryOp::get_mode (  )  const

Get the prefix/postfix mode of the operator.

Get the prefix/postfix mode of the operator (if applicable to that operator).

Returns:
Returns SgUnaryOp::Sgop_mode (enum for prefix,postfix values)

SgUnaryOp::set_mode ( SgUnaryOp::Sgop_mode  mode  ) 

Set the mode (prefix/postfix) associated with this operator.

This is an internal function, it sets up the prefix/postfix mode of the unary operator.

Parameters:
mode - sets value of intermal SgUnaryOp::Sgop_mode mode variable
Returns:
Returns void


Friends And Related Function Documentation

friend class AST_FILE_IO [friend]

Reimplemented from SgExpression.

Reimplemented in SgExpressionRoot, SgMinusOp, SgUnaryAddOp, SgNotOp, SgPointerDerefExp, SgAddressOfOp, SgMinusMinusOp, SgPlusPlusOp, SgBitComplementOp, SgCastExp, SgThrowOp, SgRealPartOp, SgImagPartOp, SgConjugateOp, and SgUserDefinedUnaryOp.

friend class SgUnaryOpStorageClass [friend]

friend class AstSpecificDataManagingClass [friend]

Reimplemented from SgExpression.

Reimplemented in SgExpressionRoot, SgMinusOp, SgUnaryAddOp, SgNotOp, SgPointerDerefExp, SgAddressOfOp, SgMinusMinusOp, SgPlusPlusOp, SgBitComplementOp, SgCastExp, SgThrowOp, SgRealPartOp, SgImagPartOp, SgConjugateOp, and SgUserDefinedUnaryOp.

friend class AstSpecificDataManagingClassStorageClass [friend]

Reimplemented from SgExpression.

Reimplemented in SgExpressionRoot, SgMinusOp, SgUnaryAddOp, SgNotOp, SgPointerDerefExp, SgAddressOfOp, SgMinusMinusOp, SgPlusPlusOp, SgBitComplementOp, SgCastExp, SgThrowOp, SgRealPartOp, SgImagPartOp, SgConjugateOp, and SgUserDefinedUnaryOp.

SgUnaryOp::isSgUnaryOp ( SgNode s  )  [friend]

Casts pointer from base class to derived class.

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

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

SgUnaryOp::isSgUnaryOp ( const SgNode s  )  [friend]

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

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

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

SgUnaryOp* SgUnaryOp_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 SgUnaryOp_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 SgUnaryOp_clearMemoryPool (  )  [friend]

void SgUnaryOp_extendMemoryPoolForFileIO ( unsigned  long  )  [friend]

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

void SgUnaryOp_resetValidFreepointers (  )  [friend]


Member Data Documentation

SgUnaryOp::p_operand_i [protected]

This is the operand associated with the unary operator.

Every unary operator is applied to a single operand, this variable stores the operand to which the unary operator is applied.

SgUnaryOp::p_expression_type [protected]

This SgType is the type of the operator (function type).

The type is now computed where possible (in all cases except for SgCastExp). This allows us to save space and avoid having explicitly stored values be unset or set incorrectly.

Deprecated:
This is no longer used (except for SgCastExp).
Todo:
This value is only used for the SgCastExp, we will move it to that IR node when we are ready to change the interface for the SgExpressions (and SgUnaryExp IR nodes).

SgUnaryOp::p_mode [protected]

This SgType is the type of the operator (function type).

This variable records the prefix vs. postfix semantics of the operator since the syntax of "operator++" cannot readily do so. This approach is simpiler to interogate than the C++ syntax for distingishing prefix vs. postfix.


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