Xrtti::ContextSet Class Reference

#include <XrttiParsed.h>

List of all members.

Public Member Functions
virtual	~ContextSet ()
virtual bool	AddHeader (const char *file, u32 includeCount, const char **pIncludes, u32 definitionCount, const char **pDefinitions, const char *tmpfile)=0
virtual const char *	GetLastError () const =0
virtual u32	GetContextCount () const =0
virtual const Context *	GetContext (u32 index) const =0
virtual const Context *	LookupContext (const char *pFullName) const =0

---

Detailed Description

************************************************************************** ContextSet is a set of all Xrtti objects which have been loaded from parsed header files. New Xrtti objects can be added by parsing new header files and the resulting set of contexts (and all associated objects) comprise the ContextSet.

---

Constructor & Destructor Documentation

virtual Xrtti::ContextSet::~ContextSet

(

)

[inline, virtual]

Destructor

---

Member Function Documentation

virtual bool Xrtti::ContextSet::AddHeader	(	const char *	file,
		u32	includeCount,
		const char **	pIncludes,
		u32	definitionCount,
		const char **	pDefinitions,
		const char *	tmpfile
	)			[pure virtual]

Adds a header file to the set; the headef file is parsed and all C++ structural information is added to the ContextSet (essentially, all Contexts defined in the header file, and all objects these reference). If the header file conflicts in any way with a previously added header file, or if it cannot be read, this returns false.

Parameters:

	file	is the header file to read and parse
	includeCount	is the number of elements in the pIncludes array parameter
	pIncludes	is an array of zero-terminated strings, each of which is a path to search for included header files when parsing the header file at [path]
	definitionCount	is the number of elements in the pDefinitions array parameter
	pDefinitions	is an array of zero-terminated strings, each of which is a preprocessor macro to define while processing the header file at [path]
	tmpfile	is a temporary file to use; defaults to gccxml.out

Returns:

true on success, false on error

virtual const char* Xrtti::ContextSet::GetLastError

(

)

const [pure virtual]

Returns a string describing the error which caused the most recent call to AddHeader() to return false.

Returns:

a string describing the error which caused the most recent call to AddHeader() to return false.

virtual u32 Xrtti::ContextSet::GetContextCount

(

)

const [pure virtual]

Returns the number of Contexts in this set.

Returns:

the number of Contexts in this set.

virtual const Context* Xrtti::ContextSet::GetContext

(

u32

index

)

const [pure virtual]

Returns a Context. The total number of available contexts is available via a call to GetContextCount().

Parameters:

index

is the index of the Context to get; this value must be less than the number of Contexts returned by GetContextCount().

Returns:

the index'th Context.

virtual const Context* Xrtti::ContextSet::LookupContext

(

const char *

pFullName

)

const [pure virtual]

Looks up a Context by full name, and returns it. Returns NULL if there is no such Context in the ContextSet.

Parameters:

pFullName

is the full name (i.e. foo::bar::baz for C++, or just the struct/union name for C) of the Context to look up and return

Returns:

the Context with the given full name, or NULL if there is no such Context

---

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

• XrttiParsed.h