SgOptions Class Reference

#include <Cxx_Grammar.h>

Inheritance diagram for SgOptions:

[legend]Collaboration diagram for SgOptions:

[legend]List of all members.

---

Detailed Description

This class represents an object used to initialize the unparsing.

There are no uses of this IR nodes anywhere in the AST.

For internal use only.

This is an object used only internally.

Todo:

Review if we really want to keep this class.

See also:

Example of using a SgOptions object

Public Types
typedef SgSupport	base_node_type
	static_variant = V_SgOptions
enum	{ static_variant = V_SgOptions }
	static variant value More...
Public Member Functions
virtual SgNode *	copy (SgCopyHelp &help) const
std::ostream &	default_output ()
void	set_default_output (std::ostream &os)
std::ostream &	debug_output ()
void	set_debug_output (std::ostream &os)
std::ostream &	error_output ()
void	set_error_output (std::ostream &os)
std::ostream &	logging_output ()
void	set_logging_output (std::ostream &os)
int	debug_level ()
void	set_debug_level (int l)
int	logging_level ()
void	set_logging (std::ostream &log_file, int level)
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 SgNode *	get_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.
	SgOptions (const SgOptionsStorageClass &source)
SgOptions *	addRegExpAttribute (std::string s, AstRegExAttribute *a)
	Support for AST matching using regular expression.
virtual	~SgOptions ()
	This is the destructor.
	SgOptions ()
	This is the constructor.
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
std::ostream *	p_default_output
std::ostream *	p_debug_output
std::ostream *	p_error_output
std::ostream *	p_logging_output
int	p_debug_level
int	p_logging_level
Friends
class	AST_FILE_IO
class	SgOptionsStorageClass
class	AstSpecificDataManagingClass
class	AstSpecificDataManagingClassStorageClass
class Sg_Options &	Sg_options ()
SgOptions *	isSgOptions (SgNode *s)
	Casts pointer from base class to derived class.
const SgOptions *	isSgOptions (const SgNode *s)
	Casts pointer from base class to derived class (for const pointers).
SgOptions *	SgOptions_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	SgOptions_getNumberOfValidNodesAndSetGlobalIndexInFreepointer (unsigned long)
	Get the size of the memory pool.
void	SgOptions_clearMemoryPool ()
void	SgOptions_extendMemoryPoolForFileIO (unsigned long)
void	SgOptions_getNextValidPointer (std::pair< SgOptions *, std::vector< unsigned char * >::const_iterator > &)
void	SgOptions_resetValidFreepointers ()

---

Member Typedef Documentation

typedef SgSupport SgOptions::base_node_type

Reimplemented from SgSupport.

---

Member Enumeration Documentation

anonymous enum

static variant value

Enumerator:

static_variant

---

Constructor & Destructor Documentation

SgOptions::SgOptions

(

const SgOptionsStorageClass &

source

)

SgOptions::~SgOptions

(

)

[virtual]

This is the destructor.

There is nothing to delete in this object.

SgOptions::SgOptions

(

)

This is the constructor.

This constructor builds the SgOptions base class.

See also:

Example:create an SgOptions object

---

Member Function Documentation

virtual SgNode* SgOptions::copy

(

SgCopyHelp &

help

)

const [virtual]

Reimplemented from SgSupport.

std::ostream& SgOptions::default_output

(

)

[inline]

void SgOptions::set_default_output

(

std::ostream &

os

)

[inline]

std::ostream& SgOptions::debug_output

(

)

[inline]

void SgOptions::set_debug_output

(

std::ostream &

os

)

[inline]

std::ostream& SgOptions::error_output

(

)

[inline]

void SgOptions::set_error_output

(

std::ostream &

os

)

[inline]

std::ostream& SgOptions::logging_output

(

)

[inline]

void SgOptions::set_logging_output

(

std::ostream &

os

)

[inline]

int SgOptions::debug_level

(

)

[inline]

void SgOptions::set_debug_level

(

int

l

)

[inline]

int SgOptions::logging_level

(

)

[inline]

void SgOptions::set_logging	(	std::ostream &	log_file,
		int	level
	)			[inline]

virtual std::string SgOptions::class_name

(

)

const [virtual]

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

Reimplemented from SgSupport.

virtual VariantT SgOptions::variantT

