src/files.c

   1 /***********************************************************
   2 * Rocks'n'Diamonds -- McDuffin Strikes Back!               *
   3 *----------------------------------------------------------*
   4 * (c) 1995-2002 Artsoft Entertainment                      *
   5 *               Holger Schemel                             *
   6 *               Detmolder Strasse 189                      *
   7 *               33604 Bielefeld                            *
   8 *               Germany                                    *
   9 *               e-mail: info@artsoft.org                   *
  10 *----------------------------------------------------------*
  11 * files.c                                                  *
  12 ***********************************************************/
  13
  14 #include <ctype.h>
  15 #include <sys/stat.h>
  16 #include <dirent.h>
  17 #include <math.h>
  18
  19 #include "libgame/libgame.h"
  20
  21 #include "files.h"
  22 #include "init.h"
  23 #include "tools.h"
  24 #include "tape.h"
  25
  26
  27 #define CHUNK_ID_LEN            4       /* IFF style chunk id length  */
  28 #define CHUNK_SIZE_UNDEFINED    0       /* undefined chunk size == 0  */
  29 #define CHUNK_SIZE_NONE         -1      /* do not write chunk size    */
  30 #define FILE_VERS_CHUNK_SIZE    8       /* size of file version chunk */
  31 #define LEVEL_HEADER_SIZE       80      /* size of level file header  */
  32 #define LEVEL_HEADER_UNUSED     1       /* unused level header bytes  */
  33 #define LEVEL_CHUNK_CNT2_SIZE   160     /* size of level CNT2 chunk   */
  34 #define LEVEL_CHUNK_CNT2_UNUSED 11      /* unused CNT2 chunk bytes    */
  35 #define LEVEL_CHUNK_CNT3_HEADER 16      /* size of level CNT3 header  */
  36 #define LEVEL_CHUNK_CNT3_UNUSED 10      /* unused CNT3 chunk bytes    */
  37 #define LEVEL_CPART_CUS3_SIZE   134     /* size of CUS3 chunk part    */
  38 #define LEVEL_CPART_CUS3_UNUSED 15      /* unused CUS3 bytes / part   */
  39 #define LEVEL_CHUNK_GRP1_SIZE   74      /* size of level GRP1 chunk   */
  40 #define TAPE_HEADER_SIZE        20      /* size of tape file header   */
  41 #define TAPE_HEADER_UNUSED      3       /* unused tape header bytes   */
  42
  43 #define LEVEL_CHUNK_CNT3_SIZE(x) (LEVEL_CHUNK_CNT3_HEADER + (x))
  44 #define LEVEL_CHUNK_CUS3_SIZE(x) (2 + (x) * LEVEL_CPART_CUS3_SIZE)
  45 #define LEVEL_CHUNK_CUS4_SIZE(x) (48 + 48 + (x) * 48)
  46
  47 /* file identifier strings */
  48 #define LEVEL_COOKIE_TMPL       "ROCKSNDIAMONDS_LEVEL_FILE_VERSION_x.x"
  49 #define TAPE_COOKIE_TMPL        "ROCKSNDIAMONDS_TAPE_FILE_VERSION_x.x"
  50 #define SCORE_COOKIE            "ROCKSNDIAMONDS_SCORE_FILE_VERSION_1.2"
  51
  52 /* values for level file type identifier */
  53 #define LEVEL_FILE_TYPE_UNKNOWN         0
  54 #define LEVEL_FILE_TYPE_RND             1
  55 #define LEVEL_FILE_TYPE_BD              2
  56 #define LEVEL_FILE_TYPE_EM              3
  57 #define LEVEL_FILE_TYPE_SP              4
  58 #define LEVEL_FILE_TYPE_DX              5
  59 #define LEVEL_FILE_TYPE_SB              6
  60 #define LEVEL_FILE_TYPE_DC              7
  61
  62 #define LEVEL_FILE_TYPE_RND_PACKED      (10 + LEVEL_FILE_TYPE_RND)
  63 #define LEVEL_FILE_TYPE_EM_PACKED       (10 + LEVEL_FILE_TYPE_EM)
  64
  65 #define IS_SINGLE_LEVEL_FILE(x)         (x < 10)
  66 #define IS_PACKED_LEVEL_FILE(x)         (x > 10)
  67
  68
  69 /* ========================================================================= */
  70 /* level file functions                                                      */
  71 /* ========================================================================= */
  72
  73 void setElementChangePages(struct ElementInfo *ei, int change_pages)
  74 {
  75   int change_page_size = sizeof(struct ElementChangeInfo);
  76
  77   ei->num_change_pages = MAX(1, change_pages);
  78
  79   ei->change_page =
  80     checked_realloc(ei->change_page, ei->num_change_pages * change_page_size);
  81
  82   if (ei->current_change_page >= ei->num_change_pages)
  83     ei->current_change_page = ei->num_change_pages - 1;
  84
  85   ei->change = &ei->change_page[ei->current_change_page];
  86 }
  87
  88 void setElementChangeInfoToDefaults(struct ElementChangeInfo *change)
  89 {
  90   int x, y;
  91
  92   change->can_change = FALSE;
  93
  94   change->events = CE_BITMASK_DEFAULT;
  95
  96   change->trigger_player = CH_PLAYER_ANY;
  97   change->trigger_side = CH_SIDE_ANY;
  98   change->trigger_page = CH_PAGE_ANY;
  99
 100   change->target_element = EL_EMPTY_SPACE;
 101
 102   change->delay_fixed = 0;
 103   change->delay_random = 0;
 104   change->delay_frames = 1;
 105
 106   change->trigger_element = EL_EMPTY_SPACE;
 107
 108   change->explode = FALSE;
 109   change->use_target_content = FALSE;
 110   change->only_if_complete = FALSE;
 111   change->use_random_replace = FALSE;
 112   change->random_percentage = 100;
 113   change->replace_when = CP_WHEN_EMPTY;
 114
 115   for (x = 0; x < 3; x++)
 116     for (y = 0; y < 3; y++)
 117       change->target_content[x][y] = EL_EMPTY_SPACE;
 118
 119   change->direct_action = 0;
 120   change->other_action = 0;
 121
 122   change->pre_change_function = NULL;
 123   change->change_function = NULL;
 124   change->post_change_function = NULL;
 125 }
 126
 127 static void setLevelInfoToDefaults(struct LevelInfo *level)
 128 {
 129   static boolean clipboard_elements_initialized = FALSE;
 130
 131   int i, j, x, y;
 132
 133   level->file_version = FILE_VERSION_ACTUAL;
 134   level->game_version = GAME_VERSION_ACTUAL;
 135
 136   level->encoding_16bit_field  = FALSE; /* default: only 8-bit elements */
 137   level->encoding_16bit_yamyam = FALSE; /* default: only 8-bit elements */
 138   level->encoding_16bit_amoeba = FALSE; /* default: only 8-bit elements */
 139
 140   level->fieldx = STD_LEV_FIELDX;
 141   level->fieldy = STD_LEV_FIELDY;
 142
 143   for (x = 0; x < MAX_LEV_FIELDX; x++)
 144     for (y = 0; y < MAX_LEV_FIELDY; y++)
 145       level->field[x][y] = EL_SAND;
 146
 147   level->time = 100;
 148   level->gems_needed = 0;
 149
 150   level->amoeba_speed = 10;
 151
 152   level->time_magic_wall = 10;
 153   level->time_wheel = 10;
 154   level->time_light = 10;
 155   level->time_timegate = 10;
 156
 157   level->amoeba_content = EL_DIAMOND;
 158
 159   level->double_speed = FALSE;
 160   level->initial_gravity = FALSE;
 161   level->em_slippery_gems = FALSE;
 162   level->instant_relocation = FALSE;
 163   level->can_pass_to_walkable = FALSE;
 164   level->grow_into_diggable = TRUE;
 165
 166   level->block_last_field = FALSE;      /* EM does not block by default */
 167   level->sp_block_last_field = TRUE;    /* SP blocks the last field */
 168   level->block_delay = 8;               /* when blocking, block 8 frames */
 169   level->sp_block_delay = 9;            /* SP indeed blocks 9 frames, not 8 */
 170
 171   level->can_move_into_acid_bits = ~0;  /* everything can move into acid */
 172   level->dont_collide_with_bits = ~0;   /* always deadly when colliding */
 173
 174   level->use_spring_bug = FALSE;
 175   level->use_step_counter = FALSE;
 176
 177   level->use_custom_template = FALSE;
 178
 179   for (i = 0; i < MAX_LEVEL_NAME_LEN; i++)
 180     level->name[i] = '\0';
 181   for (i = 0; i < MAX_LEVEL_AUTHOR_LEN; i++)
 182     level->author[i] = '\0';
 183
 184   strcpy(level->name, NAMELESS_LEVEL_NAME);
 185   strcpy(level->author, ANONYMOUS_NAME);
 186
 187   for (i = 0; i < 4; i++)
 188   {
 189     level->envelope_text[i][0] = '\0';
 190     level->envelope_xsize[i] = MAX_ENVELOPE_XSIZE;
 191     level->envelope_ysize[i] = MAX_ENVELOPE_YSIZE;
 192   }
 193
 194   for (i = 0; i < LEVEL_SCORE_ELEMENTS; i++)
 195     level->score[i] = 10;
 196
 197   level->num_yamyam_contents = STD_ELEMENT_CONTENTS;
 198   for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
 199     for (x = 0; x < 3; x++)
 200       for (y = 0; y < 3; y++)
 201         level->yamyam_content[i][x][y] =
 202           (i < STD_ELEMENT_CONTENTS ? EL_ROCK : EL_EMPTY);
 203
 204   level->field[0][0] = EL_PLAYER_1;
 205   level->field[STD_LEV_FIELDX - 1][STD_LEV_FIELDY - 1] = EL_EXIT_CLOSED;
 206
 207   for (i = 0; i < MAX_NUM_ELEMENTS; i++)
 208   {
 209     int element = i;
 210
 211     /* never initialize clipboard elements after the very first time */
 212     if (IS_CLIPBOARD_ELEMENT(element) && clipboard_elements_initialized)
 213       continue;
 214
 215     setElementChangePages(&element_info[element], 1);
 216     setElementChangeInfoToDefaults(element_info[element].change);
 217
 218     if (IS_CUSTOM_ELEMENT(element) ||
 219         IS_GROUP_ELEMENT(element) ||
 220         IS_INTERNAL_ELEMENT(element))
 221     {
 222       for (j = 0; j < MAX_ELEMENT_NAME_LEN + 1; j++)
 223         element_info[element].description[j] = '\0';
 224
 225       if (element_info[element].custom_description != NULL)
 226         strncpy(element_info[element].description,
 227                 element_info[element].custom_description,MAX_ELEMENT_NAME_LEN);
 228       else
 229         strcpy(element_info[element].description,
 230                element_info[element].editor_description);
 231
 232       element_info[element].use_gfx_element = FALSE;
 233       element_info[element].gfx_element = EL_EMPTY_SPACE;
 234
 235       element_info[element].modified_settings = FALSE;
 236     }
 237
 238     if (IS_CUSTOM_ELEMENT(element) ||
 239         IS_INTERNAL_ELEMENT(element))
 240     {
 241       element_info[element].access_direction = MV_ALL_DIRECTIONS;
 242
 243       element_info[element].collect_score = 10;         /* special default */
 244       element_info[element].collect_count = 1;          /* special default */
 245
 246       element_info[element].push_delay_fixed = -1;      /* initialize later */
 247       element_info[element].push_delay_random = -1;     /* initialize later */
 248       element_info[element].drop_delay_fixed = 0;
 249       element_info[element].drop_delay_random = 0;
 250       element_info[element].move_delay_fixed = 0;
 251       element_info[element].move_delay_random = 0;
 252
 253       element_info[element].move_pattern = MV_ALL_DIRECTIONS;
 254       element_info[element].move_direction_initial = MV_START_AUTOMATIC;
 255       element_info[element].move_stepsize = TILEX / 8;
 256
 257       element_info[element].move_enter_element = EL_EMPTY_SPACE;
 258       element_info[element].move_leave_element = EL_EMPTY_SPACE;
 259       element_info[element].move_leave_type = LEAVE_TYPE_UNLIMITED;
 260
 261       element_info[element].slippery_type = SLIPPERY_ANY_RANDOM;
 262
 263       element_info[element].explosion_type = EXPLODES_3X3;
 264       element_info[element].explosion_delay = 16;
 265       element_info[element].ignition_delay = 8;
 266
 267       for (x = 0; x < 3; x++)
 268         for (y = 0; y < 3; y++)
 269           element_info[element].content[x][y] = EL_EMPTY_SPACE;
 270
 271       element_info[element].access_type = 0;
 272       element_info[element].access_layer = 0;
 273       element_info[element].access_protected = 0;
 274       element_info[element].walk_to_action = 0;
 275       element_info[element].smash_targets = 0;
 276       element_info[element].deadliness = 0;
 277
 278       element_info[element].can_explode_by_fire = FALSE;
 279       element_info[element].can_explode_smashed = FALSE;
 280       element_info[element].can_explode_impact = FALSE;
 281
 282       element_info[element].current_change_page = 0;
 283
 284       /* start with no properties at all */
 285       for (j = 0; j < NUM_EP_BITFIELDS; j++)
 286         Properties[element][j] = EP_BITMASK_DEFAULT;
 287
 288       /* now set default properties */
 289       SET_PROPERTY(element, EP_CAN_MOVE_INTO_ACID, TRUE);
 290     }
 291
 292     if (IS_GROUP_ELEMENT(element) ||
 293         IS_INTERNAL_ELEMENT(element))
 294     {
 295       /* initialize memory for list of elements in group */
 296       if (element_info[element].group == NULL)
 297         element_info[element].group =
 298           checked_malloc(sizeof(struct ElementGroupInfo));
 299
 300       for (j = 0; j < MAX_ELEMENTS_IN_GROUP; j++)
 301         element_info[element].group->element[j] = EL_EMPTY_SPACE;
 302
 303       /* default: only one element in group */
 304       element_info[element].group->num_elements = 1;
 305
 306       element_info[element].group->choice_mode = ANIM_RANDOM;
 307     }
 308   }
 309
 310   clipboard_elements_initialized = TRUE;
 311
 312   BorderElement = EL_STEELWALL;
 313
 314   level->no_valid_file = FALSE;
 315
 316   if (leveldir_current == NULL)         /* only when dumping level */
 317     return;
 318
 319   /* try to determine better author name than 'anonymous' */
 320   if (strcmp(leveldir_current->author, ANONYMOUS_NAME) != 0)
 321   {
 322     strncpy(level->author, leveldir_current->author, MAX_LEVEL_AUTHOR_LEN);
 323     level->author[MAX_LEVEL_AUTHOR_LEN] = '\0';
 324   }
 325   else
 326   {
 327     switch (LEVELCLASS(leveldir_current))
 328     {
 329       case LEVELCLASS_TUTORIAL:
 330         strcpy(level->author, PROGRAM_AUTHOR_STRING);
 331         break;
 332
 333       case LEVELCLASS_CONTRIB:
 334         strncpy(level->author, leveldir_current->name, MAX_LEVEL_AUTHOR_LEN);
 335         level->author[MAX_LEVEL_AUTHOR_LEN] = '\0';
 336         break;
 337
 338       case LEVELCLASS_PRIVATE:
 339         strncpy(level->author, getRealName(), MAX_LEVEL_AUTHOR_LEN);
 340         level->author[MAX_LEVEL_AUTHOR_LEN] = '\0';
 341         break;
 342
 343       default:
 344         /* keep default value */
 345         break;
 346     }
 347   }
 348 }
 349
 350 static void setFileInfoToDefaults(struct LevelFileInfo *level_file_info)
 351 {
 352   level_file_info->nr = 0;
 353   level_file_info->type = LEVEL_FILE_TYPE_UNKNOWN;
 354   level_file_info->packed = FALSE;
 355   level_file_info->basename = NULL;
 356   level_file_info->filename = NULL;
 357 }
 358
 359 static void ActivateLevelTemplate()
 360 {
 361   /* Currently there is no special action needed to activate the template
 362      data, because 'element_info' and 'Properties' overwrite the original
 363      level data, while all other variables do not change. */
 364 }
 365
 366 static char *getLevelFilenameFromBasename(char *basename)
 367 {
 368   static char *filename = NULL;
 369
 370   checked_free(filename);
 371
 372   filename = getPath2(getCurrentLevelDir(), basename);
 373
 374   return filename;
 375 }
 376
 377 static int getFileTypeFromBasename(char *basename)
 378 {
 379   static char *filename = NULL;
 380   struct stat file_status;
 381
 382   /* ---------- try to determine file type from filename ---------- */
 383
 384   /* check for typical filename of a Supaplex level package file */
 385   if (strlen(basename) == 10 && (strncmp(basename, "levels.d", 8) == 0 ||
 386                                  strncmp(basename, "LEVELS.D", 8) == 0))
 387     return LEVEL_FILE_TYPE_SP;
 388
 389   /* ---------- try to determine file type from filesize ---------- */
 390
 391   checked_free(filename);
 392   filename = getPath2(getCurrentLevelDir(), basename);
 393
 394   if (stat(filename, &file_status) == 0)
 395   {
 396     /* check for typical filesize of a Supaplex level package file */
 397     if (file_status.st_size == 170496)
 398       return LEVEL_FILE_TYPE_SP;
 399   }
 400
 401   return LEVEL_FILE_TYPE_UNKNOWN;
 402 }
 403
 404 static char *getSingleLevelBasename(int nr, int type)
 405 {
 406   static char basename[MAX_FILENAME_LEN];
 407   char *level_filename = getStringCopy(leveldir_current->level_filename);
 408
 409   if (level_filename == NULL)
 410     level_filename = getStringCat2("%03d.", LEVELFILE_EXTENSION);
 411
 412   switch (type)
 413   {
 414     case LEVEL_FILE_TYPE_RND:
 415       if (nr < 0)
 416         sprintf(basename, "template.%s", LEVELFILE_EXTENSION);
 417       else
 418         sprintf(basename, "%03d.%s", nr, LEVELFILE_EXTENSION);
 419       break;
 420
 421     case LEVEL_FILE_TYPE_EM:
 422       sprintf(basename, "%d", nr);
 423       break;
 424
 425     case LEVEL_FILE_TYPE_UNKNOWN:
 426     default:
 427       sprintf(basename, level_filename, nr);
 428       break;
 429   }
 430
 431   free(level_filename);
 432
 433   return basename;
 434 }
 435
 436 static char *getPackedLevelBasename(int type)
 437 {
 438   static char basename[MAX_FILENAME_LEN];
 439   char *directory = getCurrentLevelDir();
 440   DIR *dir;
 441   struct dirent *dir_entry;
 442
 443   strcpy(basename, UNDEFINED_FILENAME);         /* default: undefined file */
 444
 445   if ((dir = opendir(directory)) == NULL)
 446   {
 447     Error(ERR_WARN, "cannot read current level directory '%s'", directory);
 448
 449     return basename;
 450   }
 451
 452   while ((dir_entry = readdir(dir)) != NULL)    /* loop until last dir entry */
 453   {
 454     char *entry_basename = dir_entry->d_name;
 455     int entry_type = getFileTypeFromBasename(entry_basename);
 456
 457     if (entry_type != LEVEL_FILE_TYPE_UNKNOWN)  /* found valid level package */
 458     {
 459       if (type == LEVEL_FILE_TYPE_UNKNOWN ||
 460           type == entry_type)
 461       {
 462         strcpy(basename, entry_basename);
 463
 464         break;
 465       }
 466     }
 467   }
 468
 469   closedir(dir);
 470
 471   return basename;
 472 }
 473
 474 static char *getSingleLevelFilename(int nr, int type)
 475 {
 476   return getLevelFilenameFromBasename(getSingleLevelBasename(nr, type));
 477 }
 478
 479 #if 0
 480 static char *getPackedLevelFilename(int type)
 481 {
 482   return getLevelFilenameFromBasename(getPackedLevelBasename(type));
 483 }
 484 #endif
 485
 486 char *getDefaultLevelFilename(int nr)
 487 {
 488   return getSingleLevelFilename(nr, LEVEL_FILE_TYPE_RND);
 489 }
 490
 491 static void setLevelFileInfo_SingleLevelFilename(struct LevelFileInfo *lfi,
 492                                                  int type)
 493 {
 494   lfi->type = type;
 495   lfi->packed = FALSE;
 496   lfi->basename = getSingleLevelBasename(lfi->nr, lfi->type);
 497   lfi->filename = getLevelFilenameFromBasename(lfi->basename);
 498 }
 499
 500 static void setLevelFileInfo_PackedLevelFilename(struct LevelFileInfo *lfi,
 501                                                  int type)
 502 {
 503   lfi->type = type;
 504   lfi->packed = TRUE;
 505   lfi->basename = getPackedLevelBasename(lfi->type);
 506   lfi->filename = getLevelFilenameFromBasename(lfi->basename);
 507 }
 508
 509 static void determineLevelFileInfo_Filename(struct LevelFileInfo *lfi)
 510 {
 511   /* special case: level number is negative => check for level template file */
 512   if (lfi->nr < 0)
 513   {
 514     setLevelFileInfo_SingleLevelFilename(lfi, LEVEL_FILE_TYPE_RND);
 515
 516     return;
 517   }
 518
 519   if (leveldir_current->level_filename != NULL)
 520   {
 521     /* check for file name/pattern specified in "levelinfo.conf" */
 522     setLevelFileInfo_SingleLevelFilename(lfi, LEVEL_FILE_TYPE_UNKNOWN);
 523     if (fileExists(lfi->filename))
 524       return;
 525   }
 526
 527   /* check for native Rocks'n'Diamonds level file */
 528   setLevelFileInfo_SingleLevelFilename(lfi, LEVEL_FILE_TYPE_RND);
 529   if (fileExists(lfi->filename))
 530     return;
 531
 532   /* check for classic Emerald Mine level file */
 533   setLevelFileInfo_SingleLevelFilename(lfi, LEVEL_FILE_TYPE_EM);
 534   if (fileExists(lfi->filename))
 535     return;
 536
 537   /* check for various packed level file formats */
 538   setLevelFileInfo_PackedLevelFilename(lfi, LEVEL_FILE_TYPE_UNKNOWN);
 539   if (fileExists(lfi->filename))
 540     return;
 541
 542   /* no known level file found -- try to use default values */
 543   setLevelFileInfo_SingleLevelFilename(lfi, LEVEL_FILE_TYPE_UNKNOWN);
 544 }
 545
 546 static void determineLevelFileInfo_Filetype(struct LevelFileInfo *lfi)
 547 {
 548   if (lfi->type == LEVEL_FILE_TYPE_UNKNOWN)
 549     lfi->type = getFileTypeFromBasename(lfi->basename);
 550 }
 551
 552 static struct LevelFileInfo *getLevelFileInfo(int nr)
 553 {
 554   static struct LevelFileInfo level_file_info;
 555
 556   /* always start with reliable default values */
 557   setFileInfoToDefaults(&level_file_info);
 558
 559   level_file_info.nr = nr;      /* set requested level number */
 560
 561   determineLevelFileInfo_Filename(&level_file_info);
 562   determineLevelFileInfo_Filetype(&level_file_info);
 563
 564   return &level_file_info;
 565 }
 566
 567
 568 /* ------------------------------------------------------------------------- */
 569 /* functions for loading R'n'D level                                         */
 570 /* ------------------------------------------------------------------------- */
 571
 572 int getMappedElement(int element)
 573 {
 574   /* remap some (historic, now obsolete) elements */
 575
 576 #if 1
 577   switch (element)
 578   {
 579     case EL_PLAYER_OBSOLETE:
 580       element = EL_PLAYER_1;
 581       break;
 582
 583     case EL_KEY_OBSOLETE:
 584       element = EL_KEY_1;
 585
 586     case EL_EM_KEY_1_FILE_OBSOLETE:
 587       element = EL_EM_KEY_1;
 588       break;
 589
 590     case EL_EM_KEY_2_FILE_OBSOLETE:
 591       element = EL_EM_KEY_2;
 592       break;
 593
 594     case EL_EM_KEY_3_FILE_OBSOLETE:
 595       element = EL_EM_KEY_3;
 596       break;
 597
 598     case EL_EM_KEY_4_FILE_OBSOLETE:
 599       element = EL_EM_KEY_4;
 600       break;
 601
 602     case EL_ENVELOPE_OBSOLETE:
 603       element = EL_ENVELOPE_1;
 604       break;
 605
 606     case EL_SP_EMPTY:
 607       element = EL_EMPTY;
 608       break;
 609
 610     default:
 611       if (element >= NUM_FILE_ELEMENTS)
 612       {
 613         Error(ERR_WARN, "invalid level element %d", element);
 614
 615         element = EL_UNKNOWN;
 616       }
 617       break;
 618   }
 619 #else
 620   if (element >= NUM_FILE_ELEMENTS)
 621   {
 622     Error(ERR_WARN, "invalid level element %d", element);
 623
 624     element = EL_UNKNOWN;
 625   }
 626   else if (element == EL_PLAYER_OBSOLETE)
 627     element = EL_PLAYER_1;
 628   else if (element == EL_KEY_OBSOLETE)
 629     element = EL_KEY_1;
 630 #endif
 631
 632   return element;
 633 }
 634
 635 int getMappedElementByVersion(int element, int game_version)
 636 {
 637   /* remap some elements due to certain game version */
 638
 639   if (game_version <= VERSION_IDENT(2,2,0,0))
 640   {
 641     /* map game font elements */
 642     element = (element == EL_CHAR('[')  ? EL_CHAR_AUMLAUT :
 643                element == EL_CHAR('\\') ? EL_CHAR_OUMLAUT :
 644                element == EL_CHAR(']')  ? EL_CHAR_UUMLAUT :
 645                element == EL_CHAR('^')  ? EL_CHAR_COPYRIGHT : element);
 646   }
 647
 648   if (game_version < VERSION_IDENT(3,0,0,0))
 649   {
 650     /* map Supaplex gravity tube elements */
 651     element = (element == EL_SP_GRAVITY_PORT_LEFT  ? EL_SP_PORT_LEFT  :
 652                element == EL_SP_GRAVITY_PORT_RIGHT ? EL_SP_PORT_RIGHT :
 653                element == EL_SP_GRAVITY_PORT_UP    ? EL_SP_PORT_UP    :
 654                element == EL_SP_GRAVITY_PORT_DOWN  ? EL_SP_PORT_DOWN  :
 655                element);
 656   }
 657
 658   return element;
 659 }
 660
 661 static int LoadLevel_VERS(FILE *file, int chunk_size, struct LevelInfo *level)
 662 {
 663   level->file_version = getFileVersion(file);
 664   level->game_version = getFileVersion(file);
 665
 666   return chunk_size;
 667 }
 668
 669 static int LoadLevel_HEAD(FILE *file, int chunk_size, struct LevelInfo *level)
 670 {
 671   int i, x, y;
 672
 673   level->fieldx = getFile8Bit(file);
 674   level->fieldy = getFile8Bit(file);
 675
 676   level->time           = getFile16BitBE(file);
 677   level->gems_needed    = getFile16BitBE(file);
 678
 679   for (i = 0; i < MAX_LEVEL_NAME_LEN; i++)
 680     level->name[i] = getFile8Bit(file);
 681   level->name[MAX_LEVEL_NAME_LEN] = 0;
 682
 683   for (i = 0; i < LEVEL_SCORE_ELEMENTS; i++)
 684     level->score[i] = getFile8Bit(file);
 685
 686   level->num_yamyam_contents = STD_ELEMENT_CONTENTS;
 687   for (i = 0; i < STD_ELEMENT_CONTENTS; i++)
 688     for (y = 0; y < 3; y++)
 689       for (x = 0; x < 3; x++)
 690         level->yamyam_content[i][x][y] = getMappedElement(getFile8Bit(file));
 691
 692   level->amoeba_speed           = getFile8Bit(file);
 693   level->time_magic_wall        = getFile8Bit(file);
 694   level->time_wheel             = getFile8Bit(file);
 695   level->amoeba_content         = getMappedElement(getFile8Bit(file));
 696   level->double_speed           = (getFile8Bit(file) == 1 ? TRUE : FALSE);
 697   level->initial_gravity        = (getFile8Bit(file) == 1 ? TRUE : FALSE);
 698   level->encoding_16bit_field   = (getFile8Bit(file) == 1 ? TRUE : FALSE);
 699   level->em_slippery_gems       = (getFile8Bit(file) == 1 ? TRUE : FALSE);
 700
 701   level->use_custom_template    = (getFile8Bit(file) == 1 ? TRUE : FALSE);
 702
 703   level->block_last_field       = (getFile8Bit(file) == 1 ? TRUE : FALSE);
 704   level->sp_block_last_field    = (getFile8Bit(file) == 1 ? TRUE : FALSE);
 705   level->can_move_into_acid_bits = getFile32BitBE(file);
 706   level->dont_collide_with_bits = getFile8Bit(file);
 707
 708   level->use_spring_bug         = (getFile8Bit(file) == 1 ? TRUE : FALSE);
 709   level->use_step_counter       = (getFile8Bit(file) == 1 ? TRUE : FALSE);
 710
 711   level->instant_relocation     = (getFile8Bit(file) == 1 ? TRUE : FALSE);
 712   level->can_pass_to_walkable   = (getFile8Bit(file) == 1 ? TRUE : FALSE);
 713   level->grow_into_diggable     = (getFile8Bit(file) == 1 ? TRUE : FALSE);
 714
 715   ReadUnusedBytesFromFile(file, LEVEL_HEADER_UNUSED);
 716
 717   return chunk_size;
 718 }
 719
 720 static int LoadLevel_AUTH(FILE *file, int chunk_size, struct LevelInfo *level)
 721 {
 722   int i;
 723
 724   for (i = 0; i < MAX_LEVEL_AUTHOR_LEN; i++)
 725     level->author[i] = getFile8Bit(file);
 726   level->author[MAX_LEVEL_NAME_LEN] = 0;
 727
 728   return chunk_size;
 729 }
 730
 731 static int LoadLevel_BODY(FILE *file, int chunk_size, struct LevelInfo *level)
 732 {
 733   int x, y;
 734   int chunk_size_expected = level->fieldx * level->fieldy;
 735
 736   /* Note: "chunk_size" was wrong before version 2.0 when elements are
 737      stored with 16-bit encoding (and should be twice as big then).
 738      Even worse, playfield data was stored 16-bit when only yamyam content
 739      contained 16-bit elements and vice versa. */
 740
 741   if (level->encoding_16bit_field && level->file_version >= FILE_VERSION_2_0)
 742     chunk_size_expected *= 2;
 743
 744   if (chunk_size_expected != chunk_size)
 745   {
 746     ReadUnusedBytesFromFile(file, chunk_size);
 747     return chunk_size_expected;
 748   }
 749
 750   for (y = 0; y < level->fieldy; y++)
 751     for (x = 0; x < level->fieldx; x++)
 752       level->field[x][y] =
 753         getMappedElement(level->encoding_16bit_field ? getFile16BitBE(file) :
 754                          getFile8Bit(file));
 755   return chunk_size;
 756 }
 757
 758 static int LoadLevel_CONT(FILE *file, int chunk_size, struct LevelInfo *level)
 759 {
 760   int i, x, y;
 761   int header_size = 4;
 762   int content_size = MAX_ELEMENT_CONTENTS * 3 * 3;
 763   int chunk_size_expected = header_size + content_size;
 764
 765   /* Note: "chunk_size" was wrong before version 2.0 when elements are
 766      stored with 16-bit encoding (and should be twice as big then).
 767      Even worse, playfield data was stored 16-bit when only yamyam content
 768      contained 16-bit elements and vice versa. */
 769
 770   if (level->encoding_16bit_field && level->file_version >= FILE_VERSION_2_0)
 771     chunk_size_expected += content_size;
 772
 773   if (chunk_size_expected != chunk_size)
 774   {
 775     ReadUnusedBytesFromFile(file, chunk_size);
 776     return chunk_size_expected;
 777   }
 778
 779   getFile8Bit(file);
 780   level->num_yamyam_contents = getFile8Bit(file);
 781   getFile8Bit(file);
 782   getFile8Bit(file);
 783
 784   /* correct invalid number of content fields -- should never happen */
 785   if (level->num_yamyam_contents < 1 ||
 786       level->num_yamyam_contents > MAX_ELEMENT_CONTENTS)
 787     level->num_yamyam_contents = STD_ELEMENT_CONTENTS;
 788
 789   for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
 790     for (y = 0; y < 3; y++)
 791       for (x = 0; x < 3; x++)
 792         level->yamyam_content[i][x][y] =
 793           getMappedElement(level->encoding_16bit_field ?
 794                            getFile16BitBE(file) : getFile8Bit(file));
 795   return chunk_size;
 796 }
 797
 798 static int LoadLevel_CNT2(FILE *file, int chunk_size, struct LevelInfo *level)
 799 {
 800   int i, x, y;
 801   int element;
 802   int num_contents, content_xsize, content_ysize;
 803   int content_array[MAX_ELEMENT_CONTENTS][3][3];
 804
 805   element = getMappedElement(getFile16BitBE(file));
 806   num_contents = getFile8Bit(file);
 807   content_xsize = getFile8Bit(file);
 808   content_ysize = getFile8Bit(file);
 809
 810   ReadUnusedBytesFromFile(file, LEVEL_CHUNK_CNT2_UNUSED);
 811
 812   for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
 813     for (y = 0; y < 3; y++)
 814       for (x = 0; x < 3; x++)
 815         content_array[i][x][y] = getMappedElement(getFile16BitBE(file));
 816
 817   /* correct invalid number of content fields -- should never happen */
 818   if (num_contents < 1 || num_contents > MAX_ELEMENT_CONTENTS)
 819     num_contents = STD_ELEMENT_CONTENTS;
 820
 821   if (element == EL_YAMYAM)
 822   {
 823     level->num_yamyam_contents = num_contents;
 824
 825     for (i = 0; i < num_contents; i++)
 826       for (y = 0; y < 3; y++)
 827         for (x = 0; x < 3; x++)
 828           level->yamyam_content[i][x][y] = content_array[i][x][y];
 829   }
 830   else if (element == EL_BD_AMOEBA)
 831   {
 832     level->amoeba_content = content_array[0][0][0];
 833   }
 834   else
 835   {
 836     Error(ERR_WARN, "cannot load content for element '%d'", element);
 837   }
 838
 839   return chunk_size;
 840 }
 841
 842 static int LoadLevel_CNT3(FILE *file, int chunk_size, struct LevelInfo *level)
 843 {
 844   int i;
 845   int element;
 846   int envelope_nr;
 847   int envelope_len;
 848   int chunk_size_expected;
 849
 850   element = getMappedElement(getFile16BitBE(file));
 851   if (!IS_ENVELOPE(element))
 852     element = EL_ENVELOPE_1;
 853
 854   envelope_nr = element - EL_ENVELOPE_1;
 855
 856   envelope_len = getFile16BitBE(file);
 857
 858   level->envelope_xsize[envelope_nr] = getFile8Bit(file);
 859   level->envelope_ysize[envelope_nr] = getFile8Bit(file);
 860
 861   ReadUnusedBytesFromFile(file, LEVEL_CHUNK_CNT3_UNUSED);
 862
 863   chunk_size_expected = LEVEL_CHUNK_CNT3_SIZE(envelope_len);
 864   if (chunk_size_expected != chunk_size)
 865   {
 866     ReadUnusedBytesFromFile(file, chunk_size - LEVEL_CHUNK_CNT3_HEADER);
 867     return chunk_size_expected;
 868   }
 869
 870   for (i = 0; i < envelope_len; i++)
 871     level->envelope_text[envelope_nr][i] = getFile8Bit(file);
 872
 873   return chunk_size;
 874 }
 875
 876 static int LoadLevel_CUS1(FILE *file, int chunk_size, struct LevelInfo *level)
 877 {
 878   int num_changed_custom_elements = getFile16BitBE(file);
 879   int chunk_size_expected = 2 + num_changed_custom_elements * 6;
 880   int i;
 881
 882   if (chunk_size_expected != chunk_size)
 883   {
 884     ReadUnusedBytesFromFile(file, chunk_size - 2);
 885     return chunk_size_expected;
 886   }
 887
 888   for (i = 0; i < num_changed_custom_elements; i++)
 889   {
 890     int element = getFile16BitBE(file);
 891     int properties = getFile32BitBE(file);
 892
 893     if (IS_CUSTOM_ELEMENT(element))
 894       Properties[element][EP_BITFIELD_BASE] = properties;
 895     else
 896       Error(ERR_WARN, "invalid custom element number %d", element);
 897   }
 898
 899   return chunk_size;
 900 }
 901
 902 static int LoadLevel_CUS2(FILE *file, int chunk_size, struct LevelInfo *level)
 903 {
 904   int num_changed_custom_elements = getFile16BitBE(file);
 905   int chunk_size_expected = 2 + num_changed_custom_elements * 4;
 906   int i;
 907
 908   if (chunk_size_expected != chunk_size)
 909   {
 910     ReadUnusedBytesFromFile(file, chunk_size - 2);
 911     return chunk_size_expected;
 912   }
 913
 914   for (i = 0; i < num_changed_custom_elements; i++)
 915   {
 916     int element = getFile16BitBE(file);
 917     int custom_target_element = getFile16BitBE(file);
 918
 919     if (IS_CUSTOM_ELEMENT(element))
 920       element_info[element].change->target_element = custom_target_element;
 921     else
 922       Error(ERR_WARN, "invalid custom element number %d", element);
 923   }
 924
 925   return chunk_size;
 926 }
 927
 928 static int LoadLevel_CUS3(FILE *file, int chunk_size, struct LevelInfo *level)
 929 {
 930   int num_changed_custom_elements = getFile16BitBE(file);
 931   int chunk_size_expected = LEVEL_CHUNK_CUS3_SIZE(num_changed_custom_elements);
 932   int i, j, x, y;
 933
 934   if (chunk_size_expected != chunk_size)
 935   {
 936     ReadUnusedBytesFromFile(file, chunk_size - 2);
 937     return chunk_size_expected;
 938   }
 939
 940   for (i = 0; i < num_changed_custom_elements; i++)
 941   {
 942     int element = getFile16BitBE(file);
 943
 944     if (!IS_CUSTOM_ELEMENT(element))
 945     {
 946       Error(ERR_WARN, "invalid custom element number %d", element);
 947
 948       element = EL_INTERNAL_DUMMY;
 949     }
 950
 951     for (j = 0; j < MAX_ELEMENT_NAME_LEN; j++)
 952       element_info[element].description[j] = getFile8Bit(file);
 953     element_info[element].description[MAX_ELEMENT_NAME_LEN] = 0;
 954
 955     Properties[element][EP_BITFIELD_BASE] = getFile32BitBE(file);
 956
 957     /* some free bytes for future properties and padding */
 958     ReadUnusedBytesFromFile(file, 7);
 959
 960     element_info[element].use_gfx_element = getFile8Bit(file);
 961     element_info[element].gfx_element =
 962       getMappedElement(getFile16BitBE(file));
 963
 964     element_info[element].collect_score = getFile8Bit(file);
 965     element_info[element].collect_count = getFile8Bit(file);
 966
 967     element_info[element].push_delay_fixed = getFile16BitBE(file);
 968     element_info[element].push_delay_random = getFile16BitBE(file);
 969     element_info[element].move_delay_fixed = getFile16BitBE(file);
 970     element_info[element].move_delay_random = getFile16BitBE(file);
 971
 972     element_info[element].move_pattern = getFile16BitBE(file);
 973     element_info[element].move_direction_initial = getFile8Bit(file);
 974     element_info[element].move_stepsize = getFile8Bit(file);
 975
 976     for (y = 0; y < 3; y++)
 977       for (x = 0; x < 3; x++)
 978         element_info[element].content[x][y] =
 979           getMappedElement(getFile16BitBE(file));
 980
 981     element_info[element].change->events = getFile32BitBE(file);
 982
 983     element_info[element].change->target_element =
 984       getMappedElement(getFile16BitBE(file));
 985
 986     element_info[element].change->delay_fixed = getFile16BitBE(file);
 987     element_info[element].change->delay_random = getFile16BitBE(file);
 988     element_info[element].change->delay_frames = getFile16BitBE(file);
 989
 990     element_info[element].change->trigger_element =
 991       getMappedElement(getFile16BitBE(file));
 992
 993     element_info[element].change->explode = getFile8Bit(file);
 994     element_info[element].change->use_target_content = getFile8Bit(file);
 995     element_info[element].change->only_if_complete = getFile8Bit(file);
 996     element_info[element].change->use_random_replace = getFile8Bit(file);
 997
 998     element_info[element].change->random_percentage = getFile8Bit(file);
 999     element_info[element].change->replace_when = getFile8Bit(file);
1000
1001     for (y = 0; y < 3; y++)
1002       for (x = 0; x < 3; x++)
1003         element_info[element].change->target_content[x][y] =
1004           getMappedElement(getFile16BitBE(file));
1005
1006     element_info[element].slippery_type = getFile8Bit(file);
1007
1008     /* some free bytes for future properties and padding */
1009     ReadUnusedBytesFromFile(file, LEVEL_CPART_CUS3_UNUSED);
1010
1011     /* mark that this custom element has been modified */
1012     element_info[element].modified_settings = TRUE;
1013   }
1014
1015   return chunk_size;
1016 }
1017
1018 static int LoadLevel_CUS4(FILE *file, int chunk_size, struct LevelInfo *level)
1019 {
1020   struct ElementInfo *ei;
1021   int chunk_size_expected;
1022   int element;
1023   int i, x, y;
1024
1025   element = getFile16BitBE(file);
1026
1027   if (!IS_CUSTOM_ELEMENT(element))
1028   {
1029     Error(ERR_WARN, "invalid custom element number %d", element);
1030
1031     ReadUnusedBytesFromFile(file, chunk_size - 2);
1032     return chunk_size;
1033   }
1034
1035   ei = &element_info[element];
1036
1037   for (i = 0; i < MAX_ELEMENT_NAME_LEN; i++)
1038     ei->description[i] = getFile8Bit(file);
1039   ei->description[MAX_ELEMENT_NAME_LEN] = 0;
1040
1041   Properties[element][EP_BITFIELD_BASE] = getFile32BitBE(file);
1042   ReadUnusedBytesFromFile(file, 4);     /* reserved for more base properties */
1043
1044   ei->num_change_pages = getFile8Bit(file);
1045
1046   /* some free bytes for future base property values and padding */
1047   ReadUnusedBytesFromFile(file, 5);
1048
1049   chunk_size_expected = LEVEL_CHUNK_CUS4_SIZE(ei->num_change_pages);
1050   if (chunk_size_expected != chunk_size)
1051   {
1052     ReadUnusedBytesFromFile(file, chunk_size - 48);
1053     return chunk_size_expected;
1054   }
1055
1056   /* read custom property values */
1057
1058   ei->use_gfx_element = getFile8Bit(file);
1059   ei->gfx_element = getMappedElement(getFile16BitBE(file));
1060
1061   ei->collect_score = getFile8Bit(file);
1062   ei->collect_count = getFile8Bit(file);
1063
1064   ei->drop_delay_fixed = getFile8Bit(file);
1065   ei->push_delay_fixed = getFile8Bit(file);
1066   ei->drop_delay_random = getFile8Bit(file);
1067   ei->push_delay_random = getFile8Bit(file);
1068   ei->move_delay_fixed = getFile16BitBE(file);
1069   ei->move_delay_random = getFile16BitBE(file);
1070
1071   /* bits 0 - 15 of "move_pattern" ... */
1072   ei->move_pattern = getFile16BitBE(file);
1073   ei->move_direction_initial = getFile8Bit(file);
1074   ei->move_stepsize = getFile8Bit(file);
1075
1076   ei->slippery_type = getFile8Bit(file);
1077
1078   for (y = 0; y < 3; y++)
1079     for (x = 0; x < 3; x++)
1080       ei->content[x][y] = getMappedElement(getFile16BitBE(file));
1081
1082   ei->move_enter_element = getMappedElement(getFile16BitBE(file));
1083   ei->move_leave_element = getMappedElement(getFile16BitBE(file));
1084   ei->move_leave_type = getFile8Bit(file);
1085
1086   /* ... bits 16 - 31 of "move_pattern" (not nice, but downward compatible) */
1087   ei->move_pattern |= (getFile16BitBE(file) << 16);
1088
1089   ei->access_direction = getFile8Bit(file);
1090
1091   ei->explosion_delay = getFile8Bit(file);
1092   ei->ignition_delay = getFile8Bit(file);
1093   ei->explosion_type = getFile8Bit(file);
1094
1095   /* some free bytes for future custom property values and padding */
1096   ReadUnusedBytesFromFile(file, 1);
1097
1098   /* read change property values */
1099
1100   setElementChangePages(ei, ei->num_change_pages);
1101
1102   for (i = 0; i < ei->num_change_pages; i++)
1103   {
1104     struct ElementChangeInfo *change = &ei->change_page[i];
1105
1106     /* always start with reliable default values */
1107     setElementChangeInfoToDefaults(change);
1108
1109     change->events = getFile32BitBE(file);
1110
1111     change->target_element = getMappedElement(getFile16BitBE(file));
1112
1113     change->delay_fixed = getFile16BitBE(file);
1114     change->delay_random = getFile16BitBE(file);
1115     change->delay_frames = getFile16BitBE(file);
1116
1117     change->trigger_element = getMappedElement(getFile16BitBE(file));
1118
1119     change->explode = getFile8Bit(file);
1120     change->use_target_content = getFile8Bit(file);
1121     change->only_if_complete = getFile8Bit(file);
1122     change->use_random_replace = getFile8Bit(file);
1123
1124     change->random_percentage = getFile8Bit(file);
1125     change->replace_when = getFile8Bit(file);
1126
1127     for (y = 0; y < 3; y++)
1128       for (x = 0; x < 3; x++)
1129         change->target_content[x][y] = getMappedElement(getFile16BitBE(file));
1130
1131     change->can_change = getFile8Bit(file);
1132
1133     change->trigger_side = getFile8Bit(file);
1134
1135 #if 1
1136     change->trigger_player = getFile8Bit(file);
1137     change->trigger_page = getFile8Bit(file);
1138
1139     change->trigger_page = (change->trigger_page == CH_PAGE_ANY_FILE ?
1140                             CH_PAGE_ANY : (1 << change->trigger_page));
1141
1142     /* some free bytes for future change property values and padding */
1143     ReadUnusedBytesFromFile(file, 6);
1144
1145 #else
1146
1147     /* some free bytes for future change property values and padding */
1148     ReadUnusedBytesFromFile(file, 8);
1149 #endif
1150   }
1151
1152   /* mark this custom element as modified */
1153   ei->modified_settings = TRUE;
1154
1155   return chunk_size;
1156 }
1157
1158 static int LoadLevel_GRP1(FILE *file, int chunk_size, struct LevelInfo *level)
1159 {
1160   struct ElementInfo *ei;
1161   struct ElementGroupInfo *group;
1162   int element;
1163   int i;
1164
1165   element = getFile16BitBE(file);
1166
1167   if (!IS_GROUP_ELEMENT(element))
1168   {
1169     Error(ERR_WARN, "invalid group element number %d", element);
1170
1171     ReadUnusedBytesFromFile(file, chunk_size - 2);
1172     return chunk_size;
1173   }
1174
1175   ei = &element_info[element];
1176
1177   for (i = 0; i < MAX_ELEMENT_NAME_LEN; i++)
1178     ei->description[i] = getFile8Bit(file);
1179   ei->description[MAX_ELEMENT_NAME_LEN] = 0;
1180
1181   group = element_info[element].group;
1182
1183   group->num_elements = getFile8Bit(file);
1184
1185   ei->use_gfx_element = getFile8Bit(file);
1186   ei->gfx_element = getMappedElement(getFile16BitBE(file));
1187
1188   group->choice_mode = getFile8Bit(file);
1189
1190   /* some free bytes for future values and padding */
1191   ReadUnusedBytesFromFile(file, 3);
1192
1193   for (i = 0; i < MAX_ELEMENTS_IN_GROUP; i++)
1194     group->element[i] = getMappedElement(getFile16BitBE(file));
1195
1196   /* mark this group element as modified */
1197   element_info[element].modified_settings = TRUE;
1198
1199   return chunk_size;
1200 }
1201
1202 static void LoadLevelFromFileInfo_RND(struct LevelInfo *level,
1203                                       struct LevelFileInfo *level_file_info)
1204 {
1205   char *filename = level_file_info->filename;
1206   char cookie[MAX_LINE_LEN];
1207   char chunk_name[CHUNK_ID_LEN + 1];
1208   int chunk_size;
1209   FILE *file;
1210
1211   if (!(file = fopen(filename, MODE_READ)))
1212   {
1213     level->no_valid_file = TRUE;
1214
1215     if (level != &level_template)
1216       Error(ERR_WARN, "cannot read level '%s' -- using empty level", filename);
1217
1218     return;
1219   }
1220
1221   getFileChunkBE(file, chunk_name, NULL);
1222   if (strcmp(chunk_name, "RND1") == 0)
1223   {
1224     getFile32BitBE(file);               /* not used */
1225
1226     getFileChunkBE(file, chunk_name, NULL);
1227     if (strcmp(chunk_name, "CAVE") != 0)
1228     {
1229       level->no_valid_file = TRUE;
1230
1231       Error(ERR_WARN, "unknown format of level file '%s'", filename);
1232       fclose(file);
1233       return;
1234     }
1235   }
1236   else  /* check for pre-2.0 file format with cookie string */
1237   {
1238     strcpy(cookie, chunk_name);
1239     fgets(&cookie[4], MAX_LINE_LEN - 4, file);
1240     if (strlen(cookie) > 0 && cookie[strlen(cookie) - 1] == '\n')
1241       cookie[strlen(cookie) - 1] = '\0';
1242
1243     if (!checkCookieString(cookie, LEVEL_COOKIE_TMPL))
1244     {
1245       level->no_valid_file = TRUE;
1246
1247       Error(ERR_WARN, "unknown format of level file '%s'", filename);
1248       fclose(file);
1249       return;
1250     }
1251
1252     if ((level->file_version = getFileVersionFromCookieString(cookie)) == -1)
1253     {
1254       level->no_valid_file = TRUE;
1255
1256       Error(ERR_WARN, "unsupported version of level file '%s'", filename);
1257       fclose(file);
1258       return;
1259     }
1260
1261     /* pre-2.0 level files have no game version, so use file version here */
1262     level->game_version = level->file_version;
1263   }
1264
1265   if (level->file_version < FILE_VERSION_1_2)
1266   {
1267     /* level files from versions before 1.2.0 without chunk structure */
1268     LoadLevel_HEAD(file, LEVEL_HEADER_SIZE,             level);
1269     LoadLevel_BODY(file, level->fieldx * level->fieldy, level);
1270   }
1271   else
1272   {
1273     static struct
1274     {
1275       char *name;
1276       int size;
1277       int (*loader)(FILE *, int, struct LevelInfo *);
1278     }
1279     chunk_info[] =
1280     {
1281       { "VERS", FILE_VERS_CHUNK_SIZE,   LoadLevel_VERS },
1282       { "HEAD", LEVEL_HEADER_SIZE,      LoadLevel_HEAD },
1283       { "AUTH", MAX_LEVEL_AUTHOR_LEN,   LoadLevel_AUTH },
1284       { "BODY", -1,                     LoadLevel_BODY },
1285       { "CONT", -1,                     LoadLevel_CONT },
1286       { "CNT2", LEVEL_CHUNK_CNT2_SIZE,  LoadLevel_CNT2 },
1287       { "CNT3", -1,                     LoadLevel_CNT3 },
1288       { "CUS1", -1,                     LoadLevel_CUS1 },
1289       { "CUS2", -1,                     LoadLevel_CUS2 },
1290       { "CUS3", -1,                     LoadLevel_CUS3 },
1291       { "CUS4", -1,                     LoadLevel_CUS4 },
1292       { "GRP1", -1,                     LoadLevel_GRP1 },
1293       {  NULL,  0,                      NULL }
1294     };
1295
1296     while (getFileChunkBE(file, chunk_name, &chunk_size))
1297     {
1298       int i = 0;
1299
1300       while (chunk_info[i].name != NULL &&
1301              strcmp(chunk_name, chunk_info[i].name) != 0)
1302         i++;
1303
1304       if (chunk_info[i].name == NULL)
1305       {
1306         Error(ERR_WARN, "unknown chunk '%s' in level file '%s'",
1307               chunk_name, filename);
1308         ReadUnusedBytesFromFile(file, chunk_size);
1309       }
1310       else if (chunk_info[i].size != -1 &&
1311                chunk_info[i].size != chunk_size)
1312       {
1313         Error(ERR_WARN, "wrong size (%d) of chunk '%s' in level file '%s'",
1314               chunk_size, chunk_name, filename);
1315         ReadUnusedBytesFromFile(file, chunk_size);
1316       }
1317       else
1318       {
1319         /* call function to load this level chunk */
1320         int chunk_size_expected =
1321           (chunk_info[i].loader)(file, chunk_size, level);
1322
1323         /* the size of some chunks cannot be checked before reading other
1324            chunks first (like "HEAD" and "BODY") that contain some header
1325            information, so check them here */
1326         if (chunk_size_expected != chunk_size)
1327         {
1328           Error(ERR_WARN, "wrong size (%d) of chunk '%s' in level file '%s'",
1329                 chunk_size, chunk_name, filename);
1330         }
1331       }
1332     }
1333   }
1334
1335   fclose(file);
1336 }
1337
1338 /* ------------------------------------------------------------------------- */
1339 /* functions for loading EM level                                            */
1340 /* ------------------------------------------------------------------------- */
1341
1342 static int map_em_element_yam(int element)
1343 {
1344   switch (element)
1345   {
1346     case 0x00:  return EL_EMPTY;
1347     case 0x01:  return EL_EMERALD;
1348     case 0x02:  return EL_DIAMOND;
1349     case 0x03:  return EL_ROCK;
1350     case 0x04:  return EL_ROBOT;
1351     case 0x05:  return EL_SPACESHIP_UP;
1352     case 0x06:  return EL_BOMB;
1353     case 0x07:  return EL_BUG_UP;
1354     case 0x08:  return EL_AMOEBA_DROP;
1355     case 0x09:  return EL_NUT;
1356     case 0x0a:  return EL_YAMYAM;
1357     case 0x0b:  return EL_QUICKSAND_FULL;
1358     case 0x0c:  return EL_SAND;
1359     case 0x0d:  return EL_WALL_SLIPPERY;
1360     case 0x0e:  return EL_STEELWALL;
1361     case 0x0f:  return EL_WALL;
1362     case 0x10:  return EL_EM_KEY_1;
1363     case 0x11:  return EL_EM_KEY_2;
1364     case 0x12:  return EL_EM_KEY_4;
1365     case 0x13:  return EL_EM_KEY_3;
1366     case 0x14:  return EL_MAGIC_WALL;
1367     case 0x15:  return EL_ROBOT_WHEEL;
1368     case 0x16:  return EL_DYNAMITE;
1369
1370     case 0x17:  return EL_EM_KEY_1;                     /* EMC */
1371     case 0x18:  return EL_BUG_UP;                       /* EMC */
1372     case 0x1a:  return EL_DIAMOND;                      /* EMC */
1373     case 0x1b:  return EL_EMERALD;                      /* EMC */
1374     case 0x25:  return EL_NUT;                          /* EMC */
1375     case 0x80:  return EL_EMPTY;                        /* EMC */
1376     case 0x85:  return EL_EM_KEY_1;                     /* EMC */
1377     case 0x86:  return EL_EM_KEY_2;                     /* EMC */
1378     case 0x87:  return EL_EM_KEY_4;                     /* EMC */
1379     case 0x88:  return EL_EM_KEY_3;                     /* EMC */
1380     case 0x94:  return EL_QUICKSAND_EMPTY;              /* EMC */
1381     case 0x9a:  return EL_AMOEBA_WET;                   /* EMC */
1382     case 0xaf:  return EL_DYNAMITE;                     /* EMC */
1383     case 0xbd:  return EL_SAND;                         /* EMC */
1384
1385     default:
1386       Error(ERR_WARN, "invalid level element %d", element);
1387       return EL_UNKNOWN;
1388   }
1389 }
1390
1391 static int map_em_element_field(int element)
1392 {
1393   if (element >= 0xc8 && element <= 0xe1)
1394     return EL_CHAR_A + (element - 0xc8);
1395   else if (element >= 0xe2 && element <= 0xeb)
1396     return EL_CHAR_0 + (element - 0xe2);
1397
1398   switch (element)
1399   {
1400     case 0x00:  return EL_ROCK;
1401     case 0x01:  return EL_ROCK;                         /* EMC */
1402     case 0x02:  return EL_DIAMOND;
1403     case 0x03:  return EL_DIAMOND;
1404     case 0x04:  return EL_ROBOT;
1405     case 0x05:  return EL_ROBOT;                        /* EMC */
1406     case 0x06:  return EL_EMPTY_SPACE;                  /* EMC */
1407     case 0x07:  return EL_EMPTY_SPACE;                  /* EMC */
1408     case 0x08:  return EL_SPACESHIP_UP;
1409     case 0x09:  return EL_SPACESHIP_RIGHT;
1410     case 0x0a:  return EL_SPACESHIP_DOWN;
1411     case 0x0b:  return EL_SPACESHIP_LEFT;
1412     case 0x0c:  return EL_SPACESHIP_UP;
1413     case 0x0d:  return EL_SPACESHIP_RIGHT;
1414     case 0x0e:  return EL_SPACESHIP_DOWN;
1415     case 0x0f:  return EL_SPACESHIP_LEFT;
1416
1417     case 0x10:  return EL_BOMB;
1418     case 0x11:  return EL_BOMB;                         /* EMC */
1419     case 0x12:  return EL_EMERALD;
1420     case 0x13:  return EL_EMERALD;
1421     case 0x14:  return EL_BUG_UP;
1422     case 0x15:  return EL_BUG_RIGHT;
1423     case 0x16:  return EL_BUG_DOWN;
1424     case 0x17:  return EL_BUG_LEFT;
1425     case 0x18:  return EL_BUG_UP;
1426     case 0x19:  return EL_BUG_RIGHT;
1427     case 0x1a:  return EL_BUG_DOWN;
1428     case 0x1b:  return EL_BUG_LEFT;
1429     case 0x1c:  return EL_AMOEBA_DROP;
1430     case 0x1d:  return EL_AMOEBA_DROP;                  /* EMC */
1431     case 0x1e:  return EL_AMOEBA_DROP;                  /* EMC */
1432     case 0x1f:  return EL_AMOEBA_DROP;                  /* EMC */
1433
1434     case 0x20:  return EL_ROCK;
1435     case 0x21:  return EL_BOMB;                         /* EMC */
1436     case 0x22:  return EL_DIAMOND;                      /* EMC */
1437     case 0x23:  return EL_EMERALD;                      /* EMC */
1438     case 0x24:  return EL_MAGIC_WALL;
1439     case 0x25:  return EL_NUT;
1440     case 0x26:  return EL_NUT;                          /* EMC */
1441     case 0x27:  return EL_NUT;                          /* EMC */
1442
1443       /* looks like magic wheel, but is _always_ activated */
1444     case 0x28:  return EL_ROBOT_WHEEL;                  /* EMC */
1445
1446     case 0x29:  return EL_YAMYAM;       /* up */
1447     case 0x2a:  return EL_YAMYAM;       /* down */
1448     case 0x2b:  return EL_YAMYAM;       /* left */      /* EMC */
1449     case 0x2c:  return EL_YAMYAM;       /* right */     /* EMC */
1450     case 0x2d:  return EL_QUICKSAND_FULL;
1451     case 0x2e:  return EL_EMPTY_SPACE;                  /* EMC */
1452     case 0x2f:  return EL_EMPTY_SPACE;                  /* EMC */
1453
1454     case 0x30:  return EL_EMPTY_SPACE;                  /* EMC */
1455     case 0x31:  return EL_SAND;                         /* EMC */
1456     case 0x32:  return EL_SAND;                         /* EMC */
1457     case 0x33:  return EL_SAND;                         /* EMC */
1458     case 0x34:  return EL_QUICKSAND_FULL;               /* EMC */
1459     case 0x35:  return EL_QUICKSAND_FULL;               /* EMC */
1460     case 0x36:  return EL_QUICKSAND_FULL;               /* EMC */
1461     case 0x37:  return EL_SAND;                         /* EMC */
1462     case 0x38:  return EL_ROCK;                         /* EMC */
1463     case 0x39:  return EL_EXPANDABLE_WALL_HORIZONTAL;   /* EMC */
1464     case 0x3a:  return EL_EXPANDABLE_WALL_VERTICAL;     /* EMC */
1465     case 0x3b:  return EL_DYNAMITE_ACTIVE;      /* 1 */
1466     case 0x3c:  return EL_DYNAMITE_ACTIVE;      /* 2 */
1467     case 0x3d:  return EL_DYNAMITE_ACTIVE;      /* 3 */
1468     case 0x3e:  return EL_DYNAMITE_ACTIVE;      /* 4 */
1469     case 0x3f:  return EL_ACID_POOL_BOTTOM;
1470
1471     case 0x40:  return EL_EXIT_OPEN;    /* 1 */
1472     case 0x41:  return EL_EXIT_OPEN;    /* 2 */
1473     case 0x42:  return EL_EXIT_OPEN;    /* 3 */
1474     case 0x43:  return EL_BALLOON;                      /* EMC */
1475     case 0x44:  return EL_UNKNOWN;                      /* EMC ("plant") */
1476     case 0x45:  return EL_SPRING;                       /* EMC */
1477     case 0x46:  return EL_SPRING;       /* falling */   /* EMC */
1478     case 0x47:  return EL_SPRING;       /* left */      /* EMC */
1479     case 0x48:  return EL_SPRING;       /* right */     /* EMC */
1480     case 0x49:  return EL_UNKNOWN;                      /* EMC ("ball 1") */
1481     case 0x4a:  return EL_UNKNOWN;                      /* EMC ("ball 2") */
1482     case 0x4b:  return EL_UNKNOWN;                      /* EMC ("android") */
1483     case 0x4c:  return EL_EMPTY_SPACE;                  /* EMC */
1484     case 0x4d:  return EL_UNKNOWN;                      /* EMC ("android") */
1485     case 0x4e:  return EL_INVISIBLE_WALL;               /* EMC (? "android") */
1486     case 0x4f:  return EL_UNKNOWN;                      /* EMC ("android") */
1487
1488     case 0x50:  return EL_UNKNOWN;                      /* EMC ("android") */
1489     case 0x51:  return EL_UNKNOWN;                      /* EMC ("android") */
1490     case 0x52:  return EL_UNKNOWN;                      /* EMC ("android") */
1491     case 0x53:  return EL_UNKNOWN;                      /* EMC ("android") */
1492     case 0x54:  return EL_UNKNOWN;                      /* EMC ("android") */
1493     case 0x55:  return EL_EMPTY_SPACE;                  /* EMC */
1494     case 0x56:  return EL_EMPTY_SPACE;                  /* EMC */
1495     case 0x57:  return EL_EMPTY_SPACE;                  /* EMC */
1496     case 0x58:  return EL_EMPTY_SPACE;                  /* EMC */
1497     case 0x59:  return EL_EMPTY_SPACE;                  /* EMC */
1498     case 0x5a:  return EL_EMPTY_SPACE;                  /* EMC */
1499     case 0x5b:  return EL_EMPTY_SPACE;                  /* EMC */
1500     case 0x5c:  return EL_EMPTY_SPACE;                  /* EMC */
1501     case 0x5d:  return EL_EMPTY_SPACE;                  /* EMC */
1502     case 0x5e:  return EL_EMPTY_SPACE;                  /* EMC */
1503     case 0x5f:  return EL_EMPTY_SPACE;                  /* EMC */
1504
1505     case 0x60:  return EL_EMPTY_SPACE;                  /* EMC */
1506     case 0x61:  return EL_EMPTY_SPACE;                  /* EMC */
1507     case 0x62:  return EL_EMPTY_SPACE;                  /* EMC */
1508     case 0x63:  return EL_SPRING;       /* left */      /* EMC */
1509     case 0x64:  return EL_SPRING;       /* right */     /* EMC */
1510     case 0x65:  return EL_ACID;         /* 1 */         /* EMC */
1511     case 0x66:  return EL_ACID;         /* 2 */         /* EMC */
1512     case 0x67:  return EL_ACID;         /* 3 */         /* EMC */
1513     case 0x68:  return EL_ACID;         /* 4 */         /* EMC */
1514     case 0x69:  return EL_ACID;         /* 5 */         /* EMC */
1515     case 0x6a:  return EL_ACID;         /* 6 */         /* EMC */
1516     case 0x6b:  return EL_ACID;         /* 7 */         /* EMC */
1517     case 0x6c:  return EL_ACID;         /* 8 */         /* EMC */
1518     case 0x6d:  return EL_EMPTY_SPACE;                  /* EMC */
1519     case 0x6e:  return EL_EMPTY_SPACE;                  /* EMC */
1520     case 0x6f:  return EL_EMPTY_SPACE;                  /* EMC */
1521
1522     case 0x70:  return EL_EMPTY_SPACE;                  /* EMC */
1523     case 0x71:  return EL_EMPTY_SPACE;                  /* EMC */
1524     case 0x72:  return EL_NUT;          /* left */      /* EMC */
1525     case 0x73:  return EL_SAND;                         /* EMC (? "nut") */
1526     case 0x74:  return EL_STEELWALL;
1527     case 0x75:  return EL_EMPTY_SPACE;                  /* EMC */
1528     case 0x76:  return EL_EMPTY_SPACE;                  /* EMC */
1529     case 0x77:  return EL_BOMB;         /* left */      /* EMC */
1530     case 0x78:  return EL_BOMB;         /* right */     /* EMC */
1531     case 0x79:  return EL_ROCK;         /* left */      /* EMC */
1532     case 0x7a:  return EL_ROCK;         /* right */     /* EMC */
1533     case 0x7b:  return EL_ACID;                         /* (? EMC "blank") */
1534     case 0x7c:  return EL_EMPTY_SPACE;                  /* EMC */
1535     case 0x7d:  return EL_EMPTY_SPACE;                  /* EMC */
1536     case 0x7e:  return EL_EMPTY_SPACE;                  /* EMC */
1537     case 0x7f:  return EL_EMPTY_SPACE;                  /* EMC */
1538
1539     case 0x80:  return EL_EMPTY;
1540     case 0x81:  return EL_WALL_SLIPPERY;
1541     case 0x82:  return EL_SAND;
1542     case 0x83:  return EL_STEELWALL;
1543     case 0x84:  return EL_WALL;
1544     case 0x85:  return EL_EM_KEY_1;
1545     case 0x86:  return EL_EM_KEY_2;
1546     case 0x87:  return EL_EM_KEY_4;
1547     case 0x88:  return EL_EM_KEY_3;
1548     case 0x89:  return EL_EM_GATE_1;
1549     case 0x8a:  return EL_EM_GATE_2;
1550     case 0x8b:  return EL_EM_GATE_4;
1551     case 0x8c:  return EL_EM_GATE_3;
1552     case 0x8d:  return EL_INVISIBLE_WALL;               /* EMC (? "dripper") */
1553     case 0x8e:  return EL_EM_GATE_1_GRAY;
1554     case 0x8f:  return EL_EM_GATE_2_GRAY;
1555
1556     case 0x90:  return EL_EM_GATE_4_GRAY;
1557     case 0x91:  return EL_EM_GATE_3_GRAY;
1558     case 0x92:  return EL_MAGIC_WALL;
1559     case 0x93:  return EL_ROBOT_WHEEL;
1560     case 0x94:  return EL_QUICKSAND_EMPTY;              /* (? EMC "sand") */
1561     case 0x95:  return EL_ACID_POOL_TOPLEFT;
1562     case 0x96:  return EL_ACID_POOL_TOPRIGHT;
1563     case 0x97:  return EL_ACID_POOL_BOTTOMLEFT;
1564     case 0x98:  return EL_ACID_POOL_BOTTOMRIGHT;
1565     case 0x99:  return EL_ACID;                 /* (? EMC "fake blank") */
1566     case 0x9a:  return EL_AMOEBA_DEAD;          /* 1 */
1567     case 0x9b:  return EL_AMOEBA_DEAD;          /* 2 */
1568     case 0x9c:  return EL_AMOEBA_DEAD;          /* 3 */
1569     case 0x9d:  return EL_AMOEBA_DEAD;          /* 4 */
1570     case 0x9e:  return EL_EXIT_CLOSED;
1571     case 0x9f:  return EL_CHAR_LESS;            /* arrow left */
1572
1573       /* looks like normal sand, but behaves like wall */
1574     case 0xa0:  return EL_UNKNOWN;              /* EMC ("fake grass") */
1575     case 0xa1:  return EL_UNKNOWN;              /* EMC ("lenses") */
1576     case 0xa2:  return EL_UNKNOWN;              /* EMC ("magnify") */
1577     case 0xa3:  return EL_UNKNOWN;              /* EMC ("fake blank") */
1578     case 0xa4:  return EL_UNKNOWN;              /* EMC ("fake grass") */
1579     case 0xa5:  return EL_UNKNOWN;              /* EMC ("switch") */
1580     case 0xa6:  return EL_UNKNOWN;              /* EMC ("switch") */
1581     case 0xa7:  return EL_EMPTY_SPACE;                  /* EMC */
1582     case 0xa8:  return EL_EMC_WALL_1;                   /* EMC ("decor 8") */
1583     case 0xa9:  return EL_EMC_WALL_2;                   /* EMC ("decor 9") */
1584     case 0xaa:  return EL_EMC_WALL_3;                   /* EMC ("decor 10") */
1585     case 0xab:  return EL_EMC_WALL_7;                   /* EMC ("decor 5") */
1586     case 0xac:  return EL_CHAR_COMMA;                   /* EMC */
1587     case 0xad:  return EL_CHAR_QUOTEDBL;                /* EMC */
1588     case 0xae:  return EL_CHAR_MINUS;                   /* EMC */
1589     case 0xaf:  return EL_DYNAMITE;
1590
1591     case 0xb0:  return EL_EMC_STEELWALL_1;              /* EMC ("steel 3") */
1592     case 0xb1:  return EL_EMC_WALL_8;                   /* EMC ("decor 6") */
1593     case 0xb2:  return EL_UNKNOWN;                      /* EMC ("decor 7") */
1594     case 0xb3:  return EL_STEELWALL;            /* 2 */ /* EMC */
1595     case 0xb4:  return EL_WALL_SLIPPERY;        /* 2 */ /* EMC */
1596     case 0xb5:  return EL_EMC_WALL_6;                   /* EMC ("decor 2") */
1597     case 0xb6:  return EL_EMC_WALL_5;                   /* EMC ("decor 4") */
1598     case 0xb7:  return EL_EMC_WALL_4;                   /* EMC ("decor 3") */
1599     case 0xb8:  return EL_BALLOON_SWITCH_ANY;           /* EMC */
1600     case 0xb9:  return EL_BALLOON_SWITCH_RIGHT;         /* EMC */
1601     case 0xba:  return EL_BALLOON_SWITCH_DOWN;          /* EMC */
1602     case 0xbb:  return EL_BALLOON_SWITCH_LEFT;          /* EMC */
1603     case 0xbc:  return EL_BALLOON_SWITCH_UP;            /* EMC */
1604     case 0xbd:  return EL_SAND;                         /* EMC ("dirt") */
1605     case 0xbe:  return EL_UNKNOWN;                      /* EMC ("plant") */
1606     case 0xbf:  return EL_UNKNOWN;                      /* EMC ("key 5") */
1607
1608     case 0xc0:  return EL_UNKNOWN;                      /* EMC ("key 6") */
1609     case 0xc1:  return EL_UNKNOWN;                      /* EMC ("key 7") */
1610     case 0xc2:  return EL_UNKNOWN;                      /* EMC ("key 8") */
1611     case 0xc3:  return EL_UNKNOWN;                      /* EMC ("door 5") */
1612     case 0xc4:  return EL_UNKNOWN;                      /* EMC ("door 6") */
1613     case 0xc5:  return EL_UNKNOWN;                      /* EMC ("door 7") */
1614     case 0xc6:  return EL_UNKNOWN;                      /* EMC ("door 8") */
1615     case 0xc7:  return EL_UNKNOWN;                      /* EMC ("bumper") */
1616
1617       /* characters: see above */
1618
1619     case 0xec:  return EL_CHAR_PERIOD;
1620     case 0xed:  return EL_CHAR_EXCLAM;
1621     case 0xee:  return EL_CHAR_COLON;
1622     case 0xef:  return EL_CHAR_QUESTION;
1623
1624     case 0xf0:  return EL_CHAR_GREATER;                 /* arrow right */
1625     case 0xf1:  return EL_CHAR_COPYRIGHT;               /* EMC: "decor 1" */
1626     case 0xf2:  return EL_UNKNOWN;              /* EMC ("fake door 5") */
1627     case 0xf3:  return EL_UNKNOWN;              /* EMC ("fake door 6") */
1628     case 0xf4:  return EL_UNKNOWN;              /* EMC ("fake door 7") */
1629     case 0xf5:  return EL_UNKNOWN;              /* EMC ("fake door 8") */
1630     case 0xf6:  return EL_EMPTY_SPACE;                  /* EMC */
1631     case 0xf7:  return EL_EMPTY_SPACE;                  /* EMC */
1632
1633     case 0xf8:  return EL_EMPTY_SPACE;                  /* EMC */
1634     case 0xf9:  return EL_EMPTY_SPACE;                  /* EMC */
1635     case 0xfa:  return EL_EMPTY_SPACE;                  /* EMC */
1636     case 0xfb:  return EL_EMPTY_SPACE;                  /* EMC */
1637     case 0xfc:  return EL_EMPTY_SPACE;                  /* EMC */
1638     case 0xfd:  return EL_EMPTY_SPACE;                  /* EMC */
1639
1640     case 0xfe:  return EL_PLAYER_1;                     /* EMC: "blank" */
1641     case 0xff:  return EL_PLAYER_2;                     /* EMC: "blank" */
1642
1643     default:
1644       /* should never happen (all 8-bit value cases should be handled) */
1645       Error(ERR_WARN, "invalid level element %d", element);
1646       return EL_UNKNOWN;
1647   }
1648 }
1649
1650 #define EM_LEVEL_SIZE                   2106
1651 #define EM_LEVEL_XSIZE                  64
1652 #define EM_LEVEL_YSIZE                  32
1653
1654 static void LoadLevelFromFileInfo_EM(struct LevelInfo *level,
1655                                      struct LevelFileInfo *level_file_info)
1656 {
1657   char *filename = level_file_info->filename;
1658   FILE *file;
1659   unsigned char leveldata[EM_LEVEL_SIZE];
1660   unsigned char *header = &leveldata[EM_LEVEL_XSIZE * EM_LEVEL_YSIZE];
1661   unsigned char code0 = 0x65;
1662   unsigned char code1 = 0x11;
1663   boolean level_is_crypted = FALSE;
1664   int nr = level_file_info->nr;
1665   int i, x, y;
1666
1667   if (!(file = fopen(filename, MODE_READ)))
1668   {
1669     level->no_valid_file = TRUE;
1670
1671     Error(ERR_WARN, "cannot read level '%s' -- using empty level", filename);
1672
1673     return;
1674   }
1675
1676   for(i = 0; i < EM_LEVEL_SIZE; i++)
1677     leveldata[i] = fgetc(file);
1678
1679   fclose(file);
1680
1681   /* check if level data is crypted by testing against known starting bytes
1682      of the few existing crypted level files (from Emerald Mine 1 + 2) */
1683
1684   if ((leveldata[0] == 0xf1 ||
1685        leveldata[0] == 0xf5) && leveldata[2] == 0xe7 && leveldata[3] == 0xee)
1686   {
1687     level_is_crypted = TRUE;
1688
1689     if (leveldata[0] == 0xf5)   /* error in crypted Emerald Mine 2 levels */
1690       leveldata[0] = 0xf1;
1691   }
1692
1693   if (level_is_crypted)         /* decode crypted level data */
1694   {
1695     for(i = 0; i < EM_LEVEL_SIZE; i++)
1696     {
1697       leveldata[i] ^= code0;
1698       leveldata[i] -= code1;
1699
1700       code0  = (code0 + 7) & 0xff;
1701     }
1702   }
1703
1704   level->fieldx = EM_LEVEL_XSIZE;
1705   level->fieldy = EM_LEVEL_YSIZE;
1706
1707   level->time           = header[46] * 10;
1708   level->gems_needed    = header[47];
1709
1710   /* The original Emerald Mine levels have their level number stored
1711      at the second byte of the level file...
1712      Do not trust this information at other level files, e.g. EMC,
1713      but correct it anyway (normally the first row is completely
1714      steel wall, so the correction does not hurt anyway). */
1715
1716   if (leveldata[1] == nr)
1717     leveldata[1] = leveldata[2];        /* correct level number field */
1718
1719   sprintf(level->name, "Level %d", nr);         /* set level name */
1720
1721   level->score[SC_EMERALD]      = header[36];
1722   level->score[SC_DIAMOND]      = header[37];
1723   level->score[SC_ROBOT]        = header[38];
1724   level->score[SC_SPACESHIP]    = header[39];
1725   level->score[SC_BUG]          = header[40];
1726   level->score[SC_YAMYAM]       = header[41];
1727   level->score[SC_NUT]          = header[42];
1728   level->score[SC_DYNAMITE]     = header[43];
1729   level->score[SC_TIME_BONUS]   = header[44];
1730
1731   level->num_yamyam_contents = 4;
1732
1733   for(i = 0; i < level->num_yamyam_contents; i++)
1734     for(y = 0; y < 3; y++)
1735       for(x = 0; x < 3; x++)
1736         level->yamyam_content[i][x][y] =
1737           map_em_element_yam(header[i * 9 + y * 3 + x]);
1738
1739   level->amoeba_speed           = (header[52] * 256 + header[53]) % 256;
1740   level->time_magic_wall        = (header[54] * 256 + header[55]) * 16 / 100;
1741   level->time_wheel             = (header[56] * 256 + header[57]) * 16 / 100;
1742   level->amoeba_content         = EL_DIAMOND;
1743
1744   for (y = 0; y < level->fieldy; y++) for (x = 0; x < level->fieldx; x++)
1745   {
1746     int new_element = map_em_element_field(leveldata[y * EM_LEVEL_XSIZE + x]);
1747
1748     if (new_element == EL_AMOEBA_DEAD && level->amoeba_speed)
1749       new_element = EL_AMOEBA_WET;
1750
1751     level->field[x][y] = new_element;
1752   }
1753
1754   x = (header[48] * 256 + header[49]) % EM_LEVEL_XSIZE;
1755   y = (header[48] * 256 + header[49]) / EM_LEVEL_XSIZE;
1756   level->field[x][y] = EL_PLAYER_1;
1757
1758   x = (header[50] * 256 + header[51]) % EM_LEVEL_XSIZE;
1759   y = (header[50] * 256 + header[51]) / EM_LEVEL_XSIZE;
1760   level->field[x][y] = EL_PLAYER_2;
1761 }
1762
1763 /* ------------------------------------------------------------------------- */
1764 /* functions for loading SP level                                            */
1765 /* ------------------------------------------------------------------------- */
1766
1767 #define NUM_SUPAPLEX_LEVELS_PER_PACKAGE 111
1768 #define SP_LEVEL_SIZE                   1536
1769 #define SP_LEVEL_XSIZE                  60
1770 #define SP_LEVEL_YSIZE                  24
1771 #define SP_LEVEL_NAME_LEN               23
1772
1773 static void LoadLevelFromFileStream_SP(FILE *file, struct LevelInfo *level,
1774                                        int nr)
1775 {
1776   int num_special_ports;
1777   int i, x, y;
1778
1779   /* for details of the Supaplex level format, see Herman Perk's Supaplex
1780      documentation file "SPFIX63.DOC" from his Supaplex "SpeedFix" package */
1781
1782   /* read level body (width * height == 60 * 24 tiles == 1440 bytes) */
1783   for (y = 0; y < SP_LEVEL_YSIZE; y++)
1784   {
1785     for (x = 0; x < SP_LEVEL_XSIZE; x++)
1786     {
1787       int element_old = fgetc(file);
1788       int element_new;
1789
1790       if (element_old <= 0x27)
1791         element_new = getMappedElement(EL_SP_START + element_old);
1792       else if (element_old == 0x28)
1793         element_new = EL_INVISIBLE_WALL;
1794       else
1795       {
1796         Error(ERR_WARN, "in level %d, at position %d, %d:", nr, x, y);
1797         Error(ERR_WARN, "invalid level element %d", element_old);
1798
1799         element_new = EL_UNKNOWN;
1800       }
1801
1802       level->field[x][y] = element_new;
1803     }
1804   }
1805
1806   ReadUnusedBytesFromFile(file, 4);     /* (not used by Supaplex engine) */
1807
1808   /* initial gravity: 1 == "on", anything else (0) == "off" */
1809   level->initial_gravity = (fgetc(file) == 1 ? TRUE : FALSE);
1810
1811   ReadUnusedBytesFromFile(file, 1);     /* (not used by Supaplex engine) */
1812
1813   /* level title in uppercase letters, padded with dashes ("-") (23 bytes) */
1814   for (i = 0; i < SP_LEVEL_NAME_LEN; i++)
1815     level->name[i] = fgetc(file);
1816   level->name[SP_LEVEL_NAME_LEN] = '\0';
1817
1818   /* initial "freeze zonks": 2 == "on", anything else (0, 1) == "off" */
1819   ReadUnusedBytesFromFile(file, 1);     /* (not used by R'n'D engine) */
1820
1821   /* number of infotrons needed; 0 means that Supaplex will count the total
1822      amount of infotrons in the level and use the low byte of that number
1823      (a multiple of 256 infotrons will result in "0 infotrons needed"!) */
1824   level->gems_needed = fgetc(file);
1825
1826   /* number of special ("gravity") port entries below (maximum 10 allowed) */
1827   num_special_ports = fgetc(file);
1828
1829   /* database of properties of up to 10 special ports (6 bytes per port) */
1830   for (i = 0; i < 10; i++)
1831   {
1832     int port_location, port_x, port_y, port_element;
1833     int gravity;
1834
1835     /* high and low byte of the location of a special port; if (x, y) are the
1836        coordinates of a port in the field and (0, 0) is the top-left corner,
1837        the 16 bit value here calculates as 2 * (x + (y * 60)) (this is twice
1838        of what may be expected: Supaplex works with a game field in memory
1839        which is 2 bytes per tile) */
1840     port_location = getFile16BitBE(file);
1841
1842     /* change gravity: 1 == "turn on", anything else (0) == "turn off" */
1843     gravity = fgetc(file);
1844
1845     /* "freeze zonks": 2 == "turn on", anything else (0, 1) == "turn off" */
1846     ReadUnusedBytesFromFile(file, 1);   /* (not used by R'n'D engine) */
1847
1848     /* "freeze enemies": 1 == "turn on", anything else (0) == "turn off" */
1849     ReadUnusedBytesFromFile(file, 1);   /* (not used by R'n'D engine) */
1850
1851     ReadUnusedBytesFromFile(file, 1);   /* (not used by Supaplex engine) */
1852
1853     if (i >= num_special_ports)
1854       continue;
1855
1856     port_x = (port_location / 2) % SP_LEVEL_XSIZE;
1857     port_y = (port_location / 2) / SP_LEVEL_XSIZE;
1858
1859     if (port_x < 0 || port_x >= SP_LEVEL_XSIZE ||
1860         port_y < 0 || port_y >= SP_LEVEL_YSIZE)
1861     {
1862       Error(ERR_WARN, "special port position (%d, %d) out of bounds",
1863             port_x, port_y);
1864
1865       continue;
1866     }
1867
1868     port_element = level->field[port_x][port_y];
1869
1870     if (port_element < EL_SP_GRAVITY_PORT_RIGHT ||
1871         port_element > EL_SP_GRAVITY_PORT_UP)
1872     {
1873       Error(ERR_WARN, "no special port at position (%d, %d)", port_x, port_y);
1874
1875       continue;
1876     }
1877
1878     /* change previous (wrong) gravity inverting special port to either
1879        gravity enabling special port or gravity disabling special port */
1880     level->field[port_x][port_y] +=
1881       (gravity == 1 ? EL_SP_GRAVITY_ON_PORT_RIGHT :
1882        EL_SP_GRAVITY_OFF_PORT_RIGHT) - EL_SP_GRAVITY_PORT_RIGHT;
1883   }
1884
1885   ReadUnusedBytesFromFile(file, 4);     /* (not used by Supaplex engine) */
1886
1887   /* change special gravity ports without database entries to normal ports */
1888   for (y = 0; y < SP_LEVEL_YSIZE; y++)
1889     for (x = 0; x < SP_LEVEL_XSIZE; x++)
1890       if (level->field[x][y] >= EL_SP_GRAVITY_PORT_RIGHT &&
1891           level->field[x][y] <= EL_SP_GRAVITY_PORT_UP)
1892         level->field[x][y] += EL_SP_PORT_RIGHT - EL_SP_GRAVITY_PORT_RIGHT;
1893
1894   /* auto-determine number of infotrons if it was stored as "0" -- see above */
1895   if (level->gems_needed == 0)
1896   {
1897     for (y = 0; y < SP_LEVEL_YSIZE; y++)
1898       for (x = 0; x < SP_LEVEL_XSIZE; x++)
1899         if (level->field[x][y] == EL_SP_INFOTRON)
1900           level->gems_needed++;
1901
1902     level->gems_needed &= 0xff;         /* only use low byte -- see above */
1903   }
1904
1905   level->fieldx = SP_LEVEL_XSIZE;
1906   level->fieldy = SP_LEVEL_YSIZE;
1907
1908   level->time = 0;                      /* no time limit */
1909   level->amoeba_speed = 0;
1910   level->time_magic_wall = 0;
1911   level->time_wheel = 0;
1912   level->amoeba_content = EL_EMPTY;
1913
1914   for(i = 0; i < LEVEL_SCORE_ELEMENTS; i++)
1915     level->score[i] = 0;                /* !!! CORRECT THIS !!! */
1916
1917   /* there are no yamyams in supaplex levels */
1918   for(i = 0; i < level->num_yamyam_contents; i++)
1919     for(y = 0; y < 3; y++)
1920       for(x = 0; x < 3; x++)
1921         level->yamyam_content[i][x][y] = EL_EMPTY;
1922 }
1923
1924 static void LoadLevelFromFileInfo_SP(struct LevelInfo *level,
1925                                      struct LevelFileInfo *level_file_info)
1926 {
1927   char *filename = level_file_info->filename;
1928   FILE *file;
1929   int nr = level_file_info->nr - leveldir_current->first_level;
1930   int i, l, x, y;
1931   char name_first, name_last;
1932   struct LevelInfo multipart_level;
1933   int multipart_xpos, multipart_ypos;
1934   boolean is_multipart_level;
1935   boolean is_first_part;
1936   boolean reading_multipart_level = FALSE;
1937   boolean use_empty_level = FALSE;
1938
1939   if (!(file = fopen(filename, MODE_READ)))
1940   {
1941     level->no_valid_file = TRUE;
1942
1943     Error(ERR_WARN, "cannot read level '%s' -- using empty level", filename);
1944
1945     return;
1946   }
1947
1948   /* position file stream to the requested level inside the level package */
1949   if (fseek(file, nr * SP_LEVEL_SIZE, SEEK_SET) != 0)
1950   {
1951     level->no_valid_file = TRUE;
1952
1953     Error(ERR_WARN, "cannot fseek level '%s' -- using empty level", filename);
1954
1955     return;
1956   }
1957
1958   /* there exist Supaplex level package files with multi-part levels which
1959      can be detected as follows: instead of leading and trailing dashes ('-')
1960      to pad the level name, they have leading and trailing numbers which are
1961      the x and y coordinations of the current part of the multi-part level;
1962      if there are '?' characters instead of numbers on the left or right side
1963      of the level name, the multi-part level consists of only horizontal or
1964      vertical parts */
1965
1966   for (l = nr; l < NUM_SUPAPLEX_LEVELS_PER_PACKAGE; l++)
1967   {
1968     LoadLevelFromFileStream_SP(file, level, l);
1969
1970     /* check if this level is a part of a bigger multi-part level */
1971
1972     name_first = level->name[0];
1973     name_last  = level->name[SP_LEVEL_NAME_LEN - 1];
1974
1975     is_multipart_level =
1976       ((name_first == '?' || (name_first >= '0' && name_first <= '9')) &&
1977        (name_last  == '?' || (name_last  >= '0' && name_last  <= '9')));
1978
1979     is_first_part =
1980       ((name_first == '?' || name_first == '1') &&
1981        (name_last  == '?' || name_last  == '1'));
1982
1983     /* correct leading multipart level meta information in level name */
1984     for (i = 0; i < SP_LEVEL_NAME_LEN && level->name[i] == name_first; i++)
1985       level->name[i] = '-';
1986
1987     /* correct trailing multipart level meta information in level name */
1988     for (i = SP_LEVEL_NAME_LEN - 1; i>=0 && level->name[i] == name_last; i--)
1989       level->name[i] = '-';
1990
1991     /* ---------- check for normal single level ---------- */
1992
1993     if (!reading_multipart_level && !is_multipart_level)
1994     {
1995       /* the current level is simply a normal single-part level, and we are
1996          not reading a multi-part level yet, so return the level as it is */
1997
1998       break;
1999     }
2000
2001     /* ---------- check for empty level (unused multi-part) ---------- */
2002
2003     if (!reading_multipart_level && is_multipart_level && !is_first_part)
2004     {
2005       /* this is a part of a multi-part level, but not the first part
2006          (and we are not already reading parts of a multi-part level);
2007          in this case, use an empty level instead of the single part */
2008
2009       use_empty_level = TRUE;
2010
2011       break;
2012     }
2013
2014     /* ---------- check for finished multi-part level ---------- */
2015
2016     if (reading_multipart_level &&
2017         (!is_multipart_level ||
2018          strcmp(level->name, multipart_level.name) != 0))
2019     {
2020       /* we are already reading parts of a multi-part level, but this level is
2021          either not a multi-part level, or a part of a different multi-part
2022          level; in both cases, the multi-part level seems to be complete */
2023
2024       break;
2025     }
2026
2027     /* ---------- here we have one part of a multi-part level ---------- */
2028
2029     reading_multipart_level = TRUE;
2030
2031     if (is_first_part)  /* start with first part of new multi-part level */
2032     {
2033       /* copy level info structure from first part */
2034       multipart_level = *level;
2035
2036       /* clear playfield of new multi-part level */
2037       for (y = 0; y < MAX_LEV_FIELDY; y++)
2038         for (x = 0; x < MAX_LEV_FIELDX; x++)
2039           multipart_level.field[x][y] = EL_EMPTY;
2040     }
2041
2042     if (name_first == '?')
2043       name_first = '1';
2044     if (name_last == '?')
2045       name_last = '1';
2046
2047     multipart_xpos = (int)(name_first - '0');
2048     multipart_ypos = (int)(name_last  - '0');
2049
2050 #if 0
2051     printf("----------> part (%d/%d) of multi-part level '%s'\n",
2052            multipart_xpos, multipart_ypos, multipart_level.name);
2053 #endif
2054
2055     if (multipart_xpos * SP_LEVEL_XSIZE > MAX_LEV_FIELDX ||
2056         multipart_ypos * SP_LEVEL_YSIZE > MAX_LEV_FIELDY)
2057     {
2058       Error(ERR_WARN, "multi-part level is too big -- ignoring part of it");
2059
2060       break;
2061     }
2062
2063     multipart_level.fieldx = MAX(multipart_level.fieldx,
2064                                  multipart_xpos * SP_LEVEL_XSIZE);
2065     multipart_level.fieldy = MAX(multipart_level.fieldy,
2066                                  multipart_ypos * SP_LEVEL_YSIZE);
2067
2068     /* copy level part at the right position of multi-part level */
2069     for (y = 0; y < SP_LEVEL_YSIZE; y++)
2070     {
2071       for (x = 0; x < SP_LEVEL_XSIZE; x++)
2072       {
2073         int start_x = (multipart_xpos - 1) * SP_LEVEL_XSIZE;
2074         int start_y = (multipart_ypos - 1) * SP_LEVEL_YSIZE;
2075
2076         multipart_level.field[start_x + x][start_y + y] = level->field[x][y];
2077       }
2078     }
2079   }
2080
2081   fclose(file);
2082
2083   if (use_empty_level)
2084   {
2085     setLevelInfoToDefaults(level);
2086
2087     level->fieldx = SP_LEVEL_XSIZE;
2088     level->fieldy = SP_LEVEL_YSIZE;
2089
2090     for (y = 0; y < SP_LEVEL_YSIZE; y++)
2091       for (x = 0; x < SP_LEVEL_XSIZE; x++)
2092         level->field[x][y] = EL_EMPTY;
2093
2094     strcpy(level->name, "-------- EMPTY --------");
2095
2096     Error(ERR_WARN, "single part of multi-part level -- using empty level");
2097   }
2098
2099   if (reading_multipart_level)
2100     *level = multipart_level;
2101 }
2102
2103 /* ------------------------------------------------------------------------- */
2104 /* functions for loading generic level                                       */
2105 /* ------------------------------------------------------------------------- */
2106
2107 void LoadLevelFromFileInfo(struct LevelInfo *level,
2108                            struct LevelFileInfo *level_file_info)
2109 {
2110   /* always start with reliable default values */
2111   setLevelInfoToDefaults(level);
2112
2113   switch (level_file_info->type)
2114   {
2115     case LEVEL_FILE_TYPE_RND:
2116       LoadLevelFromFileInfo_RND(level, level_file_info);
2117       break;
2118
2119     case LEVEL_FILE_TYPE_EM:
2120       LoadLevelFromFileInfo_EM(level, level_file_info);
2121       break;
2122
2123     case LEVEL_FILE_TYPE_SP:
2124       LoadLevelFromFileInfo_SP(level, level_file_info);
2125       break;
2126
2127     default:
2128       LoadLevelFromFileInfo_RND(level, level_file_info);
2129       break;
2130   }
2131 }
2132
2133 void LoadLevelFromFilename(struct LevelInfo *level, char *filename)
2134 {
2135   static struct LevelFileInfo level_file_info;
2136
2137   /* always start with reliable default values */
2138   setFileInfoToDefaults(&level_file_info);
2139
2140   level_file_info.nr = 0;                       /* unknown level number */
2141   level_file_info.type = LEVEL_FILE_TYPE_RND;   /* no others supported yet */
2142   level_file_info.filename = filename;
2143
2144   LoadLevelFromFileInfo(level, &level_file_info);
2145 }
2146
2147 static void LoadLevel_InitVersion(struct LevelInfo *level, char *filename)
2148 {
2149   if (leveldir_current == NULL)         /* only when dumping level */
2150     return;
2151
2152 #if 0
2153   printf("::: sort_priority: %d\n", leveldir_current->sort_priority);
2154 #endif
2155
2156   /* determine correct game engine version of current level */
2157 #if 1
2158   if (!leveldir_current->latest_engine)
2159 #else
2160   if (IS_LEVELCLASS_CONTRIB(leveldir_current) ||
2161       IS_LEVELCLASS_PRIVATE(leveldir_current) ||
2162       IS_LEVELCLASS_UNDEFINED(leveldir_current))
2163 #endif
2164   {
2165 #if 0
2166     printf("\n::: This level is private or contributed: '%s'\n", filename);
2167 #endif
2168
2169 #if 0
2170     printf("\n::: Use the stored game engine version for this level\n");
2171 #endif
2172
2173     /* For all levels which are not forced to use the latest game engine
2174        version (normally user contributed, private and undefined levels),
2175        use the version of the game engine the levels were created for.
2176
2177        Since 2.0.1, the game engine version is now directly stored
2178        in the level file (chunk "VERS"), so there is no need anymore
2179        to set the game version from the file version (except for old,
2180        pre-2.0 levels, where the game version is still taken from the
2181        file format version used to store the level -- see above). */
2182
2183 #if 1
2184     /* player was faster than enemies in 1.0.0 and before */
2185     if (level->file_version == FILE_VERSION_1_0)
2186       level->double_speed = TRUE;
2187 #else
2188     /* do some special adjustments to support older level versions */
2189     if (level->file_version == FILE_VERSION_1_0)
2190     {
2191       Error(ERR_WARN, "level file '%s' has version number 1.0", filename);
2192       Error(ERR_WARN, "using high speed movement for player");
2193
2194       /* player was faster than monsters in (pre-)1.0 levels */
2195       level->double_speed = TRUE;
2196     }
2197 #endif
2198
2199     /* default behaviour for EM style gems was "slippery" only in 2.0.1 */
2200     if (level->game_version == VERSION_IDENT(2,0,1,0))
2201       level->em_slippery_gems = TRUE;
2202
2203     /* springs could be pushed over pits before (pre-release version) 2.2.0 */
2204     if (level->game_version < VERSION_IDENT(2,2,0,0))
2205       level->use_spring_bug = TRUE;
2206
2207     /* only few elements were able to actively move into acid before 3.1.0 */
2208     if (level->game_version < VERSION_IDENT(3,1,0,0))
2209     {
2210       int i, j;
2211
2212       level->can_move_into_acid_bits = 0; /* nothing can move into acid */
2213       level->dont_collide_with_bits = 0; /* nothing is deadly when colliding */
2214
2215       setMoveIntoAcidProperty(level, EL_ROBOT,     TRUE);
2216       setMoveIntoAcidProperty(level, EL_SATELLITE, TRUE);
2217       setMoveIntoAcidProperty(level, EL_PENGUIN,   TRUE);
2218       setMoveIntoAcidProperty(level, EL_BALLOON,   TRUE);
2219
2220       for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2221         SET_PROPERTY(EL_CUSTOM_START + i, EP_CAN_MOVE_INTO_ACID, TRUE);
2222
2223       for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2224       {
2225         int element = EL_CUSTOM_START + i;
2226         struct ElementInfo *ei = &element_info[element];
2227
2228         for (j = 0; j < ei->num_change_pages; j++)
2229         {
2230           struct ElementChangeInfo *change = &ei->change_page[j];
2231
2232           change->trigger_player = CH_PLAYER_ANY;
2233           change->trigger_page = CH_PAGE_ANY;
2234         }
2235       }
2236     }
2237
2238 #if 1
2239     /* blocking the last field when moving was corrected in version 3.1.1 */
2240     if (level->game_version < VERSION_IDENT(3,1,1,0))
2241     {
2242       /* even "not blocking" was blocking the last field for one frame */
2243       level->block_delay    = (level->block_last_field    ? 7 : 1);
2244       level->sp_block_delay = (level->sp_block_last_field ? 7 : 1);
2245
2246       level->block_last_field = TRUE;
2247       level->sp_block_last_field = TRUE;
2248     }
2249 #endif
2250   }
2251   else          /* always use the latest game engine version */
2252   {
2253 #if 0
2254     printf("\n::: ALWAYS USE LATEST ENGINE FOR THIS LEVEL: [%d] '%s'\n",
2255            leveldir_current->sort_priority, filename);
2256 #endif
2257
2258 #if 0
2259     printf("\n::: Use latest game engine version for this level.\n");
2260 #endif
2261
2262     /* For all levels which are forced to use the latest game engine version
2263        (normally all but user contributed, private and undefined levels), set
2264        the game engine version to the actual version; this allows for actual
2265        corrections in the game engine to take effect for existing, converted
2266        levels (from "classic" or other existing games) to make the emulation
2267        of the corresponding game more accurate, while (hopefully) not breaking
2268        existing levels created from other players. */
2269
2270 #if 0
2271     printf("::: changing engine from %d to %d\n",
2272            level->game_version, GAME_VERSION_ACTUAL);
2273 #endif
2274
2275     level->game_version = GAME_VERSION_ACTUAL;
2276
2277     /* Set special EM style gems behaviour: EM style gems slip down from
2278        normal, steel and growing wall. As this is a more fundamental change,
2279        it seems better to set the default behaviour to "off" (as it is more
2280        natural) and make it configurable in the level editor (as a property
2281        of gem style elements). Already existing converted levels (neither
2282        private nor contributed levels) are changed to the new behaviour. */
2283
2284     if (level->file_version < FILE_VERSION_2_0)
2285       level->em_slippery_gems = TRUE;
2286   }
2287
2288 #if 0
2289   printf("::: => %d\n", level->game_version);
2290 #endif
2291 }
2292
2293 static void LoadLevel_InitElements(struct LevelInfo *level, char *filename)
2294 {
2295   int i, j, x, y;
2296
2297   /* map custom element change events that have changed in newer versions
2298      (these following values were accidentally changed in version 3.0.1) */
2299   if (level->game_version <= VERSION_IDENT(3,0,0,0))
2300   {
2301     for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2302     {
2303       int element = EL_CUSTOM_START + i;
2304
2305       /* order of checking and copying events to be mapped is important */
2306       for (j = CE_BY_OTHER_ACTION; j >= CE_BY_PLAYER_OBSOLETE; j--)
2307       {
2308         if (HAS_CHANGE_EVENT(element, j - 2))
2309         {
2310           SET_CHANGE_EVENT(element, j - 2, FALSE);
2311           SET_CHANGE_EVENT(element, j, TRUE);
2312         }
2313       }
2314
2315       /* order of checking and copying events to be mapped is important */
2316       for (j = CE_OTHER_GETS_COLLECTED; j >= CE_HITTING_SOMETHING; j--)
2317       {
2318         if (HAS_CHANGE_EVENT(element, j - 1))
2319         {
2320           SET_CHANGE_EVENT(element, j - 1, FALSE);
2321           SET_CHANGE_EVENT(element, j, TRUE);
2322         }
2323       }
2324     }
2325   }
2326
2327   /* some custom element change events get mapped since version 3.0.3 */
2328   for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2329   {
2330     int element = EL_CUSTOM_START + i;
2331
2332     if (HAS_CHANGE_EVENT(element, CE_BY_PLAYER_OBSOLETE) ||
2333         HAS_CHANGE_EVENT(element, CE_BY_COLLISION_OBSOLETE))
2334     {
2335       SET_CHANGE_EVENT(element, CE_BY_PLAYER_OBSOLETE, FALSE);
2336       SET_CHANGE_EVENT(element, CE_BY_COLLISION_OBSOLETE, FALSE);
2337
2338       SET_CHANGE_EVENT(element, CE_BY_DIRECT_ACTION, TRUE);
2339     }
2340   }
2341
2342   /* initialize "can_change" field for old levels with only one change page */
2343   if (level->game_version <= VERSION_IDENT(3,0,2,0))
2344   {
2345     for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2346     {
2347       int element = EL_CUSTOM_START + i;
2348
2349       if (CAN_CHANGE(element))
2350         element_info[element].change->can_change = TRUE;
2351     }
2352   }
2353
2354   /* correct custom element values (for old levels without these options) */
2355   for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2356   {
2357     int element = EL_CUSTOM_START + i;
2358     struct ElementInfo *ei = &element_info[element];
2359
2360     if (ei->access_direction == MV_NO_MOVING)
2361       ei->access_direction = MV_ALL_DIRECTIONS;
2362
2363     for (j = 0; j < ei->num_change_pages; j++)
2364     {
2365       struct ElementChangeInfo *change = &ei->change_page[j];
2366
2367       if (change->trigger_side == CH_SIDE_NONE)
2368         change->trigger_side = CH_SIDE_ANY;
2369     }
2370   }
2371
2372   /* initialize "can_explode" field for old levels which did not store this */
2373   if (level->game_version <= VERSION_IDENT(3,1,0,0))
2374   {
2375     for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2376     {
2377       int element = EL_CUSTOM_START + i;
2378
2379       if (EXPLODES_1X1_OLD(element))
2380         element_info[element].explosion_type = EXPLODES_1X1;
2381
2382       SET_PROPERTY(element, EP_CAN_EXPLODE, (EXPLODES_BY_FIRE(element) ||
2383                                              EXPLODES_SMASHED(element) ||
2384                                              EXPLODES_IMPACT(element)));
2385     }
2386   }
2387
2388 #if 0
2389   /* set default push delay values (corrected since version 3.0.7-1) */
2390   if (level->game_version < VERSION_IDENT(3,0,7,1))
2391   {
2392     game.default_push_delay_fixed = 2;
2393     game.default_push_delay_random = 8;
2394   }
2395   else
2396   {
2397     game.default_push_delay_fixed = 8;
2398     game.default_push_delay_random = 8;
2399   }
2400
2401   /* set uninitialized push delay values of custom elements in older levels */
2402   for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2403   {
2404     int element = EL_CUSTOM_START + i;
2405
2406     if (element_info[element].push_delay_fixed == -1)
2407       element_info[element].push_delay_fixed = game.default_push_delay_fixed;
2408     if (element_info[element].push_delay_random == -1)
2409       element_info[element].push_delay_random = game.default_push_delay_random;
2410   }
2411 #endif
2412
2413   /* map elements that have changed in newer versions */
2414   level->amoeba_content = getMappedElementByVersion(level->amoeba_content,
2415                                                     level->game_version);
2416   for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
2417     for (x = 0; x < 3; x++)
2418       for (y = 0; y < 3; y++)
2419         level->yamyam_content[i][x][y] =
2420           getMappedElementByVersion(level->yamyam_content[i][x][y],
2421                                     level->game_version);
2422
2423   /* initialize element properties for level editor etc. */
2424   InitElementPropertiesEngine(level->game_version);
2425 }
2426
2427 static void LoadLevel_InitPlayfield(struct LevelInfo *level, char *filename)
2428 {
2429   int x, y;
2430
2431   /* map elements that have changed in newer versions */
2432   for (y = 0; y < level->fieldy; y++)
2433   {
2434     for (x = 0; x < level->fieldx; x++)
2435     {
2436       int element = level->field[x][y];
2437
2438 #if 1
2439       element = getMappedElementByVersion(element, level->game_version);
2440 #else
2441       if (level->game_version <= VERSION_IDENT(2,2,0,0))
2442       {
2443         /* map game font elements */
2444         element = (element == EL_CHAR('[')  ? EL_CHAR_AUMLAUT :
2445                    element == EL_CHAR('\\') ? EL_CHAR_OUMLAUT :
2446                    element == EL_CHAR(']')  ? EL_CHAR_UUMLAUT :
2447                    element == EL_CHAR('^')  ? EL_CHAR_COPYRIGHT : element);
2448       }
2449
2450       if (level->game_version < VERSION_IDENT(3,0,0,0))
2451       {
2452         /* map Supaplex gravity tube elements */
2453         element = (element == EL_SP_GRAVITY_PORT_LEFT  ? EL_SP_PORT_LEFT  :
2454                    element == EL_SP_GRAVITY_PORT_RIGHT ? EL_SP_PORT_RIGHT :
2455                    element == EL_SP_GRAVITY_PORT_UP    ? EL_SP_PORT_UP    :
2456                    element == EL_SP_GRAVITY_PORT_DOWN  ? EL_SP_PORT_DOWN  :
2457                    element);
2458       }
2459 #endif
2460
2461       level->field[x][y] = element;
2462     }
2463   }
2464
2465   /* copy elements to runtime playfield array */
2466   for (x = 0; x < MAX_LEV_FIELDX; x++)
2467     for (y = 0; y < MAX_LEV_FIELDY; y++)
2468       Feld[x][y] = level->field[x][y];
2469
2470   /* initialize level size variables for faster access */
2471   lev_fieldx = level->fieldx;
2472   lev_fieldy = level->fieldy;
2473
2474   /* determine border element for this level */
2475   SetBorderElement();
2476 }
2477
2478 void LoadLevelTemplate(int nr)
2479 {
2480 #if 1
2481   struct LevelFileInfo *level_file_info = getLevelFileInfo(nr);
2482   char *filename = level_file_info->filename;
2483
2484   LoadLevelFromFileInfo(&level_template, level_file_info);
2485 #else
2486   char *filename = getDefaultLevelFilename(nr);
2487
2488   LoadLevelFromFilename_RND(&level_template, filename);
2489 #endif
2490
2491   LoadLevel_InitVersion(&level, filename);
2492   LoadLevel_InitElements(&level, filename);
2493
2494   ActivateLevelTemplate();
2495 }
2496
2497 void LoadLevel(int nr)
2498 {
2499 #if 1
2500   struct LevelFileInfo *level_file_info = getLevelFileInfo(nr);
2501   char *filename = level_file_info->filename;
2502
2503   LoadLevelFromFileInfo(&level, level_file_info);
2504 #else
2505   char *filename = getLevelFilename(nr);
2506
2507   LoadLevelFromFilename_RND(&level, filename);
2508 #endif
2509
2510   if (level.use_custom_template)
2511     LoadLevelTemplate(-1);
2512
2513 #if 1
2514   LoadLevel_InitVersion(&level, filename);
2515   LoadLevel_InitElements(&level, filename);
2516   LoadLevel_InitPlayfield(&level, filename);
2517 #else
2518   LoadLevel_InitLevel(&level, filename);
2519 #endif
2520 }
2521
2522 static void SaveLevel_VERS(FILE *file, struct LevelInfo *level)
2523 {
2524   putFileVersion(file, level->file_version);
2525   putFileVersion(file, level->game_version);
2526 }
2527
2528 static void SaveLevel_HEAD(FILE *file, struct LevelInfo *level)
2529 {
2530   int i, x, y;
2531
2532   putFile8Bit(file, level->fieldx);
2533   putFile8Bit(file, level->fieldy);
2534
2535   putFile16BitBE(file, level->time);
2536   putFile16BitBE(file, level->gems_needed);
2537
2538   for (i = 0; i < MAX_LEVEL_NAME_LEN; i++)
2539     putFile8Bit(file, level->name[i]);
2540
2541   for (i = 0; i < LEVEL_SCORE_ELEMENTS; i++)
2542     putFile8Bit(file, level->score[i]);
2543
2544   for (i = 0; i < STD_ELEMENT_CONTENTS; i++)
2545     for (y = 0; y < 3; y++)
2546       for (x = 0; x < 3; x++)
2547         putFile8Bit(file, (level->encoding_16bit_yamyam ? EL_EMPTY :
2548                            level->yamyam_content[i][x][y]));
2549   putFile8Bit(file, level->amoeba_speed);
2550   putFile8Bit(file, level->time_magic_wall);
2551   putFile8Bit(file, level->time_wheel);
2552   putFile8Bit(file, (level->encoding_16bit_amoeba ? EL_EMPTY :
2553                      level->amoeba_content));
2554   putFile8Bit(file, (level->double_speed ? 1 : 0));
2555   putFile8Bit(file, (level->initial_gravity ? 1 : 0));
2556   putFile8Bit(file, (level->encoding_16bit_field ? 1 : 0));
2557   putFile8Bit(file, (level->em_slippery_gems ? 1 : 0));
2558
2559   putFile8Bit(file, (level->use_custom_template ? 1 : 0));
2560
2561   putFile8Bit(file, (level->block_last_field ? 1 : 0));
2562   putFile8Bit(file, (level->sp_block_last_field ? 1 : 0));
2563   putFile32BitBE(file, level->can_move_into_acid_bits);
2564   putFile8Bit(file, level->dont_collide_with_bits);
2565
2566   putFile8Bit(file, (level->use_spring_bug ? 1 : 0));
2567   putFile8Bit(file, (level->use_step_counter ? 1 : 0));
2568
2569   putFile8Bit(file, (level->instant_relocation ? 1 : 0));
2570   putFile8Bit(file, (level->can_pass_to_walkable ? 1 : 0));
2571   putFile8Bit(file, (level->grow_into_diggable ? 1 : 0));
2572
2573   WriteUnusedBytesToFile(file, LEVEL_HEADER_UNUSED);
2574 }
2575
2576 static void SaveLevel_AUTH(FILE *file, struct LevelInfo *level)
2577 {
2578   int i;
2579
2580   for (i = 0; i < MAX_LEVEL_AUTHOR_LEN; i++)
2581     putFile8Bit(file, level->author[i]);
2582 }
2583
2584 static void SaveLevel_BODY(FILE *file, struct LevelInfo *level)
2585 {
2586   int x, y;
2587
2588   for (y = 0; y < level->fieldy; y++)
2589     for (x = 0; x < level->fieldx; x++)
2590       if (level->encoding_16bit_field)
2591         putFile16BitBE(file, level->field[x][y]);
2592       else
2593         putFile8Bit(file, level->field[x][y]);
2594 }
2595
2596 #if 0
2597 static void SaveLevel_CONT(FILE *file, struct LevelInfo *level)
2598 {
2599   int i, x, y;
2600
2601   putFile8Bit(file, EL_YAMYAM);
2602   putFile8Bit(file, level->num_yamyam_contents);
2603   putFile8Bit(file, 0);
2604   putFile8Bit(file, 0);
2605
2606   for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
2607     for (y = 0; y < 3; y++)
2608       for (x = 0; x < 3; x++)
2609         if (level->encoding_16bit_field)
2610           putFile16BitBE(file, level->yamyam_content[i][x][y]);
2611         else
2612           putFile8Bit(file, level->yamyam_content[i][x][y]);
2613 }
2614 #endif
2615
2616 static void SaveLevel_CNT2(FILE *file, struct LevelInfo *level, int element)
2617 {
2618   int i, x, y;
2619   int num_contents, content_xsize, content_ysize;
2620   int content_array[MAX_ELEMENT_CONTENTS][3][3];
2621
2622   if (element == EL_YAMYAM)
2623   {
2624     num_contents = level->num_yamyam_contents;
2625     content_xsize = 3;
2626     content_ysize = 3;
2627
2628     for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
2629       for (y = 0; y < 3; y++)
2630         for (x = 0; x < 3; x++)
2631           content_array[i][x][y] = level->yamyam_content[i][x][y];
2632   }
2633   else if (element == EL_BD_AMOEBA)
2634   {
2635     num_contents = 1;
2636     content_xsize = 1;
2637     content_ysize = 1;
2638
2639     for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
2640       for (y = 0; y < 3; y++)
2641         for (x = 0; x < 3; x++)
2642           content_array[i][x][y] = EL_EMPTY;
2643     content_array[0][0][0] = level->amoeba_content;
2644   }
2645   else
2646   {
2647     /* chunk header already written -- write empty chunk data */
2648     WriteUnusedBytesToFile(file, LEVEL_CHUNK_CNT2_SIZE);
2649
2650     Error(ERR_WARN, "cannot save content for element '%d'", element);
2651     return;
2652   }
2653
2654   putFile16BitBE(file, element);
2655   putFile8Bit(file, num_contents);
2656   putFile8Bit(file, content_xsize);
2657   putFile8Bit(file, content_ysize);
2658
2659   WriteUnusedBytesToFile(file, LEVEL_CHUNK_CNT2_UNUSED);
2660
2661   for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
2662     for (y = 0; y < 3; y++)
2663       for (x = 0; x < 3; x++)
2664         putFile16BitBE(file, content_array[i][x][y]);
2665 }
2666
2667 static void SaveLevel_CNT3(FILE *file, struct LevelInfo *level, int element)
2668 {
2669   int i;
2670   int envelope_nr = element - EL_ENVELOPE_1;
2671   int envelope_len = strlen(level->envelope_text[envelope_nr]) + 1;
2672
2673   putFile16BitBE(file, element);
2674   putFile16BitBE(file, envelope_len);
2675   putFile8Bit(file, level->envelope_xsize[envelope_nr]);
2676   putFile8Bit(file, level->envelope_ysize[envelope_nr]);
2677
2678   WriteUnusedBytesToFile(file, LEVEL_CHUNK_CNT3_UNUSED);
2679
2680   for (i = 0; i < envelope_len; i++)
2681     putFile8Bit(file, level->envelope_text[envelope_nr][i]);
2682 }
2683
2684 #if 0
2685 static void SaveLevel_CUS1(FILE *file, struct LevelInfo *level,
2686                            int num_changed_custom_elements)
2687 {
2688   int i, check = 0;
2689
2690   putFile16BitBE(file, num_changed_custom_elements);
2691
2692   for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2693   {
2694     int element = EL_CUSTOM_START + i;
2695
2696     if (Properties[element][EP_BITFIELD_BASE] != EP_BITMASK_DEFAULT)
2697     {
2698       if (check < num_changed_custom_elements)
2699       {
2700         putFile16BitBE(file, element);
2701         putFile32BitBE(file, Properties[element][EP_BITFIELD_BASE]);
2702       }
2703
2704       check++;
2705     }
2706   }
2707
2708   if (check != num_changed_custom_elements)     /* should not happen */
2709     Error(ERR_WARN, "inconsistent number of custom element properties");
2710 }
2711 #endif
2712
2713 #if 0
2714 static void SaveLevel_CUS2(FILE *file, struct LevelInfo *level,
2715                            int num_changed_custom_elements)
2716 {
2717   int i, check = 0;
2718
2719   putFile16BitBE(file, num_changed_custom_elements);
2720
2721   for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2722   {
2723     int element = EL_CUSTOM_START + i;
2724
2725     if (element_info[element].change->target_element != EL_EMPTY_SPACE)
2726     {
2727       if (check < num_changed_custom_elements)
2728       {
2729         putFile16BitBE(file, element);
2730         putFile16BitBE(file, element_info[element].change->target_element);
2731       }
2732
2733       check++;
2734     }
2735   }
2736
2737   if (check != num_changed_custom_elements)     /* should not happen */
2738     Error(ERR_WARN, "inconsistent number of custom target elements");
2739 }
2740 #endif
2741
2742 #if 0
2743 static void SaveLevel_CUS3(FILE *file, struct LevelInfo *level,
2744                            int num_changed_custom_elements)
2745 {
2746   int i, j, x, y, check = 0;
2747
2748   putFile16BitBE(file, num_changed_custom_elements);
2749
2750   for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2751   {
2752     int element = EL_CUSTOM_START + i;
2753
2754     if (element_info[element].modified_settings)
2755     {
2756       if (check < num_changed_custom_elements)
2757       {
2758         putFile16BitBE(file, element);
2759
2760         for (j = 0; j < MAX_ELEMENT_NAME_LEN; j++)
2761           putFile8Bit(file, element_info[element].description[j]);
2762
2763         putFile32BitBE(file, Properties[element][EP_BITFIELD_BASE]);
2764
2765         /* some free bytes for future properties and padding */
2766         WriteUnusedBytesToFile(file, 7);
2767
2768         putFile8Bit(file, element_info[element].use_gfx_element);
2769         putFile16BitBE(file, element_info[element].gfx_element);
2770
2771         putFile8Bit(file, element_info[element].collect_score);
2772         putFile8Bit(file, element_info[element].collect_count);
2773
2774         putFile16BitBE(file, element_info[element].push_delay_fixed);
2775         putFile16BitBE(file, element_info[element].push_delay_random);
2776         putFile16BitBE(file, element_info[element].move_delay_fixed);
2777         putFile16BitBE(file, element_info[element].move_delay_random);
2778
2779         putFile16BitBE(file, element_info[element].move_pattern);
2780         putFile8Bit(file, element_info[element].move_direction_initial);
2781         putFile8Bit(file, element_info[element].move_stepsize);
2782
2783         for (y = 0; y < 3; y++)
2784           for (x = 0; x < 3; x++)
2785             putFile16BitBE(file, element_info[element].content[x][y]);
2786
2787         putFile32BitBE(file, element_info[element].change->events);
2788
2789         putFile16BitBE(file, element_info[element].change->target_element);
2790
2791         putFile16BitBE(file, element_info[element].change->delay_fixed);
2792         putFile16BitBE(file, element_info[element].change->delay_random);
2793         putFile16BitBE(file, element_info[element].change->delay_frames);
2794
2795         putFile16BitBE(file, element_info[element].change->trigger_element);
2796
2797         putFile8Bit(file, element_info[element].change->explode);
2798         putFile8Bit(file, element_info[element].change->use_target_content);
2799         putFile8Bit(file, element_info[element].change->only_if_complete);
2800         putFile8Bit(file, element_info[element].change->use_random_replace);
2801
2802         putFile8Bit(file, element_info[element].change->random_percentage);
2803         putFile8Bit(file, element_info[element].change->replace_when);
2804
2805         for (y = 0; y < 3; y++)
2806           for (x = 0; x < 3; x++)
2807             putFile16BitBE(file, element_info[element].change->content[x][y]);
2808
2809         putFile8Bit(file, element_info[element].slippery_type);
2810
2811         /* some free bytes for future properties and padding */
2812         WriteUnusedBytesToFile(file, LEVEL_CPART_CUS3_UNUSED);
2813       }
2814
2815       check++;
2816     }
2817   }
2818
2819   if (check != num_changed_custom_elements)     /* should not happen */
2820     Error(ERR_WARN, "inconsistent number of custom element properties");
2821 }
2822 #endif
2823
2824 static void SaveLevel_CUS4(FILE *file, struct LevelInfo *level, int element)
2825 {
2826   struct ElementInfo *ei = &element_info[element];
2827   int i, x, y;
2828
2829   putFile16BitBE(file, element);
2830
2831   for (i = 0; i < MAX_ELEMENT_NAME_LEN; i++)
2832     putFile8Bit(file, ei->description[i]);
2833
2834   putFile32BitBE(file, Properties[element][EP_BITFIELD_BASE]);
2835   WriteUnusedBytesToFile(file, 4);      /* reserved for more base properties */
2836
2837   putFile8Bit(file, ei->num_change_pages);
2838
2839   /* some free bytes for future base property values and padding */
2840   WriteUnusedBytesToFile(file, 5);
2841
2842   /* write custom property values */
2843
2844   putFile8Bit(file, ei->use_gfx_element);
2845   putFile16BitBE(file, ei->gfx_element);
2846
2847   putFile8Bit(file, ei->collect_score);
2848   putFile8Bit(file, ei->collect_count);
2849
2850   putFile8Bit(file, ei->drop_delay_fixed);
2851   putFile8Bit(file, ei->push_delay_fixed);
2852   putFile8Bit(file, ei->drop_delay_random);
2853   putFile8Bit(file, ei->push_delay_random);
2854   putFile16BitBE(file, ei->move_delay_fixed);
2855   putFile16BitBE(file, ei->move_delay_random);
2856
2857   /* bits 0 - 15 of "move_pattern" ... */
2858   putFile16BitBE(file, ei->move_pattern & 0xffff);
2859   putFile8Bit(file, ei->move_direction_initial);
2860   putFile8Bit(file, ei->move_stepsize);
2861
2862   putFile8Bit(file, ei->slippery_type);
2863
2864   for (y = 0; y < 3; y++)
2865     for (x = 0; x < 3; x++)
2866       putFile16BitBE(file, ei->content[x][y]);
2867
2868   putFile16BitBE(file, ei->move_enter_element);
2869   putFile16BitBE(file, ei->move_leave_element);
2870   putFile8Bit(file, ei->move_leave_type);
2871
2872   /* ... bits 16 - 31 of "move_pattern" (not nice, but downward compatible) */
2873   putFile16BitBE(file, (ei->move_pattern >> 16) & 0xffff);
2874
2875   putFile8Bit(file, ei->access_direction);
2876
2877   putFile8Bit(file, ei->explosion_delay);
2878   putFile8Bit(file, ei->ignition_delay);
2879   putFile8Bit(file, ei->explosion_type);
2880
2881   /* some free bytes for future custom property values and padding */
2882   WriteUnusedBytesToFile(file, 1);
2883
2884   /* write change property values */
2885
2886   for (i = 0; i < ei->num_change_pages; i++)
2887   {
2888     struct ElementChangeInfo *change = &ei->change_page[i];
2889
2890     putFile32BitBE(file, change->events);
2891
2892     putFile16BitBE(file, change->target_element);
2893
2894     putFile16BitBE(file, change->delay_fixed);
2895     putFile16BitBE(file, change->delay_random);
2896     putFile16BitBE(file, change->delay_frames);
2897
2898     putFile16BitBE(file, change->trigger_element);
2899
2900     putFile8Bit(file, change->explode);
2901     putFile8Bit(file, change->use_target_content);
2902     putFile8Bit(file, change->only_if_complete);
2903     putFile8Bit(file, change->use_random_replace);
2904
2905     putFile8Bit(file, change->random_percentage);
2906     putFile8Bit(file, change->replace_when);
2907
2908     for (y = 0; y < 3; y++)
2909       for (x = 0; x < 3; x++)
2910         putFile16BitBE(file, change->target_content[x][y]);
2911
2912     putFile8Bit(file, change->can_change);
2913
2914     putFile8Bit(file, change->trigger_side);
2915
2916 #if 1
2917     putFile8Bit(file, change->trigger_player);
2918     putFile8Bit(file, (change->trigger_page == CH_PAGE_ANY ? CH_PAGE_ANY_FILE :
2919                        log_2(change->trigger_page)));
2920
2921     /* some free bytes for future change property values and padding */
2922     WriteUnusedBytesToFile(file, 6);
2923
2924 #else
2925
2926     /* some free bytes for future change property values and padding */
2927     WriteUnusedBytesToFile(file, 8);
2928 #endif
2929   }
2930 }
2931
2932 static void SaveLevel_GRP1(FILE *file, struct LevelInfo *level, int element)
2933 {
2934   struct ElementInfo *ei = &element_info[element];
2935   struct ElementGroupInfo *group = ei->group;
2936   int i;
2937
2938   putFile16BitBE(file, element);
2939
2940   for (i = 0; i < MAX_ELEMENT_NAME_LEN; i++)
2941     putFile8Bit(file, ei->description[i]);
2942
2943   putFile8Bit(file, group->num_elements);
2944
2945   putFile8Bit(file, ei->use_gfx_element);
2946   putFile16BitBE(file, ei->gfx_element);
2947
2948   putFile8Bit(file, group->choice_mode);
2949
2950   /* some free bytes for future values and padding */
2951   WriteUnusedBytesToFile(file, 3);
2952
2953   for (i = 0; i < MAX_ELEMENTS_IN_GROUP; i++)
2954     putFile16BitBE(file, group->element[i]);
2955 }
2956
2957 static void SaveLevelFromFilename(struct LevelInfo *level, char *filename)
2958 {
2959   int body_chunk_size;
2960   int i, x, y;
2961   FILE *file;
2962
2963   if (!(file = fopen(filename, MODE_WRITE)))
2964   {
2965     Error(ERR_WARN, "cannot save level file '%s'", filename);
2966     return;
2967   }
2968
2969   level->file_version = FILE_VERSION_ACTUAL;
2970   level->game_version = GAME_VERSION_ACTUAL;
2971
2972   /* check level field for 16-bit elements */
2973   level->encoding_16bit_field = FALSE;
2974   for (y = 0; y < level->fieldy; y++)
2975     for (x = 0; x < level->fieldx; x++)
2976       if (level->field[x][y] > 255)
2977         level->encoding_16bit_field = TRUE;
2978
2979   /* check yamyam content for 16-bit elements */
2980   level->encoding_16bit_yamyam = FALSE;
2981   for (i = 0; i < level->num_yamyam_contents; i++)
2982     for (y = 0; y < 3; y++)
2983       for (x = 0; x < 3; x++)
2984         if (level->yamyam_content[i][x][y] > 255)
2985           level->encoding_16bit_yamyam = TRUE;
2986
2987   /* check amoeba content for 16-bit elements */
2988   level->encoding_16bit_amoeba = FALSE;
2989   if (level->amoeba_content > 255)
2990     level->encoding_16bit_amoeba = TRUE;
2991
2992   /* calculate size of "BODY" chunk */
2993   body_chunk_size =
2994     level->fieldx * level->fieldy * (level->encoding_16bit_field ? 2 : 1);
2995
2996   putFileChunkBE(file, "RND1", CHUNK_SIZE_UNDEFINED);
2997   putFileChunkBE(file, "CAVE", CHUNK_SIZE_NONE);
2998
2999   putFileChunkBE(file, "VERS", FILE_VERS_CHUNK_SIZE);
3000   SaveLevel_VERS(file, level);
3001
3002   putFileChunkBE(file, "HEAD", LEVEL_HEADER_SIZE);
3003   SaveLevel_HEAD(file, level);
3004
3005   putFileChunkBE(file, "AUTH", MAX_LEVEL_AUTHOR_LEN);
3006   SaveLevel_AUTH(file, level);
3007
3008   putFileChunkBE(file, "BODY", body_chunk_size);
3009   SaveLevel_BODY(file, level);
3010
3011   if (level->encoding_16bit_yamyam ||
3012       level->num_yamyam_contents != STD_ELEMENT_CONTENTS)
3013   {
3014     putFileChunkBE(file, "CNT2", LEVEL_CHUNK_CNT2_SIZE);
3015     SaveLevel_CNT2(file, level, EL_YAMYAM);
3016   }
3017
3018   if (level->encoding_16bit_amoeba)
3019   {
3020     putFileChunkBE(file, "CNT2", LEVEL_CHUNK_CNT2_SIZE);
3021     SaveLevel_CNT2(file, level, EL_BD_AMOEBA);
3022   }
3023
3024   /* check for envelope content */
3025   for (i = 0; i < 4; i++)
3026   {
3027     if (strlen(level->envelope_text[i]) > 0)
3028     {
3029       int envelope_len = strlen(level->envelope_text[i]) + 1;
3030
3031       putFileChunkBE(file, "CNT3", LEVEL_CHUNK_CNT3_SIZE(envelope_len));
3032       SaveLevel_CNT3(file, level, EL_ENVELOPE_1 + i);
3033     }
3034   }
3035
3036   /* check for non-default custom elements (unless using template level) */
3037   if (!level->use_custom_template)
3038   {
3039     for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
3040     {
3041       int element = EL_CUSTOM_START + i;
3042
3043       if (element_info[element].modified_settings)
3044       {
3045         int num_change_pages = element_info[element].num_change_pages;
3046
3047         putFileChunkBE(file, "CUS4", LEVEL_CHUNK_CUS4_SIZE(num_change_pages));
3048         SaveLevel_CUS4(file, level, element);
3049       }
3050     }
3051   }
3052
3053   /* check for non-default group elements (unless using template level) */
3054   if (!level->use_custom_template)
3055   {
3056     for (i = 0; i < NUM_GROUP_ELEMENTS; i++)
3057     {
3058       int element = EL_GROUP_START + i;
3059
3060       if (element_info[element].modified_settings)
3061       {
3062         putFileChunkBE(file, "GRP1", LEVEL_CHUNK_GRP1_SIZE);
3063         SaveLevel_GRP1(file, level, element);
3064       }
3065     }
3066   }
3067
3068   fclose(file);
3069
3070   SetFilePermissions(filename, PERMS_PRIVATE);
3071 }
3072
3073 void SaveLevel(int nr)
3074 {
3075   char *filename = getDefaultLevelFilename(nr);
3076
3077   SaveLevelFromFilename(&level, filename);
3078 }
3079
3080 void SaveLevelTemplate()
3081 {
3082   char *filename = getDefaultLevelFilename(-1);
3083
3084   SaveLevelFromFilename(&level, filename);
3085 }
3086
3087 void DumpLevel(struct LevelInfo *level)
3088 {
3089   if (level->no_valid_file)
3090   {
3091     Error(ERR_WARN, "cannot dump -- no valid level file found");
3092
3093     return;
3094   }
3095
3096   printf_line("-", 79);
3097   printf("Level xxx (file version %08d, game version %08d)\n",
3098          level->file_version, level->game_version);
3099   printf_line("-", 79);
3100
3101   printf("Level author: '%s'\n", level->author);
3102   printf("Level title:  '%s'\n", level->name);
3103   printf("\n");
3104   printf("Playfield size: %d x %d\n", level->fieldx, level->fieldy);
3105   printf("\n");
3106   printf("Level time:  %d seconds\n", level->time);
3107   printf("Gems needed: %d\n", level->gems_needed);
3108   printf("\n");
3109   printf("Time for magic wall: %d seconds\n", level->time_magic_wall);
3110   printf("Time for wheel:      %d seconds\n", level->time_wheel);
3111   printf("Time for light:      %d seconds\n", level->time_light);
3112   printf("Time for timegate:   %d seconds\n", level->time_timegate);
3113   printf("\n");
3114   printf("Amoeba speed: %d\n", level->amoeba_speed);
3115   printf("\n");
3116   printf("Initial gravity:             %s\n", (level->initial_gravity ? "yes" : "no"));
3117   printf("Double speed movement:       %s\n", (level->double_speed ? "yes" : "no"));
3118   printf("EM style slippery gems:      %s\n", (level->em_slippery_gems ? "yes" : "no"));
3119   printf("Player blocks last field:    %s\n", (level->block_last_field ? "yes" : "no"));
3120   printf("SP player blocks last field: %s\n", (level->sp_block_last_field ? "yes" : "no"));
3121   printf("use spring bug: %s\n", (level->use_spring_bug ? "yes" : "no"));
3122   printf("use step counter: %s\n", (level->use_step_counter ? "yes" : "no"));
3123
3124   printf_line("-", 79);
3125 }
3126
3127
3128 /* ========================================================================= */
3129 /* tape file functions                                                       */
3130 /* ========================================================================= */
3131
3132 static void setTapeInfoToDefaults()
3133 {
3134   int i;
3135
3136   /* always start with reliable default values (empty tape) */
3137   TapeErase();
3138
3139   /* default values (also for pre-1.2 tapes) with only the first player */
3140   tape.player_participates[0] = TRUE;
3141   for (i = 1; i < MAX_PLAYERS; i++)
3142     tape.player_participates[i] = FALSE;
3143
3144   /* at least one (default: the first) player participates in every tape */
3145   tape.num_participating_players = 1;
3146
3147   tape.level_nr = level_nr;
3148   tape.counter = 0;
3149   tape.changed = FALSE;
3150
3151   tape.recording = FALSE;
3152   tape.playing = FALSE;
3153   tape.pausing = FALSE;
3154
3155   tape.no_valid_file = FALSE;
3156 }
3157
3158 static int LoadTape_VERS(FILE *file, int chunk_size, struct TapeInfo *tape)
3159 {
3160   tape->file_version = getFileVersion(file);
3161   tape->game_version = getFileVersion(file);
3162
3163   return chunk_size;
3164 }
3165
3166 static int LoadTape_HEAD(FILE *file, int chunk_size, struct TapeInfo *tape)
3167 {
3168   int i;
3169
3170   tape->random_seed = getFile32BitBE(file);
3171   tape->date        = getFile32BitBE(file);
3172   tape->length      = getFile32BitBE(file);
3173
3174   /* read header fields that are new since version 1.2 */
3175   if (tape->file_version >= FILE_VERSION_1_2)
3176   {
3177     byte store_participating_players = getFile8Bit(file);
3178     int engine_version;
3179
3180     /* since version 1.2, tapes store which players participate in the tape */
3181     tape->num_participating_players = 0;
3182     for (i = 0; i < MAX_PLAYERS; i++)
3183     {
3184       tape->player_participates[i] = FALSE;
3185
3186       if (store_participating_players & (1 << i))
3187       {
3188         tape->player_participates[i] = TRUE;
3189         tape->num_participating_players++;
3190       }
3191     }
3192
3193     ReadUnusedBytesFromFile(file, TAPE_HEADER_UNUSED);
3194
3195     engine_version = getFileVersion(file);
3196     if (engine_version > 0)
3197       tape->engine_version = engine_version;
3198     else
3199       tape->engine_version = tape->game_version;
3200   }
3201
3202   return chunk_size;
3203 }
3204
3205 static int LoadTape_INFO(FILE *file, int chunk_size, struct TapeInfo *tape)
3206 {
3207   int level_identifier_size;
3208   int i;
3209
3210   level_identifier_size = getFile16BitBE(file);
3211
3212   tape->level_identifier =
3213     checked_realloc(tape->level_identifier, level_identifier_size);
3214
3215   for (i = 0; i < level_identifier_size; i++)
3216     tape->level_identifier[i] = getFile8Bit(file);
3217
3218   tape->level_nr = getFile16BitBE(file);
3219
3220   chunk_size = 2 + level_identifier_size + 2;
3221
3222   return chunk_size;
3223 }
3224
3225 static int LoadTape_BODY(FILE *file, int chunk_size, struct TapeInfo *tape)
3226 {
3227   int i, j;
3228   int chunk_size_expected =
3229     (tape->num_participating_players + 1) * tape->length;
3230
3231   if (chunk_size_expected != chunk_size)
3232   {
3233     ReadUnusedBytesFromFile(file, chunk_size);
3234     return chunk_size_expected;
3235   }
3236
3237   for (i = 0; i < tape->length; i++)
3238   {
3239     if (i >= MAX_TAPELEN)
3240       break;
3241
3242     for (j = 0; j < MAX_PLAYERS; j++)
3243     {
3244       tape->pos[i].action[j] = MV_NO_MOVING;
3245
3246       if (tape->player_participates[j])
3247         tape->pos[i].action[j] = getFile8Bit(file);
3248     }
3249
3250     tape->pos[i].delay = getFile8Bit(file);
3251
3252     if (tape->file_version == FILE_VERSION_1_0)
3253     {
3254       /* eliminate possible diagonal moves in old tapes */
3255       /* this is only for backward compatibility */
3256
3257       byte joy_dir[4] = { JOY_LEFT, JOY_RIGHT, JOY_UP, JOY_DOWN };
3258       byte action = tape->pos[i].action[0];
3259       int k, num_moves = 0;
3260
3261       for (k = 0; k<4; k++)
3262       {
3263         if (action & joy_dir[k])
3264         {
3265           tape->pos[i + num_moves].action[0] = joy_dir[k];
3266           if (num_moves > 0)
3267             tape->pos[i + num_moves].delay = 0;
3268           num_moves++;
3269         }
3270       }
3271
3272       if (num_moves > 1)
3273       {
3274         num_moves--;
3275         i += num_moves;
3276         tape->length += num_moves;
3277       }
3278     }
3279     else if (tape->file_version < FILE_VERSION_2_0)
3280     {
3281       /* convert pre-2.0 tapes to new tape format */
3282
3283       if (tape->pos[i].delay > 1)
3284       {
3285         /* action part */
3286         tape->pos[i + 1] = tape->pos[i];
3287         tape->pos[i + 1].delay = 1;
3288
3289         /* delay part */
3290         for (j = 0; j < MAX_PLAYERS; j++)
3291           tape->pos[i].action[j] = MV_NO_MOVING;
3292         tape->pos[i].delay--;
3293
3294         i++;
3295         tape->length++;
3296       }
3297     }
3298
3299     if (feof(file))
3300       break;
3301   }
3302
3303   if (i != tape->length)
3304     chunk_size = (tape->num_participating_players + 1) * i;
3305
3306   return chunk_size;
3307 }
3308
3309 void LoadTapeFromFilename(char *filename)
3310 {
3311   char cookie[MAX_LINE_LEN];
3312   char chunk_name[CHUNK_ID_LEN + 1];
3313   FILE *file;
3314   int chunk_size;
3315
3316   /* always start with reliable default values */
3317   setTapeInfoToDefaults();
3318
3319   if (!(file = fopen(filename, MODE_READ)))
3320   {
3321     tape.no_valid_file = TRUE;
3322
3323 #if 0
3324     Error(ERR_WARN, "cannot read tape '%s' -- using empty tape", filename);
3325 #endif
3326
3327     return;
3328   }
3329
3330   getFileChunkBE(file, chunk_name, NULL);
3331   if (strcmp(chunk_name, "RND1") == 0)
3332   {
3333     getFile32BitBE(file);               /* not used */
3334
3335     getFileChunkBE(file, chunk_name, NULL);
3336     if (strcmp(chunk_name, "TAPE") != 0)
3337     {
3338       tape.no_valid_file = TRUE;
3339
3340       Error(ERR_WARN, "unknown format of tape file '%s'", filename);
3341       fclose(file);
3342       return;
3343     }
3344   }
3345   else  /* check for pre-2.0 file format with cookie string */
3346   {
3347     strcpy(cookie, chunk_name);
3348     fgets(&cookie[4], MAX_LINE_LEN - 4, file);
3349     if (strlen(cookie) > 0 && cookie[strlen(cookie) - 1] == '\n')
3350       cookie[strlen(cookie) - 1] = '\0';
3351
3352     if (!checkCookieString(cookie, TAPE_COOKIE_TMPL))
3353     {
3354       tape.no_valid_file = TRUE;
3355
3356       Error(ERR_WARN, "unknown format of tape file '%s'", filename);
3357       fclose(file);
3358       return;
3359     }
3360
3361     if ((tape.file_version = getFileVersionFromCookieString(cookie)) == -1)
3362     {
3363       tape.no_valid_file = TRUE;
3364
3365       Error(ERR_WARN, "unsupported version of tape file '%s'", filename);
3366       fclose(file);
3367       return;
3368     }
3369
3370     /* pre-2.0 tape files have no game version, so use file version here */
3371     tape.game_version = tape.file_version;
3372   }
3373
3374   if (tape.file_version < FILE_VERSION_1_2)
3375   {
3376     /* tape files from versions before 1.2.0 without chunk structure */
3377     LoadTape_HEAD(file, TAPE_HEADER_SIZE, &tape);
3378     LoadTape_BODY(file, 2 * tape.length,  &tape);
3379   }
3380   else
3381   {
3382     static struct
3383     {
3384       char *name;
3385       int size;
3386       int (*loader)(FILE *, int, struct TapeInfo *);
3387     }
3388     chunk_info[] =
3389     {
3390       { "VERS", FILE_VERS_CHUNK_SIZE,   LoadTape_VERS },
3391       { "HEAD", TAPE_HEADER_SIZE,       LoadTape_HEAD },
3392       { "INFO", -1,                     LoadTape_INFO },
3393       { "BODY", -1,                     LoadTape_BODY },
3394       {  NULL,  0,                      NULL }
3395     };
3396
3397     while (getFileChunkBE(file, chunk_name, &chunk_size))
3398     {
3399       int i = 0;
3400
3401       while (chunk_info[i].name != NULL &&
3402              strcmp(chunk_name, chunk_info[i].name) != 0)
3403         i++;
3404
3405       if (chunk_info[i].name == NULL)
3406       {
3407         Error(ERR_WARN, "unknown chunk '%s' in tape file '%s'",
3408               chunk_name, filename);
3409         ReadUnusedBytesFromFile(file, chunk_size);
3410       }
3411       else if (chunk_info[i].size != -1 &&
3412                chunk_info[i].size != chunk_size)
3413       {
3414         Error(ERR_WARN, "wrong size (%d) of chunk '%s' in tape file '%s'",
3415               chunk_size, chunk_name, filename);
3416         ReadUnusedBytesFromFile(file, chunk_size);
3417       }
3418       else
3419       {
3420         /* call function to load this tape chunk */
3421         int chunk_size_expected =
3422           (chunk_info[i].loader)(file, chunk_size, &tape);
3423
3424         /* the size of some chunks cannot be checked before reading other
3425            chunks first (like "HEAD" and "BODY") that contain some header
3426            information, so check them here */
3427         if (chunk_size_expected != chunk_size)
3428         {
3429           Error(ERR_WARN, "wrong size (%d) of chunk '%s' in tape file '%s'",
3430                 chunk_size, chunk_name, filename);
3431         }
3432       }
3433     }
3434   }
3435
3436   fclose(file);
3437
3438   tape.length_seconds = GetTapeLength();
3439
3440 #if 0
3441   printf("::: tape game version: %d\n", tape.game_version);
3442   printf("::: tape engine version: %d\n", tape.engine_version);
3443 #endif
3444 }
3445
3446 void LoadTape(int nr)
3447 {
3448   char *filename = getTapeFilename(nr);
3449
3450   LoadTapeFromFilename(filename);
3451 }
3452
3453 void LoadSolutionTape(int nr)
3454 {
3455   char *filename = getSolutionTapeFilename(nr);
3456
3457   LoadTapeFromFilename(filename);
3458 }
3459
3460 static void SaveTape_VERS(FILE *file, struct TapeInfo *tape)
3461 {
3462   putFileVersion(file, tape->file_version);
3463   putFileVersion(file, tape->game_version);
3464 }
3465
3466 static void SaveTape_HEAD(FILE *file, struct TapeInfo *tape)
3467 {
3468   int i;
3469   byte store_participating_players = 0;
3470
3471   /* set bits for participating players for compact storage */
3472   for (i = 0; i < MAX_PLAYERS; i++)
3473     if (tape->player_participates[i])
3474       store_participating_players |= (1 << i);
3475
3476   putFile32BitBE(file, tape->random_seed);
3477   putFile32BitBE(file, tape->date);
3478   putFile32BitBE(file, tape->length);
3479
3480   putFile8Bit(file, store_participating_players);
3481
3482   /* unused bytes not at the end here for 4-byte alignment of engine_version */
3483   WriteUnusedBytesToFile(file, TAPE_HEADER_UNUSED);
3484
3485   putFileVersion(file, tape->engine_version);
3486 }
3487
3488 static void SaveTape_INFO(FILE *file, struct TapeInfo *tape)
3489 {
3490   int level_identifier_size = strlen(tape->level_identifier) + 1;
3491   int i;
3492
3493   putFile16BitBE(file, level_identifier_size);
3494
3495   for (i = 0; i < level_identifier_size; i++)
3496     putFile8Bit(file, tape->level_identifier[i]);
3497
3498   putFile16BitBE(file, tape->level_nr);
3499 }
3500
3501 static void SaveTape_BODY(FILE *file, struct TapeInfo *tape)
3502 {
3503   int i, j;
3504
3505   for (i = 0; i < tape->length; i++)
3506   {
3507     for (j = 0; j < MAX_PLAYERS; j++)
3508       if (tape->player_participates[j])
3509         putFile8Bit(file, tape->pos[i].action[j]);
3510
3511     putFile8Bit(file, tape->pos[i].delay);
3512   }
3513 }
3514
3515 void SaveTape(int nr)
3516 {
3517   char *filename = getTapeFilename(nr);
3518   FILE *file;
3519   boolean new_tape = TRUE;
3520   int num_participating_players = 0;
3521   int info_chunk_size;
3522   int body_chunk_size;
3523   int i;
3524
3525   InitTapeDirectory(leveldir_current->subdir);
3526
3527   /* if a tape still exists, ask to overwrite it */
3528   if (access(filename, F_OK) == 0)
3529   {
3530     new_tape = FALSE;
3531     if (!Request("Replace old tape ?", REQ_ASK))
3532       return;
3533   }
3534
3535   if (!(file = fopen(filename, MODE_WRITE)))
3536   {
3537     Error(ERR_WARN, "cannot save level recording file '%s'", filename);
3538     return;
3539   }
3540
3541   tape.file_version = FILE_VERSION_ACTUAL;
3542   tape.game_version = GAME_VERSION_ACTUAL;
3543
3544   /* count number of participating players  */
3545   for (i = 0; i < MAX_PLAYERS; i++)
3546     if (tape.player_participates[i])
3547       num_participating_players++;
3548
3549   info_chunk_size = 2 + (strlen(tape.level_identifier) + 1) + 2;
3550   body_chunk_size = (num_participating_players + 1) * tape.length;
3551
3552   putFileChunkBE(file, "RND1", CHUNK_SIZE_UNDEFINED);
3553   putFileChunkBE(file, "TAPE", CHUNK_SIZE_NONE);
3554
3555   putFileChunkBE(file, "VERS", FILE_VERS_CHUNK_SIZE);
3556   SaveTape_VERS(file, &tape);
3557
3558   putFileChunkBE(file, "HEAD", TAPE_HEADER_SIZE);
3559   SaveTape_HEAD(file, &tape);
3560
3561   putFileChunkBE(file, "INFO", info_chunk_size);
3562   SaveTape_INFO(file, &tape);
3563
3564   putFileChunkBE(file, "BODY", body_chunk_size);
3565   SaveTape_BODY(file, &tape);
3566
3567   fclose(file);
3568
3569   SetFilePermissions(filename, PERMS_PRIVATE);
3570
3571   tape.changed = FALSE;
3572
3573   if (new_tape)
3574     Request("tape saved !", REQ_CONFIRM);
3575 }
3576
3577 void DumpTape(struct TapeInfo *tape)
3578 {
3579   int i, j;
3580
3581 #if 1
3582   if (tape->no_valid_file)
3583   {
3584     Error(ERR_WARN, "cannot dump -- no valid tape file found");
3585
3586     return;
3587   }
3588 #else
3589   if (TAPE_IS_EMPTY(*tape))
3590   {
3591     Error(ERR_WARN, "no tape available for level %d", tape->level_nr);
3592
3593     return;
3594   }
3595 #endif
3596
3597   printf_line("-", 79);
3598   printf("Tape of Level %03d (file version %08d, game version %08d)\n",
3599          tape->level_nr, tape->file_version, tape->game_version);
3600   printf("Level series identifier: '%s'\n", tape->level_identifier);
3601   printf_line("-", 79);
3602
3603   for (i = 0; i < tape->length; i++)
3604   {
3605     if (i >= MAX_TAPELEN)
3606       break;
3607
3608     printf("%03d: ", i);
3609
3610     for (j = 0; j < MAX_PLAYERS; j++)
3611     {
3612       if (tape->player_participates[j])
3613       {
3614         int action = tape->pos[i].action[j];
3615
3616         printf("%d:%02x ", j, action);
3617         printf("[%c%c%c%c|%c%c] - ",
3618                (action & JOY_LEFT ? '<' : ' '),
3619                (action & JOY_RIGHT ? '>' : ' '),
3620                (action & JOY_UP ? '^' : ' '),
3621                (action & JOY_DOWN ? 'v' : ' '),
3622                (action & JOY_BUTTON_1 ? '1' : ' '),
3623                (action & JOY_BUTTON_2 ? '2' : ' '));
3624       }
3625     }
3626
3627     printf("(%03d)\n", tape->pos[i].delay);
3628   }
3629
3630   printf_line("-", 79);
3631 }
3632
3633
3634 /* ========================================================================= */
3635 /* score file functions                                                      */
3636 /* ========================================================================= */
3637
3638 void LoadScore(int nr)
3639 {
3640   int i;
3641   char *filename = getScoreFilename(nr);
3642   char cookie[MAX_LINE_LEN];
3643   char line[MAX_LINE_LEN];
3644   char *line_ptr;
3645   FILE *file;
3646
3647   /* always start with reliable default values */
3648   for (i = 0; i < MAX_SCORE_ENTRIES; i++)
3649   {
3650     strcpy(highscore[i].Name, EMPTY_PLAYER_NAME);
3651     highscore[i].Score = 0;
3652   }
3653
3654   if (!(file = fopen(filename, MODE_READ)))
3655     return;
3656
3657   /* check file identifier */
3658   fgets(cookie, MAX_LINE_LEN, file);
3659   if (strlen(cookie) > 0 && cookie[strlen(cookie) - 1] == '\n')
3660     cookie[strlen(cookie) - 1] = '\0';
3661
3662   if (!checkCookieString(cookie, SCORE_COOKIE))
3663   {
3664     Error(ERR_WARN, "unknown format of score file '%s'", filename);
3665     fclose(file);
3666     return;
3667   }
3668
3669   for (i = 0; i < MAX_SCORE_ENTRIES; i++)
3670   {
3671     fscanf(file, "%d", &highscore[i].Score);
3672     fgets(line, MAX_LINE_LEN, file);
3673
3674     if (line[strlen(line) - 1] == '\n')
3675       line[strlen(line) - 1] = '\0';
3676
3677     for (line_ptr = line; *line_ptr; line_ptr++)
3678     {
3679       if (*line_ptr != ' ' && *line_ptr != '\t' && *line_ptr != '\0')
3680       {
3681         strncpy(highscore[i].Name, line_ptr, MAX_PLAYER_NAME_LEN);
3682         highscore[i].Name[MAX_PLAYER_NAME_LEN] = '\0';
3683         break;
3684       }
3685     }
3686   }
3687
3688   fclose(file);
3689 }
3690
3691 void SaveScore(int nr)
3692 {
3693   int i;
3694   char *filename = getScoreFilename(nr);
3695   FILE *file;
3696
3697   InitScoreDirectory(leveldir_current->subdir);
3698
3699   if (!(file = fopen(filename, MODE_WRITE)))
3700   {
3701     Error(ERR_WARN, "cannot save score for level %d", nr);
3702     return;
3703   }
3704
3705   fprintf(file, "%s\n\n", SCORE_COOKIE);
3706
3707   for (i = 0; i < MAX_SCORE_ENTRIES; i++)
3708     fprintf(file, "%d %s\n", highscore[i].Score, highscore[i].Name);
3709
3710   fclose(file);
3711
3712   SetFilePermissions(filename, PERMS_PUBLIC);
3713 }
3714
3715
3716 /* ========================================================================= */
3717 /* setup file functions                                                      */
3718 /* ========================================================================= */
3719
3720 #define TOKEN_STR_PLAYER_PREFIX                 "player_"
3721
3722 /* global setup */
3723 #define SETUP_TOKEN_PLAYER_NAME                 0
3724 #define SETUP_TOKEN_SOUND                       1
3725 #define SETUP_TOKEN_SOUND_LOOPS                 2
3726 #define SETUP_TOKEN_SOUND_MUSIC                 3
3727 #define SETUP_TOKEN_SOUND_SIMPLE                4
3728 #define SETUP_TOKEN_TOONS                       5
3729 #define SETUP_TOKEN_SCROLL_DELAY                6
3730 #define SETUP_TOKEN_SOFT_SCROLLING              7
3731 #define SETUP_TOKEN_FADING                      8
3732 #define SETUP_TOKEN_AUTORECORD                  9
3733 #define SETUP_TOKEN_QUICK_DOORS                 10
3734 #define SETUP_TOKEN_TEAM_MODE                   11
3735 #define SETUP_TOKEN_HANDICAP                    12
3736 #define SETUP_TOKEN_TIME_LIMIT                  13
3737 #define SETUP_TOKEN_FULLSCREEN                  14
3738 #define SETUP_TOKEN_ASK_ON_ESCAPE               15
3739 #define SETUP_TOKEN_GRAPHICS_SET                16
3740 #define SETUP_TOKEN_SOUNDS_SET                  17
3741 #define SETUP_TOKEN_MUSIC_SET                   18
3742 #define SETUP_TOKEN_OVERRIDE_LEVEL_GRAPHICS     19
3743 #define SETUP_TOKEN_OVERRIDE_LEVEL_SOUNDS       20
3744 #define SETUP_TOKEN_OVERRIDE_LEVEL_MUSIC        21
3745
3746 #define NUM_GLOBAL_SETUP_TOKENS                 22
3747
3748 /* editor setup */
3749 #define SETUP_TOKEN_EDITOR_EL_BOULDERDASH       0
3750 #define SETUP_TOKEN_EDITOR_EL_EMERALD_MINE      1
3751 #define SETUP_TOKEN_EDITOR_EL_MORE              2
3752 #define SETUP_TOKEN_EDITOR_EL_SOKOBAN           3
3753 #define SETUP_TOKEN_EDITOR_EL_SUPAPLEX          4
3754 #define SETUP_TOKEN_EDITOR_EL_DIAMOND_CAVES     5
3755 #define SETUP_TOKEN_EDITOR_EL_DX_BOULDERDASH    6
3756 #define SETUP_TOKEN_EDITOR_EL_CHARS             7
3757 #define SETUP_TOKEN_EDITOR_EL_CUSTOM            8
3758 #define SETUP_TOKEN_EDITOR_EL_CUSTOM_MORE       9
3759 #define SETUP_TOKEN_EDITOR_EL_HEADLINES         10
3760 #define SETUP_TOKEN_EDITOR_EL_USER_DEFINED      11
3761
3762 #define NUM_EDITOR_SETUP_TOKENS                 12
3763
3764 /* shortcut setup */
3765 #define SETUP_TOKEN_SHORTCUT_SAVE_GAME          0
3766 #define SETUP_TOKEN_SHORTCUT_LOAD_GAME          1
3767 #define SETUP_TOKEN_SHORTCUT_TOGGLE_PAUSE       2
3768
3769 #define NUM_SHORTCUT_SETUP_TOKENS               3
3770
3771 /* player setup */
3772 #define SETUP_TOKEN_PLAYER_USE_JOYSTICK         0
3773 #define SETUP_TOKEN_PLAYER_JOY_DEVICE_NAME      1
3774 #define SETUP_TOKEN_PLAYER_JOY_XLEFT            2
3775 #define SETUP_TOKEN_PLAYER_JOY_XMIDDLE          3
3776 #define SETUP_TOKEN_PLAYER_JOY_XRIGHT           4
3777 #define SETUP_TOKEN_PLAYER_JOY_YUPPER           5
3778 #define SETUP_TOKEN_PLAYER_JOY_YMIDDLE          6
3779 #define SETUP_TOKEN_PLAYER_JOY_YLOWER           7
3780 #define SETUP_TOKEN_PLAYER_JOY_SNAP             8
3781 #define SETUP_TOKEN_PLAYER_JOY_DROP             9
3782 #define SETUP_TOKEN_PLAYER_KEY_LEFT             10
3783 #define SETUP_TOKEN_PLAYER_KEY_RIGHT            11
3784 #define SETUP_TOKEN_PLAYER_KEY_UP               12
3785 #define SETUP_TOKEN_PLAYER_KEY_DOWN             13
3786 #define SETUP_TOKEN_PLAYER_KEY_SNAP             14
3787 #define SETUP_TOKEN_PLAYER_KEY_DROP             15
3788
3789 #define NUM_PLAYER_SETUP_TOKENS                 16
3790
3791 /* system setup */
3792 #define SETUP_TOKEN_SYSTEM_SDL_AUDIODRIVER      0
3793 #define SETUP_TOKEN_SYSTEM_AUDIO_FRAGMENT_SIZE  1
3794
3795 #define NUM_SYSTEM_SETUP_TOKENS                 2
3796
3797 /* options setup */
3798 #define SETUP_TOKEN_OPTIONS_VERBOSE             0
3799
3800 #define NUM_OPTIONS_SETUP_TOKENS                1
3801
3802
3803 static struct SetupInfo si;
3804 static struct SetupEditorInfo sei;
3805 static struct SetupShortcutInfo ssi;
3806 static struct SetupInputInfo sii;
3807 static struct SetupSystemInfo syi;
3808 static struct OptionInfo soi;
3809
3810 static struct TokenInfo global_setup_tokens[] =
3811 {
3812   { TYPE_STRING, &si.player_name,       "player_name"                   },
3813   { TYPE_SWITCH, &si.sound,             "sound"                         },
3814   { TYPE_SWITCH, &si.sound_loops,       "repeating_sound_loops"         },
3815   { TYPE_SWITCH, &si.sound_music,       "background_music"              },
3816   { TYPE_SWITCH, &si.sound_simple,      "simple_sound_effects"          },
3817   { TYPE_SWITCH, &si.toons,             "toons"                         },
3818   { TYPE_SWITCH, &si.scroll_delay,      "scroll_delay"                  },
3819   { TYPE_SWITCH, &si.soft_scrolling,    "soft_scrolling"                },
3820   { TYPE_SWITCH, &si.fading,            "screen_fading"                 },
3821   { TYPE_SWITCH, &si.autorecord,        "automatic_tape_recording"      },
3822   { TYPE_SWITCH, &si.quick_doors,       "quick_doors"                   },
3823   { TYPE_SWITCH, &si.team_mode,         "team_mode"                     },
3824   { TYPE_SWITCH, &si.handicap,          "handicap"                      },
3825   { TYPE_SWITCH, &si.time_limit,        "time_limit"                    },
3826   { TYPE_SWITCH, &si.fullscreen,        "fullscreen"                    },
3827   { TYPE_SWITCH, &si.ask_on_escape,     "ask_on_escape"                 },
3828   { TYPE_STRING, &si.graphics_set,      "graphics_set"                  },
3829   { TYPE_STRING, &si.sounds_set,        "sounds_set"                    },
3830   { TYPE_STRING, &si.music_set,         "music_set"                     },
3831   { TYPE_SWITCH, &si.override_level_graphics, "override_level_graphics" },
3832   { TYPE_SWITCH, &si.override_level_sounds,   "override_level_sounds"   },
3833   { TYPE_SWITCH, &si.override_level_music,    "override_level_music"    },
3834 };
3835
3836 static struct TokenInfo editor_setup_tokens[] =
3837 {
3838   { TYPE_SWITCH, &sei.el_boulderdash,   "editor.el_boulderdash"         },
3839   { TYPE_SWITCH, &sei.el_emerald_mine,  "editor.el_emerald_mine"        },
3840   { TYPE_SWITCH, &sei.el_more,          "editor.el_more"                },
3841   { TYPE_SWITCH, &sei.el_sokoban,       "editor.el_sokoban"             },
3842   { TYPE_SWITCH, &sei.el_supaplex,      "editor.el_supaplex"            },
3843   { TYPE_SWITCH, &sei.el_diamond_caves, "editor.el_diamond_caves"       },
3844   { TYPE_SWITCH, &sei.el_dx_boulderdash,"editor.el_dx_boulderdash"      },
3845   { TYPE_SWITCH, &sei.el_chars,         "editor.el_chars"               },
3846   { TYPE_SWITCH, &sei.el_custom,        "editor.el_custom"              },
3847   { TYPE_SWITCH, &sei.el_custom_more,   "editor.el_custom_more"         },
3848   { TYPE_SWITCH, &sei.el_headlines,     "editor.el_headlines"           },
3849   { TYPE_SWITCH, &sei.el_user_defined,  "editor.el_user_defined"        },
3850 };
3851
3852 static struct TokenInfo shortcut_setup_tokens[] =
3853 {
3854   { TYPE_KEY_X11, &ssi.save_game,       "shortcut.save_game"            },
3855   { TYPE_KEY_X11, &ssi.load_game,       "shortcut.load_game"            },
3856   { TYPE_KEY_X11, &ssi.toggle_pause,    "shortcut.toggle_pause"         }
3857 };
3858
3859 static struct TokenInfo player_setup_tokens[] =
3860 {
3861   { TYPE_BOOLEAN, &sii.use_joystick,    ".use_joystick"                 },
3862   { TYPE_STRING,  &sii.joy.device_name, ".joy.device_name"              },
3863   { TYPE_INTEGER, &sii.joy.xleft,       ".joy.xleft"                    },
3864   { TYPE_INTEGER, &sii.joy.xmiddle,     ".joy.xmiddle"                  },
3865   { TYPE_INTEGER, &sii.joy.xright,      ".joy.xright"                   },
3866   { TYPE_INTEGER, &sii.joy.yupper,      ".joy.yupper"                   },
3867   { TYPE_INTEGER, &sii.joy.ymiddle,     ".joy.ymiddle"                  },
3868   { TYPE_INTEGER, &sii.joy.ylower,      ".joy.ylower"                   },
3869   { TYPE_INTEGER, &sii.joy.snap,        ".joy.snap_field"               },
3870   { TYPE_INTEGER, &sii.joy.drop,        ".joy.place_bomb"               },
3871   { TYPE_KEY_X11, &sii.key.left,        ".key.move_left"                },
3872   { TYPE_KEY_X11, &sii.key.right,       ".key.move_right"               },
3873   { TYPE_KEY_X11, &sii.key.up,          ".key.move_up"                  },
3874   { TYPE_KEY_X11, &sii.key.down,        ".key.move_down"                },
3875   { TYPE_KEY_X11, &sii.key.snap,        ".key.snap_field"               },
3876   { TYPE_KEY_X11, &sii.key.drop,        ".key.place_bomb"               }
3877 };
3878
3879 static struct TokenInfo system_setup_tokens[] =
3880 {
3881   { TYPE_STRING,  &syi.sdl_audiodriver, "system.sdl_audiodriver"        },
3882   { TYPE_INTEGER, &syi.audio_fragment_size,"system.audio_fragment_size" }
3883 };
3884
3885 static struct TokenInfo options_setup_tokens[] =
3886 {
3887   { TYPE_BOOLEAN, &soi.verbose,         "options.verbose"               }
3888 };
3889
3890 static char *get_corrected_login_name(char *login_name)
3891 {
3892   /* needed because player name must be a fixed length string */
3893   char *login_name_new = checked_malloc(MAX_PLAYER_NAME_LEN + 1);
3894
3895   strncpy(login_name_new, login_name, MAX_PLAYER_NAME_LEN);
3896   login_name_new[MAX_PLAYER_NAME_LEN] = '\0';
3897
3898   if (strlen(login_name) > MAX_PLAYER_NAME_LEN)         /* name has been cut */
3899     if (strchr(login_name_new, ' '))
3900       *strchr(login_name_new, ' ') = '\0';
3901
3902   return login_name_new;
3903 }
3904
3905 static void setSetupInfoToDefaults(struct SetupInfo *si)
3906 {
3907   int i;
3908
3909   si->player_name = get_corrected_login_name(getLoginName());
3910
3911   si->sound = TRUE;
3912   si->sound_loops = TRUE;
3913   si->sound_music = TRUE;
3914   si->sound_simple = TRUE;
3915   si->toons = TRUE;
3916   si->double_buffering = TRUE;
3917   si->direct_draw = !si->double_buffering;
3918   si->scroll_delay = TRUE;
3919   si->soft_scrolling = TRUE;
3920   si->fading = FALSE;
3921   si->autorecord = TRUE;
3922   si->quick_doors = FALSE;
3923   si->team_mode = FALSE;
3924   si->handicap = TRUE;
3925   si->time_limit = TRUE;
3926   si->fullscreen = FALSE;
3927   si->ask_on_escape = TRUE;
3928
3929   si->graphics_set = getStringCopy(GFX_CLASSIC_SUBDIR);
3930   si->sounds_set = getStringCopy(SND_CLASSIC_SUBDIR);
3931   si->music_set = getStringCopy(MUS_CLASSIC_SUBDIR);
3932   si->override_level_graphics = FALSE;
3933   si->override_level_sounds = FALSE;
3934   si->override_level_music = FALSE;
3935
3936   si->editor.el_boulderdash = TRUE;
3937   si->editor.el_emerald_mine = TRUE;
3938   si->editor.el_more = TRUE;
3939   si->editor.el_sokoban = TRUE;
3940   si->editor.el_supaplex = TRUE;
3941   si->editor.el_diamond_caves = TRUE;
3942   si->editor.el_dx_boulderdash = TRUE;
3943   si->editor.el_chars = TRUE;
3944   si->editor.el_custom = TRUE;
3945   si->editor.el_custom_more = FALSE;
3946
3947   si->editor.el_headlines = TRUE;
3948   si->editor.el_user_defined = FALSE;
3949
3950   si->shortcut.save_game = DEFAULT_KEY_SAVE_GAME;
3951   si->shortcut.load_game = DEFAULT_KEY_LOAD_GAME;
3952   si->shortcut.toggle_pause = DEFAULT_KEY_TOGGLE_PAUSE;
3953
3954   for (i = 0; i < MAX_PLAYERS; i++)
3955   {
3956     si->input[i].use_joystick = FALSE;
3957     si->input[i].joy.device_name=getStringCopy(getDeviceNameFromJoystickNr(i));
3958     si->input[i].joy.xleft   = JOYSTICK_XLEFT;
3959     si->input[i].joy.xmiddle = JOYSTICK_XMIDDLE;
3960     si->input[i].joy.xright  = JOYSTICK_XRIGHT;
3961     si->input[i].joy.yupper  = JOYSTICK_YUPPER;
3962     si->input[i].joy.ymiddle = JOYSTICK_YMIDDLE;
3963     si->input[i].joy.ylower  = JOYSTICK_YLOWER;
3964     si->input[i].joy.snap  = (i == 0 ? JOY_BUTTON_1 : 0);
3965     si->input[i].joy.drop  = (i == 0 ? JOY_BUTTON_2 : 0);
3966     si->input[i].key.left  = (i == 0 ? DEFAULT_KEY_LEFT  : KSYM_UNDEFINED);
3967     si->input[i].key.right = (i == 0 ? DEFAULT_KEY_RIGHT : KSYM_UNDEFINED);
3968     si->input[i].key.up    = (i == 0 ? DEFAULT_KEY_UP    : KSYM_UNDEFINED);
3969     si->input[i].key.down  = (i == 0 ? DEFAULT_KEY_DOWN  : KSYM_UNDEFINED);
3970     si->input[i].key.snap  = (i == 0 ? DEFAULT_KEY_SNAP  : KSYM_UNDEFINED);
3971     si->input[i].key.drop  = (i == 0 ? DEFAULT_KEY_DROP  : KSYM_UNDEFINED);
3972   }
3973
3974   si->system.sdl_audiodriver = getStringCopy(ARG_DEFAULT);
3975   si->system.audio_fragment_size = DEFAULT_AUDIO_FRAGMENT_SIZE;
3976
3977   si->options.verbose = FALSE;
3978 }
3979
3980 static void decodeSetupFileHash(SetupFileHash *setup_file_hash)
3981 {
3982   int i, pnr;
3983
3984   if (!setup_file_hash)
3985     return;
3986
3987   /* global setup */
3988   si = setup;
3989   for (i = 0; i < NUM_GLOBAL_SETUP_TOKENS; i++)
3990     setSetupInfo(global_setup_tokens, i,
3991                  getHashEntry(setup_file_hash, global_setup_tokens[i].text));
3992   setup = si;
3993
3994   /* editor setup */
3995   sei = setup.editor;
3996   for (i = 0; i < NUM_EDITOR_SETUP_TOKENS; i++)
3997     setSetupInfo(editor_setup_tokens, i,
3998                  getHashEntry(setup_file_hash,editor_setup_tokens[i].text));
3999   setup.editor = sei;
4000
4001   /* shortcut setup */
4002   ssi = setup.shortcut;
4003   for (i = 0; i < NUM_SHORTCUT_SETUP_TOKENS; i++)
4004     setSetupInfo(shortcut_setup_tokens, i,
4005                  getHashEntry(setup_file_hash,shortcut_setup_tokens[i].text));
4006   setup.shortcut = ssi;
4007
4008   /* player setup */
4009   for (pnr = 0; pnr < MAX_PLAYERS; pnr++)
4010   {
4011     char prefix[30];
4012
4013     sprintf(prefix, "%s%d", TOKEN_STR_PLAYER_PREFIX, pnr + 1);
4014
4015     sii = setup.input[pnr];
4016     for (i = 0; i < NUM_PLAYER_SETUP_TOKENS; i++)
4017     {
4018       char full_token[100];
4019
4020       sprintf(full_token, "%s%s", prefix, player_setup_tokens[i].text);
4021       setSetupInfo(player_setup_tokens, i,
4022                    getHashEntry(setup_file_hash, full_token));
4023     }
4024     setup.input[pnr] = sii;
4025   }
4026
4027   /* system setup */
4028   syi = setup.system;
4029   for (i = 0; i < NUM_SYSTEM_SETUP_TOKENS; i++)
4030     setSetupInfo(system_setup_tokens, i,
4031                  getHashEntry(setup_file_hash, system_setup_tokens[i].text));
4032   setup.system = syi;
4033
4034   /* options setup */
4035   soi = setup.options;
4036   for (i = 0; i < NUM_OPTIONS_SETUP_TOKENS; i++)
4037     setSetupInfo(options_setup_tokens, i,
4038                  getHashEntry(setup_file_hash, options_setup_tokens[i].text));
4039   setup.options = soi;
4040 }
4041
4042 void LoadSetup()
4043 {
4044   char *filename = getSetupFilename();
4045   SetupFileHash *setup_file_hash = NULL;
4046
4047   /* always start with reliable default values */
4048   setSetupInfoToDefaults(&setup);
4049
4050   setup_file_hash = loadSetupFileHash(filename);
4051
4052   if (setup_file_hash)
4053   {
4054     char *player_name_new;
4055
4056     checkSetupFileHashIdentifier(setup_file_hash, getCookie("SETUP"));
4057     decodeSetupFileHash(setup_file_hash);
4058
4059     setup.direct_draw = !setup.double_buffering;
4060
4061     freeSetupFileHash(setup_file_hash);
4062
4063     /* needed to work around problems with fixed length strings */
4064     player_name_new = get_corrected_login_name(setup.player_name);
4065     free(setup.player_name);
4066     setup.player_name = player_name_new;
4067   }
4068   else
4069     Error(ERR_WARN, "using default setup values");
4070 }
4071
4072 void SaveSetup()
4073 {
4074   char *filename = getSetupFilename();
4075   FILE *file;
4076   int i, pnr;
4077
4078   InitUserDataDirectory();
4079
4080   if (!(file = fopen(filename, MODE_WRITE)))
4081   {
4082     Error(ERR_WARN, "cannot write setup file '%s'", filename);
4083     return;
4084   }
4085
4086   fprintf(file, "%s\n", getFormattedSetupEntry(TOKEN_STR_FILE_IDENTIFIER,
4087                                                getCookie("SETUP")));
4088   fprintf(file, "\n");
4089
4090   /* global setup */
4091   si = setup;
4092   for (i = 0; i < NUM_GLOBAL_SETUP_TOKENS; i++)
4093   {
4094     /* just to make things nicer :) */
4095     if (i == SETUP_TOKEN_PLAYER_NAME + 1 ||
4096         i == SETUP_TOKEN_GRAPHICS_SET)
4097       fprintf(file, "\n");
4098
4099     fprintf(file, "%s\n", getSetupLine(global_setup_tokens, "", i));
4100   }
4101
4102   /* editor setup */
4103   sei = setup.editor;
4104   fprintf(file, "\n");
4105   for (i = 0; i < NUM_EDITOR_SETUP_TOKENS; i++)
4106     fprintf(file, "%s\n", getSetupLine(editor_setup_tokens, "", i));
4107
4108   /* shortcut setup */
4109   ssi = setup.shortcut;
4110   fprintf(file, "\n");
4111   for (i = 0; i < NUM_SHORTCUT_SETUP_TOKENS; i++)
4112     fprintf(file, "%s\n", getSetupLine(shortcut_setup_tokens, "", i));
4113
4114   /* player setup */
4115   for (pnr = 0; pnr < MAX_PLAYERS; pnr++)
4116   {
4117     char prefix[30];
4118
4119     sprintf(prefix, "%s%d", TOKEN_STR_PLAYER_PREFIX, pnr + 1);
4120     fprintf(file, "\n");
4121
4122     sii = setup.input[pnr];
4123     for (i = 0; i < NUM_PLAYER_SETUP_TOKENS; i++)
4124       fprintf(file, "%s\n", getSetupLine(player_setup_tokens, prefix, i));
4125   }
4126
4127   /* system setup */
4128   syi = setup.system;
4129   fprintf(file, "\n");
4130   for (i = 0; i < NUM_SYSTEM_SETUP_TOKENS; i++)
4131     fprintf(file, "%s\n", getSetupLine(system_setup_tokens, "", i));
4132
4133   /* options setup */
4134   soi = setup.options;
4135   fprintf(file, "\n");
4136   for (i = 0; i < NUM_OPTIONS_SETUP_TOKENS; i++)
4137     fprintf(file, "%s\n", getSetupLine(options_setup_tokens, "", i));
4138
4139   fclose(file);
4140
4141   SetFilePermissions(filename, PERMS_PRIVATE);
4142 }
4143
4144 void LoadCustomElementDescriptions()
4145 {
4146   char *filename = getCustomArtworkConfigFilename(ARTWORK_TYPE_GRAPHICS);
4147   SetupFileHash *setup_file_hash;
4148   int i;
4149
4150   for (i = 0; i < NUM_FILE_ELEMENTS; i++)
4151   {
4152     if (element_info[i].custom_description != NULL)
4153     {
4154       free(element_info[i].custom_description);
4155       element_info[i].custom_description = NULL;
4156     }
4157   }
4158
4159   if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
4160     return;
4161
4162   for (i = 0; i < NUM_FILE_ELEMENTS; i++)
4163   {
4164     char *token = getStringCat2(element_info[i].token_name, ".name");
4165     char *value = getHashEntry(setup_file_hash, token);
4166
4167     if (value != NULL)
4168       element_info[i].custom_description = getStringCopy(value);
4169
4170     free(token);
4171   }
4172
4173   freeSetupFileHash(setup_file_hash);
4174 }
4175
4176 void LoadSpecialMenuDesignSettings()
4177 {
4178   char *filename = getCustomArtworkConfigFilename(ARTWORK_TYPE_GRAPHICS);
4179   SetupFileHash *setup_file_hash;
4180   int i, j;
4181
4182   /* always start with reliable default values from default config */
4183   for (i = 0; image_config_vars[i].token != NULL; i++)
4184     for (j = 0; image_config[j].token != NULL; j++)
4185       if (strcmp(image_config_vars[i].token, image_config[j].token) == 0)
4186         *image_config_vars[i].value =
4187           get_auto_parameter_value(image_config_vars[i].token,
4188                                    image_config[j].value);
4189
4190   if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
4191     return;
4192
4193   /* special case: initialize with default values that may be overwritten */
4194   for (i = 0; i < NUM_SPECIAL_GFX_ARGS; i++)
4195   {
4196     char *value_x = getHashEntry(setup_file_hash, "menu.draw_xoffset");
4197     char *value_y = getHashEntry(setup_file_hash, "menu.draw_yoffset");
4198     char *list_size = getHashEntry(setup_file_hash, "menu.list_size");
4199
4200     if (value_x != NULL)
4201       menu.draw_xoffset[i] = get_integer_from_string(value_x);
4202     if (value_y != NULL)
4203       menu.draw_yoffset[i] = get_integer_from_string(value_y);
4204     if (list_size != NULL)
4205       menu.list_size[i] = get_integer_from_string(list_size);
4206   }
4207
4208   /* read (and overwrite with) values that may be specified in config file */
4209   for (i = 0; image_config_vars[i].token != NULL; i++)
4210   {
4211     char *value = getHashEntry(setup_file_hash, image_config_vars[i].token);
4212
4213     if (value != NULL)
4214       *image_config_vars[i].value =
4215         get_auto_parameter_value(image_config_vars[i].token, value);
4216   }
4217
4218   freeSetupFileHash(setup_file_hash);
4219 }
4220
4221 void LoadUserDefinedEditorElementList(int **elements, int *num_elements)
4222 {
4223   char *filename = getEditorSetupFilename();
4224   SetupFileList *setup_file_list, *list;
4225   SetupFileHash *element_hash;
4226   int num_unknown_tokens = 0;
4227   int i;
4228
4229   if ((setup_file_list = loadSetupFileList(filename)) == NULL)
4230     return;
4231
4232   element_hash = newSetupFileHash();
4233
4234   for (i = 0; i < NUM_FILE_ELEMENTS; i++)
4235     setHashEntry(element_hash, element_info[i].token_name, i_to_a(i));
4236
4237   /* determined size may be larger than needed (due to unknown elements) */
4238   *num_elements = 0;
4239   for (list = setup_file_list; list != NULL; list = list->next)
4240     (*num_elements)++;
4241
4242   /* add space for up to 3 more elements for padding that may be needed */
4243   *num_elements += 3;
4244
4245   *elements = checked_malloc(*num_elements * sizeof(int));
4246
4247   *num_elements = 0;
4248   for (list = setup_file_list; list != NULL; list = list->next)
4249   {
4250     char *value = getHashEntry(element_hash, list->token);
4251
4252     if (value)
4253     {
4254       (*elements)[(*num_elements)++] = atoi(value);
4255     }
4256     else
4257     {
4258       if (num_unknown_tokens == 0)
4259       {
4260         Error(ERR_RETURN_LINE, "-");
4261         Error(ERR_RETURN, "warning: unknown token(s) found in config file:");
4262         Error(ERR_RETURN, "- config file: '%s'", filename);
4263
4264         num_unknown_tokens++;
4265       }
4266
4267       Error(ERR_RETURN, "- token: '%s'", list->token);
4268     }
4269   }
4270
4271   if (num_unknown_tokens > 0)
4272     Error(ERR_RETURN_LINE, "-");
4273
4274   while (*num_elements % 4)     /* pad with empty elements, if needed */
4275     (*elements)[(*num_elements)++] = EL_EMPTY;
4276
4277   freeSetupFileList(setup_file_list);
4278   freeSetupFileHash(element_hash);
4279
4280 #if 0
4281   /* TEST-ONLY */
4282   for (i = 0; i < *num_elements; i++)
4283     printf("editor: element '%s' [%d]\n",
4284            element_info[(*elements)[i]].token_name, (*elements)[i]);
4285 #endif
4286 }
4287
4288 static struct MusicFileInfo *get_music_file_info_ext(char *basename, int music,
4289                                                      boolean is_sound)
4290 {
4291   SetupFileHash *setup_file_hash = NULL;
4292   struct MusicFileInfo tmp_music_file_info, *new_music_file_info;
4293   char *filename_music, *filename_prefix, *filename_info;
4294   struct
4295   {
4296     char *token;
4297     char **value_ptr;
4298   }
4299   token_to_value_ptr[] =
4300   {
4301     { "title_header",   &tmp_music_file_info.title_header       },
4302     { "artist_header",  &tmp_music_file_info.artist_header      },
4303     { "album_header",   &tmp_music_file_info.album_header       },
4304     { "year_header",    &tmp_music_file_info.year_header        },
4305
4306     { "title",          &tmp_music_file_info.title              },
4307     { "artist",         &tmp_music_file_info.artist             },
4308     { "album",          &tmp_music_file_info.album              },
4309     { "year",           &tmp_music_file_info.year               },
4310
4311     { NULL,             NULL                                    },
4312   };
4313   int i;
4314
4315   filename_music = (is_sound ? getCustomSoundFilename(basename) :
4316                     getCustomMusicFilename(basename));
4317
4318   if (filename_music == NULL)
4319     return NULL;
4320
4321   /* ---------- try to replace file extension ---------- */
4322
4323   filename_prefix = getStringCopy(filename_music);
4324   if (strrchr(filename_prefix, '.') != NULL)
4325     *strrchr(filename_prefix, '.') = '\0';
4326   filename_info = getStringCat2(filename_prefix, ".txt");
4327
4328 #if 0
4329   printf("trying to load file '%s'...\n", filename_info);
4330 #endif
4331
4332   if (fileExists(filename_info))
4333     setup_file_hash = loadSetupFileHash(filename_info);
4334
4335   free(filename_prefix);
4336   free(filename_info);
4337
4338   if (setup_file_hash == NULL)
4339   {
4340     /* ---------- try to add file extension ---------- */
4341
4342     filename_prefix = getStringCopy(filename_music);
4343     filename_info = getStringCat2(filename_prefix, ".txt");
4344
4345 #if 0
4346     printf("trying to load file '%s'...\n", filename_info);
4347 #endif
4348
4349     if (fileExists(filename_info))
4350       setup_file_hash = loadSetupFileHash(filename_info);
4351
4352     free(filename_prefix);
4353     free(filename_info);
4354   }
4355
4356   if (setup_file_hash == NULL)
4357     return NULL;
4358
4359   /* ---------- music file info found ---------- */
4360
4361   memset(&tmp_music_file_info, 0, sizeof(struct MusicFileInfo));
4362
4363   for (i = 0; token_to_value_ptr[i].token != NULL; i++)
4364   {
4365     char *value = getHashEntry(setup_file_hash, token_to_value_ptr[i].token);
4366
4367     *token_to_value_ptr[i].value_ptr =
4368       getStringCopy(value != NULL && *value != '\0' ? value : UNKNOWN_NAME);
4369   }
4370
4371   tmp_music_file_info.basename = getStringCopy(basename);
4372   tmp_music_file_info.music = music;
4373   tmp_music_file_info.is_sound = is_sound;
4374
4375   new_music_file_info = checked_malloc(sizeof(struct MusicFileInfo));
4376   *new_music_file_info = tmp_music_file_info;
4377
4378   return new_music_file_info;
4379 }
4380
4381 static struct MusicFileInfo *get_music_file_info(char *basename, int music)
4382 {
4383   return get_music_file_info_ext(basename, music, FALSE);
4384 }
4385
4386 static struct MusicFileInfo *get_sound_file_info(char *basename, int sound)
4387 {
4388   return get_music_file_info_ext(basename, sound, TRUE);
4389 }
4390
4391 static boolean music_info_listed_ext(struct MusicFileInfo *list,
4392                                      char *basename, boolean is_sound)
4393 {
4394   for (; list != NULL; list = list->next)
4395     if (list->is_sound == is_sound && strcmp(list->basename, basename) == 0)
4396       return TRUE;
4397
4398   return FALSE;
4399 }
4400
4401 static boolean music_info_listed(struct MusicFileInfo *list, char *basename)
4402 {
4403   return music_info_listed_ext(list, basename, FALSE);
4404 }
4405
4406 static boolean sound_info_listed(struct MusicFileInfo *list, char *basename)
4407 {
4408   return music_info_listed_ext(list, basename, TRUE);
4409 }
4410
4411 void LoadMusicInfo()
4412 {
4413   char *music_directory = getCustomMusicDirectory();
4414   int num_music = getMusicListSize();
4415   int num_music_noconf = 0;
4416   int num_sounds = getSoundListSize();
4417   DIR *dir;
4418   struct dirent *dir_entry;
4419   struct FileInfo *music, *sound;
4420   struct MusicFileInfo *next, **new;
4421   int i;
4422
4423   while (music_file_info != NULL)
4424   {
4425     next = music_file_info->next;
4426
4427     checked_free(music_file_info->basename);
4428
4429     checked_free(music_file_info->title_header);
4430     checked_free(music_file_info->artist_header);
4431     checked_free(music_file_info->album_header);
4432     checked_free(music_file_info->year_header);
4433
4434     checked_free(music_file_info->title);
4435     checked_free(music_file_info->artist);
4436     checked_free(music_file_info->album);
4437     checked_free(music_file_info->year);
4438
4439     free(music_file_info);
4440
4441     music_file_info = next;
4442   }
4443
4444   new = &music_file_info;
4445
4446 #if 0
4447   printf("::: num_music == %d\n", num_music);
4448 #endif
4449
4450   for (i = 0; i < num_music; i++)
4451   {
4452     music = getMusicListEntry(i);
4453
4454 #if 0
4455     printf("::: %d [%08x]\n", i, music->filename);
4456 #endif
4457
4458     if (music->filename == NULL)
4459       continue;
4460
4461     if (strcmp(music->filename, UNDEFINED_FILENAME) == 0)
4462       continue;
4463
4464     /* a configured file may be not recognized as music */
4465     if (!FileIsMusic(music->filename))
4466       continue;
4467
4468 #if 0
4469     printf("::: -> '%s' (configured)\n", music->filename);
4470 #endif
4471
4472     if (!music_info_listed(music_file_info, music->filename))
4473     {
4474       *new = get_music_file_info(music->filename, i);
4475       if (*new != NULL)
4476         new = &(*new)->next;
4477     }
4478   }
4479
4480   if ((dir = opendir(music_directory)) == NULL)
4481   {
4482     Error(ERR_WARN, "cannot read music directory '%s'", music_directory);
4483     return;
4484   }
4485
4486   while ((dir_entry = readdir(dir)) != NULL)    /* loop until last dir entry */
4487   {
4488     char *basename = dir_entry->d_name;
4489     boolean music_already_used = FALSE;
4490     int i;
4491
4492     /* skip all music files that are configured in music config file */
4493     for (i = 0; i < num_music; i++)
4494     {
4495       music = getMusicListEntry(i);
4496
4497       if (music->filename == NULL)
4498         continue;
4499
4500       if (strcmp(basename, music->filename) == 0)
4501       {
4502         music_already_used = TRUE;
4503         break;
4504       }
4505     }
4506
4507     if (music_already_used)
4508       continue;
4509
4510     if (!FileIsMusic(basename))
4511       continue;
4512
4513 #if 0
4514     printf("::: -> '%s' (found in directory)\n", basename);
4515 #endif
4516
4517     if (!music_info_listed(music_file_info, basename))
4518     {
4519       *new = get_music_file_info(basename, MAP_NOCONF_MUSIC(num_music_noconf));
4520       if (*new != NULL)
4521         new = &(*new)->next;
4522     }
4523
4524     num_music_noconf++;
4525   }
4526
4527   closedir(dir);
4528
4529   for (i = 0; i < num_sounds; i++)
4530   {
4531     sound = getSoundListEntry(i);
4532
4533     if (sound->filename == NULL)
4534       continue;
4535
4536     if (strcmp(sound->filename, UNDEFINED_FILENAME) == 0)
4537       continue;
4538
4539     /* a configured file may be not recognized as sound */
4540     if (!FileIsSound(sound->filename))
4541       continue;
4542
4543 #if 0
4544     printf("::: -> '%s' (configured)\n", sound->filename);
4545 #endif
4546
4547     if (!sound_info_listed(music_file_info, sound->filename))
4548     {
4549       *new = get_sound_file_info(sound->filename, i);
4550       if (*new != NULL)
4551         new = &(*new)->next;
4552     }
4553   }
4554
4555 #if 0
4556   /* TEST-ONLY */
4557   for (next = music_file_info; next != NULL; next = next->next)
4558     printf("::: title == '%s'\n", next->title);
4559 #endif
4560 }
4561
4562 void add_helpanim_entry(int element, int action, int direction, int delay,
4563                         int *num_list_entries)
4564 {
4565   struct HelpAnimInfo *new_list_entry;
4566   (*num_list_entries)++;
4567
4568   helpanim_info =
4569     checked_realloc(helpanim_info,
4570                     *num_list_entries * sizeof(struct HelpAnimInfo));
4571   new_list_entry = &helpanim_info[*num_list_entries - 1];
4572
4573   new_list_entry->element = element;
4574   new_list_entry->action = action;
4575   new_list_entry->direction = direction;
4576   new_list_entry->delay = delay;
4577 }
4578
4579 void print_unknown_token(char *filename, char *token, int token_nr)
4580 {
4581   if (token_nr == 0)
4582   {
4583     Error(ERR_RETURN_LINE, "-");
4584     Error(ERR_RETURN, "warning: unknown token(s) found in config file:");
4585     Error(ERR_RETURN, "- config file: '%s'", filename);
4586   }
4587
4588   Error(ERR_RETURN, "- token: '%s'", token);
4589 }
4590
4591 void print_unknown_token_end(int token_nr)
4592 {
4593   if (token_nr > 0)
4594     Error(ERR_RETURN_LINE, "-");
4595 }
4596
4597 void LoadHelpAnimInfo()
4598 {
4599   char *filename = getHelpAnimFilename();
4600   SetupFileList *setup_file_list = NULL, *list;
4601   SetupFileHash *element_hash, *action_hash, *direction_hash;
4602   int num_list_entries = 0;
4603   int num_unknown_tokens = 0;
4604   int i;
4605
4606   if (fileExists(filename))
4607     setup_file_list = loadSetupFileList(filename);
4608
4609   if (setup_file_list == NULL)
4610   {
4611     /* use reliable default values from static configuration */
4612     SetupFileList *insert_ptr;
4613
4614     insert_ptr = setup_file_list =
4615       newSetupFileList(helpanim_config[0].token,
4616                        helpanim_config[0].value);
4617
4618     for (i = 1; helpanim_config[i].token; i++)
4619       insert_ptr = addListEntry(insert_ptr,
4620                                 helpanim_config[i].token,
4621                                 helpanim_config[i].value);
4622   }
4623
4624   element_hash   = newSetupFileHash();
4625   action_hash    = newSetupFileHash();
4626   direction_hash = newSetupFileHash();
4627
4628   for (i = 0; i < MAX_NUM_ELEMENTS; i++)
4629     setHashEntry(element_hash, element_info[i].token_name, i_to_a(i));
4630
4631   for (i = 0; i < NUM_ACTIONS; i++)
4632     setHashEntry(action_hash, element_action_info[i].suffix,
4633                  i_to_a(element_action_info[i].value));
4634
4635   /* do not store direction index (bit) here, but direction value! */
4636   for (i = 0; i < NUM_DIRECTIONS; i++)
4637     setHashEntry(direction_hash, element_direction_info[i].suffix,
4638                  i_to_a(1 << element_direction_info[i].value));
4639
4640   for (list = setup_file_list; list != NULL; list = list->next)
4641   {
4642     char *element_token, *action_token, *direction_token;
4643     char *element_value, *action_value, *direction_value;
4644     int delay = atoi(list->value);
4645
4646     if (strcmp(list->token, "end") == 0)
4647     {
4648       add_helpanim_entry(HELPANIM_LIST_NEXT, -1, -1, -1, &num_list_entries);
4649
4650       continue;
4651     }
4652
4653     /* first try to break element into element/action/direction parts;
4654        if this does not work, also accept combined "element[.act][.dir]"
4655        elements (like "dynamite.active"), which are unique elements */
4656
4657     if (strchr(list->token, '.') == NULL)       /* token contains no '.' */
4658     {
4659       element_value = getHashEntry(element_hash, list->token);
4660       if (element_value != NULL)        /* element found */
4661         add_helpanim_entry(atoi(element_value), -1, -1, delay,
4662                            &num_list_entries);
4663       else
4664       {
4665         /* no further suffixes found -- this is not an element */
4666         print_unknown_token(filename, list->token, num_unknown_tokens++);
4667       }
4668
4669       continue;
4670     }
4671
4672     /* token has format "<prefix>.<something>" */
4673
4674     action_token = strchr(list->token, '.');    /* suffix may be action ... */
4675     direction_token = action_token;             /* ... or direction */
4676
4677     element_token = getStringCopy(list->token);
4678     *strchr(element_token, '.') = '\0';
4679
4680     element_value = getHashEntry(element_hash, element_token);
4681
4682     if (element_value == NULL)          /* this is no element */
4683     {
4684       element_value = getHashEntry(element_hash, list->token);
4685       if (element_value != NULL)        /* combined element found */
4686         add_helpanim_entry(atoi(element_value), -1, -1, delay,
4687                            &num_list_entries);
4688       else
4689         print_unknown_token(filename, list->token, num_unknown_tokens++);
4690
4691       free(element_token);
4692
4693       continue;
4694     }
4695
4696     action_value = getHashEntry(action_hash, action_token);
4697
4698     if (action_value != NULL)           /* action found */
4699     {
4700       add_helpanim_entry(atoi(element_value), atoi(action_value), -1, delay,
4701                     &num_list_entries);
4702
4703       free(element_token);
4704
4705       continue;
4706     }
4707
4708     direction_value = getHashEntry(direction_hash, direction_token);
4709
4710     if (direction_value != NULL)        /* direction found */
4711     {
4712       add_helpanim_entry(atoi(element_value), -1, atoi(direction_value), delay,
4713                          &num_list_entries);
4714
4715       free(element_token);
4716
4717       continue;
4718     }
4719
4720     if (strchr(action_token + 1, '.') == NULL)
4721     {
4722       /* no further suffixes found -- this is not an action nor direction */
4723
4724       element_value = getHashEntry(element_hash, list->token);
4725       if (element_value != NULL)        /* combined element found */
4726         add_helpanim_entry(atoi(element_value), -1, -1, delay,
4727                            &num_list_entries);
4728       else
4729         print_unknown_token(filename, list->token, num_unknown_tokens++);
4730
4731       free(element_token);
4732
4733       continue;
4734     }
4735
4736     /* token has format "<prefix>.<suffix>.<something>" */
4737
4738     direction_token = strchr(action_token + 1, '.');
4739
4740     action_token = getStringCopy(action_token);
4741     *strchr(action_token + 1, '.') = '\0';
4742
4743     action_value = getHashEntry(action_hash, action_token);
4744
4745     if (action_value == NULL)           /* this is no action */
4746     {
4747       element_value = getHashEntry(element_hash, list->token);
4748       if (element_value != NULL)        /* combined element found */
4749         add_helpanim_entry(atoi(element_value), -1, -1, delay,
4750                            &num_list_entries);
4751       else
4752         print_unknown_token(filename, list->token, num_unknown_tokens++);
4753
4754       free(element_token);
4755       free(action_token);
4756
4757       continue;
4758     }
4759
4760     direction_value = getHashEntry(direction_hash, direction_token);
4761
4762     if (direction_value != NULL)        /* direction found */
4763     {
4764       add_helpanim_entry(atoi(element_value), atoi(action_value),
4765                          atoi(direction_value), delay, &num_list_entries);
4766
4767       free(element_token);
4768       free(action_token);
4769
4770       continue;
4771     }
4772
4773     /* this is no direction */
4774
4775     element_value = getHashEntry(element_hash, list->token);
4776     if (element_value != NULL)          /* combined element found */
4777       add_helpanim_entry(atoi(element_value), -1, -1, delay,
4778                          &num_list_entries);
4779     else
4780       print_unknown_token(filename, list->token, num_unknown_tokens++);
4781
4782     free(element_token);
4783     free(action_token);
4784   }
4785
4786   print_unknown_token_end(num_unknown_tokens);
4787
4788   add_helpanim_entry(HELPANIM_LIST_NEXT, -1, -1, -1, &num_list_entries);
4789   add_helpanim_entry(HELPANIM_LIST_END,  -1, -1, -1, &num_list_entries);
4790
4791   freeSetupFileList(setup_file_list);
4792   freeSetupFileHash(element_hash);
4793   freeSetupFileHash(action_hash);
4794   freeSetupFileHash(direction_hash);
4795
4796 #if 0
4797   /* TEST ONLY */
4798   for (i = 0; i < num_list_entries; i++)
4799     printf("::: %d, %d, %d => %d\n",
4800            helpanim_info[i].element,
4801            helpanim_info[i].action,
4802            helpanim_info[i].direction,
4803            helpanim_info[i].delay);
4804 #endif
4805 }
4806
4807 void LoadHelpTextInfo()
4808 {
4809   char *filename = getHelpTextFilename();
4810   int i;
4811
4812   if (helptext_info != NULL)
4813   {
4814     freeSetupFileHash(helptext_info);
4815     helptext_info = NULL;
4816   }
4817
4818   if (fileExists(filename))
4819     helptext_info = loadSetupFileHash(filename);
4820
4821   if (helptext_info == NULL)
4822   {
4823     /* use reliable default values from static configuration */
4824     helptext_info = newSetupFileHash();
4825
4826     for (i = 0; helptext_config[i].token; i++)
4827       setHashEntry(helptext_info,
4828                    helptext_config[i].token,
4829                    helptext_config[i].value);
4830   }
4831
4832 #if 0
4833   /* TEST ONLY */
4834   BEGIN_HASH_ITERATION(helptext_info, itr)
4835   {
4836     printf("::: '%s' => '%s'\n",
4837            HASH_ITERATION_TOKEN(itr), HASH_ITERATION_VALUE(itr));
4838   }
4839   END_HASH_ITERATION(hash, itr)
4840 #endif
4841 }
4842
4843
4844 /* ------------------------------------------------------------------------- *
4845  * convert levels
4846  * ------------------------------------------------------------------------- */
4847
4848 #define MAX_NUM_CONVERT_LEVELS          1000
4849
4850 void ConvertLevels()
4851 {
4852   static LevelDirTree *convert_leveldir = NULL;
4853   static int convert_level_nr = -1;
4854   static int num_levels_handled = 0;
4855   static int num_levels_converted = 0;
4856   static boolean levels_failed[MAX_NUM_CONVERT_LEVELS];
4857   int i;
4858
4859   convert_leveldir = getTreeInfoFromIdentifier(leveldir_first,
4860                                                global.convert_leveldir);
4861
4862   if (convert_leveldir == NULL)
4863     Error(ERR_EXIT, "no such level identifier: '%s'",
4864           global.convert_leveldir);
4865
4866   leveldir_current = convert_leveldir;
4867
4868   if (global.convert_level_nr != -1)
4869   {
4870     convert_leveldir->first_level = global.convert_level_nr;
4871     convert_leveldir->last_level  = global.convert_level_nr;
4872   }
4873
4874   convert_level_nr = convert_leveldir->first_level;
4875
4876   printf_line("=", 79);
4877   printf("Converting levels\n");
4878   printf_line("-", 79);
4879   printf("Level series identifier: '%s'\n", convert_leveldir->identifier);
4880   printf("Level series name:       '%s'\n", convert_leveldir->name);
4881   printf("Level series author:     '%s'\n", convert_leveldir->author);
4882   printf("Number of levels:        %d\n",   convert_leveldir->levels);
4883   printf_line("=", 79);
4884   printf("\n");
4885
4886   for (i = 0; i < MAX_NUM_CONVERT_LEVELS; i++)
4887     levels_failed[i] = FALSE;
4888
4889   while (convert_level_nr <= convert_leveldir->last_level)
4890   {
4891     char *level_filename;
4892     boolean new_level;
4893
4894     level_nr = convert_level_nr++;
4895
4896     printf("Level %03d: ", level_nr);
4897
4898     LoadLevel(level_nr);
4899     if (level.no_valid_file)
4900     {
4901       printf("(no level)\n");
4902       continue;
4903     }
4904
4905     printf("converting level ... ");
4906
4907     level_filename = getDefaultLevelFilename(level_nr);
4908     new_level = !fileExists(level_filename);
4909
4910     if (new_level)
4911     {
4912       SaveLevel(level_nr);
4913
4914       num_levels_converted++;
4915
4916       printf("converted.\n");
4917     }
4918     else
4919     {
4920       if (level_nr >= 0 && level_nr < MAX_NUM_CONVERT_LEVELS)
4921         levels_failed[level_nr] = TRUE;
4922
4923       printf("NOT CONVERTED -- LEVEL ALREADY EXISTS.\n");
4924     }
4925
4926     num_levels_handled++;
4927   }
4928
4929   printf("\n");
4930   printf_line("=", 79);
4931   printf("Number of levels handled: %d\n", num_levels_handled);
4932   printf("Number of levels converted: %d (%d%%)\n", num_levels_converted,
4933          (num_levels_handled ?
4934           num_levels_converted * 100 / num_levels_handled : 0));
4935   printf_line("-", 79);
4936   printf("Summary (for automatic parsing by scripts):\n");
4937   printf("LEVELDIR '%s', CONVERTED %d/%d (%d%%)",
4938          convert_leveldir->identifier, num_levels_converted,
4939          num_levels_handled,
4940          (num_levels_handled ?
4941           num_levels_converted * 100 / num_levels_handled : 0));
4942
4943   if (num_levels_handled != num_levels_converted)
4944   {
4945     printf(", FAILED:");
4946     for (i = 0; i < MAX_NUM_CONVERT_LEVELS; i++)
4947       if (levels_failed[i])
4948         printf(" %03d", i);
4949   }
4950
4951   printf("\n");
4952   printf_line("=", 79);
4953
4954   CloseAllAndExit(0);
4955 }