MsWksGraph.hxx Source File documentation

MsWksGraph.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 Microsoft Works text document ( graphic part )
36 *
37 */
38#ifndef MS_WKS_MWAW_GRAPH
39# define MS_WKS_MWAW_GRAPH
40
41#include <list>
42#include <string>
43#include <vector>
44
45#include "MWAWPosition.hxx"
46
47#include "MWAWEntry.hxx"
48#include "MWAWGraphicStyle.hxx"
49#include "MWAWParser.hxx"
50
51namespace MsWksGraphInternal
52{
53struct GroupZone;
54struct RBZone;
55struct TextBox;
56struct Zone;
57
58struct State;
59
60class SubDocument;
61}
62
63class MsWksTable;
64class MsWksDocument;
65
66class MsWksParser;
67class MsWks4Zone;
68class MsWksDBParser;
69class MsWksDRParser;
70class MsWksSSParser;
71
73 class MsWksGraph
74{
75 friend class MsWksDocument;
76 friend class MsWksTable;
77
78 friend class MsWksParser;
79 friend class MsWks4Zone;
80 friend class MsWksDBParser;
81 friend class MsWksDRParser;
82 friend class MsWksSSParser;
83 friend class MsWksGraphInternal::SubDocument;
84public:
85 struct Style;
86
88 explicit MsWksGraph(MsWksDocument &document);
90 virtual ~MsWksGraph();
91
93 void setPageLeftTop(MWAWVec2f const &leftTop);
94
96 int version() const;
98 int numPages(int zoneId) const;
99
104 void send(int id, MWAWPosition const &pos);
106 void sendAll(int zoneId, bool mainZone);
107
109 struct SendData {
111 SendData()
112 : m_type(RBDR)
113 , m_id(-1)
114 , m_anchor(MWAWPosition::Char)
115 , m_page(-1)
116 , m_size()
117 {
118 }
119
120 enum Type { RBDR, RBIL, ALL } m_type;
122 int m_id;
124 MWAWPosition::AnchorTo m_anchor;
126 int m_page;
128 MWAWVec2i m_size;
129 };
130
131 void sendObjects(SendData const &what);
132
134 void computePositions(int zoneId, std::vector<int> &linesHeight, std::vector<int> &pagesHeight);
135
136protected:
138 void flushExtra();
139
140 //
141 // Intermediate level
142 //
143
145 bool readPictHeader(MsWksGraphInternal::Zone &pict);
147 bool readGradient(Style &style);
149 int getEntryPictureV1(int zoneId, MWAWEntry &zone, bool autoSend=true);
150
152 int getEntryPicture(int zoneId, MWAWEntry &zone, bool autoSend=true, int order=-1000);
153
160 bool readRB(MWAWInputStreamPtr input, MWAWEntry const &entry, int kind);
161
162 // version 4 file
163
165 bool readPictureV4(MWAWInputStreamPtr input, MWAWEntry const &entry);
166
168 bool readText(MsWksGraphInternal::TextBox &textBox);
170 void sendTextBox(int zId, MWAWListenerPtr listener);
172 void checkTextBoxLinks(MsWksGraphInternal::RBZone &rbZone);
173
174 // interface function
175
177 bool getZoneGraphicStyle(int zoneId, MWAWGraphicStyle &style) const;
179 bool getZonePosition(int zoneId, MWAWPosition::AnchorTo anchor, MWAWPosition &pos) const;
180
182 void sendFrameText(MWAWEntry const &entry, std::string const &frame);
183
185 void sendTable(int id);
186
188 void sendChart(int zoneId);
189
190 //
191 // low level
192 //
194 std::shared_ptr<MsWksGraphInternal::GroupZone> readGroup(MsWksGraphInternal::Zone &group);
196 void sendGroup(int zoneId, MWAWPosition const &pos);
198 void sendGroupChild(int zoneId, MWAWPosition const &pos);
200 bool canCreateGraphic(MsWksGraphInternal::GroupZone const &group) const;
202 void sendGroup(MsWksGraphInternal::GroupZone const &group, MWAWGraphicListenerPtr &listener) const;
204 bool readFont(MWAWFont &font);
205
206public:
208 struct Style final : public MWAWGraphicStyle {
210 Style()
211 : MWAWGraphicStyle()
212 , m_baseLineColor(MWAWColor::black())
213 , m_baseSurfaceColor(MWAWColor::white())
214 {
215 m_fillRuleEvenOdd=true;
216 }
217 Style(Style const &)=default;
218 Style &operator=(Style const &)=default;
219 Style &operator=(Style &&)=default;
221 ~Style() final;
223 friend std::ostream &operator<<(std::ostream &o, Style const &st)
224 {
225 o << static_cast<MWAWGraphicStyle const &>(st);
226 if (st.m_baseLineColor != st.m_lineColor)
227 o << "lineColor[base]=" << st.m_baseLineColor << ",";
228 if (st.m_baseSurfaceColor != st.m_surfaceColor)
229 o << "surfaceColor[base]=" << st.m_baseSurfaceColor << ",";
230
231 return o;
232 }
233
235 MWAWColor m_baseLineColor;
237 MWAWColor m_baseSurfaceColor;
238 };
239
240private:
241 MsWksGraph(MsWksGraph const &orig) = delete;
242 MsWksGraph &operator=(MsWksGraph const &orig) = delete;
243
244protected:
245 //
246 // data
247 //
249 MWAWParserStatePtr m_parserState;
250
252 std::shared_ptr<MsWksGraphInternal::State> m_state;
253
255 MWAWParser *m_mainParser;
257 MsWksDocument &m_document;
258
260 std::shared_ptr<MsWksTable> m_tableParser;
261};
262#endif
263// vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
MWAWEntry.hxx
MWAWGraphicStyle.hxx
MWAWParser.hxx
MWAWPosition.hxx
MWAWEntry
basic class to store an entry in a file This contained :
Definition MWAWEntry.hxx:47
MWAWFont
Class to store font.
Definition MWAWFont.hxx:44
MWAWGraphicStyle
a structure used to define a picture style
Definition MWAWGraphicStyle.hxx:48
MWAWGraphicStyle::m_fillRuleEvenOdd
bool m_fillRuleEvenOdd
true if the fill rule is evenod
Definition MWAWGraphicStyle.hxx:646
MWAWGraphicStyle::MWAWGraphicStyle
MWAWGraphicStyle()
constructor
Definition MWAWGraphicStyle.hxx:445
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
MWAWPosition::AnchorTo
AnchorTo
a list of enum used to defined the anchor
Definition MWAWPosition.hxx:51
MsWks4Zone
The class which parses the main zones of a mac MS Works document v4.
Definition MsWks4Zone.hxx:74
MsWksDBParser
the main class to read a Microsoft Works database file and convert it in a spreadsheet file
Definition MsWksDBParser.hxx:66
MsWksDRParser
the main class to read a Microsoft Works graphic file
Definition MsWksDRParser.hxx:60
MsWksDocument
the main class to read/store generic data of a MsWorks document v1-v3
Definition MsWksDocument.hxx:69
MsWksGraphInternal::SubDocument
Internal: the subdocument of a MsWksGraph.
Definition MsWksGraph.cxx:956
MsWksGraph::readGradient
bool readGradient(Style &style)
read the gradient structure ( v4)
Definition MsWksGraph.cxx:1356
MsWksGraph::sendObjects
void sendObjects(SendData const &what)
sends all the object of a page, frame, ...
Definition MsWksGraph.cxx:2968
MsWksGraph::getEntryPicture
int getEntryPicture(int zoneId, MWAWEntry &zone, bool autoSend=true, int order=-1000)
checks if the next zone is a v2 picture and returns a zone id ( or -1)
Definition MsWksGraph.cxx:1457
MsWksGraph::send
void send(int id, MWAWPosition const &pos)
send a zone (textbox, ...).
Definition MsWksGraph.cxx:2829
MsWksGraph::readGroup
std::shared_ptr< MsWksGraphInternal::GroupZone > readGroup(MsWksGraphInternal::Zone &group)
try to read the group data
Definition MsWksGraph.cxx:2526
MsWksGraph::checkTextBoxLinks
void checkTextBoxLinks(MsWksGraphInternal::RBZone &rbZone)
check the text box link v4
Definition MsWksGraph.cxx:2228
MsWksGraph::sendTextBox
void sendTextBox(int zId, MWAWListenerPtr listener)
try to send a text box zone v1-3
Definition MsWksGraph.cxx:2761
MsWksGraph::version
int version() const
returns the file version
Definition MsWksGraph.cxx:1088
MsWksGraph::MsWksGraph
MsWksGraph(MsWksDocument &document)
constructor
Definition MsWksGraph.cxx:1068
MsWksGraph::flushExtra
void flushExtra()
sends the data which have not yet been sent to the listener
Definition MsWksGraph.cxx:3045
MsWksGraph::getEntryPictureV1
int getEntryPictureV1(int zoneId, MWAWEntry &zone, bool autoSend=true)
checks if the next zone is a v1 picture and returns a zone id ( or -1).
Definition MsWksGraph.cxx:2008
MsWksGraph::MsWksTable
friend class MsWksTable
Definition MsWksGraph.hxx:76
MsWksGraph::MsWksParser
friend class MsWksParser
Definition MsWksGraph.hxx:78
MsWksGraph::readFont
bool readFont(MWAWFont &font)
reads the textbox font
Definition MsWksGraph.cxx:2713
MsWksGraph::readRB
bool readRB(MWAWInputStreamPtr input, MWAWEntry const &entry, int kind)
reads the RBDR or a RBIL zone: a zone which seems to regroup all pages pictures in v3-v4 document
Definition MsWksGraph.cxx:2072
MsWksGraph::computePositions
void computePositions(int zoneId, std::vector< int > &linesHeight, std::vector< int > &pagesHeight)
try to update positions knowing pages and lines height
Definition MsWksGraph.cxx:1975
MsWksGraph::numPages
int numPages(int zoneId) const
returns the number of pages
Definition MsWksGraph.cxx:1095
MsWksGraph::canCreateGraphic
bool canCreateGraphic(MsWksGraphInternal::GroupZone const &group) const
returns true if we can create a graphic for the whole group
Definition MsWksGraph.cxx:2455
MsWksGraph::getZoneGraphicStyle
bool getZoneGraphicStyle(int zoneId, MWAWGraphicStyle &style) const
returns the graphic style of the zone defined by zoneId
Definition MsWksGraph.cxx:1130
MsWksGraph::MsWksSSParser
friend class MsWksSSParser
Definition MsWksGraph.hxx:82
MsWksGraph::sendChart
void sendChart(int zoneId)
try to send a chart
Definition MsWksGraph.cxx:1115
MsWksGraph::MsWksGraph
MsWksGraph(MsWksGraph const &orig)=delete
MsWksGraph::m_parserState
MWAWParserStatePtr m_parserState
the parser state
Definition MsWksGraph.hxx:249
MsWksGraph::MsWks4Zone
friend class MsWks4Zone
Definition MsWksGraph.hxx:79
MsWksGraph::sendTable
void sendTable(int id)
try to a table zone
Definition MsWksGraph.cxx:1120
MsWksGraph::m_state
std::shared_ptr< MsWksGraphInternal::State > m_state
the state
Definition MsWksGraph.hxx:252
MsWksGraph::m_document
MsWksDocument & m_document
the main document
Definition MsWksGraph.hxx:257
MsWksGraph::readPictHeader
bool readPictHeader(MsWksGraphInternal::Zone &pict)
read the picture header
Definition MsWksGraph.cxx:1150
MsWksGraph::MsWksDBParser
friend class MsWksDBParser
Definition MsWksGraph.hxx:80
MsWksGraph::readPictureV4
bool readPictureV4(MWAWInputStreamPtr input, MWAWEntry const &entry)
reads a Pict zone: a zone which seems to code in v4 : header/footer picture
Definition MsWksGraph.cxx:2285
MsWksGraph::readText
bool readText(MsWksGraphInternal::TextBox &textBox)
try to read a text zone
Definition MsWksGraph.cxx:2566
MsWksGraph::sendAll
void sendAll(int zoneId, bool mainZone)
send all the picture corresponding to a zone
Definition MsWksGraph.cxx:2954
MsWksGraph::sendFrameText
void sendFrameText(MWAWEntry const &entry, std::string const &frame)
ask m_mainParser to send a frame text(v4)
Definition MsWksGraph.cxx:1110
MsWksGraph::~MsWksGraph
virtual ~MsWksGraph()
destructor
Definition MsWksGraph.cxx:1079
MsWksGraph::operator=
MsWksGraph & operator=(MsWksGraph const &orig)=delete
MsWksGraph::getZonePosition
bool getZonePosition(int zoneId, MWAWPosition::AnchorTo anchor, MWAWPosition &pos) const
returns the position of the zone defined by zoneId
Definition MsWksGraph.cxx:1140
MsWksGraph::m_mainParser
MWAWParser * m_mainParser
the main parser;
Definition MsWksGraph.hxx:255
MsWksGraph::sendGroup
void sendGroup(int zoneId, MWAWPosition const &pos)
try to send a group
Definition MsWksGraph.cxx:2317
MsWksGraph::setPageLeftTop
void setPageLeftTop(MWAWVec2f const &leftTop)
define the page left top dimension in point
Definition MsWksGraph.cxx:1083
MsWksGraph::MsWksDocument
friend class MsWksDocument
Definition MsWksGraph.hxx:75
MsWksGraph::m_tableParser
std::shared_ptr< MsWksTable > m_tableParser
the table manager
Definition MsWksGraph.hxx:260
MsWksGraph::MsWksDRParser
friend class MsWksDRParser
Definition MsWksGraph.hxx:81
MsWksGraph::sendGroupChild
void sendGroupChild(int zoneId, MWAWPosition const &pos)
try to send a group elements by elemenys
Definition MsWksGraph.cxx:2354
MsWksParser
the main class to read a Microsoft Works file: v1-v4
Definition MsWksParser.hxx:60
MsWksSSParser
the main class to read a Microsoft Works spreadsheet file
Definition MsWksSSParser.hxx:66
MsWksTable
the main class to read the table ( or a chart ) of a Microsoft Works file
Definition MsWksTable.hxx:59
MWAWVec2i
MWAWVec2< int > MWAWVec2i
MWAWVec2 of int.
Definition libmwaw_internal.hxx:838
MWAWGraphicListenerPtr
std::shared_ptr< MWAWGraphicListener > MWAWGraphicListenerPtr
a smart pointer of MWAWGraphicListener
Definition libmwaw_internal.hxx:549
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
MWAWVec2f
MWAWVec2< float > MWAWVec2f
MWAWVec2 of float.
Definition libmwaw_internal.hxx:842
MWAWInputStreamPtr
std::shared_ptr< MWAWInputStream > MWAWInputStreamPtr
a smart pointer of MWAWInputStream
Definition libmwaw_internal.hxx:551
MsWksGraphInternal
Internal: the structures of a MsWksGraph.
Definition MsWksGraph.cxx:64
MWAWColor
the class to store a color
Definition libmwaw_internal.hxx:192
MsWksGraphInternal::GroupZone
Internal: the group of a MsWksGraph.
Definition MsWksGraph.cxx:315
MsWksGraphInternal::RBZone
Internal: a list of zones ( for v4).
Definition MsWksGraph.cxx:67
MsWksGraphInternal::State
Internal: the state of a MsWksGraph.
Definition MsWksGraph.cxx:825
MsWksGraphInternal::TextBox
Internal: the textbox of a MsWksGraph ( v2-v3).
Definition MsWksGraph.cxx:615
MsWksGraphInternal::Zone
Internal: the generic pict.
Definition MsWksGraph.cxx:92
MsWksGraph::SendData
small struct used which picture need to be send
Definition MsWksGraph.hxx:109
MsWksGraph::SendData::m_id
int m_id
the rbil id
Definition MsWksGraph.hxx:122
MsWksGraph::SendData::m_page
int m_page
the page ( used if anchor==page)
Definition MsWksGraph.hxx:126
MsWksGraph::SendData::m_size
MWAWVec2i m_size
the size of the data ( used by rbil )
Definition MsWksGraph.hxx:128
MsWksGraph::SendData::SendData
SendData()
constructor
Definition MsWksGraph.hxx:111
MsWksGraph::SendData::Type
Type
the type
Definition MsWksGraph.hxx:120
MsWksGraph::SendData::ALL
@ ALL
Definition MsWksGraph.hxx:120
MsWksGraph::SendData::RBDR
@ RBDR
Definition MsWksGraph.hxx:120
MsWksGraph::SendData::RBIL
@ RBIL
Definition MsWksGraph.hxx:120
MsWksGraph::SendData::m_type
enum MsWksGraph::SendData::Type m_type
MsWksGraph::SendData::m_anchor
MWAWPosition::AnchorTo m_anchor
the anchor
Definition MsWksGraph.hxx:124
MsWksGraph::Style
Internal: the graphic style of MsWksGraph.
Definition MsWksGraph.hxx:208
MsWksGraph::Style::~Style
~Style() final
destructor
Definition MsWksGraph.cxx:3059
MsWksGraph::Style::m_baseLineColor
MWAWColor m_baseLineColor
the line color
Definition MsWksGraph.hxx:235
MsWksGraph::Style::m_baseSurfaceColor
MWAWColor m_baseSurfaceColor
the 2D surface color
Definition MsWksGraph.hxx:237
MsWksGraph::Style::Style
Style()
constructor
Definition MsWksGraph.hxx:210
MsWksGraph::Style::operator=
Style & operator=(Style const &)=default
MsWksGraph::Style::operator=
Style & operator=(Style &&)=default
MsWksGraph::Style::Style
Style(Style const &)=default