/
saveinfo.c
341 lines (290 loc) · 8.62 KB
/
saveinfo.c
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
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
/**
* @file saveinfo.c
* Save state info.
*
* @authors Copyright © 2003-2012 Jaakko Keränen <jaakko.keranen@iki.fi>
* @authors Copyright © 2005-2012 Daniel Swanson <danij@dengine.net>
*
* @par License
* GPL: http://www.gnu.org/licenses/gpl.html
*
* <small>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 St, Fifth Floor, Boston, MA
* 02110-1301 USA</small>
*/
#include <stdlib.h>
#include <string.h>
#include "common.h"
#include "p_tick.h"
#include "p_saveg.h"
#include "p_saveio.h"
#include "saveinfo.h"
SaveInfo* SaveInfo_NewWithFilePath(const ddstring_t* filePath)
{
SaveInfo* info = (SaveInfo*)malloc(sizeof *info);
if(!info) Con_Error("SaveInfo_New: Failed on allocation of %lu bytes for new SaveInfo.", (unsigned long) sizeof *info);
Str_Init(&info->filePath);
if(filePath) Str_Set(&info->filePath, Str_Text(filePath));
Str_Init(&info->name);
info->gameId = 0;
memset(&info->header, 0, sizeof(info->header));
return info;
}
SaveInfo* SaveInfo_New(void)
{
return SaveInfo_NewWithFilePath(0);
}
void SaveInfo_Delete(SaveInfo* info)
{
assert(info);
Str_Free(&info->filePath);
Str_Free(&info->name);
free(info);
}
const ddstring_t* SaveInfo_FilePath(SaveInfo* info)
{
assert(info);
return &info->filePath;
}
uint SaveInfo_GameId(SaveInfo* info)
{
assert(info);
return info->gameId;
}
const saveheader_t* SaveInfo_Header(SaveInfo* info)
{
assert(info);
//if(!SaveInfo_IsLoadable(info)) return NULL;
return &info->header;
}
const ddstring_t* SaveInfo_Name(SaveInfo* info)
{
assert(info);
return &info->name;
}
void SaveInfo_SetFilePath(SaveInfo* info, ddstring_t* newFilePath)
{
assert(info);
Str_CopyOrClear(&info->filePath, newFilePath);
}
void SaveInfo_SetGameId(SaveInfo* info, uint newGameId)
{
assert(info);
info->gameId = newGameId;
}
void SaveInfo_SetName(SaveInfo* info, const ddstring_t* newName)
{
assert(info);
Str_CopyOrClear(&info->name, newName);
}
void SaveInfo_Configure(SaveInfo* info)
{
saveheader_t* hdr;
assert(info);
hdr = &info->header;
hdr->magic = IS_NETWORK_CLIENT? MY_CLIENT_SAVE_MAGIC : MY_SAVE_MAGIC;
hdr->version = MY_SAVE_VERSION;
hdr->gameMode = gameMode;
hdr->map = gameMap+1;
#if __JHEXEN__
hdr->episode = 1;
#else
hdr->episode = gameEpisode+1;
#endif
#if __JHEXEN__
hdr->skill = gameSkill;
hdr->randomClasses = randomClassParm;
#else
hdr->skill = gameSkill;
if(fastParm) hdr->skill |= 0x80; // Set high byte.
#endif
hdr->deathmatch = deathmatch;
hdr->noMonsters = noMonstersParm;
#if __JHEXEN__
hdr->randomClasses = randomClassParm;
#else
hdr->respawnMonsters = respawnMonsters;
hdr->mapTime = mapTime;
{ int i;
for(i = 0; i < MAXPLAYERS; i++)
{
hdr->players[i] = players[i].plr->inGame;
}}
#endif
}
boolean SaveInfo_IsLoadable(SaveInfo* info)
{
assert(info);
if(Str_IsEmpty(&info->filePath) || !SV_ExistingFile(Str_Text(&info->filePath))) return false;
// Game Mode missmatch?
if(info->header.gameMode != gameMode) return false;
/// @todo Validate loaded add-ons and checksum the definition database.
return true; // It's good!
}
void SaveInfo_Update(SaveInfo* info)
{
assert(info);
if(Str_IsEmpty(&info->filePath))
{
// The save path cannot be accessed for some reason. Perhaps its a
// network path? Clear the info for this slot.
Str_Clear(&info->name);
return;
}
// Is this a recognisable save state?
if(!SV_RecogniseState(info)) return;
// Ensure we have a valid name.
if(Str_IsEmpty(&info->name))
{
Str_Set(&info->name, "UNNAMED");
}
}
void SaveInfo_Write(SaveInfo* saveInfo, Writer* writer)
{
saveheader_t* info;
assert(saveInfo);
info = &saveInfo->header;
Writer_WriteInt32(writer, info->magic);
Writer_WriteInt32(writer, info->version);
Writer_WriteInt32(writer, info->gameMode);
Str_Write(&saveInfo->name, writer);
Writer_WriteByte(writer, info->skill);
Writer_WriteByte(writer, info->episode);
Writer_WriteByte(writer, info->map);
Writer_WriteByte(writer, info->deathmatch);
Writer_WriteByte(writer, info->noMonsters);
#if __JHEXEN__
Writer_WriteByte(writer, info->randomClasses);
#else
Writer_WriteByte(writer, info->respawnMonsters);
Writer_WriteInt32(writer, info->mapTime);
{ int i;
for(i = 0; i < MAXPLAYERS; ++i)
{
Writer_WriteByte(writer, info->players[i]);
}}
#endif
Writer_WriteInt32(writer, saveInfo->gameId);
}
#if __JDOOM__ || __JHERETIC__
static void translateLegacyGameMode(gamemode_t* mode)
{
static const gamemode_t oldGameModes[] = {
# if __JDOOM__
doom_shareware,
doom,
doom2,
doom_ultimate
# else // __JHERETIC__
heretic_shareware,
heretic,
heretic_extended
# endif
};
if(!mode) return;
*mode = oldGameModes[(int)(*mode)];
# if __JDOOM__
/**
* @note Kludge: Older versions did not differentiate between versions
* of Doom2 (i.e., Plutonia and TNT are marked as Doom2). If we detect
* that this save is from some version of Doom2, replace the marked
* gamemode with the current gamemode.
*/
if((*mode) == doom2 && (gameModeBits & GM_ANY_DOOM2))
{
(*mode) = gameMode;
}
/// kludge end.
# endif
}
#endif
void SaveInfo_Read(SaveInfo* saveInfo, Reader* reader)
{
saveheader_t* info;
assert(saveInfo);
info = &saveInfo->header;
info->magic = Reader_ReadInt32(reader);
info->version = Reader_ReadInt32(reader);
info->gameMode = (gamemode_t)Reader_ReadInt32(reader);
if(info->version >= 10)
{
Str_Read(&saveInfo->name, reader);
}
else
{
// Older formats use a fixed-length name (24 characters).
#define OLD_NAME_LENGTH 24
char buf[OLD_NAME_LENGTH];
Reader_Read(reader, buf, OLD_NAME_LENGTH);
Str_Set(&saveInfo->name, buf);
#undef OLD_NAME_LENGTH
}
info->skill = Reader_ReadByte(reader);
info->episode = Reader_ReadByte(reader);
info->map = Reader_ReadByte(reader);
info->deathmatch = Reader_ReadByte(reader);
info->noMonsters = Reader_ReadByte(reader);
#if __JHEXEN__
info->randomClasses = Reader_ReadByte(reader);
#endif
#if !__JHEXEN__
info->respawnMonsters = Reader_ReadByte(reader);
// Older formats serialize the unpacked saveheader_t struct; skip the junk values (alignment).
if(info->version < 10) SV_Seek(2);
info->mapTime = Reader_ReadInt32(reader);
{ int i;
for(i = 0; i < MAXPLAYERS; ++i)
{
info->players[i] = Reader_ReadByte(reader);
}}
#endif
saveInfo->gameId = Reader_ReadInt32(reader);
// Translate gameMode identifiers from older save versions.
#if __JDOOM__ || __JHERETIC__
# if __JDOOM__
if(info->version < 9)
# else // __JHERETIC__
if(info->version < 8)
# endif
{
translateLegacyGameMode(&info->gameMode);
}
#endif
}
#if __JHEXEN__
void SaveInfo_Read_Hx_v9(SaveInfo* saveInfo, Reader* reader)
{
# define HXS_VERSION_TEXT "HXS Ver " // Do not change me!
# define HXS_VERSION_TEXT_LENGTH 16
# define HXS_NAME_LENGTH 24
char verText[HXS_VERSION_TEXT_LENGTH], nameBuffer[HXS_NAME_LENGTH];
saveheader_t* info;
assert(saveInfo);
info = &saveInfo->header;
Reader_Read(reader, nameBuffer, HXS_NAME_LENGTH);
Str_Set(&saveInfo->name, nameBuffer);
Reader_Read(reader, &verText, HXS_VERSION_TEXT_LENGTH);
info->version = atoi(&verText[8]);
SV_Seek(4); // Junk.
info->episode = 1;
info->map = Reader_ReadByte(reader);
info->skill = Reader_ReadByte(reader);
info->deathmatch = Reader_ReadByte(reader);
info->noMonsters = Reader_ReadByte(reader);
info->randomClasses = Reader_ReadByte(reader);
info->magic = MY_SAVE_MAGIC; // Lets pretend...
/// @note Older formats do not contain all needed values:
info->gameMode = gameMode; // Assume the current mode.
saveInfo->gameId = 0; // None.
# undef HXS_NAME_LENGTH
# undef HXS_VERSION_TEXT_LENGTH
# undef HXS_VERSION_TEXT
}
#endif