/usr/include/cxxtools/xml/xmlreader.h is in libcxxtools-dev 2.2.1-2.
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 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 | /*
* Copyright (C) 2009 Marc Boris Duerner
*
* 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; either
* version 2.1 of the License, or (at your option) any later version.
*
* As a special exception, you may use this file as part of a free
* software library without restriction. Specifically, if other files
* instantiate templates or use macros or inline functions from this
* file, or you compile this file and link it with other files to
* produce an executable, this file does not by itself cause the
* resulting executable to be covered by the GNU General Public
* License. This exception does not however invalidate any other
* reasons why the executable file might be covered by the GNU Library
* General Public License.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
#ifndef cxxtools_Xml_XmlReader_h
#define cxxtools_Xml_XmlReader_h
#include <cxxtools/string.h>
#include <cxxtools/textstream.h>
#include <cxxtools/xml/api.h>
#include <cxxtools/xml/node.h>
#include <cxxtools/xml/enddocument.h>
#include <iosfwd>
namespace cxxtools {
namespace xml {
class Node;
class StartElement;
class EntityResolver;
/** @brief Reads XML as a Stream of XML Nodes.
This class operates on an input stream from which XML character data
is read and parsed.
The parser will only parse the XML document as far as the user read
data from it. To read the current element (Node) the method get() can
be used. To parse and read the next element the method next() can be
used. Only when next() or any corresponding method or operator is
called, the next chunk of XML input data is parsed.
To parse a XML-document, a XmlReader constructed with an input stream
from which the XML document is to be read.
The current XML element (Node) can be read using get(). Every call to
next() will parse the next element, position the cursor to the next
element and return the parsed element. The returned element is of type
Node, which is the super-class for all XML element classes. The class
Node has a method type() which returns the type of the read element.
Depending on the type the generic Node object may be cast to the more
concrete element object. For example a Node object with a node type of
Node::StartElement can be cast to StartElement.
Parsing using next() will continue until the end of the document is
reached which will resultin a EndDocument element to be returned by
next() and get().
This class also provides the method current() to obtain an iterator
which basically works the same way like using using get() and next()
directly. The iterator can be set to the next element by using the
++ operator. The current element can be accessed by dereferencing
the iterator.
@see Node
*/
class CXXTOOLS_XML_API XmlReader
{
public:
class Iterator
{
public:
Iterator()
: _stream(0)
, _node(0)
{ }
Iterator(XmlReader& xis)
: _stream(&xis)
, _node(0)
{ _node = &_stream->get(); }
Iterator(const Iterator& it)
: _stream(it._stream), _node(it._node)
{ }
~Iterator()
{ }
Iterator& operator=(const Iterator& it)
{
_stream = it._stream;
_node = it._node;
return *this;
}
inline const Node& operator*() const
{ return *_node; }
inline const Node* operator->() const
{ return _node; }
Iterator& operator++()
{
if(_node->type() == Node::EndDocument)
_node = 0;
else
_node = &_stream->next();
return *this;
}
inline bool operator==(const Iterator& it) const
{ return _node == it._node; }
inline bool operator!=(const Iterator& it) const
{ return _node != it._node; }
private:
XmlReader* _stream;
const Node* _node;
};
public:
/* TODO: Consider the following processing flags:
- ReportProcessingInstructions
- IgnoreWhitespace
- ReportComments
- ReportDocumentStart
*/
XmlReader(std::istream& is, int flags = 0);
XmlReader(std::basic_istream<Char>& is, int flags = 0);
~XmlReader();
void reset(std::basic_istream<Char>& is, int flags = 0);
void reset(std::istream& is, int flags = 0);
const cxxtools::String& documentVersion() const;
const cxxtools::String& documentEncoding() const;
bool standaloneDocument() const;
EntityResolver& entityResolver();
const EntityResolver& entityResolver() const;
size_t depth() const;
Iterator current()
{
return Iterator(*this);
}
Iterator end() const
{
return Iterator();
}
//! @brief Get current element
const Node& get();
//! @brief Get next element from stream
const Node& next();
bool advance();
const StartElement& nextElement();
const Node& nextTag();
std::size_t line() const;
private:
class XmlReaderImpl* _impl;
};
}
}
#endif
|