HanMacWrdKGraph.hxx Source File documentation

HanMacWrdKGraph.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 HanMac Word text document ( graphic part )
36 *
37 */
38#ifndef HAN_MAC_WRD_K_GRAPH
39# define HAN_MAC_WRD_K_GRAPH
40
41#include <map>
42#include <string>
43#include <vector>
44
45#include <librevenge/librevenge.h>
46
47#include "libmwaw_internal.hxx"
48
49#include "MWAWDebug.hxx"
50#include "MWAWInputStream.hxx"
51
52namespace HanMacWrdKGraphInternal
53{
54struct Frame;
55struct ShapeGraph;
56struct FootnoteFrame;
57struct Group;
58struct PictureFrame;
59struct Table;
60struct TableCell;
61struct TextBox;
62
63struct Picture;
64
65struct State;
66class SubDocument;
67}
68
69struct HanMacWrdKZone;
70class HanMacWrdKParser;
71
77 class HanMacWrdKGraph
78{
79 friend class HanMacWrdKParser;
80 friend class HanMacWrdKGraphInternal::SubDocument;
81 friend struct HanMacWrdKGraphInternal::Table;
82
83public:
85 explicit HanMacWrdKGraph(HanMacWrdKParser &parser);
87 virtual ~HanMacWrdKGraph();
88
90 int version() const;
91
93 int numPages() const;
94
95protected:
96
98 bool getColor(int colId, int patternId, MWAWColor &color) const;
99
101 bool sendPageGraphics(std::vector<long> const &doNotSendIds);
103 void flushExtra();
104
105
106 //
107 // Intermediate level
108 //
109
111 bool readFrames(std::shared_ptr<HanMacWrdKZone> zone);
113 bool readPicture(std::shared_ptr<HanMacWrdKZone> zone);
115 void prepareStructures();
116
117 // interface with mainParser
118
120 bool sendFrame(long frameId, MWAWPosition const &pos);
122 bool sendPicture(long pictId, MWAWPosition const &pos);
123
125 bool sendText(long textId, long id, MWAWListenerPtr const &listener=MWAWListenerPtr());
128 std::map<long,int> getTextFrameInformations() const;
129
130 //
131 // low level
132 //
133
135 bool checkGroupStructures(long fileId, long fileSubId, std::multimap<long, long> &seens, bool inGroup);
136
138 bool sendPicture(HanMacWrdKGraphInternal::Picture const &picture, MWAWPosition const &pos);
140 bool sendFrame(HanMacWrdKGraphInternal::Frame const &frame, MWAWPosition const &pos);
142 bool sendShapeGraph(HanMacWrdKGraphInternal::ShapeGraph const &shape, MWAWPosition const &pos);
144 bool sendPictureFrame(HanMacWrdKGraphInternal::PictureFrame const &pict, MWAWPosition const &pos);
146 bool sendEmptyPicture(MWAWPosition const &pos);
148 bool sendTextBox(HanMacWrdKGraphInternal::TextBox const &textbox, MWAWPosition const &pos);
150 bool sendTableUnformatted(long fId);
151
153 bool sendGroup(long fId, MWAWPosition const &pos);
155 bool sendGroup(HanMacWrdKGraphInternal::Group const &group, MWAWPosition const &pos);
157 bool canCreateGraphic(HanMacWrdKGraphInternal::Group const &group);
159 void sendGroupChild(HanMacWrdKGraphInternal::Group const &group, MWAWPosition const &pos);
161 void sendGroup(HanMacWrdKGraphInternal::Group const &group, MWAWGraphicListenerPtr &listener);
162
164 std::shared_ptr<HanMacWrdKGraphInternal::ShapeGraph> readShapeGraph(std::shared_ptr<HanMacWrdKZone> zone, HanMacWrdKGraphInternal::Frame const &header);
166 std::shared_ptr<HanMacWrdKGraphInternal::FootnoteFrame> readFootnoteFrame(std::shared_ptr<HanMacWrdKZone> zone, HanMacWrdKGraphInternal::Frame const &header);
168 std::shared_ptr<HanMacWrdKGraphInternal::Group> readGroup(std::shared_ptr<HanMacWrdKZone> zone, HanMacWrdKGraphInternal::Frame const &header);
170 std::shared_ptr<HanMacWrdKGraphInternal::PictureFrame> readPictureFrame(std::shared_ptr<HanMacWrdKZone> zone, HanMacWrdKGraphInternal::Frame const &header);
172 std::shared_ptr<HanMacWrdKGraphInternal::Table> readTable(std::shared_ptr<HanMacWrdKZone> zone, HanMacWrdKGraphInternal::Frame const &header);
174 std::shared_ptr<HanMacWrdKGraphInternal::TextBox> readTextBox(std::shared_ptr<HanMacWrdKZone> zone, HanMacWrdKGraphInternal::Frame const &header, bool isMemo);
175
176private:
177 HanMacWrdKGraph(HanMacWrdKGraph const &orig) = delete;
178 HanMacWrdKGraph &operator=(HanMacWrdKGraph const &orig) = delete;
179
180protected:
181 //
182 // data
183 //
185 MWAWParserStatePtr m_parserState;
186
188 std::shared_ptr<HanMacWrdKGraphInternal::State> m_state;
189
191 HanMacWrdKParser *m_mainParser;
192};
193#endif
194// vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
MWAWDebug.hxx
MWAWInputStream.hxx
HanMacWrdKGraphInternal::SubDocument
Internal: the subdocument of a HanMacWrdKGraph.
Definition: HanMacWrdKGraph.cxx:824
HanMacWrdKGraph
the main class to read the graphic part of a HanMac Word file
Definition: HanMacWrdKGraph.hxx:78
HanMacWrdKGraph::sendEmptyPicture
bool sendEmptyPicture(MWAWPosition const &pos)
try to send an empty picture
Definition: HanMacWrdKGraph.cxx:1391
HanMacWrdKGraph::operator=
HanMacWrdKGraph & operator=(HanMacWrdKGraph const &orig)=delete
HanMacWrdKGraph::~HanMacWrdKGraph
virtual ~HanMacWrdKGraph()
destructor
Definition: HanMacWrdKGraph.cxx:948
HanMacWrdKGraph::m_mainParser
HanMacWrdKParser * m_mainParser
the main parser;
Definition: HanMacWrdKGraph.hxx:191
HanMacWrdKGraph::sendGroup
bool sendGroup(long fId, MWAWPosition const &pos)
try to send a group to the listener
Definition: HanMacWrdKGraph.cxx:1998
HanMacWrdKGraph::readShapeGraph
std::shared_ptr< HanMacWrdKGraphInternal::ShapeGraph > readShapeGraph(std::shared_ptr< HanMacWrdKZone > zone, HanMacWrdKGraphInternal::Frame const &header)
try to read the basic graph data
Definition: HanMacWrdKGraph.cxx:1484
HanMacWrdKGraph::m_parserState
MWAWParserStatePtr m_parserState
the parser state
Definition: HanMacWrdKGraph.hxx:185
HanMacWrdKGraph::getTextFrameInformations
std::map< long, int > getTextFrameInformations() const
return a list textZId -> type which 3(footnote), 4(textbox), 9(table), 10(comment)
Definition: HanMacWrdKGraph.cxx:994
HanMacWrdKGraph::m_state
std::shared_ptr< HanMacWrdKGraphInternal::State > m_state
the state
Definition: HanMacWrdKGraph.hxx:188
HanMacWrdKGraph::sendGroupChild
void sendGroupChild(HanMacWrdKGraphInternal::Group const &group, MWAWPosition const &pos)
try to send a group elements by elements
Definition: HanMacWrdKGraph.cxx:2090
HanMacWrdKGraph::readTextBox
std::shared_ptr< HanMacWrdKGraphInternal::TextBox > readTextBox(std::shared_ptr< HanMacWrdKZone > zone, HanMacWrdKGraphInternal::Frame const &header, bool isMemo)
try to read the textbox data
Definition: HanMacWrdKGraph.cxx:1778
HanMacWrdKGraph::numPages
int numPages() const
returns the number of pages
Definition: HanMacWrdKGraph.cxx:973
HanMacWrdKGraph::readPicture
bool readPicture(std::shared_ptr< HanMacWrdKZone > zone)
try to read a picture zone (type d)
Definition: HanMacWrdKGraph.cxx:1163
HanMacWrdKGraph::readFrames
bool readFrames(std::shared_ptr< HanMacWrdKZone > zone)
try to read the frame definition (type 2)
Definition: HanMacWrdKGraph.cxx:1042
HanMacWrdKGraph::canCreateGraphic
bool canCreateGraphic(HanMacWrdKGraphInternal::Group const &group)
check if we can send a group as graphic
Definition: HanMacWrdKGraph.cxx:2021
HanMacWrdKGraph::sendFrame
bool sendFrame(long frameId, MWAWPosition const &pos)
try to send a frame to the listener
Definition: HanMacWrdKGraph.cxx:1264
HanMacWrdKGraph::readTable
std::shared_ptr< HanMacWrdKGraphInternal::Table > readTable(std::shared_ptr< HanMacWrdKZone > zone, HanMacWrdKGraphInternal::Frame const &header)
try to read the table data
Definition: HanMacWrdKGraph.cxx:1825
HanMacWrdKGraph::readPictureFrame
std::shared_ptr< HanMacWrdKGraphInternal::PictureFrame > readPictureFrame(std::shared_ptr< HanMacWrdKZone > zone, HanMacWrdKGraphInternal::Frame const &header)
try to read the picture data
Definition: HanMacWrdKGraph.cxx:1700
HanMacWrdKGraph::HanMacWrdKGraph
HanMacWrdKGraph(HanMacWrdKGraph const &orig)=delete
HanMacWrdKGraph::sendPageGraphics
bool sendPageGraphics(std::vector< long > const &doNotSendIds)
try to send the page graphic
Definition: HanMacWrdKGraph.cxx:2274
HanMacWrdKGraph::flushExtra
void flushExtra()
sends the data which have not yet been sent to the listener
Definition: HanMacWrdKGraph.cxx:2292
HanMacWrdKGraph::version
int version() const
returns the file version
Definition: HanMacWrdKGraph.cxx:951
HanMacWrdKGraph::readFootnoteFrame
std::shared_ptr< HanMacWrdKGraphInternal::FootnoteFrame > readFootnoteFrame(std::shared_ptr< HanMacWrdKZone > zone, HanMacWrdKGraphInternal::Frame const &header)
try to read the footnote data
Definition: HanMacWrdKGraph.cxx:1742
HanMacWrdKGraph::sendShapeGraph
bool sendShapeGraph(HanMacWrdKGraphInternal::ShapeGraph const &shape, MWAWPosition const &pos)
try to send a basic picture to the listener
Definition: HanMacWrdKGraph.cxx:1453
HanMacWrdKGraph::sendTableUnformatted
bool sendTableUnformatted(long fId)
try to send a table unformatted
Definition: HanMacWrdKGraph.cxx:1466
HanMacWrdKGraph::checkGroupStructures
bool checkGroupStructures(long fileId, long fileSubId, std::multimap< long, long > &seens, bool inGroup)
check the graph structures: ie.
Definition: HanMacWrdKGraph.cxx:2239
HanMacWrdKGraph::sendText
bool sendText(long textId, long id, MWAWListenerPtr const &listener=MWAWListenerPtr())
ask main parser to send a text zone
Definition: HanMacWrdKGraph.cxx:989
HanMacWrdKGraph::readGroup
std::shared_ptr< HanMacWrdKGraphInternal::Group > readGroup(std::shared_ptr< HanMacWrdKZone > zone, HanMacWrdKGraphInternal::Frame const &header)
try to read the group data
Definition: HanMacWrdKGraph.cxx:1662
HanMacWrdKGraph::getColor
bool getColor(int colId, int patternId, MWAWColor &color) const
returns the color associated with a pattern
Definition: HanMacWrdKGraph.cxx:956
HanMacWrdKGraph::sendPicture
bool sendPicture(long pictId, MWAWPosition const &pos)
try to send a picture to the listener
Definition: HanMacWrdKGraph.cxx:1220
HanMacWrdKGraph::sendPictureFrame
bool sendPictureFrame(HanMacWrdKGraphInternal::PictureFrame const &pict, MWAWPosition const &pos)
try to send a picture frame
Definition: HanMacWrdKGraph.cxx:1418
HanMacWrdKGraph::sendTextBox
bool sendTextBox(HanMacWrdKGraphInternal::TextBox const &textbox, MWAWPosition const &pos)
try to send a textbox to the listener
Definition: HanMacWrdKGraph.cxx:1429
HanMacWrdKGraph::prepareStructures
void prepareStructures()
check the group structures, the linked textbox
Definition: HanMacWrdKGraph.cxx:2211
HanMacWrdKParser
the main class to read a HanMac Word-K file
Definition: HanMacWrdKParser.hxx:186
MWAWPosition
Class to define the position of an object (textbox, picture, ..) in the document.
Definition: MWAWPosition.hxx:48
libmwaw_internal.hxx
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
HanMacWrdKGraphInternal
Internal: the structures of a HanMacWrdKGraph.
Definition: HanMacWrdKGraph.cxx:65
HanMacWrdKGraphInternal::Frame
Internal: the frame header of a HanMacWrdKGraph.
Definition: HanMacWrdKGraph.cxx:68
HanMacWrdKGraphInternal::Group
Internal: the group of a HanMacWrdKGraph.
Definition: HanMacWrdKGraph.cxx:280
HanMacWrdKGraphInternal::PictureFrame
Internal: the picture of a HanMacWrdKGraph.
Definition: HanMacWrdKGraph.cxx:342
HanMacWrdKGraphInternal::Picture
Internal: the picture of a HanMacWrdKGraph.
Definition: HanMacWrdKGraph.cxx:617
HanMacWrdKGraphInternal::ShapeGraph
Internal: the geometrical graph of a HanMacWrdKGraph.
Definition: HanMacWrdKGraph.cxx:200
HanMacWrdKGraphInternal::Table
Internal: the table of a HanMacWrdKGraph.
Definition: HanMacWrdKGraph.cxx:432
HanMacWrdKGraphInternal::TextBox
Internal: the textbox of a HanMacWrdKGraph.
Definition: HanMacWrdKGraph.cxx:499
HanMacWrdKZone
Small class used to store the decoded zone of HanMacWrdKParser.
Definition: HanMacWrdKParser.hxx:58
MWAWColor
the class to store a color
Definition: libmwaw_internal.hxx:192