RVNGDirectoryStream.h
Go to the documentation of this file.
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: t; c-basic-offset: 4 -*- */
2 /* librevenge
3  * Version: MPL 2.0 / LGPLv2.1+
4  *
5  * This Source Code Form is subject to the terms of the Mozilla Public
6  * License, v. 2.0. If a copy of the MPL was not distributed with this
7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8  *
9  * Major Contributor(s):
10  * Copyright (C) 2002-2005 William Lachance (wrlach@gmail.com)
11  * Copyright (C) 2002 Marc Maurer (uwog@uwog.net)
12  * Copyright (C) 2006 Fridrich Strba (fridrich.strba@bluewin.ch)
13  *
14  * For minor contributions see the git repository.
15  *
16  * Alternatively, the contents of this file may be used under the terms
17  * of the GNU Lesser General Public License Version 2.1 or later
18  * (LGPLv2.1+), in which case the provisions of the LGPLv2.1+ are
19  * applicable instead of those above.
20  */
21 
22 #ifndef RVNGDIRECTORYSTREAM_H_INCLUDED
23 #define RVNGDIRECTORYSTREAM_H_INCLUDED
24 
25 #include "librevenge-stream-api.h"
26 
27 #include "RVNGStream.h"
28 
29 namespace librevenge
30 {
31 
32 struct RVNGDirectoryStreamImpl;
33 
41 {
42  // disable copying
45 
46 public:
52  explicit RVNGDirectoryStream(const char *path);
53 
54  virtual ~RVNGDirectoryStream();
55 
63  static RVNGDirectoryStream *createForParent(const char *path);
64 
69  static bool isDirectory(const char *path);
70 
71  virtual bool isStructured();
72  virtual unsigned subStreamCount();
73  virtual const char *subStreamName(unsigned id);
74  virtual bool existsSubStream(const char *name);
75  virtual RVNGInputStream *getSubStreamByName(const char *name);
76  virtual RVNGInputStream *getSubStreamById(unsigned id);
77 
78  virtual const unsigned char *read(unsigned long numBytes, unsigned long &numBytesRead);
79  virtual int seek(long offset, RVNG_SEEK_TYPE seekType);
80  virtual long tell();
81  virtual bool isEnd();
82 
83 private:
85 };
86 
87 }
88 
89 #endif // RVNGDIRECTORYSTREAM_H_INCLUDED
90 
91 /* vim:set shiftwidth=4 softtabstop=4 noexpandtab: */
librevenge-stream.h
librevenge::RVNGDirectoryStream::existsSubStream
virtual bool existsSubStream(const char *name)
Definition: RVNGDirectoryStream.cpp:162
librevenge::RVNGDirectoryStream::operator=
RVNGDirectoryStream & operator=(const RVNGDirectoryStream &)
librevenge::RVNGDirectoryStream::seek
virtual int seek(long offset, RVNG_SEEK_TYPE seekType)
Moves to the next location inside the input stream.
Definition: RVNGDirectoryStream.cpp:208
librevenge::RVNGDirectoryStream::subStreamCount
virtual unsigned subStreamCount()
Definition: RVNGDirectoryStream.cpp:147
S_ISREG
#define S_ISREG(x)
Definition: RVNGStreamImplementation.cpp:35
librevenge::RVNGDirectoryStream::read
virtual const unsigned char * read(unsigned long numBytes, unsigned long &numBytesRead)
Tries to read a given number of bytes starting from the current position inside the input stream.
Definition: RVNGDirectoryStream.cpp:202
librevenge-stream-api.h
librevenge::RVNGDirectoryStream::isStructured
virtual bool isStructured()
Analyses the content of the input stream to see whether it is an OLE2 storage.
Definition: RVNGDirectoryStream.cpp:140
librevenge::RVNGDirectoryStream::subStreamName
virtual const char * subStreamName(unsigned id)
Definition: RVNGDirectoryStream.cpp:155
librevenge::RVNGDirectoryStream
A stream representation of a directory.
Definition: RVNGDirectoryStream.h:41
librevenge::RVNGFileStream
Definition: RVNGStreamImplementation.h:33
librevenge::RVNGDirectoryStreamImpl
Definition: RVNGDirectoryStream.cpp:93
librevenge::RVNGDirectoryStream::~RVNGDirectoryStream
virtual ~RVNGDirectoryStream()
Definition: RVNGDirectoryStream.cpp:114
RVNGStream.h
librevenge::RVNGDirectoryStream::createForParent
static RVNGDirectoryStream * createForParent(const char *path)
Create a stream for parent directory of path.
Definition: RVNGDirectoryStream.cpp:119
librevenge::RVNGDirectoryStream::isDirectory
static bool isDirectory(const char *path)
Test whether path is a directory.
Definition: RVNGDirectoryStream.cpp:135
librevenge::RVNGDirectoryStreamImpl::RVNGDirectoryStreamImpl
RVNGDirectoryStreamImpl(const char *path)
Definition: RVNGDirectoryStream.cpp:99
librevenge::RVNGDirectoryStream::RVNGDirectoryStream
RVNGDirectoryStream(const RVNGDirectoryStream &)
REVENGE_STREAM_API
#define REVENGE_STREAM_API
Definition: librevenge-stream-api.h:34
librevenge::RVNGDirectoryStream::tell
virtual long tell()
Returns the actual position inside the input stream.
Definition: RVNGDirectoryStream.cpp:213
librevenge::RVNGInputStream
Definition: RVNGStream.h:34
offset
unsigned offset
Definition: RVNGZipStream.cpp:77
librevenge::RVNG_SEEK_TYPE
RVNG_SEEK_TYPE
Definition: RVNGStream.h:27
librevenge
Definition: RVNGBinaryData.cpp:39
librevenge::RVNGDirectoryStreamImpl::m_splitPath
std::vector< std::string > m_splitPath
Definition: RVNGDirectoryStream.cpp:94
librevenge::RVNGDirectoryStream::m_impl
RVNGDirectoryStreamImpl * m_impl
Definition: RVNGDirectoryStream.h:84
librevenge::RVNGDirectoryStream::getSubStreamByName
virtual RVNGInputStream * getSubStreamByName(const char *name)
Extracts a named stream from an OLE2 storage.
Definition: RVNGDirectoryStream.cpp:176
librevenge::RVNGDirectoryStream::getSubStreamById
virtual RVNGInputStream * getSubStreamById(unsigned id)
Definition: RVNGDirectoryStream.cpp:195
librevenge::RVNGDirectoryStream::isEnd
virtual bool isEnd()
Determines whether the current position is at the end of the stream.
Definition: RVNGDirectoryStream.cpp:220

Generated for librevenge by doxygen 1.8.18