HanMacWrdJGraph.hxx Source File documentation

HanMacWrdJGraph.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-J text document ( graphic part )
36 *
37 */
38 #ifndef HAN_MAC_WRD_J_GRAPH
39 # define HAN_MAC_WRD_J_GRAPH
40
41 #include <map>
42 #include <set>
43 #include <string>
44 #include <vector>
45
46 #include <librevenge/librevenge.h>
47
48 #include "libmwaw_internal.hxx"
49
50 #include "MWAWDebug.hxx"
51 #include "MWAWInputStream.hxx"
52
53 namespace HanMacWrdJGraphInternal
54 {
55 struct CellFormat;
56 struct Frame;
57 struct CommentFrame;
58 struct Group;
59 struct PictureFrame;
60 struct ShapeGraph;
61 struct TableFrame;
62 struct TextboxFrame;
63 struct TextFrame;
64 struct Table;
65 struct TableCell;
66
67 struct State;
68 class SubDocument;
69 }
70
71 class HanMacWrdJParser;
72
78 class HanMacWrdJGraph
79 {
80 friend class HanMacWrdJParser;
81 friend struct HanMacWrdJGraphInternal::Table;
82 friend class HanMacWrdJGraphInternal::SubDocument;
83
84 public:
86 explicit HanMacWrdJGraph(HanMacWrdJParser &parser);
88 virtual ~HanMacWrdJGraph();
89
91 int version() const;
92
94 int numPages() const;
95
96 protected:
97
99 bool getColor(int colId, int patternId, MWAWColor &color) const;
100
102 void prepareStructures();
104 bool sendPageGraphics(std::vector<long> const &doNotSendIds);
106 void flushExtra();
107
108 //
109 // Intermediate level
110 //
112 bool readFrames(MWAWEntry const &entry);
114 std::shared_ptr<HanMacWrdJGraphInternal::Frame> readFrame(int id);
116 std::shared_ptr<HanMacWrdJGraphInternal::ShapeGraph> readShapeGraph(HanMacWrdJGraphInternal::Frame const &header, long endPos);
118 std::shared_ptr<HanMacWrdJGraphInternal::CommentFrame> readCommentData(HanMacWrdJGraphInternal::Frame const &header, long endPos);
120 std::shared_ptr<HanMacWrdJGraphInternal::PictureFrame> readPictureData(HanMacWrdJGraphInternal::Frame const &header, long endPos);
122 std::shared_ptr<HanMacWrdJGraphInternal::TableFrame> readTableData(HanMacWrdJGraphInternal::Frame const &header, long endPos);
124 std::shared_ptr<HanMacWrdJGraphInternal::TextboxFrame> readTextboxData(HanMacWrdJGraphInternal::Frame const &header, long endPos);
126 std::shared_ptr<HanMacWrdJGraphInternal::TextFrame> readTextData(HanMacWrdJGraphInternal::Frame const &header, long endPos);
128 bool readGroupData(MWAWEntry const &entry, int actZone);
130 bool readGraphData(MWAWEntry const &entry, int actZone);
132 bool readPicture(MWAWEntry const &entry, int actZone);
134 bool readTable(MWAWEntry const &entry, int actZone);
136 bool readTableFormatsList(HanMacWrdJGraphInternal::Table &table, long endPos);
137
138
140 bool sendFrame(HanMacWrdJGraphInternal::Frame const &frame, MWAWPosition const &pos);
142 bool sendShapeGraph(HanMacWrdJGraphInternal::ShapeGraph const &pict, MWAWPosition const &pos);
144 bool sendComment(HanMacWrdJGraphInternal::CommentFrame const &textbox, MWAWPosition const &pos, librevenge::RVNGPropertyList const &extras=librevenge::RVNGPropertyList());
146 bool sendPictureFrame(HanMacWrdJGraphInternal::PictureFrame const &pict, MWAWPosition const &pos);
148 bool sendEmptyPicture(MWAWPosition const &pos);
150 bool sendTextbox(HanMacWrdJGraphInternal::TextboxFrame const &textbox, MWAWPosition const &pos);
152 bool sendTableUnformatted(long zId);
153
155 bool sendGroup(long zId, MWAWPosition const &pos);
157 bool sendGroup(HanMacWrdJGraphInternal::Group const &group, MWAWPosition const &pos);
159 bool canCreateGraphic(HanMacWrdJGraphInternal::Group const &group);
161 void sendGroupChild(HanMacWrdJGraphInternal::Group const &group, MWAWPosition const &pos);
163 void sendGroup(HanMacWrdJGraphInternal::Group const &group, MWAWGraphicListenerPtr const &listener);
164
165 // interface with mainParser
166
169 std::map<long,int> getTextFrameInformations() const;
171 bool getFootnoteInformations(long &textZId, std::vector<long> &fPosList) const;
173 bool sendFrame(long frameId, MWAWPosition const &pos);
175 bool sendText(long textId, long fPos, MWAWListenerPtr const &listener=MWAWListenerPtr());
176
177 //
178 // low level
179 //
181 bool checkGroupStructures(long zId, std::set<long> &seens, bool inGroup);
182
183
184 private:
185 HanMacWrdJGraph(HanMacWrdJGraph const &orig) = delete;
186 HanMacWrdJGraph &operator=(HanMacWrdJGraph const &orig) = delete;
187
188 protected:
189 //
190 // data
191 //
193 MWAWParserStatePtr m_parserState;
194
196 std::shared_ptr<HanMacWrdJGraphInternal::State> m_state;
197
199 HanMacWrdJParser *m_mainParser;
200 };
201 #endif
202 // vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
HanMacWrdJGraph::getColor
bool getColor(int colId, int patternId, MWAWColor &color) const
returns the color associated with a pattern
Definition: HanMacWrdJGraph.cxx:1075
HanMacWrdJGraph::readFrames
bool readFrames(MWAWEntry const &entry)
try to read the frames definition (type 3)
Definition: HanMacWrdJGraph.cxx:1170
HanMacWrdJParser
the main class to read a HanMac Word-J file
Definition: HanMacWrdJParser.hxx:109
HanMacWrdJGraph::sendComment
bool sendComment(HanMacWrdJGraphInternal::CommentFrame const &textbox, MWAWPosition const &pos, librevenge::RVNGPropertyList const &extras=librevenge::RVNGPropertyList())
try to send a comment box to the listener
Definition: HanMacWrdJGraph.cxx:2133
HanMacWrdJGraphInternal::ShapeGraph
Internal: the geometrical graph of a HanMacWrdJGraph.
Definition: HanMacWrdJGraph.cxx:712
MWAWParserStatePtr
std::shared_ptr< MWAWParserState > MWAWParserStatePtr
a smart pointer of MWAWParserState
Definition: libmwaw_internal.hxx:553
HanMacWrdJGraph::sendTextbox
bool sendTextbox(HanMacWrdJGraphInternal::TextboxFrame const &textbox, MWAWPosition const &pos)
try to send a textbox to the listener
Definition: HanMacWrdJGraph.cxx:2165
HanMacWrdJGraph::operator=
HanMacWrdJGraph & operator=(HanMacWrdJGraph const &orig)=delete
HanMacWrdJGraphInternal::CommentFrame
Internal: the comment frame of a HanMacWrdJGraph.
Definition: HanMacWrdJGraph.cxx:438
libmwaw_internal.hxx
MWAWListenerPtr
std::shared_ptr< MWAWListener > MWAWListenerPtr
a smart pointer of MWAWListener
Definition: libmwaw_internal.hxx:549
HanMacWrdJGraph::sendGroupChild
void sendGroupChild(HanMacWrdJGraphInternal::Group const &group, MWAWPosition const &pos)
try to send a group elements by elements
Definition: HanMacWrdJGraph.cxx:2900
HanMacWrdJGraph::checkGroupStructures
bool checkGroupStructures(long zId, std::set< long > &seens, bool inGroup)
check the graph structures: ie.
Definition: HanMacWrdJGraph.cxx:2766
HanMacWrdJGraphInternal::Frame
Internal: the frame header of a HanMacWrdJGraph.
Definition: HanMacWrdJGraph.cxx:321
HanMacWrdJGraph::readPictureData
std::shared_ptr< HanMacWrdJGraphInternal::PictureFrame > readPictureData(HanMacWrdJGraphInternal::Frame const &header, long endPos)
try to read the picture data
Definition: HanMacWrdJGraph.cxx:2396
HanMacWrdJGraphInternal::Group
Internal: a group of a HanMacWrdJGraph.
Definition: HanMacWrdJGraph.cxx:485
HanMacWrdJGraph::readShapeGraph
std::shared_ptr< HanMacWrdJGraphInternal::ShapeGraph > readShapeGraph(HanMacWrdJGraphInternal::Frame const &header, long endPos)
try to read the basic graph data
Definition: HanMacWrdJGraph.cxx:2566
HanMacWrdJGraphInternal
Internal: the structures of a HanMacWrdJGraph.
Definition: HanMacWrdJGraph.cxx:62
HanMacWrdJGraph
the main class to read the graphic part of a HanMac Word-J file
Definition: HanMacWrdJGraph.hxx:78
HanMacWrdJGraph::readPicture
bool readPicture(MWAWEntry const &entry, int actZone)
try to read the pictures definition (type 6)
Definition: HanMacWrdJGraph.cxx:1654
HanMacWrdJGraph::readTable
bool readTable(MWAWEntry const &entry, int actZone)
try to read a table (zone 7)
Definition: HanMacWrdJGraph.cxx:1696
HanMacWrdJGraph::sendText
bool sendText(long textId, long fPos, MWAWListenerPtr const &listener=MWAWListenerPtr())
ask main parser to send a text zone
Definition: HanMacWrdJGraph.cxx:1106
HanMacWrdJGraph::readTableData
std::shared_ptr< HanMacWrdJGraphInternal::TableFrame > readTableData(HanMacWrdJGraphInternal::Frame const &header, long endPos)
try to read the table data
Definition: HanMacWrdJGraph.cxx:2445
HanMacWrdJGraphInternal::PictureFrame
Internal: the picture frame of a HanMacWrdJGraph.
Definition: HanMacWrdJGraph.cxx:512
HanMacWrdJGraph::readFrame
std::shared_ptr< HanMacWrdJGraphInternal::Frame > readFrame(int id)
try to read a frame
Definition: HanMacWrdJGraph.cxx:1390
HanMacWrdJGraph::readGroupData
bool readGroupData(MWAWEntry const &entry, int actZone)
try to read the groupd data ( type 9 )
Definition: HanMacWrdJGraph.cxx:1502
HanMacWrdJGraph::sendTableUnformatted
bool sendTableUnformatted(long zId)
try to send a table unformatted
Definition: HanMacWrdJGraph.cxx:2194
HanMacWrdJGraph::sendPictureFrame
bool sendPictureFrame(HanMacWrdJGraphInternal::PictureFrame const &pict, MWAWPosition const &pos)
try to send a picture frame
Definition: HanMacWrdJGraph.cxx:2066
MWAWColor
the class to store a color
Definition: libmwaw_internal.hxx:192
MWAWGraphicListenerPtr
std::shared_ptr< MWAWGraphicListener > MWAWGraphicListenerPtr
a smart pointer of MWAWGraphicListener
Definition: libmwaw_internal.hxx:545
HanMacWrdJGraph::readTableFormatsList
bool readTableFormatsList(HanMacWrdJGraphInternal::Table &table, long endPos)
try to read a list of format
Definition: HanMacWrdJGraph.cxx:1911
HanMacWrdJGraph::readTextData
std::shared_ptr< HanMacWrdJGraphInternal::TextFrame > readTextData(HanMacWrdJGraphInternal::Frame const &header, long endPos)
try to read a text data (text, header/footer, footnote)
Definition: HanMacWrdJGraph.cxx:2528
HanMacWrdJGraph::readTextboxData
std::shared_ptr< HanMacWrdJGraphInternal::TextboxFrame > readTextboxData(HanMacWrdJGraphInternal::Frame const &header, long endPos)
try to read a textbox data
Definition: HanMacWrdJGraph.cxx:2488
HanMacWrdJGraph::canCreateGraphic
bool canCreateGraphic(HanMacWrdJGraphInternal::Group const &group)
check if we can send a group as graphic
Definition: HanMacWrdJGraph.cxx:2823
HanMacWrdJGraphInternal::SubDocument
Internal: the subdocument of a HanMacWrdJGraph.
Definition: HanMacWrdJGraph.cxx:947
HanMacWrdJGraph::readCommentData
std::shared_ptr< HanMacWrdJGraphInternal::CommentFrame > readCommentData(HanMacWrdJGraphInternal::Frame const &header, long endPos)
try to read the comment data
Definition: HanMacWrdJGraph.cxx:2345
HanMacWrdJGraph::getTextFrameInformations
std::map< long, int > getTextFrameInformations() const
return a list textZId -> type which type=0(main), 1(header), 2(footer), 3(footnote), 4(textbox), 9(table), 10(comment)
Definition: HanMacWrdJGraph.cxx:1111
HanMacWrdJGraph::m_parserState
MWAWParserStatePtr m_parserState
the parser state
Definition: HanMacWrdJGraph.hxx:193
HanMacWrdJGraph::sendEmptyPicture
bool sendEmptyPicture(MWAWPosition const &pos)
try to send an empty picture
Definition: HanMacWrdJGraph.cxx:2105
HanMacWrdJGraphInternal::Table
Internal: the table of a HanMacWrdJGraph.
Definition: HanMacWrdJGraph.cxx:165
HanMacWrdJGraph::~HanMacWrdJGraph
virtual ~HanMacWrdJGraph()
destructor
Definition: HanMacWrdJGraph.cxx:1066
HanMacWrdJGraphInternal::TextboxFrame
Internal: the textbox frame of a HanMacWrdJGraph.
Definition: HanMacWrdJGraph.cxx:621
HanMacWrdJGraph::readGraphData
bool readGraphData(MWAWEntry const &entry, int actZone)
try to read the graph data (zone 8)
Definition: HanMacWrdJGraph.cxx:1577
HanMacWrdJGraph::version
int version() const
returns the file version
Definition: HanMacWrdJGraph.cxx:1070
HanMacWrdJGraph::flushExtra
void flushExtra()
sends the data which have not yet been sent to the listener
Definition: HanMacWrdJGraph.cxx:3059
HanMacWrdJGraph::m_mainParser
HanMacWrdJParser * m_mainParser
the main parser;
Definition: HanMacWrdJGraph.hxx:199
MWAWInputStream.hxx
MWAWDebug.hxx
HanMacWrdJGraph::sendGroup
bool sendGroup(long zId, MWAWPosition const &pos)
try to send a group to the listener
Definition: HanMacWrdJGraph.cxx:2796
HanMacWrdJGraph::sendPageGraphics
bool sendPageGraphics(std::vector< long > const &doNotSendIds)
try to send the page graphic
Definition: HanMacWrdJGraph.cxx:3034
HanMacWrdJGraph::numPages
int numPages() const
returns the number of pages
Definition: HanMacWrdJGraph.cxx:1090
HanMacWrdJGraph::getFootnoteInformations
bool getFootnoteInformations(long &textZId, std::vector< long > &fPosList) const
return the footnote text zone id and the list of first char position
Definition: HanMacWrdJGraph.cxx:1147
MWAWPosition
Class to define the position of an object (textbox, picture, ..) in the document. ...
Definition: MWAWPosition.hxx:47
MWAWEntry
basic class to store an entry in a file This contained :
Definition: MWAWEntry.hxx:46
HanMacWrdJGraph::sendFrame
bool sendFrame(HanMacWrdJGraphInternal::Frame const &frame, MWAWPosition const &pos)
try to send a frame to the listener
Definition: HanMacWrdJGraph.cxx:2223
HanMacWrdJGraph::prepareStructures
void prepareStructures()
check the group structures, the linked textbox
Definition: HanMacWrdJGraph.cxx:2710
HanMacWrdJGraph::HanMacWrdJGraph
HanMacWrdJGraph(HanMacWrdJParser &parser)
constructor
Definition: HanMacWrdJGraph.cxx:1059
HanMacWrdJGraph::m_state
std::shared_ptr< HanMacWrdJGraphInternal::State > m_state
the state
Definition: HanMacWrdJGraph.hxx:196
HanMacWrdJGraph::sendShapeGraph
bool sendShapeGraph(HanMacWrdJGraphInternal::ShapeGraph const &pict, MWAWPosition const &pos)
try to send a basic picture to the listener
Definition: HanMacWrdJGraph.cxx:2044