StarBitmap.hxx Source File documentation

StarBitmap.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 /* libstaroffice
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 * StarBitmap to read/parse some basic bitmap/pattern in StarOffice documents
36 *
37 */
38 #ifndef STAR_BITMAP
39 # define STAR_BITMAP
40
41 #include <vector>
42
43 #include "libstaroffice_internal.hxx"
44 #include "STOFFDebug.hxx"
45 #include "STOFFEntry.hxx"
46 #include "STOFFInputStream.hxx"
47
48 namespace StarBitmapInternal
49 {
50 struct Bitmap;
51 struct State;
52 }
53
54 class StarObject;
55 class StarZone;
56
62 class StarBitmap
63 {
64 public:
66 StarBitmap();
68 explicit StarBitmap(uint32_t const((&pixels)[32]), STOFFColor const((&colors)[2]));
70 virtual ~StarBitmap();
71
73
77 bool readBitmap(StarZone &zone, bool inFileHeader, long lastPos, librevenge::RVNGBinaryData &data, std::string &type);
79 bool getData(librevenge::RVNGBinaryData &data, std::string &type) const;
81 STOFFVec2i getBitmapSize() const;
82 protected:
84 bool readBitmapInformation(StarZone &zone, StarBitmapInternal::Bitmap &info, long lastPos);
86 bool readBitmapData(STOFFInputStreamPtr &input, StarBitmapInternal::Bitmap &bitmap, long lastPos);
87 //
88 // data
89 //
90 private:
92 std::shared_ptr<StarBitmapInternal::State> m_state;
93 };
94 #endif
95 // vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
STOFFVec2< int >
StarBitmapInternal::Bitmap::m_numColors
uint32_t m_numColors[2]
the number of used column (used, other)
Definition: StarBitmap.cxx:150
StarZone::ascii
libstoff::DebugFile & ascii()
returns the ascii file
Definition: StarZone.hxx:254
StarBitmapInternal::Bitmap::m_colorsList
std::vector< STOFFColor > m_colorsList
the bitmap color list
Definition: StarBitmap.cxx:152
STOFFEntry.hxx
STOFF_DEBUG_MSG
#define STOFF_DEBUG_MSG(M)
Definition: libstaroffice_internal.hxx:129
StarBitmapInternal::Bitmap::getPPMData
bool getPPMData(librevenge::RVNGBinaryData &data) const
try to return a ppm data (without alpha)
Definition: StarBitmap.cxx:80
StarBitmapInternal::Bitmap::m_hasAlphaColor
bool m_hasAlphaColor
a flag to know if the color has alpha component
Definition: StarBitmap.cxx:148
STOFFColor
the class to store a color
Definition: libstaroffice_internal.hxx:189
StarBitmap::readBitmap
bool readBitmap(StarZone &zone, bool inFileHeader, long lastPos, librevenge::RVNGBinaryData &data, std::string &type)
low level
Definition: StarBitmap.cxx:214
StarBitmapInternal::Bitmap::m_pixelsPerMeter
uint32_t m_pixelsPerMeter[2]
the number of x/y pixel by meters
Definition: StarBitmap.cxx:146
StarBitmapInternal::Bitmap::Bitmap
Bitmap()
constructor
Definition: StarBitmap.cxx:64
StarBitmapInternal::Bitmap::m_bitCount
uint16_t m_bitCount
the bit count
Definition: StarBitmap.cxx:140
StarBitmap
the main class to read/.
Definition: StarBitmap.hxx:62
libstaroffice_internal.hxx
StarBitmap::readBitmapData
bool readBitmapData(STOFFInputStreamPtr &input, StarBitmapInternal::Bitmap &bitmap, long lastPos)
try to read the bitmap data block
Definition: StarBitmap.cxx:511
StarBitmapInternal::Bitmap::m_compression
uint32_t m_compression
related to compression
Definition: StarBitmap.cxx:142
libstoff::Debug::dumpFile
bool dumpFile(librevenge::RVNGBinaryData &, char const *)
Definition: STOFFDebug.hxx:183
libstoff::DebugStream::str
static std::string str()
Definition: STOFFDebug.hxx:203
StarBitmapInternal::Bitmap::m_colorDataList
std::vector< STOFFColor > m_colorDataList
the color bitmap data
Definition: StarBitmap.cxx:156
StarBitmapInternal::Bitmap::operator<<
friend std::ostream & operator<<(std::ostream &o, Bitmap const &info)
operator<<
Definition: StarBitmap.cxx:119
StarBitmapInternal::Bitmap::m_width
uint32_t m_width
bitmap width
Definition: StarBitmap.cxx:134
StarBitmapInternal::State
Internal: the state of a StarBitmap.
Definition: StarBitmap.cxx:160
StarBitmapInternal::State::State
State()
constructor
Definition: StarBitmap.cxx:162
StarBitmapInternal::Bitmap::m_sizeImage
uint32_t m_sizeImage
the image size?
Definition: StarBitmap.cxx:144
STOFFInputStreamPtr
std::shared_ptr< STOFFInputStream > STOFFInputStreamPtr
a smart pointer of STOFFInputStream
Definition: libstaroffice_internal.hxx:489
StarZone
a zone in a StarOffice file
Definition: StarZone.hxx:56
StarZone::getRecordLevel
int getRecordLevel() const
returns the record level
Definition: StarZone.hxx:195
StarObject
an object corresponding to an OLE directory
Definition: StarObject.hxx:64
StarBitmapInternal::Bitmap::m_height
uint32_t m_height
bitmap height
Definition: StarBitmap.cxx:136
libstoff::DebugStream
Definition: STOFFDebug.hxx:194
StarBitmap::getData
bool getData(librevenge::RVNGBinaryData &data, std::string &type) const
try to convert the read data in ppm
Definition: StarBitmap.cxx:201
STOFFStringStream.hxx
StarBitmapInternal::Bitmap::m_indexDataList
std::vector< int > m_indexDataList
the index bitmap data
Definition: StarBitmap.cxx:154
StarBitmap::m_state
std::shared_ptr< StarBitmapInternal::State > m_state
the state
Definition: StarBitmap.hxx:92
StarBitmapInternal::State::m_bitmap
Bitmap m_bitmap
the bitmap
Definition: StarBitmap.cxx:167
STOFFDebug.hxx
StarBitmap.hxx
StarBitmapInternal::Bitmap
internal: the bitmap information
Definition: StarBitmap.cxx:62
libstoff::DebugFile::addPos
static void addPos(long)
Definition: STOFFDebug.hxx:223
libstoff::DebugFile::addDelimiter
static void addDelimiter(long, char)
Definition: STOFFDebug.hxx:225
StarZone.hxx
libstoff::DebugFile
Definition: STOFFDebug.hxx:210
STOFFInputStream
Internal class used to read the file stream Internal class used to read the file stream,...
Definition: STOFFInputStream.hxx:53
StarBitmap::readBitmapInformation
bool readBitmapInformation(StarZone &zone, StarBitmapInternal::Bitmap &info, long lastPos)
try to read the bitmap information block
Definition: StarBitmap.cxx:449
StarBitmap::StarBitmap
StarBitmap()
constructor
Definition: StarBitmap.cxx:175
libstoff::DebugFile::addNote
static void addNote(char const *)
Definition: STOFFDebug.hxx:224
libstoff::DebugFile::skipZone
static void skipZone(long, long)
Definition: STOFFDebug.hxx:230
StarZone::input
STOFFInputStreamPtr input()
return the zone input
Definition: StarZone.hxx:247
StarBitmap::~StarBitmap
virtual ~StarBitmap()
destructor
Definition: StarBitmap.cxx:180
STOFFVec2i
STOFFVec2< int > STOFFVec2i
STOFFVec2 of int.
Definition: libstaroffice_internal.hxx:767
STOFFInputStream.hxx
StarItemPool.hxx
StarBitmapInternal::Bitmap::m_planes
uint16_t m_planes
the number of planes
Definition: StarBitmap.cxx:138
STOFFStringStream
internal class used to create a RVNGInputStream from a unsigned char's pointer
Definition: STOFFStringStream.hxx:36
StarBitmap::getBitmapSize
STOFFVec2i getBitmapSize() const
try to return the bitmap size (in point)
Definition: StarBitmap.cxx:209
StarBitmapInternal
Internal: the structures of a StarBitmap.
Definition: StarBitmap.cxx:58