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