#include <taml.h>

Inheritance diagram for Taml:

Public Types
enum	TamlFormatMode { InvalidFormat = 0, XmlFormat, BinaryFormat, JSONFormat }

Public Types inherited from SimObject
enum	WriteFlags { SelectedOnly = BIT(0) }

Public Member Functions
	Taml ()

virtual	~Taml ()

virtual bool	onAdd ()
	Called when the object is added to the sim. More...

virtual void	onRemove ()
	Called when the object is removed from the sim. More...

void	setFormatMode (const TamlFormatMode formatMode)
	Format mode. More...

TamlFormatMode	getFormatMode (void) const

void	setAutoFormat (const bool autoFormat)
	Auto-Format mode. More...

bool	getAutoFormat (void) const

void	setWriteDefaults (const bool writeDefaults)
	Write defaults. More...

bool	getWriteDefaults (void) const

void	setProgenitorUpdate (const bool progenitorUpdate)
	Progenitor. More...

bool	getProgenitorUpdate (void) const

void	setAutoFormatXmlExtension (const char *pExtension)
	Auto-format extensions. More...

StringTableEntry	getAutoFormatXmlExtension (void) const

void	setAutoFormatBinaryExtension (const char *pExtension)

StringTableEntry	getAutoFormatBinaryExtension (void) const

void	setBinaryCompression (const bool compressed)
	Compression. More...

bool	getBinaryCompression (void) const

void	setJSONStrict (const bool jsonStrict)
	JSON Strict RFC4627 mode. More...

bool	getJSONStrict (void) const

TamlFormatMode	getFileAutoFormatMode (const char *pFilename)

const char *	getFilePathBuffer (void) const

bool	write (SimObject pSimObject, const char pFilename)
	Write. More...

template<typename T >
T *	read (const char *pFilename)
	Read. More...

SimObject *	read (const char *pFilename)

bool	parse (const char *pFilename, TamlVisitor &visitor)
	Parse. More...

void	tamlPreWrite (TamlCallbacks *pCallbacks)
	Taml callbacks. More...

void	tamlPostWrite (TamlCallbacks *pCallbacks)

void	tamlPreRead (TamlCallbacks *pCallbacks)

void	tamlPostRead (TamlCallbacks *pCallbacks, const TamlCustomNodes &customNodes)

void	tamlAddParent (TamlCallbacks pCallbacks, SimObject pParentObject)

void	tamlCustomWrite (TamlCallbacks *pCallbacks, TamlCustomNodes &customNodes)

void	tamlCustomRead (TamlCallbacks *pCallbacks, const TamlCustomNodes &customNodes)

	DECLARE_CONOBJECT (Taml)
	Declare Console Object. More...

Public Member Functions inherited from SimObject
StringTableEntry	getClassNamespace () const

StringTableEntry	getSuperClassNamespace () const

void	setClassNamespace (const char *classNamespace)

void	setSuperClassNamespace (const char *superClassNamespace)

void	pushScriptCallbackGuard (void)

void	popScriptCallbackGuard (void)

S32	getScriptCallbackGuard (void)

virtual SimObject *	findObject (const char *name)

Namespace *	getNamespace ()
	Return the object's namespace. More...

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

virtual void	dump ()

virtual void	dumpClassHierarchy ()

SimObject *	clone (const bool copyDynamicFields)

virtual void	copyTo (SimObject *object)

template<typename T >
bool	isType (void)

virtual bool	handlesConsoleMethod (const char fname, S32 routingId)

	DECLARE_CONOBJECT (SimObject)

Notify *	removeNotify (void *ptr, Notify::Type)
	Remove a notification from the list. More...

void	deleteNotify (SimObject *obj)
	Notify an object when we are deleted. More...

void	clearNotify (SimObject *obj)
	Notify an object when we are cleared. More...

void	clearAllNotifications ()
	Remove all notifications for this object. More...

void	processDeleteNotifies ()
	Send out deletion notifications. More...

void	registerReference (SimObject **obj)

void	unregisterReference (SimObject **obj)

const char *	getDataField (StringTableEntry slotName, const char *array)

