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