MsWrdStruct.hxx Source File documentation

MsWrdStruct.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 * Class to read/store the MsWrd structures
36 */
37
38 #ifndef MS_WRD_STRUCT
39 # define MS_WRD_STRUCT
40
41 #include <iostream>
42 #include <string>
43 #include <vector>
44
45 #include "libmwaw_internal.hxx"
46
47 #include "MWAWFont.hxx"
48 #include "MWAWParagraph.hxx"
49
51 namespace MsWrdStruct
52 {
54 MWAWBorder getBorder(int val, std::string &extra);
55
57 struct Font {
58 enum { NumFlags =9 };
59
61 Font(): m_font(MWAWFont(-1,0)), m_size(0), m_value(0), m_picturePos(0), m_unknown(0), m_extra("")
62 {
63 for (int i = 0; i < NumFlags; i++) m_flags[i]=MWAWVariable<int>(0);
64 }
65
67 void insert(Font const &font, Font const *styleFont=0);
68
70 void updateFontToFinalState(Font const *styleFont=0);
71
73 friend std::ostream &operator<<(std::ostream &o, Font const &font);
74
76 int cmp(Font const &oth) const
77 {
78 int diff = m_font.get().cmp(oth.m_font.get());
79 if (diff) return diff;
80 if (m_size.get() < oth.m_size.get()) return -1;
81 if (m_size.get() > oth.m_size.get()) return 1;
82 diff = m_value.get()-oth.m_value.get();
83 if (diff) return diff;
84 for (int i = 0; i < NumFlags; i++) {
85 diff = m_flags[i].get()-oth.m_flags[i].get();
86 if (diff) return diff;
87 }
88 if (m_picturePos.get()<oth.m_picturePos.get()) return -1;
89 if (m_picturePos.get()>oth.m_picturePos.get()) return 1;
90 diff = m_unknown.get()-oth.m_unknown.get();
91 if (diff) return diff;
92 return 0;
93 }
95 MWAWVariable<MWAWFont> m_font;
97 MWAWVariable<float> m_size;
99 MWAWVariable<int> m_value;
101 MWAWVariable<int> m_flags[NumFlags];
103 MWAWVariable<long> m_picturePos;
105 MWAWVariable<int> m_unknown;
107 std::string m_extra;
108 };
109
111 struct Section {
113 Section() : m_id(-1), m_type(0), m_paragraphId(-9999), m_col(1),
114 m_colSep(0.5), m_colBreak(false), m_flag(0), m_extra("")
115 {
116 }
118 MWAWSection getSection(double pageWidth) const;
119
121 void insert(Section const &sec)
122 {
123 m_id.insert(sec.m_id);
124 m_type.insert(sec.m_type);
125 m_paragraphId.insert(sec.m_paragraphId);
126 m_col.insert(sec.m_col);
127 m_colSep.insert(sec.m_colSep);
128 m_colBreak.insert(sec.m_colBreak);
129 m_flag.insert(sec.m_flag);
130 m_extra+=sec.m_extra;
131 }
133 bool read(MWAWInputStreamPtr &input, long endPos);
135 bool readV3(MWAWInputStreamPtr &input, long endPos);
136
138 friend std::ostream &operator<<(std::ostream &o, Section const &section);
139
141 MWAWVariable<int> m_id;
143 MWAWVariable<int> m_type;
145 MWAWVariable<int> m_paragraphId;
147 MWAWVariable<int> m_col;
149 MWAWVariable<float> m_colSep;
151 MWAWVariable<bool> m_colBreak;
153 MWAWVariable<int> m_flag;
155 std::string m_extra;
156 };
157
159 struct Table {
160 struct Cell;
162 Table() : m_height(0), m_justify(MWAWParagraph::JustificationLeft), m_indent(0),
163 m_columns(), m_columnsWidthMod(), m_cells(), m_badCell(), m_extra("")
164 {
165 }
167 void insert(Table const &table);
169 bool read(MWAWInputStreamPtr &input, long endPos);
171 MWAWVariable<Cell> &getCell(int id);
172
174 friend std::ostream &operator<<(std::ostream &o, Table const &table);
175
177 struct Cell {
179 Cell() : m_borders(), m_backColor(1.0f), m_extra("")
180 {
181 }
183 void insert(Cell const &cell)
184 {
185 size_t cNumBorders = cell.m_borders.size();
186 if (cNumBorders > m_borders.size())
187 m_borders.resize(cNumBorders);
188 for (size_t i=0; i < cNumBorders; i++)
189 if (cell.m_borders[i].isSet()) m_borders[i]=*cell.m_borders[i];
190 m_backColor.insert(cell.m_backColor);
191 m_extra+=cell.m_extra;
192 }
194 bool hasBorders() const
195 {
196 for (size_t i = 0; i < m_borders.size(); i++)
197 if (m_borders[i].isSet() && m_borders[i]->m_style != MWAWBorder::None)
198 return true;
199 return false;
200 }
202 friend std::ostream &operator<<(std::ostream &o, Cell const &cell);
204 std::vector<MWAWVariable<MWAWBorder> > m_borders;
206 MWAWVariable<float> m_backColor;
208 std::string m_extra;
209 };
210
212 MWAWVariable<float> m_height;
214 MWAWVariable<MWAWParagraph::Justification> m_justify;
216 MWAWVariable<float> m_indent;
218 MWAWVariable<std::vector<float> > m_columns;
220 MWAWVariable<std::vector<float> > m_columnsWidthMod;
222 std::vector<MWAWVariable<Cell> > m_cells;
224 MWAWVariable<Cell> m_badCell;
226 std::string m_extra;
227 };
228
230 struct ParagraphInfo {
232 ParagraphInfo() : m_type(0), m_dim(), m_numLines(-1), m_error("")
233 {
234 }
236 bool isLineSet() const
237 {
238 return *m_numLines!=0;
239 }
241 bool isEmpty() const
242 {
243 if (*m_numLines || *m_type) return false;
244 if (!m_dim.isSet()) return true;
245 if ((*m_dim)[0] > 0 || (*m_dim)[1] > 0) return false;
246 return true;
247 }
249 bool read(MWAWInputStreamPtr &input, long endPos, int vers);
251 friend std::ostream &operator<<(std::ostream &o, ParagraphInfo const &pInfo)
252 {
253 // find also pInfo.m_type&0x40 : ?
254 if (*pInfo.m_type&0xd0) o << "type?=" << ((*pInfo.m_type&0xd0)>>4) << ",";
255 if (*pInfo.m_type&0x0f) o << "#unkn=" << (*pInfo.m_type&0xf) << ",";
256 if (pInfo.m_dim.isSet()) {
257 if ((*pInfo.m_dim)[0] > 0)
258 o << "width=" << (*pInfo.m_dim)[0] << ",";
259 if ((*pInfo.m_dim)[1] > 0) {
260 o << "height=" << (*pInfo.m_dim)[1];
261 if (*pInfo.m_type&0x20)
262 o << "[total]";
263 o << ",";
264 }
265 }
266 if (pInfo.m_numLines.isSet() && *pInfo.m_numLines!=-1 && *pInfo.m_numLines!=1)
267 o << "nLines=" << *pInfo.m_numLines << ",";
268 if (pInfo.m_error.length()) o << pInfo.m_error << ",";
269 return o;
270 }
272 void insert(ParagraphInfo const &pInfo);
274 MWAWVariable<int> m_type;
276 MWAWVariable<MWAWVec2f> m_dim;
278 MWAWVariable<int> m_numLines;
280 std::string m_error;
281 };
282
284 struct Paragraph : public MWAWParagraph {
286 explicit Paragraph(int version) : MWAWParagraph(), m_version(version), m_styleId(-1000),
287 m_interline(0), m_deletedTabs(), m_info(), m_font(), m_modFont(), m_section(),
288 m_bordersStyle(), m_inCell(false), m_tableDef(false), m_table()
289 {
290 m_tabsRelativeToLeftMargin=false;
291 }
293 virtual ~Paragraph();
295 void insert(Paragraph const &para, bool insertModif=true);
297 bool read(MWAWInputStreamPtr &input, long endPos);
299 void updateParagraphToFinalState(Paragraph const *style=0);
301 bool getFont(Font &font, Font const *styleFont=0) const;
303 bool inTable() const
304 {
305 return m_inCell.get();
306 }
308 friend std::ostream &operator<<(std::ostream &o, Paragraph const &ind);
309
311 void print(std::ostream &o, MWAWFontConverterPtr converter) const;
312
314 int getNumLines() const
315 {
316 return m_info.get().m_numLines.get();
317 }
319 int m_version;
321 MWAWVariable<int> m_styleId;
323 MWAWVariable<double> m_interline;
325 std::vector<float> m_deletedTabs;
327 MWAWVariable<ParagraphInfo> m_info;
329 MWAWVariable<Font> m_font, m_modFont ;
331 MWAWVariable<Section> m_section;
333 MWAWVariable<MWAWBorder> m_bordersStyle;
335 MWAWVariable<bool> m_inCell;
337 MWAWVariable<bool> m_tableDef;
339 MWAWVariable<Table> m_table;
340 };
341 }
342 #endif
343 // vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
MsWrdStruct::Font::m_flags
MWAWVariable< int > m_flags[NumFlags]
a list of flags
Definition: MsWrdStruct.hxx:101
MsWrdStruct::Font
the font structure of a Microsoft Word file
Definition: MsWrdStruct.hxx:57
MsWrdStruct::Table::Cell::m_extra
std::string m_extra
extra data
Definition: MsWrdStruct.hxx:208
MsWrdStruct::Font::NumFlags
the number of flags needed to store all datas
Definition: MsWrdStruct.hxx:58
MsWrdStruct::Font::m_size
MWAWVariable< float > m_size
a second size
Definition: MsWrdStruct.hxx:97
MsWrdStruct::ParagraphInfo::m_type
MWAWVariable< int > m_type
the type
Definition: MsWrdStruct.hxx:274
MsWrdStruct::Table::Cell::m_backColor
MWAWVariable< float > m_backColor
the background gray color
Definition: MsWrdStruct.hxx:206
MsWrdStruct::Table::Cell::Cell
Cell()
constructor
Definition: MsWrdStruct.hxx:179
MWAWVariable::get
T const & get() const
return the current value
Definition: libmwaw_internal.hxx:595
MsWrdStruct::ParagraphInfo::isLineSet
bool isLineSet() const
returns true if num lines is set
Definition: MsWrdStruct.hxx:236
MsWrdStruct::ParagraphInfo::ParagraphInfo
ParagraphInfo()
constructor
Definition: MsWrdStruct.hxx:232
libmwaw_internal.hxx
MsWrdStruct::Paragraph::m_table
MWAWVariable< Table > m_table
the table
Definition: MsWrdStruct.hxx:339
MsWrdStruct::Paragraph::m_version
int m_version
the file version
Definition: MsWrdStruct.hxx:319
MsWrdStruct::Table::Cell::m_borders
std::vector< MWAWVariable< MWAWBorder > > m_borders
the borders TLBR
Definition: MsWrdStruct.hxx:204
MsWrdStruct::Table::Cell::insert
void insert(Cell const &cell)
update the cell data by merging
Definition: MsWrdStruct.hxx:183
MsWrdStruct::Paragraph::m_inCell
MWAWVariable< bool > m_inCell
a cell/textbox
Definition: MsWrdStruct.hxx:335
MsWrdStruct::Table::m_justify
MWAWVariable< MWAWParagraph::Justification > m_justify
the justification
Definition: MsWrdStruct.hxx:214
MsWrdStruct::Section::Section
Section()
constructor
Definition: MsWrdStruct.hxx:113
MsWrdStruct::Font::insert
void insert(Font const &font, Font const *styleFont=0)
insert new font data ( beginning by updating font flags )
Definition: MsWrdStruct.cxx:82
MsWrdStruct
namespace to store the main structure which appears in a Microsoft Word 3.0-5.0 file ...
Definition: MsWrdStruct.cxx:41
MsWrdStruct::Paragraph
the paragraph structure of a Microsoft Word file
Definition: MsWrdStruct.hxx:284
MsWrdStruct::Section::m_paragraphId
MWAWVariable< int > m_paragraphId
the paragraph id
Definition: MsWrdStruct.hxx:145
MsWrdStruct::Table::Table
Table()
constructor
Definition: MsWrdStruct.hxx:162
MWAWVariable::isSet
bool isSet() const
return true if the variable is set
Definition: libmwaw_internal.hxx:600
MsWrdStruct::Paragraph::Paragraph
Paragraph(int version)
Constructor.
Definition: MsWrdStruct.hxx:286
MsWrdStruct::Table::m_indent
MWAWVariable< float > m_indent
the indent
Definition: MsWrdStruct.hxx:216
MsWrdStruct::Font::m_font
MWAWVariable< MWAWFont > m_font
the font
Definition: MsWrdStruct.hxx:95
HanMacWrdKTextInternal::getSection
Section getSection(const State &state, const long id)
Definition: HanMacWrdKText.cxx:249
MsWrdStruct::Paragraph::m_interline
MWAWVariable< double > m_interline
the interline if set
Definition: MsWrdStruct.hxx:323
MsWrdStruct::Paragraph::m_deletedTabs
std::vector< float > m_deletedTabs
the delete tabulation
Definition: MsWrdStruct.hxx:325
MsWrdStruct::Section::insert
void insert(Section const &sec)
insert the new values
Definition: MsWrdStruct.hxx:121
MWAWFont
Class to store font.
Definition: MWAWFont.hxx:43
MWAWBorder
a border
Definition: libmwaw_internal.hxx:328
MsWrdStruct::ParagraphInfo::m_error
std::string m_error
the errors
Definition: MsWrdStruct.hxx:280
MsWrdStruct::Table::m_extra
std::string m_extra
the errors
Definition: MsWrdStruct.hxx:226
MsWrdStruct::Paragraph::getNumLines
int getNumLines() const
returns the number of line stored in m_info or -1
Definition: MsWrdStruct.hxx:314
MWAWFont.hxx
MsWrdStruct::Section::m_extra
std::string m_extra
the errors
Definition: MsWrdStruct.hxx:155
MsWrdStruct::Font::m_extra
std::string m_extra
extra data
Definition: MsWrdStruct.hxx:107
MsWrdStruct::Font::m_value
MWAWVariable< int > m_value
a unknown value
Definition: MsWrdStruct.hxx:99
MsWrdStruct::Section::m_colSep
MWAWVariable< float > m_colSep
the spacing between column
Definition: MsWrdStruct.hxx:149
MsWrdStruct::Paragraph::m_tableDef
MWAWVariable< bool > m_tableDef
a table flag
Definition: MsWrdStruct.hxx:337
MsWrdStruct::Table::m_columns
MWAWVariable< std::vector< float > > m_columns
the table columns
Definition: MsWrdStruct.hxx:218
MsWrdStruct::Table::Cell
the cells definitions in a Microsoft Word Table
Definition: MsWrdStruct.hxx:177
MsWrdStruct::Section::m_id
MWAWVariable< int > m_id
the identificator
Definition: MsWrdStruct.hxx:141
MsWrdStruct::Font::cmp
int cmp(Font const &oth) const
a comparison function
Definition: MsWrdStruct.hxx:76
MWAWBorder::None
Definition: libmwaw_internal.hxx:330
MsWrdStruct::Section::m_colBreak
MWAWVariable< bool > m_colBreak
only a column break
Definition: MsWrdStruct.hxx:151
MsWrdStruct::ParagraphInfo
the paragraph information of a Microsoft Word file (PHE)
Definition: MsWrdStruct.hxx:230
MsWrdStruct::Paragraph::m_info
MWAWVariable< ParagraphInfo > m_info
the dimension
Definition: MsWrdStruct.hxx:327
MsWrdStruct::Paragraph::inTable
bool inTable() const
returns true if we are in table
Definition: MsWrdStruct.hxx:303
MsWrdStruct::Table::Cell::hasBorders
bool hasBorders() const
returns true if the cell has borders
Definition: MsWrdStruct.hxx:194
MWAWSection
a class which stores section properties
Definition: MWAWSection.hxx:45
MsWrdStruct::Section::m_type
MWAWVariable< int > m_type
the type
Definition: MsWrdStruct.hxx:143
MWAWInputStreamPtr
shared_ptr< MWAWInputStream > MWAWInputStreamPtr
a smart pointer of MWAWInputStream
Definition: libmwaw_internal.hxx:517
MsWrdStruct::getBorder
MWAWBorder getBorder(int val, std::string &extra)
generic function use to fill a border using the read data
Definition: MsWrdStruct.cxx:1215
MsWrdStruct::Paragraph::m_bordersStyle
MWAWVariable< MWAWBorder > m_bordersStyle
the border style ( old v3)
Definition: MsWrdStruct.hxx:333
MsWrdStruct::Table::m_columnsWidthMod
MWAWVariable< std::vector< float > > m_columnsWidthMod
the columns width modifier
Definition: MsWrdStruct.hxx:220
MsWrdStruct::Font::m_unknown
MWAWVariable< int > m_unknown
some unknown flag
Definition: MsWrdStruct.hxx:105
MsWrdStruct::Font::operator<<
friend std::ostream & operator<<(std::ostream &o, Font const &font)
operator<<
Definition: MsWrdStruct.cxx:44
MsWrdStruct::Section
the section structure of a Microsoft Word file
Definition: MsWrdStruct.hxx:111
MWAWFontConverterPtr
shared_ptr< MWAWFontConverter > MWAWFontConverterPtr
a smart pointer of MWAWFontConverter
Definition: libmwaw_internal.hxx:509
MsWrdStruct::Table::m_badCell
MWAWVariable< Cell > m_badCell
empty cell used by getCell to return unknown cell
Definition: MsWrdStruct.hxx:224
MsWrdStruct::ParagraphInfo::isEmpty
bool isEmpty() const
returns true if no data are been set
Definition: MsWrdStruct.hxx:241
MWAWParagraph
class to store the paragraph properties
Definition: MWAWParagraph.hxx:81
MsWrdStruct::ParagraphInfo::m_numLines
MWAWVariable< int > m_numLines
the number of lines
Definition: MsWrdStruct.hxx:278
MsWrdStruct::Section::m_col
MWAWVariable< int > m_col
the num of columns
Definition: MsWrdStruct.hxx:147
MsWrdStruct::Font::m_picturePos
MWAWVariable< long > m_picturePos
a picture file position (if this corresponds to a picture)
Definition: MsWrdStruct.hxx:103
MsWrdStruct::Paragraph::m_section
MWAWVariable< Section > m_section
the section
Definition: MsWrdStruct.hxx:331
MsWrdStruct::Font::Font
Font()
the constructor
Definition: MsWrdStruct.hxx:61
MsWrdStruct::Table
the table in a Microsoft Word file
Definition: MsWrdStruct.hxx:159
MWAWFont::cmp
int cmp(MWAWFont const &oth) const
a comparison function
Definition: MWAWFont.hxx:503
MsWrdStruct::ParagraphInfo::operator<<
friend std::ostream & operator<<(std::ostream &o, ParagraphInfo const &pInfo)
operator<<
Definition: MsWrdStruct.hxx:251
MsWrdStruct::Paragraph::m_styleId
MWAWVariable< int > m_styleId
the style id (if known)
Definition: MsWrdStruct.hxx:321
MsWrdStruct::Section::m_flag
MWAWVariable< int > m_flag
some flag ( in the main position)
Definition: MsWrdStruct.hxx:153
MsWrdStruct::ParagraphInfo::m_dim
MWAWVariable< MWAWVec2f > m_dim
the zone dimension
Definition: MsWrdStruct.hxx:276
MWAWParagraph.hxx
MWAWVariable< MWAWFont >
MsWrdStruct::Font::updateFontToFinalState
void updateFontToFinalState(Font const *styleFont=0)
update the font to obtain the final font
Definition: MsWrdStruct.cxx:98
MsWrdStruct::Table::m_height
MWAWVariable< float > m_height
the row height in inches
Definition: MsWrdStruct.hxx:212
MsWrdStruct::Table::m_cells
std::vector< MWAWVariable< Cell > > m_cells
the table cells
Definition: MsWrdStruct.hxx:222