File: CStream.h

package info (click to toggle)
vcmi 1.6.5%2Bdfsg-2
  • links: PTS, VCS
  • area: contrib
  • in suites: forky, sid, trixie
  • size: 32,060 kB
  • sloc: cpp: 238,971; python: 265; sh: 224; xml: 157; ansic: 78; objc: 61; makefile: 49
file content (53 lines) | stat: -rw-r--r-- 1,045 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
/*
 * CStream.h, part of VCMI engine
 *
 * Authors: listed in file AUTHORS in main folder
 *
 * License: GNU General Public License v2.0 or later
 * Full text of license available in license.txt file, in main folder
 *
 */
#pragma once

VCMI_LIB_NAMESPACE_BEGIN

class DLL_LINKAGE CStream : private boost::noncopyable
{
public:
	/**
	 * D-tor.
	 */
	virtual ~CStream() = default;

	/**
	 * Seeks to the specified position.
	 *
	 * @param position The position from the beginning.
	 * @return the position actually moved to, -1 on error.
	 */
	virtual si64 seek(si64 position) = 0;

	/**
	 * Gets the current position in the stream.
	 *
	 * @return the position.
	 */
	virtual si64 tell() = 0;

	/**
	 * Relative seeks to the specified position.
	 *
	 * @param delta The count of bytes to seek from current position.
	 * @return the count of bytes skipped actually.
	 */
	virtual si64 skip(si64 delta) = 0;

	/**
	 * Gets the length of the stream.
	 *
	 * @return the length in bytes
	 */
	virtual si64 getSize() = 0;	
};

VCMI_LIB_NAMESPACE_END