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