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