src/files.c

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