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
51{
52struct DocInfoFieldParser;
53struct State;
54class SubDocument;
55}
56
57class RagTime5Chart;
58class RagTime5Graph;
59class RagTime5Layout;
64class RagTime5Text;
65class 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;
85
86public:
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
98protected:
100 void init();
101
102 //
103 // interface
104 //
105
107 shared_ptr<RagTime5Zone> getDataZone(int dataId) 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);
165 std::vector<RagTime5StructManager::ZoneLink> &listLinks);
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
191 bool readDocInfoClusterData(RagTime5Zone &zone, MWAWEntry const &entry);
200
204 bool readStructData(RagTime5Zone &zone, long endPos, int n, int headerSz,
205 RagTime5StructManager::FieldParser &parser, librevenge::RVNGString const &dataName);
206
212 bool readFixedSizeZone(RagTime5ClusterManager::Link const &link, std::string const &name);
215
217 bool checkClusterList(std::vector<RagTime5StructManager::ZoneLink> const &list);
219 bool checkClusterList(std::vector<int> const &list);
221 void flushExtra();
222
223protected:
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:
basic class to store an entry in a file This contained :
Definition: MWAWEntry.hxx:47
a function used by MWAWDocument to store the version of document
Definition: MWAWHeader.hxx:57
Class to define the position of an object (textbox, picture, ..) in the document.
Definition: MWAWPosition.hxx:48
virtual class which defines the ancestor of all text zone parser
Definition: MWAWParser.hxx:296
the main class to read the chart part of RagTime 56 file
Definition: RagTime5Chart.hxx:74
basic class used to manage RagTime 5/6 zones
Definition: RagTime5ClusterManager.hxx:59
the main class to read the graphic part of RagTime 56 file
Definition: RagTime5Graph.hxx:80
the main class to read the text part of RagTime 56 file
Definition: RagTime5Layout.hxx:73
Internal: the subdocument of a RagTime5Parser.
Definition: RagTime5Parser.cxx:266
the main class to read a RagTime v5 file
Definition: RagTime5Parser.hxx:74
shared_ptr< RagTime5ClusterManager::Cluster > readGraphicCluster(RagTime5Zone &zone, int zoneType)
try to read a graphic cluster (via the graphic manager)
Definition: RagTime5Parser.cxx:370
void parse(librevenge::RVNGTextInterface *documentInterface)
virtual function used to parse the input
Definition: RagTime5Parser.cxx:436
bool readUnicodeStringList(RagTime5ClusterManager::Link const &link, std::map< int, librevenge::RVNGString > &idToStringMap)
try to read a list of unicode string zone
Definition: RagTime5Parser.cxx:896
shared_ptr< RagTime5ClusterManager::Cluster > readSpreadsheetCluster(RagTime5Zone &zone, int zoneType)
try to read a spreadsheet cluster (via the spreadsheet manager)
Definition: RagTime5Parser.cxx:390
bool readLongListWithSize(int dataId, int fSz, std::vector< long > &list, std::string const &zoneName="")
try to read a int/long zone data
Definition: RagTime5Parser.cxx:905
RagTime5ClusterManager::Cluster::Type getClusterType(int zId) const
returns the cluster type corresponding to zone id or C_Unknown (if the zone is not a cluster or was n...
Definition: RagTime5Parser.cxx:407
bool readZoneInfo()
try to read the main zone info zone and the main cluster(and child)
Definition: RagTime5Parser.cxx:649
shared_ptr< RagTime5Spreadsheet > m_spreadsheetParser
the spreadsheet manager
Definition: RagTime5Parser.hxx:239
shared_ptr< RagTime5StyleManager > m_styleManager
the style manager
Definition: RagTime5Parser.hxx:248
bool checkClusterList(std::vector< RagTime5StructManager::ZoneLink > const &list)
check a cluster list
Definition: RagTime5Parser.cxx:1131
bool readClusterZone(RagTime5Zone &zone, int type=-1)
try to read a cluster zone
Definition: RagTime5Parser.cxx:1146
shared_ptr< RagTime5Layout > m_layoutParser
the layout manager
Definition: RagTime5Parser.hxx:235
shared_ptr< RagTime5ParserInternal::State > m_state
the state
Definition: RagTime5Parser.hxx:229
bool readClusterScriptData(RagTime5ClusterManager::ClusterScript &cluster)
try to read the script data
Definition: RagTime5Parser.cxx:1560
bool readStructZone(RagTime5ClusterManager::Cluster &cluster, RagTime5StructManager::FieldParser &parser, int headerSz)
try to read a structured zone
Definition: RagTime5Parser.cxx:1790
shared_ptr< RagTime5StyleManager > getStyleManager()
returns the style manager
Definition: RagTime5Parser.cxx:360
shared_ptr< RagTime5Text > m_textParser
the text manager
Definition: RagTime5Parser.hxx:241
bool readScriptComment(RagTime5Zone &zone)
try to read a script comment zone
Definition: RagTime5Parser.cxx:1482
shared_ptr< RagTime5ClusterManager::Cluster > readChartCluster(RagTime5Zone &zone, int zoneType)
try to read a chart cluster (via the spreadsheet manager)
Definition: RagTime5Parser.cxx:365
shared_ptr< RagTime5StructManager > m_structManager
the structure manager
Definition: RagTime5Parser.hxx:246
bool readListZone(RagTime5ClusterManager::Link const &link)
try to read a list zone
Definition: RagTime5Parser.cxx:1653
shared_ptr< RagTime5Graph > m_graphParser
the graph manager
Definition: RagTime5Parser.hxx:233
RagTime5Parser(MWAWInputStreamPtr input, MWAWRSRCParserPtr rsrcParser, MWAWHeader *header)
constructor
Definition: RagTime5Parser.cxx:317
void newPage(int number)
adds a new page
Definition: RagTime5Parser.cxx:420
bool send(int zoneId, MWAWListenerPtr listener, MWAWPosition const &pos, int partId=0, int part2Id=0)
try to send a cluster zone (mainly unimplemented)
Definition: RagTime5Parser.cxx:2493
shared_ptr< RagTime5ClusterManager::Cluster > readTextCluster(RagTime5Zone &zone, int zoneType)
try to read a text cluster (via the text manager)
Definition: RagTime5Parser.cxx:395
shared_ptr< RagTime5Chart > m_chartParser
the chart manager
Definition: RagTime5Parser.hxx:231
bool readString(RagTime5Zone &zone, std::string &string)
try to read a string zone ( zone with id1=21,id2=23:24)
Definition: RagTime5Parser.cxx:840
bool readClusterGProp(RagTime5ClusterManager::Cluster &cluster)
try to read the cluster with contains main graphic object properties
Definition: RagTime5Parser.cxx:1592
bool findDataZones(MWAWEntry const &entry)
try to create the main data zones list
Definition: RagTime5Parser.cxx:2225
bool readUnknownClusterCData(RagTime5ClusterManager::Cluster &cluster)
try to read the unknown clusterC data
Definition: RagTime5Parser.cxx:1618
shared_ptr< RagTime5Zone > getDataZone(int dataId) const
returns the zone corresponding to a data id (or 0)
Definition: RagTime5Parser.cxx:400
bool readPositions(int posId, std::vector< long > &listPosition)
try to read a positions zone in data
Definition: RagTime5Parser.cxx:954
void init()
inits all internal variables
Definition: RagTime5Parser.cxx:329
bool checkHeader(MWAWHeader *header, bool strict=false)
checks if the document header is correct (or not)
Definition: RagTime5Parser.cxx:2406
shared_ptr< RagTime5ClusterManager::Cluster > readPictureCluster(RagTime5Zone &zone, int zoneType)
try to read a picture cluster (via the graphic manager)
Definition: RagTime5Parser.cxx:385
bool readLongList(RagTime5ClusterManager::Link const &link, std::vector< long > &list)
try to read/get the list of long of a L_LongList
Definition: RagTime5Parser.cxx:945
virtual ~RagTime5Parser()
destructor
Definition: RagTime5Parser.cxx:325
shared_ptr< RagTime5ClusterManager > m_clusterManager
the cluster manager
Definition: RagTime5Parser.hxx:244
shared_ptr< RagTime5ClusterManager > getClusterManager()
returns the cluster manager
Definition: RagTime5Parser.cxx:350
bool readFixedSizeZone(RagTime5ClusterManager::Link const &link, std::string const &name)
try to read a fixed size zone
Definition: RagTime5Parser.cxx:1726
bool createZones()
finds the different objects zones
Definition: RagTime5Parser.cxx:503
bool unpackZone(RagTime5Zone &zone, MWAWEntry const &entry, std::vector< unsigned char > &data)
try to unpack a zone
Definition: RagTime5Parser.cxx:2030
void createDocument(librevenge::RVNGTextInterface *documentInterface)
creates the listener which will be associated to the document
Definition: RagTime5Parser.cxx:468
bool readZoneData(RagTime5Zone &zone)
try to read the zone data
Definition: RagTime5Parser.cxx:731
bool sendZones()
try to send the different zones
Definition: RagTime5Parser.cxx:2477
shared_ptr< RagTime5ClusterManager::Cluster > readLayoutCluster(RagTime5Zone &zone, int zoneType)
try to read a layout cluster (via the layout manager)
Definition: RagTime5Parser.cxx:375
bool update(RagTime5Zone &zone)
try to update a zone: create a new input if the zone is stored in different positions,...
Definition: RagTime5Parser.cxx:1978
bool readClusterRootData(RagTime5ClusterManager::ClusterRoot &cluster)
try to read the main cluster
Definition: RagTime5Parser.cxx:962
void flushExtra()
flush unsent zone (debugging function)
Definition: RagTime5Parser.cxx:2522
bool readStructData(RagTime5Zone &zone, long endPos, int n, int headerSz, RagTime5StructManager::FieldParser &parser, librevenge::RVNGString const &dataName)
try to read a data in a structured zone
Definition: RagTime5Parser.cxx:1886
bool readUnicodeString(RagTime5Zone &zone, std::string const &what="")
try to read a unicode string zone
Definition: RagTime5Parser.cxx:870
shared_ptr< RagTime5Pipeline > m_pipelineParser
the pipeline manager
Definition: RagTime5Parser.hxx:237
bool readClusterFieldsData(RagTime5ClusterManager::Cluster &cluster)
try to read the field data
Definition: RagTime5Parser.cxx:1316
shared_ptr< RagTime5StructManager > getStructManager()
returns the structure manager
Definition: RagTime5Parser.cxx:355
bool readDocInfoClusterData(RagTime5Zone &zone, MWAWEntry const &entry)
try to read the main doc info cluster data
Definition: RagTime5Parser.cxx:1329
bool readClusterLinkList(RagTime5Zone &zone, RagTime5ClusterManager::Link const &link, std::vector< RagTime5StructManager::ZoneLink > &listLinks)
try to read a cluster link zone
Definition: RagTime5Parser.cxx:1239
bool readDocumentVersion(RagTime5Zone &zone)
try to read the document version zone
Definition: RagTime5Parser.cxx:2173
RagTime5ClusterManager::Cluster::Type getPipelineContainerType(int pipelineId) const
try to return the container's type corresponding to an id
Definition: RagTime5Parser.cxx:412
shared_ptr< RagTime5ClusterManager::Cluster > readPipelineCluster(RagTime5Zone &zone, int zoneType)
try to read a pipeline cluster (via the pipeline manager)
Definition: RagTime5Parser.cxx:380
the main class to read the text part of RagTime 56 file
Definition: RagTime5Pipeline.hxx:73
the main class to read the spreadsheet part of RagTime 56 file
Definition: RagTime5Spreadsheet.hxx:76
basic class used to store RagTime 5/6 structures
Definition: RagTime5StructManager.hxx:157
basic class used to read/store RagTime 5/6 styles
Definition: RagTime5StyleManager.hxx:61
the main class to read the text part of RagTime 56 file
Definition: RagTime5Text.hxx:76
main zone in a RagTime v5-v6 document
Definition: RagTime5StructManager.hxx:49
shared_ptr< MWAWListener > MWAWListenerPtr
a smart pointer of MWAWListener
Definition: libmwaw_internal.hxx:505
shared_ptr< MWAWRSRCParser > MWAWRSRCParserPtr
a smart pointer of MWAWRSRCParser
Definition: libmwaw_internal.hxx:513
shared_ptr< MWAWInputStream > MWAWInputStreamPtr
a smart pointer of MWAWInputStream
Definition: libmwaw_internal.hxx:503
Internal: the structures of a RagTime5Parser.
Definition: RagTime5Parser.cxx:71
the cluster for root
Definition: RagTime5ClusterManager.hxx:269
the cluster script ( 2/a/4002/400a zone)
Definition: RagTime5ClusterManager.hxx:307
the cluster data
Definition: RagTime5ClusterManager.hxx:216
Type
the cluster type
Definition: RagTime5ClusterManager.hxx:218
Internal: the helper to read doc info parse.
Definition: RagTime5Parser.cxx:73
virtual class use to parse the unstructured data
Definition: RagTime5StructManager.hxx:347
virtual class use to parse the field data
Definition: RagTime5StructManager.hxx:308

Generated on Wed Jan 19 2022 22:23:17 for libmwaw by doxygen 1.9.3