MSWrite.h
Go to the documentation of this file.
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: t; c-basic-offset: 4 -*- */
2 /* libwps
3  * Version: MPL 2.0 / LGPLv2.1+
4  *
5  * This Source Code Form is subject to the terms of the Mozilla Public
6  * License, v. 2.0. If a copy of the MPL was not distributed with this
7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8  *
9  * Major Contributor(s):
10  * Copyright (C) 2015 Sean Young <sean@mess.org>
11  *
12  * For minor contributions see the git repository.
13  *
14  * Alternatively, the contents of this file may be used under the terms
15  * of the GNU Lesser General Public License Version 2.1 or later
16  * (LGPLv2.1+), in which case the provisions of the LGPLv2.1+ are
17  * applicable instead of those above.
18  *
19  * For further information visit http://libwps.sourceforge.net
20  */
21 
22 #ifndef MS_WRITE_H
23 #define MS_WRITE_H
24 
25 #include <vector>
26 
27 #include <librevenge-stream/librevenge-stream.h>
28 #include "libwps_internal.h"
29 #include "libwps_tools_win.h"
30 
31 #include "WPSParser.h"
32 #include "WPSEntry.h"
33 #include "WPSFont.h"
34 #include "WPSPageSpan.h"
35 #include "WPSParagraph.h"
36 
37 namespace MSWriteParserInternal
38 {
39 class SubDocument;
40 
41 struct Paragraph : public WPSParagraph
42 {
45  : WPSParagraph()
46  , m_fcFirst(0)
47  , m_fcLim(0)
48  , m_Location(MAIN)
49  , m_graphics(false)
50  , m_firstpage(false)
51  , m_skiptab(false)
52  , m_headerUseMargin(false)
53  , m_interLine(0.0)
55  uint32_t m_fcFirst, m_fcLim;
58  double m_interLine;
60 };
61 
62 struct Font : public WPSFont
63 {
64  Font()
65  : WPSFont()
66  , m_fcFirst(0)
67  , m_fcLim(0)
68  , m_special(false)
69  , m_footnote(false)
70  , m_annotation(false)
71  , m_encoding(libwps_tools_win::Font::UNKNOWN) { }
72  uint32_t m_fcFirst, m_fcLim;
75 };
76 
77 struct Footnote
78 {
80  : m_fcFtn(0)
81  , m_fcRef(0) { }
82  uint32_t m_fcFtn, m_fcRef;
83 };
84 
85 struct Section
86 {
89  : m_fcLim(0)
90  , m_bkc(1)
91  , m_yaMac(11)
92  , m_xaMac(8.5)
93  , m_yaTop(1)
94  , m_dyaText(9)
95  , m_xaLeft(1.25)
96  , m_dxaText(6)
97  , m_startPageNumber(0xffff)
98  , m_yaHeader(0.75)
99  , m_yaFooter(10.25) /* 11-0.75inch*/
100  , m_endFtns(false)
101  , m_columns(1)
102  , m_dxaColumns(0.5)
103  , m_dxaGutter(0.0)
104  , m_Main() { }
105  uint32_t m_fcLim;
106  unsigned m_bkc;
107  double m_yaMac, m_xaMac;
108  double m_yaTop;
109  double m_dyaText;
110  double m_xaLeft;
111  double m_dxaText;
113  double m_yaHeader;
114  double m_yaFooter;
115  bool m_endFtns;
116  unsigned m_columns;
119 };
120 
121 }
122 
127 class MSWriteParser : public WPSParser
128 {
132 
133 public:
136 
137 
138  ~MSWriteParser() override;
139  void parse(librevenge::RVNGTextInterface *documentInterface) override;
140 
141 private:
142  MSWriteParser(const MSWriteParser &) = delete;
143  MSWriteParser &operator=(const MSWriteParser &) = delete;
144 
145  std::shared_ptr<WPSContentListener> createListener(librevenge::RVNGTextInterface *interface);
146 protected:
147  void readStructures();
149  void readFIB();
150  virtual void readFFNTB();
151  void readFOD(unsigned page, void (MSWriteParser::*parseFOD)(uint32_t fcFirst, uint32_t fcLim, unsigned size));
152  virtual void readPAP(uint32_t fcFirst, uint32_t fcLim, unsigned cch);
153  virtual void readCHP(uint32_t fcFirst, uint32_t fcLim, unsigned cch);
154  virtual void readSUMD();
155  virtual void readFNTB();
156  virtual void readSED();
158  int numPages();
159  void processObject(WPSPosition &pos, unsigned long lastPos);
160  bool processDDB(librevenge::RVNGBinaryData &bmpdata, WPSPosition &pos, unsigned width, unsigned height, unsigned byte_width, unsigned planes, unsigned bits_pixel, unsigned size);
161  bool processDIB(librevenge::RVNGBinaryData &bmpdata, unsigned size);
162  bool processWMF(librevenge::RVNGBinaryData &wmfdata, unsigned size);
163  void processEmbeddedOLE(WPSPosition &pos, unsigned long lastPos);
164  bool processStaticOLE(librevenge::RVNGBinaryData &, std::string &mimetype, WPSPosition &pos, unsigned long lastPos);
165  bool readString(std::string &res, unsigned long lastPos);
166  virtual void insertSpecial(uint8_t val, uint32_t fc, MSWriteParserInternal::Paragraph::Location location);
167  virtual void insertControl(uint8_t val, uint32_t fc);
168  void insertNote(bool annotation, uint32_t fcPos, librevenge::RVNGString &label);
169  unsigned insertString(const unsigned char *str, unsigned size, libwps_tools_win::Font::Type type);
170  static void getPageStyle(MSWriteParserInternal::Section &sep, WPSPageSpan &pageSpan);
171  void getHeaderFooters(uint32_t first, MSWriteParserInternal::Section &sep, WPSPageSpan &pageSpan);
173 
175  bool checkFilePosition(uint32_t pos) const
176  {
177  return pos<=m_fileLength;
178  }
179  // State
181  uint32_t m_fileLength;
182  uint32_t m_fcMac;
183 
184  std::vector<MSWriteParserInternal::Paragraph> m_paragraphList;
185  std::vector<MSWriteParserInternal::Font> m_fontList;
186  std::vector<MSWriteParserInternal::Footnote> m_footnotes;
187  std::vector<MSWriteParserInternal::Section> m_sections;
188  std::vector<librevenge::RVNGString> m_fonts;
190 
191  std::shared_ptr<WPSContentListener> m_listener; /* the listener (if set)*/
192 
193  librevenge::RVNGPropertyList m_metaData;
194 };
195 
196 #endif /* MS_WRITE_H */
197 /* vim:set shiftwidth=4 softtabstop=4 noexpandtab: */
bool m_special
Definition: MSWrite.h:73
std::vector< MSWriteParserInternal::Font > m_fontList
Definition: MSWrite.h:185
void startSection(MSWriteParserInternal::Section &section)
Definition: MSWrite.cpp:1751
unsigned m_bkc
Definition: MSWrite.h:106
Definition: MSWrite.cpp:38
class to store the paragraph properties
Definition: WPSParagraph.h:57
double m_dxaText
Definition: MSWrite.h:111
Footnote()
Definition: MSWrite.h:79
bool readString(std::string &res, unsigned long lastPos)
Definition: MSWrite.cpp:1142
double m_xaLeft
Definition: MSWrite.h:110
double m_dyaText
Definition: MSWrite.h:109
uint32_t m_fcLim
Definition: MSWrite.h:105
void insertNote(bool annotation, uint32_t fcPos, librevenge::RVNGString &label)
Definition: MSWrite.cpp:1714
virtual void readSED()
Definition: MSWrite.cpp:445
std::vector< MSWriteParserInternal::Paragraph > m_paragraphList
Definition: MSWrite.h:184
std::vector< librevenge::RVNGString > m_fonts
Definition: MSWrite.h:188
virtual void readFFNTB()
Definition: MSWrite.cpp:347
double m_yaMac
Definition: MSWrite.h:107
unsigned m_columns
Definition: MSWrite.h:116
double m_xaMac
Definition: MSWrite.h:107
MSWriteParser & operator=(const MSWriteParser &)=delete
define the font properties
Definition: WPSFont.h:36
uint16_t m_startPageNumber
Definition: MSWrite.h:112
bool m_footnote
Definition: MSWrite.h:73
bool m_skiptab
Definition: MSWrite.h:57
uint32_t m_fcLim
Definition: MSWrite.h:72
bool m_graphics
Definition: MSWrite.h:57
uint32_t m_fcFirst
Definition: MSWrite.h:55
libwps_tools_win::Font::Type m_encoding
Definition: MSWrite.h:74
double m_interLine
Definition: MSWrite.h:58
void getHeaderFooters(uint32_t first, MSWriteParserInternal::Section &sep, WPSPageSpan &pageSpan)
Definition: MSWrite.cpp:760
bool m_annotation
Definition: MSWrite.h:73
Definition: WPSParser.h:35
Type
enum Type
Definition: libwps_tools_win.h:46
MSWriteParser(RVNGInputStreamPtr &input, WPSHeaderPtr &header, libwps_tools_win::Font::Type encoding=libwps_tools_win::Font::WIN3_WEUROPE)
Definition: MSWrite.cpp:283
bool processStaticOLE(librevenge::RVNGBinaryData &, std::string &mimetype, WPSPosition &pos, unsigned long lastPos)
Definition: MSWrite.cpp:1520
double m_yaTop
Definition: MSWrite.h:108
static void getPageStyle(MSWriteParserInternal::Section &sep, WPSPageSpan &pageSpan)
Definition: MSWrite.cpp:503
Internal: the subdocument of a MSWriteParser.
Definition: MSWrite.cpp:41
WPSEntry m_Main
Definition: MSWrite.h:118
double m_yaHeader
Definition: MSWrite.h:113
virtual void readFNTB()
Definition: MSWrite.cpp:1681
void readText(WPSEntry const &e, MSWriteParserInternal::Paragraph::Location location)
Definition: MSWrite.cpp:923
uint32_t m_fcLim
Definition: MSWrite.h:55
uint32_t m_fcFirst
Definition: MSWrite.h:72
libwps_tools_win::Font::Type m_fontType
Definition: MSWrite.h:189
WPSPageSpan::HeaderFooterOccurrence m_HeaderFooterOccurrence
Definition: MSWrite.h:59
librevenge::RVNGPropertyList m_metaData
Definition: MSWrite.h:193
std::vector< MSWriteParserInternal::Footnote > m_footnotes
Definition: MSWrite.h:186
uint32_t m_fcFtn
Definition: MSWrite.h:82
void processEmbeddedOLE(WPSPosition &pos, unsigned long lastPos)
Definition: MSWrite.cpp:1577
virtual void readCHP(uint32_t fcFirst, uint32_t fcLim, unsigned cch)
Definition: MSWrite.cpp:704
double m_yaFooter
Definition: MSWrite.h:114
bool m_firstpage
Definition: MSWrite.h:57
unsigned insertString(const unsigned char *str, unsigned size, libwps_tools_win::Font::Type type)
Definition: MSWrite.cpp:1126
Definition: MSWrite.h:62
Font()
Definition: MSWrite.h:64
void readFIB()
Definition: MSWrite.cpp:321
virtual void insertSpecial(uint8_t val, uint32_t fc, MSWriteParserInternal::Paragraph::Location location)
Definition: MSWrite.cpp:1093
std::shared_ptr< librevenge::RVNGInputStream > RVNGInputStreamPtr
shared pointer to librevenge::RVNGInputStream
Definition: libwps_internal.h:87
std::shared_ptr< WPSContentListener > m_listener
Definition: MSWrite.h:191
double m_dxaColumns
Definition: MSWrite.h:117
std::shared_ptr< WPSContentListener > createListener(librevenge::RVNGTextInterface *interface)
Definition: MSWrite.cpp:898
Paragraph()
Definition: MSWrite.h:44
uint32_t m_fcMac
Definition: MSWrite.h:182
HeaderFooterOccurrence
Definition: WPSPageSpan.h:44
This class parses Microsoft Write 3.0 and 3.1.
Definition: MSWrite.h:127
double m_dxaGutter
Definition: MSWrite.h:117
virtual void readSUMD()
Definition: MSWrite.cpp:1676
bool m_headerUseMargin
Definition: MSWrite.h:57
void parse(librevenge::RVNGTextInterface *documentInterface) override
Definition: MSWrite.cpp:1761
virtual void insertControl(uint8_t val, uint32_t fc)
Definition: MSWrite.cpp:1099
bool processDIB(librevenge::RVNGBinaryData &bmpdata, unsigned size)
Definition: MSWrite.cpp:1477
virtual void readPAP(uint32_t fcFirst, uint32_t fcLim, unsigned cch)
Definition: MSWrite.cpp:605
bool processDDB(librevenge::RVNGBinaryData &bmpdata, WPSPosition &pos, unsigned width, unsigned height, unsigned byte_width, unsigned planes, unsigned bits_pixel, unsigned size)
Definition: MSWrite.cpp:1292
bool m_endFtns
Definition: MSWrite.h:115
uint32_t m_fcRef
Definition: MSWrite.h:82
some Windows© classes and tools
Definition: libwps_tools_win.cpp:31
~MSWriteParser() override
Definition: MSWrite.cpp:309
void readStructures()
Definition: MSWrite.cpp:1686
bool checkFilePosition(uint32_t pos) const
check if the file position is correct or not
Definition: MSWrite.h:175
Definition: WPSPageSpan.h:38
Definition: MSWrite.h:85
Location m_Location
Definition: MSWrite.h:56
std::vector< MSWriteParserInternal::Section > m_sections
Definition: MSWrite.h:187
basic class to store an entry in a file This contained :
Definition: WPSEntry.h:38
void readFOD(unsigned page, void(MSWriteParser::*parseFOD)(uint32_t fcFirst, uint32_t fcLim, unsigned size))
Definition: MSWrite.cpp:550
Class to define the position of an object (textbox, picture, ..) in the document. ...
Definition: WPSPosition.h:39
Location
Definition: MSWrite.h:43
bool processWMF(librevenge::RVNGBinaryData &wmfdata, unsigned size)
Definition: MSWrite.cpp:1657
Definition: libwps_tools_win.h:52
virtual libwps_tools_win::Font::Type getFileEncoding(libwps_tools_win::Font::Type hint)
Definition: MSWrite.cpp:313
std::shared_ptr< WPSHeader > WPSHeaderPtr
shared pointer to WPSHeader
Definition: libwps_internal.h:109
uint32_t m_fileLength
the last file position
Definition: MSWrite.h:181
void processObject(WPSPosition &pos, unsigned long lastPos)
Definition: MSWrite.cpp:1183
Definition: MSWrite.h:41
Section()
constructor
Definition: MSWrite.h:88
Definition: MSWrite.h:77

Generated on Fri May 27 2022 03:07:00 for libwps by doxygen 1.8.14