MWAWOLEStream.hxx
Go to the documentation of this file.
/* -*- Mode: C++; c-default-style: "k&r"; indent-tabs-mode: nil; tab-width: 2; c-basic-offset: 2 -*- */
/* POLE - Portable C++ library to access OLE Storage
Copyright (C) 2002-2005 Ariya Hidayat <ariya@kde.org>
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
* Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of the authors nor the names of its contributors may be
used to endorse or promote products derived from this software without
specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef MWAWOLESTREAM_HXX
#define MWAWOLESTREAM_HXX
#include <string>
#include <fstream>
#include <vector>
#include "libmwaw_internal.hxx"
class WPXInputStream;
namespace libmwawOLE
{
class IStorage;
class IStream;
class Storage
{
friend class Stream;
public:
// for Storage::result()
enum Result { Ok, OpenFailed, NotOLE, BadOLE, UnknownError };
Storage( shared_ptr<WPXInputStream> is );
~Storage();
bool isStructuredDocument();
std::vector<std::string> getSubStreamList(std::string dir="/", bool onlyFiles=true);
bool isSubStream(const std::string &name);
bool isDirectory(const std::string &name);
shared_ptr<WPXInputStream> getSubStream(const std::string &name);
private:
shared_ptr<WPXInputStream> getSubStreamForDirectory(const std::string &name);
libmwawOLE::IStorage *m_io;
// no copy or assign
Storage( const Storage & );
Storage &operator=( const Storage & );
};
} // namespace libmwawOLE
#endif // WPXOLESTREAM_H
// vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
libmwawOLE::Storage::m_io
libmwawOLE::IStorage * m_io
the main data storage
Definition: MWAWOLEStream.hxx:99
libmwawOLE::Storage
class used to read/parse an OLE file
Definition: MWAWOLEStream.hxx:48
libmwawOLE::Storage::operator=
Storage & operator=(const Storage &)
libmwaw_internal.hxx
libmwawOLE::IStorage
Internal and low level: class of libmwawOLE used to read an OLE with various functions to retrieve th...
Definition: MWAWOLEStream.cxx:917
libmwawOLE::Storage::UnknownError
Definition: MWAWOLEStream.hxx:55
libmwawOLE::Storage::~Storage
~Storage()
Destroys the storage.
Definition: MWAWOLEStream.cxx:1693
libmwawOLE::Storage::NotOLE
Definition: MWAWOLEStream.hxx:55
libmwawOLE::Storage::BadOLE
Definition: MWAWOLEStream.hxx:55
libmwawOLE::Storage::Stream
friend class Stream
Definition: MWAWOLEStream.hxx:50
libmwawOLE::Storage::getSubStreamForDirectory
shared_ptr< WPXInputStream > getSubStreamForDirectory(const std::string &name)
Returns a WPXInputStream corresponding to a directory substream.
Definition: MWAWOLEStream.cxx:1780
libmwawOLE::Storage::isDirectory
bool isDirectory(const std::string &name)
Returns true if name corresponds to a directory.
Definition: MWAWOLEStream.cxx:1733
libmwawOLE::Storage::Storage
Storage(shared_ptr< WPXInputStream > is)
Constructs a storage with data.
Definition: MWAWOLEStream.cxx:1688
libmwawOLE::Storage::isSubStream
bool isSubStream(const std::string &name)
Returns true if name corresponds to a sub stream.
Definition: MWAWOLEStream.cxx:1723
libmwawOLE::Storage::isStructuredDocument
bool isStructuredDocument()
Checks whether the storage is OLE2 storage.
Definition: MWAWOLEStream.cxx:1698
libmwawOLE::Storage::OpenFailed
Definition: MWAWOLEStream.hxx:55
libmwawOLE::Storage::Result
Result
Definition: MWAWOLEStream.hxx:55
libmwawOLE::Storage::getSubStreamList
std::vector< std::string > getSubStreamList(std::string dir="/", bool onlyFiles=true)
Returns the list of all ole leaves names.
Definition: MWAWOLEStream.cxx:1703
libmwawOLE::Storage::getSubStream
shared_ptr< WPXInputStream > getSubStream(const std::string &name)
Returns a WPXInputStream corresponding to a leaf/directory substream.
Definition: MWAWOLEStream.cxx:1743
libmwawOLE::Storage::Ok
Definition: MWAWOLEStream.hxx:55