void	setDataField (StringTableEntry slotName, const char array, const char value)

const char *	getPrefixedDataField (StringTableEntry fieldName, const char *array)

void	setPrefixedDataField (StringTableEntry fieldName, const char array, const char value)

const char *	getPrefixedDynamicDataField (StringTableEntry fieldName, const char *array, const S32 fieldType=-1)

void	setPrefixedDynamicDataField (StringTableEntry fieldName, const char array, const char value, const S32 fieldType=-1)

StringTableEntry	getDataFieldPrefix (StringTableEntry fieldName)

U32	getDataFieldType (StringTableEntry slotName, const char *array)

SimFieldDictionary *	getFieldDictionary ()

void	clearDynamicFields (void)
	Clear all dynamic fields. More...

void	setCanSaveDynamicFields (bool bCanSave)
	Set whether fields created at runtime should be saved. Default is true. More...

bool	getCanSaveDynamicFields (void) const
	Get whether fields created at runtime should be saved. Default is true. More...

void	setInternalName (const char *newname)

StringTableEntry	getInternalName ()
	Get the internal of of this control. More...

virtual bool	save (const char *pcFilePath, bool bOnlySelected=false)
	Save object as a TorqueScript File. More...

virtual bool	isMethod (const char *methodName)
	Check if a method exists in the objects current namespace. More...

SimObjectId	getId (void) const

StringTableEntry	getIdString (void) const

U32	getType () const

const StringTableEntry	getName (void) const

void	setId (SimObjectId id)

void	assignName (const char *name)

SimGroup *	getGroup () const

bool	isChildOfGroup (SimGroup *pGroup)

bool	isProperlyAdded () const

bool	isDeleted () const

bool	isRemoved () const

bool	isLocked ()

void	setLocked (bool b)

bool	isHidden ()

void	setHidden (bool b)

void	setProgenitorFile (const char *pFile)

StringTableEntry	getProgenitorFile (void) const

void	setPeriodicTimerID (const S32 timerID)

S32	getPeriodicTimerID (void) const

bool	isPeriodicTimerActive (void) const

bool	isSelected () const

bool	isExpanded () const

void	setSelected (bool sel)

void	setExpanded (bool exp)

void	setModDynamicFields (bool dyn)

void	setModStaticFields (bool sta)

	SimObject (const U8 namespaceLinkMask=LinkSuperClassName\|LinkClassName)

virtual	~SimObject ()

virtual bool	processArguments (S32 argc, const char **argv)
	Process constructor options. (ie, new SimObject(1,2,3)) More...

virtual void	onGroupAdd ()
	Called when the object is added to a SimGroup. More...

virtual void	onGroupRemove ()
	Called when the object is removed from a SimGroup. More...

virtual void	onNameChange (const char *name)
	Called when the object's name is changed. More...

virtual void	onStaticModified (const char slotName, const char newValue=NULL)

virtual void	inspectPreApply ()

virtual void	inspectPostApply ()

virtual void	onDeleteNotify (SimObject *object)

virtual void	onEditorEnable ()
	Called when the editor is activated. More...

virtual void	onEditorDisable ()
	Called when the editor is deactivated. More...

bool	registerObject ()

bool	registerObject (U32 id)

bool	registerObject (const char *name)

bool	registerObject (const char *name, U32 id)

void	unregisterObject ()

void	deleteObject ()

bool	addToSet (SimObjectId)

bool	addToSet (const char *)

bool	removeFromSet (SimObjectId)

bool	removeFromSet (const char *)

virtual bool	writeField (StringTableEntry fieldname, const char *value)

virtual void	write (Stream &stream, U32 tabStop, U32 flags=0)

virtual void	writeFields (Stream &stream, U32 tabStop)

virtual bool	writeObject (Stream *stream)

virtual bool	readObject (Stream *stream)

virtual void	buildFilterList ()

void	addFieldFilter (const char *fieldName)

void	removeFieldFilter (const char *fieldName)

void	clearFieldFilters ()

bool	isFiltered (const char *fieldName)

void	assignFieldsFrom (SimObject *obj)

void	assignDynamicFieldsFrom (SimObject *obj)

