File: file.h

package info (click to toggle)
scummvm 2.9.1%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 450,580 kB
  • sloc: cpp: 4,299,825; asm: 28,322; python: 12,901; sh: 11,302; java: 9,289; xml: 7,895; perl: 2,639; ansic: 2,465; yacc: 1,670; javascript: 1,020; makefile: 933; lex: 578; awk: 275; objc: 82; sed: 11; php: 1
file content (183 lines) | stat: -rw-r--r-- 5,510 bytes parent folder | download | duplicates (2)
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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef COMMON_FILE_H
#define COMMON_FILE_H

#include "common/scummsys.h"
#include "common/fs.h"
#include "common/noncopyable.h"
#include "common/str.h"
#include "common/stream.h"

namespace Common {

/**
 * @defgroup common_files Files
 * @ingroup common
 *
 * @brief  API for operations on files.
 *
 * @{
 */

class Archive;

/**
 * @todo vital to document this core class properly!!! For both users and implementors
 */
class File : public SeekableReadStream, public NonCopyable {
protected:
	/** File handle to the actual file; 0 if no file is open. */
	SeekableReadStream *_handle;

	/** The name of this file, kept for debugging purposes. */
	String _name;

public:
	File();
	virtual ~File();

	/**
	 * Check if a given file exists in any of the current default paths,
	 * as defined by SearchMan.
	 *
	 * @param	filename	The file to check for.
	 * @return	True if the file exists, false otherwise.
	 */
	static bool exists(const Path &filename);

	/**
	 * Try to open the file with the given file name, by searching SearchMan.
	 * @note Must not be called if this file is already open (i.e. if isOpen returns true).
	 *
	 * @param	filename	Name of the file to open.
	 * @return	True if the file was opened successfully, false otherwise.
	 */
	virtual bool open(const Path &filename);

	/**
	 * Try to open the file with the given file name from within the given archive.
	 * @note Must not be called if this file is already open (i.e. if isOpen returns true).
	 *
	 * @param	filename	Name of the file to open.
	 * @param	archive		Archive in which to search for the file.
	 * @return	True if the file was opened successfully, false otherwise.
	 */
	virtual bool open(const Path &filename, Archive &archive);

	/**
	 * Try to open the file corresponding to the given node. Will check whether the
	 * node actually refers to an existing file (and not a directory), and handle
	 * those cases gracefully.
	 * @note Must not be called if this file already is open (i.e. if isOpen returns true).
	 *
	 * @param   node        The node to consider.
	 * @return	True if the file was opened successfully, false otherwise.
	 */
	virtual bool open(const FSNode &node);

	/**
	 * Try to 'open' the given stream. That is, wrap around it, and if the stream
	 * is a NULL pointer, gracefully treat this as if opening failed.
	 * @note Must not be called if this file already is open (i.e. if isOpen returns true).
	 *
	 * @param	stream		Pointer to a SeekableReadStream, or 0.
	 * @param	name		String describing the 'file' corresponding to the stream.
	 * @return	True if the stream was non-zero, false otherwise.
	 */
	virtual bool open(SeekableReadStream *stream, const String &name);

	/**
	 * Close the file, if open.
	 */
	virtual void close();

	/**
	 * Check if the object opened a file successfully.
	 *
	 * @return True if any file is opened, false otherwise.
	 */
	bool isOpen() const;

	/**
	 * Return the file name of the opened file for debugging purposes.
	 *
	 * @return The file name of the opened file.
	 */
	const char *getName() const { return _name.c_str(); }

	bool err() const override;	/*!< Implement abstract Stream method. */
	void clearErr() override;	/*!< Implement abstract Stream method. */
	bool eos() const override;	/*!< Implement abstract SeekableReadStream method. */

	int64 pos() const override;	 /*!< Implement abstract SeekableReadStream method. */
	int64 size() const override; /*!< Implement abstract SeekableReadStream method. */
	bool seek(int64 offs, int whence = SEEK_SET) override;	/*!< Implement abstract SeekableReadStream method. */
	uint32 read(void *dataPtr, uint32 dataSize) override;	/*!< Implement abstract SeekableReadStream method. */
};


/**
 * @todo Document this class
 *
 * Some design ideas:
 *  - automatically drop all files into dumps/ dir? Might not be desired in all cases
 */
class DumpFile : public SeekableWriteStream, public NonCopyable {
protected:
	/** File handle to the actual file. 0 if no file is open. */
	WriteStream *_handle;

public:
	DumpFile();
	virtual ~DumpFile();

	virtual bool open(const Path &filename, bool createPath = false);
	virtual bool open(const FSNode &node);

	virtual void close();

	/**
	 * Check if the object opened a file successfully.
	 *
	 * @return True if any file is opened, false otherwise.
	 */
	bool isOpen() const;

	bool err() const override;
	void clearErr() override;

	uint32 write(const void *dataPtr, uint32 dataSize) override;

	bool flush() override;

	int64 pos() const override;

	bool seek(int64 offset, int whence = SEEK_SET) override;
	int64 size() const override;
};

/** @} */

} // End of namespace Common

#endif