AST Class Reference

#include <AST.hpp>

Inheritance diagram for AST:

[legend]Collaboration diagram for AST:


Public Types
typedef std::auto_ptr< AST >	Node
enum	{ Type = NodeType_Generic }
Public Member Functions
	AST ()
	AST (const AST &other)
virtual	~AST ()
virtual const char *	typeName (void) const =0
	Return the type name for this AST node. (for XML output).
virtual RefAST	clone (void) const =0
	Clone this AST node.
virtual bool	equals (RefAST t) const =0
	Is node t equal to this in terms of token type and text?
virtual bool	equalsList (RefAST t) const =0
	Is t an exact structural and equals() match of this tree.
virtual bool	equalsListPartial (RefAST t) const =0
	Is 't' a subtree of this list? The siblings of the root are NOT ignored.
virtual bool	equalsTree (RefAST t) const =0
	Is tree rooted at 'this' equal to 't'? The siblings of 'this' are ignored.
virtual bool	equalsTreePartial (RefAST t) const =0
	Is 't' a subtree of the tree rooted at 'this'? The siblings of 'this' are ignored.
virtual std::vector< RefAST >	findAll (RefAST t)=0
	Walk the tree looking for all exact subtree matches.
virtual std::vector< RefAST >	findAllPartial (RefAST t)=0
	Walk the tree looking for all subtrees.
virtual void	addChild (RefAST c)=0
	Add a node to the end of the child list for this node.
virtual RefAST	getFirstChild () const =0
	Get the first child of this node; null if no children.
virtual RefAST	getNextSibling () const =0
	Get the next sibling in line after this one.
virtual std::string	getText () const =0
	Get the token text for this node.
virtual int	getType () const =0
	Get the token type for this node.
virtual void	initialize (int t, const std::string &txt)=0
	Various initialization routines.
virtual void	initialize (RefAST t)=0
virtual void	initialize (RefToken t)=0
virtual void	setFirstChild (RefAST c)=0
	Set the first child of a node.
virtual void	setNextSibling (RefAST n)=0
	Set the next sibling after this one.
virtual void	setText (const std::string &txt)=0
	Set the token text for this node.
virtual void	setType (int type)=0
	Set the token type for this node.
virtual std::string	toString () const =0
	Return this AST node as a string.
virtual std::string	toStringList () const =0
	Print out a child-sibling tree in LISP notation.
virtual std::string	toStringTree () const =0
	AST ()
virtual	~AST ()
int	nodeType () const
void	setNodeType (int nodeType)
AST *	parent ()
void	setParent (AST *parent)
void	setStartPosition (int line, int col)
void	getStartPosition (int line, int col) const
void	setEndPosition (int line, int col)
void	getEndPosition (int line, int col) const
QPtrList< AST >	children ()
void	appendChild (AST *child)
void	removeChild (AST *child)
virtual QString	text () const
void	setSlice (const Slice &slice)
void	setSlice (const QString &text, int position, int length)
void	setText (const QString &text)
Private Member Functions
	AST (RefAST other)
AST &	operator= (const AST &other)
AST &	operator= (RefAST other)
	AST (const AST &source)
void	operator= (const AST &source)
Private Attributes
ASTRef *	ref
int	m_nodeType
AST *	m_parent
int	m_startLine
int	m_startColumn
int	m_endLine
int	m_endColumn
Slice	m_slice
QPtrList< AST >	m_children
Friends
struct	ASTRef

Member Typedef Documentation

typedef std::auto_ptr<AST> AST::Node

Reimplemented in GroupAST, TemplateArgumentListAST, ClassOrNamespaceNameAST, NameAST, TypeParameterAST, DeclarationAST, AccessDeclarationAST, TypeSpecifierAST, BaseSpecifierAST, BaseClauseAST, ClassSpecifierAST, EnumeratorAST, EnumSpecifierAST, ElaboratedTypeSpecifierAST, LinkageBodyAST, LinkageSpecificationAST, NamespaceAST, NamespaceAliasAST, UsingAST, UsingDirectiveAST, DeclaratorAST, ParameterDeclarationAST, ParameterDeclarationListAST, ParameterDeclarationClauseAST, InitDeclaratorAST, InitDeclaratorListAST, TypedefAST, TemplateParameterAST, TemplateParameterListAST, TemplateDeclarationAST, SimpleDeclarationAST, StatementAST, ExpressionStatementAST, ConditionAST, IfStatementAST, WhileStatementAST, DoStatementAST, ForStatementAST, SwitchStatementAST, StatementListAST, DeclarationStatementAST, FunctionDefinitionAST, and TranslationUnitAST.
Definition at line 213 of file ast.h.

Member Enumeration Documentation

anonymous enum

Enumeration values:

Type

Definition at line 214 of file ast.h.

Constructor & Destructor Documentation

AST::AST ( ) [inline]

Definition at line 25 of file AST.hpp.
References ref.

AST::AST ( const AST & other ) [inline]