Public Member Functions inherited from ConsoleObject
const AbstractClassRep::Field *	findField (StringTableEntry fieldName) const
	Get a reference to a field by name. More...

virtual AbstractClassRep *	getClassRep () const
	Gets the ClassRep. More...

bool	setField (const char fieldName, const char value)
	Set the value of a field. More...

virtual	~ConsoleObject ()

const AbstractClassRep::FieldList &	getFieldList () const
	Get a list of all the fields. This information cannot be modified. More...

AbstractClassRep::FieldList &	getModifiableFieldList ()

bool &	getDynamicGroupExpand ()

S32	getClassId (U32 netClassGroup) const

const char *	getClassName () const

Static Public Member Functions
static void	initPersistFields ()

static SimObject *	createType (StringTableEntry typeName, const Taml pTaml, const char pProgenitorSuffix=NULL)
	Create type. More...

static bool	generateTamlSchema ()
	Schema generation. More...

static void	WriteUnrestrictedCustomTamlSchema (const char pCustomNodeName, const AbstractClassRep pClassRep, TiXmlElement *pParentElement)
	Write a unrestricted custom Taml schema. More...

static TamlFormatMode	getFormatModeEnum (const char *label)
	Get format mode info. More...

static const char *	getFormatModeDescription (const TamlFormatMode formatMode)

Static Public Member Functions inherited from SimObject
static void	initPersistFields ()

Static Public Member Functions inherited from ConsoleObject
static const char *	lookupClassName (const U32 in_classTag)
	Get the classname from a class tag. More...

static void	initPersistFields ()

static void	consoleInit ()

static ConsoleObject *	create (const char *in_pClassName)

static ConsoleObject *	create (const U32 groupId, const U32 typeId, const U32 in_classId)

static AbstractClassRep *	getStaticClassRep ()
	Get the abstract class information for this class. More...

static AbstractClassRep *	getParentStaticClassRep ()
	Get the abstract class information for this class's superclass. More...

Additional Inherited Members
Protected Types inherited from SimObject
enum	SimObjectNSLinkType { LinkClassName = BIT(0), LinkSuperClassName = BIT(1) }

Protected Member Functions inherited from SimObject
virtual void	onTamlPreWrite (void)
	Taml callbacks. More...

virtual void	onTamlPostWrite (void)
	Called after Taml has finished writing the object. More...

virtual void	onTamlPreRead (void)
	Called prior to Taml reading the object. More...

virtual void	onTamlPostRead (const TamlCustomNodes &customNodes)

virtual void	onTamlAddParent (SimObject *pParentObject)
	Called after Taml has finished reading the object and has added the object to any parent. More...

virtual void	onTamlCustomWrite (TamlCustomNodes &customNodes)
	Called during the writing of the object to allow custom properties to be written. More...

virtual void	onTamlCustomRead (const TamlCustomNodes &customNodes)
	Called during the reading of the object to allow custom properties to be read. More...

void	linkNamespaces ()

void	unlinkNamespaces ()

Static Protected Member Functions inherited from SimObject
static bool	setClass (void obj, const char data)

static bool	setSuperClass (void obj, const char data)

static bool	writeCanSaveDynamicFields (void *obj, StringTableEntry pFieldName)

static bool	writeInternalName (void *obj, StringTableEntry pFieldName)

static bool	setParentGroup (void obj, const char data)

static bool	writeParentGroup (void *obj, StringTableEntry pFieldName)

static bool	writeSuperclass (void *obj, StringTableEntry pFieldName)

static bool	writeClass (void *obj, StringTableEntry pFieldName)

static SimObject::Notify *	allocNotify ()
	Get a free Notify structure. More...

static void	freeNotify (SimObject::Notify *)
	Mark a Notify structure as free. More...

Protected Attributes inherited from SimObject
SimObjectId	mId
	Id number for this object. More...

StringTableEntry	mIdString

Namespace *	mNameSpace

U32	mTypeMask

S32	mScriptCallbackGuard
	Whether the object is executing a script callback. More...

bool	mCanSaveFieldDictionary
	true if dynamic fields (added at runtime) should be saved, defaults to true More...

