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
|
/* 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 2
* 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, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* $URL$
* $Id$
*
*/
#ifndef COMMON_FILE_H
#define COMMON_FILE_H
#include "common/scummsys.h"
#include "common/noncopyable.h"
#include "common/str.h"
#include "common/stream.h"
class FilesystemNode;
namespace Common {
/**
* 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. */
void *_handle;
/** Status flag which tells about recent I/O failures. */
bool _ioFailed;
/** The name of this file, for debugging. */
String _name;
public:
static void addDefaultDirectory(const String &directory);
static void addDefaultDirectoryRecursive(const String &directory, int level = 4, const String &prefix = "");
static void addDefaultDirectory(const FilesystemNode &directory);
static void addDefaultDirectoryRecursive(const FilesystemNode &directory, int level = 4, const String &prefix = "");
static void resetDefaultDirectories();
File();
virtual ~File();
/**
* Checks if a given file exists in any of the current default paths
* (those were/are added by addDefaultDirectory and/or
* addDefaultDirectoryRecursive).
*
* @param filename: the file to check for
* @return: true if the file exists, else false
*/
static bool exists(const String &filename);
virtual bool open(const String &filename);
virtual bool open(const FilesystemNode &node);
virtual void close();
/**
* Checks if the object opened a file successfully.
*
* @return: true if any file is opened, false otherwise.
*/
bool isOpen() const;
/**
* Returns the filename of the opened file.
*
* @return: the filename
*/
const char *name() const { return _name.c_str(); }
bool ioFailed() const;
void clearIOFailed();
bool eos() const { return eof(); }
/**
* Checks for end of file.
*
* @return: true if the end of file is reached, false otherwise.
*/
virtual bool eof() const;
virtual uint32 pos() const;
virtual uint32 size() const;
void seek(int32 offs, int whence = SEEK_SET);
uint32 read(void *dataPtr, uint32 dataSize);
};
/**
* TODO: document this class
*
* Some design ideas:
* - automatically drop all files into dumps/ dir? Might not be desired in all cases
*/
class DumpFile : public WriteStream, public NonCopyable {
protected:
/** File handle to the actual file; 0 if no file is open. */
void *_handle;
public:
DumpFile();
virtual ~DumpFile();
virtual bool open(const String &filename);
virtual bool open(const FilesystemNode &node);
virtual void close();
/**
* Checks if the object opened a file successfully.
*
* @return: true if any file is opened, false otherwise.
*/
bool isOpen() const;
bool ioFailed() const;
void clearIOFailed();
bool eos() const { return eof(); }
/**
* Checks for end of file.
*
* @return: true if the end of file is reached, false otherwise.
*/
virtual bool eof() const;
virtual uint32 write(const void *dataPtr, uint32 dataSize);
virtual void flush();
};
} // End of namespace Common
#endif
|
