SDWParser.hxx Source File documentation

SDWParser.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 sdw StarOffice document
36 *
37 */
38 #ifndef SDW_PARSER
39 # define SDW_PARSER
40
41 #include <vector>
42
43 #include "STOFFDebug.hxx"
44 #include "STOFFEntry.hxx"
45 #include "STOFFInputStream.hxx"
46
47 #include "STOFFParser.hxx"
48
49 namespace SDWParserInternal
50 {
51 struct State;
52 }
53
54 class StarAttributeManager;
55 class StarObject;
56 class StarZone;
57 class STOFFOLEParser;
58 class StarFormatManager;
64 class SDWParser final : public STOFFTextParser
65 {
66 public:
68 SDWParser(STOFFInputStreamPtr &input, STOFFHeader *header);
70 ~SDWParser() final;
72 void setDocumentPassword(char const *passwd)
73 {
74 m_password=passwd;
75 }
77 bool checkHeader(STOFFHeader *header, bool strict=false) override;
78
79 // the main parse function
80 void parse(librevenge::RVNGTextInterface *documentInterface) override;
81
82 protected:
84 void createDocument(librevenge::RVNGTextInterface *documentInterface);
85
87 bool createZones();
88
89 //
90 // low level
91 //
92
93 //
94 // data
95 //
96
98 char const *m_password;
100 std::shared_ptr<STOFFOLEParser> m_oleParser;
102 std::shared_ptr<SDWParserInternal::State> m_state;
103 private:
104 SDWParser(SDWParser const &orig) = delete;
105 SDWParser &operator=(SDWParser const &orig) = delete;
106 };
107 #endif
108 // vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
StarFileManager.hxx
STOFFHeader::reset
void reset(int vers, Kind kind=STOFFDocument::STOFF_K_TEXT)
resets the data
Definition: STOFFHeader.hxx:77
STOFFDocument::STOFF_K_TEXT
@ STOFF_K_TEXT
word processing file
Definition: STOFFDocument.hxx:75
StarAttributeManager
the main class to read/.
Definition: StarAttribute.hxx:1080
SDWParser::createZones
bool createZones()
parses the different OLE, ...
Definition: SDWParser.cxx:118
STOFFParser::getTextListener
STOFFTextListenerPtr & getTextListener()
returns the text listener
Definition: STOFFParser.hxx:138
STOFFEntry.hxx
STOFF_DEBUG_MSG
#define STOFF_DEBUG_MSG(M)
Definition: libstaroffice_internal.hxx:129
SDWParser::setDocumentPassword
void setDocumentPassword(char const *passwd)
set the document password
Definition: SDWParser.hxx:72
SDWParser::parse
void parse(librevenge::RVNGTextInterface *documentInterface) override
virtual function used to parse the input
Definition: SDWParser.cxx:90
SDWParserInternal::State::m_numPages
int m_numPages
the number of page of the final document
Definition: SDWParser.cxx:65
SDWParserInternal::State::m_actPage
int m_actPage
the actual page
Definition: SDWParser.cxx:65
SDWParser::m_password
const char * m_password
the password
Definition: SDWParser.hxx:98
STOFFPageSpan
A class which defines the page properties.
Definition: STOFFPageSpan.hxx:75
STOFFTextListener
This class contains the code needed to create Text document.
Definition: STOFFTextListener.hxx:59
SDWParser::checkHeader
bool checkHeader(STOFFHeader *header, bool strict=false) override
checks if the document header is correct (or not)
Definition: SDWParser.cxx:174
SDWParserInternal::State::m_mainText
std::shared_ptr< StarObjectText > m_mainText
the main graphic document
Definition: SDWParser.cxx:67
SDWParserInternal::State::State
State()
constructor
Definition: SDWParser.cxx:58
STOFFParser::setTextListener
void setTextListener(STOFFTextListenerPtr &listener)
sets the text listener
Definition: STOFFParser.cxx:100
STOFFHeader::setEncrypted
void setEncrypted(bool encrypted)
set the encryption mode
Definition: STOFFHeader.hxx:110
SDWParser::createDocument
void createDocument(librevenge::RVNGTextInterface *documentInterface)
creates the listener which will be associated to the document
Definition: SDWParser.cxx:140
StarObjectText
the main class to read a StarOffice sdw file
Definition: StarObjectText.hxx:100
STOFFParser.hxx
STOFFOLEParser.hxx
libstoff::DebugFile::reset
static void reset()
Definition: STOFFDebug.hxx:228
SDWParser.hxx
SDWParser::m_oleParser
std::shared_ptr< STOFFOLEParser > m_oleParser
the ole parser
Definition: SDWParser.hxx:100
STOFFTextListener.hxx
SDWParser::SDWParser
SDWParser(STOFFInputStreamPtr &input, STOFFHeader *header)
constructor
Definition: SDWParser.cxx:75
STOFFInputStreamPtr
std::shared_ptr< STOFFInputStream > STOFFInputStreamPtr
a smart pointer of STOFFInputStream
Definition: libstaroffice_internal.hxx:489
StarZone
a zone in a StarOffice file
Definition: StarZone.hxx:56
StarObject
an object corresponding to an OLE directory
Definition: StarObject.hxx:64
SDWParser::operator=
SDWParser & operator=(SDWParser const &orig)=delete
STOFFPageSpan::m_pageSpan
int m_pageSpan
the number of page
Definition: STOFFPageSpan.hxx:108
STOFFParser::ascii
libstoff::DebugFile & ascii()
a DebugFile used to write what we recognize when we parse the document
Definition: STOFFParser.hxx:143
SDWParserInternal::State
Internal: the state of a SDWParser.
Definition: SDWParser.cxx:56
SDWParser::~SDWParser
~SDWParser() final
destructor
Definition: SDWParser.cxx:83
libstoff::ParseException
Definition: libstaroffice_internal.hxx:143
STOFFParser::resetTextListener
void resetTextListener()
resets the text listener
Definition: STOFFParser.cxx:105
STOFFHeader
a function used by STOFFDocument to store the version of document
Definition: STOFFHeader.hxx:56
STOFFOLEParser
a class used to parse some basic oles Tries to read the different ole parts and stores their contents...
Definition: STOFFOLEParser.hxx:86
StarFileManager::checkUnparsed
static void checkUnparsed(STOFFInputStreamPtr input, std::shared_ptr< STOFFOLEParser > oleParser, char const *password)
low level
Definition: StarFileManager.cxx:435
StarObjectText.hxx
STOFFParser::getParserState
STOFFParserStatePtr getParserState()
returns the parser state
Definition: STOFFParser.hxx:103
STOFFDebug.hxx
STOFFParser::getPageSpan
const STOFFPageSpan & getPageSpan() const
returns the actual page dimension
Definition: STOFFParser.hxx:118
StarObject::getDocumentKind
STOFFDocument::Kind getDocumentKind() const
returns the document kind
Definition: StarObject.cxx:115
SDWParser::m_state
std::shared_ptr< SDWParserInternal::State > m_state
the state
Definition: SDWParser.hxx:102
StarZone.hxx
STOFFTextParser
virtual class which defines the ancestor of all text zone parser
Definition: STOFFParser.hxx:194
SDWParser
the main class to read a StarOffice sdw file
Definition: SDWParser.hxx:64
STOFFParser::getInput
STOFFInputStreamPtr & getInput()
returns the actual input
Definition: STOFFParser.hxx:113
StarFormatManager
the main class to read/.
Definition: StarFormatManager.hxx:90
STOFFInputStream.hxx
STOFFTextListenerPtr
std::shared_ptr< STOFFTextListener > STOFFTextListenerPtr
a smart pointer of STOFFTextListener
Definition: libstaroffice_internal.hxx:501
SDWParserInternal
Internal: the structures of a SDWParser.
Definition: SDWParser.cxx:52