SgFloatVal Class Reference

#include <Cxx_Grammar.h>

Inheritance diagram for SgFloatVal:

Inheritance graph
[legend]
Collaboration diagram for SgFloatVal:

Collaboration graph
[legend]
List of all members.

Detailed Description

This class represents the notion of an value (expression value).

For internal use only.

This class will hold a string value so that the exact text for constants can be help in the AST.

Todo:
Add string to this class so that the exact value can be held in the AST.
See also:
Example of using a SgFloatVal object


Public Types

typedef SgValueExp base_node_type
 static_variant = V_SgFloatVal
enum  { static_variant = V_SgFloatVal }
 static variant value More...

Public Member Functions

virtual SgNodecopy (SgCopyHelp &help) const
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.
 SgFloatVal (const SgFloatValStorageClass &source)
SgFloatValaddRegExpAttribute (std::string s, AstRegExAttribute *a)
 Support for AST matching using regular expression.
SgTypeget_type () const
 get the type associated with this 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.
float get_value () const
void set_value (float value)
std::string get_valueString () const
void set_valueString (std::string valueString)
virtual ~SgFloatVal ()
 This is the destructor.
 SgFloatVal (Sg_File_Info *startOfConstruct, float value=0.0, std::string valueString="")
 SgFloatVal (float value, std::string valueString)

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

float p_value
 This value holds the float represented in the source code.
std::string p_valueString

Friends

class AST_FILE_IO
class SgFloatValStorageClass
class AstSpecificDataManagingClass
class AstSpecificDataManagingClassStorageClass
SgFloatValisSgFloatVal (SgNode *s)
 Casts pointer from base class to derived class.
const SgFloatValisSgFloatVal (const SgNode *s)
 Casts pointer from base class to derived class (for const pointers).
SgFloatValSgFloatVal_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 SgFloatVal_getNumberOfValidNodesAndSetGlobalIndexInFreepointer (unsigned long)
 Get the size of the memory pool.
void SgFloatVal_clearMemoryPool ()
void SgFloatVal_extendMemoryPoolForFileIO (unsigned long)
void SgFloatVal_getNextValidPointer (std::pair< SgFloatVal *, std::vector< unsigned char * >::const_iterator > &)
void SgFloatVal_resetValidFreepointers ()


Member Typedef Documentation

typedef SgValueExp SgFloatVal::base_node_type

Reimplemented from SgValueExp.


Member Enumeration Documentation

anonymous enum

static variant value

Enumerator:
static_variant 


Constructor & Destructor Documentation

SgFloatVal::SgFloatVal ( const SgFloatValStorageClass &  source  ) 

SgFloatVal::~SgFloatVal (  )  [virtual]

This is the destructor.

Only the Sg_File_Info object can be deleted in this object.

SgFloatVal::SgFloatVal ( Sg_File_Info startOfConstruct,
float  value = 0.0,
std::string  valueString = "" 
)

SgFloatVal::SgFloatVal ( float  value,
std::string  valueString 
)


Member Function Documentation

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

Reimplemented from SgValueExp.

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

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

Reimplemented from SgValueExp.

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

returns new style SageIII enum values

Reimplemented from SgValueExp.

void* SgFloatVal::operator new ( size_t  size  ) 

returns pointer to newly allocated IR node

Reimplemented from SgValueExp.

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

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

Reimplemented from SgValueExp.

void SgFloatVal::operator delete ( void *  pointer  ) 

Reimplemented from SgValueExp.

static size_t SgFloatVal::numberOfNodes (  )  [static]

Returns the total number of IR nodes of this type.

Reimplemented from SgValueExp.

static size_t SgFloatVal::memoryUsage (  )  [static]

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

Reimplemented from SgValueExp.

virtual std::vector<SgNode*> SgFloatVal::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 SgValueExp.

virtual std::vector<std::string> SgFloatVal::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 SgValueExp.

virtual size_t SgFloatVal::get_numberOfTraversalSuccessors (  )  [virtual]

Reimplemented from SgValueExp.

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

Reimplemented from SgValueExp.

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

Reimplemented from SgValueExp.

virtual RTIReturnType SgFloatVal::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 SgValueExp.

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

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

Reimplemented from SgValueExp.

void SgFloatVal::executeVisitorMemberFunction ( ROSE_VisitorPattern visitor  ) 

FOR INTERNAL USE Support for visitor pattern.

Reimplemented from SgValueExp.

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

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

Reimplemented from SgValueExp.

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

FOR INTERNAL USE Support for visitor pattern.

Reimplemented from SgValueExp.

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

FOR INTERNAL USE Support for visitor pattern.

Reimplemented from SgValueExp.

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

FOR INTERNAL USE Support for type-based traversal.

Reimplemented from SgValueExp.

virtual bool SgFloatVal::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 SgValueExp.

virtual void SgFloatVal::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 SgValueExp.

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

virtual void SgFloatVal::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 SgValueExp.

virtual long SgFloatVal::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 SgValueExp.

SgFloatVal* SgFloatVal::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 SgValueExp.

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

void SgFloatVal::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 SgValueExp.

float SgFloatVal::get_value (  )  const

void SgFloatVal::set_value ( float  value  ) 

std::string SgFloatVal::get_valueString (  )  const

void SgFloatVal::set_valueString ( std::string  valueString  ) 


Friends And Related Function Documentation

friend class AST_FILE_IO [friend]

Reimplemented from SgValueExp.

friend class SgFloatValStorageClass [friend]

friend class AstSpecificDataManagingClass [friend]

Reimplemented from SgValueExp.

friend class AstSpecificDataManagingClassStorageClass [friend]

Reimplemented from SgValueExp.

SgFloatVal* isSgFloatVal ( SgNode s  )  [friend]

Casts pointer from base class to derived class.

const SgFloatVal* isSgFloatVal ( const SgNode s  )  [friend]

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

SgFloatVal* SgFloatVal_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 SgFloatVal_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 SgFloatVal_clearMemoryPool (  )  [friend]

void SgFloatVal_extendMemoryPoolForFileIO ( unsigned  long  )  [friend]

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

void SgFloatVal_resetValidFreepointers (  )  [friend]


Member Data Documentation

SgFloatVal::p_value [protected]

This value holds the float represented in the source code.

std::string SgFloatVal::p_valueString [protected]


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