ClarisWksGraph.hxx Source File documentation

ClarisWksGraph.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 * Parser to Claris Works text document ( graphic part )
36 *
37 */
38#ifndef CLARIS_WKS_GRAPH
39# define CLARIS_WKS_GRAPH
40
41#include <string>
42#include <vector>
43
44#include <librevenge/librevenge.h>
45
46#include "libmwaw_internal.hxx"
47
48#include "MWAWDebug.hxx"
49#include "MWAWInputStream.hxx"
50#include "MWAWPosition.hxx"
51
52#include "ClarisWksStruct.hxx"
53
54namespace ClarisWksGraphInternal
55{
56struct Group;
57struct State;
58struct Style;
59struct Zone;
60struct Chart;
61struct ZoneShape;
62struct Bitmap;
63struct ZonePict;
64
65class SubDocument;
66}
67
68class ClarisWksDocument;
69class ClarisWksParser;
70class MWAWParser;
71
77 class ClarisWksGraph
78{
79 friend class ClarisWksGraphInternal::SubDocument;
80 friend class ClarisWksDocument;
81 friend class ClarisWksParser;
82
83public:
85 explicit ClarisWksGraph(ClarisWksDocument &document);
87 virtual ~ClarisWksGraph();
88
90 int version() const;
91
93 int numPages() const;
94
96 bool getPageDimension(MWAWVec2f &dim) const;
97
99 void computePositions() const;
100
102 void findMasterPage() const;
103
105 std::shared_ptr<ClarisWksStruct::DSET> readGroupZone
106 (ClarisWksStruct::DSET const &zone, MWAWEntry const &entry, bool &complete);
107
109 std::shared_ptr<ClarisWksStruct::DSET> readBitmapZone
110 (ClarisWksStruct::DSET const &zone, MWAWEntry const &entry, bool &complete);
111
113 bool readDatabasePictZone();
114
116 bool getSurfaceColor(ClarisWksGraphInternal::Style const &style, MWAWColor &col) const;
117protected:
119 bool canSendGroupAsGraphic(int number) const;
121 bool sendPageGraphics(int groupId);
123 bool sendMaster(int pg);
125 bool sendDatabasePictZone(int pictId, MWAWListenerPtr listener, MWAWPosition const &pos=MWAWPosition());
127 bool sendGroup(int number, MWAWListenerPtr listener, MWAWPosition const &pos=MWAWPosition());
129 bool canSendBitmapAsGraphic(int number) const;
131 bool sendBitmap(int number, MWAWListenerPtr listener, MWAWPosition const &pos=MWAWPosition());
132
134 void flushExtra();
135
136 // interface with main parser
137
139 void askToSend(int number, MWAWListenerPtr listener, MWAWPosition const &pos=MWAWPosition());
140
141 //
142 // Intermediate level
143 //
144
146 void updateGroup(ClarisWksGraphInternal::Group &group) const;
148 bool canSendAsGraphic(ClarisWksGraphInternal::Group &group) const;
150 bool sendGroup(ClarisWksGraphInternal::Group &group, MWAWPosition const &position);
152 bool sendGroupChild(std::vector<std::shared_ptr<ClarisWksGraphInternal::Zone> > const &lChild, MWAWListenerPtr listener, MWAWVec2f const &leftTop);
154 bool sendGroupChild(std::shared_ptr<ClarisWksGraphInternal::Zone> zone, MWAWPosition position);
156 bool sendPageChild(ClarisWksGraphInternal::Group &group);
157 /* read a simple group */
158 std::shared_ptr<ClarisWksGraphInternal::Zone> readGroupDef(MWAWEntry const &entry);
159 /* read the group data.
160
161 \note \a beginGroupPos is only used to help debugging */
162 bool readGroupData(ClarisWksGraphInternal::Group &group, long beginGroupPos);
163
164 /* read a simple graphic zone */
165 bool readShape(MWAWEntry const &entry,
166 ClarisWksGraphInternal::ZoneShape &zone);
167
168 /* try to read the chart data */
169 bool readChartData(std::shared_ptr<ClarisWksGraphInternal::Zone> zone);
170
171 /* try to read a pict data zone */
172 bool readPictData(std::shared_ptr<ClarisWksGraphInternal::Zone> zone);
173
174 /* try to read the polygon data */
175 bool readPolygonData(std::shared_ptr<ClarisWksGraphInternal::Zone> zone);
176
177 /* read a picture */
178 bool readPICT(ClarisWksGraphInternal::ZonePict &zone);
179
180 /* read a postcript zone */
181 bool readPS(ClarisWksGraphInternal::ZonePict &zone);
182
183 /* read a ole document zone */
184 bool readOLE(ClarisWksGraphInternal::ZonePict &zone);
185
187 /* try to read the qtime data zone */
188 bool readQTimeData(std::shared_ptr<ClarisWksGraphInternal::Zone> zone);
189
190 /* read a named picture */
191 bool readNamedPict(ClarisWksGraphInternal::ZonePict &zone);
192
194 /* try to read a bitmap zone */
195 bool readBitmapColorMap(std::vector<MWAWColor> &cMap);
196
197 /* try to read the bitmap */
198 bool readBitmapData(ClarisWksGraphInternal::Bitmap &zone);
199 //
200 // low level
201 //
202
203 /* read the first zone of a group type */
204 bool readGroupHeader(ClarisWksGraphInternal::Group &group);
205
206 /* read some unknown data in first zone */
207 bool readGroupUnknown(ClarisWksGraphInternal::Group &group, int zoneSz, int id);
208
210 bool sendPicture(ClarisWksGraphInternal::ZonePict &pict, MWAWPosition pos);
211
213 bool sendShape(ClarisWksGraphInternal::ZoneShape const &pict, MWAWPosition pos);
214
216 bool sendBitmap(ClarisWksGraphInternal::Bitmap &pict, MWAWListener &listener, MWAWPosition pos);
217
218private:
219 ClarisWksGraph(ClarisWksGraph const &orig) = delete;
220 ClarisWksGraph &operator=(ClarisWksGraph const &orig) = delete;
221
222protected:
223 //
224 // data
225 //
227 ClarisWksDocument &m_document;
228
230 MWAWParserStatePtr m_parserState;
231
233 std::shared_ptr<ClarisWksGraphInternal::State> m_state;
234
236 MWAWParser *m_mainParser;
237};
238#endif
239// vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
ClarisWksStruct.hxx
MWAWDebug.hxx
MWAWInputStream.hxx
MWAWPosition.hxx
ClarisWksDocument
main document information used to create a ClarisWorks file
Definition: ClarisWksDocument.hxx:74
ClarisWksGraphInternal::SubDocument
Internal: the subdocument of a ClarisWksGraph.
Definition: ClarisWksGraph.cxx:776
ClarisWksGraph
the main class to read the graphic part of Claris Works file
Definition: ClarisWksGraph.hxx:78
ClarisWksGraph::readPictData
bool readPictData(std::shared_ptr< ClarisWksGraphInternal::Zone > zone)
Definition: ClarisWksGraph.cxx:2249
ClarisWksGraph::readChartData
bool readChartData(std::shared_ptr< ClarisWksGraphInternal::Zone > zone)
Definition: ClarisWksGraph.cxx:2202
ClarisWksGraph::sendPageGraphics
bool sendPageGraphics(int groupId)
sends the page element
Definition: ClarisWksGraph.cxx:3410
ClarisWksGraph::readGroupUnknown
bool readGroupUnknown(ClarisWksGraphInternal::Group &group, int zoneSz, int id)
Definition: ClarisWksGraph.cxx:2051
ClarisWksGraph::readGroupHeader
bool readGroupHeader(ClarisWksGraphInternal::Group &group)
Definition: ClarisWksGraph.cxx:1958
ClarisWksGraph::sendPicture
bool sendPicture(ClarisWksGraphInternal::ZonePict &pict, MWAWPosition pos)
sends a picture zone
Definition: ClarisWksGraph.cxx:3278
ClarisWksGraph::m_mainParser
MWAWParser * m_mainParser
the main parser;
Definition: ClarisWksGraph.hxx:236
ClarisWksGraph::computePositions
void computePositions() const
compute the pages position
Definition: ClarisWksGraph.cxx:849
ClarisWksGraph::canSendBitmapAsGraphic
bool canSendBitmapAsGraphic(int number) const
check if we can send a group as graphic
Definition: ClarisWksGraph.cxx:3139
ClarisWksGraph::m_state
std::shared_ptr< ClarisWksGraphInternal::State > m_state
the state
Definition: ClarisWksGraph.hxx:233
ClarisWksGraph::readShape
bool readShape(MWAWEntry const &entry, ClarisWksGraphInternal::ZoneShape &zone)
Definition: ClarisWksGraph.cxx:1818
ClarisWksGraph::readPS
bool readPS(ClarisWksGraphInternal::ZonePict &zone)
Definition: ClarisWksGraph.cxx:2346
ClarisWksGraph::numPages
int numPages() const
returns the number of pages
Definition: ClarisWksGraph.cxx:860
ClarisWksGraph::sendBitmap
bool sendBitmap(int number, MWAWListenerPtr listener, MWAWPosition const &pos=MWAWPosition())
sends the bitmap data to the listener (if it exists )
Definition: ClarisWksGraph.cxx:3167
ClarisWksGraph::updateGroup
void updateGroup(ClarisWksGraphInternal::Group &group) const
update the group information to choose how to send the group data
Definition: ClarisWksGraph.cxx:2634
ClarisWksGraph::sendGroupChild
bool sendGroupChild(std::vector< std::shared_ptr< ClarisWksGraphInternal::Zone > > const &lChild, MWAWListenerPtr listener, MWAWVec2f const &leftTop)
send a child group as graphic or as presentation
Definition: ClarisWksGraph.cxx:2695
ClarisWksGraph::readPICT
bool readPICT(ClarisWksGraphInternal::ZonePict &zone)
Definition: ClarisWksGraph.cxx:2311
ClarisWksGraph::readGroupZone
std::shared_ptr< ClarisWksStruct::DSET > readGroupZone(ClarisWksStruct::DSET const &zone, MWAWEntry const &entry, bool &complete)
reads the zone Group DSET
Definition: ClarisWksGraph.cxx:902
ClarisWksGraph::sendMaster
bool sendMaster(int pg)
sends the master zone (ie. the background zone in a graphic document)
Definition: ClarisWksGraph.cxx:3382
ClarisWksGraph::sendPageChild
bool sendPageChild(ClarisWksGraphInternal::Group &group)
send the child element corresponding to some page
Definition: ClarisWksGraph.cxx:2754
ClarisWksGraph::readBitmapColorMap
bool readBitmapColorMap(std::vector< MWAWColor > &cMap)
Definition: ClarisWksGraph.cxx:2519
ClarisWksGraph::readQTimeData
bool readQTimeData(std::shared_ptr< ClarisWksGraphInternal::Zone > zone)
Definition: ClarisWksGraph.cxx:2433
ClarisWksGraph::findMasterPage
void findMasterPage() const
find the master zone to the content zones in a graphic document
Definition: ClarisWksGraph.cxx:1293
ClarisWksGraph::ClarisWksGraph
ClarisWksGraph(ClarisWksGraph const &orig)=delete
ClarisWksGraph::sendDatabasePictZone
bool sendDatabasePictZone(int pictId, MWAWListenerPtr listener, MWAWPosition const &pos=MWAWPosition())
sends the database zone if known
Definition: ClarisWksGraph.cxx:3151
ClarisWksGraph::sendGroup
bool sendGroup(int number, MWAWListenerPtr listener, MWAWPosition const &pos=MWAWPosition())
sends the zone data to the listener (if it exists )
Definition: ClarisWksGraph.cxx:3423
ClarisWksGraph::readGroupDef
std::shared_ptr< ClarisWksGraphInternal::Zone > readGroupDef(MWAWEntry const &entry)
Definition: ClarisWksGraph.cxx:1338
ClarisWksGraph::getPageDimension
bool getPageDimension(MWAWVec2f &dim) const
returns the page dimension if known (in point)
Definition: ClarisWksGraph.cxx:876
ClarisWksGraph::readGroupData
bool readGroupData(ClarisWksGraphInternal::Group &group, long beginGroupPos)
Definition: ClarisWksGraph.cxx:1626
ClarisWksGraph::sendShape
bool sendShape(ClarisWksGraphInternal::ZoneShape const &pict, MWAWPosition pos)
sends a basic graphic zone
Definition: ClarisWksGraph.cxx:3123
ClarisWksGraph::askToSend
void askToSend(int number, MWAWListenerPtr listener, MWAWPosition const &pos=MWAWPosition())
ask the main parser to send a zone
Definition: ClarisWksGraph.cxx:882
ClarisWksGraph::getSurfaceColor
bool getSurfaceColor(ClarisWksGraphInternal::Style const &style, MWAWColor &col) const
return the surface color which corresponds to some ids (if possible)
Definition: ClarisWksGraph.cxx:890
ClarisWksGraph::m_document
ClarisWksDocument & m_document
the document
Definition: ClarisWksGraph.hxx:227
ClarisWksGraph::operator=
ClarisWksGraph & operator=(ClarisWksGraph const &orig)=delete
ClarisWksGraph::~ClarisWksGraph
virtual ~ClarisWksGraph()
destructor
Definition: ClarisWksGraph.cxx:841
ClarisWksGraph::version
int version() const
returns the file version
Definition: ClarisWksGraph.cxx:844
ClarisWksGraph::readPolygonData
bool readPolygonData(std::shared_ptr< ClarisWksGraphInternal::Zone > zone)
Definition: ClarisWksGraph.cxx:2114
ClarisWksGraph::readOLE
bool readOLE(ClarisWksGraphInternal::ZonePict &zone)
Definition: ClarisWksGraph.cxx:2386
ClarisWksGraph::readBitmapZone
std::shared_ptr< ClarisWksStruct::DSET > readBitmapZone(ClarisWksStruct::DSET const &zone, MWAWEntry const &entry, bool &complete)
reads the zone Bitmap DSET
Definition: ClarisWksGraph.cxx:1000
ClarisWksGraph::readDatabasePictZone
bool readDatabasePictZone()
try to read a database picture zone, v5-v6
Definition: ClarisWksGraph.cxx:1115
ClarisWksGraph::readNamedPict
bool readNamedPict(ClarisWksGraphInternal::ZonePict &zone)
Definition: ClarisWksGraph.cxx:2469
ClarisWksGraph::readBitmapData
bool readBitmapData(ClarisWksGraphInternal::Bitmap &zone)
Definition: ClarisWksGraph.cxx:2566
ClarisWksGraph::canSendAsGraphic
bool canSendAsGraphic(ClarisWksGraphInternal::Group &group) const
check if we can send a group as graphic
Definition: ClarisWksGraph.cxx:3362
ClarisWksGraph::m_parserState
MWAWParserStatePtr m_parserState
the parser state
Definition: ClarisWksGraph.hxx:230
ClarisWksGraph::canSendGroupAsGraphic
bool canSendGroupAsGraphic(int number) const
check if we can send a group as graphic
Definition: ClarisWksGraph.cxx:3354
ClarisWksGraph::flushExtra
void flushExtra()
sends the data which have not yet been sent to the listener
Definition: ClarisWksGraph.cxx:3443
ClarisWksParser
the main class to read a Claris Works file
Definition: ClarisWksParser.hxx:68
MWAWEntry
basic class to store an entry in a file This contained :
Definition: MWAWEntry.hxx:47
MWAWListener
This class contains a virtual interface to all listener.
Definition: MWAWListener.hxx:50
MWAWParser
virtual class which defines the ancestor of all main zone parser
Definition: MWAWParser.hxx:100
MWAWPosition
Class to define the position of an object (textbox, picture, ..) in the document.
Definition: MWAWPosition.hxx:48
MWAWVec2< float >
libmwaw_internal.hxx
MWAWParserStatePtr
std::shared_ptr< MWAWParserState > MWAWParserStatePtr
a smart pointer of MWAWParserState
Definition: libmwaw_internal.hxx:557
MWAWListenerPtr
std::shared_ptr< MWAWListener > MWAWListenerPtr
a smart pointer of MWAWListener
Definition: libmwaw_internal.hxx:553
ClarisWksGraphInternal
Internal: the structures of a ClarisWksGraph.
Definition: ClarisWksGraph.cxx:69
ClarisWksGraphInternal::Bitmap
Internal: structure to store a bitmap of a ClarisWksGraph.
Definition: ClarisWksGraph.cxx:417
ClarisWksGraphInternal::Group
Internal: class which stores a group of graphics, ...
Definition: ClarisWksGraph.cxx:681
ClarisWksGraphInternal::Style
Internal: the structure used to store a style of a ClarisWksGraph.
Definition: ClarisWksGraph.cxx:112
ClarisWksGraphInternal::ZonePict
Internal: the structure used to store a PICT or a MOVIE.
Definition: ClarisWksGraph.cxx:340
ClarisWksGraphInternal::ZoneShape
Internal: small class to store a basic graphic zone of a ClarisWksGraph.
Definition: ClarisWksGraph.cxx:285
ClarisWksStruct::DSET
main structure which correspond to a document part
Definition: ClarisWksStruct.hxx:87
MWAWColor
the class to store a color
Definition: libmwaw_internal.hxx:192