ssa_private::VarUniqueName Class Reference

Description

Class holding a unique name for a variable.

Is attached to varRefs as a persistant attribute. This is used to assign absolute names to VarRefExp nodes during VariableRenaming.

Definition at line 16 of file uniqueNameTraversal.h.

#include <midend/programAnalysis/staticSingleAssignment/uniqueNameTraversal.h>

Inheritance diagram for ssa_private::VarUniqueName:

Collaboration diagram for ssa_private::VarUniqueName:

Public Member Functions
	VarUniqueName ()
	Constructs the attribute with an empty key.
	VarUniqueName (SgInitializedName *thisNode)
	Constructs the attribute with value thisNode.
	VarUniqueName (const std::vector< SgInitializedName * > &prefix, SgInitializedName *thisNode)
	Constructs the attribute using the prefix vector and thisNode.
	VarUniqueName (const VarUniqueName &other)
	Copy the attribute.
VarUniqueName *	copy () const
	Virtual copy constructor.
const std::vector< SgInitializedName * > &	getKey ()
	Get a constant reference to the name.
void	setKey (const std::vector< SgInitializedName * > &newKey)
	Set the value of the name.
bool	getUsesThis ()
void	setUsesThis (bool uses)
std::string	getNameString ()
	Get the string representing this uniqueName.
Public Member Functions inherited from AstAttribute
virtual OwnershipPolicy	getOwnershipPolicy () const
	Who owns this attribute.
virtual AstAttribute *	constructor () const
	Virtual default constructor.
virtual AstAttribute *	copy ()
virtual std::string	attribute_class_name () const
	Attribute class name.
virtual std::string	toString ()
	Convert an attribute to a string.
virtual bool	commentOutNodeInGraph ()
	Eliminate IR nodes in DOT graphs.
virtual int	packed_size ()
	Packing support.
virtual char *	packed_data ()
	Packing support.
virtual void	unpacked_data (int size, char *data)
	Packing support.
virtual std::string	additionalNodeOptions ()
	DOT support.
virtual std::vector< AttributeEdgeInfo >	additionalEdgeInfo ()
	DOT support.
virtual std::vector< AttributeNodeInfo >	additionalNodeInfo ()
	DOT support.

Additional Inherited Members
Public Types inherited from AstAttribute
enum	OwnershipPolicy {   CONTAINER_OWNERSHIP ,   NO_OWNERSHIP ,   CUSTOM_OWNERSHIP ,   UNKNOWN_OWNERSHIP }
	Who owns this attribute. More...

Constructor & Destructor Documentation

VarUniqueName() [1/4]

ssa_private::VarUniqueName::VarUniqueName ( )

inline

Constructs the attribute with an empty key.

Definition at line 31 of file uniqueNameTraversal.h.

Referenced by copy().

VarUniqueName() [2/4]

ssa_private::VarUniqueName::VarUniqueName ( SgInitializedName *  thisNode )

inline

Constructs the attribute with value thisNode.

The key will consist of only the current node.

Parameters

thisNode

The node to use for the key.

Definition at line 41 of file uniqueNameTraversal.h.

VarUniqueName() [3/4]

ssa_private::VarUniqueName::VarUniqueName ( const std::vector< SgInitializedName * > &  prefix, SgInitializedName *  thisNode  )

inline

Constructs the attribute using the prefix vector and thisNode.

The key will first be copied from the prefix value, and then the thisNode value will be appended.

Parameters

prefix	The prefix of the new name.
thisNode	The node to append to the end of the new name.

Definition at line 54 of file uniqueNameTraversal.h.

VarUniqueName() [4/4]

ssa_private::VarUniqueName::VarUniqueName ( const VarUniqueName &  other )

inline

Copy the attribute.

Parameters

other

The attribute to copy from.

Definition at line 64 of file uniqueNameTraversal.h.

Member Function Documentation

copy()

VarUniqueName * ssa_private::VarUniqueName::copy ( ) const

inlinevirtual

Virtual copy constructor.

Copy-constructs a new object on the heap and returns its pointer. All subclasses must implement this in order to instantiate the correct dynamic type, although many don't. If this copy method returns a null pointer (like the base implementation) then the attribute is not copied as part of copying its container. E.g., an attribute stored in an AST will not be copied when the AST is copied if that attribute is directly derived from AstAttribute and fails to implement copy. If a subclass fails to implement copy and inherits from a class that does implement a copy that returns non-null, then the copied attribute will have an incorrect dynamic type.

It would be nice if we could make this pure virtual, but unfortunately ROSETTA-generated code fails to compile because it generates an instantiation of this interface (whether or not that code is ever executed is unkown). [Robb Matzke 2015-11-10]

Reimplemented from AstAttribute.

Definition at line 69 of file uniqueNameTraversal.h.

References VarUniqueName().

getKey()

const std::vector< SgInitializedName * > & ssa_private::VarUniqueName::getKey ( )

inline

Get a constant reference to the name.

Returns

Constant Reference to the name.

Definition at line 79 of file uniqueNameTraversal.h.

setKey()

void ssa_private::VarUniqueName::setKey ( const std::vector< SgInitializedName * > &  newKey )

inline

Set the value of the name.

Parameters

newKey

The new name to use.

Definition at line 88 of file uniqueNameTraversal.h.

getUsesThis()

bool ssa_private::VarUniqueName::getUsesThis ( )

inline

Definition at line 93 of file uniqueNameTraversal.h.

setUsesThis()

void ssa_private::VarUniqueName::setUsesThis ( bool  uses )

inline

Definition at line 98 of file uniqueNameTraversal.h.

getNameString()

std::string ssa_private::VarUniqueName::getNameString ( )

inline

Get the string representing this uniqueName.

Returns

The name string.

Definition at line 107 of file uniqueNameTraversal.h.

---

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

• uniqueNameTraversal.h