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