RagTime5Parser.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 RAG_TIME_5_PARSER
35 # define RAG_TIME_5_PARSER
36 
37 #include <map>
38 #include <string>
39 #include <set>
40 #include <vector>
41 
42 #include "MWAWDebug.hxx"
43 #include "MWAWInputStream.hxx"
44 
45 #include "MWAWParser.hxx"
46 
49 
50 namespace RagTime5ParserInternal
51 {
52 struct DocInfoFieldParser;
53 struct State;
54 class SubDocument;
55 }
56 
57 class RagTime5Chart;
58 class RagTime5Graph;
59 class RagTime5Layout;
60 class RagTime5Pipeline;
64 class RagTime5Text;
65 class RagTime5Zone;
67 
74 {
75  friend class RagTime5Chart;
76  friend class RagTime5Graph;
77  friend class RagTime5Layout;
78  friend class RagTime5Pipeline;
79  friend class RagTime5Spreadsheet;
80  friend class RagTime5Text;
81  friend class RagTime5ClusterManager;
83  friend class RagTime5StyleManager;
85 
86 public:
90  virtual ~RagTime5Parser();
91 
93  bool checkHeader(MWAWHeader *header, bool strict=false);
94 
95  // the main parse function
96  void parse(librevenge::RVNGTextInterface *documentInterface);
97 
98 protected:
100  void init();
101 
102  //
103  // interface
104  //
105 
107  shared_ptr<RagTime5Zone> getDataZone(int dataId) const;
109  RagTime5ClusterManager::Cluster::Type getClusterType(int zId) const;
111  RagTime5ClusterManager::Cluster::Type getPipelineContainerType(int pipelineId) const;
112 
114  shared_ptr<RagTime5ClusterManager> getClusterManager();
116  shared_ptr<RagTime5StructManager> getStructManager();
118  shared_ptr<RagTime5StyleManager> getStyleManager();
119 
121  shared_ptr<RagTime5ClusterManager::Cluster> readChartCluster(RagTime5Zone &zone, int zoneType);
123  shared_ptr<RagTime5ClusterManager::Cluster> readGraphicCluster(RagTime5Zone &zone, int zoneType);
125  shared_ptr<RagTime5ClusterManager::Cluster> readLayoutCluster(RagTime5Zone &zone, int zoneType);
127  shared_ptr<RagTime5ClusterManager::Cluster> readPipelineCluster(RagTime5Zone &zone, int zoneType);
129  shared_ptr<RagTime5ClusterManager::Cluster> readPictureCluster(RagTime5Zone &zone, int zoneType);
131  shared_ptr<RagTime5ClusterManager::Cluster> readSpreadsheetCluster(RagTime5Zone &zone, int zoneType);
133  shared_ptr<RagTime5ClusterManager::Cluster> readTextCluster(RagTime5Zone &zone, int zoneType);
134 
136  void createDocument(librevenge::RVNGTextInterface *documentInterface);
138  bool sendZones();
140  bool send(int zoneId, MWAWListenerPtr listener, MWAWPosition const &pos, int partId=0, int part2Id=0);
141 
143  void newPage(int number);
144 
146  bool createZones();
148  bool findDataZones(MWAWEntry const &entry);
150  bool update(RagTime5Zone &zone);
152  bool readZoneData(RagTime5Zone &zone);
154  bool unpackZone(RagTime5Zone &zone, MWAWEntry const &entry, std::vector<unsigned char> &data);
156  bool unpackZone(RagTime5Zone &zone);
157 
159  bool readZoneInfo();
161  bool readClusterZone(RagTime5Zone &zone, int type=-1);
163  bool readClusterLinkList(RagTime5Zone &zone,
164  RagTime5ClusterManager::Link const &link,
165  std::vector<RagTime5StructManager::ZoneLink> &listLinks);
167  bool readClusterLinkList(RagTime5ClusterManager::Link const &link,
168  RagTime5ClusterManager::Link const &nameLink,
169  std::vector<RagTime5StructManager::ZoneLink> &list, std::string const &name="");
170 
172  bool readString(RagTime5Zone &zone, std::string &string);
174  bool readUnicodeString(RagTime5Zone &zone, std::string const &what="");
176  bool readLongListWithSize(int dataId, int fSz, std::vector<long> &list, std::string const &zoneName="");
178  bool readPositions(int posId, std::vector<long> &listPosition);
180  bool readLongList(RagTime5ClusterManager::Link const &link, std::vector<long> &list);
182  bool readUnicodeStringList(RagTime5ClusterManager::Link const &link, std::map<int, librevenge::RVNGString> &idToStringMap);
183 
185  bool readDocumentVersion(RagTime5Zone &zone);
187  bool readClusterRootData(RagTime5ClusterManager::ClusterRoot &cluster);
189  bool readClusterFieldsData(RagTime5ClusterManager::Cluster &cluster);
191  bool readDocInfoClusterData(RagTime5Zone &zone, MWAWEntry const &entry);
193  bool readClusterScriptData(RagTime5ClusterManager::ClusterScript &cluster);
195  bool readScriptComment(RagTime5Zone &zone);
197  bool readClusterGProp(RagTime5ClusterManager::Cluster &cluster);
199  bool readUnknownClusterCData(RagTime5ClusterManager::Cluster &cluster);
200 
204  bool readStructData(RagTime5Zone &zone, long endPos, int n, int headerSz,
205  RagTime5StructManager::FieldParser &parser, librevenge::RVNGString const &dataName);
206 
208  bool readListZone(RagTime5ClusterManager::Link const &link);
210  bool readListZone(RagTime5ClusterManager::Link const &link, RagTime5StructManager::DataParser &parser);
212  bool readFixedSizeZone(RagTime5ClusterManager::Link const &link, std::string const &name);
214  bool readFixedSizeZone(RagTime5ClusterManager::Link const &link, RagTime5StructManager::DataParser &parser);
215 
217  bool checkClusterList(std::vector<RagTime5StructManager::ZoneLink> const &list);
219  bool checkClusterList(std::vector<int> const &list);
221  void flushExtra();
222 
223 protected:
224 
225  //
226  // data
227  //
229  shared_ptr<RagTime5ParserInternal::State> m_state;
231  shared_ptr<RagTime5Chart> m_chartParser;
233  shared_ptr<RagTime5Graph> m_graphParser;
235  shared_ptr<RagTime5Layout> m_layoutParser;
237  shared_ptr<RagTime5Pipeline> m_pipelineParser;
239  shared_ptr<RagTime5Spreadsheet> m_spreadsheetParser;
241  shared_ptr<RagTime5Text> m_textParser;
242 
244  shared_ptr<RagTime5ClusterManager> m_clusterManager;
246  shared_ptr<RagTime5StructManager> m_structManager;
248  shared_ptr<RagTime5StyleManager> m_styleManager;
249 };
250 #endif
251 // vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
shared_ptr< RagTime5Text > m_textParser
the text manager
Definition: RagTime5Parser.hxx:241
shared_ptr< MWAWListener > MWAWListenerPtr
a smart pointer of MWAWListener
Definition: libmwaw_internal.hxx:519
a function used by MWAWDocument to store the version of document
Definition: MWAWHeader.hxx:56
shared_ptr< RagTime5Graph > m_graphParser
the graph manager
Definition: RagTime5Parser.hxx:233
void parse(MWAWListenerPtr &listener, libmwaw::SubDocumentType type)
the parser function
Definition: RagTime5Parser.cxx:291
Internal: the helper to read doc info parse.
Definition: RagTime5Parser.cxx:73
the main class to read the text part of RagTime 56 file
Definition: RagTime5Pipeline.hxx:72
the cluster script ( 2/a/4002/400a zone)
Definition: RagTime5ClusterManager.hxx:307
the main class to read the graphic part of RagTime 56 file
Definition: RagTime5Graph.hxx:79
basic class used to read/store RagTime 5/6 styles
Definition: RagTime5StyleManager.hxx:60
shared_ptr< RagTime5ClusterManager > m_clusterManager
the cluster manager
Definition: RagTime5Parser.hxx:244
virtual class use to parse the field data
Definition: RagTime5StructManager.hxx:308
main zone in a RagTime v5-v6 document
Definition: RagTime5StructManager.hxx:48
the cluster for root
Definition: RagTime5ClusterManager.hxx:269
Internal: the structures of a RagTime5Parser.
Definition: RagTime5Parser.cxx:70
Internal: the subdocument of a RagTime5Parser.
Definition: RagTime5Parser.cxx:265
the main class to read the spreadsheet part of RagTime 56 file
Definition: RagTime5Spreadsheet.hxx:75
shared_ptr< MWAWRSRCParser > MWAWRSRCParserPtr
a smart pointer of MWAWRSRCParser
Definition: libmwaw_internal.hxx:527
virtual class use to parse the unstructured data
Definition: RagTime5StructManager.hxx:347
shared_ptr< RagTime5Spreadsheet > m_spreadsheetParser
the spreadsheet manager
Definition: RagTime5Parser.hxx:239
basic class used to manage RagTime 5/6 zones
Definition: RagTime5ClusterManager.hxx:58
virtual class which defines the ancestor of all text zone parser
Definition: MWAWParser.hxx:295
the main class to read a RagTime v5 file
Definition: RagTime5Parser.hxx:73
the main class to read the text part of RagTime 56 file
Definition: RagTime5Text.hxx:75
shared_ptr< MWAWInputStream > MWAWInputStreamPtr
a smart pointer of MWAWInputStream
Definition: libmwaw_internal.hxx:517
the main class to read the chart part of RagTime 56 file
Definition: RagTime5Chart.hxx:73
shared_ptr< RagTime5Layout > m_layoutParser
the layout manager
Definition: RagTime5Parser.hxx:235
shared_ptr< RagTime5StyleManager > m_styleManager
the style manager
Definition: RagTime5Parser.hxx:248
shared_ptr< RagTime5Chart > m_chartParser
the chart manager
Definition: RagTime5Parser.hxx:231
the main class to read the text part of RagTime 56 file
Definition: RagTime5Layout.hxx:72
Type
the cluster type
Definition: RagTime5ClusterManager.hxx:218
shared_ptr< RagTime5StructManager > m_structManager
the structure manager
Definition: RagTime5Parser.hxx:246
Class to define the position of an object (textbox, picture, ..) in the document. ...
Definition: MWAWPosition.hxx:47
basic class to store an entry in a file This contained :
Definition: MWAWEntry.hxx:46
basic class used to store RagTime 5/6 structures
Definition: RagTime5StructManager.hxx:156
shared_ptr< RagTime5Pipeline > m_pipelineParser
the pipeline manager
Definition: RagTime5Parser.hxx:237
shared_ptr< RagTime5ParserInternal::State > m_state
the state
Definition: RagTime5Parser.hxx:229
the cluster data
Definition: RagTime5ClusterManager.hxx:216
bool readStructZone(MWAWParserState &parserState, char const *zoneName, bool hasEntete)
try to read a structured zone with unknown content
Definition: ClarisWksStruct.cxx:129

Generated on Sat Oct 28 2017 21:17:44 for libmwaw by doxygen 1.8.13