MsWks4Zone.hxx Source File documentation

MsWks4Zone.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 #ifndef MS_WKS4_ZONE
35 # define MS_WKS4_ZONE
36
37 #include <map>
38 #include <string>
39
40 #include "MWAWDebug.hxx"
41 #include "MWAWEntry.hxx"
42 #include "MWAWInputStream.hxx"
43
44 #include "MWAWParser.hxx"
45
46 #include "MsWksDocument.hxx"
47
48 class MsWksParser;
49 class MsWksDRParser;
50
51 namespace MsWks4ZoneInternal
52 {
53 struct State;
54 }
55
73 class MsWks4Zone
74 {
75 friend class MsWksDocument;
76 friend class MsWksDRParser;
77 friend class MsWksParser;
78 friend class MsWks4Text;
79
80 public:
82 MsWks4Zone(MWAWInputStreamPtr const &input, MWAWParserStatePtr const &parserState,
83 MWAWParser &parser, std::string const &oleName);
85 ~MsWks4Zone();
86
87 protected:
89 void init();
91 MWAWInputStreamPtr getInput();
92
97 bool parseHeaderIndex(MWAWInputStreamPtr &input);
98
100 bool parseHeaderIndexEntry(MWAWInputStreamPtr &input);
101
103 bool createZones(bool mainOle);
104
108 void readContentZones(MWAWEntry const &entry, bool mainOle);
109
111 MWAWTextListenerPtr createListener(librevenge::RVNGTextInterface *interface);
112
114 double getTextHeight() const;
115
117 void newPage(int number, bool soft=false);
118
120 void readFootNote(int id);
121
123 MWAWEntry getTextPosition() const;
124
125 //
126 // low level
127 //
128
130 bool readPRNT(MWAWInputStreamPtr input, MWAWEntry const &entry, MWAWPageSpan &page);
131
135 bool readDOP(MWAWInputStreamPtr input, MWAWEntry const &entry, MWAWPageSpan &page);
136
140 bool readFRAM(MWAWInputStreamPtr input, MWAWEntry const &entry);
141
145 bool readRLRB(MWAWInputStreamPtr input, MWAWEntry const &entry);
146
150 bool readSELN(MWAWInputStreamPtr input, MWAWEntry const &entry);
151
153 void setAscii(std::string const &oleName);
155 libmwaw::DebugFile &ascii();
156
157 private:
158 MsWks4Zone(MsWks4Zone const &orig) = delete;
159 MsWks4Zone &operator=(MsWks4Zone const &orig) = delete;
160 protected:
161 //
162 // data
163 //
164
166 MWAWParser *m_mainParser;
167
169 std::shared_ptr<MWAWParserState> m_parserState;
170
172 std::shared_ptr<MsWks4ZoneInternal::State> m_state;
173
175 std::shared_ptr<MsWksDocument> m_document;
176 };
177 #endif
178 // vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
MWAWTextListenerPtr
std::shared_ptr< MWAWTextListener > MWAWTextListenerPtr
a smart pointer of MWAWTextListener
Definition: libmwaw_internal.hxx:563
MsWks4Zone::readFootNote
void readFootNote(int id)
sends text corresponding to the footnote id to the listener (via MsWks4Text)
Definition: MsWks4Zone.cxx:222
MWAWParserStatePtr
std::shared_ptr< MWAWParserState > MWAWParserStatePtr
a smart pointer of MWAWParserState
Definition: libmwaw_internal.hxx:553
MsWks4Zone::setAscii
void setAscii(std::string const &oleName)
inits the ascii file
Definition: MsWks4Zone.cxx:211
MsWks4Zone::newPage
void newPage(int number, bool soft=false)
adds a new page
Definition: MsWks4Zone.cxx:238
MWAWParser.hxx
MsWksParser
the main class to read a Microsoft Works file: v1-v4
Definition: MsWksParser.hxx:59
MsWks4Text
The class which parses text zones in a mac MS Works document v4.
Definition: MsWks4Text.hxx:64
MWAWPageSpan
A class which defines the page properties.
Definition: MWAWPageSpan.hxx:95
MWAWEntry.hxx
MsWks4Zone::m_mainParser
MWAWParser * m_mainParser
the main parser
Definition: MsWks4Zone.hxx:166
libmwaw::DebugFile
an interface used to insert comment in a binary file, written in ascii form (if debug_with_files is n...
Definition: MWAWDebug.hxx:65
MsWks4Zone::init
void init()
inits all internal variables
Definition: MsWks4Zone.cxx:200
MsWks4Zone::operator=
MsWks4Zone & operator=(MsWks4Zone const &orig)=delete
MsWks4Zone::~MsWks4Zone
~MsWks4Zone()
destructor
Definition: MsWks4Zone.cxx:193
MsWks4Zone::ascii
libmwaw::DebugFile & ascii()
a DebugFile used to write what we recognize when we parse the document
Definition: MsWks4Zone.cxx:217
MsWks4Zone::m_document
std::shared_ptr< MsWksDocument > m_document
the zone data
Definition: MsWks4Zone.hxx:175
MsWks4Zone::readDOP
bool readDOP(MWAWInputStreamPtr input, MWAWEntry const &entry, MWAWPageSpan &page)
parses the DIO zone which contains the document properties (dimension, ...)
Definition: MsWks4Zone.cxx:678
MsWks4Zone
The class which parses the main zones of a mac MS Works document v4.
Definition: MsWks4Zone.hxx:73
MsWks4Zone::getInput
MWAWInputStreamPtr getInput()
returns the actual input
Definition: MsWks4Zone.cxx:206
MsWks4ZoneInternal
Internal: the structures of a MsWks4Zone.
Definition: MsWks4Zone.cxx:57
MsWks4Zone::parseHeaderIndex
bool parseHeaderIndex(MWAWInputStreamPtr &input)
tries to find the beginning of the list of indices, then try to find all entries in this list...
Definition: MsWks4Zone.cxx:392
MsWks4Zone::getTextHeight
double getTextHeight() const
returns the page height, ie. paper size less margin (in inches) less header/footer size ...
Definition: MsWks4Zone.cxx:230
MsWksDRParser
the main class to read a Microsoft Works graphic file
Definition: MsWksDRParser.hxx:59
MsWks4Zone::readSELN
bool readSELN(MWAWInputStreamPtr input, MWAWEntry const &entry)
parses the SELN zone which seems to contain some information about the actual
Definition: MsWks4Zone.cxx:1098
MsWks4Zone::createListener
MWAWTextListenerPtr createListener(librevenge::RVNGTextInterface *interface)
creates the main listener
Definition: MsWks4Zone.cxx:269
MsWks4Zone::readRLRB
bool readRLRB(MWAWInputStreamPtr input, MWAWEntry const &entry)
parses the RLRB zone which seems to contain some position in the page ?
Definition: MsWks4Zone.cxx:876
MWAWInputStream.hxx
MWAWDebug.hxx
MsWks4Zone::m_parserState
std::shared_ptr< MWAWParserState > m_parserState
the parser state
Definition: MsWks4Zone.hxx:169
MWAWInputStreamPtr
std::shared_ptr< MWAWInputStream > MWAWInputStreamPtr
a smart pointer of MWAWInputStream
Definition: libmwaw_internal.hxx:547
MsWks4Zone::parseHeaderIndexEntry
bool parseHeaderIndexEntry(MWAWInputStreamPtr &input)
parses an index entry
Definition: MsWks4Zone.cxx:292
MsWks4Zone::MsWks4Zone
MsWks4Zone(MWAWInputStreamPtr const &input, MWAWParserStatePtr const &parserState, MWAWParser &parser, std::string const &oleName)
constructor
Definition: MsWks4Zone.cxx:180
MsWks4Zone::readContentZones
void readContentZones(MWAWEntry const &entry, bool mainOle)
final reading of a text zone
Definition: MsWks4Zone.cxx:566
MsWks4Zone::createZones
bool createZones(bool mainOle)
finds and parses all the zones to prepare the data
Definition: MsWks4Zone.cxx:471
MsWks4Zone::m_state
std::shared_ptr< MsWks4ZoneInternal::State > m_state
the internal state
Definition: MsWks4Zone.hxx:172
MWAWParser
virtual class which defines the ancestor of all main zone parser
Definition: MWAWParser.hxx:99
MsWks4Zone::readFRAM
bool readFRAM(MWAWInputStreamPtr input, MWAWEntry const &entry)
parses the FRAM zone which contains some information about frames (header, footer, ...)
Definition: MsWks4Zone.cxx:930
MWAWEntry
basic class to store an entry in a file This contained :
Definition: MWAWEntry.hxx:46
MsWks4Zone::getTextPosition
MWAWEntry getTextPosition() const
return the text positions ( used for frame text)
Definition: MsWks4Zone.cxx:261
MsWksDocument.hxx
MsWks4Zone::readPRNT
bool readPRNT(MWAWInputStreamPtr input, MWAWEntry const &entry, MWAWPageSpan &page)
reads the PRNT zone which contains the printer properties ( page dimension, margins, ...)
Definition: MsWks4Zone.cxx:633
MsWksDocument
the main class to read/store generic data of a MsWorks document v1-v3
Definition: MsWksDocument.hxx:68