HLVM API Documentation

AST Class Reference

AST Tree Root Class. More...

#include <AST.h>

Inheritance diagram for AST:

[legend]List of all members.

Accessors

• const std::string & getSystemID () const
• const std::string & getPublicID () const
• Pool * getPool () const
• static bool classof (const AST *)

  Provide support for isa<X> and friends.
  

• static bool classof (const Node *N)

  Provide support for isa<X> and friends.
  

Mutators

• void setSystemID (const std::string &id)
• void setPublicID (const std::string &id)
• void addBundle (Bundle *b)
• virtual void setParent (Node *parent)
• virtual void insertChild (Node *child)
• virtual void removeChild (Node *child)

Factories

• URI * new_URI (const std::string &uri)
• Locator * new_Locator (const URI *uri, uint32_t line=0, uint32_t col=0, uint32_t line2=0, uint32_t col2=0)
• Documentation * new_Documentation (const Locator *loc=0)
• Bundle * new_Bundle (const std::string &id, const Locator *loc=0)
• Import * new_Import (const std::string &id, const Locator *loc=0)
• Argument * new_Argument (const std::string &name, const Type *Ty, const Locator *loc=0)

  Create a new.
  

• Function * new_Function (const std::string &id, Bundle *B, const SignatureType *type, const Locator *loc=0)

  Create a new Function node.
  

• Program * new_Program (const std::string &id, Bundle *B, const Locator *loc=0)
• Type * new_IntrinsicType (const std::string &id, Bundle *bundle, IntrinsicTypes it, const Locator *loc=0)
• IntegerType * new_IntegerType (const std::string &id, Bundle *bundle, uint16_t bits=32, bool isSigned=true, const Locator *loc=0)
• RangeType * new_RangeType (const std::string &id, Bundle *bundle, int64_t min, int64_t max, const Locator *loc=0)
• EnumerationType * new_EnumerationType (const std::string &id, Bundle *bundle, const Locator *loc=0)
• RealType * new_RealType (const std::string &id, Bundle *bundle, uint32_t mantissa=52, uint32_t exponent=11, const Locator *loc=0)
• AnyType * new_AnyType (const std::string &id, Bundle *bundle, const Locator *loc=0)
• BooleanType * new_BooleanType (const std::string &id, Bundle *bundle, const Locator *loc=0)
• BufferType * new_BufferType (const std::string &id, Bundle *bundle, const Locator *loc=0)
• TextType * new_TextType (const std::string &id, Bundle *bundle, const Locator *loc=0)
• StreamType * new_StreamType (const std::string &id, Bundle *bundle, const Locator *loc=0)
• CharacterType * new_CharacterType (const std::string &id, Bundle *bundle, const std::string &enc, const Locator *loc=0)
• StringType * new_StringType (const std::string &id, Bundle *bundle, const std::string &enc, const Locator *loc=0)
• PointerType * new_PointerType (const std::string &id, Bundle *bundle, const Type *target, const Locator *loc=0)
• ArrayType * new_ArrayType (const std::string &id, Bundle *bundle, Type *elemType, uint64_t maxSize, const Locator *loc=0)
• VectorType * new_VectorType (const std::string &id, Bundle *bundle, Type *elemType, uint64_t size, const Locator *loc=0)
• NamedType * new_NamedType (const std::string &name, const Type *type, const Locator *loc=0)
• Parameter * new_Parameter (const std::string &name, const Type *type, const Locator *loc=0)
• Field * new_Field (const std::string &name, const Type *type, const Locator *loc=0)
• StructureType * new_StructureType (const std::string &id, Bundle *bundle, const Locator *loc=0)
• ContinuationType * new_ContinuationType (const std::string &id, Bundle *bundle, const Locator *loc=0)
• SignatureType * new_SignatureType (const std::string &id, Bundle *bundle, const Type *resultType, bool isVarArgs=false, const Locator *loc=0)
• OpaqueType * new_OpaqueType (const std::string &id, bool is_unresolved, Bundle *bundle, const Locator *loc=0)
• Variable * new_Variable (const std::string &id, Bundle *bundle, const Type *ty, const Locator *loc=0)
• ConstantAny * new_ConstantAny (const std::string &name, Bundle *bundle, const Type *Ty, ConstantValue *val, const Locator *loc=0)

  Createa new ConstantAny node.
  

