Torque Game Engine Documentation
TGE Version 1.5.2

Namespace Class Reference

#include <consoleInternal.h>

Public Member Functions

Namespace ()

void addFunction (StringTableEntry name, CodeBlock *cb, U32 functionOffset)

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 void activatePackage (StringTableEntry name)

static void deactivatePackage (StringTableEntry name)

static void dumpClasses ()

static void dumpFunctions ()

static void printNamespaceEntries (Namespace *g)

static void unlinkPackages ()

static void relinkPackages ()

static bool isPackage (StringTableEntry name)

Data Fields

StringTableEntry mName

StringTableEntry mPackage

Namespace * mParent

Namespace * mNext

AbstractClassRep * mClassRep

U32 mRefCountToParent

Entry * mEntryList

Entry ** mHashTable

U32 mHashSize

U32 mHashSequence

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

char * lastUsage

Static Public Attributes

static U32 mCacheSequence

static DataChunker mCacheAllocator

static DataChunker mAllocator

static Namespace * mNamespaceList

static Namespace * mGlobalNamespace

Private Types

enum { MaxActivePackages = 512 }

Static Private Attributes

static U32 mNumActivePackages

static U32 mOldNumActivePackages

static StringTableEntry mActivePackages [MaxActivePackages]

Data Structures

struct Entry

Member Enumeration Documentation

anonymous enum [private]

Enumerator:

MaxActivePackages

Constructor & Destructor Documentation

Namespace::Namespace ( )

Member Function Documentation

void Namespace::addFunction	(	StringTableEntry	name,
		CodeBlock *	cb,
		U32	functionOffset
	)

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

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

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

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

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

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

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

void Namespace::getEntryList ( Vector< Entry * > * )

Entry* Namespace::lookup ( StringTableEntry name )

Entry* Namespace::lookupRecursive ( StringTableEntry name )

Entry* Namespace::createLocalEntry ( StringTableEntry name )

void Namespace::buildHashTable ( )

void Namespace::clearEntries ( )

bool Namespace::classLinkTo ( Namespace * parent )

bool Namespace::unlinkClass ( Namespace * parent )

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

static void Namespace::trashCache ( ) [static]

static void Namespace::init ( ) [static]

static void Namespace::shutdown ( ) [static]

static Namespace* Namespace::global ( ) [static]

static Namespace* Namespace::find	(	StringTableEntry	name,
		StringTableEntry	package = `NULL`
	)			`[static]`

static void Namespace::activatePackage ( StringTableEntry name ) [static]

static void Namespace::deactivatePackage ( StringTableEntry name ) [static]

static void Namespace::dumpClasses ( ) [static]

static void Namespace::dumpFunctions ( ) [static]

static void Namespace::printNamespaceEntries ( Namespace * g ) [static]

static void Namespace::unlinkPackages ( ) [static]

static void Namespace::relinkPackages ( ) [static]

static bool Namespace::isPackage ( StringTableEntry name ) [static]

Field Documentation

U32 Namespace::mNumActivePackages [static, private]

U32 Namespace::mOldNumActivePackages [static, private]

StringTableEntry Namespace::mActivePackages[MaxActivePackages] [static, private]

StringTableEntry Namespace::mName

StringTableEntry Namespace::mPackage

Namespace* Namespace::mParent

Namespace* Namespace::mNext

AbstractClassRep* Namespace::mClassRep

U32 Namespace::mRefCountToParent

Entry* Namespace::mEntryList

Entry** Namespace::mHashTable

U32 Namespace::mHashSize

U32 Namespace::mHashSequence

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

char* Namespace::lastUsage

U32 Namespace::mCacheSequence [static]

DataChunker Namespace::mCacheAllocator [static]

DataChunker Namespace::mAllocator [static]

Namespace* Namespace::mNamespaceList [static]

Namespace* Namespace::mGlobalNamespace [static]