SDXParser.hxx Source File documentation

SDXParser.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/*
35 * Parser to convert sdX StarOffice document
36 *
37 */
38#ifndef SDX_PARSER
39# define SDX_PARSER
40
41#include <vector>
42
43#include "STOFFDebug.hxx"
44#include "STOFFEntry.hxx"
45#include "STOFFInputStream.hxx"
46
47#include "STOFFParser.hxx"
48
49namespace SDXParserInternal
50{
51struct State;
52}
53
54class StarAttributeManager;
55class StarObject;
56class StarZone;
57class STOFFOLEParser;
58class StarFormatManager;
64 class SDXParser final : public STOFFTextParser
65{
66public:
68 SDXParser(STOFFInputStreamPtr &input, STOFFHeader *header);
70 ~SDXParser() final;
72 void setDocumentPassword(char const *passwd)
73 {
74 m_password=passwd;
75 }
76
77 bool checkHeader(STOFFHeader *header, bool strict=false) override;
78
79 // the main parse function
80 void parse(librevenge::RVNGTextInterface *documentInterface) override;
81
82protected:
84 void init();
85
87 void createDocument(librevenge::RVNGTextInterface *documentInterface);
88
90 bool createZones();
91
92 //
93 // low level
94 //
95
96 //
97 // data
98 //
99
101 char const *m_password;
103 std::shared_ptr<STOFFOLEParser> m_oleParser;
105 std::shared_ptr<SDXParserInternal::State> m_state;
106private:
107 SDXParser(SDXParser const &orig) = delete;
108 SDXParser &operator=(SDXParser const &orig) = delete;
109};
110#endif
111// vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
STOFFDebug.hxx
STOFFEntry.hxx
STOFFInputStream.hxx
STOFFParser.hxx
SDXParser::checkHeader
bool checkHeader(STOFFHeader *header, bool strict=false) override
checks if the document header is correct (or not)
Definition SDXParser.cxx:246
SDXParser::operator=
SDXParser & operator=(SDXParser const &orig)=delete
SDXParser::setDocumentPassword
void setDocumentPassword(char const *passwd)
set the document password
Definition SDXParser.hxx:72
SDXParser::SDXParser
SDXParser(SDXParser const &orig)=delete
SDXParser::m_state
std::shared_ptr< SDXParserInternal::State > m_state
the state
Definition SDXParser.hxx:105
SDXParser::~SDXParser
~SDXParser() final
destructor
Definition SDXParser.cxx:88
SDXParser::SDXParser
SDXParser(STOFFInputStreamPtr &input, STOFFHeader *header)
constructor
Definition SDXParser.cxx:79
SDXParser::m_password
char const * m_password
the password
Definition SDXParser.hxx:101
SDXParser::createDocument
void createDocument(librevenge::RVNGTextInterface *documentInterface)
creates the listener which will be associated to the document
Definition SDXParser.cxx:223
SDXParser::m_oleParser
std::shared_ptr< STOFFOLEParser > m_oleParser
the ole parser
Definition SDXParser.hxx:103
SDXParser::init
void init()
inits all internal variables
Definition SDXParser.cxx:92
SDXParser::parse
void parse(librevenge::RVNGTextInterface *documentInterface) override
virtual function used to parse the input
Definition SDXParser.cxx:102
SDXParser::createZones
bool createZones()
parses the different OLE, ...
Definition SDXParser.cxx:124
STOFFHeader
a function used by STOFFDocument to store the version of document
Definition STOFFHeader.hxx:57
STOFFOLEParser
a class used to parse some basic oles Tries to read the different ole parts and stores their contents...
Definition STOFFOLEParser.hxx:87
STOFFTextParser::STOFFTextParser
STOFFTextParser(STOFFInputStreamPtr &input, STOFFHeader *header)
constructor (protected)
Definition STOFFParser.hxx:201
StarAttributeManager
the main class to read/.
Definition StarAttribute.hxx:1081
StarFormatManager
the main class to read/.
Definition StarFormatManager.hxx:91
StarObject
an object corresponding to an OLE directory
Definition StarObject.hxx:65
StarZone
a zone in a StarOffice file
Definition StarZone.hxx:57
STOFFInputStreamPtr
std::shared_ptr< STOFFInputStream > STOFFInputStreamPtr
a smart pointer of STOFFInputStream
Definition libstaroffice_internal.hxx:489
SDXParserInternal
Internal: the structures of a SDXParser.
Definition SDXParser.cxx:60
SDXParserInternal::State
Internal: the state of a SDXParser.
Definition SDXParser.cxx:63