Puma::CSemDatabase Class Reference

#include <Puma/CSemDatabase.h>

Description

Semantic information database.

Contains all semantic objects created during the semantic analysis for one translation unit.

Public Types
typedef std::set< CObjectInfo * >	ObjectSet

Public Member Functions
	CSemDatabase (CProject &prj, int size=997)
	Constructor.
virtual	~CSemDatabase ()
	Destructor.
ObjectSet &	Objects ()
	Get the set of all semantic objects.
unsigned	ObjectInfos () const
	Get the number of semantic objects.
unsigned	ClassInfos () const
	Get the number of semantic objects for classes.
unsigned	UnionInfos () const
	Get the number of semantic objects for unions.
unsigned	EnumInfos () const
	Get the number of semantic objects for enumerations.
unsigned	TypedefInfos () const
	Get the number of semantic objects for typedefs.
unsigned	FunctionInfos () const
	Get the number of semantic objects for functions.
unsigned	FileInfos () const
	Get the number of semantic objects for translation units (file scope).
CObjectInfo *	ObjectInfo (unsigned n) const
	Get the n-th semantic object.
CClassInfo *	ClassInfo (unsigned n) const
	Get the n-th semantic object for classes.
CUnionInfo *	UnionInfo (unsigned n) const
	Get the n-th semantic object for unions.
CEnumInfo *	EnumInfo (unsigned n) const
	Get the n-th semantic object for enumerations.
CTypedefInfo *	TypedefInfo (unsigned n) const
	Get the n-th semantic object for typedefs.
CFunctionInfo *	FunctionInfo (unsigned n) const
	Get the n-th semantic object for functions.
CFileInfo *	FileInfo (unsigned n) const
	Get the n-th semantic object for translation units (file scope).
CObjectInfo *	ObjectInfo (Token *pos) const
	Get the semantic object for the entity at the given source code position (token).
CObjectInfo *	ObjectInfo (CT_Token *pos) const
	Get the semantic object for the entity at the given source code position (token).
CArgumentInfo *	newArgument ()
CAttributeInfo *	newAttribute ()
CBaseClassInfo *	newBaseClass ()
CClassInfo *	newClass ()
CClassInstance *	newClassInstance ()
CEnumInfo *	newEnum ()
CEnumeratorInfo *	newEnumerator ()
CFunctionInfo *	newFunction ()
CFctInstance *	newFctInstance ()
CLabelInfo *	newLabel ()
CLocalScope *	newLocalScope ()
CMemberAliasInfo *	newMemberAlias ()
CNamespaceInfo *	newNamespace ()
CTemplateInfo *	newTemplate ()
CTemplateParamInfo *	newTemplateParam ()
CTypedefInfo *	newTypedef ()
CUnionInfo *	newUnion ()
CUnionInstance *	newUnionInstance ()
CUsingInfo *	newUsing ()
CFileInfo *	newFile ()
void	Insert (CObjectInfo *info)
	Insert a new semantic object into the database.
void	Remove (CObjectInfo *info)
	Remove the given semantic object from the database.
CFunctionInfo *	BuiltinOperator (const char *name, int tok, CTypeInfo *rtype, CTypeInfo *t0, CTypeInfo *t1)
	Get the semantic object for the given built-in operator.
void	Dump (std::ostream &out, int depth=0, bool dump_builtins=true) const
	Dump the contents of the database.
CProject *	Project () const
	Get the project information.

Member Typedef Documentation

ObjectSet

typedef std::set<CObjectInfo*> Puma::CSemDatabase::ObjectSet

Constructor & Destructor Documentation

CSemDatabase()

Puma::CSemDatabase::CSemDatabase ( CProject & prj, int size = 997 )

inline

Constructor.

Parameters

prj	The project information.
size	Initial size of the database (not yet used!).

~CSemDatabase()

virtual Puma::CSemDatabase::~CSemDatabase ( )

virtual

Destructor.

Destroys all semantic information objects in the database.

Member Function Documentation

BuiltinOperator()

CFunctionInfo * Puma::CSemDatabase::BuiltinOperator	(	const char *	name,
		int	tok,
		CTypeInfo *	rtype,
		CTypeInfo *	t0,
		CTypeInfo *	t1 )

Get the semantic object for the given built-in operator.

Parameters

name	The operator name/symbol.
tok	The operator token type.
rtype	The result type of the operator.
t0	Type of the first operand.
t1	Type of the second operand, or NULL if only one operand.

ClassInfo()

CClassInfo * Puma::CSemDatabase::ClassInfo ( unsigned n ) const

inline

Get the n-th semantic object for classes.

Parameters

n	The index of the object.

Returns

The object or NULL if n is invalid.

ClassInfos()

unsigned Puma::CSemDatabase::ClassInfos ( ) const

inline

Get the number of semantic objects for classes.

Dump()

void Puma::CSemDatabase::Dump	(	std::ostream &	out,
		int	depth = 0,
		bool	dump_builtins = true ) const

Dump the contents of the database.

The dump is indented as tree corresponding to the nesting of the semantic objects.

Parameters

out	The output stream.
depth	The maximum indentation depth (0 means infinite).
dump_builtins	Dump or ignore builtin function, types and objects.

EnumInfo()