Definition at line 26 of file AST.hpp.
References ref.

AST::~AST ( ) [inline, virtual]

Definition at line 27 of file AST.hpp.

AST::AST ( RefAST other ) [private]

AST::AST ( )

virtual AST::~AST ( ) [virtual]

AST::AST ( const AST & source ) [private]

Member Function Documentation

virtual void AST::addChild ( RefAST c ) [pure virtual]

Add a node to the end of the child list for this node.

Implemented in ASTNULLType, and BaseAST.

void AST::appendChild ( AST * child )

Definition at line 189 of file ast.cpp.
References m_children.
Referenced by setParent().

QPtrList<AST> AST::children ( ) [inline]

Definition at line 235 of file ast.h.
Referenced by findNodeAt().

virtual RefAST AST::clone ( void ) const [pure virtual]

Clone this AST node.

Implemented in ASTNULLType, BaseAST, CommonAST, and CommonASTWithHiddenTokens.

virtual bool AST::equals ( RefAST t ) const [pure virtual]

Is node t equal to this in terms of token type and text?

Implemented in ASTNULLType, and BaseAST.

virtual bool AST::equalsList ( RefAST t ) const [pure virtual]

Is t an exact structural and equals() match of this tree.
The 'this' reference is considered the start of a sibling list.
Implemented in ASTNULLType, and BaseAST.

virtual bool AST::equalsListPartial ( RefAST t ) const [pure virtual]

Is 't' a subtree of this list? The siblings of the root are NOT ignored.

Implemented in ASTNULLType, and BaseAST.

virtual bool AST::equalsTree ( RefAST t ) const [pure virtual]

Is tree rooted at 'this' equal to 't'? The siblings of 'this' are ignored.

Implemented in ASTNULLType, and BaseAST.

virtual bool AST::equalsTreePartial ( RefAST t ) const [pure virtual]

Is 't' a subtree of the tree rooted at 'this'? The siblings of 'this' are ignored.

Implemented in ASTNULLType, and BaseAST.

virtual std ::vector<RefAST> AST::findAll ( RefAST t ) [pure virtual]

Walk the tree looking for all exact subtree matches.
Return a vector of RefAST that lets the caller walk the list of subtree roots found herein.
Implemented in ASTNULLType, and BaseAST.

virtual std ::vector<RefAST> AST::findAllPartial ( RefAST t ) [pure virtual]

Walk the tree looking for all subtrees.
Return a vector of RefAST that lets the caller walk the list of subtree roots found herein.
Implemented in ASTNULLType, and BaseAST.

virtual RefAST AST::getFirstChild ( ) const [pure virtual]

Get the first child of this node; null if no children.

Implemented in ASTNULLType, and BaseAST.

virtual RefAST AST::getNextSibling ( ) const [pure virtual]

Get the next sibling in line after this one.

Implemented in ASTNULLType, and BaseAST.

void AST::getStartPosition ( int * line,

int * col

) const

Definition at line 149 of file ast.cpp.
Referenced by CppCodeCompletion::completeText(), CppCodeCompletion::computeContext(), findNodeAt(), StoreWalker::findOrInsertNamespace(), ComputeRecoveryPoints::insertRecoveryPoint(), TagCreator::parseBaseClause(), TagCreator::parseClassSpecifier(), StoreWalker::parseClassSpecifier(), StoreWalker::parseDeclaration(), TagCreator::parseEnumSpecifier(), TagCreator::parseFunctionDeclaration(), StoreWalker::parseFunctionDeclaration(), TagCreator::parseFunctionDefinition(), StoreWalker::parseFunctionDefinition(), TagCreator::parseMyDeclaration(), TagCreator::parseNamespace(), TagCreator::parseTypedef(), StoreWalker::parseTypedef(), TagCreator::parseUsingDirective(), and CppSupportPart::slotNeedTextHint().

virtual std ::string AST::getText ( ) const [pure virtual]

Get the token text for this node.

Implemented in ASTNULLType, BaseAST, and CommonAST.
Referenced by BaseAST::equals().

virtual int AST::getType ( ) const [pure virtual]

Get the token type for this node.

Implemented in ASTNULLType, BaseAST, and CommonAST.
Referenced by BaseAST::equals().

virtual void AST::initialize ( RefToken t ) [pure virtual]

Implemented in ASTNULLType, CommonAST, and CommonASTWithHiddenTokens.

virtual void AST::initialize ( RefAST t ) [pure virtual]

Implemented in ASTNULLType, CommonAST, and CommonASTWithHiddenTokens.

virtual void AST::initialize ( int t,

const std::string & txt

) [pure virtual]

Various initialization routines.
Used by several factories to initialize an AST element.
Implemented in ASTNULLType, CommonAST, and CommonASTWithHiddenTokens.

int AST::nodeType ( ) const [inline]

