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()
62  : m_font(MWAWFont(-1,0))
63  , m_size(0)
64  , m_value(0)
65  , m_picturePos(0)
66  , m_unknown(0)
67  , m_extra("")
68  {
69  for (auto &fl : m_flags) fl=MWAWVariable<int>(0);
70  }
71  Font(Font const &)=default;
72  Font &operator=(Font const &)=default;
74  void insert(Font const &font, Font const *styleFont=nullptr);
75 
77  void updateFontToFinalState(Font const *styleFont=nullptr);
78 
80  friend std::ostream &operator<<(std::ostream &o, Font const &font);
81 
83  int cmp(Font const &oth) const
84  {
85  int diff = m_font.get().cmp(oth.m_font.get());
86  if (diff) return diff;
87  if (m_size.get() < oth.m_size.get()) return -1;
88  if (m_size.get() > oth.m_size.get()) return 1;
89  diff = m_value.get()-oth.m_value.get();
90  if (diff) return diff;
91  for (int i = 0; i < NumFlags; i++) {
92  diff = m_flags[i].get()-oth.m_flags[i].get();
93  if (diff) return diff;
94  }
95  if (m_picturePos.get()<oth.m_picturePos.get()) return -1;
96  if (m_picturePos.get()>oth.m_picturePos.get()) return 1;
97  diff = m_unknown.get()-oth.m_unknown.get();
98  if (diff) return diff;
99  return 0;
100  }
114  std::string m_extra;
115 };
116 
118 struct Section {
121  : m_id(-1)
122  , m_type(0)
123  , m_paragraphId(-9999)
124  , m_col(1)
125  , m_colSep(0.5)
126  , m_colBreak(false)
127  , m_flag(0)
128  , m_extra("")
129  {
130  }
132  MWAWSection getSection(double pageWidth) const;
133 
135  void insert(Section const &sec)
136  {
137  m_id.insert(sec.m_id);
138  m_type.insert(sec.m_type);
140  m_col.insert(sec.m_col);
141  m_colSep.insert(sec.m_colSep);
143  m_flag.insert(sec.m_flag);
144  m_extra+=sec.m_extra;
145  }
147  bool read(MWAWInputStreamPtr &input, long endPos);
149  bool readV3(MWAWInputStreamPtr &input, long endPos);
150 
152  friend std::ostream &operator<<(std::ostream &o, Section const &section);
153 
169  std::string m_extra;
170 };
171 
173 struct Table {
174  struct Cell;
177  : m_height(0)
178  , m_justify(MWAWParagraph::JustificationLeft)
179  , m_indent(0)
180  , m_columns()
182  , m_cells()
183  , m_badCell()
184  , m_extra("")
185  {
186  }
188  void insert(Table const &table);
190  bool read(MWAWInputStreamPtr &input, long endPos);
192  MWAWVariable<Cell> &getCell(int id);
193 
195  friend std::ostream &operator<<(std::ostream &o, Table const &table);
196 
198  struct Cell {
201  : m_borders()
202  , m_backColor(1.0f)
203  , m_extra("")
204  {
205  }
207  void insert(Cell const &cell)
208  {
209  size_t cNumBorders = cell.m_borders.size();
210  if (cNumBorders > m_borders.size())
211  m_borders.resize(cNumBorders);
212  for (size_t i=0; i < cNumBorders; i++)
213  if (cell.m_borders[i].isSet()) m_borders[i]=*cell.m_borders[i];
215  m_extra+=cell.m_extra;
216  }
218  bool hasBorders() const
219  {
220  for (auto const &bd : m_borders)
221  if (bd.isSet() && bd->m_style != MWAWBorder::None)
222  return true;
223  return false;
224  }
226  friend std::ostream &operator<<(std::ostream &o, Cell const &cell);
228  std::vector<MWAWVariable<MWAWBorder> > m_borders;
232  std::string m_extra;
233  };
234 
246  std::vector<MWAWVariable<Cell> > m_cells;
250  std::string m_extra;
251 };
252 
257  : m_type(0)
258  , m_dim()
259  , m_numLines(-1)
260  , m_error("")
261  {
262  }
264  bool isLineSet() const
265  {
266  return *m_numLines!=0;
267  }
269  bool isEmpty() const
270  {
271  if (*m_numLines || *m_type) return false;
272  if (!m_dim.isSet()) return true;
273  if ((*m_dim)[0] > 0 || (*m_dim)[1] > 0) return false;
274  return true;
275  }
277  bool read(MWAWInputStreamPtr &input, long endPos, int vers);
279  friend std::ostream &operator<<(std::ostream &o, ParagraphInfo const &pInfo)
280  {
281  // find also pInfo.m_type&0x40 : ?
282  if (*pInfo.m_type&0xd0) o << "type?=" << ((*pInfo.m_type&0xd0)>>4) << ",";
283  if (*pInfo.m_type&0x0f) o << "#unkn=" << (*pInfo.m_type&0xf) << ",";
284  if (pInfo.m_dim.isSet()) {
285  if ((*pInfo.m_dim)[0] > 0)
286  o << "width=" << (*pInfo.m_dim)[0] << ",";
287  if ((*pInfo.m_dim)[1] > 0) {
288  o << "height=" << (*pInfo.m_dim)[1];
289  if (*pInfo.m_type&0x20)
290  o << "[total]";
291  o << ",";
292  }
293  }
294  if (pInfo.m_numLines.isSet() && *pInfo.m_numLines!=-1 && *pInfo.m_numLines!=1)
295  o << "nLines=" << *pInfo.m_numLines << ",";
296  if (pInfo.m_error.length()) o << pInfo.m_error << ",";
297  return o;
298  }
300  void insert(ParagraphInfo const &pInfo);
308  std::string m_error;
309 };
310 
312 struct Paragraph final : public MWAWParagraph {
314  explicit Paragraph(int version)
315  : MWAWParagraph()
316  , m_version(version)
317  , m_styleId(-1000)
318  , m_interline(0)
319  , m_deletedTabs()
320  , m_info()
321  , m_font()
322  , m_modFont()
323  , m_section()
324  , m_bordersStyle()
325  , m_inCell(false)
326  , m_tableDef(false)
327  , m_table()
328  {
330  }
331  Paragraph(Paragraph const &)=default;
332  Paragraph &operator=(Paragraph const &)=default;
333  Paragraph &operator=(Paragraph &&)=default;
335  ~Paragraph() final;
337  void insert(Paragraph const &para, bool insertModif=true);
339  bool read(MWAWInputStreamPtr &input, long endPos);
341  void updateParagraphToFinalState(Paragraph const *style=nullptr);
343  bool getFont(Font &font, Font const *styleFont=nullptr) const;
345  bool inTable() const
346  {
347  return m_inCell.get();
348  }
350  friend std::ostream &operator<<(std::ostream &o, Paragraph const &ind);
351 
353  void print(std::ostream &o, MWAWFontConverterPtr converter) const;
354 
356  int getNumLines() const
357  {
358  return m_info.get().m_numLines.get();
359  }
367  std::vector<float> m_deletedTabs;
382 };
383 }
384 #endif
385 // vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
MWAWVariable< int > m_flags[NumFlags]
a list of flags
Definition: MsWrdStruct.hxx:108
void insert(ParagraphInfo const &pInfo)
insert the new values
Definition: MsWrdStruct.cxx:717
the font structure of a Microsoft Word file
Definition: MsWrdStruct.hxx:57
~Paragraph() final
destructor
Definition: MsWrdStruct.cxx:726
std::string m_extra
extra data
Definition: MsWrdStruct.hxx:232
the number of flags needed to store all datas
Definition: MsWrdStruct.hxx:58
MWAWVariable< float > m_size
a second size
Definition: MsWrdStruct.hxx:104
MWAWVariable< int > m_type
the type
Definition: MsWrdStruct.hxx:302
MWAWVariable< float > m_backColor
the background gray color
Definition: MsWrdStruct.hxx:230
Cell()
constructor
Definition: MsWrdStruct.hxx:200
T const & get() const
return the current value
Definition: libmwaw_internal.hxx:630
bool isLineSet() const
returns true if num lines is set
Definition: MsWrdStruct.hxx:264
ParagraphInfo()
constructor
Definition: MsWrdStruct.hxx:256
MWAWVariable< Table > m_table
the table
Definition: MsWrdStruct.hxx:381
int m_version
the file version
Definition: MsWrdStruct.hxx:361
std::vector< MWAWVariable< MWAWBorder > > m_borders
the borders TLBR
Definition: MsWrdStruct.hxx:228
void insert(Cell const &cell)
update the cell data by merging
Definition: MsWrdStruct.hxx:207
void insert(Font const &font, Font const *styleFont=nullptr)
insert new font data ( beginning by updating font flags )
Definition: MsWrdStruct.cxx:83
MWAWVariable< bool > m_inCell
a cell/textbox
Definition: MsWrdStruct.hxx:377
MWAWVariable< MWAWParagraph::Justification > m_justify
the justification
Definition: MsWrdStruct.hxx:238
friend std::ostream & operator<<(std::ostream &o, Table const &table)
operator<<
Definition: MsWrdStruct.cxx:646
void insert(MWAWVariable const &orig)
update the current value if orig is set
Definition: libmwaw_internal.hxx:600
Font & operator=(Font const &)=default
Section()
constructor
Definition: MsWrdStruct.hxx:120
bool read(MWAWInputStreamPtr &input, long endPos)
try to read a data
Definition: MsWrdStruct.cxx:168
void updateFontToFinalState(Font const *styleFont=nullptr)
update the font to obtain the final font
Definition: MsWrdStruct.cxx:99
namespace to store the main structure which appears in a Microsoft Word 3.0-5.0 file ...
Definition: MsWrdStruct.cxx:41
the paragraph structure of a Microsoft Word file
Definition: MsWrdStruct.hxx:312
MWAWVariable< int > m_paragraphId
the paragraph id
Definition: MsWrdStruct.hxx:159
Table()
constructor
Definition: MsWrdStruct.hxx:176
Paragraph & operator=(Paragraph const &)=default
bool isSet() const
return true if the variable is set
Definition: libmwaw_internal.hxx:635
Paragraph(int version)
Constructor.
Definition: MsWrdStruct.hxx:314
bool readV3(MWAWInputStreamPtr &input, long endPos)
try to read a data ( v3 code )
Definition: MsWrdStruct.cxx:234
MWAWVariable< float > m_indent
the indent
Definition: MsWrdStruct.hxx:240
MWAWVariable< Font > m_modFont
font (modifier)
Definition: MsWrdStruct.hxx:371
MWAWVariable< MWAWFont > m_font
the font
Definition: MsWrdStruct.hxx:102
bool getFont(Font &font, Font const *styleFont=nullptr) const
returns the font which correspond to the paragraph if possible
Definition: MsWrdStruct.cxx:1116
MWAWVariable< double > m_interline
the interline if set
Definition: MsWrdStruct.hxx:365
std::vector< float > m_deletedTabs
the delete tabulation
Definition: MsWrdStruct.hxx:367
void insert(Section const &sec)
insert the new values
Definition: MsWrdStruct.hxx:135
Class to store font.
Definition: MWAWFont.hxx:43
a border
Definition: libmwaw_internal.hxx:333
std::string m_error
the errors
Definition: MsWrdStruct.hxx:308
std::string m_extra
the errors
Definition: MsWrdStruct.hxx:250
MWAWSection getSection(double pageWidth) const
returns a section
Definition: MsWrdStruct.cxx:151
bool read(MWAWInputStreamPtr &input, long endPos)
try to read a data
Definition: MsWrdStruct.cxx:435
int getNumLines() const
returns the number of line stored in m_info or -1
Definition: MsWrdStruct.hxx:356
std::string m_extra
the errors
Definition: MsWrdStruct.hxx:169
void updateParagraphToFinalState(Paragraph const *style=nullptr)
update the paragraph to obtain the final paragraph
Definition: MsWrdStruct.cxx:1130
std::string m_extra
extra data
Definition: MsWrdStruct.hxx:114
MWAWVariable< int > m_value
a unknown value
Definition: MsWrdStruct.hxx:106
MWAWVariable< float > m_colSep
the spacing between column
Definition: MsWrdStruct.hxx:163
MWAWVariable< bool > m_tableDef
a table flag
Definition: MsWrdStruct.hxx:379
MWAWVariable< std::vector< float > > m_columns
the table columns
Definition: MsWrdStruct.hxx:242
MWAWVariable< Cell > & getCell(int id)
returns the ith Cell
Definition: MsWrdStruct.cxx:425
MWAWVariable< Font > m_font
the font
Definition: MsWrdStruct.hxx:371
the cells definitions in a Microsoft Word Table
Definition: MsWrdStruct.hxx:198
MWAWVariable< int > m_id
the identificator
Definition: MsWrdStruct.hxx:155
int cmp(Font const &oth) const
a comparison function
Definition: MsWrdStruct.hxx:83
Definition: libmwaw_internal.hxx:335
friend std::ostream & operator<<(std::ostream &o, Paragraph const &ind)
operator<<
Definition: MsWrdStruct.cxx:1092
MWAWVariable< bool > m_colBreak
only a column break
Definition: MsWrdStruct.hxx:165
void insert(Table const &table)
insert the new values
Definition: MsWrdStruct.cxx:596
the paragraph information of a Microsoft Word file (PHE)
Definition: MsWrdStruct.hxx:254
MWAWVariable< ParagraphInfo > m_info
the dimension
Definition: MsWrdStruct.hxx:369
friend std::ostream & operator<<(std::ostream &o, Section const &section)
operator<<
Definition: MsWrdStruct.cxx:407
bool inTable() const
returns true if we are in table
Definition: MsWrdStruct.hxx:345
bool hasBorders() const
returns true if the cell has borders
Definition: MsWrdStruct.hxx:218
a class which stores section properties
Definition: MWAWSection.hxx:45
MWAWVariable< int > m_type
the type
Definition: MsWrdStruct.hxx:157
friend std::ostream & operator<<(std::ostream &o, Cell const &cell)
operator<<
Definition: MsWrdStruct.cxx:628
MWAWBorder getBorder(int val, std::string &extra)
generic function use to fill a border using the read data
Definition: MsWrdStruct.cxx:1207
MWAWVariable< MWAWBorder > m_bordersStyle
the border style ( old v3)
Definition: MsWrdStruct.hxx:375
MWAWVariable< std::vector< float > > m_columnsWidthMod
the columns width modifier
Definition: MsWrdStruct.hxx:244
bool read(MWAWInputStreamPtr &input, long endPos, int vers)
try to read a data
Definition: MsWrdStruct.cxx:702
MWAWVariable< int > m_unknown
some unknown flag
Definition: MsWrdStruct.hxx:112
friend std::ostream & operator<<(std::ostream &o, Font const &font)
operator<<
Definition: MsWrdStruct.cxx:44
the section structure of a Microsoft Word file
Definition: MsWrdStruct.hxx:118
std::shared_ptr< MWAWInputStream > MWAWInputStreamPtr
a smart pointer of MWAWInputStream
Definition: libmwaw_internal.hxx:551
MWAWVariable< Cell > m_badCell
empty cell used by getCell to return unknown cell
Definition: MsWrdStruct.hxx:248
void insert(Paragraph const &para, bool insertModif=true)
insert the new values
Definition: MsWrdStruct.cxx:1157
bool isEmpty() const
returns true if no data are been set
Definition: MsWrdStruct.hxx:269
class to store the paragraph properties
Definition: MWAWParagraph.hxx:84
std::shared_ptr< MWAWFontConverter > MWAWFontConverterPtr
a smart pointer of MWAWFontConverter
Definition: libmwaw_internal.hxx:543
MWAWVariable< int > m_numLines
the number of lines
Definition: MsWrdStruct.hxx:306
bool read(MWAWInputStreamPtr &input, long endPos)
try to read a data
Definition: MsWrdStruct.cxx:730
MWAWVariable< int > m_col
the num of columns
Definition: MsWrdStruct.hxx:161
MWAWVariable< long > m_picturePos
a picture file position (if this corresponds to a picture)
Definition: MsWrdStruct.hxx:110
MWAWVariable< Section > m_section
the section
Definition: MsWrdStruct.hxx:373
Font()
the constructor
Definition: MsWrdStruct.hxx:61
the table in a Microsoft Word file
Definition: MsWrdStruct.hxx:173
int cmp(MWAWFont const &oth) const
a comparison function
Definition: MWAWFont.hxx:524
friend std::ostream & operator<<(std::ostream &o, ParagraphInfo const &pInfo)
operator<<
Definition: MsWrdStruct.hxx:279
MWAWVariable< int > m_styleId
the style id (if known)
Definition: MsWrdStruct.hxx:363
void print(std::ostream &o, MWAWFontConverterPtr converter) const
operator<<
Definition: MsWrdStruct.cxx:1197
MWAWVariable< int > m_flag
some flag ( in the main position)
Definition: MsWrdStruct.hxx:167
MWAWVariable< MWAWVec2f > m_dim
the zone dimension
Definition: MsWrdStruct.hxx:304
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:164
MWAWVariable< float > m_height
the row height in inches
Definition: MsWrdStruct.hxx:236
std::vector< MWAWVariable< Cell > > m_cells
the table cells
Definition: MsWrdStruct.hxx:246

Generated for libmwaw by doxygen 1.8.14