MWAWPictData.hxx Source File documentation

MWAWPictData.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 /* This header contains code specific to a pict which can be stored in a
35 * librevenge::RVNGBinaryData, this includes :
36 * - the mac Pict format (in MWAWPictMac)
37 * - some old data names db3
38 * - some potential short data file
39 */
40
41 #ifndef MWAW_PICT_DATA
42 # define MWAW_PICT_DATA
43
44 # include <ostream>
45
46 # include <librevenge/librevenge.h>
47
48 # include "libmwaw_internal.hxx"
49 # include "MWAWPict.hxx"
50
52 class MWAWPictData : public MWAWPict
53 {
54 public:
56 enum SubType { PictMac, DB3, Unknown };
58 ~MWAWPictData();
60 virtual Type getType() const
61 {
62 return MWAWPict::PictData;
63 }
65 virtual SubType getSubType() const = 0;
66
68 virtual bool getBinary(MWAWEmbeddedObject &picture) const
69 {
70 if (!valid() || isEmpty()) return false;
71
72 librevenge::RVNGBinaryData data;
73 createFileData(m_data, data);
74 picture=MWAWEmbeddedObject(data, "image/pict");
75 return true;
76 }
77
79 virtual bool sure() const
80 {
81 return getSubType() != Unknown;
82 }
83
85 virtual bool valid() const
86 {
87 return false;
88 }
89
91 bool isEmpty() const
92 {
93 return m_empty;
94 }
95
100 static ReadResult check(MWAWInputStreamPtr input, int size, MWAWBox2f &box)
101 {
102 return checkOrGet(input, size, box, 0L);
103 }
104
108 static MWAWPictData *get(MWAWInputStreamPtr input, int size)
109 {
110 MWAWPictData *res = 0L;
111 MWAWBox2f box;
112 if (checkOrGet(input, size, box, &res) == MWAW_R_BAD) return 0L;
113 if (res) { // if the bdbox is good, we set it
114 MWAWVec2f sz = box.size();
115 if (sz.x()>0 && sz.y()>0) res->setBdBox(box);
116 }
117 return res;
118 }
119
122 virtual int cmp(MWAWPict const &a) const
123 {
124 int diff = MWAWPict::cmp(a);
125 if (diff) return diff;
126 MWAWPictData const &aPict = static_cast<MWAWPictData const &>(a);
127
128 diff = static_cast<int>(m_empty) - static_cast<int>(aPict.m_empty);
129 if (diff) return (diff < 0) ? -1 : 1;
130 else if (m_empty) // both empty
131 return 0;
132 // the type
133 diff = getSubType() - aPict.getSubType();
134 if (diff) return (diff < 0) ? -1 : 1;
135
136 if (m_data.size() < aPict.m_data.size())
137 return 1;
138 if (m_data.size() > aPict.m_data.size())
139 return -1;
140 unsigned char const *data=m_data.getDataBuffer();
141 unsigned char const *aData=m_data.getDataBuffer();
142 if (!data || !aData) return 0; // must only appear if the two buffers are empty
143 for (unsigned long c=0; c < m_data.size(); c++, data++, aData++) {
144 if (*data < *aData) return -1;
145 if (*data > *aData) return 1;
146 }
147 return 0;
148 }
149
150 protected:
153 static bool createFileData(librevenge::RVNGBinaryData const &orig, librevenge::RVNGBinaryData &result);
154
156 MWAWPictData(): m_data(), m_empty(false) { }
157 explicit MWAWPictData(MWAWBox2f &): m_data(), m_empty(false) { }
158
164 static ReadResult checkOrGet(MWAWInputStreamPtr input, int size,
165 MWAWBox2f &box, MWAWPictData **result = 0L);
166
168 librevenge::RVNGBinaryData m_data;
169
171 bool m_empty;
172 };
173
175 class MWAWPictDB3 : public MWAWPictData
176 {
177 public:
179 virtual ~MWAWPictDB3();
180
182 virtual SubType getSubType() const
183 {
184 return DB3;
185 }
186
188 virtual bool valid() const
189 {
190 return m_data.size() != 0;
191 }
192
195 virtual int cmp(MWAWPict const &a) const
196 {
197 return MWAWPictData::cmp(a);
198 }
199
200 protected:
201
203 MWAWPictDB3()
204 {
205 m_empty = false;
206 }
207
208 friend class MWAWPictData;
214 static ReadResult checkOrGet(MWAWInputStreamPtr input, int size, MWAWPictData **result = 0L);
215 };
216
218 class MWAWPictDUnknown : public MWAWPictData
219 {
220 public:
222 ~MWAWPictDUnknown();
223
225 virtual SubType getSubType() const
226 {
227 return Unknown;
228 }
229
231 virtual bool valid() const
232 {
233 return m_data.size() != 0;
234 }
235
238 virtual int cmp(MWAWPict const &a) const
239 {
240 return MWAWPictData::cmp(a);
241 }
242
243 protected:
244
246 MWAWPictDUnknown()
247 {
248 m_empty = false;
249 }
250
251 friend class MWAWPictData;
252
258 static ReadResult checkOrGet(MWAWInputStreamPtr input, int size, MWAWPictData **result = 0L);
259 };
260
261 #endif
262 // vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
MWAWPictData::m_data
librevenge::RVNGBinaryData m_data
the data size (without the empty header of 512 characters)
Definition: MWAWPictData.hxx:168
MWAWPictData::cmp
virtual int cmp(MWAWPict const &a) const
a virtual function used to obtain a strict order, must be redefined in the subs class ...
Definition: MWAWPictData.hxx:122
MWAWPictData::MWAWPictData
MWAWPictData(MWAWBox2f &)
Definition: MWAWPictData.hxx:157
MWAWPictData::~MWAWPictData
~MWAWPictData()
destructor
Definition: MWAWPictData.cxx:45
MWAWPictDB3::getSubType
virtual SubType getSubType() const
returns the picture subtype
Definition: MWAWPictData.hxx:182
MWAWPictDB3::cmp
virtual int cmp(MWAWPict const &a) const
a virtual function used to obtain a strict order, must be redefined in the subs class ...
Definition: MWAWPictData.hxx:195
MWAWPictDUnknown::valid
virtual bool valid() const
returns true if the picture is valid
Definition: MWAWPictData.hxx:231
MWAWPictData::DB3
Definition: MWAWPictData.hxx:56
MWAWVec2::y
T y() const
second element
Definition: libmwaw_internal.hxx:634
MWAWPictDUnknown::getSubType
virtual SubType getSubType() const
returns the picture subtype
Definition: MWAWPictData.hxx:225
MWAWPictDB3
a small table file (known by open office)
Definition: MWAWPictData.hxx:175
MWAWPictData::Unknown
Definition: MWAWPictData.hxx:56
libmwaw_internal.hxx
MWAWPictData::checkOrGet
static ReadResult checkOrGet(MWAWInputStreamPtr input, int size, MWAWBox2f &box, MWAWPictData **result=0L)
checks if the data pointed by input and of given size is a pict
Definition: MWAWPictData.cxx:60
MWAWPictDB3::valid
virtual bool valid() const
returns true if the picture is valid
Definition: MWAWPictData.hxx:188
MWAWPictData::createFileData
static bool createFileData(librevenge::RVNGBinaryData const &orig, librevenge::RVNGBinaryData &result)
a file pict can be created from the data pict by adding a header with size 512, this function do this...
Definition: MWAWPictData.cxx:49
MWAWPict::ReadResult
ReadResult
an enum to defined the result of a parsing use by some picture&#39;s classes which can read their data ...
Definition: MWAWPict.hxx:73
MWAWPictData::isEmpty
bool isEmpty() const
returns true if the picture is valid and has size 0 or contains no data
Definition: MWAWPictData.hxx:91
MWAWPictDUnknown
class to store small data which are potentially a picture
Definition: MWAWPictData.hxx:218
MWAWBox2::size
MWAWVec2< T > size() const
the box size
Definition: libmwaw_internal.hxx:1022
MWAWPict::setBdBox
void setBdBox(MWAWBox2f const &box)
sets the bdbox of the picture
Definition: MWAWPict.hxx:84
MWAWVec2::x
T x() const
first element
Definition: libmwaw_internal.hxx:629
MWAWPictData::PictMac
Definition: MWAWPictData.hxx:56
MWAWBox2< float >
MWAWPict.hxx
MWAWPictData::m_empty
bool m_empty
some picture can be valid but empty
Definition: MWAWPictData.hxx:171
MWAWPictData
an abstract class which defines basic formated picture ( AppleŠ Pict, DB3, ...)
Definition: MWAWPictData.hxx:52
MWAWPict::cmp
virtual int cmp(MWAWPict const &a) const
a virtual function used to obtain a strict order, must be redefined in the subs class ...
Definition: MWAWPict.hxx:101
MWAWPictData::MWAWPictData
MWAWPictData()
protected constructor: use check to construct a picture
Definition: MWAWPictData.hxx:156
MWAWPictData::getBinary
virtual bool getBinary(MWAWEmbeddedObject &picture) const
returns the final picture
Definition: MWAWPictData.hxx:68
MWAWPict::Type
Type
the different picture types:
Definition: MWAWPict.hxx:63
MWAWEmbeddedObject
small class use to define a embedded object
Definition: libmwaw_internal.hxx:439
MWAWPictDUnknown::MWAWPictDUnknown
MWAWPictDUnknown()
protected constructor: uses check to construct a picture
Definition: MWAWPictData.hxx:246
MWAWPict::PictData
Definition: MWAWPict.hxx:63
MWAWInputStreamPtr
shared_ptr< MWAWInputStream > MWAWInputStreamPtr
a smart pointer of MWAWInputStream
Definition: libmwaw_internal.hxx:517
MWAWPictData::sure
virtual bool sure() const
returns true if we are relatively sure that the data are correct
Definition: MWAWPictData.hxx:79
MWAWPictDUnknown::cmp
virtual int cmp(MWAWPict const &a) const
a virtual function used to obtain a strict order, must be redefined in the subs class ...
Definition: MWAWPictData.hxx:238
MWAWPictData::getSubType
virtual SubType getSubType() const =0
returns the picture subtype
MWAWPictData::SubType
SubType
the picture subtype
Definition: MWAWPictData.hxx:56
MWAWPict::MWAW_R_BAD
Definition: MWAWPict.hxx:73
MWAWPictData::getType
virtual Type getType() const
returns the picture type
Definition: MWAWPictData.hxx:60
MWAWPictData::valid
virtual bool valid() const
returns true if the picture is valid
Definition: MWAWPictData.hxx:85
MWAWPictData::check
static ReadResult check(MWAWInputStreamPtr input, int size, MWAWBox2f &box)
checks if the data pointed by input is known
Definition: MWAWPictData.hxx:100
MWAWPict
Generic function used to define/store a picture.
Definition: MWAWPict.hxx:51
MWAWVec2< float >
MWAWPictDB3::MWAWPictDB3
MWAWPictDB3()
protected constructor: uses check to construct a picture
Definition: MWAWPictData.hxx:203