Namespace Class Reference

#include <consoleNamespace.h>

Classes
struct	Entry

Public Member Functions
	Namespace ()
	~Namespace ()
void	addFunction (StringTableEntry name, CodeBlock *cb, U32 functionOffset, const char *usage=NULL)
void	addCommand (StringTableEntry name, StringCallback, const char *usage, S32 minArgs, S32 maxArgs)
void	addCommand (StringTableEntry name, IntCallback, const char *usage, S32 minArgs, S32 maxArgs)
void	addCommand (StringTableEntry name, FloatCallback, const char *usage, S32 minArgs, S32 maxArgs)
void	addCommand (StringTableEntry name, VoidCallback, const char *usage, S32 minArgs, S32 maxArgs)
void	addCommand (StringTableEntry name, BoolCallback, const char *usage, S32 minArgs, S32 maxArgs)
void	addOverload (const char *name, const char *altUsage)
void	markGroup (const char *name, const char *usage)
void	getEntryList (Vector< Entry * > *)
Entry *	lookup (StringTableEntry name)
Entry *	lookupRecursive (StringTableEntry name)
Entry *	createLocalEntry (StringTableEntry name)
void	buildHashTable ()
void	clearEntries ()
bool	classLinkTo (Namespace *parent)
bool	unlinkClass (Namespace *parent)
const char *	tabComplete (const char *prevText, S32 baseLen, bool fForward)

Static Public Member Functions
static void	trashCache ()
static void	init ()
static void	shutdown ()
static Namespace *	global ()
static Namespace *	find (StringTableEntry name, StringTableEntry package=NULL)
static bool	canTabComplete (const char *prevText, const char *bestMatch, const char *newText, S32 baseLen, bool fForward)
static void	activatePackage (StringTableEntry name)
static void	deactivatePackage (StringTableEntry name)
static void	dumpClasses (bool dumpScript=true, bool dumpEngine=true)
static void	dumpFunctions (bool dumpScript=true, bool dumpEngine=true)
static void	printNamespaceEntries (Namespace *g, bool dumpScript=true, bool dumpEngine=true)
static void	unlinkPackages ()
static void	relinkPackages ()
static bool	isPackage (StringTableEntry name)

Public Attributes
StringTableEntry	mName
StringTableEntry	mPackage
Namespace *	mParent
Namespace *	mNext
AbstractClassRep *	mClassRep
U32	mRefCountToParent
const char *	mUsage
bool	mCleanUpUsage
Entry *	mEntryList
Entry **	mHashTable
U32	mHashSize
U32	mHashSequence
char *	lastUsage

Static Public Attributes
static U32	mCacheSequence = 0
static DataChunker	mCacheAllocator
static DataChunker	mAllocator
static Namespace *	mNamespaceList = NULL
static Namespace *	mGlobalNamespace = NULL

Constructor & Destructor Documentation

Namespace()

Namespace

(

)

~Namespace()

~Namespace

(

)

Member Function Documentation

activatePackage()

void activatePackage ( StringTableEntry name )

static

addCommand() [1/5]

void addCommand	(	StringTableEntry	name,
		BoolCallback	cb,
		const char *	usage,
		S32	minArgs,
		S32	maxArgs )

addCommand() [2/5]

void addCommand	(	StringTableEntry	name,
		FloatCallback	cb,
		const char *	usage,
		S32	minArgs,
		S32	maxArgs )

addCommand() [3/5]

void addCommand	(	StringTableEntry	name,
		IntCallback	cb,
		const char *	usage,
		S32	minArgs,
		S32	maxArgs )

addCommand() [4/5]

void addCommand	(	StringTableEntry	name,
		StringCallback	cb,
		const char *	usage,
		S32	minArgs,
		S32	maxArgs )

addCommand() [5/5]

void addCommand	(	StringTableEntry	name,
		VoidCallback	cb,
		const char *	usage,
		S32	minArgs,
		S32	maxArgs )

addFunction()

void addFunction	(	StringTableEntry	name,
		CodeBlock *	cb,
		U32	functionOffset,
		const char *	usage = NULL )

addOverload()

void addOverload	(	const char *	name,
		const char *	altUsage )

buildHashTable()

void buildHashTable

(

)

canTabComplete()

bool canTabComplete ( const char * prevText, const char * bestMatch, const char * newText, S32 baseLen, bool fForward )

static

classLinkTo()

bool classLinkTo

(

Namespace *

parent

)

clearEntries()

void clearEntries

(

)

createLocalEntry()

Namespace::Entry * createLocalEntry

(

StringTableEntry

name

)

deactivatePackage()

void deactivatePackage ( StringTableEntry name )

static

dumpClasses()

void dumpClasses ( bool dumpScript = true, bool dumpEngine = true )

static

dumpFunctions()

void dumpFunctions ( bool dumpScript = true, bool dumpEngine = true )

static

find()

Namespace * find ( StringTableEntry name, StringTableEntry package = NULL )

static

getEntryList()

void getEntryList

(

Vector< Entry * > *

vec

)

global()

Namespace * global ( )

static

init()

void init ( )

static

isPackage()

bool isPackage ( StringTableEntry name )

static

lookup()

Namespace::Entry * lookup

(

StringTableEntry

name

)

lookupRecursive()

Namespace::Entry * lookupRecursive

(

StringTableEntry

name

)

markGroup()

void markGroup	(	const char *	name,
		const char *	usage )

printNamespaceEntries()

void printNamespaceEntries ( Namespace * g, bool dumpScript = true, bool dumpEngine = true )

static

relinkPackages()

void relinkPackages ( )

static

shutdown()

void shutdown ( )

static

tabComplete()

const char * tabComplete	(	const char *	prevText,
		S32	baseLen,
		bool	fForward )

trashCache()

void trashCache ( )

static

unlinkClass()

bool unlinkClass

(

Namespace *

parent

)

unlinkPackages()

void unlinkPackages ( )

static

Member Data Documentation

lastUsage

char* lastUsage

mAllocator

DataChunker mAllocator

static

mCacheAllocator

DataChunker mCacheAllocator

static

mCacheSequence

U32 mCacheSequence = 0

static

mClassRep

AbstractClassRep* mClassRep

mCleanUpUsage

bool mCleanUpUsage

mEntryList

Entry* mEntryList

mGlobalNamespace

Namespace * mGlobalNamespace = NULL

static

mHashSequence

U32 mHashSequence

Note

The hash sequence is used by the autodoc console facility as a means of testing reference state.

mHashSize

U32 mHashSize

mHashTable

Entry** mHashTable

mName

StringTableEntry mName

mNamespaceList

Namespace * mNamespaceList = NULL

static

mNext

Namespace* mNext

mPackage

StringTableEntry mPackage

mParent

Namespace* mParent

mRefCountToParent

U32 mRefCountToParent

mUsage

const char* mUsage

---

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

• console/consoleNamespace.h
• console/consoleDoc.cc
• console/consoleNamespace.cc