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)
73 : m_type(type)
74 , m_id(id)
75 , m_extra("")
76 {
77 }
79 friend std::ostream &operator<<(std::ostream &o, PLC const &plc);
81 struct ltstr {
82 bool operator()(PLC const &s1, PLC const &s2) const
83 {
84 if (s1.m_type != s2.m_type)
85 return int(s1.m_type) < int(s2.m_type);
86 if (s1.m_id != s2.m_id)
87 return s1.m_id < s2.m_id;
88 return false;
89 }
90 };
92 Type m_type;
94 int m_id;
96 std::string m_extra;
97 };
98 public:
100 explicit MsWrdText(MsWrdParser &parser);
102 virtual ~MsWrdText();
103
105 int version() const;
106
108 int numPages() const;
109
111 MWAWEntry getHeader() const;
112
114 MWAWEntry getFooter() const;
115 protected:
117 std::shared_ptr<MWAWParserState> &getParserState()
118 {
119 return m_parserState;
120 }
121
123 bool sendMainText();
124
126 bool sendText(MWAWEntry const &textEntry, bool mainZone, bool tableCell=false);
128 bool sendSection(int sectionId);
130 bool readHeaderTextLength();
131
133 bool createZones(long bot);
134
136 bool readTextStruct(MsWrdEntry &entry);
137
139 bool readPageBreak(MsWrdEntry &entry);
140
142 bool readParagraphInfo(MsWrdEntry &entry);
143
145 bool readFields(MsWrdEntry &entry, std::vector<long> const &fieldPos);
146
148 bool sendFieldComment(int id);
149
151 bool readFootnotesPos(MsWrdEntry &entry, std::vector<long> const &noteDef);
152
154 bool readFootnotesData(MsWrdEntry &entry);
155
157 bool sendFootnote(int id);
158
160 bool readFontNames(MsWrdEntry &entry);
161
163 void flushExtra();
164
166 bool sendTable(MsWrdTextInternal::Table const &table);
167
168 // interface with MsWrdTextStyles
169
171 long getMainTextLength() const;
173 std::multimap<long, MsWrdText::PLC> &getTextPLCMap();
175 std::multimap<long, MsWrdText::PLC> &getFilePLCMap();
176
177 //
178 // low level
179 //
180
182 void prepareData();
183
185 void prepareLines();
187 void convertFilePLCPos();
189 void prepareParagraphProperties();
191 void prepareFontProperties();
192
194 void prepareTableLimits();
196 bool updateTableBeginnningAt(long cPos, long &nextCPos);
197
199 bool readLongZone(MsWrdEntry &entry, int sz, std::vector<long> &list);
200
201 private:
202 MsWrdText(MsWrdText const &orig) = delete;
203 MsWrdText &operator=(MsWrdText const &orig) = delete;
204
205 protected:
206 //
207 // data
208 //
210 MWAWParserStatePtr m_parserState;
211
213 std::shared_ptr<MsWrdTextInternal::State> m_state;
214
216 std::shared_ptr<MsWrdTextStyles> m_stylesManager;
217
219 MsWrdParser *m_mainParser;
220 };
221 #endif
222 // vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
MsWrdText::readTextStruct
bool readTextStruct(MsWrdEntry &entry)
read the text structure(some paragraph style+some text position?)
Definition: MsWrdText.cxx:744
MsWrdText::PLC::m_extra
std::string m_extra
some extra data
Definition: MsWrdText.hxx:96
MsWrdText::PLC::HeaderFooter
Definition: MsWrdText.hxx:71
MsWrdText::prepareLines
void prepareLines()
cut the text in line/cell pos
Definition: MsWrdText.cxx:1274
MsWrdText::m_stylesManager
std::shared_ptr< MsWrdTextStyles > m_stylesManager
the style manager
Definition: MsWrdText.hxx:216
MsWrdText::sendText
bool sendText(MWAWEntry const &textEntry, bool mainZone, bool tableCell=false)
send a text zone
Definition: MsWrdText.cxx:1883
MWAWParserStatePtr
std::shared_ptr< MWAWParserState > MWAWParserStatePtr
a smart pointer of MWAWParserState
Definition: libmwaw_internal.hxx:555
MsWrdText::PLC::TextPosition
Definition: MsWrdText.hxx:71
MWAWEntry.hxx
libmwaw_internal.hxx
MsWrdText::prepareFontProperties
void prepareFontProperties()
retrieve the font properties
Definition: MsWrdText.cxx:1521
MsWrdText::PLC::Font
Definition: MsWrdText.hxx:71
MsWrdText::numPages
int numPages() const
returns the number of pages
Definition: MsWrdText.cxx:486
MsWrdText::sendSection
bool sendSection(int sectionId)
try to open a section
Definition: MsWrdText.cxx:2093
MsWrdText::getTextPLCMap
std::multimap< long, MsWrdText::PLC > & getTextPLCMap()
returns the text correspondance zone ( textpos, plc )
Definition: MsWrdText.cxx:543
MsWrdText::sendFootnote
bool sendFootnote(int id)
send a note to a listener
Definition: MsWrdText.cxx:2184
MsWrdText::PLC::Section
Definition: MsWrdText.hxx:71
MsWrdText::readParagraphInfo
bool readParagraphInfo(MsWrdEntry &entry)
read the paragraph height info
Definition: MsWrdText.cxx:907
MsWrdEntry
the entry of MsWrdParser
Definition: MsWrdParser.hxx:63
MsWrdText::sendFieldComment
bool sendFieldComment(int id)
send a field note to a listener
Definition: MsWrdText.cxx:2202
MsWrdText::readHeaderTextLength
bool readHeaderTextLength()
reads the three different zone size
Definition: MsWrdText.cxx:604
MsWrdText::PLC::FootnoteDef
Definition: MsWrdText.hxx:71
MsWrdText::getHeader
MWAWEntry getHeader() const
returns the header entry
Definition: MsWrdText.cxx:497
MsWrdText::prepareParagraphProperties
void prepareParagraphProperties()
retrieve the paragraph properties
Definition: MsWrdText.cxx:1429
MsWrdText::readFields
bool readFields(MsWrdEntry &entry, std::vector< long > const &fieldPos)
read the field data
Definition: MsWrdText.cxx:1144
MsWrdText::readLongZone
bool readLongZone(MsWrdEntry &entry, int sz, std::vector< long > &list)
read a zone which consists in a list of int
Definition: MsWrdText.cxx:1236
MsWrdText::flushExtra
void flushExtra()
sends the data which have not yet been sent to the listener
Definition: MsWrdText.cxx:2222
MsWrdText::convertFilePLCPos
void convertFilePLCPos()
convert the file position in character position and compute the paragraph limit
Definition: MsWrdText.cxx:1312
MsWrdText::PLC
Internal: the plc.
Definition: MsWrdText.hxx:70
MsWrdText::version
int version() const
returns the file version
Definition: MsWrdText.cxx:479
MsWrdText::PLC::ParagraphInfo
Definition: MsWrdText.hxx:71
MsWrdTextStyles.hxx
MsWrdText::PLC::Field
Definition: MsWrdText.hxx:71
MsWrdText::sendTable
bool sendTable(MsWrdTextInternal::Table const &table)
try to send a table.
Definition: MsWrdText.cxx:2109
MsWrdText::PLC::Footnote
Definition: MsWrdText.hxx:71
MsWrdTextInternal::Table
Internal and low level: a structure to store a table of a MsWrdText.
Definition: MsWrdText.cxx:290
MsWrdText::PLC::Type
Type
Definition: MsWrdText.hxx:71
MsWrdText::createZones
bool createZones(long bot)
finds the different zones
Definition: MsWrdText.cxx:634
MsWrdText::PLC::Page
Definition: MsWrdText.hxx:71
MsWrdText::readFootnotesData
bool readFootnotesData(MsWrdEntry &entry)
read the footnote data
Definition: MsWrdText.cxx:1097
MsWrdText::PLC::ltstr::operator()
bool operator()(PLC const &s1, PLC const &s2) const
Definition: MsWrdText.hxx:82
MsWrdText::PLC::m_id
int m_id
the identificator
Definition: MsWrdText.hxx:94
MsWrdText::m_parserState
MWAWParserStatePtr m_parserState
the parser state
Definition: MsWrdText.hxx:210
MsWrdText::getFilePLCMap
std::multimap< long, MsWrdText::PLC > & getFilePLCMap()
returns the file correspondance zone ( filepos, plc )
Definition: MsWrdText.cxx:548
MsWrdText::prepareData
void prepareData()
prepare the data to be send
Definition: MsWrdText.cxx:1729
MsWrdText::~MsWrdText
virtual ~MsWrdText()
destructor
Definition: MsWrdText.cxx:476
MsWrdText::readFootnotesPos
bool readFootnotesPos(MsWrdEntry &entry, std::vector< long > const &noteDef)
read the footnote pos in text + val
Definition: MsWrdText.cxx:1036
MsWrdText::MsWrdText
MsWrdText(MsWrdParser &parser)
constructor
Definition: MsWrdText.cxx:467
MsWrdParser
the main class to read a Microsoft Word file
Definition: MsWrdParser.hxx:97
MsWrdText::PLC::m_type
Type m_type
the plc type
Definition: MsWrdText.hxx:92
MsWrdText::sendMainText
bool sendMainText()
send a main zone
Definition: MsWrdText.cxx:2175
MsWrdText::PLC::Object
Definition: MsWrdText.hxx:71
MWAWDebug.hxx
MsWrdText::prepareTableLimits
void prepareTableLimits()
find the table end position knowing the end cell/pos delimiter
Definition: MsWrdText.cxx:1606
MsWrdTextInternal
Internal: the structures of a MsWrdText.
Definition: MsWrdText.cxx:69
MsWrdText::PLC::Paragraph
Definition: MsWrdText.hxx:71
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:219
MsWrdText::PLC::ltstr
a comparaison structure
Definition: MsWrdText.hxx:81
MsWrdText::operator=
MsWrdText & operator=(MsWrdText const &orig)=delete
MWAWEntry
basic class to store an entry in a file This contained :
Definition: MWAWEntry.hxx:46
MsWrdText::getParserState
std::shared_ptr< MWAWParserState > & getParserState()
returns the parser state
Definition: MsWrdText.hxx:117
MsWrdText::getMainTextLength
long getMainTextLength() const
returns the main text length
Definition: MsWrdText.cxx:492
MsWrdText::PLC::operator<<
friend std::ostream & operator<<(std::ostream &o, PLC const &plc)
operator<<
Definition: MsWrdText.cxx:557
MsWrdText::m_state
std::shared_ptr< MsWrdTextInternal::State > m_state
the state
Definition: MsWrdText.hxx:213
MsWrdText::readFontNames
bool readFontNames(MsWrdEntry &entry)
read the font names
Definition: MsWrdText.cxx:846
MsWrdText::updateTableBeginnningAt
bool updateTableBeginnningAt(long cPos, long &nextCPos)
try to find a table which begin at position cPos, if so, update its data...
Definition: MsWrdText.cxx:1706
MsWrdText::getFooter
MWAWEntry getFooter() const
returns the footer entry
Definition: MsWrdText.cxx:520
MsWrdText::PLC::PLC
PLC(Type type, int id=0)
Definition: MsWrdText.hxx:72
MsWrdText::readPageBreak
bool readPageBreak(MsWrdEntry &entry)
read the page limit ?
Definition: MsWrdText.cxx:973