MsWrdText.hxx Source File documentation

MsWrdText.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 Word text document
36 *
37 */
38 #ifndef MS_WRD_MWAW_TEXT
39 # define MS_WRD_MWAW_TEXT
40
41 #include <map>
42 #include <string>
43 #include <vector>
44
45 #include "libmwaw_internal.hxx"
46
47 #include "MWAWEntry.hxx"
48
49 #include "MWAWDebug.hxx"
50
51 #include "MsWrdTextStyles.hxx"
52
53 namespace MsWrdTextInternal
54 {
55 struct State;
56 struct Table;
57 }
58
59 struct MsWrdEntry;
60 class MsWrdParser;
61 class MsWrdTextStyles;
62
64 class MsWrdText
65 {
66 friend class MsWrdParser;
67 friend class MsWrdTextStyles;
68 public:
70 struct PLC {
71 enum Type { TextPosition, HeaderFooter, Page, Section, ParagraphInfo, Paragraph, Font, Footnote, FootnoteDef, Field, Object };
72 PLC(Type type, int id=0) : m_type(type), m_id(id), m_extra("")
73 {
74 }
76 friend std::ostream &operator<<(std::ostream &o, PLC const &plc);
78 struct ltstr {
79 bool operator()(PLC const &s1, PLC const &s2) const
80 {
81 if (s1.m_type != s2.m_type)
82 return int(s1.m_type) < int(s2.m_type);
83 if (s1.m_id != s2.m_id)
84 return s1.m_id < s2.m_id;
85 return false;
86 }
87 };
89 Type m_type;
91 int m_id;
93 std::string m_extra;
94 };
95 public:
97 explicit MsWrdText(MsWrdParser &parser);
99 virtual ~MsWrdText();
100
102 int version() const;
103
105 int numPages() const;
106
108 MWAWEntry getHeader() const;
109
111 MWAWEntry getFooter() const;
112 protected:
114 shared_ptr<MWAWParserState> &getParserState()
115 {
116 return m_parserState;
117 }
118
120 bool sendMainText();
121
123 bool sendText(MWAWEntry const &textEntry, bool mainZone, bool tableCell=false);
125 bool sendSection(int sectionId);
127 bool readHeaderTextLength();
128
130 bool createZones(long bot);
131
133 bool readTextStruct(MsWrdEntry &entry);
134
136 bool readPageBreak(MsWrdEntry &entry);
137
139 bool readParagraphInfo(MsWrdEntry &entry);
140
142 bool readFields(MsWrdEntry &entry, std::vector<long> const &fieldPos);
143
145 bool sendFieldComment(int id);
146
148 bool readFootnotesPos(MsWrdEntry &entry, std::vector<long> const &noteDef);
149
151 bool readFootnotesData(MsWrdEntry &entry);
152
154 bool sendFootnote(int id);
155
157 bool readFontNames(MsWrdEntry &entry);
158
160 void flushExtra();
161
163 bool sendTable(MsWrdTextInternal::Table const &table);
164
165 // interface with MsWrdTextStyles
166
168 long getMainTextLength() const;
170 std::multimap<long, MsWrdText::PLC> &getTextPLCMap();
172 std::multimap<long, MsWrdText::PLC> &getFilePLCMap();
173
174 //
175 // low level
176 //
177
179 void prepareData();
180
182 void prepareLines();
184 void convertFilePLCPos();
186 void prepareParagraphProperties();
188 void prepareFontProperties();
189
191 void prepareTableLimits();
193 bool updateTableBeginnningAt(long cPos, long &nextCPos);
194
196 bool readLongZone(MsWrdEntry &entry, int sz, std::vector<long> &list);
197
198 private:
199 MsWrdText(MsWrdText const &orig);
200 MsWrdText &operator=(MsWrdText const &orig);
201
202 protected:
203 //
204 // data
205 //
207 MWAWParserStatePtr m_parserState;
208
210 shared_ptr<MsWrdTextInternal::State> m_state;
211
213 shared_ptr<MsWrdTextStyles> m_stylesManager;
214
216 MsWrdParser *m_mainParser;
217 };
218 #endif
219 // vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
MsWrdText::PLC::m_extra
std::string m_extra
some extra data
Definition: MsWrdText.hxx:93
BeagleWksDRParserInternal::operator<<
std::ostream & operator<<(std::ostream &o, Shape const &shape)
Definition: BeagleWksDRParser.cxx:98
MWAWEntry.hxx
libmwaw_internal.hxx
MsWrdText::getParserState
shared_ptr< MWAWParserState > & getParserState()
returns the parser state
Definition: MsWrdText.hxx:114
MsWrdEntry
the entry of MsWrdParser
Definition: MsWrdParser.hxx:63
MsWrdText::PLC
Internal: the plc.
Definition: MsWrdText.hxx:70
MsWrdTextStyles.hxx
MsWrdTextInternal::Table
Internal and low level: a structure to store a table of a MsWrdText.
Definition: MsWrdText.cxx:262
MsWrdText::PLC::Type
Type
Definition: MsWrdText.hxx:71
MsWrdText::m_state
shared_ptr< MsWrdTextInternal::State > m_state
the state
Definition: MsWrdText.hxx:210
MsWrdText::PLC::ltstr::operator()
bool operator()(PLC const &s1, PLC const &s2) const
Definition: MsWrdText.hxx:79
MsWrdText::PLC::m_id
int m_id
the identificator
Definition: MsWrdText.hxx:91
MsWrdText::m_parserState
MWAWParserStatePtr m_parserState
the parser state
Definition: MsWrdText.hxx:207
MsWrdParser
the main class to read a Microsoft Word file
Definition: MsWrdParser.hxx:94
MsWrdText::PLC::m_type
Type m_type
the plc type
Definition: MsWrdText.hxx:89
MWAWDebug.hxx
MsWrdTextInternal
Internal: the structures of a MsWrdText.
Definition: MsWrdText.cxx:69
MsWrdText
the main class to read the text part of Microsoft Word file
Definition: MsWrdText.hxx:64
MsWrdTextStyles
the main class to read/store the text font, paragraph, section stylesread
Definition: MsWrdTextStyles.hxx:66
MsWrdText::m_mainParser
MsWrdParser * m_mainParser
the main parser;
Definition: MsWrdText.hxx:216
MsWrdText::PLC::ltstr
a comparaison structure
Definition: MsWrdText.hxx:78
MWAWParserStatePtr
shared_ptr< MWAWParserState > MWAWParserStatePtr
a smart pointer of MWAWParserState
Definition: libmwaw_internal.hxx:509
MWAWEntry
basic class to store an entry in a file This contained :
Definition: MWAWEntry.hxx:46
MWAWDocumentInternal::getHeader
MWAWHeader * getHeader(MWAWInputStreamPtr &input, MWAWRSRCParserPtr rsrcParser, bool strict)
return the header corresponding to an input.
Definition: MWAWDocument.cxx:436
MsWrdText::m_stylesManager
shared_ptr< MsWrdTextStyles > m_stylesManager
the style manager
Definition: MsWrdText.hxx:213
MsWrdText::PLC::PLC
PLC(Type type, int id=0)
Definition: MsWrdText.hxx:72