/usr/include/cxxtools/xml/xmlserializer.h is in libcxxtools-dev 2.0-4ubuntu2.
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 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 | /*
* Copyright (C) 2008 by 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_XmlSerializer_h
#define cxxtools_Xml_XmlSerializer_h
#include <cxxtools/string.h>
#include <cxxtools/formatter.h>
#include <cxxtools/serializer.h>
#include <memory>
namespace cxxtools {
namespace xml {
class XmlWriter;
/** @brief Serialize objects or object data to XML
Thic class performs XML serialization of a single object or
object data.
*/
class XmlFormatter : public cxxtools::Formatter
{
public:
/** @brief Construct a serializer without initializing the
serializer for writing.
The serializer can be "opened" for writing by calling
method attach().
*/
XmlFormatter();
/** @brief Construct a serializer writing to a byte stream
The serializer will write the objects as XML with
UTF-8 encoding to the output stream.
*/
XmlFormatter(std::ostream& os);
/** @brief Construct a serializer writing to the given XmlWriter object
The serializer will write the objects to the given XmlWriter object.
This class will not free the given XmlWriter object. The caller is
responsible to free it if needed.
*/
XmlFormatter(cxxtools::xml::XmlWriter* writer);
//! @brief Destructor
~XmlFormatter();
/** @brief Opens this serializer for writing into the given stream.
The serializer will write the objects as XML with
UTF-8 encoding to the output stream.
This method does not have to be called if this XmlSerializer object
was constructed using the constructor that takes an ostream or
XmlWriter object. If this method is called anyway or called twice an
std::logic_error is thrown.
*/
void attach(std::ostream& os);
/** @brief Opens this serializer for writing into the given XmlWriter object.
The serializer will write the objects to the given XmlWriter object.
This method does not have to be called if this XmlSerializer object
was constructed using the constructor that takes an ostream or
XmlWriter object. If this method is called anyway or called twice an
std::logic_error is thrown.
This class will not free the given XmlWriter object. The caller is
responsible to free it if needed.
*/
void attach(cxxtools::xml::XmlWriter& writer);
/** @brief Detaches the currently set writer from this object.
Before detaching the writer, the underlaying stream is flushed.
If there is no currently set writer, nothing happens.
*/
void detach();
//! @internal
void flush();
void addValue(const std::string& name, const std::string& type,
const cxxtools::String& value, const std::string& id);
void addReference(const std::string& name, const cxxtools::String& value);
void beginArray(const std::string& name, const std::string& type,
const std::string& id);
void finishArray();
void beginObject(const std::string& name, const std::string& type,
const std::string& id);
void beginMember(const std::string& name);
void finishMember();
void finishObject();
void finish();
private:
//! @internal
cxxtools::xml::XmlWriter* _writer;
//! @internal
std::auto_ptr<cxxtools::xml::XmlWriter> _deleter;
};
/** @brief Serialize objects or object data to XML
Thic class performs XML serialization of a single object or
object data.
*/
class XmlSerializer
{
public:
/** @brief Construct a serializer without initializing the
serializer for writing.
The serializer can be "opened" for writing by calling
method attach().
*/
XmlSerializer();
/** @brief Construct a serializer writing to a byte stream
The serializer will write the objects as XML with
UTF-8 encoding to the output stream.
*/
XmlSerializer(std::ostream& os);
/** @brief Construct a serializer writing to the given XmlWriter object
The serializer will write the objects to the given XmlWriter object.
This class will not free the given XmlWriter object. The caller is
responsible to free it if needed.
*/
XmlSerializer(cxxtools::xml::XmlWriter* writer);
//! @brief Destructor
~XmlSerializer();
/** @brief Opens this serializer for writing into the given stream.
The serializer will write the objects as XML with
UTF-8 encoding to the output stream.
This method does not have to be called if this XmlSerializer object
was constructed using the constructor that takes an ostream or
XmlWriter object. If this method is called anyway or called twice an
std::logic_error is thrown.
*/
void attach(std::ostream& os);
/** @brief Opens this serializer for writing into the given XmlWriter object.
The serializer will write the objects to the given XmlWriter object.
This method does not have to be called if this XmlSerializer object
was constructed using the constructor that takes an ostream or
XmlWriter object. If this method is called anyway or called twice an
std::logic_error is thrown.
This class will not free the given XmlWriter object. The caller is
responsible to free it if needed.
*/
void attach(cxxtools::xml::XmlWriter& writer);
/** @brief Detaches the currently set writer from this object.
Before detaching the writer, the underlaying stream is flushed.
If there is no currently set writer, nothing happens.
*/
void detach();
/** @brief Serialize an object to XML
The serializer will serialize the object \a type as
XML to the assigned stream. The string \a name will be used
as the instance name of \a type and appear as the name of the
XML element. The type must be serializable.
*/
template <typename T>
void serialize(const T& type, const std::string& name)
{
cxxtools::ISerializer* serializer = _context.begin(type);
serializer->setName(name);
}
void finish()
{
_context.fixdown(_formatter);
_context.clear();
flush();
}
//! @internal
void flush();
private:
XmlFormatter _formatter;
//! @internal
cxxtools::SerializationContext _context;
};
} // namespace xml
} // namespace cxxtools
#endif
|