ROSE  0.11.54.0
Public Types | Public Member Functions | List of all members
AstValueAttribute< T > Class Template Reference

Description

template<class T>
class AstValueAttribute< T >

IR node attribute that stores a copyable value.

Since IR node attributes must all inherit from AstAttribute we need to write wrappers around POD types and 3rd party types when we want to store them as IR attributes. We've ended up with a proliferation of such attributes that all do almost the same thing but have different names to access their data members. Hopefully by providing one class template we can avoid further proliferation.

Definition at line 451 of file AstAttributeMechanism.h.

#include <AstAttributeMechanism.h>

Inheritance diagram for AstValueAttribute< T >:
Inheritance graph
[legend]
Collaboration diagram for AstValueAttribute< T >:
Collaboration graph
[legend]

Public Types

typedef T Value
 Type of value this wrapper holds. More...
 
- Public Types inherited from AstAttribute
enum  OwnershipPolicy {
  CONTAINER_OWNERSHIP,
  NO_OWNERSHIP,
  CUSTOM_OWNERSHIP,
  UNKNOWN_OWNERSHIP
}
 Who owns this attribute. More...
 

Public Member Functions

 AstValueAttribute ()
 Default constructor. More...
 
 AstValueAttribute (const T &value)
 Constructs an attribute containing a specified value. More...
 
 AstValueAttribute (const AstValueAttribute &other)
 Copy constructor. More...
 
virtual AstAttributecopy () const
 Virtual copy constructor. More...
 
virtual std::string attribute_class_name () const
 Attribute class name. More...
 
void set (const T &value)
 Assign a new value. More...
 
const T & get () const
 Return the stored value by reference.
 
T & get ()
 Return the stored value by reference.
 
- Public Member Functions inherited from AstAttribute
virtual OwnershipPolicy getOwnershipPolicy () const
 Who owns this attribute. More...
 
virtual AstAttributeconstructor () const
 Virtual default constructor. More...
 
virtual AstAttributecopy ()
 
virtual std::string toString ()
 Convert an attribute to a string. More...
 
virtual bool commentOutNodeInGraph ()
 Eliminate IR nodes in DOT graphs. More...
 
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< AttributeEdgeInfoadditionalEdgeInfo ()
 DOT support.
 
virtual std::vector< AttributeNodeInfoadditionalNodeInfo ()
 DOT support.
 

Member Typedef Documentation

template<class T>
typedef T AstValueAttribute< T >::Value

Type of value this wrapper holds.

Definition at line 454 of file AstAttributeMechanism.h.

Constructor & Destructor Documentation

template<class T>
AstValueAttribute< T >::AstValueAttribute ( )
inline

Default constructor.

Constructs an attribute wrapper having a default-constructed value.

Definition at line 459 of file AstAttributeMechanism.h.

template<class T>
AstValueAttribute< T >::AstValueAttribute ( const T &  value)
inlineexplicit

Constructs an attribute containing a specified value.

Definition at line 462 of file AstAttributeMechanism.h.

template<class T>
AstValueAttribute< T >::AstValueAttribute ( const AstValueAttribute< T > &  other)
inline

Copy constructor.

Invokes the copy-constructor of the contained value.

Definition at line 465 of file AstAttributeMechanism.h.

Member Function Documentation

template<class T>
virtual AstAttribute* AstValueAttribute< T >::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.

Reimplemented in AstIntAttribute, AstSgNodeListAttribute, and AstSgNodeAttribute.

Definition at line 467 of file AstAttributeMechanism.h.

template<class T>
virtual std::string AstValueAttribute< T >::attribute_class_name ( ) const
inlinevirtual

Attribute class name.

Returns the name of the dynamic type. All subclasses must implement this in order to return the correct type name, although many don't. If a subclass fails to implement this then it will return an incorrect class name.

It would be nice if this could be 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 unknown). [Robb Matzke 2015-11-10]

Reimplemented from AstAttribute.

Reimplemented in AstIntAttribute, AstSgNodeListAttribute, and AstSgNodeAttribute.

Definition at line 468 of file AstAttributeMechanism.h.

template<class T>
void AstValueAttribute< T >::set ( const T &  value)
inline

Assign a new value.

Definition at line 478 of file AstAttributeMechanism.h.


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