HLVM API Documentation

Documentable Class Reference

AST Documentable Node. More...

#include <Node.h>

Inheritance diagram for Documentable:

Inheritance graph
[legend]
List of all members.

Constructors

Accessors

Public Member Functions

Mutators

Protected Attributes

Data

Friends


Detailed Description

AST Documentable Node.

This class is an abstract base class in the Abstract Syntax Tree for any node type that can be documented. That is, it provides a facility for attaching a Documentation node. This is the base class of most definitions in the AST.

See also:
Documentation

Definition at line 481 of file Node.h.


Constructor & Destructor Documentation

Documentable NodeIDs  id  )  [inline, protected]
 

Definition at line 486 of file Node.h.

~Documentable  )  [virtual]
 

Definition at line 98 of file Node.cpp.


Member Function Documentation

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

Provide support for isa<X> and friends.

Reimplemented from Node.

Reimplemented in NegateOp, ComplementOp, PreIncrOp, PostIncrOp, PreDecrOp, PostDecrOp, SizeOfOp, LengthOp, ConvertOp, AddOp, SubtractOp, MultiplyOp, DivideOp, ModuloOp, BAndOp, BOrOp, BXorOp, BNorOp, Block, ResultOp, NotOp, AndOp, OrOp, NorOp, XorOp, LessThanOp, GreaterThanOp, LessEqualOp, GreaterEqualOp, EqualityOp, InequalityOp, Bundle, Import, Constant, ConstantValue, ConstantAny, ConstantBoolean, ConstantCharacter, ConstantEnumerator, ConstantInteger, ConstantReal, ConstantString, ConstantPointer, ConstantAggregate, ConstantArray, ConstantVector, ConstantStructure, ConstantContinuation, ConstantExpression, PointerType, ArrayType, VectorType, NamedType, DisparateContainerType, StructureType, ContinuationType, SignatureType, SelectOp, SwitchOp, WhileOp, UnlessOp, UntilOp, LoopOp, ReturnOp, BreakOp, ContinueOp, CallOp, OpenOp, CloseOp, ReadOp, WriteOp, Linkable, Variable, Argument, Function, Program, AllocateOp, DeallocateOp, LoadOp, StoreOp, AutoVarOp, GetOp, GetFieldOp, GetIndexOp, Value, Operator, NilaryOperator, UnaryOperator, BinaryOperator, TernaryOperator, MultiOperator, IsPInfOp, IsNInfOp, IsNanOp, TruncOp, RoundOp, FloorOp, CeilingOp, LogEOp, Log2Op, Log10Op, SquareRootOp, CubeRootOp, FactorialOp, PowerOp, RootOp, GCDOp, LCMOp, TextType, StreamType, BufferType, StrInsertOp, StrEraseOp, StrReplaceOp, StrConcatOp, Type, AnyType, BooleanType, CharacterType, StringType, IntegerType, RangeType, EnumerationType, RealType, RationalType, and OpaqueType.

Definition at line 499 of file Node.h.

References Node::isDocumentable().

static bool classof const Documentable  )  [inline, static]
 

Reimplemented in Type.

Definition at line 498 of file Node.h.

Documentation* getDoc  )  const [inline]
 

Get the name of the node.

Definition at line 495 of file Node.h.

References Documentable::doc.

void setDoc Documentation d  )  [inline]
 

Definition at line 505 of file Node.h.

References Documentable::doc.


Friends And Related Function Documentation

friend class AST [friend]
 

Reimplemented from Node.

Reimplemented in NegateOp, ComplementOp, PreIncrOp, PostIncrOp, PreDecrOp, PostDecrOp, SizeOfOp, LengthOp, ConvertOp, AddOp, SubtractOp, MultiplyOp, DivideOp, ModuloOp, BAndOp, BOrOp, BXorOp, BNorOp, Block, ResultOp, NotOp, AndOp, OrOp, NorOp, XorOp, LessThanOp, GreaterThanOp, LessEqualOp, GreaterEqualOp, EqualityOp, InequalityOp, Bundle, Import, Constant, ConstantValue, ConstantAny, ConstantBoolean, ConstantCharacter, ConstantEnumerator, ConstantInteger, ConstantReal, ConstantString, ConstantPointer, ConstantAggregate, ConstantArray, ConstantVector, ConstantStructure, ConstantContinuation, ConstantExpression, PointerType, ArrayType, VectorType, NamedType, StructureType, ContinuationType, SignatureType, SelectOp, SwitchOp, WhileOp, UnlessOp, UntilOp, LoopOp, ReturnOp, BreakOp, ContinueOp, CallOp, OpenOp, CloseOp, ReadOp, WriteOp, Linkable, Variable, Argument, Function, Program, AllocateOp, DeallocateOp, LoadOp, StoreOp, AutoVarOp, GetOp, GetFieldOp, GetIndexOp, Value, Operator, NilaryOperator, UnaryOperator, BinaryOperator, TernaryOperator, MultiOperator, IsPInfOp, IsNInfOp, IsNanOp, TruncOp, RoundOp, FloorOp, CeilingOp, LogEOp, Log2Op, Log10Op, SquareRootOp, CubeRootOp, FactorialOp, PowerOp, RootOp, GCDOp, LCMOp, RuntimeType, TextType, StreamType, BufferType, StrInsertOp, StrEraseOp, StrReplaceOp, StrConcatOp, Type, AnyType, BooleanType, CharacterType, StringType, IntegerType, RangeType, EnumerationType, RealType, RationalType, and OpaqueType.

Definition at line 513 of file Node.h.


Member Data Documentation

Documentation* doc [protected]
 

All named nodes can have documentation

Definition at line 511 of file Node.h.


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