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
|
/* ScummVM - Scumm Interpreter
* Copyright (C) 2002-2006 The ScummVM project
*
* 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/stdafx.h"
#include "common/scummsys.h"
#include "common/str.h"
#include "common/stream.h"
class FilesystemNode;
namespace Common {
class File : public SeekableReadStream, public WriteStream {
protected:
/** POSIX file handle to the actual file; 0 if no file is open. */
FILE *_handle;
/** Status flag which tells about recent I/O failures. */
bool _ioFailed;
/** Simple ref-counter for File objects. */
int32 _refcount;
/** The name of this file, for debugging. */
String _name;
private:
// Disallow copying File objects. There is not strict reason for this,
// except that so far we never had real need for such a feature, and
// code that accidentally copied File objects tended to break in strange
// ways.
File(const File &f);
File &operator =(const File &f);
public:
enum AccessMode {
kFileReadMode = 1,
kFileWriteMode = 2
};
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);
/**
* Increases the reference counter of the file object.
* This can be used to share file objects between different
* parts of the code. Some systems (like Symbian don't support
* it thought). It should just be used on file objects
* allocated with new, since decRef destroys the object
* with delete if the counter reaches zero.
*
* This is a possible candidate to be reworked in the future
* see the TODO list for more information.
*/
void incRef();
/**
* Decreases the reference counter of the file object.
* If the counter is zero after this call, the file object will
* be deleted, with delete. It should just be used on file objects
* allocated with new out of that reason.
*
* This is a possible candidate to be reworked in the future
* see the TODO list for more information.
*/
void decRef();
virtual bool open(const String &filename, AccessMode mode = kFileReadMode);
virtual bool open(const FilesystemNode &node, AccessMode mode = kFileReadMode);
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.
*/
bool eof() const;
uint32 pos() const;
uint32 size() const;
void seek(int32 offs, int whence = SEEK_SET);
uint32 read(void *dataPtr, uint32 dataSize);
uint32 write(const void *dataPtr, uint32 dataSize);
};
} // End of namespace Common
#endif
|