• ConstantBoolean * new_ConstantBoolean (const std::string &name, Bundle *bundle, const Type *Ty, bool t_or_f, const Locator *loc=0)

  Createa new ConstantBoolean node.
  

• ConstantCharacter * new_ConstantCharacter (const std::string &name, Bundle *bundle, const Type *Ty, const std::string &val, const Locator *loc=0)

  Createa new ConstantCharacter node.
  

• ConstantEnumerator * new_ConstantEnumerator (const std::string &name, Bundle *bundle, const Type *Ty, const std::string &val, const Locator *loc=0)

  Createa new ConstantEnumerator node.
  

• ConstantInteger * new_ConstantInteger (const std::string &name, Bundle *bundle, const Type *Ty, const std::string &val, uint16_t base, const Locator *loc=0)

  Create a new ConstantInteger node.
  

• ConstantReal * new_ConstantReal (const std::string &name, Bundle *bundle, const Type *Ty, const std::string &val, const Locator *loc=0)

  Create a new ConstantReal node.
  

• ConstantString * new_ConstantString (const std::string &name, Bundle *bundle, const Type *Ty, const std::string &value, const Locator *loc=0)

  Create a new ConstantString node.
  

• ConstantPointer * new_ConstantPointer (const std::string &name, Bundle *bundle, const Type *type, Constant *referent, const Locator *loc=0)

  Create a new ConstantPointer node.
  

• ConstantArray * new_ConstantArray (const std::string &name, Bundle *bundle, const ArrayType *Ty, const std::vector< ConstantValue * > &elems, const Locator *loc=0)

  Create a new ConstantArray node.
  

• ConstantVector * new_ConstantVector (const std::string &name, Bundle *bundle, const VectorType *Ty, const std::vector< ConstantValue * > &elems, const Locator *loc=0)

  Create a new ConstantVector node.
  

• ConstantStructure * new_ConstantStructure (const std::string &name, Bundle *bundle, const StructureType *Ty, const std::vector< ConstantValue * > &elems, const Locator *loc=0)

  Create a new ConstantStructure node.
  

• ConstantContinuation * new_ConstantContinuation (const std::string &name, Bundle *bundle, const ContinuationType *Ty, const std::vector< ConstantValue * > &elems, const Locator *loc=0)

  Create a new ConstantContinuation node.
  

• Constant * new_UnaryCE (NodeIDs id, Constant *C, const Locator *loc=0)

  Create a unary ConstantExpression Node.
  

• Constant * new_BinaryCE (NodeIDs id, Constant *C1, Constant *C2, const Locator *loc=0)

  Create a binary ConstantExpression Node.
  

• Block * new_Block (const Locator *loc)
• AutoVarOp * new_AutoVarOp (const std::string &name, const Type *Ty, const Locator *loc)
• GetOp * new_GetOp (const Value *V, const Locator *loc=0)

  Create a new GetOp.
  

• GetFieldOp * new_GetFieldOp (Operator *op, const std::string &nm, const Locator *loc=0)
• GetIndexOp * new_GetIndexOp (Operator *op1, Operator *op2, const Locator *loc=0)
• ConvertOp * new_ConvertOp (Operator *oprnd, const Type *Ty, const Locator *loc)

  Create a new ConvertOp.
  

• template<class OpClass> OpClass * new_NilaryOp (Bundle *bundle, const Locator *loc=0)

  Provide a template function for creating standard nilary operators.
  

• template<class OpClass> OpClass * new_UnaryOp (Operator *oprnd1, Bundle *bundle, const Locator *loc=0)

  Provide a template function for creating standard unary operators.
  

• template<class OpClass> OpClass * new_BinaryOp (Operator *oprnd1, Operator *oprnd2, Bundle *bundle, const Locator *loc=0)

  Provide a template function for creating a binary operator.
  

• template<class OpClass> OpClass * new_TernaryOp (Operator *oprnd1, Operator *oprnd2, Operator *oprnd3, Bundle *bundle, const Locator *loc=0)

  Provide a template function for creating standard ternary operators.
  

• template<class OpClass> OpClass * new_MultiOp (const std::vector< Operator * > &o, Bundle *bundle, const Locator *loc=0)
• void old (Node *to_be_deleted)
• template<class OpClass> OpClass * new_NilaryOp (const Type *Ty, const Locator *loc=0)
• template<class OpClass> OpClass * new_UnaryOp (const Type *Ty, Operator *oprnd1, const Locator *loc=0)

  Provide a template function for creating a unary operator.
  

