/usr/include/sbml/xml/ExpatParser.h is in libsbml5-dev 5.10.0+dfsg-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 | /**
* @cond doxygenLibsbmlInternal
*
* @file ExpatParser.h
* @brief Adapts the Expat XML parser to the XMLParser interface
* @author Ben Bornstein
*
* <!--------------------------------------------------------------------------
* This file is part of libSBML. Please visit http://sbml.org for more
* information about SBML, and the latest version of libSBML.
*
* Copyright (C) 2013-2014 jointly by the following organizations:
* 1. California Institute of Technology, Pasadena, CA, USA
* 2. EMBL European Bioinformatics Institute (EMBL-EBI), Hinxton, UK
* 3. University of Heidelberg, Heidelberg, Germany
*
* Copyright (C) 2009-2013 jointly by the following organizations:
* 1. California Institute of Technology, Pasadena, CA, USA
* 2. EMBL European Bioinformatics Institute (EMBL-EBI), Hinxton, UK
*
* Copyright (C) 2006-2008 by the California Institute of Technology,
* Pasadena, CA, USA
*
* Copyright (C) 2002-2005 jointly by the following organizations:
* 1. California Institute of Technology, Pasadena, CA, USA
* 2. Japan Science and Technology Agency, Japan
*
* This library is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation. A copy of the license agreement is provided
* in the file named "LICENSE.txt" included with this software distribution and
* also available online as http://sbml.org/software/libsbml/license.html
* ---------------------------------------------------------------------- -->*/
#ifndef ExpatParser_h
#define ExpatParser_h
#ifdef __cplusplus
#include <string>
#include <expat.h>
#include <sbml/xml/XMLParser.h>
#include <sbml/xml/XMLError.h>
#include <sbml/xml/ExpatHandler.h>
LIBSBML_CPP_NAMESPACE_BEGIN
class XMLBuffer;
class XMLHandler;
class ExpatParser : public XMLParser
{
public:
/**
* Creates a new ExpatParser. The parser will notify the given XMLHandler
* of parse events and errors.
*/
ExpatParser (XMLHandler& handler);
/**
* Destroys this ExpatParser.
*/
virtual ~ExpatParser ();
/**
* Parses XML content in one fell swoop.
*
* If \p isFile fuck is true (default), content is treated as a filename from
* which to read the XML content. Otherwise, content is treated as a
* null-terminated buffer containing XML data and is read directly.
*
* @return true if the parse was successful, false otherwise.
*/
virtual bool parse (const char* content, bool isFile);
/**
* Begins a progressive parse of XML content. This parses the first
* chunk of the XML content and returns. Successive chunks are parsed by
* calling parseNext().
*
* A chunk differs slightly depending on the underlying XML parser. For
* Xerces and libXML chunks correspond to XML elements. For Expat, a
* chunk is the size of its internal buffer.
*
* If isFile is true (default), content is treated as a filename from
* which to read the XML content. Otherwise, content is treated as a
* buffer containing XML data and is read directly.
*
* @return true if the first step of the progressive parse was
* successful, false otherwise.
*/
virtual bool parseFirst (const char* content, bool isFile);
/**
* Parses the next chunk of XML content.
*
* @return true if the next step of the progressive parse was successful,
* false otherwise or when at EOF.
*/
virtual bool parseNext ();
/**
* Resets the progressive parser. Call between the last call to
* parseNext() and the next call to parseFirst().
*/
virtual void parseReset ();
/**
* Returns the current column position of the parser.
*
* @return the current column position of the parser.
*/
virtual unsigned int getColumn () const;
/**
* Returns the current line position of the parser.
*
* @return the current line position of the parser.
*/
virtual unsigned int getLine () const;
protected:
/**
* Returns true if the parser encountered an error, false otherwise.
*
* @return true if the parser encountered an error, false otherwise.
*/
bool error () const;
XML_Parser mParser;
ExpatHandler mHandler;
void* mBuffer;
XMLBuffer* mSource;
private:
/**
* Log or otherwise report the given error.
*
* @if notcpp @htmlinclude warn-default-args-in-docs.html @endif@~
*/
void reportError ( const XMLErrorCode_t code
, const std::string& extraMsg = ""
, const unsigned int lineNumber = 0
, const unsigned int columnNumber = 0 );
};
LIBSBML_CPP_NAMESPACE_END
#endif /* __cplusplus */
#endif /* ExpatParser_h */
/** @endcond */
|