MsWks4Text.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 MS_WKS4_TEXT
35 # define MS_WKS4_TEXT
36
37 #include <vector>
38
39 #include "MWAWEntry.hxx"
40 #include "MWAWDebug.hxx"
41 #include "MWAWInputStream.hxx"
42
43 namespace MsWks4TextInternal
44 {
45 struct Font;
46 struct Paragraph;
47 struct State;
48 }
49
50 class MsWksDocument;
51 class MsWks4Zone;
52
64 class MsWks4Text
65 {
66 friend class MsWks4Zone;
67 protected:
68 struct DataFOD;
75 typedef bool (MsWks4Text::* FDPParser)(MWAWInputStreamPtr &input, long endPos,
76 int &id, std::string &mess);
77 public:
79 explicit MsWks4Text(MsWksDocument &document);
80
82 ~MsWks4Text();
83
85 void setDefault(MWAWFont &font);
86
88 int numPages() const;
89
91 void flushExtra(MWAWInputStreamPtr /*input*/) {}
92
93 protected:
97 bool readStructures(MWAWInputStreamPtr input, bool mainOle);
98
100 bool readText(MWAWInputStreamPtr input, MWAWEntry const &entry, bool mainOle);
101
103 bool readFootNote(MWAWInputStreamPtr input, int id);
104
105 //----------------------------------------
106 // PLC parsing, setting
107 //----------------------------------------
115 typedef bool (MsWks4Text::* DataParser)
116 (MWAWInputStreamPtr input, long endPos, long bot, long eot, int id, std::string &mess);
117
125 bool readPLC(MWAWInputStreamPtr input, MWAWEntry const &entry,
126 std::vector<long> &textPtrs, std::vector<long> &listValues,
127 DataParser parser = &MsWks4Text::defDataParser);
135 bool readSimplePLC(MWAWInputStreamPtr &input, MWAWEntry const &entry,
136 std::vector<long> &textPtrs,
137 std::vector<long> &listValues)
138 {
139 return readPLC(input, entry, textPtrs, listValues);
140 }
141
143 bool defDataParser(MWAWInputStreamPtr input, long endPos,
144 long bot, long eot, int id, std::string &mess);
145
147 bool readFontNames(MWAWInputStreamPtr input, MWAWEntry const &entry);
148
150 bool readFont(MWAWInputStreamPtr &input, long endPos,
151 int &id, std::string &mess);
152
154 void setProperty(MsWks4TextInternal::Paragraph const &tabs);
156 bool readParagraph(MWAWInputStreamPtr &input, long endPos,
157 int &id, std::string &mess);
158
160 bool ftntDataParser(MWAWInputStreamPtr input, long endPos,
161 long bot, long eot, int id, std::string &mess);
162
164 bool eobjDataParser(MWAWInputStreamPtr input, long endPos,
165 long bot, long eot, int id, std::string &mess);
166
170 bool toknDataParser(MWAWInputStreamPtr input, long endPos,
171 long bot, long eot, int id, std::string &mess);
172
176 bool pgdDataParser(MWAWInputStreamPtr input, long endPos,
177 long, long, int id, std::string &mess);
178
180 void flushNote(int noteId);
181
182 protected:
185 std::vector<DataFOD> mergeSortedLists
186 (std::vector<DataFOD> const &lst1, std::vector<DataFOD> const &lst2) const;
187
190 bool readFDP(MWAWInputStreamPtr &input, MWAWEntry const &entry,
191 std::vector<DataFOD> &fods, FDPParser parser);
192
199 bool findFDPStructures(MWAWInputStreamPtr &input, int which);
207 bool findFDPStructuresByHand(MWAWInputStreamPtr &input, int which);
208
209 protected:
211 struct DataFOD {
218 enum Type { ATTR_TEXT, ATTR_PARAG, ATTR_PLC, ATTR_UNKN };
219
221 DataFOD() : m_type(ATTR_UNKN), m_pos(-1), m_defPos(0), m_id(-1) {}
222
224 Type m_type;
226 long m_pos;
228 long m_defPos;
230 int m_id;
231 };
232
233 private:
234 MsWks4Text(MsWks4Text const &orig);
235 MsWks4Text &operator=(MsWks4Text const &orig);
236 protected:
238 MWAWParser *m_mainParser;
240 MWAWParserStatePtr m_parserState;
241
243 MsWksDocument &m_document;
244
246 MWAWEntry m_textPositions;
247
249 mutable shared_ptr<MsWks4TextInternal::State> m_state;
250
252 std::vector<DataFOD> m_FODsList;
253
255 std::vector<MWAWEntry const *> m_FDPCs;
257 std::vector<MWAWEntry const *> m_FDPPs;
258 };
259
260 #endif
261 // vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
MsWks4Text::DataFOD::m_type
Type m_type
the type of the attribute
Definition: MsWks4Text.hxx:224
MsWks4TextInternal::Paragraph
Internal: class to store a paragraph properties.
Definition: MsWks4Text.cxx:234
MsWks4Text
The class which parses text zones in a mac MS Works document v4.
Definition: MsWks4Text.hxx:64
MWAWEntry.hxx
MsWks4Text::flushExtra
void flushExtra(MWAWInputStreamPtr)
sends the data which have not been sent: actually do nothing
Definition: MsWks4Text.hxx:91
MsWks4TextInternal
Internal: the structures of a MsWks4Text.
Definition: MsWks4Text.cxx:70
MsWks4Text::DataFOD::m_pos
long m_pos
the offset position of the text modified by this attribute
Definition: MsWks4Text.hxx:226
MsWks4Text::DataFOD::m_defPos
long m_defPos
the offset position of the definition of the attribute in the file
Definition: MsWks4Text.hxx:228
MsWks4Text::m_parserState
MWAWParserStatePtr m_parserState
the parser state
Definition: MsWks4Text.hxx:240
MsWks4Text::m_FODsList
std::vector< DataFOD > m_FODsList
the list of a FOD
Definition: MsWks4Text.hxx:252
MWAWFont
Class to store font.
Definition: MWAWFont.hxx:43
MsWks4Text::DataFOD
structure which retrieves data information which correspond to a text position
Definition: MsWks4Text.hxx:211
MsWks4Zone
The class which parses the main zones of a mac MS Works document v4.
Definition: MsWks4Zone.hxx:73
MsWks4Text::defDataParser
bool defDataParser(MWAWInputStreamPtr input, long endPos, long bot, long eot, int id, std::string &mess)
the default parser (does nothing)
Definition: MsWks4Text.cxx:1038
MWAWInputStreamPtr
shared_ptr< MWAWInputStream > MWAWInputStreamPtr
a smart pointer of MWAWInputStream
Definition: libmwaw_internal.hxx:517
MsWks4Text::m_document
MsWksDocument & m_document
the main document
Definition: MsWks4Text.hxx:243
MWAWInputStream.hxx
MWAWDebug.hxx
MsWks4Text::m_textPositions
MWAWEntry m_textPositions
an entry which corresponds to the complete text zone
Definition: MsWks4Text.hxx:246
MWAWParserStatePtr
shared_ptr< MWAWParserState > MWAWParserStatePtr
a smart pointer of MWAWParserState
Definition: libmwaw_internal.hxx:523
MsWks4Text::DataFOD::Type
Type
different type which can be associated to a text position
Definition: MsWks4Text.hxx:218
MsWks4Text::m_FDPPs
std::vector< MWAWEntry const * > m_FDPPs
the list of FDPP entries
Definition: MsWks4Text.hxx:257
MWAWParser
virtual class which defines the ancestor of all main zone parser
Definition: MWAWParser.hxx:99
MsWks4Text::m_mainParser
MWAWParser * m_mainParser
the main parser;
Definition: MsWks4Text.hxx:238
MWAWEntry
basic class to store an entry in a file This contained :
Definition: MWAWEntry.hxx:46
MsWks4Text::readSimplePLC
bool readSimplePLC(MWAWInputStreamPtr &input, MWAWEntry const &entry, std::vector< long > &textPtrs, std::vector< long > &listValues)
reads a PLC (Pointer List Composant ?) in zone entry
Definition: MsWks4Text.hxx:135
MsWks4Text::m_state
shared_ptr< MsWks4TextInternal::State > m_state
the internal state
Definition: MsWks4Text.hxx:249
MsWks4Text::DataFOD::m_id
int m_id
an identificator (which must be unique by category)
Definition: MsWks4Text.hxx:230
MsWks4Text::DataFOD::DataFOD
DataFOD()
the constructor
Definition: MsWks4Text.hxx:221
MsWks4Text::m_FDPCs
std::vector< MWAWEntry const * > m_FDPCs
the list of FDPC entries
Definition: MsWks4Text.hxx:255
MsWksDocument
the main class to read/store generic data of a MsWorks document v1-v3
Definition: MsWksDocument.hxx:68