Canvas5Parser.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 /* libmwaw
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 CANVAS5_PARSER
35 # define CANVAS5_PARSER
36 
37 #include <functional>
38 #include <map>
39 #include <string>
40 #include <utility>
41 #include <vector>
42 
43 #include <librevenge/librevenge.h>
44 
45 #include "MWAWDebug.hxx"
46 #include "MWAWInputStream.hxx"
47 #include "MWAWPosition.hxx"
48 
49 #include "MWAWParser.hxx"
50 
51 namespace Canvas5ParserInternal
52 {
53 struct Layer;
54 struct Slide;
55 
56 struct State;
57 }
58 
59 class Canvas5Graph;
60 class Canvas5Image;
62 
63 namespace Canvas5Structure
64 {
65 struct Stream;
66 }
67 
71 class Canvas5Parser final : public MWAWGraphicParser
72 {
73  friend class Canvas5Graph;
74  friend class Canvas5Image;
75  friend class Canvas5StyleManager;
76 public:
78  Canvas5Parser(MWAWInputStreamPtr const &input, MWAWRSRCParserPtr const &rsrcParser, MWAWHeader *header);
80  ~Canvas5Parser() final;
81 
83  bool checkHeader(MWAWHeader *header, bool strict=false) final;
84 
85  // the main parse function
86  void parse(librevenge::RVNGDrawingInterface *documentInterface) final;
87 
88 protected:
90  void createDocument(librevenge::RVNGDrawingInterface *documentInterface);
91 
92  //
93  // interface
94  //
95 
97  bool isWindowsFile() const;
99  librevenge::RVNGString getTextLink(int textLinkId) const;
100 
101 protected:
103  bool createZones();
105  bool readMainBlock(std::shared_ptr<Canvas5Structure::Stream> stream);
107  bool readMainBlock9(std::shared_ptr<Canvas5Structure::Stream> stream);
109  bool readFileRSRCs(std::shared_ptr<Canvas5Structure::Stream> stream);
111  bool readSI200(Canvas5Structure::Stream &stream);
113  bool readFileDesc(Canvas5Structure::Stream &stream);
114 
115  // Intermediate level
116 
117  //
118  // first block
119  //
120 
122  bool readFileHeader(std::shared_ptr<Canvas5Structure::Stream> stream);
123 
125  bool readDocumentSettings(std::shared_ptr<Canvas5Structure::Stream> stream);
127  bool readLayers(std::shared_ptr<Canvas5Structure::Stream> stream);
129  bool readSlides(std::shared_ptr<Canvas5Structure::Stream> stream);
131  bool readTextLinks(std::shared_ptr<Canvas5Structure::Stream> stream);
132 
133  //
134  // second block
135  //
136 
137  //
138  // third block
139  //
140 
142  bool readPrinterRsrc(Canvas5Structure::Stream &stream);
144  bool readOLnkRsrc(std::shared_ptr<Canvas5Structure::Stream> stream);
146  bool readObjectDBRsrc(std::shared_ptr<Canvas5Structure::Stream> stream);
147 
148  //
149  // Mac RSRC
150  //
152  bool readPnot(Canvas5Structure::Stream &stream, MWAWEntry const &entry);
154  bool readPicture(Canvas5Structure::Stream &stream, MWAWEntry const &entry);
155 
156  //
157  // Windows RSRC
158  //
159 
160  //
161  // send data to the listener
162  //
163 
165  bool send(Canvas5ParserInternal::Slide const &slide);
167  bool send(Canvas5ParserInternal::Layer const &layer);
168 
169  //
170  // low level
171  //
172 
174  bool readString(Canvas5Structure::Stream &stream, librevenge::RVNGString &string, int maxSize, bool canBeCString=false);
176  bool readDouble(Canvas5Structure::Stream &stream, double &val, bool &isNaN) const;
178  double readDouble(Canvas5Structure::Stream &stream, int fieldSize) const;
180  int readInteger(Canvas5Structure::Stream &stream, int fieldSize) const;
181 
183  struct Item {
186  : m_id(-1)
187  , m_type(unsigned(-1))
188  , m_length(0)
189  , m_pos(-1)
190  , m_decal(0)
191  {
192  }
193 
195  int m_id;
197  unsigned m_type;
199  long m_length;
201  long m_pos;
203  int m_decal;
204  };
206  typedef std::function<void(std::shared_ptr<Canvas5Structure::Stream>, Item const &, std::string const &)> DataFunction;
208  static void defDataFunction(std::shared_ptr<Canvas5Structure::Stream>, Item const &, std::string const &) {}
210  static void stringDataFunction(std::shared_ptr<Canvas5Structure::Stream> stream, Item const &item, std::string const &what);
211 
213  bool readDataHeader(Canvas5Structure::Stream &stream, int expectedSize, int &N);
218  bool readExtendedHeader(std::shared_ptr<Canvas5Structure::Stream> stream, int expectedValue, std::string const &what, DataFunction const &func);
219 
221  bool readUsed(Canvas5Structure::Stream &stream, std::string const &what);
223  bool readDefined(Canvas5Structure::Stream &stream, std::vector<bool> &defined, std::string const &what);
224 
226  bool readIndexMap(std::shared_ptr<Canvas5Structure::Stream> stream, std::string const &what, DataFunction const &func=&Canvas5Parser::defDataFunction);
227 
229  // v9 new structures
231 
233  bool readArray9(std::shared_ptr<Canvas5Structure::Stream> stream, std::string const &what,
236  bool readItemHeader9(Canvas5Structure::Stream &stream, int &id, int &used);
237 
239  bool getTAG9(Canvas5Structure::Stream &stream, std::string &tag, int &type);
241  bool checkTAG9(Canvas5Structure::Stream &stream, std::string const &tag, int type);
242 
245 
246  //
247  // data
248  //
250  std::shared_ptr<Canvas5ParserInternal::State> m_state;
252  std::shared_ptr<Canvas5Graph> m_graphParser;
254  std::shared_ptr<Canvas5Image> m_imageParser;
256  std::shared_ptr<Canvas5StyleManager> m_styleManager;
257 };
258 #endif
259 // vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
bool readSI200(Canvas5Structure::Stream &stream)
try to read the SI200 zone: v6
Definition: Canvas5Parser.cxx:1518
a function used by MWAWDocument to store the version of document
Definition: MWAWHeader.hxx:56
unsigned m_type
the type (if known)
Definition: Canvas5Parser.hxx:197
std::shared_ptr< Canvas5Graph > m_graphParser
the graph parser
Definition: Canvas5Parser.hxx:252
bool send(Canvas5ParserInternal::Slide const &slide)
try to send a page/slide
Definition: Canvas5Parser.cxx:2856
bool readItemHeader9(Canvas5Structure::Stream &stream, int &id, int &used)
try to read an array item header: v9
Definition: Canvas5Parser.cxx:3484
bool readObjectDBRsrc(std::shared_ptr< Canvas5Structure::Stream > stream)
try to read the object database: XOBD v6
Definition: Canvas5Parser.cxx:2234
bool readOLnkRsrc(std::shared_ptr< Canvas5Structure::Stream > stream)
try to read the OLnk rsrc block: v6
Definition: Canvas5Parser.cxx:2176
Definition: MWAWDocument.hxx:56
bool readDocumentSettings(std::shared_ptr< Canvas5Structure::Stream > stream)
read the document settings
Definition: Canvas5Parser.cxx:1774
bool readFileHeader(std::shared_ptr< Canvas5Structure::Stream > stream)
try to read the file header
Definition: Canvas5Parser.cxx:1653
bool readIndexMap(std::shared_ptr< Canvas5Structure::Stream > stream, std::string const &what, DataFunction const &func=&Canvas5Parser::defDataFunction)
try to read a index map
Definition: Canvas5Parser.cxx:3139
static void stringDataFunction(std::shared_ptr< Canvas5Structure::Stream > stream, Item const &item, std::string const &what)
the default function to parse a string
Definition: Canvas5Parser.cxx:3120
bool getTAG9(Canvas5Structure::Stream &stream, std::string &tag, int &type)
try to return a tag, type:0 means begin, type:1 means end: v9
Definition: Canvas5Parser.cxx:3542
bool readString(Canvas5Structure::Stream &stream, librevenge::RVNGString &string, int maxSize, bool canBeCString=false)
try to read a pascal string in the data fork or a Pascal/C string depending on the file type ...
Definition: Canvas5Parser.cxx:2971
bool readDefined(Canvas5Structure::Stream &stream, std::vector< bool > &defined, std::string const &what)
try to read the defined list
Definition: Canvas5Parser.cxx:3246
long m_length
the data length (from current position)
Definition: Canvas5Parser.hxx:199
bool isWindowsFile() const
returns true if the file is a windows file
Definition: Canvas5Parser.cxx:202
static MWAWInputStreamPtr decode(MWAWInputStreamPtr input, int version)
try to decode the input stream
Definition: Canvas5Parser.cxx:3598
Internal: the structures of a Canvas5Parser.
Definition: Canvas5Parser.cxx:70
the main class to read the graphic part of Canvas v5-v11 file
Definition: Canvas5Graph.hxx:84
bool readMainBlock9(std::shared_ptr< Canvas5Structure::Stream > stream)
try to read the first big block: v9
Definition: Canvas5Parser.cxx:492
bool readFileDesc(Canvas5Structure::Stream &stream)
try to read the last block: some pathes, ...
Definition: Canvas5Parser.cxx:1592
std::shared_ptr< Canvas5ParserInternal::State > m_state
the state
Definition: Canvas5Parser.hxx:250
bool readUsed(Canvas5Structure::Stream &stream, std::string const &what)
try to read the used list
Definition: Canvas5Parser.cxx:3300
std::shared_ptr< MWAWRSRCParser > MWAWRSRCParserPtr
a smart pointer of MWAWRSRCParser
Definition: libmwaw_internal.hxx:561
bool readDouble(Canvas5Structure::Stream &stream, double &val, bool &isNaN) const
try to read a double 8
Definition: Canvas5Parser.cxx:2959
bool readLayers(std::shared_ptr< Canvas5Structure::Stream > stream)
try to read the different layers
Definition: Canvas5Parser.cxx:1908
bool readSlides(std::shared_ptr< Canvas5Structure::Stream > stream)
try to read the list of slides
Definition: Canvas5Parser.cxx:2392
int version() const
returns the works version
Definition: MWAWParser.hxx:108
a structure used to store the item data of a Canvas5Parser
Definition: Canvas5Parser.hxx:183
bool readPrinterRsrc(Canvas5Structure::Stream &stream)
try to read a printer rsrc
Definition: Canvas5Parser.cxx:2015
~Canvas5Parser() final
destructor
Definition: Canvas5Parser.cxx:198
a sub stream of Canvas5Structure
Definition: Canvas5Structure.hxx:49
int m_id
the identifier
Definition: Canvas5Parser.hxx:195
bool readMainBlock(std::shared_ptr< Canvas5Structure::Stream > stream)
try to read the first big block
Definition: Canvas5Parser.cxx:458
std::shared_ptr< Canvas5StyleManager > m_styleManager
the style manager
Definition: Canvas5Parser.hxx:256
void parse(librevenge::RVNGDrawingInterface *documentInterface) final
virtual function used to parse the input
Definition: Canvas5Parser.cxx:221
static void defDataFunction(std::shared_ptr< Canvas5Structure::Stream >, Item const &, std::string const &)
the default function to parse the data of a index map/a extended header
Definition: Canvas5Parser.hxx:208
virtual class which defines the ancestor of all graphic zone parser
Definition: MWAWParser.hxx:250
std::shared_ptr< MWAWInputStream > MWAWInputStreamPtr
a smart pointer of MWAWInputStream
Definition: libmwaw_internal.hxx:551
bool checkHeader(MWAWHeader *header, bool strict=false) final
checks if the document header is correct (or not)
Definition: Canvas5Parser.cxx:2718
bool readExtendedHeader(std::shared_ptr< Canvas5Structure::Stream > stream, int expectedValue, std::string const &what, DataFunction const &func)
try to read an extended data header, ie.
Definition: Canvas5Parser.cxx:3039
librevenge::RVNGString getTextLink(int textLinkId) const
returns the link corresponding to a text id
Definition: Canvas5Parser.cxx:208
the main class to read the style part of Canvas 5 file
Definition: Canvas5StyleManager.hxx:85
Item()
constructor
Definition: Canvas5Parser.hxx:185
the main class to read a Canvas 5-10 files (and probably some not password protected Windows 11 files...
Definition: Canvas5Parser.hxx:71
bool readFileRSRCs(std::shared_ptr< Canvas5Structure::Stream > stream)
try to read the third big block: a list of resource?, font, ...
Definition: Canvas5Parser.cxx:619
bool readPicture(Canvas5Structure::Stream &stream, MWAWEntry const &entry)
read the RSRC Pict zone
Definition: Canvas5Parser.cxx:2812
bool checkTAG9(Canvas5Structure::Stream &stream, std::string const &tag, int type)
try to check is the following is a tag: v9
Definition: Canvas5Parser.cxx:3509
basic class to store an entry in a file This contained :
Definition: MWAWEntry.hxx:46
std::function< void(std::shared_ptr< Canvas5Structure::Stream >, Item const &, std::string const &)> DataFunction
a function used to parse the data of a index map/a extended header
Definition: Canvas5Parser.hxx:206
bool readTextLinks(std::shared_ptr< Canvas5Structure::Stream > stream)
try to read the text links
Definition: Canvas5Parser.cxx:2288
std::shared_ptr< Canvas5Image > m_imageParser
the image parser
Definition: Canvas5Parser.hxx:254
bool createZones()
finds the different objects zones
Definition: Canvas5Parser.cxx:381
long m_pos
the data beginning position (may be before the current position: v9)
Definition: Canvas5Parser.hxx:201
int m_decal
the decal position
Definition: Canvas5Parser.hxx:203
bool readArray9(std::shared_ptr< Canvas5Structure::Stream > stream, std::string const &what, DataFunction const &func=&Canvas5Parser::defDataFunction)
try to read an array: v9
Definition: Canvas5Parser.cxx:3357
a namespace used to define basic function or structure to read a Canvas v5-v11 file ...
Definition: Canvas5BMParser.hxx:63
int readInteger(Canvas5Structure::Stream &stream, int fieldSize) const
try to read a int: either a cast a double: fieldSize=8 or a int32/int16
Definition: Canvas5Parser.cxx:2906
bool readDataHeader(Canvas5Structure::Stream &stream, int expectedSize, int &N)
try to read a data header, ie. N fields with a given size
Definition: Canvas5Parser.cxx:3018
bool readPnot(Canvas5Structure::Stream &stream, MWAWEntry const &entry)
read the RSRC 0 pnot zone
Definition: Canvas5Parser.cxx:2784
void createDocument(librevenge::RVNGDrawingInterface *documentInterface)
creates the listener which will be associated to the document
Definition: Canvas5Parser.cxx:253
the main class to read/convert the image or movie inside of Canvas 5-11 files
Definition: Canvas5Image.hxx:77
Canvas5Parser(MWAWInputStreamPtr const &input, MWAWRSRCParserPtr const &rsrcParser, MWAWHeader *header)
constructor
Definition: Canvas5Parser.cxx:179

Generated for libmwaw by doxygen 1.8.14