Coverage Report

Created: 2026-03-12 06:42

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/librevenge/inc/librevenge-stream/RVNGStream.h
Line
Count
Source
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) 2004-2005 William Lachance (wrlach@gmail.com)
11
 *
12
 * For minor contributions see the git repository.
13
 *
14
 * Alternatively, the contents of this file may be used under the terms
15
 * of the GNU Lesser General Public License Version 2.1 or later
16
 * (LGPLv2.1+), in which case the provisions of the LGPLv2.1+ are
17
 * applicable instead of those above.
18
 */
19
20
#ifndef RVNGSTREAM_H
21
#define RVNGSTREAM_H
22
23
namespace librevenge
24
{
25
26
enum RVNG_SEEK_TYPE
27
{
28
  RVNG_SEEK_CUR,
29
  RVNG_SEEK_SET,
30
  RVNG_SEEK_END
31
};
32
33
class RVNGInputStream
34
{
35
public:
36
23.3M
  RVNGInputStream() {}
37
23.3M
  virtual ~RVNGInputStream() {}
38
39
  /**
40
  Analyses the content of the input stream to see whether it is an OLE2 storage.
41
  \return A boolean value that should be true if the input stream is an OLE2 storage
42
  and false if it is not the case
43
  */
44
  virtual bool isStructured() = 0;
45
46
  virtual unsigned subStreamCount() = 0;
47
48
  virtual const char *subStreamName(unsigned id) = 0;
49
50
  virtual bool existsSubStream(const char *name) = 0;
51
52
  /**
53
  Extracts a \c named stream from an OLE2 storage.
54
  \return Should be a pointer to RVNGInputStream constructed from the \c named stream if it exists.
55
  \return Should be 0, if the \c named stream does not exist inside the OLE2 storage
56
  or if the input stream is not an OLE2 storage.
57
  */
58
  virtual RVNGInputStream *getSubStreamByName(const char *name) = 0;
59
60
  virtual RVNGInputStream *getSubStreamById(unsigned id) = 0;
61
62
  /**
63
  Tries to read a given number of bytes starting from the current position inside the input stream.
64
  \param numBytes Number of bytes desired to be read.
65
  \param numBytesRead Number of bytes that were possible to be read.
66
  \return Should be a pointer to an array of numBytesRead bytes (unsigned char[numBytesRead]).
67
  \return Optionally it could be 0 if the desired number of bytes could not be read.
68
  */
69
  virtual const unsigned char *read(unsigned long numBytes, unsigned long &numBytesRead) = 0;
70
71
  /**
72
  Moves to the next location inside the input stream.
73
  \param offset The offset of the location inside the input stream to move to.
74
  It is relative either to the current position or to the beginning of the input stream
75
  depending on the value of the \c seekType parameter.
76
  \param seekType Determines whether the \c offset is relative to the
77
  beginning of the input stream (\c RVNG_SEEK_SET) or to the current position (\c RVNG_SEEK_CUR).
78
  \return An integer value that should be 0 (zero) if the seek was successful and any other value
79
  if it failed (i.e. the requested \c offset is beyond the end of the input stream or before its beginning).
80
  */
81
  virtual int seek(long offset, RVNG_SEEK_TYPE seekType) = 0;
82
83
  /**
84
  Returns the actual position inside the input stream.
85
  \return A long integer value that should correspond to the position of the next location to be read in the input stream.
86
  */
87
  virtual long tell() = 0;
88
89
  /**
90
  Determines whether the current position is at the end of the stream.
91
  \return A boolean value that should be true if the next location to be read in the input stream
92
  is beyond its end. In all other cases, it should be false.
93
  */
94
  virtual bool isEnd() = 0;
95
};
96
97
}
98
99
#endif
100
/* vim:set shiftwidth=4 softtabstop=4 noexpandtab: */