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
49 namespace SDXParserInternal
50 {
51 struct State;
52 }
53
54 class StarAttributeManager;
55 class StarObject;
56 class StarZone;
57 class STOFFOLEParser;
58 class StarFormatManager;
64 class SDXParser final : public STOFFTextParser
65 {
66 public:
68 SDXParser(STOFFInputStreamPtr &input, STOFFHeader *header);
70 ~SDXParser() 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 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;
106 private:
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:
StarFileManager.hxx
SDXParser
the main class to read a StarOffice sdX file
Definition: SDXParser.hxx:64
StarFileManager
the main class to read/.
Definition: StarFileManager.hxx:61
STOFFDocument::STOFF_K_TEXT
@ STOFF_K_TEXT
word processing file
Definition: STOFFDocument.hxx:75
STOFFDocument::STOFF_K_DRAW
@ STOFF_K_DRAW
vectorized graphic: .sda
Definition: STOFFDocument.hxx:71
StarAttributeManager
the main class to read/.
Definition: StarAttribute.hxx:1080
SDXParser.hxx
STOFFEntry.hxx
STOFF_DEBUG_MSG
#define STOFF_DEBUG_MSG(M)
Definition: libstaroffice_internal.hxx:129
SDXParserInternal::State
Internal: the state of a SDXParser.
Definition: SDXParser.cxx:63
StarObjectSpreadsheet
the main class to read a StarOffice sdc file
Definition: StarObjectSpreadsheet.hxx:63
SDXParser::SDXParser
SDXParser(STOFFInputStreamPtr &input, STOFFHeader *header)
constructor
Definition: SDXParser.cxx:79
StarObjectSpreadsheet::parse
bool parse()
try to parse the current object
Definition: StarObjectSpreadsheet.cxx:756
SDXParser::m_oleParser
std::shared_ptr< STOFFOLEParser > m_oleParser
the ole parser
Definition: SDXParser.hxx:103
StarObjectMath
the main class to read a small StarOffice math zone .sdf
Definition: StarObjectMath.hxx:58
StarObjectText::parse
bool parse()
Definition: StarObjectText.cxx:819
StarFileManager::readOutPlaceObject
static bool readOutPlaceObject(STOFFInputStreamPtr input, libstoff::DebugFile &ascii)
try to read the "OutPlace Object"
Definition: StarFileManager.cxx:743
SDXParser::init
void init()
inits all internal variables
Definition: SDXParser.cxx:92
StarFileManager::readOleObject
static bool readOleObject(STOFFInputStreamPtr input, librevenge::RVNGBinaryData &data, std::string const &fileName)
try to read a "Ole-Object" zone
Definition: StarFileManager.cxx:724
SDXParser::setDocumentPassword
void setDocumentPassword(char const *passwd)
set the document password
Definition: SDXParser.hxx:72
StarObjectText
the main class to read a StarOffice sdw file
Definition: StarObjectText.hxx:100
STOFFParser.hxx
STOFFOLEParser.hxx
STOFFDocument::STOFF_K_CHART
@ STOFF_K_CHART
chart
Definition: STOFFDocument.hxx:69
libstoff::DebugFile::reset
static void reset()
Definition: STOFFDebug.hxx:228
STOFFOLEParser::OleDirectory
Internal: internal method to keep ole directory and their content.
Definition: STOFFOLEParser.hxx:185
libstoff::DebugStream::str
static std::string str()
Definition: STOFFDebug.hxx:203
SDXParser::m_password
const char * m_password
the password
Definition: SDXParser.hxx:101
StarObjectChart::parse
bool parse()
try to parse the current object
Definition: StarObjectChart.cxx:158
SDXParserInternal::State::m_actPage
int m_actPage
the actual page
Definition: SDXParser.cxx:71
StarFileManager::readEmbeddedPicture
static bool readEmbeddedPicture(std::shared_ptr< STOFFOLEParser > oleParser, std::string const &fileName, STOFFEmbeddedObject &image)
try to read a embedded picture file: Embedded/PicXXXXXX
Definition: StarFileManager.cxx:547
StarObjectDraw.hxx
SDXParser::operator=
SDXParser & operator=(SDXParser const &orig)=delete
StarObjectDraw
the main class to read a StarOffice draw
Definition: StarObjectDraw.hxx:61
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
StarObjectDraw::parse
bool parse()
try to parse the current object
Definition: StarObjectDraw.cxx:125
StarObjectSpreadsheet.hxx
STOFFOLEParser::OleDirectory::getUnparsedOles
std::vector< std::string > getUnparsedOles() const
returns the list of unknown ole
Definition: STOFFOLEParser.hxx:206
STOFFParser::ascii
libstoff::DebugFile & ascii()
a DebugFile used to write what we recognize when we parse the document
Definition: STOFFParser.hxx:143
libstoff::DebugStream
Definition: STOFFDebug.hxx:194
libstoff::ParseException
Definition: libstaroffice_internal.hxx:143
StarObjectMath::parse
bool parse()
try to parse the current object
Definition: StarObjectMath.cxx:99
SDXParser::~SDXParser
~SDXParser() final
destructor
Definition: SDXParser.cxx:88
STOFFHeader
a function used by STOFFDocument to store the version of document
Definition: STOFFHeader.hxx:56
SDXParser::createZones
bool createZones()
parses the different OLE, ...
Definition: SDXParser.cxx:124
StarObjectMath.hxx
STOFFOLEParser
a class used to parse some basic oles Tries to read the different ole parts and stores their contents...
Definition: STOFFOLEParser.hxx:86
SDXParser::parse
void parse(librevenge::RVNGTextInterface *documentInterface) override
virtual function used to parse the input
Definition: SDXParser.cxx:102
SDXParser::createDocument
void createDocument(librevenge::RVNGTextInterface *documentInterface)
creates the listener which will be associated to the document
Definition: SDXParser.cxx:223
StarObjectText.hxx
STOFFDebug.hxx
STOFFParser::setAsciiName
void setAsciiName(char const *name)
Debugging: change the default ascii file.
Definition: STOFFParser.hxx:171
libstoff::DebugFile::addPos
static void addPos(long)
Definition: STOFFDebug.hxx:223
StarObject.hxx
StarZone.hxx
STOFFTextParser
virtual class which defines the ancestor of all text zone parser
Definition: STOFFParser.hxx:194
SDXParser::m_state
std::shared_ptr< SDXParserInternal::State > m_state
the state
Definition: SDXParser.hxx:105
libstoff::DebugFile
Definition: STOFFDebug.hxx:210
STOFFDocument::STOFF_K_MATH
@ STOFF_K_MATH
math
Definition: STOFFDocument.hxx:72
StarFileManager::readImageDocument
static bool readImageDocument(STOFFInputStreamPtr input, librevenge::RVNGBinaryData &data, std::string const &fileName)
try to read a image zone: "StarImageDocument" or "StarImageDocument 4.0
Definition: StarFileManager.cxx:528
StarObjectChart
the main class to read a StarOffice chart
Definition: StarObjectChart.hxx:60
STOFFParser::getInput
STOFFInputStreamPtr & getInput()
returns the actual input
Definition: STOFFParser.hxx:113
libstoff::DebugFile::addNote
static void addNote(char const *)
Definition: STOFFDebug.hxx:224
StarFormatManager
the main class to read/.
Definition: StarFormatManager.hxx:90
SDXParser::checkHeader
bool checkHeader(STOFFHeader *header, bool strict=false) override
checks if the document header is correct (or not)
Definition: SDXParser.cxx:246
libstoff::DebugFile::open
static bool open(std::string const &)
Definition: STOFFDebug.hxx:218
STOFFInputStream.hxx
SDXParserInternal::State::m_numPages
int m_numPages
the number of page of the final document
Definition: SDXParser.cxx:71
StarItemPool.hxx
StarAttribute.hxx
SDXParserInternal::State::State
State()
constructor
Definition: SDXParser.cxx:65
SDXParserInternal
Internal: the structures of a SDXParser.
Definition: SDXParser.cxx:59
StarObjectChart.hxx
STOFFDocument::STOFF_K_SPREADSHEET
@ STOFF_K_SPREADSHEET
spreadsheet: .sdc
Definition: STOFFDocument.hxx:74
SWFieldManager.hxx