StringTableEntry	mInternalName
	Stores object Internal Name. More...

StringTableEntry	mClassName
	Stores the class name to link script class namespaces. More...

StringTableEntry	mSuperClassName
	Stores super class name to link script class namespaces. More...

U8	mNSLinkMask

Static Protected Attributes inherited from SimObject
static SimObject::Notify *	mNotifyFreeList = NULL

Detailed Description

See Also: TAML Reference

Member Enumeration Documentation

enum TamlFormatMode

Enumerator
InvalidFormat
XmlFormat
BinaryFormat
JSONFormat

Constructor & Destructor Documentation

Taml ( )

virtual ~Taml ( )

inlinevirtual

Member Function Documentation

SimObject * createType	(	StringTableEntry	typeName,
		const Taml *	pTaml,
		const char *	pProgenitorSuffix = `NULL`
	)

static

Create type.

DECLARE_CONOBJECT ( Taml )

Declare Console Object.

bool generateTamlSchema ( )

static

Schema generation.

bool getAutoFormat ( void ) const

inline

StringTableEntry getAutoFormatBinaryExtension ( void ) const

inline

StringTableEntry getAutoFormatXmlExtension ( void ) const

inline

bool getBinaryCompression ( void ) const

inline

Taml::TamlFormatMode getFileAutoFormatMode ( const char * pFilename )

const char* getFilePathBuffer ( void ) const

inline

TamlFormatMode getFormatMode ( void ) const

inline

const char * getFormatModeDescription ( const TamlFormatMode formatMode )

static

Taml::TamlFormatMode getFormatModeEnum ( const char * label )

static

Get format mode info.

bool getJSONStrict ( void ) const

inline

bool getProgenitorUpdate ( void ) const

inline

bool getWriteDefaults ( void ) const

inline

void initPersistFields ( void )

static

bool onAdd ( void )

virtual

Called when the object is added to the sim.

Reimplemented from SimObject.

void onRemove ( )

virtual

Called when the object is removed from the sim.

Reimplemented from SimObject.

bool parse	(	const char *	pFilename,
		TamlVisitor &	visitor
	)

Parse.

SimObject * read ( const char * pFilename )

inline

Read.

SimObject* read ( const char * pFilename )

void setAutoFormat ( const bool autoFormat )

inline

Auto-Format mode.

void setAutoFormatBinaryExtension ( const char * pExtension )

inline

void setAutoFormatXmlExtension ( const char * pExtension )

inline

Auto-format extensions.

void setBinaryCompression ( const bool compressed )

inline

Compression.

void setFormatMode ( const TamlFormatMode formatMode )

inline

Format mode.

void setJSONStrict ( const bool jsonStrict )

inline

JSON Strict RFC4627 mode.

void setProgenitorUpdate ( const bool progenitorUpdate )

inline

Progenitor.

void setWriteDefaults ( const bool writeDefaults )

inline

Write defaults.

void tamlAddParent	(	TamlCallbacks *	pCallbacks,
		SimObject *	pParentObject
	)

inline

void tamlCustomRead	(	TamlCallbacks *	pCallbacks,
		const TamlCustomNodes &	customNodes
	)

inline

void tamlCustomWrite	(	TamlCallbacks *	pCallbacks,
		TamlCustomNodes &	customNodes
	)

inline

void tamlPostRead	(	TamlCallbacks *	pCallbacks,
		const TamlCustomNodes &	customNodes
	)

inline

void tamlPostWrite ( TamlCallbacks * pCallbacks )

inline

void tamlPreRead ( TamlCallbacks * pCallbacks )

inline

void tamlPreWrite ( TamlCallbacks * pCallbacks )

inline

Taml callbacks.

bool write	(	SimObject *	pSimObject,
		const char *	pFilename
	)

Write.

void WriteUnrestrictedCustomTamlSchema	(	const char *	pCustomNodeName,
		const AbstractClassRep *	pClassRep,
		TiXmlElement *	pParentElement
	)

static

Write a unrestricted custom Taml schema.

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

persistence/taml/taml.h
persistence/taml/taml.cc

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation