RagTime5Graph.hxx Source File documentation

RagTime5Graph.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 RagTime 5-6 document ( graphic part )
36 *
37 */
38#ifndef RAGTIME5_GRAPH
39# define RAGTIME5_GRAPH
40
41#include <string>
42#include <map>
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#include "MWAWPosition.hxx"
52
53#include "RagTime5StructManager.hxx"
54#include "RagTime5ClusterManager.hxx"
55
56namespace RagTime5GraphInternal
57{
58struct ClusterButton;
59struct ClusterGraphic;
60struct ClusterPicture;
61
62struct Shape;
63struct State;
64
65class SubDocument;
66}
67
68class RagTime5Document;
69class RagTime5StructManager;
70class RagTime5StyleManager;
71class RagTime5Zone;
72
73class MWAWGraphicStyle;
74
80 class RagTime5Graph
81{
82 friend class RagTime5GraphInternal::SubDocument;
83 friend class RagTime5Document;
84
85public:
87 explicit RagTime5Graph(RagTime5Document &doc);
89 virtual ~RagTime5Graph();
90
92 int version() const;
93
95 int numPages() const;
96
97protected:
98
100 void flushExtra(bool onlyCheck=false);
101
102 // interface with main parser
103
105 bool sendTextZone(MWAWListenerPtr listener, int zId, int pId, double totalWidth=-1);
107 bool sendButtonZoneAsText(MWAWListenerPtr listener, int zId);
108
109 //
110 // Intermediate level
111 //
112
113 //
114 // picture
115 //
116
118 bool readPictureContainer(RagTime5Zone &zone);
120 bool readPictureData(RagTime5Zone &zone);
122 bool readPictureData(RagTime5Zone &zone, librevenge::RVNGBinaryData &data, std::string &type);
124 bool readPictureList(RagTime5Zone &zone);
126 bool readPictureRep(RagTime5Zone &zone);
128 bool readPictureMatch(RagTime5Zone &zone, bool color);
129
130 //
131 // basic graphic
132 //
133
135 bool readGraphicTypes(RagTime5ClusterManager::Link const &link);
136
138 bool readColorPatternZone(RagTime5ClusterManager::Cluster &cluster);
139
141 std::shared_ptr<RagTime5ClusterManager::Cluster> readButtonCluster(RagTime5Zone &zone, int zoneType);
142
144 std::shared_ptr<RagTime5ClusterManager::Cluster> readGraphicCluster(RagTime5Zone &zone, int zoneType);
146 bool readGraphicUsed(int typeId);
148 bool readGraphicShapes(RagTime5GraphInternal::ClusterGraphic &cluster);
150 bool readGraphicShape(RagTime5GraphInternal::ClusterGraphic &cluster, RagTime5Zone &dataZone, long endPos, int n, librevenge::RVNGString const &dataName);
152 bool readGraphicTransformations(RagTime5ClusterManager::Link const &link);
153
155 std::shared_ptr<RagTime5ClusterManager::Cluster> readPictureCluster(RagTime5Zone &zone, int zoneType);
156
157 //
158 // low level
159 //
160
162 void checkGraphicCluster(RagTime5GraphInternal::ClusterGraphic &cluster);
163
164 //
165 // send data
166 //
167
169 bool send(int zoneId, MWAWListenerPtr listener, MWAWPosition const &pos);
170
172 bool send(RagTime5GraphInternal::ClusterButton &cluster, MWAWListenerPtr listener, MWAWPosition const &pos, MWAWGraphicStyle const &style);
174 bool send(RagTime5GraphInternal::ClusterGraphic &cluster, MWAWListenerPtr listener, MWAWPosition const &pos);
176 bool send(RagTime5GraphInternal::Shape const &shape, RagTime5GraphInternal::ClusterGraphic const &cluster, MWAWListenerPtr listener, MWAWPosition const &pos);
177
179 bool send(RagTime5GraphInternal::ClusterPicture &cluster, MWAWListenerPtr listener, MWAWPosition const &pos);
180
181public:
183 static std::string printType(unsigned long fileType)
184 {
185 return RagTime5StructManager::printType(fileType);
186 }
187
188private:
189 RagTime5Graph(RagTime5Graph const &orig);
190 RagTime5Graph &operator=(RagTime5Graph const &orig);
191
192protected:
193 //
194 // data
195 //
197 RagTime5Document &m_document;
198
200 std::shared_ptr<RagTime5StructManager> m_structManager;
202 std::shared_ptr<RagTime5StyleManager> m_styleManager;
204 MWAWParserStatePtr m_parserState;
205
207 std::shared_ptr<RagTime5GraphInternal::State> m_state;
208};
209#endif
210// vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
MWAWDebug.hxx
MWAWInputStream.hxx
MWAWPosition.hxx
RagTime5ClusterManager.hxx
RagTime5StructManager.hxx
MWAWGraphicStyle
a structure used to define a picture style
Definition: MWAWGraphicStyle.hxx:48
MWAWPosition
Class to define the position of an object (textbox, picture, ..) in the document.
Definition: MWAWPosition.hxx:48
RagTime5Document
the main class to read a RagTime v5 file
Definition: RagTime5Document.hxx:77
RagTime5GraphInternal::SubDocument
Internal: the subdocument of a RagTime5Graph.
Definition: RagTime5Graph.cxx:543
RagTime5Graph
the main class to read the graphic part of RagTime 56 file
Definition: RagTime5Graph.hxx:81
RagTime5Graph::sendTextZone
bool sendTextZone(MWAWListenerPtr listener, int zId, int pId, double totalWidth=-1)
ask to send a text zone
Definition: RagTime5Graph.cxx:651
RagTime5Graph::readGraphicTypes
bool readGraphicTypes(RagTime5ClusterManager::Link const &link)
try to read a main graphic types
Definition: RagTime5Graph.cxx:665
RagTime5Graph::operator=
RagTime5Graph & operator=(RagTime5Graph const &orig)
RagTime5Graph::readGraphicShapes
bool readGraphicShapes(RagTime5GraphInternal::ClusterGraphic &cluster)
try to read the graphic shapes of a cluster
Definition: RagTime5Graph.cxx:836
RagTime5Graph::readGraphicCluster
std::shared_ptr< RagTime5ClusterManager::Cluster > readGraphicCluster(RagTime5Zone &zone, int zoneType)
try to read a graphic zone
Definition: RagTime5Graph.cxx:3799
RagTime5Graph::readGraphicShape
bool readGraphicShape(RagTime5GraphInternal::ClusterGraphic &cluster, RagTime5Zone &dataZone, long endPos, int n, librevenge::RVNGString const &dataName)
try to read a graphic
Definition: RagTime5Graph.cxx:938
RagTime5Graph::checkGraphicCluster
void checkGraphicCluster(RagTime5GraphInternal::ClusterGraphic &cluster)
check the graphic cluster data: check if there is no loop, ...
Definition: RagTime5Graph.cxx:3880
RagTime5Graph::readGraphicUsed
bool readGraphicUsed(int typeId)
try to read the id zone => used
Definition: RagTime5Graph.cxx:1265
RagTime5Graph::numPages
int numPages() const
returns the number of pages
Definition: RagTime5Graph.cxx:629
RagTime5Graph::flushExtra
void flushExtra(bool onlyCheck=false)
sends the data which have not yet been sent to the listener
Definition: RagTime5Graph.cxx:1799
RagTime5Graph::readPictureList
bool readPictureList(RagTime5Zone &zone)
try to read a picture list
Definition: RagTime5Graph.cxx:1385
RagTime5Graph::m_styleManager
std::shared_ptr< RagTime5StyleManager > m_styleManager
the style manager
Definition: RagTime5Graph.hxx:202
RagTime5Graph::m_document
RagTime5Document & m_document
the parser
Definition: RagTime5Graph.hxx:197
RagTime5Graph::version
int version() const
returns the file version
Definition: RagTime5Graph.cxx:624
RagTime5Graph::readPictureContainer
bool readPictureContainer(RagTime5Zone &zone)
try to read a picture data zone
Definition: RagTime5Graph.cxx:1468
RagTime5Graph::readPictureMatch
bool readPictureMatch(RagTime5Zone &zone, bool color)
try to read a picture match zone
Definition: RagTime5Graph.cxx:1725
RagTime5Graph::readGraphicTransformations
bool readGraphicTransformations(RagTime5ClusterManager::Link const &link)
try to read a graphic transformations zone
Definition: RagTime5Graph.cxx:1324
RagTime5Graph::m_parserState
MWAWParserStatePtr m_parserState
the parser state
Definition: RagTime5Graph.hxx:204
RagTime5Graph::sendButtonZoneAsText
bool sendButtonZoneAsText(MWAWListenerPtr listener, int zId)
ask to send the button content as text
Definition: RagTime5Graph.cxx:1833
RagTime5Graph::~RagTime5Graph
virtual ~RagTime5Graph()
destructor
Definition: RagTime5Graph.cxx:620
RagTime5Graph::readPictureRep
bool readPictureRep(RagTime5Zone &zone)
try to read a picture rep
Definition: RagTime5Graph.cxx:1443
RagTime5Graph::readButtonCluster
std::shared_ptr< RagTime5ClusterManager::Cluster > readButtonCluster(RagTime5Zone &zone, int zoneType)
try to read a button zone
Definition: RagTime5Graph.cxx:3682
RagTime5Graph::m_structManager
std::shared_ptr< RagTime5StructManager > m_structManager
the structure manager
Definition: RagTime5Graph.hxx:200
RagTime5Graph::printType
static std::string printType(unsigned long fileType)
debug: print a file type
Definition: RagTime5Graph.hxx:183
RagTime5Graph::readPictureCluster
std::shared_ptr< RagTime5ClusterManager::Cluster > readPictureCluster(RagTime5Zone &zone, int zoneType)
try to read a picture zone
Definition: RagTime5Graph.cxx:3733
RagTime5Graph::readPictureData
bool readPictureData(RagTime5Zone &zone)
try to read a picture data zone: ie. the zone which contains jpeg, tiff, ...
Definition: RagTime5Graph.cxx:1541
RagTime5Graph::send
bool send(int zoneId, MWAWListenerPtr listener, MWAWPosition const &pos)
try to send the cluster zone
Definition: RagTime5Graph.cxx:636
RagTime5Graph::readColorPatternZone
bool readColorPatternZone(RagTime5ClusterManager::Cluster &cluster)
try to read a zone of color and pattern
Definition: RagTime5Graph.cxx:755
RagTime5Graph::RagTime5Graph
RagTime5Graph(RagTime5Graph const &orig)
RagTime5Graph::m_state
std::shared_ptr< RagTime5GraphInternal::State > m_state
the state
Definition: RagTime5Graph.hxx:207
RagTime5StructManager
basic class used to store RagTime 5/6 structures
Definition: RagTime5StructManager.hxx:175
RagTime5StructManager::printType
static std::string printType(unsigned long fileType)
debug: print a file type
Definition: RagTime5StructManager.cxx:94
RagTime5StyleManager
basic class used to read/store RagTime 5/6 styles
Definition: RagTime5StyleManager.hxx:63
RagTime5Zone
main zone in a RagTime v5-v6 document
Definition: RagTime5StructManager.hxx:51
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
RagTime5GraphInternal
Internal: the structures of a RagTime5Graph.
Definition: RagTime5Graph.cxx:63
RagTime5ClusterManager::Cluster
the cluster data
Definition: RagTime5ClusterManager.hxx:261
RagTime5ClusterManager::Link
a link to a small zone (or set of zones) in RagTime 5/6 documents
Definition: RagTime5ClusterManager.hxx:113
RagTime5GraphInternal::ClusterButton
the button cluster
Definition: RagTime5Graph.cxx:361
RagTime5GraphInternal::ClusterGraphic
the shape cluster
Definition: RagTime5Graph.cxx:394
RagTime5GraphInternal::ClusterPicture
the picture cluster
Definition: RagTime5Graph.cxx:436
RagTime5GraphInternal::Shape
Internal: the shape of a RagTime5Graph.
Definition: RagTime5Graph.cxx:224