• template<class OpClass> OpClass * new_BinaryOp (const Type *Ty, Operator *oprnd1, Operator *oprnd2, const Locator *loc=0)

  Provide a template function for creating a binary operator.
  

• template<class OpClass> OpClass * new_TernaryOp (const Type *Ty, Operator *oprnd1, Operator *oprnd2, Operator *oprnd3, const Locator *loc=0)

  Provide a template function for creating a ternary operator.
  

• template<class OpClass> OpClass * new_MultiOp (const Type *Ty, const std::vector< Operator * > &o, const Locator *loc=0)

Constructors

• static AST * create ()
• static void destroy (AST *ast)
• AST ()
• ~AST ()

Public Types

Types

• typedef std::vector< Bundle * > BundleList
• typedef BundleList::iterator iterator
• typedef BundleList::const_iterator const_iterator

Public Member Functions

Iterators

• iterator begin ()

  Bundle Iteration.
  

• const_iterator begin () const
• iterator end ()
• const_iterator end () const
• size_t size () const
• bool empty () const
• Bundle * front ()
• const Bundle * front () const
• Bundle * back ()
• const Bundle * back () const

Protected Attributes

Data

• std::string sysid
• std::string pubid
• BundleList bundles
• Pool * pool

---

Detailed Description

AST Tree Root Class.

This class is used to hold or contain an Abstract Syntax Tree. It forms the root node of a multi-way tree of other nodes. As such, its parent node is null and this is only true of the AST node. AST provides a number of facilities for management of the tree as a whole. It also provides all the factory functions for creating AST nodes.

Definition at line 70 of file AST.h.

---

Member Typedef Documentation

typedef std::vector<Bundle*> BundleList

Definition at line 75 of file AST.h.

typedef BundleList::const_iterator const_iterator

Definition at line 77 of file AST.h.

typedef BundleList::iterator iterator

Definition at line 76 of file AST.h.

---

Constructor & Destructor Documentation

AST (   )  [protected]

Definition at line 55 of file AST.cpp. References Pool::create(), and AST::pool.

~AST (   )  [protected]

Definition at line 61 of file AST.cpp.

---

Member Function Documentation

void addBundle (  Bundle *  b  )  [inline]

Definition at line 108 of file AST.h. References AST::bundles.

const Bundle* back (   )  const [inline]

Definition at line 128 of file AST.h. References AST::bundles.

Bundle* back (   )  [inline]

Definition at line 127 of file AST.h. References AST::bundles.

const_iterator begin (   )  const [inline]

Definition at line 120 of file AST.h. References AST::bundles.

iterator begin (   )  [inline]

Bundle Iteration. Definition at line 119 of file AST.h. References AST::bundles.

static bool classof (  const Node *  N  )  [inline, static]

Provide support for isa<X> and friends. Reimplemented from Node. Definition at line 99 of file AST.h. References Node::is(), and hlvm::TreeTopID.

static bool classof (  const AST *   )  [inline, static]

Provide support for isa<X> and friends. Definition at line 98 of file AST.h.

AST * create (   )  [static]

Definition at line 90 of file AST.cpp. References AST::AST().

void destroy (  AST *  ast  )  [static]

Definition at line 96 of file AST.cpp. References ast.

bool empty (   )  const [inline]

Definition at line 124 of file AST.h. References AST::bundles.

const_iterator end (   )  const [inline]

Definition at line 122 of file AST.h. References AST::bundles.

iterator end (   )  [inline]

Definition at line 121 of file AST.h. References AST::bundles.

const Bundle* front (   )  const [inline]

Definition at line 126 of file AST.h. References AST::bundles.

Bundle* front (   )  [inline]

Definition at line 125 of file AST.h. References AST::bundles.

Pool* getPool (   )  const [inline]

Definition at line 96 of file AST.h. References AST::pool.

const std::string& getPublicID (   )  const [inline]

Definition at line 95 of file AST.h. References AST::pubid.

const std::string& getSystemID (   )  const [inline]

Definition at line 94 of file AST.h. References AST::sysid.

void insertChild (  Node *  child  )  [protected, virtual]

Reimplemented from Node. Definition at line 66 of file AST.cpp. References AST::begin(), AST::bundles, AST::end(), and hlvmAssert.

AnyType * new_AnyType (  const std::string &  id, Bundle *  bundle, const Locator *  loc = 0 )

