SDGParser.hxx Source File documentation

SDGParser.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 sdg StarOffice document
36 *
37 */
38 #ifndef SDG_PARSER
39 # define SDG_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 SDGParserInternal
50 {
51 struct State;
52 }
53
54 class StarAttributeManager;
55 class StarObject;
56 class StarZone;
57 class STOFFOLEParser;
58 class StarFormatManager;
64 class SDGParser final : public STOFFGraphicParser
65 {
66 public:
68 SDGParser(STOFFInputStreamPtr &input, STOFFHeader *header);
70 ~SDGParser() 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::RVNGDrawingInterface *documentInterface) override;
81
82 protected:
84 void createDocument(librevenge::RVNGDrawingInterface *documentInterface);
85
87 bool createZones();
88
89 //
90 // low level
91 //
92
94 bool readSGA3(StarZone &zone);
96 bool readBitmap(StarZone &zone);
97
98 //
99 // data
100 //
101
103 char const *m_password;
105 std::shared_ptr<SDGParserInternal::State> m_state;
106 private:
107 SDGParser(SDGParser const &orig) = delete;
108 SDGParser &operator=(SDGParser const &orig) = delete;
109 };
110 #endif
111 // vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
STOFFListenerPtr
std::shared_ptr< STOFFListener > STOFFListenerPtr
a smart pointer of STOFFListener
Definition: libstaroffice_internal.hxx:491
STOFFGraphicStyle::m_propertyList
librevenge::RVNGPropertyList m_propertyList
the property list
Definition: STOFFGraphicStyle.hxx:66
STOFFHeader::reset
void reset(int vers, Kind kind=STOFFDocument::STOFF_K_TEXT)
resets the data
Definition: STOFFHeader.hxx:77
STOFFVec2< int >
SDGParser::m_password
const char * m_password
the password
Definition: SDGParser.hxx:103
STOFFEntry
basic class to store an entry in a file This contained :
Definition: STOFFEntry.hxx:46
libstoff::getString
librevenge::RVNGString getString(std::vector< uint32_t > const &unicode)
transform a unicode string in a RNVGString
Definition: libstaroffice_internal.cxx:63
SDGParserInternal
Internal: the structures of a SDGParser.
Definition: SDGParser.cxx:53
StarZone::ascii
libstoff::DebugFile & ascii()
returns the ascii file
Definition: StarZone.hxx:254
StarAttributeManager
the main class to read/.
Definition: StarAttribute.hxx:1080
SDGParserInternal::SubDocument
Internal: the subdocument of a SDGParser.
Definition: SDGParser.cxx:91
STOFFEntry.hxx
STOFF_DEBUG_MSG
#define STOFF_DEBUG_MSG(M)
Definition: libstaroffice_internal.hxx:129
STOFFFrameStyle.hxx
SDGParser.hxx
SDGParserInternal::SubDocument::m_text
librevenge::RVNGString m_text
the text
Definition: SDGParser.cxx:116
STOFFSubDocument
abstract class used to store a subdocument (with a comparison function)
Definition: STOFFSubDocument.hxx:41
STOFFFrameStyle
Class to store a frame style.
Definition: STOFFFrameStyle.hxx:45
STOFFPageSpan
A class which defines the page properties.
Definition: STOFFPageSpan.hxx:75
STOFFGraphicListener
This class contains the code needed to create Graphic document.
Definition: STOFFGraphicListener.hxx:59
SDGParserInternal::Image::m_link
librevenge::RVNGString m_link
the link name
Definition: SDGParser.cxx:73
StarZone::readString
bool readString(std::vector< uint32_t > &string, int encoding=-1) const
try to read an unicode string
Definition: StarZone.hxx:220
SDGParser
the main class to read a StarOffice sdg file
Definition: SDGParser.hxx:64
SDGParserInternal::State::State
State()
constructor
Definition: SDGParser.cxx:80
StarBitmap::readBitmap
bool readBitmap(StarZone &zone, bool inFileHeader, long lastPos, librevenge::RVNGBinaryData &data, std::string &type)
low level
Definition: StarBitmap.cxx:214
StarBitmap
the main class to read/.
Definition: StarBitmap.hxx:62
STOFFParser.hxx
STOFFOLEParser.hxx
STOFFEmbeddedObject
small class use to define a embedded object
Definition: libstaroffice_internal.hxx:408
SDGParserInternal::Image::m_size
STOFFVec2i m_size
the bitmap size
Definition: SDGParser.cxx:71
libstoff::DebugFile::reset
static void reset()
Definition: STOFFDebug.hxx:228
SDGParser::createDocument
void createDocument(librevenge::RVNGDrawingInterface *documentInterface)
creates the listener which will be associated to the document
Definition: SDGParser.cxx:225
libstoff::DebugStream::str
static std::string str()
Definition: STOFFDebug.hxx:203
SDGParser::operator=
SDGParser & operator=(SDGParser const &orig)=delete
STOFFSubDocument.hxx
STOFFInputStreamPtr
std::shared_ptr< STOFFInputStream > STOFFInputStreamPtr
a smart pointer of STOFFInputStream
Definition: libstaroffice_internal.hxx:489
STOFFGraphicParser
virtual class which defines the ancestor of all graphic/presentation zone parser
Definition: STOFFParser.hxx:209
libstoff::SubDocumentType
SubDocumentType
Definition: libstaroffice_internal.hxx:185
STOFFParser::resetGraphicListener
void resetGraphicListener()
resets the graphic listener
Definition: STOFFParser.cxx:83
StarZone
a zone in a StarOffice file
Definition: StarZone.hxx:56
StarObject
an object corresponding to an OLE directory
Definition: StarObject.hxx:64
STOFFPageSpan::m_pageSpan
int m_pageSpan
the number of page
Definition: STOFFPageSpan.hxx:108
SDGParserInternal::State::m_imagesList
std::vector< Image > m_imagesList
the list of image
Definition: SDGParser.cxx:86
SDGParserInternal::Image
Internal: small class use to store an image content in a SDGParser.
Definition: SDGParser.cxx:58
STOFFParser::ascii
libstoff::DebugFile & ascii()
a DebugFile used to write what we recognize when we parse the document
Definition: STOFFParser.hxx:143
SDGParser::m_state
std::shared_ptr< SDGParserInternal::State > m_state
the state
Definition: SDGParser.hxx:105
libstoff::DebugStream
Definition: STOFFDebug.hxx:194
SDGParser::readSGA3
bool readSGA3(StarZone &zone)
try to read a SGA3 zone
Definition: SDGParser.cxx:245
SDGParserInternal::Image::Image
Image()
constructor
Definition: SDGParser.cxx:62
libstoff::ParseException
Definition: libstaroffice_internal.hxx:143
STOFFPosition::setAnchor
void setAnchor(AnchorTo anchor)
set the anchor
Definition: STOFFPosition.hxx:121
StarBitmap::getData
bool getData(librevenge::RVNGBinaryData &data, std::string &type) const
try to convert the read data in ppm
Definition: StarBitmap.cxx:201
STOFFFrameStyle::m_position
STOFFPosition m_position
the position
Definition: STOFFFrameStyle.hxx:73
SDGParser::SDGParser
SDGParser(STOFFInputStreamPtr &input, STOFFHeader *header)
constructor
Definition: SDGParser.cxx:135
STOFFGraphicListenerPtr
std::shared_ptr< STOFFGraphicListener > STOFFGraphicListenerPtr
a smart pointer of STOFFGraphicListener
Definition: libstaroffice_internal.hxx:485
STOFFHeader
a function used by STOFFDocument to store the version of document
Definition: STOFFHeader.hxx:56
STOFFGraphicListener.hxx
SDGParser::readBitmap
bool readBitmap(StarZone &zone)
try to read a bitmap
Definition: SDGParser.cxx:290
STOFFVec2f
STOFFVec2< float > STOFFVec2f
STOFFVec2 of float.
Definition: libstaroffice_internal.hxx:771
STOFFGraphicStyle
Class to store a graphic style.
Definition: STOFFGraphicStyle.hxx:44
STOFFOLEParser
a class used to parse some basic oles Tries to read the different ole parts and stores their contents...
Definition: STOFFOLEParser.hxx:86
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
SDGParser::~SDGParser
~SDGParser() final
destructor
Definition: SDGParser.cxx:142
SDGParser::setDocumentPassword
void setDocumentPassword(char const *passwd)
set the document password
Definition: SDGParser.hxx:72
STOFFParser::getGraphicListener
STOFFGraphicListenerPtr & getGraphicListener()
returns the graphic listener
Definition: STOFFParser.hxx:128
STOFFPosition::Page
@ Page
Definition: STOFFPosition.hxx:51
StarBitmap.hxx
libstoff::DebugFile::addPos
static void addPos(long)
Definition: STOFFDebug.hxx:223
StarZone.hxx
STOFFListener::PageBreak
@ PageBreak
Definition: STOFFListener.hxx:59
SDGParserInternal::State
Internal: the state of a SDGParser.
Definition: SDGParser.cxx:78
libstoff::DebugFile
Definition: STOFFDebug.hxx:210
STOFFParser::setGraphicListener
void setGraphicListener(STOFFGraphicListenerPtr &listener)
sets the graphic listener
Definition: STOFFParser.cxx:78
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
SDGParser::checkHeader
bool checkHeader(STOFFHeader *header, bool strict=false) override
checks if the document header is correct (or not)
Definition: SDGParser.cxx:418
StarZone::input
STOFFInputStreamPtr input()
return the zone input
Definition: StarZone.hxx:247
libstoff::DebugFile::open
static bool open(std::string const &)
Definition: STOFFDebug.hxx:218
STOFFInputStream.hxx
SDGParserInternal::SubDocument::operator!=
bool operator!=(STOFFSubDocument const &doc) const final
operator!=
Definition: SDGParser.cxx:102
SDGParserInternal::Image::m_object
STOFFEmbeddedObject m_object
the object
Definition: SDGParser.cxx:69
STOFFDocument::STOFF_K_GRAPHIC
@ STOFF_K_GRAPHIC
gallery graphic: .sdg
Definition: STOFFDocument.hxx:76
SDGParserInternal::SubDocument::SubDocument
SubDocument(librevenge::RVNGString const &text)
Definition: SDGParser.cxx:94
SDGParserInternal::SubDocument::parse
void parse(STOFFListenerPtr &listener, libstoff::SubDocumentType type) final
the parser function
Definition: SDGParser.cxx:119
STOFFEmbeddedObject::isEmpty
bool isEmpty() const
return true if the picture contains no data
Definition: libstaroffice_internal.hxx:426
SDGParser::createZones
bool createZones()
parses the different OLE, ...
Definition: SDGParser.cxx:199
SDGParserInternal::SubDocument::~SubDocument
~SubDocument() final
destructor
Definition: SDGParser.cxx:99
StarBitmap::getBitmapSize
STOFFVec2i getBitmapSize() const
try to return the bitmap size (in point)
Definition: StarBitmap.cxx:209
STOFFEmbeddedObject::add
void add(librevenge::RVNGBinaryData const &binaryData, std::string const &type="image/pict")
add a picture
Definition: libstaroffice_internal.hxx:437
SDGParser::parse
void parse(librevenge::RVNGDrawingInterface *documentInterface) override
virtual function used to parse the input
Definition: SDGParser.cxx:149