rnd-19990126-3
[rocksndiamonds.git] / src / files.c
1 /***********************************************************
2 *  Rocks'n'Diamonds -- McDuffin Strikes Back!              *
3 *----------------------------------------------------------*
4 *  (c) 1995-98 Artsoft Entertainment                       *
5 *              Holger Schemel                              *
6 *              Oststrasse 11a                              *
7 *              33604 Bielefeld                             *
8 *              phone: ++49 +521 290471                     *
9 *              email: aeglos@valinor.owl.de                *
10 *----------------------------------------------------------*
11 *  files.h                                                 *
12 ***********************************************************/
13
14 #include <ctype.h>
15 #include <dirent.h>
16 #include <sys/stat.h>
17 #include <unistd.h>
18
19 #include "files.h"
20 #include "tools.h"
21 #include "misc.h"
22 #include "tape.h"
23 #include "joystick.h"
24
25 #define MAX_FILENAME_LEN        256     /* maximal filename length */
26 #define MAX_LINE_LEN            1000    /* maximal input line length */
27 #define CHUNK_ID_LEN            4       /* IFF style chunk id length */
28 #define LEVEL_HEADER_SIZE       80      /* size of level file header */
29 #define LEVEL_HEADER_UNUSED     18      /* unused level header bytes */
30 #define TAPE_HEADER_SIZE        20      /* size of tape file header */
31 #define TAPE_HEADER_UNUSED      7       /* unused tape header bytes */
32 #define FILE_VERSION_1_0        10      /* old 1.0 file version */
33 #define FILE_VERSION_1_2        12      /* actual file version */
34
35 /* file identifier strings */
36 #define LEVEL_COOKIE            "ROCKSNDIAMONDS_LEVEL_FILE_VERSION_1.2"
37 #define SCORE_COOKIE            "ROCKSNDIAMONDS_SCORE_FILE_VERSION_1.2"
38 #define TAPE_COOKIE             "ROCKSNDIAMONDS_TAPE_FILE_VERSION_1.2"
39 #define SETUP_COOKIE            "ROCKSNDIAMONDS_SETUP_FILE_VERSION_1.2"
40 #define LEVELSETUP_COOKIE       "ROCKSNDIAMONDS_LEVELSETUP_FILE_VERSION_1.2"
41 #define LEVELINFO_COOKIE        "ROCKSNDIAMONDS_LEVELINFO_FILE_VERSION_1.2"
42 /* old file identifiers for backward compatibility */
43 #define LEVEL_COOKIE_10         "ROCKSNDIAMONDS_LEVEL_FILE_VERSION_1.0"
44 #define TAPE_COOKIE_10          "ROCKSNDIAMONDS_LEVELREC_FILE_VERSION_1.0"
45
46 /* file names and filename extensions */
47 #ifndef MSDOS
48 #define USERDATA_DIRECTORY      ".rocksndiamonds"
49 #define SETUP_FILENAME          "setup.conf"
50 #define LEVELSETUP_FILENAME     "levelsetup.conf"
51 #define LEVELINFO_FILENAME      "levelinfo.conf"
52 #define LEVELFILE_EXTENSION     "level"
53 #define TAPEFILE_EXTENSION      "tape"
54 #define SCOREFILE_EXTENSION     "score"
55 #else
56 #define USERDATA_DIRECTORY      "userdata"
57 #define SETUP_FILENAME          "setup.cnf"
58 #define LEVELSETUP_FILENAME     "lvlsetup.cnf"
59 #define LEVELINFO_FILENAME      "lvlinfo.cnf"
60 #define LEVELFILE_EXTENSION     "lvl"
61 #define TAPEFILE_EXTENSION      "tap"
62 #define SCOREFILE_EXTENSION     "sco"
63 #define ERROR_FILENAME          "error.out"
64 #endif
65
66 /* file permissions for newly written files */
67 #define MODE_R_ALL              (S_IRUSR | S_IRGRP | S_IROTH)
68 #define MODE_W_ALL              (S_IWUSR | S_IWGRP | S_IWOTH)
69 #define MODE_X_ALL              (S_IXUSR | S_IXGRP | S_IXOTH)
70 #define USERDATA_DIR_MODE       (MODE_R_ALL | MODE_X_ALL | S_IWUSR)
71 #define LEVEL_PERMS             (MODE_R_ALL | MODE_W_ALL)
72 #define SCORE_PERMS             LEVEL_PERMS
73 #define TAPE_PERMS              LEVEL_PERMS
74 #define SETUP_PERMS             LEVEL_PERMS
75
76 /* sort priorities of level series (also used as level series classes) */
77 #define LEVELCLASS_TUTORIAL_START       10
78 #define LEVELCLASS_TUTORIAL_END         99
79 #define LEVELCLASS_CLASSICS_START       100
80 #define LEVELCLASS_CLASSICS_END         199
81 #define LEVELCLASS_CONTRIBUTION_START   200
82 #define LEVELCLASS_CONTRIBUTION_END     299
83 #define LEVELCLASS_USER_START           300
84 #define LEVELCLASS_USER_END             399
85
86 #define LEVELCLASS_TUTORIAL             LEVELCLASS_TUTORIAL_START
87 #define LEVELCLASS_CLASSICS             LEVELCLASS_CLASSICS_START
88 #define LEVELCLASS_CONTRIBUTION         LEVELCLASS_CONTRIBUTION_START
89 #define LEVELCLASS_USER                 LEVELCLASS_USER_START
90 #define LEVELCLASS_UNDEFINED            999
91
92 #define IS_LEVELCLASS_TUTORIAL(n) \
93         (leveldir[n].sort_priority >= LEVELCLASS_TUTORIAL_START && \
94          leveldir[n].sort_priority <= LEVELCLASS_TUTORIAL_END)
95 #define IS_LEVELCLASS_CLASSICS(n) \
96         (leveldir[n].sort_priority >= LEVELCLASS_CLASSICS_START && \
97          leveldir[n].sort_priority <= LEVELCLASS_CLASSICS_END)
98 #define IS_LEVELCLASS_CONTRIBUTION(n) \
99         (leveldir[n].sort_priority >= LEVELCLASS_CONTRIBUTION_START && \
100          leveldir[n].sort_priority <= LEVELCLASS_CONTRIBUTION_END)
101 #define IS_LEVELCLASS_USER(n) \
102         (leveldir[n].sort_priority >= LEVELCLASS_USER_START && \
103          leveldir[n].sort_priority <= LEVELCLASS_USER_END)
104
105 #define LEVELCLASS(n)   (IS_LEVELCLASS_TUTORIAL(n) ? LEVELCLASS_TUTORIAL : \
106                          IS_LEVELCLASS_CLASSICS(n) ? LEVELCLASS_CLASSICS : \
107                          IS_LEVELCLASS_CONTRIBUTION(n) ? LEVELCLASS_CONTRIBUTION : \
108                          IS_LEVELCLASS_USER(n) ? LEVELCLASS_USER : \
109                          LEVELCLASS_UNDEFINED)
110
111 static void SaveUserLevelInfo();                /* for 'InitUserLevelDir()' */
112 static char *getSetupLine(char *, int);         /* for 'SaveUserLevelInfo()' */
113
114 static char *getGlobalDataDir()
115 {
116   return GAME_DIR;
117 }
118
119 char *getUserDataDir()
120 {
121   static char *userdata_dir = NULL;
122
123   if (!userdata_dir)
124   {
125     char *home_dir = getHomeDir();
126     char *data_dir = USERDATA_DIRECTORY;
127
128     userdata_dir = getPath2(home_dir, data_dir);
129   }
130
131   return userdata_dir;
132 }
133
134 static char *getSetupDir()
135 {
136   return getUserDataDir();
137 }
138
139 static char *getUserLevelDir(char *level_subdir)
140 {
141   static char *userlevel_dir = NULL;
142   char *data_dir = getUserDataDir();
143   char *userlevel_subdir = LEVELS_DIRECTORY;
144
145   if (userlevel_dir)
146     free(userlevel_dir);
147
148   if (strlen(level_subdir) > 0)
149     userlevel_dir = getPath3(data_dir, userlevel_subdir, level_subdir);
150   else
151     userlevel_dir = getPath2(data_dir, userlevel_subdir);
152
153   return userlevel_dir;
154 }
155
156 static char *getTapeDir(char *level_subdir)
157 {
158   static char *tape_dir = NULL;
159   char *data_dir = getUserDataDir();
160   char *tape_subdir = TAPES_DIRECTORY;
161
162   if (tape_dir)
163     free(tape_dir);
164
165   if (strlen(level_subdir) > 0)
166     tape_dir = getPath3(data_dir, tape_subdir, level_subdir);
167   else
168     tape_dir = getPath2(data_dir, tape_subdir);
169
170   return tape_dir;
171 }
172
173 static char *getScoreDir(char *level_subdir)
174 {
175   static char *score_dir = NULL;
176   char *data_dir = getGlobalDataDir();
177   char *score_subdir = SCORES_DIRECTORY;
178
179   if (score_dir)
180     free(score_dir);
181
182   if (strlen(level_subdir) > 0)
183     score_dir = getPath3(data_dir, score_subdir, level_subdir);
184   else
185     score_dir = getPath2(data_dir, score_subdir);
186
187   return score_dir;
188 }
189
190 static char *getLevelFilename(int nr)
191 {
192   static char *filename = NULL;
193   char basename[MAX_FILENAME_LEN];
194
195   if (filename != NULL)
196     free(filename);
197
198   sprintf(basename, "%03d.%s", nr, LEVELFILE_EXTENSION);
199   filename = getPath3((leveldir[leveldir_nr].user_defined ?
200                        getUserLevelDir("") :
201                        options.level_directory),
202                       leveldir[leveldir_nr].filename,
203                       basename);
204
205   return filename;
206 }
207
208 static char *getTapeFilename(int nr)
209 {
210   static char *filename = NULL;
211   char basename[MAX_FILENAME_LEN];
212
213   if (filename != NULL)
214     free(filename);
215
216   sprintf(basename, "%03d.%s", nr, TAPEFILE_EXTENSION);
217   filename = getPath2(getTapeDir(leveldir[leveldir_nr].filename), basename);
218
219   return filename;
220 }
221
222 static char *getScoreFilename(int nr)
223 {
224   static char *filename = NULL;
225   char basename[MAX_FILENAME_LEN];
226
227   if (filename != NULL)
228     free(filename);
229
230   sprintf(basename, "%03d.%s", nr, SCOREFILE_EXTENSION);
231   filename = getPath2(getScoreDir(leveldir[leveldir_nr].filename), basename);
232
233   return filename;
234 }
235
236 static void createDirectory(char *dir, char *text)
237 {
238   if (access(dir, F_OK) != 0)
239     if (mkdir(dir, USERDATA_DIR_MODE) != 0)
240       Error(ERR_WARN, "cannot create %s directory '%s'", text, dir);
241 }
242
243 static void InitUserDataDirectory()
244 {
245   createDirectory(getUserDataDir(), "user data");
246 }
247
248 static void InitTapeDirectory(char *level_subdir)
249 {
250   createDirectory(getUserDataDir(), "user data");
251   createDirectory(getTapeDir(""), "main tape");
252   createDirectory(getTapeDir(level_subdir), "level tape");
253 }
254
255 static void InitScoreDirectory(char *level_subdir)
256 {
257   createDirectory(getScoreDir(""), "main score");
258   createDirectory(getScoreDir(level_subdir), "level score");
259 }
260
261 static void InitUserLevelDirectory(char *level_subdir)
262 {
263   if (access(getUserLevelDir(level_subdir), F_OK) != 0)
264   {
265     createDirectory(getUserDataDir(), "user data");
266     createDirectory(getUserLevelDir(""), "main user level");
267     createDirectory(getUserLevelDir(level_subdir), "user level");
268
269     SaveUserLevelInfo();
270   }
271 }
272
273 static void getFileChunk(FILE *file, char *chunk_buffer, int *chunk_length)
274 {
275   fgets(chunk_buffer, CHUNK_ID_LEN + 1, file);
276
277   *chunk_length =
278     (fgetc(file) << 24) |
279     (fgetc(file) << 16) |
280     (fgetc(file) <<  8)  |
281     (fgetc(file) <<  0);
282 }
283
284 static void putFileChunk(FILE *file, char *chunk_name, int chunk_length)
285 {
286   fputs(chunk_name, file);
287
288   fputc((chunk_length >> 24) & 0xff, file);
289   fputc((chunk_length >> 16) & 0xff, file);
290   fputc((chunk_length >>  8) & 0xff, file);
291   fputc((chunk_length >>  0) & 0xff, file);
292 }
293
294 static void setLevelInfoToDefaults()
295 {
296   int i, x, y;
297
298   lev_fieldx = level.fieldx = STD_LEV_FIELDX;
299   lev_fieldy = level.fieldy = STD_LEV_FIELDY;
300
301   for(x=0; x<MAX_LEV_FIELDX; x++)
302     for(y=0; y<MAX_LEV_FIELDY; y++)
303       Feld[x][y] = Ur[x][y] = EL_ERDREICH;
304
305   level.time = 100;
306   level.edelsteine = 0;
307   level.tempo_amoebe = 10;
308   level.dauer_sieb = 10;
309   level.dauer_ablenk = 10;
310   level.amoebe_inhalt = EL_DIAMANT;
311
312   level.high_speed = FALSE;
313
314   for(i=0; i<MAX_LEVEL_NAME_LEN; i++)
315     level.name[i] = '\0';
316   for(i=0; i<MAX_LEVEL_AUTHOR_LEN; i++)
317     level.author[i] = '\0';
318
319   strcpy(level.name, NAMELESS_LEVEL_NAME);
320   strcpy(level.author, ANONYMOUS_NAME);
321
322   for(i=0; i<LEVEL_SCORE_ELEMENTS; i++)
323     level.score[i] = 10;
324
325   MampferMax = 4;
326   for(i=0; i<8; i++)
327     for(x=0; x<3; x++)
328       for(y=0; y<3; y++)
329         level.mampfer_inhalt[i][x][y] = EL_FELSBROCKEN;
330
331   Feld[0][0] = Ur[0][0] = EL_SPIELFIGUR;
332   Feld[STD_LEV_FIELDX-1][STD_LEV_FIELDY-1] =
333     Ur[STD_LEV_FIELDX-1][STD_LEV_FIELDY-1] = EL_AUSGANG_ZU;
334
335   BorderElement = EL_BETON;
336
337   /* try to determine better author name than 'anonymous' */
338   if (strcmp(leveldir[leveldir_nr].author, ANONYMOUS_NAME) != 0)
339   {
340     strncpy(level.author, leveldir[leveldir_nr].author, MAX_LEVEL_AUTHOR_LEN);
341     level.author[MAX_LEVEL_AUTHOR_LEN] = '\0';
342   }
343   else
344   {
345     switch (LEVELCLASS(leveldir_nr))
346     {
347       case LEVELCLASS_TUTORIAL:
348         strcpy(level.author, PROGRAM_AUTHOR_STRING);
349         break;
350
351       case LEVELCLASS_CONTRIBUTION:
352         strncpy(level.author, leveldir[leveldir_nr].name,MAX_LEVEL_AUTHOR_LEN);
353         level.author[MAX_LEVEL_AUTHOR_LEN] = '\0';
354         break;
355
356       case LEVELCLASS_USER:
357         strncpy(level.author, getRealName(), MAX_LEVEL_AUTHOR_LEN);
358         level.author[MAX_LEVEL_AUTHOR_LEN] = '\0';
359         break;
360
361       default:
362         /* keep default value */
363         break;
364     }
365   }
366 }
367
368 void LoadLevel(int level_nr)
369 {
370   int i, x, y;
371   char *filename = getLevelFilename(level_nr);
372   char cookie[MAX_LINE_LEN];
373   char chunk[CHUNK_ID_LEN + 1];
374   int file_version = FILE_VERSION_1_2;  /* last version of level files */
375   int chunk_length;
376   FILE *file;
377
378   /* always start with reliable default values */
379   setLevelInfoToDefaults();
380
381   if (!(file = fopen(filename, "r")))
382   {
383     Error(ERR_WARN, "cannot read level '%s' - creating new level", filename);
384     return;
385   }
386
387   /* check file identifier */
388   fgets(cookie, MAX_LINE_LEN, file);
389   if (strlen(cookie) > 0 && cookie[strlen(cookie) - 1] == '\n')
390     cookie[strlen(cookie) - 1] = '\0';
391
392   if (strcmp(cookie, LEVEL_COOKIE_10) == 0)     /* old 1.0 level format */
393     file_version = FILE_VERSION_1_0;
394   else if (strcmp(cookie, LEVEL_COOKIE) != 0)   /* unknown level format */
395   {
396     Error(ERR_WARN, "wrong file identifier of level file '%s'", filename);
397     fclose(file);
398     return;
399   }
400
401   /* read chunk "HEAD" */
402   if (file_version >= FILE_VERSION_1_2)
403   {
404     getFileChunk(file, chunk, &chunk_length);
405     if (strcmp(chunk, "HEAD") || chunk_length != LEVEL_HEADER_SIZE)
406     {
407       Error(ERR_WARN, "wrong 'HEAD' chunk of level file '%s'", filename);
408       fclose(file);
409       return;
410     }
411   }
412
413   lev_fieldx = level.fieldx = fgetc(file);
414   lev_fieldy = level.fieldy = fgetc(file);
415
416   level.time            = (fgetc(file)<<8) | fgetc(file);
417   level.edelsteine      = (fgetc(file)<<8) | fgetc(file);
418
419   for(i=0; i<MAX_LEVEL_NAME_LEN; i++)
420     level.name[i]       = fgetc(file);
421   level.name[MAX_LEVEL_NAME_LEN] = 0;
422
423   for(i=0; i<LEVEL_SCORE_ELEMENTS; i++)
424     level.score[i]      = fgetc(file);
425
426   MampferMax = 4;
427   for(i=0; i<8; i++)
428   {
429     for(y=0; y<3; y++)
430     {
431       for(x=0; x<3; x++)
432       {
433         if (i < 4)
434           level.mampfer_inhalt[i][x][y] = fgetc(file);
435         else
436           level.mampfer_inhalt[i][x][y] = EL_LEERRAUM;
437       }
438     }
439   }
440
441   level.tempo_amoebe    = fgetc(file);
442   level.dauer_sieb      = fgetc(file);
443   level.dauer_ablenk    = fgetc(file);
444   level.amoebe_inhalt = fgetc(file);
445
446   for(i=0; i<LEVEL_HEADER_UNUSED; i++)  /* skip unused header bytes */
447     fgetc(file);
448
449   /* read chunk "BODY" */
450   if (file_version >= FILE_VERSION_1_2)
451   {
452     getFileChunk(file, chunk, &chunk_length);
453
454     /* look for optional author chunk */
455     if (strcmp(chunk, "AUTH") == 0 && chunk_length == MAX_LEVEL_AUTHOR_LEN)
456     {
457       for(i=0; i<MAX_LEVEL_AUTHOR_LEN; i++)
458         level.author[i] = fgetc(file);
459       level.author[MAX_LEVEL_NAME_LEN] = 0;
460
461       getFileChunk(file, chunk, &chunk_length);
462     }
463
464     /* look for optional content chunk */
465     if (strcmp(chunk, "CONT") == 0 && chunk_length == 4 + 8 * 3 * 3)
466     {
467       fgetc(file);
468       MampferMax = fgetc(file);
469       fgetc(file);
470       fgetc(file);
471
472       for(i=0; i<8; i++)
473         for(y=0; y<3; y++)
474           for(x=0; x<3; x++)
475             level.mampfer_inhalt[i][x][y] = fgetc(file);
476
477       getFileChunk(file, chunk, &chunk_length);
478     }
479
480     /* next check body chunk identifier and chunk length */
481     if (strcmp(chunk, "BODY") || chunk_length != lev_fieldx * lev_fieldy)
482     {
483       Error(ERR_WARN, "wrong 'BODY' chunk of level file '%s'", filename);
484       fclose(file);
485       return;
486     }
487   }
488
489   /* clear all other level fields (needed if resized in level editor later) */
490   for(x=0; x<MAX_LEV_FIELDX; x++)
491     for(y=0; y<MAX_LEV_FIELDY; y++)
492       Feld[x][y] = Ur[x][y] = EL_LEERRAUM;
493
494   /* now read in the valid level fields from level file */
495   for(y=0; y<lev_fieldy; y++)
496     for(x=0; x<lev_fieldx; x++)
497       Feld[x][y] = Ur[x][y] = fgetc(file);
498
499   fclose(file);
500
501   /* player was faster than monsters in pre-1.0 levels */
502   if (file_version == FILE_VERSION_1_0 &&
503       IS_LEVELCLASS_CONTRIBUTION(leveldir_nr))
504   {
505     Error(ERR_WARN, "level file '%s' has version number 1.0", filename);
506     Error(ERR_WARN, "using high speed movement for player");
507     level.high_speed = TRUE;
508   }
509 }
510
511 void SaveLevel(int level_nr)
512 {
513   int i, x, y;
514   char *filename = getLevelFilename(level_nr);
515   FILE *file;
516
517   if (!(file = fopen(filename, "w")))
518   {
519     Error(ERR_WARN, "cannot save level file '%s'", filename);
520     return;
521   }
522
523   fputs(LEVEL_COOKIE, file);            /* file identifier */
524   fputc('\n', file);
525
526   putFileChunk(file, "HEAD", LEVEL_HEADER_SIZE);
527
528   fputc(level.fieldx, file);
529   fputc(level.fieldy, file);
530   fputc(level.time / 256, file);
531   fputc(level.time % 256, file);
532   fputc(level.edelsteine / 256, file);
533   fputc(level.edelsteine % 256, file);
534
535   for(i=0; i<MAX_LEVEL_NAME_LEN; i++)
536     fputc(level.name[i], file);
537   for(i=0; i<LEVEL_SCORE_ELEMENTS; i++)
538     fputc(level.score[i], file);
539   for(i=0; i<4; i++)
540     for(y=0; y<3; y++)
541       for(x=0; x<3; x++)
542         fputc(level.mampfer_inhalt[i][x][y], file);
543   fputc(level.tempo_amoebe, file);
544   fputc(level.dauer_sieb, file);
545   fputc(level.dauer_ablenk, file);
546   fputc(level.amoebe_inhalt, file);
547
548   for(i=0; i<LEVEL_HEADER_UNUSED; i++)  /* set unused header bytes to zero */
549     fputc(0, file);
550
551   putFileChunk(file, "AUTH", MAX_LEVEL_AUTHOR_LEN);
552
553   for(i=0; i<MAX_LEVEL_AUTHOR_LEN; i++)
554     fputc(level.author[i], file);
555
556   putFileChunk(file, "CONT", 4 + 8 * 3 * 3);
557
558   fputc(EL_MAMPFER, file);
559   fputc(MampferMax, file);
560   fputc(0, file);
561   fputc(0, file);
562
563   for(i=0; i<8; i++)
564     for(y=0; y<3; y++)
565       for(x=0; x<3; x++)
566         fputc(level.mampfer_inhalt[i][x][y], file);
567
568   putFileChunk(file, "BODY", lev_fieldx * lev_fieldy);
569
570   for(y=0; y<lev_fieldy; y++) 
571     for(x=0; x<lev_fieldx; x++) 
572       fputc(Ur[x][y], file);
573
574   fclose(file);
575
576   chmod(filename, LEVEL_PERMS);
577 }
578
579 void LoadTape(int level_nr)
580 {
581   int i, j;
582   char *filename = getTapeFilename(level_nr);
583   char cookie[MAX_LINE_LEN];
584   char chunk[CHUNK_ID_LEN + 1];
585   FILE *file;
586   int num_participating_players;
587   int file_version = FILE_VERSION_1_2;  /* last version of tape files */
588   int chunk_length;
589
590   /* always start with reliable default values (empty tape) */
591   TapeErase();
592
593   /* default values (also for pre-1.2 tapes) with only the first player */
594   tape.player_participates[0] = TRUE;
595   for(i=1; i<MAX_PLAYERS; i++)
596     tape.player_participates[i] = FALSE;
597
598   /* at least one (default: the first) player participates in every tape */
599   num_participating_players = 1;
600
601   if (!(file = fopen(filename, "r")))
602     return;
603
604   /* check file identifier */
605   fgets(cookie, MAX_LINE_LEN, file);
606   if (strlen(cookie) > 0 && cookie[strlen(cookie) - 1] == '\n')
607     cookie[strlen(cookie) - 1] = '\0';
608
609   if (strcmp(cookie, TAPE_COOKIE_10) == 0)      /* old 1.0 tape format */
610     file_version = FILE_VERSION_1_0;
611   else if (strcmp(cookie, TAPE_COOKIE) != 0)    /* unknown tape format */
612   {
613     Error(ERR_WARN, "wrong file identifier of tape file '%s'", filename);
614     fclose(file);
615     return;
616   }
617
618   /* read chunk "HEAD" */
619   if (file_version >= FILE_VERSION_1_2)
620   {
621     /* first check header chunk identifier and chunk length */
622     fgets(chunk, CHUNK_ID_LEN + 1, file);
623     chunk_length =
624       (fgetc(file)<<24) | (fgetc(file)<<16) | (fgetc(file)<<8) | fgetc(file);
625
626     if (strcmp(chunk, "HEAD") || chunk_length != TAPE_HEADER_SIZE)
627     {
628       Error(ERR_WARN, "wrong 'HEAD' chunk of tape file '%s'", filename);
629       fclose(file);
630       return;
631     }
632   }
633
634   tape.random_seed =
635     (fgetc(file)<<24) | (fgetc(file)<<16) | (fgetc(file)<<8) | fgetc(file);
636   tape.date =
637     (fgetc(file)<<24) | (fgetc(file)<<16) | (fgetc(file)<<8) | fgetc(file);
638   tape.length =
639     (fgetc(file)<<24) | (fgetc(file)<<16) | (fgetc(file)<<8) | fgetc(file);
640
641   /* read header fields that are new since version 1.2 */
642   if (file_version >= FILE_VERSION_1_2)
643   {
644     byte store_participating_players = fgetc(file);
645
646     for(i=0; i<TAPE_HEADER_UNUSED; i++)         /* skip unused header bytes */
647       fgetc(file);
648
649     /* since version 1.2, tapes store which players participate in the tape */
650     num_participating_players = 0;
651     for(i=0; i<MAX_PLAYERS; i++)
652     {
653       tape.player_participates[i] = FALSE;
654
655       if (store_participating_players & (1 << i))
656       {
657         tape.player_participates[i] = TRUE;
658         num_participating_players++;
659       }
660     }
661   }
662
663   tape.level_nr = level_nr;
664   tape.counter = 0;
665   tape.changed = FALSE;
666
667   tape.recording = FALSE;
668   tape.playing = FALSE;
669   tape.pausing = FALSE;
670
671   /* read chunk "BODY" */
672   if (file_version >= FILE_VERSION_1_2)
673   {
674     /* next check body chunk identifier and chunk length */
675     fgets(chunk, CHUNK_ID_LEN + 1, file);
676     chunk_length =
677       (fgetc(file)<<24) | (fgetc(file)<<16) | (fgetc(file)<<8) | fgetc(file);
678     if (strcmp(chunk, "BODY") ||
679         chunk_length != (num_participating_players + 1) * tape.length)
680     {
681       Error(ERR_WARN, "wrong 'BODY' chunk of tape file '%s'", filename);
682       fclose(file);
683       return;
684     }
685   }
686
687   for(i=0; i<tape.length; i++)
688   {
689     if (i >= MAX_TAPELEN)
690       break;
691
692     for(j=0; j<MAX_PLAYERS; j++)
693     {
694       tape.pos[i].action[j] = MV_NO_MOVING;
695
696       if (tape.player_participates[j])
697         tape.pos[i].action[j] = fgetc(file);
698     }
699
700     tape.pos[i].delay = fgetc(file);
701
702     if (file_version == FILE_VERSION_1_0)
703     {
704       /* eliminate possible diagonal moves in old tapes */
705       /* this is only for backward compatibility */
706
707       byte joy_dir[4] = { JOY_LEFT, JOY_RIGHT, JOY_UP, JOY_DOWN };
708       byte action = tape.pos[i].action[0];
709       int k, num_moves = 0;
710
711       for (k=0; k<4; k++)
712       {
713         if (action & joy_dir[k])
714         {
715           tape.pos[i + num_moves].action[0] = joy_dir[k];
716           if (num_moves > 0)
717             tape.pos[i + num_moves].delay = 0;
718           num_moves++;
719         }
720       }
721
722       if (num_moves > 1)
723       {
724         num_moves--;
725         i += num_moves;
726         tape.length += num_moves;
727       }
728     }
729
730     if (feof(file))
731       break;
732   }
733
734   fclose(file);
735
736   if (i != tape.length)
737     Error(ERR_WARN, "level recording file '%s' corrupted", filename);
738
739   tape.length_seconds = GetTapeLength();
740 }
741
742 void SaveTape(int level_nr)
743 {
744   int i;
745   char *filename = getTapeFilename(level_nr);
746   FILE *file;
747   boolean new_tape = TRUE;
748   byte store_participating_players;
749   int num_participating_players;
750   int chunk_length;
751
752   InitTapeDirectory(leveldir[leveldir_nr].filename);
753
754   /* if a tape still exists, ask to overwrite it */
755   if (access(filename, F_OK) == 0)
756   {
757     new_tape = FALSE;
758     if (!Request("Replace old tape ?", REQ_ASK))
759       return;
760   }
761
762   /* count number of players and set corresponding bits for compact storage */
763   store_participating_players = 0;
764   num_participating_players = 0;
765   for(i=0; i<MAX_PLAYERS; i++)
766   {
767     if (tape.player_participates[i])
768     {
769       num_participating_players++;
770       store_participating_players |= (1 << i);
771     }
772   }
773
774   if (!(file = fopen(filename, "w")))
775   {
776     Error(ERR_WARN, "cannot save level recording file '%s'", filename);
777     return;
778   }
779
780   fputs(TAPE_COOKIE, file);             /* file identifier */
781   fputc('\n', file);
782
783   fputs("HEAD", file);                  /* chunk identifier for file header */
784
785   chunk_length = TAPE_HEADER_SIZE;
786
787   fputc((chunk_length >>  24) & 0xff, file);
788   fputc((chunk_length >>  16) & 0xff, file);
789   fputc((chunk_length >>   8) & 0xff, file);
790   fputc((chunk_length >>   0) & 0xff, file);
791
792   fputc((tape.random_seed >> 24) & 0xff, file);
793   fputc((tape.random_seed >> 16) & 0xff, file);
794   fputc((tape.random_seed >>  8) & 0xff, file);
795   fputc((tape.random_seed >>  0) & 0xff, file);
796
797   fputc((tape.date >>  24) & 0xff, file);
798   fputc((tape.date >>  16) & 0xff, file);
799   fputc((tape.date >>   8) & 0xff, file);
800   fputc((tape.date >>   0) & 0xff, file);
801
802   fputc((tape.length >>  24) & 0xff, file);
803   fputc((tape.length >>  16) & 0xff, file);
804   fputc((tape.length >>   8) & 0xff, file);
805   fputc((tape.length >>   0) & 0xff, file);
806
807   fputc(store_participating_players, file);
808
809   for(i=0; i<TAPE_HEADER_UNUSED; i++)   /* set unused header bytes to zero */
810     fputc(0, file);
811
812   fputs("BODY", file);                  /* chunk identifier for file body */
813   chunk_length = (num_participating_players + 1) * tape.length;
814
815   fputc((chunk_length >>  24) & 0xff, file);
816   fputc((chunk_length >>  16) & 0xff, file);
817   fputc((chunk_length >>   8) & 0xff, file);
818   fputc((chunk_length >>   0) & 0xff, file);
819
820   for(i=0; i<tape.length; i++)
821   {
822     int j;
823
824     for(j=0; j<MAX_PLAYERS; j++)
825       if (tape.player_participates[j])
826         fputc(tape.pos[i].action[j], file);
827
828     fputc(tape.pos[i].delay, file);
829   }
830
831   fclose(file);
832
833   chmod(filename, TAPE_PERMS);
834
835   tape.changed = FALSE;
836
837   if (new_tape)
838     Request("tape saved !", REQ_CONFIRM);
839 }
840
841 void LoadScore(int level_nr)
842 {
843   int i;
844   char *filename = getScoreFilename(level_nr);
845   char cookie[MAX_LINE_LEN];
846   char line[MAX_LINE_LEN];
847   char *line_ptr;
848   FILE *file;
849
850   /* always start with reliable default values */
851   for(i=0; i<MAX_SCORE_ENTRIES; i++)
852   {
853     strcpy(highscore[i].Name, EMPTY_PLAYER_NAME);
854     highscore[i].Score = 0;
855   }
856
857   if (!(file = fopen(filename, "r")))
858     return;
859
860   /* check file identifier */
861   fgets(cookie, MAX_LINE_LEN, file);
862   if (strlen(cookie) > 0 && cookie[strlen(cookie) - 1] == '\n')
863     cookie[strlen(cookie) - 1] = '\0';
864
865   if (strcmp(cookie, SCORE_COOKIE) != 0)
866   {
867     Error(ERR_WARN, "wrong file identifier of score file '%s'", filename);
868     fclose(file);
869     return;
870   }
871
872   for(i=0; i<MAX_SCORE_ENTRIES; i++)
873   {
874     fscanf(file, "%d", &highscore[i].Score);
875     fgets(line, MAX_LINE_LEN, file);
876
877     if (line[strlen(line)-1] == '\n')
878       line[strlen(line)-1] = '\0';
879
880     for (line_ptr = line; *line_ptr; line_ptr++)
881     {
882       if (*line_ptr != ' ' && *line_ptr != '\t' && *line_ptr != '\0')
883       {
884         strncpy(highscore[i].Name, line_ptr, MAX_NAMELEN - 1);
885         highscore[i].Name[MAX_NAMELEN - 1] = '\0';
886         break;
887       }
888     }
889   }
890
891   fclose(file);
892 }
893
894 void SaveScore(int level_nr)
895 {
896   int i;
897   char *filename = getScoreFilename(level_nr);
898   FILE *file;
899
900   InitScoreDirectory(leveldir[leveldir_nr].filename);
901
902   if (!(file = fopen(filename, "w")))
903   {
904     Error(ERR_WARN, "cannot save score for level %d", level_nr);
905     return;
906   }
907
908   fprintf(file, "%s\n\n", SCORE_COOKIE);
909
910   for(i=0; i<MAX_SCORE_ENTRIES; i++)
911     fprintf(file, "%d %s\n", highscore[i].Score, highscore[i].Name);
912
913   fclose(file);
914
915   chmod(filename, SCORE_PERMS);
916 }
917
918 #define TOKEN_STR_FILE_IDENTIFIER       "file_identifier"
919 #define TOKEN_STR_LAST_LEVEL_SERIES     "last_level_series"
920 #define TOKEN_STR_PLAYER_PREFIX         "player_"
921
922 #define TOKEN_VALUE_POSITION            30
923
924 /* global setup */
925 #define SETUP_TOKEN_PLAYER_NAME         0
926 #define SETUP_TOKEN_SOUND               1
927 #define SETUP_TOKEN_SOUND_LOOPS         2
928 #define SETUP_TOKEN_SOUND_MUSIC         3
929 #define SETUP_TOKEN_SOUND_SIMPLE        4
930 #define SETUP_TOKEN_TOONS               5
931 #define SETUP_TOKEN_DOUBLE_BUFFERING    6
932 #define SETUP_TOKEN_SCROLL_DELAY        7
933 #define SETUP_TOKEN_SOFT_SCROLLING      8
934 #define SETUP_TOKEN_FADING              9
935 #define SETUP_TOKEN_AUTORECORD          10
936 #define SETUP_TOKEN_QUICK_DOORS         11
937 #define SETUP_TOKEN_TEAM_MODE           12
938
939 /* player setup */
940 #define SETUP_TOKEN_USE_JOYSTICK        13
941 #define SETUP_TOKEN_JOY_DEVICE_NAME     14
942 #define SETUP_TOKEN_JOY_XLEFT           15
943 #define SETUP_TOKEN_JOY_XMIDDLE         16
944 #define SETUP_TOKEN_JOY_XRIGHT          17
945 #define SETUP_TOKEN_JOY_YUPPER          18
946 #define SETUP_TOKEN_JOY_YMIDDLE         19
947 #define SETUP_TOKEN_JOY_YLOWER          20
948 #define SETUP_TOKEN_JOY_SNAP            21
949 #define SETUP_TOKEN_JOY_BOMB            22
950 #define SETUP_TOKEN_KEY_LEFT            23
951 #define SETUP_TOKEN_KEY_RIGHT           24
952 #define SETUP_TOKEN_KEY_UP              25
953 #define SETUP_TOKEN_KEY_DOWN            26
954 #define SETUP_TOKEN_KEY_SNAP            27
955 #define SETUP_TOKEN_KEY_BOMB            28
956
957 /* level directory info */
958 #define LEVELINFO_TOKEN_NAME            29
959 #define LEVELINFO_TOKEN_AUTHOR          30
960 #define LEVELINFO_TOKEN_LEVELS          31
961 #define LEVELINFO_TOKEN_FIRST_LEVEL     32
962 #define LEVELINFO_TOKEN_SORT_PRIORITY   33
963 #define LEVELINFO_TOKEN_READONLY        34
964
965 #define FIRST_GLOBAL_SETUP_TOKEN        SETUP_TOKEN_PLAYER_NAME
966 #define LAST_GLOBAL_SETUP_TOKEN         SETUP_TOKEN_TEAM_MODE
967
968 #define FIRST_PLAYER_SETUP_TOKEN        SETUP_TOKEN_USE_JOYSTICK
969 #define LAST_PLAYER_SETUP_TOKEN         SETUP_TOKEN_KEY_BOMB
970
971 #define FIRST_LEVELINFO_TOKEN           LEVELINFO_TOKEN_NAME
972 #define LAST_LEVELINFO_TOKEN            LEVELINFO_TOKEN_READONLY
973
974 #define TYPE_BOOLEAN                    1
975 #define TYPE_SWITCH                     2
976 #define TYPE_KEYSYM                     3
977 #define TYPE_INTEGER                    4
978 #define TYPE_STRING                     5
979
980 static struct SetupInfo si;
981 static struct SetupInputInfo sii;
982 static struct LevelDirInfo ldi;
983 static struct
984 {
985   int type;
986   void *value;
987   char *text;
988 } token_info[] =
989 {
990   /* global setup */
991   { TYPE_STRING,  &si.player_name,      "player_name"                   },
992   { TYPE_SWITCH,  &si.sound,            "sound"                         },
993   { TYPE_SWITCH,  &si.sound_loops,      "repeating_sound_loops"         },
994   { TYPE_SWITCH,  &si.sound_music,      "background_music"              },
995   { TYPE_SWITCH,  &si.sound_simple,     "simple_sound_effects"          },
996   { TYPE_SWITCH,  &si.toons,            "toons"                         },
997   { TYPE_SWITCH,  &si.double_buffering, "double_buffering"              },
998   { TYPE_SWITCH,  &si.scroll_delay,     "scroll_delay"                  },
999   { TYPE_SWITCH,  &si.soft_scrolling,   "soft_scrolling"                },
1000   { TYPE_SWITCH,  &si.fading,           "screen_fading"                 },
1001   { TYPE_SWITCH,  &si.autorecord,       "automatic_tape_recording"      },
1002   { TYPE_SWITCH,  &si.quick_doors,      "quick_doors"                   },
1003   { TYPE_SWITCH,  &si.team_mode,        "team_mode"                     },
1004
1005   /* player setup */
1006   { TYPE_BOOLEAN, &sii.use_joystick,    ".use_joystick"                 },
1007   { TYPE_STRING,  &sii.joy.device_name, ".joy.device_name"              },
1008   { TYPE_INTEGER, &sii.joy.xleft,       ".joy.xleft"                    },
1009   { TYPE_INTEGER, &sii.joy.xmiddle,     ".joy.xmiddle"                  },
1010   { TYPE_INTEGER, &sii.joy.xright,      ".joy.xright"                   },
1011   { TYPE_INTEGER, &sii.joy.yupper,      ".joy.yupper"                   },
1012   { TYPE_INTEGER, &sii.joy.ymiddle,     ".joy.ymiddle"                  },
1013   { TYPE_INTEGER, &sii.joy.ylower,      ".joy.ylower"                   },
1014   { TYPE_INTEGER, &sii.joy.snap,        ".joy.snap_field"               },
1015   { TYPE_INTEGER, &sii.joy.bomb,        ".joy.place_bomb"               },
1016   { TYPE_KEYSYM,  &sii.key.left,        ".key.move_left"                },
1017   { TYPE_KEYSYM,  &sii.key.right,       ".key.move_right"               },
1018   { TYPE_KEYSYM,  &sii.key.up,          ".key.move_up"                  },
1019   { TYPE_KEYSYM,  &sii.key.down,        ".key.move_down"                },
1020   { TYPE_KEYSYM,  &sii.key.snap,        ".key.snap_field"               },
1021   { TYPE_KEYSYM,  &sii.key.bomb,        ".key.place_bomb"               },
1022
1023   /* level directory info */
1024   { TYPE_STRING,  &ldi.name,            "name"                          },
1025   { TYPE_STRING,  &ldi.author,          "author"                        },
1026   { TYPE_INTEGER, &ldi.levels,          "levels"                        },
1027   { TYPE_INTEGER, &ldi.first_level,     "first_level"                   },
1028   { TYPE_INTEGER, &ldi.sort_priority,   "sort_priority"                 },
1029   { TYPE_BOOLEAN, &ldi.readonly,        "readonly"                      }
1030 };
1031
1032 static char *string_tolower(char *s)
1033 {
1034   static char s_lower[100];
1035   int i;
1036
1037   if (strlen(s) >= 100)
1038     return s;
1039
1040   strcpy(s_lower, s);
1041
1042   for (i=0; i<strlen(s_lower); i++)
1043     s_lower[i] = tolower(s_lower[i]);
1044
1045   return s_lower;
1046 }
1047
1048 static int get_string_integer_value(char *s)
1049 {
1050   static char *number_text[][3] =
1051   {
1052     { "0", "zero", "null", },
1053     { "1", "one", "first" },
1054     { "2", "two", "second" },
1055     { "3", "three", "third" },
1056     { "4", "four", "fourth" },
1057     { "5", "five", "fifth" },
1058     { "6", "six", "sixth" },
1059     { "7", "seven", "seventh" },
1060     { "8", "eight", "eighth" },
1061     { "9", "nine", "ninth" },
1062     { "10", "ten", "tenth" },
1063     { "11", "eleven", "eleventh" },
1064     { "12", "twelve", "twelfth" },
1065   };
1066
1067   int i, j;
1068
1069   for (i=0; i<13; i++)
1070     for (j=0; j<3; j++)
1071       if (strcmp(string_tolower(s), number_text[i][j]) == 0)
1072         return i;
1073
1074   return atoi(s);
1075 }
1076
1077 static boolean get_string_boolean_value(char *s)
1078 {
1079   if (strcmp(string_tolower(s), "true") == 0 ||
1080       strcmp(string_tolower(s), "yes") == 0 ||
1081       strcmp(string_tolower(s), "on") == 0 ||
1082       get_string_integer_value(s) == 1)
1083     return TRUE;
1084   else
1085     return FALSE;
1086 }
1087
1088 static char *getFormattedSetupEntry(char *token, char *value)
1089 {
1090   int i;
1091   static char entry[MAX_LINE_LEN];
1092
1093   sprintf(entry, "%s:", token);
1094   for (i=strlen(entry); i<TOKEN_VALUE_POSITION; i++)
1095     entry[i] = ' ';
1096   entry[i] = '\0';
1097
1098   strcat(entry, value);
1099
1100   return entry;
1101 }
1102
1103 static void freeSetupFileList(struct SetupFileList *setup_file_list)
1104 {
1105   if (!setup_file_list)
1106     return;
1107
1108   if (setup_file_list->token)
1109     free(setup_file_list->token);
1110   if (setup_file_list->value)
1111     free(setup_file_list->value);
1112   if (setup_file_list->next)
1113     freeSetupFileList(setup_file_list->next);
1114   free(setup_file_list);
1115 }
1116
1117 static struct SetupFileList *newSetupFileList(char *token, char *value)
1118 {
1119   struct SetupFileList *new = checked_malloc(sizeof(struct SetupFileList));
1120
1121   new->token = checked_malloc(strlen(token) + 1);
1122   strcpy(new->token, token);
1123
1124   new->value = checked_malloc(strlen(value) + 1);
1125   strcpy(new->value, value);
1126
1127   new->next = NULL;
1128
1129   return new;
1130 }
1131
1132 static char *getTokenValue(struct SetupFileList *setup_file_list,
1133                            char *token)
1134 {
1135   if (!setup_file_list)
1136     return NULL;
1137
1138   if (strcmp(setup_file_list->token, token) == 0)
1139     return setup_file_list->value;
1140   else
1141     return getTokenValue(setup_file_list->next, token);
1142 }
1143
1144 static void setTokenValue(struct SetupFileList *setup_file_list,
1145                           char *token, char *value)
1146 {
1147   if (!setup_file_list)
1148     return;
1149
1150   if (strcmp(setup_file_list->token, token) == 0)
1151   {
1152     free(setup_file_list->value);
1153     setup_file_list->value = checked_malloc(strlen(value) + 1);
1154     strcpy(setup_file_list->value, value);
1155   }
1156   else if (setup_file_list->next == NULL)
1157     setup_file_list->next = newSetupFileList(token, value);
1158   else
1159     setTokenValue(setup_file_list->next, token, value);
1160 }
1161
1162 #ifdef DEBUG
1163 static void printSetupFileList(struct SetupFileList *setup_file_list)
1164 {
1165   if (!setup_file_list)
1166     return;
1167
1168   printf("token: '%s'\n", setup_file_list->token);
1169   printf("value: '%s'\n", setup_file_list->value);
1170
1171   printSetupFileList(setup_file_list->next);
1172 }
1173 #endif
1174
1175 static struct SetupFileList *loadSetupFileList(char *filename)
1176 {
1177   int line_len;
1178   char line[MAX_LINE_LEN];
1179   char *token, *value, *line_ptr;
1180   struct SetupFileList *setup_file_list = newSetupFileList("", "");
1181   struct SetupFileList *first_valid_list_entry;
1182
1183   FILE *file;
1184
1185   if (!(file = fopen(filename, "r")))
1186   {
1187     Error(ERR_WARN, "cannot open configuration file '%s'", filename);
1188     return NULL;
1189   }
1190
1191   while(!feof(file))
1192   {
1193     /* read next line of input file */
1194     if (!fgets(line, MAX_LINE_LEN, file))
1195       break;
1196
1197     /* cut trailing comment or whitespace from input line */
1198     for (line_ptr = line; *line_ptr; line_ptr++)
1199     {
1200       if (*line_ptr == '#' || *line_ptr == '\n')
1201       {
1202         *line_ptr = '\0';
1203         break;
1204       }
1205     }
1206
1207     /* cut trailing whitespaces from input line */
1208     for (line_ptr = &line[strlen(line)]; line_ptr > line; line_ptr--)
1209       if ((*line_ptr == ' ' || *line_ptr == '\t') && line_ptr[1] == '\0')
1210         *line_ptr = '\0';
1211
1212     /* ignore empty lines */
1213     if (*line == '\0')
1214       continue;
1215
1216     line_len = strlen(line);
1217
1218     /* cut leading whitespaces from token */
1219     for (token = line; *token; token++)
1220       if (*token != ' ' && *token != '\t')
1221         break;
1222
1223     /* find end of token */
1224     for (line_ptr = token; *line_ptr; line_ptr++)
1225     {
1226       if (*line_ptr == ' ' || *line_ptr == '\t' || *line_ptr == ':')
1227       {
1228         *line_ptr = '\0';
1229         break;
1230       }
1231     }
1232
1233     if (line_ptr < line + line_len)
1234       value = line_ptr + 1;
1235     else
1236       value = "\0";
1237
1238     /* cut leading whitespaces from value */
1239     for (; *value; value++)
1240       if (*value != ' ' && *value != '\t')
1241         break;
1242
1243     if (*token && *value)
1244       setTokenValue(setup_file_list, token, value);
1245   }
1246
1247   fclose(file);
1248
1249   first_valid_list_entry = setup_file_list->next;
1250
1251   /* free empty list header */
1252   setup_file_list->next = NULL;
1253   freeSetupFileList(setup_file_list);
1254
1255   if (first_valid_list_entry == NULL)
1256     Error(ERR_WARN, "configuration file '%s' is empty", filename);
1257
1258   return first_valid_list_entry;
1259 }
1260
1261 static void checkSetupFileListIdentifier(struct SetupFileList *setup_file_list,
1262                                          char *identifier)
1263 {
1264   if (!setup_file_list)
1265     return;
1266
1267   if (strcmp(setup_file_list->token, TOKEN_STR_FILE_IDENTIFIER) == 0)
1268   {
1269     if (strcmp(setup_file_list->value, identifier) != 0)
1270     {
1271       Error(ERR_WARN, "configuration file has wrong version");
1272       return;
1273     }
1274     else
1275       return;
1276   }
1277
1278   if (setup_file_list->next)
1279     checkSetupFileListIdentifier(setup_file_list->next, identifier);
1280   else
1281   {
1282     Error(ERR_WARN, "configuration file has no version information");
1283     return;
1284   }
1285 }
1286
1287 static void setLevelDirInfoToDefaults(struct LevelDirInfo *ldi)
1288 {
1289   ldi->name = getStringCopy(ANONYMOUS_NAME);
1290   ldi->author = getStringCopy(ANONYMOUS_NAME);
1291   ldi->levels = 0;
1292   ldi->first_level = 0;
1293   ldi->sort_priority = LEVELCLASS_UNDEFINED;    /* default: least priority */
1294   ldi->readonly = TRUE;
1295 }
1296
1297 static void setSetupInfoToDefaults(struct SetupInfo *si)
1298 {
1299   int i;
1300
1301   si->player_name = getStringCopy(getLoginName());
1302
1303   si->sound = TRUE;
1304   si->sound_loops = TRUE;
1305   si->sound_music = TRUE;
1306   si->sound_simple = TRUE;
1307   si->toons = TRUE;
1308   si->double_buffering = TRUE;
1309   si->direct_draw = !si->double_buffering;
1310   si->scroll_delay = TRUE;
1311   si->soft_scrolling = TRUE;
1312   si->fading = FALSE;
1313   si->autorecord = TRUE;
1314   si->quick_doors = FALSE;
1315
1316   for (i=0; i<MAX_PLAYERS; i++)
1317   {
1318     si->input[i].use_joystick = FALSE;
1319     si->input[i].joy.device_name = getStringCopy(joystick_device_name[i]);
1320     si->input[i].joy.xleft   = JOYSTICK_XLEFT;
1321     si->input[i].joy.xmiddle = JOYSTICK_XMIDDLE;
1322     si->input[i].joy.xright  = JOYSTICK_XRIGHT;
1323     si->input[i].joy.yupper  = JOYSTICK_YUPPER;
1324     si->input[i].joy.ymiddle = JOYSTICK_YMIDDLE;
1325     si->input[i].joy.ylower  = JOYSTICK_YLOWER;
1326     si->input[i].joy.snap  = (i == 0 ? JOY_BUTTON_1 : 0);
1327     si->input[i].joy.bomb  = (i == 0 ? JOY_BUTTON_2 : 0);
1328     si->input[i].key.left  = (i == 0 ? DEFAULT_KEY_LEFT  : KEY_UNDEFINDED);
1329     si->input[i].key.right = (i == 0 ? DEFAULT_KEY_RIGHT : KEY_UNDEFINDED);
1330     si->input[i].key.up    = (i == 0 ? DEFAULT_KEY_UP    : KEY_UNDEFINDED);
1331     si->input[i].key.down  = (i == 0 ? DEFAULT_KEY_DOWN  : KEY_UNDEFINDED);
1332     si->input[i].key.snap  = (i == 0 ? DEFAULT_KEY_SNAP  : KEY_UNDEFINDED);
1333     si->input[i].key.bomb  = (i == 0 ? DEFAULT_KEY_BOMB  : KEY_UNDEFINDED);
1334   }
1335 }
1336
1337 static void setSetupInfo(int token_nr, char *token_value)
1338 {
1339   int token_type = token_info[token_nr].type;
1340   void *setup_value = token_info[token_nr].value;
1341
1342   if (token_value == NULL)
1343     return;
1344
1345   /* set setup field to corresponding token value */
1346   switch (token_type)
1347   {
1348     case TYPE_BOOLEAN:
1349     case TYPE_SWITCH:
1350       *(boolean *)setup_value = get_string_boolean_value(token_value);
1351       break;
1352
1353     case TYPE_KEYSYM:
1354       *(KeySym *)setup_value = getKeySymFromX11KeyName(token_value);
1355       break;
1356
1357     case TYPE_INTEGER:
1358       *(int *)setup_value = get_string_integer_value(token_value);
1359       break;
1360
1361     case TYPE_STRING:
1362       if (*(char **)setup_value != NULL)
1363         free(*(char **)setup_value);
1364       *(char **)setup_value = getStringCopy(token_value);
1365       break;
1366
1367     default:
1368       break;
1369   }
1370 }
1371
1372 static void decodeSetupFileList(struct SetupFileList *setup_file_list)
1373 {
1374   int i, pnr;
1375
1376   if (!setup_file_list)
1377     return;
1378
1379   /* handle global setup values */
1380   si = setup;
1381   for (i=FIRST_GLOBAL_SETUP_TOKEN; i<=LAST_GLOBAL_SETUP_TOKEN; i++)
1382     setSetupInfo(i, getTokenValue(setup_file_list, token_info[i].text));
1383   setup = si;
1384
1385   /* handle player specific setup values */
1386   for (pnr=0; pnr<MAX_PLAYERS; pnr++)
1387   {
1388     char prefix[30];
1389
1390     sprintf(prefix, "%s%d", TOKEN_STR_PLAYER_PREFIX, pnr + 1);
1391
1392     sii = setup.input[pnr];
1393     for (i=FIRST_PLAYER_SETUP_TOKEN; i<=LAST_PLAYER_SETUP_TOKEN; i++)
1394     {
1395       char full_token[100];
1396
1397       sprintf(full_token, "%s%s", prefix, token_info[i].text);
1398       setSetupInfo(i, getTokenValue(setup_file_list, full_token));
1399     }
1400     setup.input[pnr] = sii;
1401   }
1402 }
1403
1404 int getLevelSeriesNrFromLevelSeriesName(char *level_series_name)
1405 {
1406   int i;
1407
1408   if (!level_series_name)
1409     return 0;
1410
1411   for (i=0; i<num_leveldirs; i++)
1412     if (strcmp(level_series_name, leveldir[i].filename) == 0)
1413       return i;
1414
1415   return 0;
1416 }
1417
1418 int getLastPlayedLevelOfLevelSeries(char *level_series_name)
1419 {
1420   char *token_value;
1421   int level_series_nr = getLevelSeriesNrFromLevelSeriesName(level_series_name);
1422   int last_level_nr = leveldir[level_series_nr].first_level;
1423
1424   if (!level_series_name)
1425     return 0;
1426
1427   token_value = getTokenValue(level_setup_list, level_series_name);
1428
1429   if (token_value)
1430   {
1431     last_level_nr = atoi(token_value);
1432
1433     if (last_level_nr < leveldir[level_series_nr].first_level)
1434       last_level_nr = leveldir[level_series_nr].first_level;
1435     if (last_level_nr > leveldir[level_series_nr].last_level)
1436       last_level_nr = leveldir[level_series_nr].last_level;
1437   }
1438
1439   return last_level_nr;
1440 }
1441
1442 static int compareLevelDirInfoEntries(const void *object1, const void *object2)
1443 {
1444   const struct LevelDirInfo *entry1 = object1;
1445   const struct LevelDirInfo *entry2 = object2;
1446   int compare_result;
1447
1448   if (entry1->sort_priority != entry2->sort_priority)
1449     compare_result = entry1->sort_priority - entry2->sort_priority;
1450   else
1451   {
1452     char *name1 = getStringToLower(entry1->name);
1453     char *name2 = getStringToLower(entry2->name);
1454
1455     compare_result = strcmp(name1, name2);
1456
1457     free(name1);
1458     free(name2);
1459   }
1460
1461   return compare_result;
1462 }
1463
1464 static int LoadLevelInfoFromLevelDir(char *level_directory, int start_entry)
1465 {
1466   DIR *dir;
1467   struct stat file_status;
1468   char *directory = NULL;
1469   char *filename = NULL;
1470   struct SetupFileList *setup_file_list = NULL;
1471   struct dirent *dir_entry;
1472   int i, current_entry = start_entry;
1473
1474   if ((dir = opendir(level_directory)) == NULL)
1475   {
1476     Error(ERR_WARN, "cannot read level directory '%s'", level_directory);
1477     return current_entry;
1478   }
1479
1480   while (current_entry < MAX_LEVDIR_ENTRIES)
1481   {
1482     if ((dir_entry = readdir(dir)) == NULL)     /* last directory entry */
1483       break;
1484
1485     /* skip entries for current and parent directory */
1486     if (strcmp(dir_entry->d_name, ".")  == 0 ||
1487         strcmp(dir_entry->d_name, "..") == 0)
1488       continue;
1489
1490     /* find out if directory entry is itself a directory */
1491     directory = getPath2(level_directory, dir_entry->d_name);
1492     if (stat(directory, &file_status) != 0 ||           /* cannot stat file */
1493         (file_status.st_mode & S_IFMT) != S_IFDIR)      /* not a directory */
1494     {
1495       free(directory);
1496       continue;
1497     }
1498
1499     filename = getPath2(directory, LEVELINFO_FILENAME);
1500     setup_file_list = loadSetupFileList(filename);
1501
1502     if (setup_file_list)
1503     {
1504       checkSetupFileListIdentifier(setup_file_list, LEVELINFO_COOKIE);
1505       setLevelDirInfoToDefaults(&leveldir[current_entry]);
1506
1507       ldi = leveldir[current_entry];
1508       for (i=FIRST_LEVELINFO_TOKEN; i<=LAST_LEVELINFO_TOKEN; i++)
1509         setSetupInfo(i, getTokenValue(setup_file_list, token_info[i].text));
1510       leveldir[current_entry] = ldi;
1511
1512       leveldir[current_entry].filename = getStringCopy(dir_entry->d_name);
1513       leveldir[current_entry].last_level =
1514         leveldir[current_entry].first_level +
1515         leveldir[current_entry].levels - 1;
1516       leveldir[current_entry].user_defined =
1517         (level_directory == options.level_directory ? FALSE : TRUE);
1518
1519       freeSetupFileList(setup_file_list);
1520       current_entry++;
1521     }
1522     else
1523       Error(ERR_WARN, "ignoring level directory '%s'", directory);
1524
1525     free(directory);
1526     free(filename);
1527   }
1528
1529   if (current_entry == MAX_LEVDIR_ENTRIES)
1530     Error(ERR_WARN, "using %d level directories -- ignoring the rest",
1531           current_entry);
1532
1533   closedir(dir);
1534
1535   if (current_entry == start_entry)
1536     Error(ERR_WARN, "cannot find any valid level series in directory '%s'",
1537           level_directory);
1538
1539   return current_entry;
1540 }
1541
1542 void LoadLevelInfo()
1543 {
1544   InitUserLevelDirectory(getLoginName());
1545
1546   num_leveldirs = 0;
1547   leveldir_nr = 0;
1548
1549   num_leveldirs = LoadLevelInfoFromLevelDir(options.level_directory,
1550                                             num_leveldirs);
1551   num_leveldirs = LoadLevelInfoFromLevelDir(getUserLevelDir(""),
1552                                             num_leveldirs);
1553
1554   if (num_leveldirs == 0)
1555     Error(ERR_EXIT, "cannot find any valid level series in any directory");
1556
1557   if (num_leveldirs > 1)
1558     qsort(leveldir, num_leveldirs, sizeof(struct LevelDirInfo),
1559           compareLevelDirInfoEntries);
1560 }
1561
1562 static void SaveUserLevelInfo()
1563 {
1564   char *filename;
1565   FILE *file;
1566   int i;
1567
1568   filename = getPath2(getUserLevelDir(getLoginName()), LEVELINFO_FILENAME);
1569
1570   if (!(file = fopen(filename, "w")))
1571   {
1572     Error(ERR_WARN, "cannot write level info file '%s'", filename);
1573     free(filename);
1574     return;
1575   }
1576
1577   /* always start with reliable default values */
1578   setLevelDirInfoToDefaults(&ldi);
1579
1580   ldi.name = getLoginName();
1581   ldi.author = getRealName();
1582   ldi.levels = 100;
1583   ldi.first_level = 1;
1584   ldi.sort_priority = LEVELCLASS_USER_START;
1585   ldi.readonly = FALSE;
1586
1587   fprintf(file, "%s\n\n",
1588           getFormattedSetupEntry(TOKEN_STR_FILE_IDENTIFIER, LEVELINFO_COOKIE));
1589
1590   for (i=FIRST_LEVELINFO_TOKEN; i<=LAST_LEVELINFO_TOKEN; i++)
1591     fprintf(file, "%s\n", getSetupLine("", i));
1592
1593   fclose(file);
1594   free(filename);
1595
1596   chmod(filename, SETUP_PERMS);
1597 }
1598
1599 void LoadSetup()
1600 {
1601   char *filename;
1602   struct SetupFileList *setup_file_list = NULL;
1603
1604   /* always start with reliable default values */
1605   setSetupInfoToDefaults(&setup);
1606
1607   filename = getPath2(getSetupDir(), SETUP_FILENAME);
1608
1609   setup_file_list = loadSetupFileList(filename);
1610
1611   if (setup_file_list)
1612   {
1613     checkSetupFileListIdentifier(setup_file_list, SETUP_COOKIE);
1614     decodeSetupFileList(setup_file_list);
1615
1616     setup.direct_draw = !setup.double_buffering;
1617
1618     freeSetupFileList(setup_file_list);
1619
1620     /* needed to work around problems with fixed length strings */
1621     if (strlen(setup.player_name) >= MAX_NAMELEN)
1622       setup.player_name[MAX_NAMELEN - 1] = '\0';
1623     else if (strlen(setup.player_name) < MAX_NAMELEN - 1)
1624     {
1625       char *new_name = checked_malloc(MAX_NAMELEN);
1626
1627       strcpy(new_name, setup.player_name);
1628       free(setup.player_name);
1629       setup.player_name = new_name;
1630     }
1631   }
1632   else
1633     Error(ERR_WARN, "using default setup values");
1634
1635   free(filename);
1636 }
1637
1638 static char *getSetupLine(char *prefix, int token_nr)
1639 {
1640   int i;
1641   static char entry[MAX_LINE_LEN];
1642   int token_type = token_info[token_nr].type;
1643   void *setup_value = token_info[token_nr].value;
1644   char *token_text = token_info[token_nr].text;
1645
1646   /* start with the prefix, token and some spaces to format output line */
1647   sprintf(entry, "%s%s:", prefix, token_text);
1648   for (i=strlen(entry); i<TOKEN_VALUE_POSITION; i++)
1649     strcat(entry, " ");
1650
1651   /* continue with the token's value (which can have different types) */
1652   switch (token_type)
1653   {
1654     case TYPE_BOOLEAN:
1655       strcat(entry, (*(boolean *)setup_value ? "true" : "false"));
1656       break;
1657
1658     case TYPE_SWITCH:
1659       strcat(entry, (*(boolean *)setup_value ? "on" : "off"));
1660       break;
1661
1662     case TYPE_KEYSYM:
1663       {
1664         KeySym keysym = *(KeySym *)setup_value;
1665         char *keyname = getKeyNameFromKeySym(keysym);
1666
1667         strcat(entry, getX11KeyNameFromKeySym(keysym));
1668         for (i=strlen(entry); i<50; i++)
1669           strcat(entry, " ");
1670
1671         /* add comment, if useful */
1672         if (strcmp(keyname, "(undefined)") != 0 &&
1673             strcmp(keyname, "(unknown)") != 0)
1674         {
1675           strcat(entry, "# ");
1676           strcat(entry, keyname);
1677         }
1678       }
1679       break;
1680
1681     case TYPE_INTEGER:
1682       {
1683         char buffer[MAX_LINE_LEN];
1684
1685         sprintf(buffer, "%d", *(int *)setup_value);
1686         strcat(entry, buffer);
1687       }
1688       break;
1689
1690     case TYPE_STRING:
1691       strcat(entry, *(char **)setup_value);
1692       break;
1693
1694     default:
1695       break;
1696   }
1697
1698   return entry;
1699 }
1700
1701 void SaveSetup()
1702 {
1703   int i, pnr;
1704   char *filename;
1705   FILE *file;
1706
1707   InitUserDataDirectory();
1708
1709   filename = getPath2(getSetupDir(), SETUP_FILENAME);
1710
1711   if (!(file = fopen(filename, "w")))
1712   {
1713     Error(ERR_WARN, "cannot write setup file '%s'", filename);
1714     free(filename);
1715     return;
1716   }
1717
1718   fprintf(file, "%s\n",
1719           getFormattedSetupEntry(TOKEN_STR_FILE_IDENTIFIER, SETUP_COOKIE));
1720   fprintf(file, "\n");
1721
1722   /* handle global setup values */
1723   si = setup;
1724   for (i=FIRST_GLOBAL_SETUP_TOKEN; i<=LAST_GLOBAL_SETUP_TOKEN; i++)
1725   {
1726     fprintf(file, "%s\n", getSetupLine("", i));
1727
1728     /* just to make things nicer :) */
1729     if (i == SETUP_TOKEN_PLAYER_NAME)
1730       fprintf(file, "\n");
1731   }
1732
1733   /* handle player specific setup values */
1734   for (pnr=0; pnr<MAX_PLAYERS; pnr++)
1735   {
1736     char prefix[30];
1737
1738     sprintf(prefix, "%s%d", TOKEN_STR_PLAYER_PREFIX, pnr + 1);
1739     fprintf(file, "\n");
1740
1741     sii = setup.input[pnr];
1742     for (i=FIRST_PLAYER_SETUP_TOKEN; i<=LAST_PLAYER_SETUP_TOKEN; i++)
1743       fprintf(file, "%s\n", getSetupLine(prefix, i));
1744   }
1745
1746   fclose(file);
1747   free(filename);
1748
1749   chmod(filename, SETUP_PERMS);
1750 }
1751
1752 void LoadLevelSetup()
1753 {
1754   char *filename;
1755
1756   /* always start with reliable default values */
1757   leveldir_nr = 0;
1758   level_nr = 0;
1759
1760   filename = getPath2(getSetupDir(), LEVELSETUP_FILENAME);
1761
1762   if (level_setup_list)
1763     freeSetupFileList(level_setup_list);
1764
1765   level_setup_list = loadSetupFileList(filename);
1766
1767   if (level_setup_list)
1768   {
1769     char *last_level_series =
1770       getTokenValue(level_setup_list, TOKEN_STR_LAST_LEVEL_SERIES);
1771
1772     leveldir_nr = getLevelSeriesNrFromLevelSeriesName(last_level_series);
1773     level_nr = getLastPlayedLevelOfLevelSeries(last_level_series);
1774
1775     checkSetupFileListIdentifier(level_setup_list, LEVELSETUP_COOKIE);
1776   }
1777   else
1778   {
1779     level_setup_list = newSetupFileList(TOKEN_STR_FILE_IDENTIFIER,
1780                                         LEVELSETUP_COOKIE);
1781     Error(ERR_WARN, "using default setup values");
1782   }
1783
1784   free(filename);
1785 }
1786
1787 void SaveLevelSetup()
1788 {
1789   char *filename;
1790   struct SetupFileList *list_entry = level_setup_list;
1791   FILE *file;
1792
1793   InitUserDataDirectory();
1794
1795   setTokenValue(level_setup_list,
1796                 TOKEN_STR_LAST_LEVEL_SERIES, leveldir[leveldir_nr].filename);
1797
1798   setTokenValue(level_setup_list,
1799                 leveldir[leveldir_nr].filename, int2str(level_nr, 0));
1800
1801   filename = getPath2(getSetupDir(), LEVELSETUP_FILENAME);
1802
1803   if (!(file = fopen(filename, "w")))
1804   {
1805     Error(ERR_WARN, "cannot write setup file '%s'", filename);
1806     free(filename);
1807     return;
1808   }
1809
1810   fprintf(file, "%s\n\n", getFormattedSetupEntry(TOKEN_STR_FILE_IDENTIFIER,
1811                                                  LEVELSETUP_COOKIE));
1812   while (list_entry)
1813   {
1814     if (strcmp(list_entry->token, TOKEN_STR_FILE_IDENTIFIER) != 0)
1815       fprintf(file, "%s\n",
1816               getFormattedSetupEntry(list_entry->token, list_entry->value));
1817
1818     /* just to make things nicer :) */
1819     if (strcmp(list_entry->token, TOKEN_STR_LAST_LEVEL_SERIES) == 0)
1820       fprintf(file, "\n");
1821
1822     list_entry = list_entry->next;
1823   }
1824
1825   fclose(file);
1826   free(filename);
1827
1828   chmod(filename, SETUP_PERMS);
1829 }
1830
1831 #ifdef MSDOS
1832 static boolean initErrorFile()
1833 {
1834   char *filename;
1835   FILE *error_file;
1836
1837   InitUserDataDirectory();
1838
1839   filename = getPath2(getUserDataDir(), ERROR_FILENAME);
1840   error_file = fopen(filename, "w");
1841   free(filename);
1842
1843   if (error_file == NULL)
1844     return FALSE;
1845
1846   fclose(error_file);
1847
1848   return TRUE;
1849 }
1850
1851 FILE *openErrorFile()
1852 {
1853   static boolean first_access = TRUE;
1854   char *filename;
1855   FILE *error_file;
1856
1857   if (first_access)
1858   {
1859     if (!initErrorFile())
1860       return NULL;
1861
1862     first_access = FALSE;
1863   }
1864
1865   filename = getPath2(getUserDataDir(), ERROR_FILENAME);
1866   error_file = fopen(filename, "a");
1867   free(filename);
1868
1869   return error_file;
1870 }
1871
1872 void dumpErrorFile()
1873 {
1874   char *filename;
1875   FILE *error_file;
1876
1877   filename = getPath2(getUserDataDir(), ERROR_FILENAME);
1878   error_file = fopen(filename, "r");
1879   free(filename);
1880
1881   if (error_file != NULL)
1882   {
1883     while (!feof(error_file))
1884       fputc(fgetc(error_file), stderr);
1885
1886     fclose(error_file);
1887   }
1888 }
1889 #endif