tXmlParserNamespace::tXmlParser Class Reference

TODO: add documentation, this is just here so tXmlParser::node gets documented. More...

#include <tXmlParser.h>

Inheritance diagram for tXmlParserNamespace::tXmlParser:

[legend]

Collaboration diagram for tXmlParserNamespace::tXmlParser:

[legend]

List of all members.

Public Member Functions
node	GetRoot ()
	tXmlParser ()
virtual	~tXmlParser ()
	tXmlParser (int mode)
void	SetMode (int mode)
virtual bool	LoadFile (const char *filename, const char *uri="")
bool	LoadXmlFile (const char *filename, const char *uri="")
bool	LoadWithoutParsing (const char *filename, const char *uri="")
bool	LoadWithParsing (const char *filename, const char *uri="")
bool	Parse ()
virtual bool	ParseDom ()
bool	ParseSax ()
virtual void	startElement (tString &element, tAttributeList &attributes)
virtual void	endElement (tString &element)
virtual void	startDocument ()
virtual void	endDocument ()
void	cb_startDocument ()
void	cb_endDocument ()
void	cb_startElement (const xmlChar *name, const xmlChar **attrs)
void	cb_endElement (const xmlChar *name)
Public Attributes
xmlDocPtr	m_Doc
tString	m_Filename
Protected Member Functions
virtual bool	ValidateXml (FILE *docfd, const char *uri=NULL, const char *filepath=NULL)
Private Attributes
int	m_Mode
Classes
class	node
	DOM node class; provides convienient access to libxml without dealing with its functions. More...

---

Detailed Description

TODO: add documentation, this is just here so tXmlParser::node gets documented.

Definition at line 52 of file tXmlParser.h.

---

Constructor & Destructor Documentation

tXmlParserNamespace::tXmlParser::tXmlParser

(

)

[inline]

Definition at line 93 of file tXmlParser.h.

References tXmlParserNamespace::DOM, and SetMode().

: m_Doc(0) { SetMode(DOM); };

Here is the call graph for this function:

tXmlParserNamespace::tXmlParser::~tXmlParser

(

)

[virtual]

Definition at line 242 of file tXmlParser.cpp.

References m_Doc.

                        {
    if (m_Doc)
    {
        xmlFreeDoc(m_Doc);
        m_Doc=0;
    }
}

tXmlParserNamespace::tXmlParser::tXmlParser

(

int

mode

)

[inline]

Definition at line 97 of file tXmlParser.h.

References m_Doc, and SetMode().

{ SetMode(mode); m_Doc = 0; };

Here is the call graph for this function:

---

Member Function Documentation

tXmlParser::node tXmlParserNamespace::tXmlParser::GetRoot

(

)

Definition at line 508 of file tXmlParser.cpp.

References m_Doc.

Referenced by tXmlParserNamespace::tXmlResource::GetFileContents(), and tXmlParserNamespace::tXmlResource::ValidateXml().

                                   {
    return node(xmlDocGetRootElement(m_Doc));
}

Here is the caller graph for this function:

void tXmlParserNamespace::tXmlParser::SetMode

(

int

mode

)

[inline]

Definition at line 99 of file tXmlParser.h.

References m_Mode.

Referenced by tXmlParser().

{ m_Mode = mode; };

Here is the caller graph for this function:

bool tXmlParserNamespace::tXmlParser::LoadFile	(	const char *	filename,
		const char *	uri = ""
	)			[virtual]

Reimplemented in tXmlParserNamespace::tXmlResource.

Definition at line 299 of file tXmlParser.cpp.

References LoadXmlFile().

                                                               {
    return LoadXmlFile(filename, uri);
}

Here is the call graph for this function:

bool tXmlParserNamespace::tXmlParser::LoadXmlFile	(	const char *	filename,
		const char *	uri = ""
	)

Definition at line 303 of file tXmlParser.cpp.

References Parse(), and ValidateXml().

