2009-09-28 15:43:28 +00:00
|
|
|
/*============================================================================
|
|
|
|
CMake - Cross Platform Makefile Generator
|
|
|
|
Copyright 2000-2009 Kitware, Inc., Insight Software Consortium
|
2005-01-18 18:41:23 +00:00
|
|
|
|
2009-09-28 15:43:28 +00:00
|
|
|
Distributed under the OSI-approved BSD License (the "License");
|
|
|
|
see accompanying file Copyright.txt for details.
|
2005-01-18 18:41:23 +00:00
|
|
|
|
2009-09-28 15:43:28 +00:00
|
|
|
This software is distributed WITHOUT ANY WARRANTY; without even the
|
|
|
|
implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
|
|
|
|
See the License for more information.
|
|
|
|
============================================================================*/
|
2005-01-18 18:41:23 +00:00
|
|
|
#ifndef cmXMLParser_h
|
|
|
|
#define cmXMLParser_h
|
|
|
|
|
|
|
|
#include "cmStandardIncludes.h"
|
|
|
|
|
|
|
|
extern "C"
|
|
|
|
{
|
|
|
|
void cmXMLParserStartElement(void*, const char*, const char**);
|
|
|
|
void cmXMLParserEndElement(void*, const char*);
|
2012-08-13 17:42:58 +00:00
|
|
|
void cmXMLParserCharacterDataHandler(void*, const char*, int);
|
2005-01-18 18:41:23 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/** \class cmXMLParser
|
|
|
|
* \brief Helper class for performing XML parsing
|
|
|
|
*
|
|
|
|
* Superclass for all XML parsers.
|
|
|
|
*/
|
|
|
|
class cmXMLParser
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
cmXMLParser();
|
|
|
|
virtual ~cmXMLParser();
|
|
|
|
|
|
|
|
//! Parse given XML string
|
|
|
|
virtual int Parse(const char* string);
|
|
|
|
|
|
|
|
//! Parse given XML file
|
|
|
|
virtual int ParseFile(const char* file);
|
2012-08-13 17:42:58 +00:00
|
|
|
|
2005-01-18 18:41:23 +00:00
|
|
|
/**
|
2006-05-12 18:36:39 +00:00
|
|
|
* When parsing fragments of XML or streaming XML, use the following
|
|
|
|
* three methods. InitializeParser method initialize parser but does
|
|
|
|
* not perform any actual parsing. ParseChunk parses framgent of
|
|
|
|
* XML. This has to match to what was already parsed. CleanupParser
|
|
|
|
* finishes parsing. If there were errors, CleanupParser will report
|
|
|
|
* them.
|
2005-01-18 18:41:23 +00:00
|
|
|
*/
|
|
|
|
virtual int InitializeParser();
|
2012-08-13 17:42:58 +00:00
|
|
|
virtual int ParseChunk(const char* inputString,
|
2007-07-26 18:36:06 +00:00
|
|
|
std::string::size_type length);
|
2005-01-18 18:41:23 +00:00
|
|
|
virtual int CleanupParser();
|
|
|
|
|
|
|
|
protected:
|
2006-05-12 18:36:39 +00:00
|
|
|
//! This variable is true if there was a parse error while parsing in
|
|
|
|
//chunks.
|
2005-01-18 18:41:23 +00:00
|
|
|
int ParseError;
|
|
|
|
|
|
|
|
//1 Expat parser structure. Exists only during call to Parse().
|
|
|
|
void* Parser;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Called before each block of input is read from the stream to check if
|
|
|
|
* parsing is complete. Can be replaced by subclasses to change the
|
|
|
|
* terminating condition for parsing. Parsing always stops when the end of
|
|
|
|
* file is reached in the stream.
|
|
|
|
*/
|
2012-08-13 17:42:58 +00:00
|
|
|
|
2005-01-18 18:41:23 +00:00
|
|
|
virtual int ParsingComplete();
|
|
|
|
|
|
|
|
/**
|
2006-05-12 18:36:39 +00:00
|
|
|
* Called when a new element is opened in the XML source. Should be
|
|
|
|
* replaced by subclasses to handle each element. name = Name of new
|
|
|
|
* element. atts = Null-terminated array of attribute name/value pairs.
|
|
|
|
* Even indices are attribute names, and odd indices are values.
|
2005-01-18 18:41:23 +00:00
|
|
|
*/
|
|
|
|
virtual void StartElement(const char* name, const char** atts);
|
2012-08-13 17:42:58 +00:00
|
|
|
|
2006-05-12 18:36:39 +00:00
|
|
|
//! Called at the end of an element in the XML source opened when
|
|
|
|
//StartElement was called.
|
2005-01-18 18:41:23 +00:00
|
|
|
virtual void EndElement(const char* name);
|
2012-08-13 17:42:58 +00:00
|
|
|
|
2005-01-18 18:41:23 +00:00
|
|
|
//! Called when there is character data to handle.
|
2012-08-13 17:42:58 +00:00
|
|
|
virtual void CharacterDataHandler(const char* data, int length);
|
2005-01-18 18:41:23 +00:00
|
|
|
|
|
|
|
//! Called by Parse to report an XML syntax error.
|
2012-08-13 17:42:58 +00:00
|
|
|
virtual void ReportXmlParseError();
|
2005-01-18 18:41:23 +00:00
|
|
|
|
2009-02-24 20:43:37 +00:00
|
|
|
/** Called by ReportXmlParseError with basic error info. */
|
|
|
|
virtual void ReportError(int line, int column, const char* msg);
|
|
|
|
|
2005-01-18 18:41:23 +00:00
|
|
|
//! Utility for convenience of subclasses. Wraps isspace C library
|
|
|
|
// routine.
|
2012-08-13 17:42:58 +00:00
|
|
|
static int IsSpace(char c);
|
|
|
|
|
2005-01-18 18:41:23 +00:00
|
|
|
//! Send the given buffer to the XML parser.
|
2012-08-13 17:42:58 +00:00
|
|
|
virtual int ParseBuffer(const char* buffer,
|
2007-07-26 18:36:06 +00:00
|
|
|
std::string::size_type length);
|
2012-08-13 17:42:58 +00:00
|
|
|
|
2005-01-18 18:41:23 +00:00
|
|
|
//! Send the given c-style string to the XML parser.
|
|
|
|
int ParseBuffer(const char* buffer);
|
|
|
|
|
2009-02-24 20:43:49 +00:00
|
|
|
/** Helps subclasses search for attributes on elements. */
|
|
|
|
static const char* FindAttribute(const char** atts, const char* attribute);
|
|
|
|
|
2005-01-18 18:41:23 +00:00
|
|
|
//! Callbacks for the expat
|
|
|
|
friend void cmXMLParserStartElement(void*, const char*, const char**);
|
|
|
|
friend void cmXMLParserEndElement(void*, const char*);
|
|
|
|
friend void cmXMLParserCharacterDataHandler(void*, const char*, int);
|
|
|
|
};
|
|
|
|
|
|
|
|
#endif
|