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