WPS8.h Source File documentation

WPS8.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) 2006, 2007 Andrew Ziem
11 * Copyright (C) 2003-2005 William Lachance (william.lachance@sympatico.ca)
12 * Copyright (C) 2003 Marc Maurer (uwog@uwog.net)
13 *
14 * For minor contributions see the git repository.
15 *
16 * Alternatively, the contents of this file may be used under the terms
17 * of the GNU Lesser General Public License Version 2.1 or later
18 * (LGPLv2.1+), in which case the provisions of the LGPLv2.1+ are
19 * applicable instead of those above.
20 */
21
22 #ifndef WPS8_H
23 #define WPS8_H
24
25 #include <deque>
26 #include <vector>
27
28 #include <librevenge/librevenge.h>
29
30 #include "libwps_internal.h"
31 #include "WPSParser.h"
32
33 class WPSPageSpan;
34
35 namespace WPS8ParserInternal
36 {
37 class SubDocument;
38 struct State;
39 }
40
41 class WPS8Graph;
42 class WPS8Table;
43 class WPS8Text;
44
49 class WPS8Parser final : public WPSParser
50 {
51 friend class WPS8ParserInternal::SubDocument;
52 friend class WPS8Graph;
53 friend class WPS8Table;
54 friend class WPS8Text;
55
56 public:
58 WPS8Parser(RVNGInputStreamPtr &input, WPSHeaderPtr &header);
60 ~WPS8Parser() final;
62 void parse(librevenge::RVNGTextInterface *documentInterface) final;
63 protected:
65 bool checkInFile(long pos);
66
68 void newPage(int number);
70 void setListener(std::shared_ptr<WPSContentListener> const &listener);
72 std::shared_ptr<WPSContentListener> createListener(librevenge::RVNGTextInterface *interface);
73
75 bool createStructures();
77 bool createOLEStructures();
78
80 float pageHeight() const;
82 float pageWidth() const;
84 int numColumns() const;
85
87 void sendPageFrames();
88 // interface with text parser
89
91 void sendTextBox(WPSPosition const &pos, int strsid,
92 librevenge::RVNGPropertyList frameExtras=librevenge::RVNGPropertyList());
93
95 void send(WPSEntry const &entry);
97 void send(int strsId);
98
100 void sendTextInCell(int strsId, int cellId);
101
102 // interface with table parser
103
105 bool sendTable(Vec2f const &size, int objectId);
107 int getTableSTRSId(int tableId) const;
108
109 // interface with graph parser
110
116 bool sendObject(Vec2f const &size, int objectId, bool ole);
117
118 //
119 // low level
120 //
121
123 bool parseHeaderIndexEntry();
126 bool parseHeaderIndexEntryEnd(long endPos, WPSEntry &hie,std::string &mess);
127
132 bool parseHeaderIndex();
133
137 bool readDocProperties(WPSEntry const &entry, WPSPageSpan &page);
138
141 bool readFRAM(WPSEntry const &entry);
143 bool readFRCD(WPSEntry const &entry);
144
149 bool readSYID(WPSEntry const &entry, std::vector<int> &listId);
150
154 bool readWNPR(WPSEntry const &entry);
155
157 bool readSPELLING(RVNGInputStreamPtr input, std::string const &oleName);
158
159 std::shared_ptr<WPSContentListener> m_listener; /* the listener (if set)*/
161 std::shared_ptr<WPS8Graph> m_graphParser;
163 std::shared_ptr<WPS8Table> m_tableParser;
165 std::shared_ptr<WPS8Text> m_textParser;
167 std::shared_ptr<WPS8ParserInternal::State> m_state;
168
169 private:
170 std::deque<int> m_sendingTables;
171 };
172
173 #endif /* WPS8_H */
174 /* vim:set shiftwidth=4 softtabstop=4 noexpandtab: */
WPS8Parser::pageWidth
float pageWidth() const
returns the page width, ie. paper size less margin (in inches)
Definition: WPS8.cpp:355
WPS8Parser::m_state
std::shared_ptr< WPS8ParserInternal::State > m_state
the internal state
Definition: WPS8.h:167
WPS8Parser::createOLEStructures
bool createOLEStructures()
tries to parse the different OLE zones ( except the main zone )
Definition: WPS8.cpp:703
WPS8Parser
This class parses Works version 2000 through 8.
Definition: WPS8.h:49
WPS8Parser::pageHeight
float pageHeight() const
returns the page height, ie. paper size less margin (in inches)
Definition: WPS8.cpp:350
WPS8Parser::getTableSTRSId
int getTableSTRSId(int tableId) const
retrieve the strsId corresponding to a table ( mainly for debug)
Definition: WPS8.cpp:531
WPS8Graph
the main class to read/store pictures in a Pc MS Works document v5-8
Definition: WPS8Graph.h:53
librevenge
Definition: WPSOLEStream.h:33
WPS8Parser::newPage
void newPage(int number)
adds a new page
Definition: WPS8.cpp:433
WPS8Parser::numColumns
int numColumns() const
returns the number of columns
Definition: WPS8.cpp:360
WPS8Text
Definition: WPS8Text.h:47
WPS8Parser::setListener
void setListener(std::shared_ptr< WPSContentListener > const &listener)
set the listener
Definition: WPS8.cpp:379
WPS8Table
the main class to read/store table in a Pc MS Works document v5-8
Definition: WPS8Table.h:57
WPS8Parser::checkInFile
bool checkInFile(long pos)
return true if the pos is in the file, update the file size if need
Definition: WPS8.cpp:365
WPSParser.h
WPS8Parser::send
void send(WPSEntry const &entry)
sends text corresponding to the entry to the listener (via WPS8Text)
Definition: WPS8.cpp:451
WPS8Parser::readFRCD
bool readFRCD(WPSEntry const &entry)
reads the FRCD zone: ie a zone which can contains mailmerge data ?
Definition: WPS8.cpp:1654
WPS8ParserInternal::SubDocument
Internal: the subdocument of a WPS8Parser.
Definition: WPS8.cpp:50
WPS8Parser::createStructures
bool createStructures()
tries to parse the main zone, ...
Definition: WPS8.cpp:608
WPSContentListener
Definition: WPSContentListener.h:44
WPSParser
Definition: WPSParser.h:35
WPS8Parser::m_sendingTables
std::deque< int > m_sendingTables
Definition: WPS8.h:170
WPS8Parser::readSYID
bool readSYID(WPSEntry const &entry, std::vector< int > &listId)
parses a SYID zone
Definition: WPS8.cpp:1839
WPS8Parser::~WPS8Parser
~WPS8Parser() final
destructor
Definition: WPS8.cpp:345
WPS8Parser::sendPageFrames
void sendPageFrames()
send the frames which corresponds to a given page to the listener
Definition: WPS8.cpp:750
libwps_internal.h
WPS8Parser::readSPELLING
bool readSPELLING(RVNGInputStreamPtr input, std::string const &oleName)
finds the structures of the Ole zone "SPELLING"
Definition: WPS8.cpp:2043
WPS8Parser::parse
void parse(librevenge::RVNGTextInterface *documentInterface) final
called by WPSDocument to parse the file
Definition: WPS8.cpp:547
RVNGInputStreamPtr
std::shared_ptr< librevenge::RVNGInputStream > RVNGInputStreamPtr
shared pointer to librevenge::RVNGInputStream
Definition: libwps_internal.h:87
WPS8Parser::sendTable
bool sendTable(Vec2f const &size, int objectId)
sends a table as a character with given size ( via its WPS8Table )
Definition: WPS8.cpp:494
WPS8Parser::readFRAM
bool readFRAM(WPSEntry const &entry)
reads the FRAM zone: ie a zone which can contains textbox, picture, ...
Definition: WPS8.cpp:1277
WPS8Parser::WPS8Parser
WPS8Parser(RVNGInputStreamPtr &input, WPSHeaderPtr &header)
constructor
Definition: WPS8.cpp:329
WPS8Parser::createListener
std::shared_ptr< WPSContentListener > createListener(librevenge::RVNGTextInterface *interface)
creates the main listener
Definition: WPS8.cpp:387
WPS8ParserInternal
Definition: WPS8.cpp:47
WPS8Parser::parseHeaderIndexEntry
bool parseHeaderIndexEntry()
parses an index entry
Definition: WPS8.cpp:797
WPS8Parser::readDocProperties
bool readDocProperties(WPSEntry const &entry, WPSPageSpan &page)
reads the DOP zone: the document properties
Definition: WPS8.cpp:1018
WPS8Parser::sendTextInCell
void sendTextInCell(int strsId, int cellId)
send the text of a cell to a listener (via WPS8Text)
Definition: WPS8.cpp:464
WPS8Parser::m_listener
std::shared_ptr< WPSContentListener > m_listener
Definition: WPS8.h:159
WPS8Parser::readWNPR
bool readWNPR(WPSEntry const &entry)
parses the WNPR zone : a zone which seems to contain the printer preferences.
Definition: WPS8.cpp:1888
WPSPageSpan
Definition: WPSPageSpan.h:38
WPS8Parser::m_graphParser
std::shared_ptr< WPS8Graph > m_graphParser
the graph parser
Definition: WPS8.h:161
WPS8Parser::sendObject
bool sendObject(Vec2f const &size, int objectId, bool ole)
sends an object as a character with given size (via its WPS8Graph )
Definition: WPS8.cpp:485
WPS8Parser::m_tableParser
std::shared_ptr< WPS8Table > m_tableParser
the table parser
Definition: WPS8.h:163
WPSEntry
basic class to store an entry in a file This contained :
Definition: WPSEntry.h:38
Vec2< float >
WPSPosition
Class to define the position of an object (textbox, picture, ..) in the document. ...
Definition: WPSPosition.h:39
WPS8Parser::m_textParser
std::shared_ptr< WPS8Text > m_textParser
the text parser
Definition: WPS8.h:165
WPS8Parser::sendTextBox
void sendTextBox(WPSPosition const &pos, int strsid, librevenge::RVNGPropertyList frameExtras=librevenge::RVNGPropertyList())
creates a subdocument to send a textbox which correspond to the strsid text zone
Definition: WPS8.cpp:472
WPS8Parser::parseHeaderIndexEntryEnd
bool parseHeaderIndexEntryEnd(long endPos, WPSEntry &hie, std::string &mess)
function which is called, if some data remains after the basic content of an entry: by default does n...
Definition: WPS8.cpp:906
WPSHeaderPtr
std::shared_ptr< WPSHeader > WPSHeaderPtr
shared pointer to WPSHeader
Definition: libwps_internal.h:109
WPS8Parser::parseHeaderIndex
bool parseHeaderIndex()
tries to find the beginning of the list of indices, then try to find all entries in this list...
Definition: WPS8.cpp:936