MSK3Text.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 Microsoft Works text document
36  *
37  */
38 #ifndef MSK3_TEXT
39 # define MSK3_TEXT
40 
41 #include <list>
42 #include <string>
43 #include <vector>
44 
45 #include "libmwaw_internal.hxx"
46 
47 #include "MWAWEntry.hxx"
48 
49 class MWAWParagraph;
51 typedef shared_ptr<MWAWParserState> MWAWParserStatePtr;
52 
53 namespace MSK3TextInternal
54 {
55 struct Font;
56 struct LineZone;
57 struct TextZone;
58 struct State;
59 }
60 
61 class MSK3Parser;
62 
68 class MSK3Text
69 {
70  friend class MSK3Parser;
71 public:
73  MSK3Text(MSK3Parser &parser);
75  virtual ~MSK3Text();
76 
78  int version() const;
79 
81  int numPages(int zoneId) const;
82 
83 protected:
85  int createZones(int numLines=-1, bool mainZone=false);
86 
87  // reads the header/footer string : version v1-2
88  std::string readHeaderFooterString(bool header);
89 
91  void flushExtra();
92 
94  void sendZone(int zoneId);
95 
97  void sendNote(int zoneId, int noteId);
98 
100  int getHeader() const;
101 
103  int getFooter() const;
104 
106  bool getLinesPagesHeight(int zoneId,
107  std::vector<int> &lines,
108  std::vector<int> &pages);
109 
110  //
111  // low level
112  //
113 
115  bool readZoneHeader(MSK3TextInternal::LineZone &zone) const;
116 
119 
121  void updateNotes(MSK3TextInternal::TextZone &zone, int firstNote);
122 
125  void send(MSK3TextInternal::TextZone &zone, Vec2i limit=Vec2i(-1,-1));
126 
128  bool readFont(MSK3TextInternal::Font &font, long endPos);
129 
132 
134  bool sendText(MSK3TextInternal::LineZone &zone, int zoneId);
135 
137  bool sendString(std::string &str);
138 
139 private:
140  MSK3Text(MSK3Text const &orig);
141  MSK3Text &operator=(MSK3Text const &orig);
142 
143 protected:
144  //
145  // data
146  //
149 
151  shared_ptr<MSK3TextInternal::State> m_state;
152 
155 };
156 #endif
157 // vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
int numPages(int zoneId) const
returns the number of pages
Definition: MSK3Text.cxx:203
bool sendText(MSK3TextInternal::LineZone &zone, int zoneId)
tries to send a text zone
Definition: MSK3Text.cxx:402
shared_ptr< MWAWParserState > MWAWParserStatePtr
Definition: ACText.hxx:49
MSK3Text & operator=(MSK3Text const &orig)
bool getLinesPagesHeight(int zoneId, std::vector< int > &lines, std::vector< int > &pages)
return the lines and pages height ( for v1, ...)
Definition: MSK3Text.cxx:221
MSK3Text(MSK3Parser &parser)
constructor
Definition: MSK3Text.cxx:187
bool readZoneHeader(MSK3TextInternal::LineZone &zone) const
try to read a zone header
Definition: MSK3Text.cxx:382
bool readFont(MSK3TextInternal::Font &font, long endPos)
tries to read a font
Definition: MSK3Text.cxx:537
void updateNotes(MSK3TextInternal::TextZone &zone, int firstNote)
prepare the note zones given a zone and the position of the first note
Definition: MSK3Text.cxx:319
std::string readHeaderFooterString(bool header)
Definition: MSK3Text.cxx:729
the main class to read the text part of Microsoft Works file
Definition: MSK3Text.hxx:68
Vec2< int > Vec2i
Vec2 of int.
Definition: libmwaw_internal.hxx:543
a class to define the parser state
Definition: MWAWParser.hxx:60
Internal: the fonts.
Definition: MSK3Text.cxx:109
int createZones(int numLines=-1, bool mainZone=false)
finds the different text zones. Returns the zoneId or -1.
Definition: MSK3Text.cxx:256
Internal: the text zone.
Definition: MSK3Text.cxx:138
the main class to read a Microsoft Works file
Definition: MSK3Parser.hxx:62
int version() const
returns the file version
Definition: MSK3Text.cxx:196
void flushExtra()
sends the data which have not yet been sent to the listener
Definition: MSK3Text.cxx:856
shared_ptr< MSK3TextInternal::State > m_state
the state
Definition: MSK3Text.hxx:151
MSK3Parser * m_mainParser
the main parser;
Definition: MSK3Text.hxx:154
MWAWParserStatePtr m_parserState
the parser state
Definition: MSK3Text.hxx:148
void sendZone(int zoneId)
send a zone
Definition: MSK3Text.cxx:846
class to store the paragraph properties
Definition: MWAWParagraph.hxx:83
int getFooter() const
returns a footer zone id ( or -1 )
Definition: MSK3Text.cxx:245
int getHeader() const
returns a header zone id ( or -1 )
Definition: MSK3Text.cxx:237
virtual ~MSK3Text()
destructor
Definition: MSK3Text.cxx:193
bool readParagraph(MSK3TextInternal::LineZone &zone, MWAWParagraph &parag)
tries to read a paragraph
Definition: MSK3Text.cxx:599
Internal: header zone.
Definition: MSK3Text.cxx:56
void update(MSK3TextInternal::TextZone &zone)
prepare a zone
Definition: MSK3Text.cxx:295
void send(MSK3TextInternal::TextZone &zone, Vec2i limit=Vec2i(-1,-1))
sends the zone data to the listener.
Definition: MSK3Text.cxx:781
void sendNote(int zoneId, int noteId)
send a note
Definition: MSK3Text.cxx:829
bool sendString(std::string &str)
tries to send a string (for v1-2, header/footer zone)
Definition: MSK3Text.cxx:490

Generated for libmwaw by doxygen 1.8.5