MacWrtProStructures.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 MAC_WRT_PRO_STRUCTURES
35 # define MAC_WRT_PRO_STRUCTURES
36 
37 #include <string>
38 #include <vector>
39 
40 #include "MWAWDebug.hxx"
41 #include "MWAWEntry.hxx"
42 #include "MWAWInputStream.hxx"
43 #include "MWAWPosition.hxx"
44 #include "MWAWStream.hxx"
45 
46 class MacWrtProParser;
47 
49 {
50 class SubDocument;
51 }
52 
54 {
55 struct Graphic;
56 struct Page;
57 struct Cell;
58 struct Font;
59 struct Paragraph;
60 struct Section;
61 struct State;
62 class SubDocument;
63 }
64 
66 
70 {
71 public:
73  MacWrtProStructuresListenerState(std::shared_ptr<MacWrtProStructures> const &structures, bool mainZone, int version);
76 
78  bool isSent(int graphicId);
80  bool send(int graphicId);
81 
83  void sendSection(int numSection);
85  bool sendFont(int id);
87  bool sendParagraph(int id);
89  void sendChar(char c);
90 
92  int numSection() const
93  {
94  if (!m_isMainZone) {
95  MWAW_DEBUG_MSG(("MacWrtProStructuresListenerState::numSection: not called in main zone\n"));
96  return 0;
97  }
98  return m_section;
99  }
100 
102  std::vector<int> getPageBreaksPos() const;
104  void insertSoftPageBreak();
105 
106 protected:
108  bool newPage(bool softBreak=false);
109 
110  // true if this is the mainZone
112  // the file version
114  // the actual page
116  // the actual tab
117  int m_actTab;
118  // the number of tab
119  int m_numTab;
120  // the actual section ( if mainZone )
122  // the actual number of columns
124  // a flag to know if a new page has just been open
126  // the main structure parser
127  std::shared_ptr<MacWrtProStructures> m_structures;
128 };
129 
136 {
137  friend class MacWrtProParser;
141 public:
143  explicit MacWrtProStructures(MacWrtProParser &mainParser);
145  virtual ~MacWrtProStructures();
146 
150  int version() const;
151 
152 protected:
154  void init();
155 
157  bool createZones(std::shared_ptr<MWAWStream> &stream, int numPages);
158 
163  bool createZonesII(std::shared_ptr<MWAWStream> &stream, int numPages);
164 
166  int numPages() const;
167 
169  bool sendMainZone();
170 
172  void updatePageSpan(int page, bool hasTitlePage, MWAWPageSpan &pageSpan);
173 
175  void flushExtra();
176 
178  void buildPageStructures();
179 
181  void buildTableStructures();
182 
183  //
184  // low level
185  //
186 
188  bool readStyles(std::shared_ptr<MWAWStream> &stream);
189 
191  bool readStyle(std::shared_ptr<MWAWStream> &stream, int styleId);
192 
194  bool readCharStyles(std::shared_ptr<MWAWStream> &stream);
195 
197  bool readParagraphs(std::shared_ptr<MWAWStream> &stream);
198 
200  bool readParagraph(std::shared_ptr<MWAWStream> &stream, MacWrtProStructuresInternal::Paragraph &para);
201 
203  bool readGraphicsList(std::shared_ptr<MWAWStream> &stream, int nuumPages);
205  std::shared_ptr<MacWrtProStructuresInternal::Graphic> readGraphic(std::shared_ptr<MWAWStream> &stream);
206 
208  bool readPagesListII(std::shared_ptr<MWAWStream> const &stream, int numPages);
210  bool readPageII(std::shared_ptr<MWAWStream> const &stream, int wh, MacWrtProStructuresInternal::Page &page);
212  bool readGraphicII(std::shared_ptr<MWAWStream> const &stream, int id, bool mainGraphic, MacWrtProStructuresInternal::Graphic &graphic);
213 
215  bool readFontsName(std::shared_ptr<MWAWStream> &stream);
216 
218  bool readFontsDef(std::shared_ptr<MWAWStream> &stream);
219 
221  bool readFont(std::shared_ptr<MWAWStream> &stream, MacWrtProStructuresInternal::Font &font);
222 
224  bool readSections(std::shared_ptr<MWAWStream> &stream, std::vector<MacWrtProStructuresInternal::Section> &sections);
225 
227  bool readSelection(std::shared_ptr<MWAWStream> &stream);
228 
230  bool readStructB(std::shared_ptr<MWAWStream> &stream);
231 
233  static bool readString(MWAWInputStreamPtr input, std::string &res);
234 
236  bool getColor(int colId, MWAWColor &color) const;
237 
239  bool getPattern(int patId, float &patternPercent) const;
240 
242  bool getColor(int colId, int patId, MWAWColor &color) const;
243 
245  bool isSent(int graphicId);
246 
251  bool send(int graphicId, bool mainZone=false);
252 
255 
256 protected:
257  //
258  // data
259  //
260 
263 
266 
268  std::shared_ptr<MacWrtProStructuresInternal::State> m_state;
269 
271  std::string m_asciiName;
272 };
273 #endif
274 // vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
std::shared_ptr< MWAWTextListener > MWAWTextListenerPtr
a smart pointer of MWAWTextListener
Definition: libmwaw_internal.hxx:567
bool sendParagraph(int id)
try to send a paragraph
Definition: MacWrtProStructures.cxx:3028
MacWrtProParser & m_mainParser
the main parser
Definition: MacWrtProStructures.hxx:265
std::shared_ptr< MWAWParserState > MWAWParserStatePtr
a smart pointer of MWAWParserState
Definition: libmwaw_internal.hxx:557
the main class to read the structures part of MacWrite Pro file
Definition: MacWrtProStructures.hxx:135
bool readStyles(std::shared_ptr< MWAWStream > &stream)
try to read the paragraph styles zone which begins at address 0x200
Definition: MacWrtProStructures.cxx:1738
bool readFont(std::shared_ptr< MWAWStream > &stream, MacWrtProStructuresInternal::Font &font)
try to read a font
Definition: MacWrtProStructures.cxx:1356
void sendChar(char c)
send a character
Definition: MacWrtProStructures.cxx:2939
bool isSent(int graphicId)
returns true if the graphic is already sent ( or does not exists)
Definition: MacWrtProStructures.cxx:2677
std::shared_ptr< MacWrtProStructuresInternal::Graphic > readGraphic(std::shared_ptr< MWAWStream > &stream)
try to read a graphic entry: 1.0, 1.5
Definition: MacWrtProStructures.cxx:2162
bool readCharStyles(std::shared_ptr< MWAWStream > &stream)
try to read the character styles zone
Definition: MacWrtProStructures.cxx:1650
A class which defines the page properties.
Definition: MWAWPageSpan.hxx:98
bool readFontsDef(std::shared_ptr< MWAWStream > &stream)
try to read the list of fonts
Definition: MacWrtProStructures.cxx:1309
bool newPage(bool softBreak=false)
create a new page
Definition: MacWrtProStructures.cxx:2885
bool createZones(std::shared_ptr< MWAWStream > &stream, int numPages)
finds the different objects zones
Definition: MacWrtProStructures.cxx:921
int m_numCols
Definition: MacWrtProStructures.hxx:123
bool readStructB(std::shared_ptr< MWAWStream > &stream)
try to read a zone which follow the fonts zone(checkme)
Definition: MacWrtProStructures.cxx:2633
MacWrtProStructuresListenerState(std::shared_ptr< MacWrtProStructures > const &structures, bool mainZone, int version)
the constructor
Definition: MacWrtProStructures.cxx:2838
void buildTableStructures()
look for tables structures and if so, prepare data
Definition: MacWrtProStructures.cxx:1186
void sendSection(int numSection)
try to send the i^th section
Definition: MacWrtProStructures.cxx:3043
int numSection() const
returns the actual section
Definition: MacWrtProStructures.hxx:92
~MacWrtProStructuresListenerState()
the destructor
Definition: MacWrtProStructures.cxx:2859
bool readPagesListII(std::shared_ptr< MWAWStream > const &stream, int numPages)
try to parse the list of page: II
Definition: MacWrtProStructures.cxx:1874
void insertSoftPageBreak()
insert a page break ( if we are not on a new page )
Definition: MacWrtProStructures.cxx:2879
int numPages() const
returns the number of pages
Definition: MacWrtProStructures.cxx:763
int m_actPage
Definition: MacWrtProStructures.hxx:115
int version() const
returns the file version.
Definition: MacWrtProStructures.cxx:751
bool readGraphicII(std::shared_ptr< MWAWStream > const &stream, int id, bool mainGraphic, MacWrtProStructuresInternal::Graphic &graphic)
try to read a graphic structure: II
Definition: MacWrtProStructures.cxx:1949
Internal: the subdocument of a MacWrtProParser.
Definition: MacWrtProParser.cxx:254
bool readParagraph(std::shared_ptr< MWAWStream > &stream, MacWrtProStructuresInternal::Paragraph &para)
try to read a paragraph
Definition: MacWrtProStructures.cxx:1494
int m_actTab
Definition: MacWrtProStructures.hxx:117
bool m_newPageDone
Definition: MacWrtProStructures.hxx:125
void init()
inits all internal variables
Definition: MacWrtProStructures.cxx:746
Internal: a page.
Definition: MacWrtProStructures.cxx:398
the class to store a color
Definition: libmwaw_internal.hxx:192
Internal: the graphic structure.
Definition: MacWrtProStructures.cxx:61
bool readFontsName(std::shared_ptr< MWAWStream > &stream)
try to read the fonts zone
Definition: MacWrtProStructures.cxx:1243
void flushExtra()
flush not send zones
Definition: MacWrtProStructures.cxx:2774
bool send(int graphicId, bool mainZone=false)
try to send a graphic which corresponds to graphicid
Definition: MacWrtProStructures.cxx:2688
static bool readString(MWAWInputStreamPtr input, std::string &res)
try to read a string
Definition: MacWrtProStructures.cxx:2600
#define MWAW_DEBUG_MSG(M)
Definition: libmwaw_internal.hxx:129
bool sendFont(int id)
try to send a character style
Definition: MacWrtProStructures.cxx:3014
bool getPattern(int patId, float &patternPercent) const
try to return the pattern corresponding to patId
Definition: MacWrtProStructures.cxx:880
std::shared_ptr< MacWrtProStructures > m_structures
Definition: MacWrtProStructures.hxx:127
bool readSections(std::shared_ptr< MWAWStream > &stream, std::vector< MacWrtProStructuresInternal::Section > &sections)
try to read the section info ?
Definition: MacWrtProStructures.cxx:2437
void buildPageStructures()
look for pages structures
Definition: MacWrtProStructures.cxx:1121
Internal: the fonts.
Definition: MacWrtProStructures.cxx:428
Internal: the cell of a MacWrtProStructure.
Definition: MacWrtProStructures.cxx:495
bool isSent(int graphicId)
returns true if the graphic is already sent ( or does not exists)
Definition: MacWrtProStructures.cxx:2863
virtual ~MacWrtProStructures()
destructor
Definition: MacWrtProStructures.cxx:742
bool createZonesII(std::shared_ptr< MWAWStream > &stream, int numPages)
finds the different objects zones in a MacWriteII file
Definition: MacWrtProStructures.cxx:1024
std::vector< int > getPageBreaksPos() const
return a list of page break position ( as some page break are soft )
Definition: MacWrtProStructures.cxx:2916
bool readSelection(std::shared_ptr< MWAWStream > &stream)
try to read a 16 bytes the zone which follow the char styles zone ( the selection?)
Definition: MacWrtProStructures.cxx:2561
an interface to transmit the info of MacWrtProStructures to a listener
Definition: MacWrtProStructures.hxx:69
std::shared_ptr< MWAWInputStream > MWAWInputStreamPtr
a smart pointer of MWAWInputStream
Definition: libmwaw_internal.hxx:551
int m_version
Definition: MacWrtProStructures.hxx:113
bool readStyle(std::shared_ptr< MWAWStream > &stream, int styleId)
try to read a style
Definition: MacWrtProStructures.cxx:1780
std::string m_asciiName
the debug file name
Definition: MacWrtProStructures.hxx:271
Internal: class to store the paragraph properties.
Definition: MacWrtProStructures.cxx:467
MWAWParserStatePtr m_parserState
the parser state
Definition: MacWrtProStructures.hxx:262
bool readGraphicsList(std::shared_ptr< MWAWStream > &stream, int nuumPages)
try to read the list of graphic entries: 1.0 1.5
Definition: MacWrtProStructures.cxx:2076
std::shared_ptr< MacWrtProStructuresInternal::State > m_state
the state
Definition: MacWrtProStructures.hxx:268
void updatePageSpan(int page, bool hasTitlePage, MWAWPageSpan &pageSpan)
update the page span
Definition: MacWrtProStructures.cxx:770
MacWrtProStructures(MacWrtProParser &mainParser)
constructor
Definition: MacWrtProStructures.cxx:733
int m_section
Definition: MacWrtProStructures.hxx:121
MWAWTextListenerPtr & getTextListener()
returns the actual listener
Definition: MacWrtProStructures.cxx:758
the main class to read a MacWrite II and MacWrite Pro file
Definition: MacWrtProParser.hxx:67
bool sendMainZone()
send the main zone
Definition: MacWrtProStructures.cxx:1091
Internal: the structures of a MacWrtProParser.
Definition: MacWrtProParser.cxx:61
bool m_isMainZone
Definition: MacWrtProStructures.hxx:111
Internal: the structures of a MacWrtProStructures.
Definition: MacWrtProStructures.cxx:58
bool readPageII(std::shared_ptr< MWAWStream > const &stream, int wh, MacWrtProStructuresInternal::Page &page)
try to read a page entry: II
Definition: MacWrtProStructures.cxx:1894
int m_numTab
Definition: MacWrtProStructures.hxx:119
bool send(int graphicId)
try to send a graphic which corresponds to graphicid
Definition: MacWrtProStructures.cxx:2869
bool readParagraphs(std::shared_ptr< MWAWStream > &stream)
try to read a list of paragraph
Definition: MacWrtProStructures.cxx:1444
bool getColor(int colId, MWAWColor &color) const
try to return the color corresponding to colId
Definition: MacWrtProStructures.cxx:822

Generated for libmwaw by doxygen 1.8.14