Definition at line 222 of file ast.h.
Referenced by CppCodeCompletion::computeContext(), CppCodeCompletion::functionDefinition(), ComputeRecoveryPoints::insertRecoveryPoint(), CppSupportPart::MakeMemberHelper(), TreeParser::parseDeclaration(), TagCreator::parseDeclaration(), TreeParser::parseTypeSpecifier(), and scopeOfNode().

void AST::operator= ( const AST & source ) [private]

AST& AST::operator= ( RefAST other ) [private]

AST& AST::operator= ( const AST & other ) [private]

AST* AST::parent ( ) [inline]

Definition at line 225 of file ast.h.
Referenced by CppCodeCompletion::functionDefinition(), CppSupportPart::MakeMemberHelper(), scopeOfNode(), and CppSupportPart::slotNeedTextHint().

void AST::removeChild ( AST * child )

Definition at line 194 of file ast.cpp.
References m_children.
Referenced by setParent().

void AST::setEndPosition ( int line,

int col

)

Definition at line 158 of file ast.cpp.
References m_endColumn, and m_endLine.

virtual void AST::setFirstChild ( RefAST c ) [pure virtual]

Set the first child of a node.

Implemented in ASTNULLType, and BaseAST.

virtual void AST::setNextSibling ( RefAST n ) [pure virtual]

Set the next sibling after this one.

Implemented in ASTNULLType, and BaseAST.

void AST::setNodeType ( int nodeType ) [inline]

Definition at line 223 of file ast.h.

void AST::setParent ( AST * parent )

Definition at line 173 of file ast.cpp.
References appendChild(), m_parent, and removeChild().

void AST::setSlice ( const QString & text,

int position,

int length

) [inline]

Definition at line 246 of file ast.h.
References Slice::source.

void AST::setSlice ( const Slice & slice ) [inline]

Definition at line 243 of file ast.h.

void AST::setStartPosition ( int line,

int col

)

Definition at line 143 of file ast.cpp.
References m_startColumn, and m_startLine.

void AST::setText ( const QString & text ) [inline]

Definition at line 253 of file ast.h.
References text().

virtual void AST::setText ( const std::string & txt ) [pure virtual]

Set the token text for this node.

Implemented in ASTNULLType, BaseAST, and CommonAST.

virtual void AST::setType ( int type ) [pure virtual]

Set the token type for this node.

Implemented in ASTNULLType, BaseAST, and CommonAST.

virtual QString AST::text ( ) const [inline, virtual]

Reimplemented in GroupAST, TemplateArgumentListAST, ClassOrNamespaceNameAST, NameAST, AccessDeclarationAST, TypeSpecifierAST, ElaboratedTypeSpecifierAST, ParameterDeclarationAST, ParameterDeclarationListAST, and ParameterDeclarationClauseAST.
Definition at line 240 of file ast.h.
Referenced by TagCreator::parseBaseClause(), TagCreator::parseClassSpecifier(), StoreWalker::parseClassSpecifier(), TagCreator::parseNamespace(), StoreWalker::parseNamespace(), ComputeRecoveryPoints::parseNamespace(), and scopeOfNode().

virtual std ::string AST::toString ( ) const [pure virtual]

Return this AST node as a string.

Implemented in ASTNULLType, and BaseAST.

virtual std ::string AST::toStringList ( ) const [pure virtual]

Print out a child-sibling tree in LISP notation.

Implemented in ASTNULLType, and BaseAST.

virtual std ::string AST::toStringTree ( ) const [pure virtual]

Implemented in ASTNULLType, and BaseAST.

virtual const char* AST::typeName ( void ) const [pure virtual]

Return the type name for this AST node. (for XML output).

Implemented in ASTNULLType, BaseAST, CommonAST, CommonASTWithHiddenTokens, and UsingAST.

Friends And Related Function Documentation

friend struct ASTRef [friend]

Definition at line 131 of file AST.hpp.

Member Data Documentation

QPtrList<AST> AST::m_children [private]

Definition at line 263 of file ast.h.
Referenced by appendChild(), and removeChild().

int AST::m_endColumn [private]

Definition at line 260 of file ast.h.
Referenced by setEndPosition().

int AST::m_endLine [private]

Definition at line 260 of file ast.h.
Referenced by setEndPosition().

int AST::m_nodeType [private]

Definition at line 257 of file ast.h.

AST* AST::m_parent [private]

Definition at line 258 of file ast.h.
Referenced by setParent().

Slice AST::m_slice [private]

Definition at line 261 of file ast.h.

int AST::m_startColumn [private]

Definition at line 259 of file ast.h.
Referenced by setStartPosition().

int AST::m_startLine [private]

Definition at line 259 of file ast.h.
Referenced by setStartPosition().

ASTRef* AST::ref [private]

Definition at line 132 of file AST.hpp.
Referenced by AST(), ASTRef::ASTRef(), and ASTRef::getRef().

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

lib/antlr/antlr/AST.hpp
lib/cppparser/ast.h
lib/cppparser/ast.cpp

KDevelop API Documentation

AST Class Reference

Public Types

Public Member Functions

Private Member Functions