Create a new AnyType node. An AnyType node is a type that can hold a value of any other HLVM type. Parameters: id  The name of the type bundle  The bundle to insert the type into loc  The source locator Definition at line 213 of file AST.cpp. References bundle, Node::loc, Node::setLocator(), Type::setName(), and Node::setParent().

Argument * new_Argument (  const std::string &  name, const Type *  Ty, const Locator *  loc = 0 )

Create a new. Parameters: Ty  The argument name loc  The type of the argument The source locator Definition at line 675 of file AST.cpp. References Node::loc, Node::setLocator(), Argument::setName(), and Value::setType().

ArrayType * new_ArrayType (  const std::string &  id, Bundle *  bundle, Type *  elemType, uint64_t  maxSize, const Locator *  loc = 0 )

Create a new ArrayType node. An ArrayType is a sequential arrangement of memory locations of uniform type. Arrays can be dynamically expanded or shrunk, but not beyond the maxSize parameter. Parameters: id  The name of the array type bundle  The bundle to insert the type into elemType  The element type maxSize  The maximum number of elements in the array loc  The source locator Definition at line 321 of file AST.cpp. References bundle, Node::loc, UniformContainerType::setElementType(), Node::setLocator(), ArrayType::setMaxSize(), Type::setName(), and Node::setParent().

AutoVarOp * new_AutoVarOp (  const std::string &  name, const Type *  Ty, const Locator *  loc )

Create a new AutoVarOp. This one is a little unusual because it requires the user to know the type. Other operators can deduce the type from the operands. Parameters: name  Name of the autovar in its scope Ty  Type of the autovar loc  The source locator Definition at line 741 of file AST.cpp. References hlvmAssert, Node::loc, Node::setLocator(), AutoVarOp::setName(), and Value::setType().

Constant* new_BinaryCE (  NodeIDs  id, Constant *  C1, Constant *  C2, const Locator *  loc = 0 )

Create a binary ConstantExpression Node. Parameters: id  The operator for the constant expression C1  The first operand of the binary operator C2  The second operand of the binary operator loc  The source locator

template WriteOp * new_BinaryOp< WriteOp > (  const Type *  Ty, Operator *  oprnd1, Operator *  oprnd2, const Locator *  loc = 0 )  [protected]

Provide a template function for creating a binary operator. Parameters: Ty  Result type of the operator oprnd1  The first operand oprnd2  The second operand loc  The source locator Definition at line 862 of file AST.cpp. References hlvmAssert, and Node::loc.

WriteOp * new_BinaryOp< WriteOp > (  Operator *  oprnd1, Operator *  oprnd2, Bundle *  bundle, const Locator *  loc = 0 )

Provide a template function for creating a binary operator. Parameters: oprnd1  The first operand oprnd2  The second operand bundle  The bundle, for type lookup loc  The source locator Definition at line 881 of file AST.cpp. References Value::getType(), and Node::loc.

Block * new_Block (  const Locator *  loc  )

Create a new Block. You can also create Blocks with new_MulitOp<Block> interface. This one allows you to create the block before creating its content, for situations where that matters (like XML parsing). Parameters: loc  The source locator Definition at line 733 of file AST.cpp. References Node::loc, and Node::setLocator().

BooleanType * new_BooleanType (  const std::string &  id, Bundle *  bundle, const Locator *  loc = 0 )

Create a new BooleanType node. A BooleanType has a simple binary value, true or false. Parameters: id  The name of the type bundle  The bundle to insert the type into loc  The source locator Definition at line 240 of file AST.cpp. References bundle, Node::loc, Node::setLocator(), Type::setName(), and Node::setParent().

BufferType * new_BufferType (  const std::string &  id, Bundle *  bundle, const Locator *  loc = 0 )

Create a new BufferType node. A BufferType is a runtime type that is used to buffer input and output. Parameters: id  The name of the type bundle  The bundle to insert the type into loc  The source locator Definition at line 253 of file AST.cpp. References bundle, Node::loc, Node::setLocator(), Type::setName(), and Node::setParent().

Bundle * new_Bundle (  const std::string &  id, const Locator *  loc = 0 )

Create a new Bundle node. A bundle is the general container of other AST nodes. Bundles are also the unit of loading and linking. Parameters: id  The name of the bundle loc  The source locator Definition at line 136 of file AST.cpp. References Node::loc, Node::setLocator(), Bundle::setName(), and Node::setParent().

