ASTFactory Class Reference

#include <ASTFactory.hpp>

Public Types
typedef factory_type_	factory_type
typedef factory_descriptor_	factory_descriptor
typedef factory_descriptor_list_	factory_descriptor_list

Public Member Functions
	ASTFactory ()
	Make new factory. Per default (Ref)CommonAST instances are generated.
	ASTFactory (const char *factory_node_name, factory_type factory)
virtual	~ASTFactory ()
	Destroy factory.
void	registerFactory (int type, const char *ast_name, factory_type factory)
	Register a node factory for the node type type with name ast_name.
void	setMaxNodeType (int type)
	Set the maximum node (AST) type this factory may encounter.
void	addASTChild (ASTPair &currentAST, RefAST child)
	Add a child to the current AST.
virtual RefAST	create ()
	Create new empty AST node. The right default type shou.
RefAST	create (int type)
	Create AST node of the right type for 'type'.
RefAST	create (int type, const std ::string &txt)
	Create AST node of the right type for 'type' and initialize with txt.
RefAST	create (RefAST tr)
	Create duplicate of tr.
RefAST	create (RefToken tok)
	Create new AST node and initialize contents from a token.
RefAST	create (const std ::string &txt, std ::istream &infile)
	Create new AST node and initialize contents from a stream.
RefAST	dup (RefAST t)
RefAST	dupList (RefAST t)
	Duplicate tree including siblings of root.
RefAST	dupTree (RefAST t)
RefAST	make (std ::vector< RefAST > &nodes)
RefAST	make (ASTArray *nodes)
void	makeASTRoot (ASTPair &currentAST, RefAST root)
	Make an AST the root of current AST.
void	setASTNodeFactory (const char *factory_node_name, factory_type factory)

Protected Member Functions
void	loadChildren (std ::istream &infile, RefAST current)
void	loadSiblings (std ::istream &infile, RefAST current)
bool	checkCloseTag (std ::istream &infile)
RefAST	getNodeOfType (unsigned int type)
const char *	getASTNodeType (unsigned int type)
	get the name of the node 'type'
factory_type	getASTNodeFactory (unsigned int type)

Protected Attributes
factory_descriptor	default_factory_descriptor
factory_descriptor_list	nodeFactories

Private Member Functions
	ASTFactory (const ASTFactory &)
ASTFactory &	operator= (const ASTFactory &)

Detailed Description

AST Super Factory shared by TreeParser and Parser. This super factory maintains a map of all AST node types to their respective AST factories. One instance should be shared among a parser/treeparser chain.

Todo

check all this code for possible use of references in stead of RefAST's.

Member Typedef Documentation

factory_descriptor

typedef factory_descriptor_ ASTFactory::factory_descriptor

factory_descriptor_list

typedef factory_descriptor_list_ ASTFactory::factory_descriptor_list

factory_type

typedef factory_type_ ASTFactory::factory_type

Constructor & Destructor Documentation

ASTFactory() [1/3]

ASTFactory::ASTFactory

(

)

Make new factory. Per default (Ref)CommonAST instances are generated.

Initialize factory.

