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
|
/* 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.
*
*/
#ifndef SCI_ENGINE_FILE_H
#define SCI_ENGINE_FILE_H
#include "common/str-array.h"
#include "common/stream.h"
namespace Sci {
enum {
_K_FILE_MODE_OPEN_OR_CREATE = 0,
_K_FILE_MODE_OPEN_OR_FAIL = 1,
_K_FILE_MODE_CREATE = 2
};
/* Maximum length of a savegame name (including terminator character). */
#define SCI_MAX_SAVENAME_LENGTH 0x24
enum {
MAX_SAVEGAME_NR = 20 /**< Maximum number of savegames */
};
#define VIRTUALFILE_HANDLE 200
#define PHANTASMAGORIA_SAVEGAME_INDEX "phantsg.dir"
struct SavegameDesc {
int16 id;
int virtualId; // straight numbered, according to id but w/o gaps
int date;
int time;
int version;
char name[SCI_MAX_SAVENAME_LENGTH];
};
class FileHandle {
public:
Common::String _name;
Common::SeekableReadStream *_in;
Common::WriteStream *_out;
public:
FileHandle();
~FileHandle();
void close();
bool isOpen() const;
};
class DirSeeker {
protected:
reg_t _outbuffer;
Common::StringArray _files;
Common::StringArray _virtualFiles;
Common::StringArray::const_iterator _iter;
public:
DirSeeker() {
_outbuffer = NULL_REG;
_iter = _files.begin();
}
reg_t firstFile(const Common::String &mask, reg_t buffer, SegManager *segMan);
reg_t nextFile(SegManager *segMan);
Common::String getVirtualFilename(uint fileNumber);
private:
void addAsVirtualFiles(Common::String title, Common::String fileMask);
};
#ifdef ENABLE_SCI32
/**
* An implementation of a virtual file that supports basic read and write
* operations simultaneously.
*
* This class has been initially implemented for Phantasmagoria, which has its
* own custom save/load code. The load code keeps checking for the existence
* of the save index file and keeps closing and reopening it for each save
* slot. This is notoriously slow and clumsy, and introduces noticeable delays,
* especially for non-desktop systems. Also, its game scripts request to open
* the index file for reading and writing with the same parameters
* (SaveManager::setCurrentSave and SaveManager::getCurrentSave). Moreover,
* the game scripts reopen the index file for writing in order to update it
* and seek within it. We do not support seeking in writeable streams, and the
* fact that our saved games are ZIP files makes this operation even more
* expensive. Finally, the savegame index file is supposed to be expanded when
* a new save slot is added.
* For the aforementioned reasons, this class has been implemented, which offers
* the basic functionality needed by the game scripts in Phantasmagoria.
*/
class VirtualIndexFile {
public:
VirtualIndexFile(Common::String fileName);
VirtualIndexFile(uint32 initialSize);
~VirtualIndexFile();
uint32 read(char *buffer, uint32 size);
uint32 readLine(char *buffer, uint32 size);
uint32 write(const char *buffer, uint32 size);
bool seek(int32 offset, int whence);
void close();
private:
char *_buffer;
uint32 _bufferSize;
char *_ptr;
Common::String _fileName;
bool _changed;
};
#endif
} // End of namespace Sci
#endif // SCI_ENGINE_FILE_H
|