CharacterType * new_CharacterType (  const std::string &  id, Bundle *  bundle, const std::string &  enc, const Locator *  loc = 0 )

Create a new CharacterType node. A CharacterType represents a single textual character in UTF-16 encoding. Parameters: id  The name of the type bundle  The bundle to insert the type into enc  The name of the encoding for the character loc  The source locator Definition at line 292 of file AST.cpp. References bundle, Node::loc, Node::setLocator(), Type::setName(), and Node::setParent().

ConstantAny * new_ConstantAny (  const std::string &  name, Bundle *  bundle, const Type *  Ty, ConstantValue *  val, const Locator *  loc = 0 )

Createa new ConstantAny node. Parameters: name  The name of the constant bundle  The bundle to insert the type into Ty  The type for this constant val  The value for the constant loc  The source locator Definition at line 429 of file AST.cpp. References bundle, Node::loc, Node::setLocator(), Constant::setName(), Node::setParent(), and Value::setType().

ConstantArray * new_ConstantArray (  const std::string &  name, Bundle *  bundle, const ArrayType *  Ty, const std::vector< ConstantValue * > &  elems, const Locator *  loc = 0 )

Create a new ConstantArray node. Parameters: name  The name of the constant bundle  The bundle to insert the type into Ty  The type of the array elems  The elements of the array loc  The source locator Definition at line 564 of file AST.cpp. References ConstantAggregate::addConstant(), Node::loc, Node::setLocator(), and Constant::setName().

ConstantBoolean * new_ConstantBoolean (  const std::string &  name, Bundle *  bundle, const Type *  Ty, bool  t_or_f, const Locator *  loc = 0 )

Createa new ConstantBoolean node. Parameters: name  The name of the constant bundle  The bundle to insert the type into Ty  The type for this constant t_or_f  The value for the constant loc  The source locator Definition at line 445 of file AST.cpp. References bundle, Node::loc, Node::setLocator(), Constant::setName(), Node::setParent(), and Value::setType().

ConstantCharacter * new_ConstantCharacter (  const std::string &  name, Bundle *  bundle, const Type *  Ty, const std::string &  val, const Locator *  loc = 0 )

Createa new ConstantCharacter node. Parameters: name  The name of the constant bundle  The bundle to insert the type into Ty  The type for this constant val  The value for the constant loc  The source locator Definition at line 461 of file AST.cpp. References bundle, Node::loc, Node::setLocator(), Constant::setName(), Node::setParent(), and Value::setType().

ConstantContinuation * new_ConstantContinuation (  const std::string &  name, Bundle *  bundle, const ContinuationType *  Ty, const std::vector< ConstantValue * > &  elems, const Locator *  loc = 0 )

Create a new ConstantContinuation node. Parameters: name  The name of the constant bundle  The bundle to insert the type into Ty  The type of the array elems  The elements of the array loc  The source locator Definition at line 634 of file AST.cpp. References ConstantAggregate::addConstant(), DisparateContainerType::begin(), DisparateContainerType::end(), hlvmAssert, Node::loc, Node::setLocator(), Constant::setName(), and DisparateContainerType::size().

ConstantEnumerator * new_ConstantEnumerator (  const std::string &  name, Bundle *  bundle, const Type *  Ty, const std::string &  val, const Locator *  loc = 0 )

Createa new ConstantEnumerator node. Parameters: name  The name of the constant bundle  The bundle to insert the type into Ty  The type for this constant val  The value for the constant loc  The source locator Definition at line 477 of file AST.cpp. References bundle, Node::loc, Node::setLocator(), Constant::setName(), Node::setParent(), and Value::setType().

ConstantInteger * new_ConstantInteger (  const std::string &  name, Bundle *  bundle, const Type *  Ty, const std::string &  val, uint16_t  base, const Locator *  loc = 0 )

Create a new ConstantInteger node. Parameters: name  The name of the constant bundle  The bundle to insert the type into Ty  The type for this constant val  The value of the ConstantInteger base  The numeric base the value is encoded in loc  The source locator Definition at line 494 of file AST.cpp. References bundle, Node::loc, ConstantInteger::setBase(), Node::setLocator(), Constant::setName(), Node::setParent(), Value::setType(), and ConstantInteger::setValue().

ConstantPointer * new_ConstantPointer (  const std::string &  name, Bundle *  bundle, const Type *  type, Constant *  referent, const Locator *  loc = 0 )