AST Support code shared by TreeParser and Parser. We use delegation to share code (and have only one bit of code to maintain) rather than subclassing or superclassing (forces AST support code to be loaded even when you don't want to do AST stuff).

This class collects all factories of AST types used inside the code. New AST node types are registered with the registerFactory method. On creation of an ASTFactory object a default AST node factory may be specified.

When registering types gaps between different types are filled with entries for the default factory.

ASTFactory() [2/3]

ASTFactory::ASTFactory	(	const char *	factory_node_name,
		factory_type	fact )

Initialize factory with a non default node type. factory_node_name should be the name of the AST node type the factory generates. (should exist during the existance of this ASTFactory instance)

~ASTFactory()

ASTFactory::~ASTFactory ( )

virtual

Destroy factory.

Delete ASTFactory.

ASTFactory() [3/3]

ASTFactory::ASTFactory ( const ASTFactory & )

private

Member Function Documentation

addASTChild()

void ASTFactory::addASTChild	(	ASTPair &	currentAST,
		RefAST	child )

Add a child to the current AST.

Add a child to the current AST

checkCloseTag()

bool ASTFactory::checkCloseTag ( std ::istream & infile )

protected

create() [1/6]

RefAST ASTFactory::create ( )

virtual

Create new empty AST node. The right default type shou.

Create a new empty AST node; if the user did not specify an AST node type, then create a default one: CommonAST.

create() [2/6]

RefAST ASTFactory::create	(	const std ::string &	txt,
		std ::istream &	infile )

Create new AST node and initialize contents from a stream.

create() [3/6]

RefAST ASTFactory::create

(

int

type

)

Create AST node of the right type for 'type'.

create() [4/6]

RefAST ASTFactory::create	(	int	type,
		const std ::string &	txt )

Create AST node of the right type for 'type' and initialize with txt.

create() [5/6]

RefAST ASTFactory::create

(

RefAST

tr

)

Create duplicate of tr.

Create a new empty AST node; if the user did not specify an AST node type, then create a default one: CommonAST.

create() [6/6]

RefAST ASTFactory::create

(

RefToken

tok

)

Create new AST node and initialize contents from a token.

dup()

RefAST ASTFactory::dup

(

RefAST

t

)

Deep copy a single node. This function the new clone() methods in the AST interface. Returns a new RefAST(nullASTptr) if t is null.

Deep copy a single node. This function the new clone() methods in the AST interface. Returns nullAST if t is null.

dupList()

RefAST ASTFactory::dupList

(

RefAST

t

)

Duplicate tree including siblings of root.

Duplicate tree including siblings of root.

dupTree()

RefAST ASTFactory::dupTree

(

RefAST

t

)

Duplicate a tree, assuming this is a root node of a tree– duplicate that node and what's below; ignore siblings of root node.

Duplicate a tree, assuming this is a root node of a tree duplicate that node and what's below; ignore siblings of root node.

getASTNodeFactory()

factory_type ASTFactory::getASTNodeFactory ( unsigned int type )

inlineprotected

getASTNodeType()

const char * ASTFactory::getASTNodeType ( unsigned int type )

inlineprotected

get the name of the node 'type'

getNodeOfType()

RefAST ASTFactory::getNodeOfType ( unsigned int type )

inlineprotected

loadChildren()

void ASTFactory::loadChildren ( std ::istream & infile, RefAST current )

protected

loadSiblings()

void ASTFactory::loadSiblings ( std ::istream & infile, RefAST current )

protected

make() [1/2]

RefAST ASTFactory::make

(

ASTArray *

nodes

)

Make a tree from a list of nodes, where the nodes are contained in an ASTArray object. The ASTArray is deleted after use.

Todo

FIXME! I have a feeling we can get rid of this ugly ASTArray thing

Make a tree from a list of nodes, where the nodes are contained in an ASTArray object

make() [2/2]

RefAST ASTFactory::make

(

std ::vector< RefAST > &

nodes

)

Make a tree from a list of nodes. The first element in the array is the root. If the root is null, then the tree is a simple list not a tree. Handles null children nodes correctly. For example, make(a, b, null, c) yields tree (a b c). make(null,a,b) yields tree (nil a b).

makeASTRoot()

void ASTFactory::makeASTRoot	(	ASTPair &	currentAST,
		RefAST	root )

Make an AST the root of current AST.

operator=()

ASTFactory & ASTFactory::operator= ( const ASTFactory & )

private

registerFactory()

void ASTFactory::registerFactory	(	int	type,
		const char *	ast_name,
		factory_type	factory )

Register a node factory for the node type type with name ast_name.

Register a factory for a given AST type.

setASTNodeFactory()

void ASTFactory::setASTNodeFactory	(	const char *	factory_node_name,
		factory_type	factory )

Set a new default AST type. factory_node_name should be the name of the AST node type the factory generates. (should exist during the existance of this ASTFactory instance). Only change factory between parser runs. You might get unexpected results otherwise.

setMaxNodeType()

void ASTFactory::setMaxNodeType

(

int

type

)

Set the maximum node (AST) type this factory may encounter.

Member Data Documentation

default_factory_descriptor

factory_descriptor ASTFactory::default_factory_descriptor

protected

nodeFactories

factory_descriptor_list ASTFactory::nodeFactories

protected

---

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

• antlr/ASTFactory.hpp
• src/ASTFactory.cpp