(

)

const [virtual]

returns new style SageIII enum values

Reimplemented from SgSupport.

void* SgOptions::operator new

(

size_t

size

)

returns pointer to newly allocated IR node

Reimplemented from SgSupport.

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

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

Reimplemented from SgSupport.

void SgOptions::operator delete

(

void *

pointer

)

Reimplemented from SgSupport.

static size_t SgOptions::numberOfNodes

(

)

[static]

Returns the total number of IR nodes of this type.

Reimplemented from SgSupport.

static size_t SgOptions::memoryUsage

(

)

[static]

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

Reimplemented from SgSupport.

virtual std::vector<SgNode*> SgOptions::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 SgSupport.

virtual std::vector<std::string> SgOptions::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 SgSupport.

virtual size_t SgOptions::get_numberOfTraversalSuccessors

(

)

[virtual]

Reimplemented from SgSupport.

virtual SgNode* SgOptions::get_traversalSuccessorByIndex

(

size_t

idx

)

[virtual]

Reimplemented from SgSupport.

virtual size_t SgOptions::get_childIndex

(

SgNode *

child

)

[virtual]

Reimplemented from SgSupport.

virtual RTIReturnType SgOptions::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 SgSupport.

virtual const char* SgOptions::sage_class_name

(

)

const [virtual]

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

Reimplemented from SgSupport.

void SgOptions::executeVisitorMemberFunction

(

ROSE_VisitorPattern &

visitor

)

FOR INTERNAL USE Support for visitor pattern.

Reimplemented from SgSupport.

virtual void SgOptions::accept

(

ROSE_VisitorPattern &

visitor

)

[virtual]

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

Reimplemented from SgSupport.

static void SgOptions::traverseMemoryPoolNodes

(

ROSE_VisitTraversal &

visit

)

[static]

FOR INTERNAL USE Support for visitor pattern.

Reimplemented from SgSupport.

static void SgOptions::traverseMemoryPoolVisitorPattern

(

ROSE_VisitorPattern &

visitor

)

[static]

FOR INTERNAL USE Support for visitor pattern.

Reimplemented from SgSupport.

static void SgOptions::visitRepresentativeNode

(

ROSE_VisitTraversal &

visit

)

[static]

FOR INTERNAL USE Support for type-based traversal.

Reimplemented from SgSupport.

virtual bool SgOptions::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 SgSupport.

virtual void SgOptions::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 SgSupport.

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

virtual void SgOptions::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 SgSupport.

virtual long SgOptions::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 SgSupport.

SgOptions* SgOptions::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 SgSupport.

---

Friends And Related Function Documentation

friend class AST_FILE_IO [friend]

Reimplemented from SgSupport.

friend class SgOptionsStorageClass [friend]

friend class AstSpecificDataManagingClass [friend]

Reimplemented from SgSupport.

friend class AstSpecificDataManagingClassStorageClass [friend]

Reimplemented from SgSupport.

class Sg_Options& Sg_options

(

)

[friend]

SgOptions::isSgOptions

(

SgNode *

s

)

[friend]

Casts pointer from base class to derived class.

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

Returns:

Returns valid pointer to SgOptions if input is derived from a SgLocatedNode.

SgOptions::isSgOptions

(

const SgNode *

s

)

[friend]

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

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

Returns:

Returns valid pointer to SgOptions if input is derived from a SgLocatedNode.

SgOptions* SgOptions_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 SgOptions_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 SgOptions_clearMemoryPool

(

)

[friend]

void SgOptions_extendMemoryPoolForFileIO

(

unsigned

long

)

[friend]

void SgOptions_getNextValidPointer

(

std::pair< SgOptions *, std::vector< unsigned char * >::const_iterator > &

)

[friend]

void SgOptions_resetValidFreepointers

(

)

[friend]

---

Member Data Documentation

std::ostream* SgOptions::p_default_output [protected]

std::ostream* SgOptions::p_debug_output [protected]

std::ostream* SgOptions::p_error_output [protected]

std::ostream* SgOptions::p_logging_output [protected]

int SgOptions::p_debug_level [protected]

int SgOptions::p_logging_level [protected]

---

The documentation for this class was generated from the following files:

• Cxx_Grammar.h
• SgOptions.docs

---