CXeromyces Class Reference

#include <Xeromyces.h>

Inheritance diagram for CXeromyces:

Public Member Functions
PSRETURN	Load (const PIVFS &vfs, const VfsPath &filename)
	Load from an XML file (with invisible XMB caching). More...
PSRETURN	LoadString (const char *xml)
	Load from an in-memory XML string (with no caching). More...
bool	GenerateCachedXMB (const PIVFS &vfs, const VfsPath &sourcePath, VfsPath &archiveCachePath)
	Convert the given XML file into an XMB in the archive cache. More...
Public Member Functions inherited from XMBFile
	XMBFile ()
bool	Initialise (const char *FileData)
XMBElement	GetRoot () const
int	GetElementID (const char *Name) const
int	GetAttributeID (const char *Name) const
std::string	GetElementString (const int ID) const
std::string	GetAttributeString (const int ID) const

Static Public Member Functions
static void	Startup ()
	Call once when initialising the program, to load libxml2. More...
static void	Terminate ()
	Call once when shutting down the program, to unload libxml2. More...

Private Member Functions
PSRETURN	ConvertFile (const PIVFS &vfs, const VfsPath &filename, const VfsPath &xmbPath)
bool	ReadXMBFile (const PIVFS &vfs, const VfsPath &filename)

Static Private Member Functions
static PSRETURN	CreateXMB (const xmlDocPtr doc, WriteBuffer &writeBuffer)

Private Attributes
shared_ptr< u8 >	m_XMBBuffer

Friends
class	TestXeroXMB

Detailed Description

Definition at line 42 of file Xeromyces.h.

Member Function Documentation

PSRETURN CXeromyces::ConvertFile ( const PIVFS &  vfs, const VfsPath &  filename, const VfsPath &  xmbPath  )

private

Definition at line 113 of file Xeromyces.cpp.

PSRETURN CXeromyces::CreateXMB ( const xmlDocPtr  doc, WriteBuffer &  writeBuffer  )

staticprivate

Definition at line 314 of file Xeromyces.cpp.

bool CXeromyces::GenerateCachedXMB	(	const PIVFS &	vfs,
		const VfsPath &	sourcePath,
		VfsPath &	archiveCachePath
	)

Convert the given XML file into an XMB in the archive cache.

Returns the XMB path in archiveCachePath. Returns false on error.

Definition at line 104 of file Xeromyces.cpp.

PSRETURN CXeromyces::Load	(	const PIVFS &	vfs,
		const VfsPath &	filename
	)

Load from an XML file (with invisible XMB caching).

Definition at line 65 of file Xeromyces.cpp.

PSRETURN CXeromyces::LoadString

(

const char *

xml

)

Load from an in-memory XML string (with no caching).

Definition at line 167 of file Xeromyces.cpp.

bool CXeromyces::ReadXMBFile ( const PIVFS &  vfs, const VfsPath &  filename  )

private

Definition at line 148 of file Xeromyces.cpp.

void CXeromyces::Startup ( )

static

Call once when initialising the program, to load libxml2.

This should be run in the main thread, before any thread uses libxml2.

Definition at line 49 of file Xeromyces.cpp.

void CXeromyces::Terminate ( )

static

Call once when shutting down the program, to unload libxml2.

Definition at line 57 of file Xeromyces.cpp.

Friends And Related Function Documentation

friend class TestXeroXMB

friend

Definition at line 44 of file Xeromyces.h.

Member Data Documentation

shared_ptr<u8> CXeromyces::m_XMBBuffer

private

Definition at line 81 of file Xeromyces.h.

---

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

• /home/sathyam/0ad.svn/source/ps/XML/Xeromyces.h
• /home/sathyam/0ad.svn/source/ps/XML/Xeromyces.cpp