Referenced by LoadFile(), and tXmlParserNamespace::tXmlResource::LoadFile().

                                                                  {
    bool goOn;

    FILE* docfd;

    docfd = fopen(filename, "r");

    goOn = ValidateXml(docfd, uri, filename);

    if(goOn) {
        return Parse();
    } else {
        return false;
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

bool tXmlParserNamespace::tXmlParser::LoadWithoutParsing	(	const char *	filename,
		const char *	uri = ""
	)

Definition at line 259 of file tXmlParser.cpp.

References tResourceManager::locateResource(), m_Filename, tResourceManager::openResource(), and ValidateXml().

                                                                         {
    bool success=false;
    FILE* docfd;

    docfd = tResourceManager::openResource(filename, uri);
    m_Filename = tResourceManager::locateResource(filename, uri);

    if ( docfd )
    {
        success = ValidateXml(docfd, uri, filename);
        fclose(docfd);
    }

    return success;
}

Here is the call graph for this function:

bool tXmlParserNamespace::tXmlParser::LoadWithParsing	(	const char *	filename,
		const char *	uri = ""
	)

Definition at line 275 of file tXmlParser.cpp.

References con, tResourceManager::locateResource(), m_Filename, tResourceManager::openResource(), Parse(), and ValidateXml().

                                                                      {
    bool success=false;
    FILE* docfd;

    if(!(docfd = tResourceManager::openResource(filename, uri))) {
        con << "Loading XML file '" << filename << "' failed!\n";
        return false;
    }
    m_Filename = tResourceManager::locateResource(filename, uri);

    success = ValidateXml(docfd, uri, filename);
    fclose(docfd);
    if(success) {
        return Parse();
    } else {
        return false;
    }
}

Here is the call graph for this function:

bool tXmlParserNamespace::tXmlParser::Parse

(

)

Definition at line 319 of file tXmlParser.cpp.

References tXmlParserNamespace::DOM, m_Mode, ParseDom(), and ParseSax().

Referenced by LoadWithParsing(), and LoadXmlFile().

                       {
    if(m_Mode == DOM) {
        return ParseDom();
    } else {
        return ParseSax();
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

bool tXmlParserNamespace::tXmlParser::ParseDom

(

)

[virtual]

Definition at line 328 of file tXmlParser.cpp.

Referenced by Parse().

                          {
    return true;
}

Here is the caller graph for this function:

bool tXmlParserNamespace::tXmlParser::ParseSax

(

)

Definition at line 332 of file tXmlParser.cpp.

References tXmlParserNamespace::aaSaxCallsback, and m_Filename.

Referenced by Parse().

                          {
    if (xmlSAXUserParseFile(&aaSaxCallsback, this, m_Filename) < 0) {
        return false;
    } else
        return true;
}

Here is the caller graph for this function:

void tXmlParserNamespace::tXmlParser::startElement	(	tString &	element,
		tAttributeList &	attributes
	)			[virtual]

Definition at line 238 of file tXmlParser.cpp.

Referenced by cb_startElement().

                                                                          {
    // Do nothing
}

Here is the caller graph for this function:

void tXmlParserNamespace::tXmlParser::endElement

(

tString &

element

)

[virtual]

Definition at line 255 of file tXmlParser.cpp.

Referenced by cb_endElement().

                                            {
    // Do nothing
}

Here is the caller graph for this function:

void tXmlParserNamespace::tXmlParser::startDocument

(

)

[virtual]

Definition at line 206 of file tXmlParser.cpp.

Referenced by cb_startDocument().

                               {
    // Do nothing
}

Here is the caller graph for this function:

void tXmlParserNamespace::tXmlParser::endDocument

(

)

[virtual]

Definition at line 214 of file tXmlParser.cpp.

Referenced by cb_endDocument().

                             {
    // Do nothing
}

Here is the caller graph for this function:

void tXmlParserNamespace::tXmlParser::cb_startDocument

(

)

Definition at line 202 of file tXmlParser.cpp.

References startDocument().

Referenced by tXmlParserNamespace::cb_startDocument().

                                  {
    startDocument();
}

Here is the call graph for this function:

Here is the caller graph for this function:

void tXmlParserNamespace::tXmlParser::cb_endDocument

(

)

Definition at line 210 of file tXmlParser.cpp.

References endDocument().

Referenced by tXmlParserNamespace::cb_endDocument().

                                {
    endDocument();
}

Here is the call graph for this function:

Here is the caller graph for this function:

void tXmlParserNamespace::tXmlParser::cb_startElement	(	const xmlChar *	name,
		const xmlChar **	attrs
	)

Definition at line 218 of file tXmlParser.cpp.

References NULL, and startElement().

Referenced by tXmlParserNamespace::cb_startElement().

                                                                           {
    tAttributeList attributes;
    if (attrs != NULL) {
        for (int i = 0; (attrs[i] != NULL); i++) {
            tString attributeName( (const char*) attrs[i] );
            tString attributeValue;
            i++;

            if (attrs[i] != NULL) {
                attributeValue = tString( (const char*)attrs[i] );
            } else {
                attributeValue = tString();
            }
            attributes[attributeName] = attributeValue;
        }
        tString elementName((const char*)name);
        startElement(elementName, attributes );
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

void tXmlParserNamespace::tXmlParser::cb_endElement

(

const xmlChar *

name

)

Definition at line 250 of file tXmlParser.cpp.

References endElement().

Referenced by tXmlParserNamespace::cb_endElement().

                                                  {
    tString elementName((const char*)name);
    endElement(elementName);
}

Here is the call graph for this function:

Here is the caller graph for this function:

bool tXmlParserNamespace::tXmlParser::ValidateXml	(	FILE *	docfd,
		const char *	uri = NULL,
		const char *	filepath = NULL
	)			[protected, virtual]

Reimplemented in tXmlParserNamespace::tXmlResource.

Definition at line 381 of file tXmlParser.cpp.

References m_Doc, tXmlParserNamespace::myxmlInputReadFILE(), tXmlParserNamespace::myxmlParserInputBufferCreateFilenameFunc(), NULL, tDirectories::Resource(), tXmlParserNamespace::st_ErrorFunc(), and tXmlParserNamespace::st_errorLeadIn.

Referenced by LoadWithoutParsing(), LoadWithParsing(), LoadXmlFile(), and tXmlParserNamespace::tXmlResource::ValidateXml().

{
#ifndef DEDICATED
    /* register error handler */
    xmlGenericErrorFunc errorFunc = &st_ErrorFunc;
    initGenericErrorDefaultFunc( &errorFunc );
    st_errorLeadIn = "XML validation error in ";
    st_errorLeadIn += filepath;
    st_errorLeadIn += ":\n\n";
#endif

    bool validated = false;

    if (docfd == NULL) {
        printf("LoadAndValidateMapXML passed a NULL docfd (we should really trap this somewhere else!)\n");
        return false;
    }

#ifndef HAVE_LIBXML2_WO_PIBCREATE
    //xmlSetExternalEntityLoader(myxmlResourceEntityLoader);
    xmlParserInputBufferCreateFilenameDefault(myxmlParserInputBufferCreateFilenameFunc);    //should be moved to some program init area
#endif

    if (m_Doc)
    {
        xmlFreeDoc(m_Doc);
        m_Doc=0;
    }

    /*Validate the xml*/
    xmlParserCtxtPtr ctxt; /*Parser context*/

    ctxt = xmlNewParserCtxt();

    if (ctxt == 0) {
        fprintf(stderr, "Failed to allocate parser context\n");
        return false;
    }

    /* parse the file, activating the DTD validation option */
    m_Doc = xmlCtxtReadIO(ctxt, myxmlInputReadFILE, 0, docfd,
#if HAVE_LIBXML2_WO_PIBCREATE
                          (const char *)tDirectories::Resource().GetReadPath("map-0.1.dtd")
                          // TODO: don't hardcode the file
#else
                          uri
#endif
                          , NULL, XML_PARSE_DTDVALID);
    // NOTE: Do *not* pass myxmlInputCloseFILE; we close the file *later*

    /* check if parsing suceeded */
    if (m_Doc == NULL) {
        fprintf(stderr, "Failed to parse \n");
    } else {
        /* check if validation suceeded */
        if (ctxt->valid == 0) {
            fprintf(stderr, "Failed to validate \n");
            xmlFreeDoc(m_Doc);
            m_Doc=NULL;
        }
        else
        {
            validated = true;
        }
    }

    /* free up the parser context */
    xmlFreeParserCtxt(ctxt);

#ifndef DEDICATED
    /* reset error handler */
    initGenericErrorDefaultFunc( NULL );
#endif
    return validated;
}

Here is the call graph for this function:

Here is the caller graph for this function:

---

Member Data Documentation

xmlDocPtr tXmlParserNamespace::tXmlParser::m_Doc

Definition at line 90 of file tXmlParser.h.

Referenced by GetRoot(), tXmlParser(), ValidateXml(), and ~tXmlParser().

tString tXmlParserNamespace::tXmlParser::m_Filename

Definition at line 136 of file tXmlParser.h.

Referenced by tXmlParserNamespace::tXmlResource::LoadFile(), LoadWithoutParsing(), LoadWithParsing(), and ParseSax().

int tXmlParserNamespace::tXmlParser::m_Mode [private]

Definition at line 138 of file tXmlParser.h.

Referenced by Parse(), and SetMode().

---

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

• src/tools/tXmlParser.h
• src/tools/tXmlParser.cpp

---