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
51namespace MsWrdStruct
52{
54MWAWBorder getBorder(int val, std::string &extra);
55
57struct Font {
58 enum { NumFlags =9 };
59
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 }
107 std::string m_extra;
108};
109
111struct 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);
126 m_col.insert(sec.m_col);
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
155 std::string m_extra;
156};
157
159struct Table {
160 struct Cell;
162 Table() : m_height(0), m_justify(MWAWParagraph::JustificationLeft), m_indent(0),
164 {
165 }
167 void insert(Table const &table);
169 bool read(MWAWInputStreamPtr &input, long endPos);
172
174 friend std::ostream &operator<<(std::ostream &o, Table const &table);
175
177 struct Cell {
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];
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;
208 std::string m_extra;
209 };
210
222 std::vector<MWAWVariable<Cell> > m_cells;
226 std::string m_extra;
227};
228
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);
280 std::string m_error;
281};
282
284struct Paragraph : public MWAWParagraph {
286 explicit Paragraph(int version) : MWAWParagraph(), m_version(version), m_styleId(-1000),
288 m_bordersStyle(), m_inCell(false), m_tableDef(false), m_table()
289 {
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 }
325 std::vector<float> m_deletedTabs;
340};
341}
342#endif
343// vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
Class to store font.
Definition: MWAWFont.hxx:44
int cmp(MWAWFont const &oth) const
a comparison function
Definition: MWAWFont.hxx:503
class to store the paragraph properties
Definition: MWAWParagraph.hxx:82
MWAWVariable< bool > m_tabsRelativeToLeftMargin
true if the tabs are relative to left margin, false if there are relative to the page margin (default...
Definition: MWAWParagraph.hxx:158
a class which stores section properties
Definition: MWAWSection.hxx:46
shared_ptr< MWAWInputStream > MWAWInputStreamPtr
a smart pointer of MWAWInputStream
Definition: libmwaw_internal.hxx:503
shared_ptr< MWAWFontConverter > MWAWFontConverterPtr
a smart pointer of MWAWFontConverter
Definition: libmwaw_internal.hxx:495
namespace to store the main structure which appears in a Microsoft Word 3.0-5.0 file
Definition: MsWrdStruct.cxx:42
MWAWBorder getBorder(int val, std::string &extra)
generic function use to fill a border using the read data
Definition: MsWrdStruct.cxx:1215
a border
Definition: libmwaw_internal.hxx:314
@ None
Definition: libmwaw_internal.hxx:316
void insert(MWAWVariable const &orig)
update the current value if orig is set
Definition: libmwaw_internal.hxx:551
bool isSet() const
return true if the variable is set
Definition: libmwaw_internal.hxx:586
T const & get() const
return the current value
Definition: libmwaw_internal.hxx:581
the font structure of a Microsoft Word file
Definition: MsWrdStruct.hxx:57
MWAWVariable< int > m_flags[NumFlags]
a list of flags
Definition: MsWrdStruct.hxx:101
@ NumFlags
the number of flags needed to store all datas
Definition: MsWrdStruct.hxx:58
MWAWVariable< long > m_picturePos
a picture file position (if this corresponds to a picture)
Definition: MsWrdStruct.hxx:103
MWAWVariable< float > m_size
a second size
Definition: MsWrdStruct.hxx:97
friend std::ostream & operator<<(std::ostream &o, Font const &font)
operator<<
Definition: MsWrdStruct.cxx:44
int cmp(Font const &oth) const
a comparison function
Definition: MsWrdStruct.hxx:76
void updateFontToFinalState(Font const *styleFont=0)
update the font to obtain the final font
Definition: MsWrdStruct.cxx:98
std::string m_extra
extra data
Definition: MsWrdStruct.hxx:107
void insert(Font const &font, Font const *styleFont=0)
insert new font data ( beginning by updating font flags )
Definition: MsWrdStruct.cxx:82
MWAWVariable< int > m_value
a unknown value
Definition: MsWrdStruct.hxx:99
MWAWVariable< int > m_unknown
some unknown flag
Definition: MsWrdStruct.hxx:105
Font()
the constructor
Definition: MsWrdStruct.hxx:61
MWAWVariable< MWAWFont > m_font
the font
Definition: MsWrdStruct.hxx:95
the paragraph information of a Microsoft Word file (PHE)
Definition: MsWrdStruct.hxx:230
bool isEmpty() const
returns true if no data are been set
Definition: MsWrdStruct.hxx:241
MWAWVariable< int > m_numLines
the number of lines
Definition: MsWrdStruct.hxx:278
friend std::ostream & operator<<(std::ostream &o, ParagraphInfo const &pInfo)
operator<<
Definition: MsWrdStruct.hxx:251
bool isLineSet() const
returns true if num lines is set
Definition: MsWrdStruct.hxx:236
MWAWVariable< MWAWVec2f > m_dim
the zone dimension
Definition: MsWrdStruct.hxx:276
MWAWVariable< int > m_type
the type
Definition: MsWrdStruct.hxx:274
ParagraphInfo()
constructor
Definition: MsWrdStruct.hxx:232
bool read(MWAWInputStreamPtr &input, long endPos, int vers)
try to read a data
Definition: MsWrdStruct.cxx:708
std::string m_error
the errors
Definition: MsWrdStruct.hxx:280
void insert(ParagraphInfo const &pInfo)
insert the new values
Definition: MsWrdStruct.cxx:723
the paragraph structure of a Microsoft Word file
Definition: MsWrdStruct.hxx:284
friend std::ostream & operator<<(std::ostream &o, Paragraph const &ind)
operator<<
Definition: MsWrdStruct.cxx:1098
MWAWVariable< Table > m_table
the table
Definition: MsWrdStruct.hxx:339
void updateParagraphToFinalState(Paragraph const *style=0)
update the paragraph to obtain the final paragraph
Definition: MsWrdStruct.cxx:1136
bool read(MWAWInputStreamPtr &input, long endPos)
try to read a data
Definition: MsWrdStruct.cxx:736
MWAWVariable< double > m_interline
the interline if set
Definition: MsWrdStruct.hxx:323
bool inTable() const
returns true if we are in table
Definition: MsWrdStruct.hxx:303
MWAWVariable< MWAWBorder > m_bordersStyle
the border style ( old v3)
Definition: MsWrdStruct.hxx:333
int m_version
the file version
Definition: MsWrdStruct.hxx:319
MWAWVariable< bool > m_inCell
a cell/textbox
Definition: MsWrdStruct.hxx:335
MWAWVariable< int > m_styleId
the style id (if known)
Definition: MsWrdStruct.hxx:321
MWAWVariable< Font > m_font
the font
Definition: MsWrdStruct.hxx:329
int getNumLines() const
returns the number of line stored in m_info or -1
Definition: MsWrdStruct.hxx:314
MWAWVariable< Section > m_section
the section
Definition: MsWrdStruct.hxx:331
void print(std::ostream &o, MWAWFontConverterPtr converter) const
operator<<
Definition: MsWrdStruct.cxx:1205
Paragraph(int version)
Constructor.
Definition: MsWrdStruct.hxx:286
bool getFont(Font &font, Font const *styleFont=0) const
returns the font which correspond to the paragraph if possible
Definition: MsWrdStruct.cxx:1122
MWAWVariable< Font > m_modFont
font (modifier)
Definition: MsWrdStruct.hxx:329
MWAWVariable< bool > m_tableDef
a table flag
Definition: MsWrdStruct.hxx:337
virtual ~Paragraph()
destructor
Definition: MsWrdStruct.cxx:732
std::vector< float > m_deletedTabs
the delete tabulation
Definition: MsWrdStruct.hxx:325
void insert(Paragraph const &para, bool insertModif=true)
insert the new values
Definition: MsWrdStruct.cxx:1163
MWAWVariable< ParagraphInfo > m_info
the dimension
Definition: MsWrdStruct.hxx:327
the section structure of a Microsoft Word file
Definition: MsWrdStruct.hxx:111
MWAWVariable< int > m_col
the num of columns
Definition: MsWrdStruct.hxx:147
MWAWVariable< int > m_id
the identificator
Definition: MsWrdStruct.hxx:141
friend std::ostream & operator<<(std::ostream &o, Section const &section)
operator<<
Definition: MsWrdStruct.cxx:406
MWAWSection getSection(double pageWidth) const
returns a section
Definition: MsWrdStruct.cxx:150
std::string m_extra
the errors
Definition: MsWrdStruct.hxx:155
Section()
constructor
Definition: MsWrdStruct.hxx:113
MWAWVariable< int > m_paragraphId
the paragraph id
Definition: MsWrdStruct.hxx:145
MWAWVariable< bool > m_colBreak
only a column break
Definition: MsWrdStruct.hxx:151
MWAWVariable< int > m_type
the type
Definition: MsWrdStruct.hxx:143
MWAWVariable< float > m_colSep
the spacing between column
Definition: MsWrdStruct.hxx:149
MWAWVariable< int > m_flag
some flag ( in the main position)
Definition: MsWrdStruct.hxx:153
void insert(Section const &sec)
insert the new values
Definition: MsWrdStruct.hxx:121
bool readV3(MWAWInputStreamPtr &input, long endPos)
try to read a data ( v3 code )
Definition: MsWrdStruct.cxx:233
bool read(MWAWInputStreamPtr &input, long endPos)
try to read a data
Definition: MsWrdStruct.cxx:167
the cells definitions in a Microsoft Word Table
Definition: MsWrdStruct.hxx:177
std::vector< MWAWVariable< MWAWBorder > > m_borders
the borders TLBR
Definition: MsWrdStruct.hxx:204
void insert(Cell const &cell)
update the cell data by merging
Definition: MsWrdStruct.hxx:183
std::string m_extra
extra data
Definition: MsWrdStruct.hxx:208
friend std::ostream & operator<<(std::ostream &o, Cell const &cell)
operator<<
Definition: MsWrdStruct.cxx:628
MWAWVariable< float > m_backColor
the background gray color
Definition: MsWrdStruct.hxx:206
bool hasBorders() const
returns true if the cell has borders
Definition: MsWrdStruct.hxx:194
Cell()
constructor
Definition: MsWrdStruct.hxx:179
the table in a Microsoft Word file
Definition: MsWrdStruct.hxx:159
Table()
constructor
Definition: MsWrdStruct.hxx:162
MWAWVariable< std::vector< float > > m_columnsWidthMod
the columns width modifier
Definition: MsWrdStruct.hxx:220
MWAWVariable< float > m_height
the row height in inches
Definition: MsWrdStruct.hxx:212
MWAWVariable< float > m_indent
the indent
Definition: MsWrdStruct.hxx:216
MWAWVariable< MWAWParagraph::Justification > m_justify
the justification
Definition: MsWrdStruct.hxx:214
std::vector< MWAWVariable< Cell > > m_cells
the table cells
Definition: MsWrdStruct.hxx:222
bool read(MWAWInputStreamPtr &input, long endPos)
try to read a data
Definition: MsWrdStruct.cxx:434
void insert(Table const &table)
insert the new values
Definition: MsWrdStruct.cxx:596
MWAWVariable< Cell > m_badCell
empty cell used by getCell to return unknown cell
Definition: MsWrdStruct.hxx:224
std::string m_extra
the errors
Definition: MsWrdStruct.hxx:226
MWAWVariable< std::vector< float > > m_columns
the table columns
Definition: MsWrdStruct.hxx:218
friend std::ostream & operator<<(std::ostream &o, Table const &table)
operator<<
Definition: MsWrdStruct.cxx:646
MWAWVariable< Cell > & getCell(int id)
returns the ith Cell
Definition: MsWrdStruct.cxx:424

Generated on Wed Jan 19 2022 22:23:15 for libmwaw by doxygen 1.9.3