mirror of
https://github.com/reactos/CMake.git
synced 2024-12-14 23:29:57 +00:00
86578eccf2
Per-source copyright/license notice headers that spell out copyright holder names and years are hard to maintain and often out-of-date or plain wrong. Precise contributor information is already maintained automatically by the version control tool. Ultimately it is the receiver of a file who is responsible for determining its licensing status, and per-source notices are merely a convenience. Therefore it is simpler and more accurate for each source to have a generic notice of the license name and references to more detailed information on copyright holders and full license terms. Our `Copyright.txt` file now contains a list of Contributors whose names appeared source-level copyright notices. It also references version control history for more precise information. Therefore we no longer need to spell out the list of Contributors in each source file notice. Replace CMake per-source copyright/license notice headers with a short description of the license and links to `Copyright.txt` and online information available from "https://cmake.org/licensing". The online URL also handles cases of modules being copied out of our source into other projects, so we can drop our notices about replacing links with full license text. Run the `Utilities/Scripts/filter-notices.bash` script to perform the majority of the replacements mechanically. Manually fix up shebang lines and trailing newlines in a few files. Manually update the notices in a few files that the script does not handle.
112 lines
3.6 KiB
C++
112 lines
3.6 KiB
C++
/* Distributed under the OSI-approved BSD 3-Clause License. See accompanying
|
|
file Copyright.txt or https://cmake.org/licensing for details. */
|
|
#ifndef cmXMLParser_h
|
|
#define cmXMLParser_h
|
|
|
|
#include <cmConfigure.h> // IWYU pragma: keep
|
|
|
|
#include <string>
|
|
|
|
extern "C" {
|
|
void cmXMLParserStartElement(void*, const char*, const char**);
|
|
void cmXMLParserEndElement(void*, const char*);
|
|
void cmXMLParserCharacterDataHandler(void*, const char*, int);
|
|
}
|
|
|
|
/** \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);
|
|
|
|
/**
|
|
* 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.
|
|
*/
|
|
virtual int InitializeParser();
|
|
virtual int ParseChunk(const char* inputString,
|
|
std::string::size_type length);
|
|
virtual int CleanupParser();
|
|
typedef void (*ReportFunction)(int, const char*, void*);
|
|
void SetErrorCallback(ReportFunction f, void* d)
|
|
{
|
|
this->ReportCallback = f;
|
|
this->ReportCallbackData = d;
|
|
}
|
|
|
|
protected:
|
|
//! This variable is true if there was a parse error while parsing in
|
|
// chunks.
|
|
int ParseError;
|
|
ReportFunction ReportCallback;
|
|
void* ReportCallbackData;
|
|
|
|
// 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.
|
|
*/
|
|
|
|
virtual int ParsingComplete();
|
|
|
|
/**
|
|
* 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.
|
|
*/
|
|
virtual void StartElement(const std::string& name, const char** atts);
|
|
|
|
//! Called at the end of an element in the XML source opened when
|
|
// StartElement was called.
|
|
virtual void EndElement(const std::string& name);
|
|
|
|
//! Called when there is character data to handle.
|
|
virtual void CharacterDataHandler(const char* data, int length);
|
|
|
|
//! Called by Parse to report an XML syntax error.
|
|
virtual void ReportXmlParseError();
|
|
|
|
/** Called by ReportXmlParseError with basic error info. */
|
|
virtual void ReportError(int line, int column, const char* msg);
|
|
|
|
//! Utility for convenience of subclasses. Wraps isspace C library
|
|
// routine.
|
|
static int IsSpace(char c);
|
|
|
|
//! Send the given buffer to the XML parser.
|
|
virtual int ParseBuffer(const char* buffer, std::string::size_type length);
|
|
|
|
//! Send the given c-style string to the XML parser.
|
|
int ParseBuffer(const char* buffer);
|
|
|
|
/** Helps subclasses search for attributes on elements. */
|
|
static const char* FindAttribute(const char** atts, const char* attribute);
|
|
|
|
//! 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
|