HMWKParser.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 /*
35  * Parser to convert HanMac Word-K document
36  */
37 #ifndef HMWK_PARSER
38 # define HMWK_PARSER
39 
40 #include <iostream>
41 #include <string>
42 #include <vector>
43 
44 #include <libwpd/libwpd.h>
45 
46 #include "MWAWDebug.hxx"
47 #include "MWAWInputStream.hxx"
48 
49 #include "MWAWParser.hxx"
50 
51 namespace HMWKParserInternal
52 {
53 struct State;
54 class SubDocument;
55 }
56 
58 struct HMWKZone {
62  HMWKZone(shared_ptr<libmwaw::DebugFile> asciiFile);
64  ~HMWKZone();
65 
67  long begin() const {
68  return m_asciiFilePtr ? 0 : m_filePos;
69  }
71  long end() const {
72  return m_asciiFilePtr ? (long) m_data.size() : m_endFilePos;
73  }
75  long length() const {
76  if (m_asciiFilePtr) return (long) m_data.size();
77  return m_endFilePos-m_filePos;
78  }
80  bool valid() const {
81  return length() > 0;
82  }
83 
84  // function to define the zone in the original file
85 
87  long fileBeginPos() const {
88  return m_filePos;
89  }
91  long fileEndPos() const {
92  return m_endFilePos;
93  }
95  void setFileBeginPos(long begPos) {
96  m_filePos = m_endFilePos = begPos;
97  }
99  void setFileLength(long len) {
100  m_endFilePos = m_filePos+len;
101  }
103  void setFilePositions(long begPos, long endPos) {
104  m_filePos = begPos;
105  m_endFilePos = endPos;
106  }
108  WPXBinaryData &getBinaryData() {
109  return m_data;
110  }
112  std::string name() const {
113  return name(m_type);
114  }
116  static std::string name(int type);
117 
119  friend std::ostream &operator<<(std::ostream &o, HMWKZone const &zone);
120 
123  return *m_asciiFile;
124  }
125 
127  int m_type;
128 
130  long m_id;
131 
133  long m_subId;
134 
137 
139  std::string m_extra;
140 
142  mutable bool m_parsed;
143 
144 protected:
146  long m_filePos;
147 
150 
152  WPXBinaryData m_data;
153 
156 
158  shared_ptr<libmwaw::DebugFile> m_asciiFilePtr;
159 
160 private:
161  HMWKZone(HMWKZone const &orig);
162  HMWKZone &operator=(HMWKZone const &orig);
163 };
164 
165 class HMWKGraph;
166 class HMWKText;
167 
173 class HMWKParser : public MWAWParser
174 {
175  friend class HMWKGraph;
176  friend class HMWKText;
178 
179 public:
181  HMWKParser(MWAWInputStreamPtr input, MWAWRSRCParserPtr rsrcParser, MWAWHeader *header);
183  virtual ~HMWKParser();
184 
186  bool checkHeader(MWAWHeader *header, bool strict=false);
187 
188  // the main parse function
189  void parse(WPXDocumentInterface *documentInterface);
190 
191 protected:
193  void init();
194 
196  void createDocument(WPXDocumentInterface *documentInterface);
197 
199  bool createZones();
200 
202  Vec2f getPageLeftTop() const;
203 
205  void newPage(int number);
206 
207  // interface with the text parser
208 
210  bool sendText(long id, long subId, bool asGraphic=false);
211 
213  bool canSendTextAsGraphic(long id, long subId);
214 
215  // interface with the graph parser
216 
218  bool sendZone(long zId);
220  bool getColor(int colId, int patternId, MWAWColor &color) const;
221 
222  //
223  // low level
224  //
225 
227  bool readZonesList();
229  bool readZone(shared_ptr<HMWKZone> zone);
231  shared_ptr<HMWKZone> decodeZone(shared_ptr<HMWKZone> zone);
233  bool readFramesUnkn(shared_ptr<HMWKZone> zone);
235  bool readPrintInfo(HMWKZone &zone);
237  bool readZone6(shared_ptr<HMWKZone> zone);
239  bool readZone8(shared_ptr<HMWKZone> zone);
241  bool readZonea(shared_ptr<HMWKZone> zone);
243  bool readZoneb(HMWKZone &zone);
245  bool readZonec(shared_ptr<HMWKZone> zone);
246 
247 protected:
248  //
249  // data
250  //
252  shared_ptr<HMWKParserInternal::State> m_state;
253 
255  shared_ptr<HMWKGraph> m_graphParser;
256 
258  shared_ptr<HMWKText> m_textParser;
259 };
260 #endif
261 // vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
shared_ptr< HMWKText > m_textParser
the text parser
Definition: HMWKParser.hxx:258
the main class to read a HanMac Word-K file
Definition: HMWKParser.hxx:173
bool readZonec(shared_ptr< HMWKZone > zone)
try to read a unknown zone of type c
Definition: HMWKParser.cxx:879
a function used by MWAWDocument to store the version of document and the input
Definition: MWAWHeader.hxx:47
bool getColor(int colId, int patternId, MWAWColor &color) const
returns the color associated with a pattern
Definition: HMWKParser.cxx:180
std::string m_extra
some extra data
Definition: HMWKParser.hxx:139
long m_subId
the zone subId
Definition: HMWKParser.hxx:133
MWAWInputStreamPtr m_input
the main input
Definition: HMWKParser.hxx:136
the main class to read the text part of HanMac Word file
Definition: HMWKText.hxx:61
an interface used to insert comment in a binary file, written in ascii form (if debug_with_files is n...
Definition: MWAWDebug.hxx:66
libmwaw::DebugFile * m_asciiFile
the debug file
Definition: HMWKParser.hxx:155
bool readZone8(shared_ptr< HMWKZone > zone)
try to read a unknown zone of type 8
Definition: HMWKParser.cxx:744
long m_filePos
the begin of the entry
Definition: HMWKParser.hxx:146
std::string name() const
returns the zone name
Definition: HMWKParser.hxx:112
bool m_parsed
true if the zone is sended
Definition: HMWKParser.hxx:142
bool canSendTextAsGraphic(long id, long subId)
check if we can send a textzone as graphic
Definition: HMWKParser.cxx:168
void newPage(int number)
adds a new page
Definition: HMWKParser.cxx:197
WPXBinaryData & getBinaryData()
returns a pointer to the binary data
Definition: HMWKParser.hxx:108
~HMWKZone()
destructor
Definition: HMWKParser.cxx:1182
bool readZonea(shared_ptr< HMWKZone > zone)
try to read a unknown zone of type a
Definition: HMWKParser.cxx:777
the main class to read the graphic part of a HanMac Word file
Definition: HMWKGraph.hxx:77
the class to store a color
Definition: libmwaw_internal.hxx:166
Small class used to store the decoded zone of HMWKParser.
Definition: HMWKParser.hxx:58
bool sendZone(long zId)
send a zone
Definition: HMWKParser.cxx:173
Internal: the subdocument of a MWParser.
Definition: HMWKParser.cxx:84
void init()
inits all internal variables
Definition: HMWKParser.cxx:146
bool sendText(long id, long subId, bool asGraphic=false)
send a text zone
Definition: HMWKParser.cxx:163
bool readPrintInfo(HMWKZone &zone)
try to read a printinfo zone (type 7)
Definition: HMWKParser.cxx:521
void parse(WPXDocumentInterface *documentInterface)
virtual function used to parse the input
Definition: HMWKParser.cxx:213
bool valid() const
returns true if the zone data exists
Definition: HMWKParser.hxx:80
bool readZone(shared_ptr< HMWKZone > zone)
try to read a generic zone
Definition: HMWKParser.cxx:422
shared_ptr< MWAWRSRCParser > MWAWRSRCParserPtr
a smart pointer of MWAWRSRCParser
Definition: libmwaw_internal.hxx:354
virtual ~HMWKParser()
destructor
Definition: HMWKParser.cxx:142
friend std::ostream & operator<<(std::ostream &o, HMWKZone const &zone)
operator &lt;&lt;
Definition: HMWKParser.cxx:1188
void setFilePositions(long begPos, long endPos)
sets the begin/end file pos
Definition: HMWKParser.hxx:103
int m_type
the type : 1(text), ....
Definition: HMWKParser.hxx:127
HMWKZone(MWAWInputStreamPtr input, libmwaw::DebugFile &asciiFile)
constructor given an input and an asciiFile
Definition: HMWKParser.cxx:1172
shared_ptr< HMWKGraph > m_graphParser
the graph parser
Definition: HMWKParser.hxx:255
void setFileBeginPos(long begPos)
sets the begin file pos
Definition: HMWKParser.hxx:95
libmwaw::DebugFile & ascii()
returns the debug file
Definition: HMWKParser.hxx:122
long m_endFilePos
the end of the entry
Definition: HMWKParser.hxx:149
long fileBeginPos() const
returns the file begin position
Definition: HMWKParser.hxx:87
long fileEndPos() const
returns the file begin position
Definition: HMWKParser.hxx:91
long m_id
the zone id
Definition: HMWKParser.hxx:130
void createDocument(WPXDocumentInterface *documentInterface)
creates the listener which will be associated to the document
Definition: HMWKParser.cxx:250
void setFileLength(long len)
sets the file length
Definition: HMWKParser.hxx:99
shared_ptr< MWAWInputStream > MWAWInputStreamPtr
a smart pointer of MWAWInputStream
Definition: libmwaw_internal.hxx:348
bool readZoneb(HMWKZone &zone)
try to read a unknown zone of type b
Definition: HMWKParser.cxx:821
bool createZones()
finds the different objects zones
Definition: HMWKParser.cxx:297
bool readZone6(shared_ptr< HMWKZone > zone)
try to read a unknown zone of type 6
Definition: HMWKParser.cxx:700
WPXBinaryData m_data
the storage (if needed)
Definition: HMWKParser.hxx:152
HMWKParser(MWAWInputStreamPtr input, MWAWRSRCParserPtr rsrcParser, MWAWHeader *header)
constructor
Definition: HMWKParser.cxx:136
long length() const
returns the zone size
Definition: HMWKParser.hxx:75
long end() const
returns the last position in the input
Definition: HMWKParser.hxx:71
bool checkHeader(MWAWHeader *header, bool strict=false)
checks if the document header is correct (or not)
Definition: HMWKParser.cxx:1069
shared_ptr< HMWKZone > decodeZone(shared_ptr< HMWKZone > zone)
try to decode a zone
Definition: HMWKParser.cxx:962
HMWKZone & operator=(HMWKZone const &orig)
virtual class which defines the ancestor of all main zone parser
Definition: MWAWParser.hxx:89
shared_ptr< libmwaw::DebugFile > m_asciiFilePtr
the file pointer
Definition: HMWKParser.hxx:158
bool readFramesUnkn(shared_ptr< HMWKZone > zone)
try to read a zone storing a list of ?, frameType
Definition: HMWKParser.cxx:631
Vec2f getPageLeftTop() const
returns the page left top point ( in inches)
Definition: HMWKParser.cxx:188
shared_ptr< HMWKParserInternal::State > m_state
the state
Definition: HMWKParser.hxx:252
bool readZonesList()
try to read the zones list
Definition: HMWKParser.cxx:329
long begin() const
returns the first position in the input
Definition: HMWKParser.hxx:67

Generated on Tue Mar 10 2015 17:32:08 for libmwaw by doxygen 1.8.5