STOFFPropertyHandler.hxx
Go to the documentation of this file.
1 /* -*- Mode: C++; c-default-style: "k&r"; indent-tabs-mode: nil; tab-width: 2; c-basic-offset: 2 -*- */
2
3 /* libstaroffice
4 * Version: MPL 2.0 / LGPLv2+
5 *
6 * The contents of this file are subject to the Mozilla Public License Version
7 * 2.0 (the "License"); you may not use this file except in compliance with
8 * the License or as specified alternatively below. You may obtain a copy of
9 * the License at http://www.mozilla.org/MPL/
10 *
11 * Software distributed under the License is distributed on an "AS IS" basis,
12 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
13 * for the specific language governing rights and limitations under the
14 * License.
15 *
16 * Major Contributor(s):
17 * Copyright (C) 2002 William Lachance (wrlach@gmail.com)
18 * Copyright (C) 2002,2004 Marc Maurer (uwog@uwog.net)
19 * Copyright (C) 2004-2006 Fridrich Strba (fridrich.strba@bluewin.ch)
20 * Copyright (C) 2006, 2007 Andrew Ziem
21 * Copyright (C) 2011, 2012 Alonso Laurent (alonso@loria.fr)
22 *
23 *
24 * All Rights Reserved.
25 *
26 * For minor contributions see the git repository.
27 *
28 * Alternatively, the contents of this file may be used under the terms of
29 * the GNU Lesser General Public License Version 2 or later (the "LGPLv2+"),
30 * in which case the provisions of the LGPLv2+ are applicable
31 * instead of those above.
32 */
33
34 #ifndef STOFF_PROPERTY_HANDLER
35 # define STOFF_PROPERTY_HANDLER
36
37 # include <assert.h>
38 # include <ostream>
39 # include <sstream>
40 # include <string>
41
43 class STOFFPropertyHandler
44 {
45 public:
47 STOFFPropertyHandler() {}
49 virtual ~STOFFPropertyHandler();
50
52 virtual void insertElement(const char *psName) = 0;
54 virtual void insertElement(const char *psName, const librevenge::RVNGPropertyList &xPropList) = 0;
56 virtual void characters(librevenge::RVNGString const &sCharacters) = 0;
57
59 bool checkData(librevenge::RVNGBinaryData const &encoded);
61 bool readData(librevenge::RVNGBinaryData const &encoded);
62 };
63
82 class STOFFPropertyHandlerEncoder
83 {
84 public:
86 STOFFPropertyHandlerEncoder();
87
89 void insertElement(const char *psName);
91 void insertElement(const char *psName, const librevenge::RVNGPropertyList &xPropList);
93 void characters(librevenge::RVNGString const &sCharacters);
95 bool getData(librevenge::RVNGBinaryData &data);
96
97 protected:
99 void writeLong(long val);
101 void writeString(const librevenge::RVNGString &name);
103 void writeProperty(const char *key, const librevenge::RVNGProperty &prop);
105 void writePropertyList(const librevenge::RVNGPropertyList &prop);
107 void writePropertyListVector(const librevenge::RVNGPropertyListVector &vect);
108
110 std::stringstream m_f;
111 };
112
113 #endif
114 // vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
STOFFPropertyHandlerDecoder::readCharacters
bool readCharacters(librevenge::RVNGInputStream &input)
reads a set of characters
Definition: STOFFPropertyHandler.cxx:225
STOFFPropertyHandler::~STOFFPropertyHandler
virtual ~STOFFPropertyHandler()
destructor
Definition: STOFFPropertyHandler.cxx:359
STOFFPropertyHandlerEncoder::characters
void characters(librevenge::RVNGString const &sCharacters)
writes a list of characters
Definition: STOFFPropertyHandler.cxx:74
STOFFPropertyHandlerEncoder::writePropertyListVector
void writePropertyListVector(const librevenge::RVNGPropertyListVector &vect)
adds a property vector: a int: #vect followed by vect[0], vect[1], ...
Definition: STOFFPropertyHandler.cxx:124
STOFFPropertyHandlerEncoder::getData
bool getData(librevenge::RVNGBinaryData &data)
retrieves the data
Definition: STOFFPropertyHandler.cxx:131
STOFF_DEBUG_MSG
#define STOFF_DEBUG_MSG(M)
Definition: libstaroffice_internal.hxx:129
STOFFPropertyHandlerEncoder::m_f
std::stringstream m_f
the streamfile
Definition: STOFFPropertyHandler.hxx:110
STOFFPropertyHandler::checkData
bool checkData(librevenge::RVNGBinaryData const &encoded)
checks a encoded librevenge::RVNGBinaryData created by STOFFPropertyHandlerEncoder
Definition: STOFFPropertyHandler.cxx:363
STOFFPropertyHandler::STOFFPropertyHandler
STOFFPropertyHandler()
constructor
Definition: STOFFPropertyHandler.hxx:47
STOFFPropertyHandlerDecoder::readPropertyList
bool readPropertyList(librevenge::RVNGInputStream &input, librevenge::RVNGPropertyList &lists)
low level: reads a property list: number of properties followed by list of properties
Definition: STOFFPropertyHandler.cxx:262
STOFFPropertyHandlerDecoder::readData
bool readData(librevenge::RVNGBinaryData const &encoded)
tries to read the data
Definition: STOFFPropertyHandler.cxx:151
libstaroffice.hxx
STOFFPropertyHandlerDecoder::readString
bool readString(librevenge::RVNGInputStream &input, librevenge::RVNGString &s)
low level: reads a string : size and string
Definition: STOFFPropertyHandler.cxx:315
libstaroffice_internal.hxx
STOFFPropertyHandlerDecoder::m_handler
STOFFPropertyHandler * m_handler
the streamfile
Definition: STOFFPropertyHandler.cxx:351
STOFFPropertyHandler::insertElement
virtual void insertElement(const char *psName)=0
inserts a simple element
STOFFPropertyHandlerDecoder::operator=
STOFFPropertyHandlerDecoder & operator=(STOFFPropertyHandlerDecoder const &)
STOFFPropertyHandlerDecoder::readProperty
bool readProperty(librevenge::RVNGInputStream &input, librevenge::RVNGPropertyList &list)
low level: reads a property and its value, adds it to list
Definition: STOFFPropertyHandler.cxx:304
STOFFPropertyHandlerEncoder::writeProperty
void writeProperty(const char *key, const librevenge::RVNGProperty &prop)
adds a property: a string key, a string corresponding to value
Definition: STOFFPropertyHandler.cxx:95
STOFFPropertyHandlerEncoder::writePropertyList
void writePropertyList(const librevenge::RVNGPropertyList &prop)
adds a property list: int #prop followed by the different properties
Definition: STOFFPropertyHandler.cxx:105
STOFFPropertyHandlerEncoder::insertElement
void insertElement(const char *psName)
inserts an element
Definition: STOFFPropertyHandler.cxx:60
STOFFPropertyHandler
a generic property handler
Definition: STOFFPropertyHandler.hxx:43
STOFFPropertyHandlerDecoder::readPropertyListVector
bool readPropertyListVector(librevenge::RVNGInputStream &input, librevenge::RVNGPropertyListVector &vect)
low level: reads a property vector: number of properties list followed by list of properties list
Definition: STOFFPropertyHandler.cxx:239
STOFFPropertyHandlerEncoder::writeLong
void writeLong(long val)
adds a long value if f
Definition: STOFFPropertyHandler.cxx:88
STOFFPropertyHandlerDecoder::readInsertElementWithList
bool readInsertElementWithList(librevenge::RVNGInputStream &input)
reads an element with a property list
Definition: STOFFPropertyHandler.cxx:204
STOFFPropertyHandlerDecoder::readInsertElement
bool readInsertElement(librevenge::RVNGInputStream &input)
reads an simple element
Definition: STOFFPropertyHandler.cxx:190
STOFFPropertyHandlerDecoder::STOFFPropertyHandlerDecoder
STOFFPropertyHandlerDecoder(STOFFPropertyHandler *hdl=nullptr)
constructor given a STOFFPropertyHandler
Definition: STOFFPropertyHandler.cxx:148
STOFFPropertyHandler.hxx
STOFFPropertyHandlerEncoder
write in librevenge::RVNGBinaryData a list of tags/and properties
Definition: STOFFPropertyHandler.hxx:82
STOFFPropertyHandlerEncoder::STOFFPropertyHandlerEncoder
STOFFPropertyHandlerEncoder()
constructor
Definition: STOFFPropertyHandler.cxx:55
STOFFPropertyHandlerDecoder::readLong
static bool readLong(librevenge::RVNGInputStream &input, long &val)
low level: reads an long value
Definition: STOFFPropertyHandler.cxx:334
STOFFPropertyHandlerEncoder::writeString
void writeString(const librevenge::RVNGString &name)
adds a string: size and string
Definition: STOFFPropertyHandler.cxx:81
STOFFPropertyHandler::readData
bool readData(librevenge::RVNGBinaryData const &encoded)
reads a encoded librevenge::RVNGBinaryData created by STOFFPropertyHandlerEncoder
Definition: STOFFPropertyHandler.cxx:369
STOFFPropertyHandler::characters
virtual void characters(librevenge::RVNGString const &sCharacters)=0
writes a list of characters
STOFFPropertyHandlerDecoder
Definition: STOFFPropertyHandler.cxx:144