CEnumInfo * Puma::CSemDatabase::EnumInfo ( unsigned n ) const

inline

Get the n-th semantic object for enumerations.

Parameters

n	The index of the object.

Returns

The object or NULL if n is invalid.

EnumInfos()

unsigned Puma::CSemDatabase::EnumInfos ( ) const

inline

Get the number of semantic objects for enumerations.

FileInfo()

CFileInfo * Puma::CSemDatabase::FileInfo ( unsigned n ) const

inline

Get the n-th semantic object for translation units (file scope).

Parameters

n	The index of the object.

Returns

The object or NULL if n is invalid.

FileInfos()

unsigned Puma::CSemDatabase::FileInfos ( ) const

inline

Get the number of semantic objects for translation units (file scope).

FunctionInfo()

CFunctionInfo * Puma::CSemDatabase::FunctionInfo ( unsigned n ) const

inline

Get the n-th semantic object for functions.

Parameters

n	The index of the object.

Returns

The object or NULL if n is invalid.

FunctionInfos()

unsigned Puma::CSemDatabase::FunctionInfos ( ) const

inline

Get the number of semantic objects for functions.

Insert()

void Puma::CSemDatabase::Insert

(

CObjectInfo *

info

)

Insert a new semantic object into the database.

Parameters

info	The semantic object.

newArgument()

CArgumentInfo * Puma::CSemDatabase::newArgument

(

)

newAttribute()

CAttributeInfo * Puma::CSemDatabase::newAttribute

(

)

newBaseClass()

CBaseClassInfo * Puma::CSemDatabase::newBaseClass

(

)

newClass()

CClassInfo * Puma::CSemDatabase::newClass

(

)

newClassInstance()

CClassInstance * Puma::CSemDatabase::newClassInstance

(

)

newEnum()

CEnumInfo * Puma::CSemDatabase::newEnum

(

)

newEnumerator()

CEnumeratorInfo * Puma::CSemDatabase::newEnumerator

(

)

newFctInstance()

CFctInstance * Puma::CSemDatabase::newFctInstance

(

)

newFile()

CFileInfo * Puma::CSemDatabase::newFile

(

)

newFunction()

CFunctionInfo * Puma::CSemDatabase::newFunction

(

)

newLabel()

CLabelInfo * Puma::CSemDatabase::newLabel

(

)

newLocalScope()

CLocalScope * Puma::CSemDatabase::newLocalScope

(

)

newMemberAlias()

CMemberAliasInfo * Puma::CSemDatabase::newMemberAlias

(

)

newNamespace()

CNamespaceInfo * Puma::CSemDatabase::newNamespace

(

)

newTemplate()

CTemplateInfo * Puma::CSemDatabase::newTemplate

(

)

newTemplateParam()

CTemplateParamInfo * Puma::CSemDatabase::newTemplateParam

(

)

newTypedef()

CTypedefInfo * Puma::CSemDatabase::newTypedef

(

)

newUnion()

CUnionInfo * Puma::CSemDatabase::newUnion

(

)

newUnionInstance()

CUnionInstance * Puma::CSemDatabase::newUnionInstance

(

)

newUsing()

CUsingInfo * Puma::CSemDatabase::newUsing

(

)

ObjectInfo() [1/3]

CObjectInfo * Puma::CSemDatabase::ObjectInfo

(

CT_Token *

pos

)

const

Get the semantic object for the entity at the given source code position (token).

Parameters

pos	The token of the entity.

Returns

The semantic object or NULL.

ObjectInfo() [2/3]

CObjectInfo * Puma::CSemDatabase::ObjectInfo

(

Token *

pos

)

const

Get the semantic object for the entity at the given source code position (token).

Parameters

pos	The token of the entity.

Returns

The semantic object or NULL.

ObjectInfo() [3/3]

CObjectInfo * Puma::CSemDatabase::ObjectInfo

(

unsigned

n

)

const

Get the n-th semantic object.

Parameters

n	The index of the object.

Returns

The object or NULL if n is invalid.

ObjectInfos()

unsigned Puma::CSemDatabase::ObjectInfos ( ) const

inline

Get the number of semantic objects.

Objects()

CSemDatabase::ObjectSet & Puma::CSemDatabase::Objects ( )

inline

Get the set of all semantic objects.

Project()

CProject * Puma::CSemDatabase::Project ( ) const

inline

Get the project information.

Remove()

void Puma::CSemDatabase::Remove

(

CObjectInfo *

info

)

Remove the given semantic object from the database.

Parameters

info	The semantic object.

TypedefInfo()

CTypedefInfo * Puma::CSemDatabase::TypedefInfo ( unsigned n ) const

inline

Get the n-th semantic object for typedefs.

Parameters

n	The index of the object.

Returns

The object or NULL if n is invalid.

TypedefInfos()

unsigned Puma::CSemDatabase::TypedefInfos ( ) const

inline

Get the number of semantic objects for typedefs.

UnionInfo()

CUnionInfo * Puma::CSemDatabase::UnionInfo ( unsigned n ) const

inline

Get the n-th semantic object for unions.

Parameters

n	The index of the object.

Returns

The object or NULL if n is invalid.

UnionInfos()

unsigned Puma::CSemDatabase::UnionInfos ( ) const

inline

Get the number of semantic objects for unions.