d31d8c81d2d50da8609c506ce08ab708652cc666
[rocksndiamonds.git] / src / game_mm / mm_files.c
1 // ============================================================================
2 // Mirror Magic -- McDuffin's Revenge
3 // ----------------------------------------------------------------------------
4 // (c) 1994-2017 by Artsoft Entertainment
5 //                  Holger Schemel
6 //                  info@artsoft.org
7 //                  http://www.artsoft.org/
8 // ----------------------------------------------------------------------------
9 // mm_files.c
10 // ============================================================================
11
12 #include <sys/types.h>
13 #include <sys/stat.h>
14 #include <ctype.h>
15 #include <dirent.h>
16
17 #include "main_mm.h"
18
19 #include "mm_main.h"
20
21 #define CHUNK_ID_LEN            4       /* IFF style chunk id length */
22 #define CHUNK_SIZE_UNDEFINED    0       /* undefined chunk size == 0  */
23 #define CHUNK_SIZE_NONE         -1      /* do not write chunk size    */
24 #define FILE_VERS_CHUNK_SIZE    8       /* size of file version chunk */
25 #define LEVEL_HEADER_SIZE       80      /* size of level file header */
26 #define LEVEL_HEADER_UNUSED     19      /* unused level header bytes */
27
28 /* file identifier strings */
29 #define LEVEL_COOKIE_TMPL       "MIRRORMAGIC_LEVEL_FILE_VERSION_x.x"
30 #define SCORE_COOKIE            "MIRRORMAGIC_SCORE_FILE_VERSION_1.4"
31
32
33 /* ========================================================================= */
34 /* level file functions                                                      */
35 /* ========================================================================= */
36
37 static void ReadChunk_MM_VERS(File *file, int *file_version, int *game_version)
38 {
39   int file_version_major, file_version_minor, file_version_patch;
40   int game_version_major, game_version_minor, game_version_patch;
41
42   file_version_major = getFile8Bit(file);
43   file_version_minor = getFile8Bit(file);
44   file_version_patch = getFile8Bit(file);
45   getFile8Bit(file);            /* not used */
46
47   game_version_major = getFile8Bit(file);
48   game_version_minor = getFile8Bit(file);
49   game_version_patch = getFile8Bit(file);
50   getFile8Bit(file);            /* not used */
51
52   *file_version = MM_VERSION_IDENT(file_version_major,
53                                    file_version_minor,
54                                    file_version_patch);
55
56   *game_version = MM_VERSION_IDENT(game_version_major,
57                                    game_version_minor,
58                                    game_version_patch);
59 }
60
61 static void WriteChunk_MM_VERS(FILE *file, int file_version, int game_version)
62 {
63   int file_version_major = MM_VERSION_MAJOR(file_version);
64   int file_version_minor = MM_VERSION_MINOR(file_version);
65   int file_version_patch = MM_VERSION_PATCH(file_version);
66   int game_version_major = MM_VERSION_MAJOR(game_version);
67   int game_version_minor = MM_VERSION_MINOR(game_version);
68   int game_version_patch = MM_VERSION_PATCH(game_version);
69
70   fputc(file_version_major, file);
71   fputc(file_version_minor, file);
72   fputc(file_version_patch, file);
73   fputc(0, file);       /* not used */
74
75   fputc(game_version_major, file);
76   fputc(game_version_minor, file);
77   fputc(game_version_patch, file);
78   fputc(0, file);       /* not used */
79 }
80
81 void setLevelInfoToDefaults_MM()
82 {
83   int i, x, y;
84
85   native_mm_level.file_version = MM_FILE_VERSION_ACTUAL;
86   native_mm_level.game_version = MM_GAME_VERSION_ACTUAL;
87
88   native_mm_level.encoding_16bit_field = FALSE; /* default: only 8-bit elements */
89
90   lev_fieldx = native_mm_level.fieldx = STD_LEV_FIELDX;
91   lev_fieldy = native_mm_level.fieldy = STD_LEV_FIELDY;
92
93   for(x=0; x<MAX_LEV_FIELDX; x++)
94     for(y=0; y<MAX_LEV_FIELDY; y++)
95       native_mm_level.field[x][y] = Feld[x][y] = Ur[x][y] = EL_EMPTY;
96
97   native_mm_level.time = 100;
98   native_mm_level.kettles_needed = 0;
99   native_mm_level.auto_count_kettles = TRUE;
100   native_mm_level.amoeba_speed = 0;
101   native_mm_level.time_fuse = 0;
102   native_mm_level.laser_red = FALSE;
103   native_mm_level.laser_green = FALSE;
104   native_mm_level.laser_blue = TRUE;
105
106   for(i=0; i<MAX_LEVEL_NAME_LEN; i++)
107     native_mm_level.name[i] = '\0';
108   for(i=0; i<MAX_LEVEL_AUTHOR_LEN; i++)
109     native_mm_level.author[i] = '\0';
110
111   strcpy(native_mm_level.name, NAMELESS_LEVEL_NAME);
112   strcpy(native_mm_level.author, ANONYMOUS_NAME);
113
114   for(i=0; i<LEVEL_SCORE_ELEMENTS; i++)
115     native_mm_level.score[i] = 10;
116
117   native_mm_level.field[0][0] = Feld[0][0] = Ur[0][0] = EL_MCDUFFIN_RIGHT;
118   native_mm_level.field[STD_LEV_FIELDX-1][STD_LEV_FIELDY-1] =
119     Feld[STD_LEV_FIELDX-1][STD_LEV_FIELDY-1] =
120     Ur[STD_LEV_FIELDX-1][STD_LEV_FIELDY-1] = EL_EXIT_CLOSED;
121 }
122
123 static int checkLevelElement(int element)
124 {
125   if (element >= EL_FIRST_RUNTIME_EL)
126   {
127     Error(ERR_WARN, "invalid level element %d", element);
128     element = EL_CHAR_FRAGE;
129   }
130
131   return element;
132 }
133
134 static int LoadLevel_MM_VERS(File *file, int chunk_size, struct LevelInfo_MM *level)
135 {
136   ReadChunk_MM_VERS(file, &(level->file_version), &(level->game_version));
137
138   return chunk_size;
139 }
140
141 static int LoadLevel_MM_HEAD(File *file, int chunk_size, struct LevelInfo_MM *level)
142 {
143   int i;
144   int laser_color;
145
146   lev_fieldx = level->fieldx = getFile8Bit(file);
147   lev_fieldy = level->fieldy = getFile8Bit(file);
148
149   level->time           = getFile16BitInteger(file, BYTE_ORDER_BIG_ENDIAN);
150   level->kettles_needed = getFile16BitInteger(file, BYTE_ORDER_BIG_ENDIAN);
151
152   for(i=0; i<MAX_LEVEL_NAME_LEN; i++)
153     level->name[i] = getFile8Bit(file);
154   level->name[MAX_LEVEL_NAME_LEN] = 0;
155
156   for(i=0; i<LEVEL_SCORE_ELEMENTS; i++)
157     level->score[i] = getFile8Bit(file);
158
159   level->auto_count_kettles     = (getFile8Bit(file) == 1 ? TRUE : FALSE);
160   level->amoeba_speed           = getFile8Bit(file);
161   level->time_fuse              = getFile8Bit(file);
162
163   laser_color                   = getFile8Bit(file);
164   level->laser_red              = (laser_color >> 2) & 0x01;
165   level->laser_green            = (laser_color >> 1) & 0x01;
166   level->laser_blue             = (laser_color >> 0) & 0x01;
167
168   level->encoding_16bit_field   = (getFile8Bit(file) == 1 ? TRUE : FALSE);
169
170   ReadUnusedBytesFromFile(file, LEVEL_HEADER_UNUSED);
171
172   return chunk_size;
173 }
174
175 static int LoadLevel_MM_AUTH(File *file, int chunk_size, struct LevelInfo_MM *level)
176 {
177   int i;
178
179   for(i=0; i<MAX_LEVEL_AUTHOR_LEN; i++)
180     level->author[i] = getFile8Bit(file);
181   level->author[MAX_LEVEL_NAME_LEN] = 0;
182
183   return chunk_size;
184 }
185
186 static int LoadLevel_MM_BODY(File *file, int chunk_size, struct LevelInfo_MM *level)
187 {
188   int x, y;
189   int chunk_size_expected = level->fieldx * level->fieldy;
190
191   /* Note: "chunk_size" was wrong before version 2.0 when elements are
192      stored with 16-bit encoding (and should be twice as big then).
193      Even worse, playfield data was stored 16-bit when only yamyam content
194      contained 16-bit elements and vice versa. */
195
196   if (level->encoding_16bit_field && level->file_version >= MM_FILE_VERSION_2_0)
197     chunk_size_expected *= 2;
198
199   if (chunk_size_expected != chunk_size)
200   {
201     ReadUnusedBytesFromFile(file, chunk_size);
202     return chunk_size_expected;
203   }
204
205   for(y=0; y<level->fieldy; y++)
206     for(x=0; x<level->fieldx; x++)
207       native_mm_level.field[x][y] = Feld[x][y] = Ur[x][y] =
208         checkLevelElement(level->encoding_16bit_field ?
209                           getFile16BitInteger(file, BYTE_ORDER_BIG_ENDIAN) :
210                           getFile8Bit(file));
211   return chunk_size;
212 }
213
214 boolean LoadNativeLevel_MM(char *filename, boolean level_info_only)
215 {
216   char cookie[MAX_LINE_LEN];
217   char chunk_name[CHUNK_ID_LEN + 1];
218   int chunk_size;
219   File *file;
220
221   static struct
222   {
223     char *name;
224     int size;
225     int (*loader)(File *, int, struct LevelInfo_MM *);
226   }
227   chunk_info[] =
228   {
229     { "VERS", FILE_VERS_CHUNK_SIZE,     LoadLevel_MM_VERS },
230     { "HEAD", LEVEL_HEADER_SIZE,        LoadLevel_MM_HEAD },
231     { "AUTH", MAX_LEVEL_AUTHOR_LEN,     LoadLevel_MM_AUTH },
232     { "BODY", -1,                       LoadLevel_MM_BODY },
233     {  NULL,  0,                        NULL }
234   };
235
236   /* always start with reliable default values */
237   setLevelInfoToDefaults_MM();
238
239   if (!(file = openFile(filename, MODE_READ)))
240   {
241     if (!level_info_only)
242       Error(ERR_WARN, "cannot read level '%s' - creating new level", filename);
243
244     return FALSE;
245   }
246
247   getFileChunk(file, chunk_name, NULL, BYTE_ORDER_BIG_ENDIAN);
248   if (strcmp(chunk_name, "MMII") == 0)
249   {
250     getFile32BitInteger(file, BYTE_ORDER_BIG_ENDIAN);   /* not used */
251
252     getFileChunk(file, chunk_name, NULL, BYTE_ORDER_BIG_ENDIAN);
253     if (strcmp(chunk_name, "CAVE") != 0)
254     {
255       Error(ERR_WARN, "unknown format of level file '%s'", filename);
256       closeFile(file);
257
258       return FALSE;
259     }
260   }
261   else  /* check for pre-2.0 file format with cookie string */
262   {
263     strcpy(cookie, chunk_name);
264     getStringFromFile(file, &cookie[4], MAX_LINE_LEN - 4);
265     if (strlen(cookie) > 0 && cookie[strlen(cookie) - 1] == '\n')
266       cookie[strlen(cookie) - 1] = '\0';
267
268     if (!checkCookieString(cookie, LEVEL_COOKIE_TMPL))
269     {
270       Error(ERR_WARN, "unknown format of level file '%s'", filename);
271       closeFile(file);
272
273       return FALSE;
274     }
275
276     if ((native_mm_level.file_version = getFileVersionFromCookieString(cookie)) == -1)
277     {
278       Error(ERR_WARN, "unsupported version of level file '%s'", filename);
279       closeFile(file);
280
281       return FALSE;
282     }
283   }
284
285   while (getFileChunk(file, chunk_name, &chunk_size, BYTE_ORDER_BIG_ENDIAN))
286   {
287     int i = 0;
288
289     while (chunk_info[i].name != NULL &&
290            strcmp(chunk_name, chunk_info[i].name) != 0)
291       i++;
292
293     if (chunk_info[i].name == NULL)
294     {
295       Error(ERR_WARN, "unknown chunk '%s' in level file '%s'",
296             chunk_name, filename);
297       ReadUnusedBytesFromFile(file, chunk_size);
298     }
299     else if (chunk_info[i].size != -1 &&
300              chunk_info[i].size != chunk_size)
301     {
302       Error(ERR_WARN, "wrong size (%d) of chunk '%s' in level file '%s'",
303             chunk_size, chunk_name, filename);
304       ReadUnusedBytesFromFile(file, chunk_size);
305     }
306     else
307     {
308       /* call function to load this level chunk */
309       int chunk_size_expected =
310         (chunk_info[i].loader)(file, chunk_size, &native_mm_level);
311
312       /* the size of some chunks cannot be checked before reading other
313          chunks first (like "HEAD" and "BODY") that contain some header
314          information, so check them here */
315       if (chunk_size_expected != chunk_size)
316       {
317         Error(ERR_WARN, "wrong size (%d) of chunk '%s' in level file '%s'",
318               chunk_size, chunk_name, filename);
319       }
320     }
321   }
322
323   closeFile(file);
324
325   return TRUE;
326 }
327
328 static void SaveLevel_MM_HEAD(FILE *file, struct LevelInfo_MM *level)
329 {
330   int i;
331   int laser_color;
332
333   fputc(level->fieldx, file);
334   fputc(level->fieldy, file);
335
336   putFile16BitInteger(file, level->time,           BYTE_ORDER_BIG_ENDIAN);
337   putFile16BitInteger(file, level->kettles_needed, BYTE_ORDER_BIG_ENDIAN);
338
339   for(i=0; i<MAX_LEVEL_NAME_LEN; i++)
340     fputc(level->name[i], file);
341
342   for(i=0; i<LEVEL_SCORE_ELEMENTS; i++)
343     fputc(level->score[i], file);
344
345   fputc((level->auto_count_kettles ? 1 : 0), file);
346   fputc(level->amoeba_speed, file);
347   fputc(level->time_fuse, file);
348
349   laser_color = ((level->laser_red   << 2) |
350                  (level->laser_green << 1) |
351                  (level->laser_blue  << 0));
352   fputc(laser_color, file);
353
354   fputc((level->encoding_16bit_field ? 1 : 0), file);
355
356   WriteUnusedBytesToFile(file, LEVEL_HEADER_UNUSED);
357 }
358
359 static void SaveLevel_MM_AUTH(FILE *file, struct LevelInfo_MM *level)
360 {
361   int i;
362
363   for(i=0; i<MAX_LEVEL_AUTHOR_LEN; i++)
364     fputc(level->author[i], file);
365 }
366
367 static void SaveLevel_MM_BODY(FILE *file, struct LevelInfo_MM *level)
368 {
369   int x, y;
370
371   for(y=0; y<level->fieldy; y++)
372     for(x=0; x<level->fieldx; x++)
373       if (level->encoding_16bit_field)
374         putFile16BitInteger(file, Ur[x][y], BYTE_ORDER_BIG_ENDIAN);
375       else
376         fputc(Ur[x][y], file);
377 }
378
379 void SaveNativeLevel_MM(char *filename)
380 {
381   int x, y;
382   int body_chunk_size;
383   FILE *file;
384
385   if (!(file = fopen(filename, MODE_WRITE)))
386   {
387     Error(ERR_WARN, "cannot save level file '%s'", filename);
388     return;
389   }
390
391   /* check level field for 16-bit elements */
392   native_mm_level.encoding_16bit_field = FALSE;
393   for(y=0; y<native_mm_level.fieldy; y++)
394     for(x=0; x<native_mm_level.fieldx; x++)
395       if (Ur[x][y] > 255)
396         native_mm_level.encoding_16bit_field = TRUE;
397
398   body_chunk_size =
399     native_mm_level.fieldx * native_mm_level.fieldy * (native_mm_level.encoding_16bit_field ? 2 : 1);
400
401   putFileChunk(file, "MMII", CHUNK_SIZE_UNDEFINED, BYTE_ORDER_BIG_ENDIAN);
402   putFileChunk(file, "CAVE", CHUNK_SIZE_NONE,      BYTE_ORDER_BIG_ENDIAN);
403
404   putFileChunk(file, "VERS", FILE_VERS_CHUNK_SIZE, BYTE_ORDER_BIG_ENDIAN);
405   WriteChunk_MM_VERS(file, MM_FILE_VERSION_ACTUAL, MM_GAME_VERSION_ACTUAL);
406
407   putFileChunk(file, "HEAD", LEVEL_HEADER_SIZE, BYTE_ORDER_BIG_ENDIAN);
408   SaveLevel_MM_HEAD(file, &native_mm_level);
409
410   putFileChunk(file, "AUTH", MAX_LEVEL_AUTHOR_LEN, BYTE_ORDER_BIG_ENDIAN);
411   SaveLevel_MM_AUTH(file, &native_mm_level);
412
413   putFileChunk(file, "BODY", body_chunk_size, BYTE_ORDER_BIG_ENDIAN);
414   SaveLevel_MM_BODY(file, &native_mm_level);
415
416   fclose(file);
417
418   SetFilePermissions(filename, PERMS_PRIVATE);
419 }