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   /* USE_NEW_BLOCK_STYLE */
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 #if 0
2243       printf("::: %d\n", level->block_last_field);
2244 #endif
2245
2246       /* even "not blocking" was blocking the last field for one frame */
2247       level->block_delay    = (level->block_last_field    ? 7 : 1);
2248       level->sp_block_delay = (level->sp_block_last_field ? 7 : 1);
2249
2250       level->block_last_field = TRUE;
2251       level->sp_block_last_field = TRUE;
2252     }
2253 #endif
2254   }
2255   else          /* always use the latest game engine version */
2256   {
2257 #if 0
2258     printf("\n::: ALWAYS USE LATEST ENGINE FOR THIS LEVEL: [%d] '%s'\n",
2259            leveldir_current->sort_priority, filename);
2260 #endif
2261
2262 #if 0
2263     printf("\n::: Use latest game engine version for this level.\n");
2264 #endif
2265
2266     /* For all levels which are forced to use the latest game engine version
2267        (normally all but user contributed, private and undefined levels), set
2268        the game engine version to the actual version; this allows for actual
2269        corrections in the game engine to take effect for existing, converted
2270        levels (from "classic" or other existing games) to make the emulation
2271        of the corresponding game more accurate, while (hopefully) not breaking
2272        existing levels created from other players. */
2273
2274 #if 0
2275     printf("::: changing engine from %d to %d\n",
2276            level->game_version, GAME_VERSION_ACTUAL);
2277 #endif
2278
2279     level->game_version = GAME_VERSION_ACTUAL;
2280
2281     /* Set special EM style gems behaviour: EM style gems slip down from
2282        normal, steel and growing wall. As this is a more fundamental change,
2283        it seems better to set the default behaviour to "off" (as it is more
2284        natural) and make it configurable in the level editor (as a property
2285        of gem style elements). Already existing converted levels (neither
2286        private nor contributed levels) are changed to the new behaviour. */
2287
2288     if (level->file_version < FILE_VERSION_2_0)
2289       level->em_slippery_gems = TRUE;
2290   }
2291
2292 #if 0
2293   printf("::: => %d\n", level->game_version);
2294 #endif
2295 }
2296
2297 static void LoadLevel_InitElements(struct LevelInfo *level, char *filename)
2298 {
2299   int i, j, x, y;
2300
2301   /* map custom element change events that have changed in newer versions
2302      (these following values were accidentally changed in version 3.0.1) */
2303   if (level->game_version <= VERSION_IDENT(3,0,0,0))
2304   {
2305     for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2306     {
2307       int element = EL_CUSTOM_START + i;
2308
2309       /* order of checking and copying events to be mapped is important */
2310       for (j = CE_BY_OTHER_ACTION; j >= CE_BY_PLAYER_OBSOLETE; j--)
2311       {
2312         if (HAS_CHANGE_EVENT(element, j - 2))
2313         {
2314           SET_CHANGE_EVENT(element, j - 2, FALSE);
2315           SET_CHANGE_EVENT(element, j, TRUE);
2316         }
2317       }
2318
2319       /* order of checking and copying events to be mapped is important */
2320       for (j = CE_OTHER_GETS_COLLECTED; j >= CE_HITTING_SOMETHING; j--)
2321       {
2322         if (HAS_CHANGE_EVENT(element, j - 1))
2323         {
2324           SET_CHANGE_EVENT(element, j - 1, FALSE);
2325           SET_CHANGE_EVENT(element, j, TRUE);
2326         }
2327       }
2328     }
2329   }
2330
2331   /* some custom element change events get mapped since version 3.0.3 */
2332   for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2333   {
2334     int element = EL_CUSTOM_START + i;
2335
2336     if (HAS_CHANGE_EVENT(element, CE_BY_PLAYER_OBSOLETE) ||
2337         HAS_CHANGE_EVENT(element, CE_BY_COLLISION_OBSOLETE))
2338     {
2339       SET_CHANGE_EVENT(element, CE_BY_PLAYER_OBSOLETE, FALSE);
2340       SET_CHANGE_EVENT(element, CE_BY_COLLISION_OBSOLETE, FALSE);
2341
2342       SET_CHANGE_EVENT(element, CE_BY_DIRECT_ACTION, TRUE);
2343     }
2344   }
2345
2346   /* initialize "can_change" field for old levels with only one change page */
2347   if (level->game_version <= VERSION_IDENT(3,0,2,0))
2348   {
2349     for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2350     {
2351       int element = EL_CUSTOM_START + i;
2352
2353       if (CAN_CHANGE(element))
2354         element_info[element].change->can_change = TRUE;
2355     }
2356   }
2357
2358   /* correct custom element values (for old levels without these options) */
2359   for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2360   {
2361     int element = EL_CUSTOM_START + i;
2362     struct ElementInfo *ei = &element_info[element];
2363
2364     if (ei->access_direction == MV_NO_MOVING)
2365       ei->access_direction = MV_ALL_DIRECTIONS;
2366
2367     for (j = 0; j < ei->num_change_pages; j++)
2368     {
2369       struct ElementChangeInfo *change = &ei->change_page[j];
2370
2371       if (change->trigger_side == CH_SIDE_NONE)
2372         change->trigger_side = CH_SIDE_ANY;
2373     }
2374   }
2375
2376   /* initialize "can_explode" field for old levels which did not store this */
2377   if (level->game_version <= VERSION_IDENT(3,1,0,0))
2378   {
2379     for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2380     {
2381       int element = EL_CUSTOM_START + i;
2382
2383       if (EXPLODES_1X1_OLD(element))
2384         element_info[element].explosion_type = EXPLODES_1X1;
2385
2386       SET_PROPERTY(element, EP_CAN_EXPLODE, (EXPLODES_BY_FIRE(element) ||
2387                                              EXPLODES_SMASHED(element) ||
2388                                              EXPLODES_IMPACT(element)));
2389     }
2390   }
2391
2392 #if 0
2393   /* set default push delay values (corrected since version 3.0.7-1) */
2394   if (level->game_version < VERSION_IDENT(3,0,7,1))
2395   {
2396     game.default_push_delay_fixed = 2;
2397     game.default_push_delay_random = 8;
2398   }
2399   else
2400   {
2401     game.default_push_delay_fixed = 8;
2402     game.default_push_delay_random = 8;
2403   }
2404
2405   /* set uninitialized push delay values of custom elements in older levels */
2406   for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2407   {
2408     int element = EL_CUSTOM_START + i;
2409
2410     if (element_info[element].push_delay_fixed == -1)
2411       element_info[element].push_delay_fixed = game.default_push_delay_fixed;
2412     if (element_info[element].push_delay_random == -1)
2413       element_info[element].push_delay_random = game.default_push_delay_random;
2414   }
2415 #endif
2416
2417   /* map elements that have changed in newer versions */
2418   level->amoeba_content = getMappedElementByVersion(level->amoeba_content,
2419                                                     level->game_version);
2420   for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
2421     for (x = 0; x < 3; x++)
2422       for (y = 0; y < 3; y++)
2423         level->yamyam_content[i][x][y] =
2424           getMappedElementByVersion(level->yamyam_content[i][x][y],
2425                                     level->game_version);
2426
2427   /* initialize element properties for level editor etc. */
2428   InitElementPropertiesEngine(level->game_version);
2429 }
2430
2431 static void LoadLevel_InitPlayfield(struct LevelInfo *level, char *filename)
2432 {
2433   int x, y;
2434
2435   /* map elements that have changed in newer versions */
2436   for (y = 0; y < level->fieldy; y++)
2437   {
2438     for (x = 0; x < level->fieldx; x++)
2439     {
2440       int element = level->field[x][y];
2441
2442 #if 1
2443       element = getMappedElementByVersion(element, level->game_version);
2444 #else
2445       if (level->game_version <= VERSION_IDENT(2,2,0,0))
2446       {
2447         /* map game font elements */
2448         element = (element == EL_CHAR('[')  ? EL_CHAR_AUMLAUT :
2449                    element == EL_CHAR('\\') ? EL_CHAR_OUMLAUT :
2450                    element == EL_CHAR(']')  ? EL_CHAR_UUMLAUT :
2451                    element == EL_CHAR('^')  ? EL_CHAR_COPYRIGHT : element);
2452       }
2453
2454       if (level->game_version < VERSION_IDENT(3,0,0,0))
2455       {
2456         /* map Supaplex gravity tube elements */
2457         element = (element == EL_SP_GRAVITY_PORT_LEFT  ? EL_SP_PORT_LEFT  :
2458                    element == EL_SP_GRAVITY_PORT_RIGHT ? EL_SP_PORT_RIGHT :
2459                    element == EL_SP_GRAVITY_PORT_UP    ? EL_SP_PORT_UP    :
2460                    element == EL_SP_GRAVITY_PORT_DOWN  ? EL_SP_PORT_DOWN  :
2461                    element);
2462       }
2463 #endif
2464
2465       level->field[x][y] = element;
2466     }
2467   }
2468
2469   /* copy elements to runtime playfield array */
2470   for (x = 0; x < MAX_LEV_FIELDX; x++)
2471     for (y = 0; y < MAX_LEV_FIELDY; y++)
2472       Feld[x][y] = level->field[x][y];
2473
2474   /* initialize level size variables for faster access */
2475   lev_fieldx = level->fieldx;
2476   lev_fieldy = level->fieldy;
2477
2478   /* determine border element for this level */
2479   SetBorderElement();
2480 }
2481
2482 void LoadLevelTemplate(int nr)
2483 {
2484 #if 1
2485   struct LevelFileInfo *level_file_info = getLevelFileInfo(nr);
2486   char *filename = level_file_info->filename;
2487
2488   LoadLevelFromFileInfo(&level_template, level_file_info);
2489 #else
2490   char *filename = getDefaultLevelFilename(nr);
2491
2492   LoadLevelFromFilename_RND(&level_template, filename);
2493 #endif
2494
2495 #if 1
2496   LoadLevel_InitVersion(&level_template, filename);
2497   LoadLevel_InitElements(&level_template, filename);
2498 #else
2499   LoadLevel_InitVersion(&level, filename);
2500   LoadLevel_InitElements(&level, filename);
2501 #endif
2502
2503   ActivateLevelTemplate();
2504 }
2505
2506 void LoadLevel(int nr)
2507 {
2508 #if 1
2509   struct LevelFileInfo *level_file_info = getLevelFileInfo(nr);
2510   char *filename = level_file_info->filename;
2511
2512   LoadLevelFromFileInfo(&level, level_file_info);
2513 #else
2514   char *filename = getLevelFilename(nr);
2515
2516   LoadLevelFromFilename_RND(&level, filename);
2517 #endif
2518
2519   if (level.use_custom_template)
2520     LoadLevelTemplate(-1);
2521
2522 #if 1
2523   LoadLevel_InitVersion(&level, filename);
2524   LoadLevel_InitElements(&level, filename);
2525   LoadLevel_InitPlayfield(&level, filename);
2526 #else
2527   LoadLevel_InitLevel(&level, filename);
2528 #endif
2529 }
2530
2531 static void SaveLevel_VERS(FILE *file, struct LevelInfo *level)
2532 {
2533   putFileVersion(file, level->file_version);
2534   putFileVersion(file, level->game_version);
2535 }
2536
2537 static void SaveLevel_HEAD(FILE *file, struct LevelInfo *level)
2538 {
2539   int i, x, y;
2540
2541   putFile8Bit(file, level->fieldx);
2542   putFile8Bit(file, level->fieldy);
2543
2544   putFile16BitBE(file, level->time);
2545   putFile16BitBE(file, level->gems_needed);
2546
2547   for (i = 0; i < MAX_LEVEL_NAME_LEN; i++)
2548     putFile8Bit(file, level->name[i]);
2549
2550   for (i = 0; i < LEVEL_SCORE_ELEMENTS; i++)
2551     putFile8Bit(file, level->score[i]);
2552
2553   for (i = 0; i < STD_ELEMENT_CONTENTS; i++)
2554     for (y = 0; y < 3; y++)
2555       for (x = 0; x < 3; x++)
2556         putFile8Bit(file, (level->encoding_16bit_yamyam ? EL_EMPTY :
2557                            level->yamyam_content[i][x][y]));
2558   putFile8Bit(file, level->amoeba_speed);
2559   putFile8Bit(file, level->time_magic_wall);
2560   putFile8Bit(file, level->time_wheel);
2561   putFile8Bit(file, (level->encoding_16bit_amoeba ? EL_EMPTY :
2562                      level->amoeba_content));
2563   putFile8Bit(file, (level->double_speed ? 1 : 0));
2564   putFile8Bit(file, (level->initial_gravity ? 1 : 0));
2565   putFile8Bit(file, (level->encoding_16bit_field ? 1 : 0));
2566   putFile8Bit(file, (level->em_slippery_gems ? 1 : 0));
2567
2568   putFile8Bit(file, (level->use_custom_template ? 1 : 0));
2569
2570   putFile8Bit(file, (level->block_last_field ? 1 : 0));
2571   putFile8Bit(file, (level->sp_block_last_field ? 1 : 0));
2572   putFile32BitBE(file, level->can_move_into_acid_bits);
2573   putFile8Bit(file, level->dont_collide_with_bits);
2574
2575   putFile8Bit(file, (level->use_spring_bug ? 1 : 0));
2576   putFile8Bit(file, (level->use_step_counter ? 1 : 0));
2577
2578   putFile8Bit(file, (level->instant_relocation ? 1 : 0));
2579   putFile8Bit(file, (level->can_pass_to_walkable ? 1 : 0));
2580   putFile8Bit(file, (level->grow_into_diggable ? 1 : 0));
2581
2582   WriteUnusedBytesToFile(file, LEVEL_HEADER_UNUSED);
2583 }
2584
2585 static void SaveLevel_AUTH(FILE *file, struct LevelInfo *level)
2586 {
2587   int i;
2588
2589   for (i = 0; i < MAX_LEVEL_AUTHOR_LEN; i++)
2590     putFile8Bit(file, level->author[i]);
2591 }
2592
2593 static void SaveLevel_BODY(FILE *file, struct LevelInfo *level)
2594 {
2595   int x, y;
2596
2597   for (y = 0; y < level->fieldy; y++)
2598     for (x = 0; x < level->fieldx; x++)
2599       if (level->encoding_16bit_field)
2600         putFile16BitBE(file, level->field[x][y]);
2601       else
2602         putFile8Bit(file, level->field[x][y]);
2603 }
2604
2605 #if 0
2606 static void SaveLevel_CONT(FILE *file, struct LevelInfo *level)
2607 {
2608   int i, x, y;
2609
2610   putFile8Bit(file, EL_YAMYAM);
2611   putFile8Bit(file, level->num_yamyam_contents);
2612   putFile8Bit(file, 0);
2613   putFile8Bit(file, 0);
2614
2615   for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
2616     for (y = 0; y < 3; y++)
2617       for (x = 0; x < 3; x++)
2618         if (level->encoding_16bit_field)
2619           putFile16BitBE(file, level->yamyam_content[i][x][y]);
2620         else
2621           putFile8Bit(file, level->yamyam_content[i][x][y]);
2622 }
2623 #endif
2624
2625 static void SaveLevel_CNT2(FILE *file, struct LevelInfo *level, int element)
2626 {
2627   int i, x, y;
2628   int num_contents, content_xsize, content_ysize;
2629   int content_array[MAX_ELEMENT_CONTENTS][3][3];
2630
2631   if (element == EL_YAMYAM)
2632   {
2633     num_contents = level->num_yamyam_contents;
2634     content_xsize = 3;
2635     content_ysize = 3;
2636
2637     for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
2638       for (y = 0; y < 3; y++)
2639         for (x = 0; x < 3; x++)
2640           content_array[i][x][y] = level->yamyam_content[i][x][y];
2641   }
2642   else if (element == EL_BD_AMOEBA)
2643   {
2644     num_contents = 1;
2645     content_xsize = 1;
2646     content_ysize = 1;
2647
2648     for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
2649       for (y = 0; y < 3; y++)
2650         for (x = 0; x < 3; x++)
2651           content_array[i][x][y] = EL_EMPTY;
2652     content_array[0][0][0] = level->amoeba_content;
2653   }
2654   else
2655   {
2656     /* chunk header already written -- write empty chunk data */
2657     WriteUnusedBytesToFile(file, LEVEL_CHUNK_CNT2_SIZE);
2658
2659     Error(ERR_WARN, "cannot save content for element '%d'", element);
2660     return;
2661   }
2662
2663   putFile16BitBE(file, element);
2664   putFile8Bit(file, num_contents);
2665   putFile8Bit(file, content_xsize);
2666   putFile8Bit(file, content_ysize);
2667
2668   WriteUnusedBytesToFile(file, LEVEL_CHUNK_CNT2_UNUSED);
2669
2670   for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
2671     for (y = 0; y < 3; y++)
2672       for (x = 0; x < 3; x++)
2673         putFile16BitBE(file, content_array[i][x][y]);
2674 }
2675
2676 static void SaveLevel_CNT3(FILE *file, struct LevelInfo *level, int element)
2677 {
2678   int i;
2679   int envelope_nr = element - EL_ENVELOPE_1;
2680   int envelope_len = strlen(level->envelope_text[envelope_nr]) + 1;
2681
2682   putFile16BitBE(file, element);
2683   putFile16BitBE(file, envelope_len);
2684   putFile8Bit(file, level->envelope_xsize[envelope_nr]);
2685   putFile8Bit(file, level->envelope_ysize[envelope_nr]);
2686
2687   WriteUnusedBytesToFile(file, LEVEL_CHUNK_CNT3_UNUSED);
2688
2689   for (i = 0; i < envelope_len; i++)
2690     putFile8Bit(file, level->envelope_text[envelope_nr][i]);
2691 }
2692
2693 #if 0
2694 static void SaveLevel_CUS1(FILE *file, struct LevelInfo *level,
2695                            int num_changed_custom_elements)
2696 {
2697   int i, check = 0;
2698
2699   putFile16BitBE(file, num_changed_custom_elements);
2700
2701   for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2702   {
2703     int element = EL_CUSTOM_START + i;
2704
2705     if (Properties[element][EP_BITFIELD_BASE] != EP_BITMASK_DEFAULT)
2706     {
2707       if (check < num_changed_custom_elements)
2708       {
2709         putFile16BitBE(file, element);
2710         putFile32BitBE(file, Properties[element][EP_BITFIELD_BASE]);
2711       }
2712
2713       check++;
2714     }
2715   }
2716
2717   if (check != num_changed_custom_elements)     /* should not happen */
2718     Error(ERR_WARN, "inconsistent number of custom element properties");
2719 }
2720 #endif
2721
2722 #if 0
2723 static void SaveLevel_CUS2(FILE *file, struct LevelInfo *level,
2724                            int num_changed_custom_elements)
2725 {
2726   int i, check = 0;
2727
2728   putFile16BitBE(file, num_changed_custom_elements);
2729
2730   for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2731   {
2732     int element = EL_CUSTOM_START + i;
2733
2734     if (element_info[element].change->target_element != EL_EMPTY_SPACE)
2735     {
2736       if (check < num_changed_custom_elements)
2737       {
2738         putFile16BitBE(file, element);
2739         putFile16BitBE(file, element_info[element].change->target_element);
2740       }
2741
2742       check++;
2743     }
2744   }
2745
2746   if (check != num_changed_custom_elements)     /* should not happen */
2747     Error(ERR_WARN, "inconsistent number of custom target elements");
2748 }
2749 #endif
2750
2751 #if 0
2752 static void SaveLevel_CUS3(FILE *file, struct LevelInfo *level,
2753                            int num_changed_custom_elements)
2754 {
2755   int i, j, x, y, check = 0;
2756
2757   putFile16BitBE(file, num_changed_custom_elements);
2758
2759   for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2760   {
2761     int element = EL_CUSTOM_START + i;
2762
2763     if (element_info[element].modified_settings)
2764     {
2765       if (check < num_changed_custom_elements)
2766       {
2767         putFile16BitBE(file, element);
2768
2769         for (j = 0; j < MAX_ELEMENT_NAME_LEN; j++)
2770           putFile8Bit(file, element_info[element].description[j]);
2771
2772         putFile32BitBE(file, Properties[element][EP_BITFIELD_BASE]);
2773
2774         /* some free bytes for future properties and padding */
2775         WriteUnusedBytesToFile(file, 7);
2776
2777         putFile8Bit(file, element_info[element].use_gfx_element);
2778         putFile16BitBE(file, element_info[element].gfx_element);
2779
2780         putFile8Bit(file, element_info[element].collect_score);
2781         putFile8Bit(file, element_info[element].collect_count);
2782
2783         putFile16BitBE(file, element_info[element].push_delay_fixed);
2784         putFile16BitBE(file, element_info[element].push_delay_random);
2785         putFile16BitBE(file, element_info[element].move_delay_fixed);
2786         putFile16BitBE(file, element_info[element].move_delay_random);
2787
2788         putFile16BitBE(file, element_info[element].move_pattern);
2789         putFile8Bit(file, element_info[element].move_direction_initial);
2790         putFile8Bit(file, element_info[element].move_stepsize);
2791
2792         for (y = 0; y < 3; y++)
2793           for (x = 0; x < 3; x++)
2794             putFile16BitBE(file, element_info[element].content[x][y]);
2795
2796         putFile32BitBE(file, element_info[element].change->events);
2797
2798         putFile16BitBE(file, element_info[element].change->target_element);
2799
2800         putFile16BitBE(file, element_info[element].change->delay_fixed);
2801         putFile16BitBE(file, element_info[element].change->delay_random);
2802         putFile16BitBE(file, element_info[element].change->delay_frames);
2803
2804         putFile16BitBE(file, element_info[element].change->trigger_element);
2805
2806         putFile8Bit(file, element_info[element].change->explode);
2807         putFile8Bit(file, element_info[element].change->use_target_content);
2808         putFile8Bit(file, element_info[element].change->only_if_complete);
2809         putFile8Bit(file, element_info[element].change->use_random_replace);
2810
2811         putFile8Bit(file, element_info[element].change->random_percentage);
2812         putFile8Bit(file, element_info[element].change->replace_when);
2813
2814         for (y = 0; y < 3; y++)
2815           for (x = 0; x < 3; x++)
2816             putFile16BitBE(file, element_info[element].change->content[x][y]);
2817
2818         putFile8Bit(file, element_info[element].slippery_type);
2819
2820         /* some free bytes for future properties and padding */
2821         WriteUnusedBytesToFile(file, LEVEL_CPART_CUS3_UNUSED);
2822       }
2823
2824       check++;
2825     }
2826   }
2827
2828   if (check != num_changed_custom_elements)     /* should not happen */
2829     Error(ERR_WARN, "inconsistent number of custom element properties");
2830 }
2831 #endif
2832
2833 static void SaveLevel_CUS4(FILE *file, struct LevelInfo *level, int element)
2834 {
2835   struct ElementInfo *ei = &element_info[element];
2836   int i, x, y;
2837
2838   putFile16BitBE(file, element);
2839
2840   for (i = 0; i < MAX_ELEMENT_NAME_LEN; i++)
2841     putFile8Bit(file, ei->description[i]);
2842
2843   putFile32BitBE(file, Properties[element][EP_BITFIELD_BASE]);
2844   WriteUnusedBytesToFile(file, 4);      /* reserved for more base properties */
2845
2846   putFile8Bit(file, ei->num_change_pages);
2847
2848   /* some free bytes for future base property values and padding */
2849   WriteUnusedBytesToFile(file, 5);
2850
2851   /* write custom property values */
2852
2853   putFile8Bit(file, ei->use_gfx_element);
2854   putFile16BitBE(file, ei->gfx_element);
2855
2856   putFile8Bit(file, ei->collect_score);
2857   putFile8Bit(file, ei->collect_count);
2858
2859   putFile8Bit(file, ei->drop_delay_fixed);
2860   putFile8Bit(file, ei->push_delay_fixed);
2861   putFile8Bit(file, ei->drop_delay_random);
2862   putFile8Bit(file, ei->push_delay_random);
2863   putFile16BitBE(file, ei->move_delay_fixed);
2864   putFile16BitBE(file, ei->move_delay_random);
2865
2866   /* bits 0 - 15 of "move_pattern" ... */
2867   putFile16BitBE(file, ei->move_pattern & 0xffff);
2868   putFile8Bit(file, ei->move_direction_initial);
2869   putFile8Bit(file, ei->move_stepsize);
2870
2871   putFile8Bit(file, ei->slippery_type);
2872
2873   for (y = 0; y < 3; y++)
2874     for (x = 0; x < 3; x++)
2875       putFile16BitBE(file, ei->content[x][y]);
2876
2877   putFile16BitBE(file, ei->move_enter_element);
2878   putFile16BitBE(file, ei->move_leave_element);
2879   putFile8Bit(file, ei->move_leave_type);
2880
2881   /* ... bits 16 - 31 of "move_pattern" (not nice, but downward compatible) */
2882   putFile16BitBE(file, (ei->move_pattern >> 16) & 0xffff);
2883
2884   putFile8Bit(file, ei->access_direction);
2885
2886   putFile8Bit(file, ei->explosion_delay);
2887   putFile8Bit(file, ei->ignition_delay);
2888   putFile8Bit(file, ei->explosion_type);
2889
2890   /* some free bytes for future custom property values and padding */
2891   WriteUnusedBytesToFile(file, 1);
2892
2893   /* write change property values */
2894
2895   for (i = 0; i < ei->num_change_pages; i++)
2896   {
2897     struct ElementChangeInfo *change = &ei->change_page[i];
2898
2899     putFile32BitBE(file, change->events);
2900
2901     putFile16BitBE(file, change->target_element);
2902
2903     putFile16BitBE(file, change->delay_fixed);
2904     putFile16BitBE(file, change->delay_random);
2905     putFile16BitBE(file, change->delay_frames);
2906
2907     putFile16BitBE(file, change->trigger_element);
2908
2909     putFile8Bit(file, change->explode);
2910     putFile8Bit(file, change->use_target_content);
2911     putFile8Bit(file, change->only_if_complete);
2912     putFile8Bit(file, change->use_random_replace);
2913
2914     putFile8Bit(file, change->random_percentage);
2915     putFile8Bit(file, change->replace_when);
2916
2917     for (y = 0; y < 3; y++)
2918       for (x = 0; x < 3; x++)
2919         putFile16BitBE(file, change->target_content[x][y]);
2920
2921     putFile8Bit(file, change->can_change);
2922
2923     putFile8Bit(file, change->trigger_side);
2924
2925 #if 1
2926     putFile8Bit(file, change->trigger_player);
2927     putFile8Bit(file, (change->trigger_page == CH_PAGE_ANY ? CH_PAGE_ANY_FILE :
2928                        log_2(change->trigger_page)));
2929
2930     /* some free bytes for future change property values and padding */
2931     WriteUnusedBytesToFile(file, 6);
2932
2933 #else
2934
2935     /* some free bytes for future change property values and padding */
2936     WriteUnusedBytesToFile(file, 8);
2937 #endif
2938   }
2939 }
2940
2941 static void SaveLevel_GRP1(FILE *file, struct LevelInfo *level, int element)
2942 {
2943   struct ElementInfo *ei = &element_info[element];
2944   struct ElementGroupInfo *group = ei->group;
2945   int i;
2946
2947   putFile16BitBE(file, element);
2948
2949   for (i = 0; i < MAX_ELEMENT_NAME_LEN; i++)
2950     putFile8Bit(file, ei->description[i]);
2951
2952   putFile8Bit(file, group->num_elements);
2953
2954   putFile8Bit(file, ei->use_gfx_element);
2955   putFile16BitBE(file, ei->gfx_element);
2956
2957   putFile8Bit(file, group->choice_mode);
2958
2959   /* some free bytes for future values and padding */
2960   WriteUnusedBytesToFile(file, 3);
2961
2962   for (i = 0; i < MAX_ELEMENTS_IN_GROUP; i++)
2963     putFile16BitBE(file, group->element[i]);
2964 }
2965
2966 static void SaveLevelFromFilename(struct LevelInfo *level, char *filename)
2967 {
2968   int body_chunk_size;
2969   int i, x, y;
2970   FILE *file;
2971
2972   if (!(file = fopen(filename, MODE_WRITE)))
2973   {
2974     Error(ERR_WARN, "cannot save level file '%s'", filename);
2975     return;
2976   }
2977
2978   level->file_version = FILE_VERSION_ACTUAL;
2979   level->game_version = GAME_VERSION_ACTUAL;
2980
2981   /* check level field for 16-bit elements */
2982   level->encoding_16bit_field = FALSE;
2983   for (y = 0; y < level->fieldy; y++)
2984     for (x = 0; x < level->fieldx; x++)
2985       if (level->field[x][y] > 255)
2986         level->encoding_16bit_field = TRUE;
2987
2988   /* check yamyam content for 16-bit elements */
2989   level->encoding_16bit_yamyam = FALSE;
2990   for (i = 0; i < level->num_yamyam_contents; i++)
2991     for (y = 0; y < 3; y++)
2992       for (x = 0; x < 3; x++)
2993         if (level->yamyam_content[i][x][y] > 255)
2994           level->encoding_16bit_yamyam = TRUE;
2995
2996   /* check amoeba content for 16-bit elements */
2997   level->encoding_16bit_amoeba = FALSE;
2998   if (level->amoeba_content > 255)
2999     level->encoding_16bit_amoeba = TRUE;
3000
3001   /* calculate size of "BODY" chunk */
3002   body_chunk_size =
3003     level->fieldx * level->fieldy * (level->encoding_16bit_field ? 2 : 1);
3004
3005   putFileChunkBE(file, "RND1", CHUNK_SIZE_UNDEFINED);
3006   putFileChunkBE(file, "CAVE", CHUNK_SIZE_NONE);
3007
3008   putFileChunkBE(file, "VERS", FILE_VERS_CHUNK_SIZE);
3009   SaveLevel_VERS(file, level);
3010
3011   putFileChunkBE(file, "HEAD", LEVEL_HEADER_SIZE);
3012   SaveLevel_HEAD(file, level);
3013
3014   putFileChunkBE(file, "AUTH", MAX_LEVEL_AUTHOR_LEN);
3015   SaveLevel_AUTH(file, level);
3016
3017   putFileChunkBE(file, "BODY", body_chunk_size);
3018   SaveLevel_BODY(file, level);
3019
3020   if (level->encoding_16bit_yamyam ||
3021       level->num_yamyam_contents != STD_ELEMENT_CONTENTS)
3022   {
3023     putFileChunkBE(file, "CNT2", LEVEL_CHUNK_CNT2_SIZE);
3024     SaveLevel_CNT2(file, level, EL_YAMYAM);
3025   }
3026
3027   if (level->encoding_16bit_amoeba)
3028   {
3029     putFileChunkBE(file, "CNT2", LEVEL_CHUNK_CNT2_SIZE);
3030     SaveLevel_CNT2(file, level, EL_BD_AMOEBA);
3031   }
3032
3033   /* check for envelope content */
3034   for (i = 0; i < 4; i++)
3035   {
3036     if (strlen(level->envelope_text[i]) > 0)
3037     {
3038       int envelope_len = strlen(level->envelope_text[i]) + 1;
3039
3040       putFileChunkBE(file, "CNT3", LEVEL_CHUNK_CNT3_SIZE(envelope_len));
3041       SaveLevel_CNT3(file, level, EL_ENVELOPE_1 + i);
3042     }
3043   }
3044
3045   /* check for non-default custom elements (unless using template level) */
3046   if (!level->use_custom_template)
3047   {
3048     for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
3049     {
3050       int element = EL_CUSTOM_START + i;
3051
3052       if (element_info[element].modified_settings)
3053       {
3054         int num_change_pages = element_info[element].num_change_pages;
3055
3056         putFileChunkBE(file, "CUS4", LEVEL_CHUNK_CUS4_SIZE(num_change_pages));
3057         SaveLevel_CUS4(file, level, element);
3058       }
3059     }
3060   }
3061
3062   /* check for non-default group elements (unless using template level) */
3063   if (!level->use_custom_template)
3064   {
3065     for (i = 0; i < NUM_GROUP_ELEMENTS; i++)
3066     {
3067       int element = EL_GROUP_START + i;
3068
3069       if (element_info[element].modified_settings)
3070       {
3071         putFileChunkBE(file, "GRP1", LEVEL_CHUNK_GRP1_SIZE);
3072         SaveLevel_GRP1(file, level, element);
3073       }
3074     }
3075   }
3076
3077   fclose(file);
3078
3079   SetFilePermissions(filename, PERMS_PRIVATE);
3080 }
3081
3082 void SaveLevel(int nr)
3083 {
3084   char *filename = getDefaultLevelFilename(nr);
3085
3086   SaveLevelFromFilename(&level, filename);
3087 }
3088
3089 void SaveLevelTemplate()
3090 {
3091   char *filename = getDefaultLevelFilename(-1);
3092
3093   SaveLevelFromFilename(&level, filename);
3094 }
3095
3096 void DumpLevel(struct LevelInfo *level)
3097 {
3098   if (level->no_valid_file)
3099   {
3100     Error(ERR_WARN, "cannot dump -- no valid level file found");
3101
3102     return;
3103   }
3104
3105   printf_line("-", 79);
3106   printf("Level xxx (file version %08d, game version %08d)\n",
3107          level->file_version, level->game_version);
3108   printf_line("-", 79);
3109
3110   printf("Level author: '%s'\n", level->author);
3111   printf("Level title:  '%s'\n", level->name);
3112   printf("\n");
3113   printf("Playfield size: %d x %d\n", level->fieldx, level->fieldy);
3114   printf("\n");
3115   printf("Level time:  %d seconds\n", level->time);
3116   printf("Gems needed: %d\n", level->gems_needed);
3117   printf("\n");
3118   printf("Time for magic wall: %d seconds\n", level->time_magic_wall);
3119   printf("Time for wheel:      %d seconds\n", level->time_wheel);
3120   printf("Time for light:      %d seconds\n", level->time_light);
3121   printf("Time for timegate:   %d seconds\n", level->time_timegate);
3122   printf("\n");
3123   printf("Amoeba speed: %d\n", level->amoeba_speed);
3124   printf("\n");
3125   printf("Initial gravity:             %s\n", (level->initial_gravity ? "yes" : "no"));
3126   printf("Double speed movement:       %s\n", (level->double_speed ? "yes" : "no"));
3127   printf("EM style slippery gems:      %s\n", (level->em_slippery_gems ? "yes" : "no"));
3128   printf("Player blocks last field:    %s\n", (level->block_last_field ? "yes" : "no"));
3129   printf("SP player blocks last field: %s\n", (level->sp_block_last_field ? "yes" : "no"));
3130   printf("use spring bug: %s\n", (level->use_spring_bug ? "yes" : "no"));
3131   printf("use step counter: %s\n", (level->use_step_counter ? "yes" : "no"));
3132
3133   printf_line("-", 79);
3134 }
3135
3136
3137 /* ========================================================================= */
3138 /* tape file functions                                                       */
3139 /* ========================================================================= */
3140
3141 static void setTapeInfoToDefaults()
3142 {
3143   int i;
3144
3145   /* always start with reliable default values (empty tape) */
3146   TapeErase();
3147
3148   /* default values (also for pre-1.2 tapes) with only the first player */
3149   tape.player_participates[0] = TRUE;
3150   for (i = 1; i < MAX_PLAYERS; i++)
3151     tape.player_participates[i] = FALSE;
3152
3153   /* at least one (default: the first) player participates in every tape */
3154   tape.num_participating_players = 1;
3155
3156   tape.level_nr = level_nr;
3157   tape.counter = 0;
3158   tape.changed = FALSE;
3159
3160   tape.recording = FALSE;
3161   tape.playing = FALSE;
3162   tape.pausing = FALSE;
3163
3164   tape.no_valid_file = FALSE;
3165 }
3166
3167 static int LoadTape_VERS(FILE *file, int chunk_size, struct TapeInfo *tape)
3168 {
3169   tape->file_version = getFileVersion(file);
3170   tape->game_version = getFileVersion(file);
3171
3172   return chunk_size;
3173 }
3174
3175 static int LoadTape_HEAD(FILE *file, int chunk_size, struct TapeInfo *tape)
3176 {
3177   int i;
3178
3179   tape->random_seed = getFile32BitBE(file);
3180   tape->date        = getFile32BitBE(file);
3181   tape->length      = getFile32BitBE(file);
3182
3183   /* read header fields that are new since version 1.2 */
3184   if (tape->file_version >= FILE_VERSION_1_2)
3185   {
3186     byte store_participating_players = getFile8Bit(file);
3187     int engine_version;
3188
3189     /* since version 1.2, tapes store which players participate in the tape */
3190     tape->num_participating_players = 0;
3191     for (i = 0; i < MAX_PLAYERS; i++)
3192     {
3193       tape->player_participates[i] = FALSE;
3194
3195       if (store_participating_players & (1 << i))
3196       {
3197         tape->player_participates[i] = TRUE;
3198         tape->num_participating_players++;
3199       }
3200     }
3201
3202     ReadUnusedBytesFromFile(file, TAPE_HEADER_UNUSED);
3203
3204     engine_version = getFileVersion(file);
3205     if (engine_version > 0)
3206       tape->engine_version = engine_version;
3207     else
3208       tape->engine_version = tape->game_version;
3209   }
3210
3211   return chunk_size;
3212 }
3213
3214 static int LoadTape_INFO(FILE *file, int chunk_size, struct TapeInfo *tape)
3215 {
3216   int level_identifier_size;
3217   int i;
3218
3219   level_identifier_size = getFile16BitBE(file);
3220
3221   tape->level_identifier =
3222     checked_realloc(tape->level_identifier, level_identifier_size);
3223
3224   for (i = 0; i < level_identifier_size; i++)
3225     tape->level_identifier[i] = getFile8Bit(file);
3226
3227   tape->level_nr = getFile16BitBE(file);
3228
3229   chunk_size = 2 + level_identifier_size + 2;
3230
3231   return chunk_size;
3232 }
3233
3234 static int LoadTape_BODY(FILE *file, int chunk_size, struct TapeInfo *tape)
3235 {
3236   int i, j;
3237   int chunk_size_expected =
3238     (tape->num_participating_players + 1) * tape->length;
3239
3240   if (chunk_size_expected != chunk_size)
3241   {
3242     ReadUnusedBytesFromFile(file, chunk_size);
3243     return chunk_size_expected;
3244   }
3245
3246   for (i = 0; i < tape->length; i++)
3247   {
3248     if (i >= MAX_TAPELEN)
3249       break;
3250
3251     for (j = 0; j < MAX_PLAYERS; j++)
3252     {
3253       tape->pos[i].action[j] = MV_NO_MOVING;
3254
3255       if (tape->player_participates[j])
3256         tape->pos[i].action[j] = getFile8Bit(file);
3257     }
3258
3259     tape->pos[i].delay = getFile8Bit(file);
3260
3261     if (tape->file_version == FILE_VERSION_1_0)
3262     {
3263       /* eliminate possible diagonal moves in old tapes */
3264       /* this is only for backward compatibility */
3265
3266       byte joy_dir[4] = { JOY_LEFT, JOY_RIGHT, JOY_UP, JOY_DOWN };
3267       byte action = tape->pos[i].action[0];
3268       int k, num_moves = 0;
3269
3270       for (k = 0; k<4; k++)
3271       {
3272         if (action & joy_dir[k])
3273         {
3274           tape->pos[i + num_moves].action[0] = joy_dir[k];
3275           if (num_moves > 0)
3276             tape->pos[i + num_moves].delay = 0;
3277           num_moves++;
3278         }
3279       }
3280
3281       if (num_moves > 1)
3282       {
3283         num_moves--;
3284         i += num_moves;
3285         tape->length += num_moves;
3286       }
3287     }
3288     else if (tape->file_version < FILE_VERSION_2_0)
3289     {
3290       /* convert pre-2.0 tapes to new tape format */
3291
3292       if (tape->pos[i].delay > 1)
3293       {
3294         /* action part */
3295         tape->pos[i + 1] = tape->pos[i];
3296         tape->pos[i + 1].delay = 1;
3297
3298         /* delay part */
3299         for (j = 0; j < MAX_PLAYERS; j++)
3300           tape->pos[i].action[j] = MV_NO_MOVING;
3301         tape->pos[i].delay--;
3302
3303         i++;
3304         tape->length++;
3305       }
3306     }
3307
3308     if (feof(file))
3309       break;
3310   }
3311
3312   if (i != tape->length)
3313     chunk_size = (tape->num_participating_players + 1) * i;
3314
3315   return chunk_size;
3316 }
3317
3318 void LoadTapeFromFilename(char *filename)
3319 {
3320   char cookie[MAX_LINE_LEN];
3321   char chunk_name[CHUNK_ID_LEN + 1];
3322   FILE *file;
3323   int chunk_size;
3324
3325   /* always start with reliable default values */
3326   setTapeInfoToDefaults();
3327
3328   if (!(file = fopen(filename, MODE_READ)))
3329   {
3330     tape.no_valid_file = TRUE;
3331
3332 #if 0
3333     Error(ERR_WARN, "cannot read tape '%s' -- using empty tape", filename);
3334 #endif
3335
3336     return;
3337   }
3338
3339   getFileChunkBE(file, chunk_name, NULL);
3340   if (strcmp(chunk_name, "RND1") == 0)
3341   {
3342     getFile32BitBE(file);               /* not used */
3343
3344     getFileChunkBE(file, chunk_name, NULL);
3345     if (strcmp(chunk_name, "TAPE") != 0)
3346     {
3347       tape.no_valid_file = TRUE;
3348
3349       Error(ERR_WARN, "unknown format of tape file '%s'", filename);
3350       fclose(file);
3351       return;
3352     }
3353   }
3354   else  /* check for pre-2.0 file format with cookie string */
3355   {
3356     strcpy(cookie, chunk_name);
3357     fgets(&cookie[4], MAX_LINE_LEN - 4, file);
3358     if (strlen(cookie) > 0 && cookie[strlen(cookie) - 1] == '\n')
3359       cookie[strlen(cookie) - 1] = '\0';
3360
3361     if (!checkCookieString(cookie, TAPE_COOKIE_TMPL))
3362     {
3363       tape.no_valid_file = TRUE;
3364
3365       Error(ERR_WARN, "unknown format of tape file '%s'", filename);
3366       fclose(file);
3367       return;
3368     }
3369
3370     if ((tape.file_version = getFileVersionFromCookieString(cookie)) == -1)
3371     {
3372       tape.no_valid_file = TRUE;
3373
3374       Error(ERR_WARN, "unsupported version of tape file '%s'", filename);
3375       fclose(file);
3376       return;
3377     }
3378
3379     /* pre-2.0 tape files have no game version, so use file version here */
3380     tape.game_version = tape.file_version;
3381   }
3382
3383   if (tape.file_version < FILE_VERSION_1_2)
3384   {
3385     /* tape files from versions before 1.2.0 without chunk structure */
3386     LoadTape_HEAD(file, TAPE_HEADER_SIZE, &tape);
3387     LoadTape_BODY(file, 2 * tape.length,  &tape);
3388   }
3389   else
3390   {
3391     static struct
3392     {
3393       char *name;
3394       int size;
3395       int (*loader)(FILE *, int, struct TapeInfo *);
3396     }
3397     chunk_info[] =
3398     {
3399       { "VERS", FILE_VERS_CHUNK_SIZE,   LoadTape_VERS },
3400       { "HEAD", TAPE_HEADER_SIZE,       LoadTape_HEAD },
3401       { "INFO", -1,                     LoadTape_INFO },
3402       { "BODY", -1,                     LoadTape_BODY },
3403       {  NULL,  0,                      NULL }
3404     };
3405
3406     while (getFileChunkBE(file, chunk_name, &chunk_size))
3407     {
3408       int i = 0;
3409
3410       while (chunk_info[i].name != NULL &&
3411              strcmp(chunk_name, chunk_info[i].name) != 0)
3412         i++;
3413
3414       if (chunk_info[i].name == NULL)
3415       {
3416         Error(ERR_WARN, "unknown chunk '%s' in tape file '%s'",
3417               chunk_name, filename);
3418         ReadUnusedBytesFromFile(file, chunk_size);
3419       }
3420       else if (chunk_info[i].size != -1 &&
3421                chunk_info[i].size != chunk_size)
3422       {
3423         Error(ERR_WARN, "wrong size (%d) of chunk '%s' in tape file '%s'",
3424               chunk_size, chunk_name, filename);
3425         ReadUnusedBytesFromFile(file, chunk_size);
3426       }
3427       else
3428       {
3429         /* call function to load this tape chunk */
3430         int chunk_size_expected =
3431           (chunk_info[i].loader)(file, chunk_size, &tape);
3432
3433         /* the size of some chunks cannot be checked before reading other
3434            chunks first (like "HEAD" and "BODY") that contain some header
3435            information, so check them here */
3436         if (chunk_size_expected != chunk_size)
3437         {
3438           Error(ERR_WARN, "wrong size (%d) of chunk '%s' in tape file '%s'",
3439                 chunk_size, chunk_name, filename);
3440         }
3441       }
3442     }
3443   }
3444
3445   fclose(file);
3446
3447   tape.length_seconds = GetTapeLength();
3448
3449 #if 0
3450   printf("::: tape game version: %d\n", tape.game_version);
3451   printf("::: tape engine version: %d\n", tape.engine_version);
3452 #endif
3453 }
3454
3455 void LoadTape(int nr)
3456 {
3457   char *filename = getTapeFilename(nr);
3458
3459   LoadTapeFromFilename(filename);
3460 }
3461
3462 void LoadSolutionTape(int nr)
3463 {
3464   char *filename = getSolutionTapeFilename(nr);
3465
3466   LoadTapeFromFilename(filename);
3467 }
3468
3469 static void SaveTape_VERS(FILE *file, struct TapeInfo *tape)
3470 {
3471   putFileVersion(file, tape->file_version);
3472   putFileVersion(file, tape->game_version);
3473 }
3474
3475 static void SaveTape_HEAD(FILE *file, struct TapeInfo *tape)
3476 {
3477   int i;
3478   byte store_participating_players = 0;
3479
3480   /* set bits for participating players for compact storage */
3481   for (i = 0; i < MAX_PLAYERS; i++)
3482     if (tape->player_participates[i])
3483       store_participating_players |= (1 << i);
3484
3485   putFile32BitBE(file, tape->random_seed);
3486   putFile32BitBE(file, tape->date);
3487   putFile32BitBE(file, tape->length);
3488
3489   putFile8Bit(file, store_participating_players);
3490
3491   /* unused bytes not at the end here for 4-byte alignment of engine_version */
3492   WriteUnusedBytesToFile(file, TAPE_HEADER_UNUSED);
3493
3494   putFileVersion(file, tape->engine_version);
3495 }
3496
3497 static void SaveTape_INFO(FILE *file, struct TapeInfo *tape)
3498 {
3499   int level_identifier_size = strlen(tape->level_identifier) + 1;
3500   int i;
3501
3502   putFile16BitBE(file, level_identifier_size);
3503
3504   for (i = 0; i < level_identifier_size; i++)
3505     putFile8Bit(file, tape->level_identifier[i]);
3506
3507   putFile16BitBE(file, tape->level_nr);
3508 }
3509
3510 static void SaveTape_BODY(FILE *file, struct TapeInfo *tape)
3511 {
3512   int i, j;
3513
3514   for (i = 0; i < tape->length; i++)
3515   {
3516     for (j = 0; j < MAX_PLAYERS; j++)
3517       if (tape->player_participates[j])
3518         putFile8Bit(file, tape->pos[i].action[j]);
3519
3520     putFile8Bit(file, tape->pos[i].delay);
3521   }
3522 }
3523
3524 void SaveTape(int nr)
3525 {
3526   char *filename = getTapeFilename(nr);
3527   FILE *file;
3528   boolean new_tape = TRUE;
3529   int num_participating_players = 0;
3530   int info_chunk_size;
3531   int body_chunk_size;
3532   int i;
3533
3534   InitTapeDirectory(leveldir_current->subdir);
3535
3536   /* if a tape still exists, ask to overwrite it */
3537   if (access(filename, F_OK) == 0)
3538   {
3539     new_tape = FALSE;
3540     if (!Request("Replace old tape ?", REQ_ASK))
3541       return;
3542   }
3543
3544   if (!(file = fopen(filename, MODE_WRITE)))
3545   {
3546     Error(ERR_WARN, "cannot save level recording file '%s'", filename);
3547     return;
3548   }
3549
3550   tape.file_version = FILE_VERSION_ACTUAL;
3551   tape.game_version = GAME_VERSION_ACTUAL;
3552
3553   /* count number of participating players  */
3554   for (i = 0; i < MAX_PLAYERS; i++)
3555     if (tape.player_participates[i])
3556       num_participating_players++;
3557
3558   info_chunk_size = 2 + (strlen(tape.level_identifier) + 1) + 2;
3559   body_chunk_size = (num_participating_players + 1) * tape.length;
3560
3561   putFileChunkBE(file, "RND1", CHUNK_SIZE_UNDEFINED);
3562   putFileChunkBE(file, "TAPE", CHUNK_SIZE_NONE);
3563
3564   putFileChunkBE(file, "VERS", FILE_VERS_CHUNK_SIZE);
3565   SaveTape_VERS(file, &tape);
3566
3567   putFileChunkBE(file, "HEAD", TAPE_HEADER_SIZE);
3568   SaveTape_HEAD(file, &tape);
3569
3570   putFileChunkBE(file, "INFO", info_chunk_size);
3571   SaveTape_INFO(file, &tape);
3572
3573   putFileChunkBE(file, "BODY", body_chunk_size);
3574   SaveTape_BODY(file, &tape);
3575
3576   fclose(file);
3577
3578   SetFilePermissions(filename, PERMS_PRIVATE);
3579
3580   tape.changed = FALSE;
3581
3582   if (new_tape)
3583     Request("tape saved !", REQ_CONFIRM);
3584 }
3585
3586 void DumpTape(struct TapeInfo *tape)
3587 {
3588   int i, j;
3589
3590 #if 1
3591   if (tape->no_valid_file)
3592   {
3593     Error(ERR_WARN, "cannot dump -- no valid tape file found");
3594
3595     return;
3596   }
3597 #else
3598   if (TAPE_IS_EMPTY(*tape))
3599   {
3600     Error(ERR_WARN, "no tape available for level %d", tape->level_nr);
3601
3602     return;
3603   }
3604 #endif
3605
3606   printf_line("-", 79);
3607   printf("Tape of Level %03d (file version %08d, game version %08d)\n",
3608          tape->level_nr, tape->file_version, tape->game_version);
3609   printf("Level series identifier: '%s'\n", tape->level_identifier);
3610   printf_line("-", 79);
3611
3612   for (i = 0; i < tape->length; i++)
3613   {
3614     if (i >= MAX_TAPELEN)
3615       break;
3616
3617     printf("%03d: ", i);
3618
3619     for (j = 0; j < MAX_PLAYERS; j++)
3620     {
3621       if (tape->player_participates[j])
3622       {
3623         int action = tape->pos[i].action[j];
3624
3625         printf("%d:%02x ", j, action);
3626         printf("[%c%c%c%c|%c%c] - ",
3627                (action & JOY_LEFT ? '<' : ' '),
3628                (action & JOY_RIGHT ? '>' : ' '),
3629                (action & JOY_UP ? '^' : ' '),
3630                (action & JOY_DOWN ? 'v' : ' '),
3631                (action & JOY_BUTTON_1 ? '1' : ' '),
3632                (action & JOY_BUTTON_2 ? '2' : ' '));
3633       }
3634     }
3635
3636     printf("(%03d)\n", tape->pos[i].delay);
3637   }
3638
3639   printf_line("-", 79);
3640 }
3641
3642
3643 /* ========================================================================= */
3644 /* score file functions                                                      */
3645 /* ========================================================================= */
3646
3647 void LoadScore(int nr)
3648 {
3649   int i;
3650   char *filename = getScoreFilename(nr);
3651   char cookie[MAX_LINE_LEN];
3652   char line[MAX_LINE_LEN];
3653   char *line_ptr;
3654   FILE *file;
3655
3656   /* always start with reliable default values */
3657   for (i = 0; i < MAX_SCORE_ENTRIES; i++)
3658   {
3659     strcpy(highscore[i].Name, EMPTY_PLAYER_NAME);
3660     highscore[i].Score = 0;
3661   }
3662
3663   if (!(file = fopen(filename, MODE_READ)))
3664     return;
3665
3666   /* check file identifier */
3667   fgets(cookie, MAX_LINE_LEN, file);
3668   if (strlen(cookie) > 0 && cookie[strlen(cookie) - 1] == '\n')
3669     cookie[strlen(cookie) - 1] = '\0';
3670
3671   if (!checkCookieString(cookie, SCORE_COOKIE))
3672   {
3673     Error(ERR_WARN, "unknown format of score file '%s'", filename);
3674     fclose(file);
3675     return;
3676   }
3677
3678   for (i = 0; i < MAX_SCORE_ENTRIES; i++)
3679   {
3680     fscanf(file, "%d", &highscore[i].Score);
3681     fgets(line, MAX_LINE_LEN, file);
3682
3683     if (line[strlen(line) - 1] == '\n')
3684       line[strlen(line) - 1] = '\0';
3685
3686     for (line_ptr = line; *line_ptr; line_ptr++)
3687     {
3688       if (*line_ptr != ' ' && *line_ptr != '\t' && *line_ptr != '\0')
3689       {
3690         strncpy(highscore[i].Name, line_ptr, MAX_PLAYER_NAME_LEN);
3691         highscore[i].Name[MAX_PLAYER_NAME_LEN] = '\0';
3692         break;
3693       }
3694     }
3695   }
3696
3697   fclose(file);
3698 }
3699
3700 void SaveScore(int nr)
3701 {
3702   int i;
3703   char *filename = getScoreFilename(nr);
3704   FILE *file;
3705
3706   InitScoreDirectory(leveldir_current->subdir);
3707
3708   if (!(file = fopen(filename, MODE_WRITE)))
3709   {
3710     Error(ERR_WARN, "cannot save score for level %d", nr);
3711     return;
3712   }
3713
3714   fprintf(file, "%s\n\n", SCORE_COOKIE);
3715
3716   for (i = 0; i < MAX_SCORE_ENTRIES; i++)
3717     fprintf(file, "%d %s\n", highscore[i].Score, highscore[i].Name);
3718
3719   fclose(file);
3720
3721   SetFilePermissions(filename, PERMS_PUBLIC);
3722 }
3723
3724
3725 /* ========================================================================= */
3726 /* setup file functions                                                      */
3727 /* ========================================================================= */
3728
3729 #define TOKEN_STR_PLAYER_PREFIX                 "player_"
3730
3731 /* global setup */
3732 #define SETUP_TOKEN_PLAYER_NAME                 0
3733 #define SETUP_TOKEN_SOUND                       1
3734 #define SETUP_TOKEN_SOUND_LOOPS                 2
3735 #define SETUP_TOKEN_SOUND_MUSIC                 3
3736 #define SETUP_TOKEN_SOUND_SIMPLE                4
3737 #define SETUP_TOKEN_TOONS                       5
3738 #define SETUP_TOKEN_SCROLL_DELAY                6
3739 #define SETUP_TOKEN_SOFT_SCROLLING              7
3740 #define SETUP_TOKEN_FADING                      8
3741 #define SETUP_TOKEN_AUTORECORD                  9
3742 #define SETUP_TOKEN_QUICK_DOORS                 10
3743 #define SETUP_TOKEN_TEAM_MODE                   11
3744 #define SETUP_TOKEN_HANDICAP                    12
3745 #define SETUP_TOKEN_TIME_LIMIT                  13
3746 #define SETUP_TOKEN_FULLSCREEN                  14
3747 #define SETUP_TOKEN_ASK_ON_ESCAPE               15
3748 #define SETUP_TOKEN_GRAPHICS_SET                16
3749 #define SETUP_TOKEN_SOUNDS_SET                  17
3750 #define SETUP_TOKEN_MUSIC_SET                   18
3751 #define SETUP_TOKEN_OVERRIDE_LEVEL_GRAPHICS     19
3752 #define SETUP_TOKEN_OVERRIDE_LEVEL_SOUNDS       20
3753 #define SETUP_TOKEN_OVERRIDE_LEVEL_MUSIC        21
3754
3755 #define NUM_GLOBAL_SETUP_TOKENS                 22
3756
3757 /* editor setup */
3758 #define SETUP_TOKEN_EDITOR_EL_BOULDERDASH       0
3759 #define SETUP_TOKEN_EDITOR_EL_EMERALD_MINE      1
3760 #define SETUP_TOKEN_EDITOR_EL_MORE              2
3761 #define SETUP_TOKEN_EDITOR_EL_SOKOBAN           3
3762 #define SETUP_TOKEN_EDITOR_EL_SUPAPLEX          4
3763 #define SETUP_TOKEN_EDITOR_EL_DIAMOND_CAVES     5
3764 #define SETUP_TOKEN_EDITOR_EL_DX_BOULDERDASH    6
3765 #define SETUP_TOKEN_EDITOR_EL_CHARS             7
3766 #define SETUP_TOKEN_EDITOR_EL_CUSTOM            8
3767 #define SETUP_TOKEN_EDITOR_EL_CUSTOM_MORE       9
3768 #define SETUP_TOKEN_EDITOR_EL_HEADLINES         10
3769 #define SETUP_TOKEN_EDITOR_EL_USER_DEFINED      11
3770
3771 #define NUM_EDITOR_SETUP_TOKENS                 12
3772
3773 /* shortcut setup */
3774 #define SETUP_TOKEN_SHORTCUT_SAVE_GAME          0
3775 #define SETUP_TOKEN_SHORTCUT_LOAD_GAME          1
3776 #define SETUP_TOKEN_SHORTCUT_TOGGLE_PAUSE       2
3777
3778 #define NUM_SHORTCUT_SETUP_TOKENS               3
3779
3780 /* player setup */
3781 #define SETUP_TOKEN_PLAYER_USE_JOYSTICK         0
3782 #define SETUP_TOKEN_PLAYER_JOY_DEVICE_NAME      1
3783 #define SETUP_TOKEN_PLAYER_JOY_XLEFT            2
3784 #define SETUP_TOKEN_PLAYER_JOY_XMIDDLE          3
3785 #define SETUP_TOKEN_PLAYER_JOY_XRIGHT           4
3786 #define SETUP_TOKEN_PLAYER_JOY_YUPPER           5
3787 #define SETUP_TOKEN_PLAYER_JOY_YMIDDLE          6
3788 #define SETUP_TOKEN_PLAYER_JOY_YLOWER           7
3789 #define SETUP_TOKEN_PLAYER_JOY_SNAP             8
3790 #define SETUP_TOKEN_PLAYER_JOY_DROP             9
3791 #define SETUP_TOKEN_PLAYER_KEY_LEFT             10
3792 #define SETUP_TOKEN_PLAYER_KEY_RIGHT            11
3793 #define SETUP_TOKEN_PLAYER_KEY_UP               12
3794 #define SETUP_TOKEN_PLAYER_KEY_DOWN             13
3795 #define SETUP_TOKEN_PLAYER_KEY_SNAP             14
3796 #define SETUP_TOKEN_PLAYER_KEY_DROP             15
3797
3798 #define NUM_PLAYER_SETUP_TOKENS                 16
3799
3800 /* system setup */
3801 #define SETUP_TOKEN_SYSTEM_SDL_AUDIODRIVER      0
3802 #define SETUP_TOKEN_SYSTEM_AUDIO_FRAGMENT_SIZE  1
3803
3804 #define NUM_SYSTEM_SETUP_TOKENS                 2
3805
3806 /* options setup */
3807 #define SETUP_TOKEN_OPTIONS_VERBOSE             0
3808
3809 #define NUM_OPTIONS_SETUP_TOKENS                1
3810
3811
3812 static struct SetupInfo si;
3813 static struct SetupEditorInfo sei;
3814 static struct SetupShortcutInfo ssi;
3815 static struct SetupInputInfo sii;
3816 static struct SetupSystemInfo syi;
3817 static struct OptionInfo soi;
3818
3819 static struct TokenInfo global_setup_tokens[] =
3820 {
3821   { TYPE_STRING, &si.player_name,       "player_name"                   },
3822   { TYPE_SWITCH, &si.sound,             "sound"                         },
3823   { TYPE_SWITCH, &si.sound_loops,       "repeating_sound_loops"         },
3824   { TYPE_SWITCH, &si.sound_music,       "background_music"              },
3825   { TYPE_SWITCH, &si.sound_simple,      "simple_sound_effects"          },
3826   { TYPE_SWITCH, &si.toons,             "toons"                         },
3827   { TYPE_SWITCH, &si.scroll_delay,      "scroll_delay"                  },
3828   { TYPE_SWITCH, &si.soft_scrolling,    "soft_scrolling"                },
3829   { TYPE_SWITCH, &si.fading,            "screen_fading"                 },
3830   { TYPE_SWITCH, &si.autorecord,        "automatic_tape_recording"      },
3831   { TYPE_SWITCH, &si.quick_doors,       "quick_doors"                   },
3832   { TYPE_SWITCH, &si.team_mode,         "team_mode"                     },
3833   { TYPE_SWITCH, &si.handicap,          "handicap"                      },
3834   { TYPE_SWITCH, &si.time_limit,        "time_limit"                    },
3835   { TYPE_SWITCH, &si.fullscreen,        "fullscreen"                    },
3836   { TYPE_SWITCH, &si.ask_on_escape,     "ask_on_escape"                 },
3837   { TYPE_STRING, &si.graphics_set,      "graphics_set"                  },
3838   { TYPE_STRING, &si.sounds_set,        "sounds_set"                    },
3839   { TYPE_STRING, &si.music_set,         "music_set"                     },
3840   { TYPE_SWITCH, &si.override_level_graphics, "override_level_graphics" },
3841   { TYPE_SWITCH, &si.override_level_sounds,   "override_level_sounds"   },
3842   { TYPE_SWITCH, &si.override_level_music,    "override_level_music"    },
3843 };
3844
3845 static struct TokenInfo editor_setup_tokens[] =
3846 {
3847   { TYPE_SWITCH, &sei.el_boulderdash,   "editor.el_boulderdash"         },
3848   { TYPE_SWITCH, &sei.el_emerald_mine,  "editor.el_emerald_mine"        },
3849   { TYPE_SWITCH, &sei.el_more,          "editor.el_more"                },
3850   { TYPE_SWITCH, &sei.el_sokoban,       "editor.el_sokoban"             },
3851   { TYPE_SWITCH, &sei.el_supaplex,      "editor.el_supaplex"            },
3852   { TYPE_SWITCH, &sei.el_diamond_caves, "editor.el_diamond_caves"       },
3853   { TYPE_SWITCH, &sei.el_dx_boulderdash,"editor.el_dx_boulderdash"      },
3854   { TYPE_SWITCH, &sei.el_chars,         "editor.el_chars"               },
3855   { TYPE_SWITCH, &sei.el_custom,        "editor.el_custom"              },
3856   { TYPE_SWITCH, &sei.el_custom_more,   "editor.el_custom_more"         },
3857   { TYPE_SWITCH, &sei.el_headlines,     "editor.el_headlines"           },
3858   { TYPE_SWITCH, &sei.el_user_defined,  "editor.el_user_defined"        },
3859 };
3860
3861 static struct TokenInfo shortcut_setup_tokens[] =
3862 {
3863   { TYPE_KEY_X11, &ssi.save_game,       "shortcut.save_game"            },
3864   { TYPE_KEY_X11, &ssi.load_game,       "shortcut.load_game"            },
3865   { TYPE_KEY_X11, &ssi.toggle_pause,    "shortcut.toggle_pause"         }
3866 };
3867
3868 static struct TokenInfo player_setup_tokens[] =
3869 {
3870   { TYPE_BOOLEAN, &sii.use_joystick,    ".use_joystick"                 },
3871   { TYPE_STRING,  &sii.joy.device_name, ".joy.device_name"              },
3872   { TYPE_INTEGER, &sii.joy.xleft,       ".joy.xleft"                    },
3873   { TYPE_INTEGER, &sii.joy.xmiddle,     ".joy.xmiddle"                  },
3874   { TYPE_INTEGER, &sii.joy.xright,      ".joy.xright"                   },
3875   { TYPE_INTEGER, &sii.joy.yupper,      ".joy.yupper"                   },
3876   { TYPE_INTEGER, &sii.joy.ymiddle,     ".joy.ymiddle"                  },
3877   { TYPE_INTEGER, &sii.joy.ylower,      ".joy.ylower"                   },
3878   { TYPE_INTEGER, &sii.joy.snap,        ".joy.snap_field"               },
3879   { TYPE_INTEGER, &sii.joy.drop,        ".joy.place_bomb"               },
3880   { TYPE_KEY_X11, &sii.key.left,        ".key.move_left"                },
3881   { TYPE_KEY_X11, &sii.key.right,       ".key.move_right"               },
3882   { TYPE_KEY_X11, &sii.key.up,          ".key.move_up"                  },
3883   { TYPE_KEY_X11, &sii.key.down,        ".key.move_down"                },
3884   { TYPE_KEY_X11, &sii.key.snap,        ".key.snap_field"               },
3885   { TYPE_KEY_X11, &sii.key.drop,        ".key.place_bomb"               }
3886 };
3887
3888 static struct TokenInfo system_setup_tokens[] =
3889 {
3890   { TYPE_STRING,  &syi.sdl_audiodriver, "system.sdl_audiodriver"        },
3891   { TYPE_INTEGER, &syi.audio_fragment_size,"system.audio_fragment_size" }
3892 };
3893
3894 static struct TokenInfo options_setup_tokens[] =
3895 {
3896   { TYPE_BOOLEAN, &soi.verbose,         "options.verbose"               }
3897 };
3898
3899 static char *get_corrected_login_name(char *login_name)
3900 {
3901   /* needed because player name must be a fixed length string */
3902   char *login_name_new = checked_malloc(MAX_PLAYER_NAME_LEN + 1);
3903
3904   strncpy(login_name_new, login_name, MAX_PLAYER_NAME_LEN);
3905   login_name_new[MAX_PLAYER_NAME_LEN] = '\0';
3906
3907   if (strlen(login_name) > MAX_PLAYER_NAME_LEN)         /* name has been cut */
3908     if (strchr(login_name_new, ' '))
3909       *strchr(login_name_new, ' ') = '\0';
3910
3911   return login_name_new;
3912 }
3913
3914 static void setSetupInfoToDefaults(struct SetupInfo *si)
3915 {
3916   int i;
3917
3918   si->player_name = get_corrected_login_name(getLoginName());
3919
3920   si->sound = TRUE;
3921   si->sound_loops = TRUE;
3922   si->sound_music = TRUE;
3923   si->sound_simple = TRUE;
3924   si->toons = TRUE;
3925   si->double_buffering = TRUE;
3926   si->direct_draw = !si->double_buffering;
3927   si->scroll_delay = TRUE;
3928   si->soft_scrolling = TRUE;
3929   si->fading = FALSE;
3930   si->autorecord = TRUE;
3931   si->quick_doors = FALSE;
3932   si->team_mode = FALSE;
3933   si->handicap = TRUE;
3934   si->time_limit = TRUE;
3935   si->fullscreen = FALSE;
3936   si->ask_on_escape = TRUE;
3937
3938   si->graphics_set = getStringCopy(GFX_CLASSIC_SUBDIR);
3939   si->sounds_set = getStringCopy(SND_CLASSIC_SUBDIR);
3940   si->music_set = getStringCopy(MUS_CLASSIC_SUBDIR);
3941   si->override_level_graphics = FALSE;
3942   si->override_level_sounds = FALSE;
3943   si->override_level_music = FALSE;
3944
3945   si->editor.el_boulderdash = TRUE;
3946   si->editor.el_emerald_mine = TRUE;
3947   si->editor.el_more = TRUE;
3948   si->editor.el_sokoban = TRUE;
3949   si->editor.el_supaplex = TRUE;
3950   si->editor.el_diamond_caves = TRUE;
3951   si->editor.el_dx_boulderdash = TRUE;
3952   si->editor.el_chars = TRUE;
3953   si->editor.el_custom = TRUE;
3954   si->editor.el_custom_more = FALSE;
3955
3956   si->editor.el_headlines = TRUE;
3957   si->editor.el_user_defined = FALSE;
3958
3959   si->shortcut.save_game = DEFAULT_KEY_SAVE_GAME;
3960   si->shortcut.load_game = DEFAULT_KEY_LOAD_GAME;
3961   si->shortcut.toggle_pause = DEFAULT_KEY_TOGGLE_PAUSE;
3962
3963   for (i = 0; i < MAX_PLAYERS; i++)
3964   {
3965     si->input[i].use_joystick = FALSE;
3966     si->input[i].joy.device_name=getStringCopy(getDeviceNameFromJoystickNr(i));
3967     si->input[i].joy.xleft   = JOYSTICK_XLEFT;
3968     si->input[i].joy.xmiddle = JOYSTICK_XMIDDLE;
3969     si->input[i].joy.xright  = JOYSTICK_XRIGHT;
3970     si->input[i].joy.yupper  = JOYSTICK_YUPPER;
3971     si->input[i].joy.ymiddle = JOYSTICK_YMIDDLE;
3972     si->input[i].joy.ylower  = JOYSTICK_YLOWER;
3973     si->input[i].joy.snap  = (i == 0 ? JOY_BUTTON_1 : 0);
3974     si->input[i].joy.drop  = (i == 0 ? JOY_BUTTON_2 : 0);
3975     si->input[i].key.left  = (i == 0 ? DEFAULT_KEY_LEFT  : KSYM_UNDEFINED);
3976     si->input[i].key.right = (i == 0 ? DEFAULT_KEY_RIGHT : KSYM_UNDEFINED);
3977     si->input[i].key.up    = (i == 0 ? DEFAULT_KEY_UP    : KSYM_UNDEFINED);
3978     si->input[i].key.down  = (i == 0 ? DEFAULT_KEY_DOWN  : KSYM_UNDEFINED);
3979     si->input[i].key.snap  = (i == 0 ? DEFAULT_KEY_SNAP  : KSYM_UNDEFINED);
3980     si->input[i].key.drop  = (i == 0 ? DEFAULT_KEY_DROP  : KSYM_UNDEFINED);
3981   }
3982
3983   si->system.sdl_audiodriver = getStringCopy(ARG_DEFAULT);
3984   si->system.audio_fragment_size = DEFAULT_AUDIO_FRAGMENT_SIZE;
3985
3986   si->options.verbose = FALSE;
3987 }
3988
3989 static void decodeSetupFileHash(SetupFileHash *setup_file_hash)
3990 {
3991   int i, pnr;
3992
3993   if (!setup_file_hash)
3994     return;
3995
3996   /* global setup */
3997   si = setup;
3998   for (i = 0; i < NUM_GLOBAL_SETUP_TOKENS; i++)
3999     setSetupInfo(global_setup_tokens, i,
4000                  getHashEntry(setup_file_hash, global_setup_tokens[i].text));
4001   setup = si;
4002
4003   /* editor setup */
4004   sei = setup.editor;
4005   for (i = 0; i < NUM_EDITOR_SETUP_TOKENS; i++)
4006     setSetupInfo(editor_setup_tokens, i,
4007                  getHashEntry(setup_file_hash,editor_setup_tokens[i].text));
4008   setup.editor = sei;
4009
4010   /* shortcut setup */
4011   ssi = setup.shortcut;
4012   for (i = 0; i < NUM_SHORTCUT_SETUP_TOKENS; i++)
4013     setSetupInfo(shortcut_setup_tokens, i,
4014                  getHashEntry(setup_file_hash,shortcut_setup_tokens[i].text));
4015   setup.shortcut = ssi;
4016
4017   /* player setup */
4018   for (pnr = 0; pnr < MAX_PLAYERS; pnr++)
4019   {
4020     char prefix[30];
4021
4022     sprintf(prefix, "%s%d", TOKEN_STR_PLAYER_PREFIX, pnr + 1);
4023
4024     sii = setup.input[pnr];
4025     for (i = 0; i < NUM_PLAYER_SETUP_TOKENS; i++)
4026     {
4027       char full_token[100];
4028
4029       sprintf(full_token, "%s%s", prefix, player_setup_tokens[i].text);
4030       setSetupInfo(player_setup_tokens, i,
4031                    getHashEntry(setup_file_hash, full_token));
4032     }
4033     setup.input[pnr] = sii;
4034   }
4035
4036   /* system setup */
4037   syi = setup.system;
4038   for (i = 0; i < NUM_SYSTEM_SETUP_TOKENS; i++)
4039     setSetupInfo(system_setup_tokens, i,
4040                  getHashEntry(setup_file_hash, system_setup_tokens[i].text));
4041   setup.system = syi;
4042
4043   /* options setup */
4044   soi = setup.options;
4045   for (i = 0; i < NUM_OPTIONS_SETUP_TOKENS; i++)
4046     setSetupInfo(options_setup_tokens, i,
4047                  getHashEntry(setup_file_hash, options_setup_tokens[i].text));
4048   setup.options = soi;
4049 }
4050
4051 void LoadSetup()
4052 {
4053   char *filename = getSetupFilename();
4054   SetupFileHash *setup_file_hash = NULL;
4055
4056   /* always start with reliable default values */
4057   setSetupInfoToDefaults(&setup);
4058
4059   setup_file_hash = loadSetupFileHash(filename);
4060
4061   if (setup_file_hash)
4062   {
4063     char *player_name_new;
4064
4065     checkSetupFileHashIdentifier(setup_file_hash, getCookie("SETUP"));
4066     decodeSetupFileHash(setup_file_hash);
4067
4068     setup.direct_draw = !setup.double_buffering;
4069
4070     freeSetupFileHash(setup_file_hash);
4071
4072     /* needed to work around problems with fixed length strings */
4073     player_name_new = get_corrected_login_name(setup.player_name);
4074     free(setup.player_name);
4075     setup.player_name = player_name_new;
4076   }
4077   else
4078     Error(ERR_WARN, "using default setup values");
4079 }
4080
4081 void SaveSetup()
4082 {
4083   char *filename = getSetupFilename();
4084   FILE *file;
4085   int i, pnr;
4086
4087   InitUserDataDirectory();
4088
4089   if (!(file = fopen(filename, MODE_WRITE)))
4090   {
4091     Error(ERR_WARN, "cannot write setup file '%s'", filename);
4092     return;
4093   }
4094
4095   fprintf(file, "%s\n", getFormattedSetupEntry(TOKEN_STR_FILE_IDENTIFIER,
4096                                                getCookie("SETUP")));
4097   fprintf(file, "\n");
4098
4099   /* global setup */
4100   si = setup;
4101   for (i = 0; i < NUM_GLOBAL_SETUP_TOKENS; i++)
4102   {
4103     /* just to make things nicer :) */
4104     if (i == SETUP_TOKEN_PLAYER_NAME + 1 ||
4105         i == SETUP_TOKEN_GRAPHICS_SET)
4106       fprintf(file, "\n");
4107
4108     fprintf(file, "%s\n", getSetupLine(global_setup_tokens, "", i));
4109   }
4110
4111   /* editor setup */
4112   sei = setup.editor;
4113   fprintf(file, "\n");
4114   for (i = 0; i < NUM_EDITOR_SETUP_TOKENS; i++)
4115     fprintf(file, "%s\n", getSetupLine(editor_setup_tokens, "", i));
4116
4117   /* shortcut setup */
4118   ssi = setup.shortcut;
4119   fprintf(file, "\n");
4120   for (i = 0; i < NUM_SHORTCUT_SETUP_TOKENS; i++)
4121     fprintf(file, "%s\n", getSetupLine(shortcut_setup_tokens, "", i));
4122
4123   /* player setup */
4124   for (pnr = 0; pnr < MAX_PLAYERS; pnr++)
4125   {
4126     char prefix[30];
4127
4128     sprintf(prefix, "%s%d", TOKEN_STR_PLAYER_PREFIX, pnr + 1);
4129     fprintf(file, "\n");
4130
4131     sii = setup.input[pnr];
4132     for (i = 0; i < NUM_PLAYER_SETUP_TOKENS; i++)
4133       fprintf(file, "%s\n", getSetupLine(player_setup_tokens, prefix, i));
4134   }
4135
4136   /* system setup */
4137   syi = setup.system;
4138   fprintf(file, "\n");
4139   for (i = 0; i < NUM_SYSTEM_SETUP_TOKENS; i++)
4140     fprintf(file, "%s\n", getSetupLine(system_setup_tokens, "", i));
4141
4142   /* options setup */
4143   soi = setup.options;
4144   fprintf(file, "\n");
4145   for (i = 0; i < NUM_OPTIONS_SETUP_TOKENS; i++)
4146     fprintf(file, "%s\n", getSetupLine(options_setup_tokens, "", i));
4147
4148   fclose(file);
4149
4150   SetFilePermissions(filename, PERMS_PRIVATE);
4151 }
4152
4153 void LoadCustomElementDescriptions()
4154 {
4155   char *filename = getCustomArtworkConfigFilename(ARTWORK_TYPE_GRAPHICS);
4156   SetupFileHash *setup_file_hash;
4157   int i;
4158
4159   for (i = 0; i < NUM_FILE_ELEMENTS; i++)
4160   {
4161     if (element_info[i].custom_description != NULL)
4162     {
4163       free(element_info[i].custom_description);
4164       element_info[i].custom_description = NULL;
4165     }
4166   }
4167
4168   if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
4169     return;
4170
4171   for (i = 0; i < NUM_FILE_ELEMENTS; i++)
4172   {
4173     char *token = getStringCat2(element_info[i].token_name, ".name");
4174     char *value = getHashEntry(setup_file_hash, token);
4175
4176     if (value != NULL)
4177       element_info[i].custom_description = getStringCopy(value);
4178
4179     free(token);
4180   }
4181
4182   freeSetupFileHash(setup_file_hash);
4183 }
4184
4185 void LoadSpecialMenuDesignSettings()
4186 {
4187   char *filename = getCustomArtworkConfigFilename(ARTWORK_TYPE_GRAPHICS);
4188   SetupFileHash *setup_file_hash;
4189   int i, j;
4190
4191   /* always start with reliable default values from default config */
4192   for (i = 0; image_config_vars[i].token != NULL; i++)
4193     for (j = 0; image_config[j].token != NULL; j++)
4194       if (strcmp(image_config_vars[i].token, image_config[j].token) == 0)
4195         *image_config_vars[i].value =
4196           get_auto_parameter_value(image_config_vars[i].token,
4197                                    image_config[j].value);
4198
4199   if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
4200     return;
4201
4202   /* special case: initialize with default values that may be overwritten */
4203   for (i = 0; i < NUM_SPECIAL_GFX_ARGS; i++)
4204   {
4205     char *value_x = getHashEntry(setup_file_hash, "menu.draw_xoffset");
4206     char *value_y = getHashEntry(setup_file_hash, "menu.draw_yoffset");
4207     char *list_size = getHashEntry(setup_file_hash, "menu.list_size");
4208
4209     if (value_x != NULL)
4210       menu.draw_xoffset[i] = get_integer_from_string(value_x);
4211     if (value_y != NULL)
4212       menu.draw_yoffset[i] = get_integer_from_string(value_y);
4213     if (list_size != NULL)
4214       menu.list_size[i] = get_integer_from_string(list_size);
4215   }
4216
4217   /* read (and overwrite with) values that may be specified in config file */
4218   for (i = 0; image_config_vars[i].token != NULL; i++)
4219   {
4220     char *value = getHashEntry(setup_file_hash, image_config_vars[i].token);
4221
4222     if (value != NULL)
4223       *image_config_vars[i].value =
4224         get_auto_parameter_value(image_config_vars[i].token, value);
4225   }
4226
4227   freeSetupFileHash(setup_file_hash);
4228 }
4229
4230 void LoadUserDefinedEditorElementList(int **elements, int *num_elements)
4231 {
4232   char *filename = getEditorSetupFilename();
4233   SetupFileList *setup_file_list, *list;
4234   SetupFileHash *element_hash;
4235   int num_unknown_tokens = 0;
4236   int i;
4237
4238   if ((setup_file_list = loadSetupFileList(filename)) == NULL)
4239     return;
4240
4241   element_hash = newSetupFileHash();
4242
4243   for (i = 0; i < NUM_FILE_ELEMENTS; i++)
4244     setHashEntry(element_hash, element_info[i].token_name, i_to_a(i));
4245
4246   /* determined size may be larger than needed (due to unknown elements) */
4247   *num_elements = 0;
4248   for (list = setup_file_list; list != NULL; list = list->next)
4249     (*num_elements)++;
4250
4251   /* add space for up to 3 more elements for padding that may be needed */
4252   *num_elements += 3;
4253
4254   *elements = checked_malloc(*num_elements * sizeof(int));
4255
4256   *num_elements = 0;
4257   for (list = setup_file_list; list != NULL; list = list->next)
4258   {
4259     char *value = getHashEntry(element_hash, list->token);
4260
4261     if (value)
4262     {
4263       (*elements)[(*num_elements)++] = atoi(value);
4264     }
4265     else
4266     {
4267       if (num_unknown_tokens == 0)
4268       {
4269         Error(ERR_RETURN_LINE, "-");
4270         Error(ERR_RETURN, "warning: unknown token(s) found in config file:");
4271         Error(ERR_RETURN, "- config file: '%s'", filename);
4272
4273         num_unknown_tokens++;
4274       }
4275
4276       Error(ERR_RETURN, "- token: '%s'", list->token);
4277     }
4278   }
4279
4280   if (num_unknown_tokens > 0)
4281     Error(ERR_RETURN_LINE, "-");
4282
4283   while (*num_elements % 4)     /* pad with empty elements, if needed */
4284     (*elements)[(*num_elements)++] = EL_EMPTY;
4285
4286   freeSetupFileList(setup_file_list);
4287   freeSetupFileHash(element_hash);
4288
4289 #if 0
4290   /* TEST-ONLY */
4291   for (i = 0; i < *num_elements; i++)
4292     printf("editor: element '%s' [%d]\n",
4293            element_info[(*elements)[i]].token_name, (*elements)[i]);
4294 #endif
4295 }
4296
4297 static struct MusicFileInfo *get_music_file_info_ext(char *basename, int music,
4298                                                      boolean is_sound)
4299 {
4300   SetupFileHash *setup_file_hash = NULL;
4301   struct MusicFileInfo tmp_music_file_info, *new_music_file_info;
4302   char *filename_music, *filename_prefix, *filename_info;
4303   struct
4304   {
4305     char *token;
4306     char **value_ptr;
4307   }
4308   token_to_value_ptr[] =
4309   {
4310     { "title_header",   &tmp_music_file_info.title_header       },
4311     { "artist_header",  &tmp_music_file_info.artist_header      },
4312     { "album_header",   &tmp_music_file_info.album_header       },
4313     { "year_header",    &tmp_music_file_info.year_header        },
4314
4315     { "title",          &tmp_music_file_info.title              },
4316     { "artist",         &tmp_music_file_info.artist             },
4317     { "album",          &tmp_music_file_info.album              },
4318     { "year",           &tmp_music_file_info.year               },
4319
4320     { NULL,             NULL                                    },
4321   };
4322   int i;
4323
4324   filename_music = (is_sound ? getCustomSoundFilename(basename) :
4325                     getCustomMusicFilename(basename));
4326
4327   if (filename_music == NULL)
4328     return NULL;
4329
4330   /* ---------- try to replace file extension ---------- */
4331
4332   filename_prefix = getStringCopy(filename_music);
4333   if (strrchr(filename_prefix, '.') != NULL)
4334     *strrchr(filename_prefix, '.') = '\0';
4335   filename_info = getStringCat2(filename_prefix, ".txt");
4336
4337 #if 0
4338   printf("trying to load file '%s'...\n", filename_info);
4339 #endif
4340
4341   if (fileExists(filename_info))
4342     setup_file_hash = loadSetupFileHash(filename_info);
4343
4344   free(filename_prefix);
4345   free(filename_info);
4346
4347   if (setup_file_hash == NULL)
4348   {
4349     /* ---------- try to add file extension ---------- */
4350
4351     filename_prefix = getStringCopy(filename_music);
4352     filename_info = getStringCat2(filename_prefix, ".txt");
4353
4354 #if 0
4355     printf("trying to load file '%s'...\n", filename_info);
4356 #endif
4357
4358     if (fileExists(filename_info))
4359       setup_file_hash = loadSetupFileHash(filename_info);
4360
4361     free(filename_prefix);
4362     free(filename_info);
4363   }
4364
4365   if (setup_file_hash == NULL)
4366     return NULL;
4367
4368   /* ---------- music file info found ---------- */
4369
4370   memset(&tmp_music_file_info, 0, sizeof(struct MusicFileInfo));
4371
4372   for (i = 0; token_to_value_ptr[i].token != NULL; i++)
4373   {
4374     char *value = getHashEntry(setup_file_hash, token_to_value_ptr[i].token);
4375
4376     *token_to_value_ptr[i].value_ptr =
4377       getStringCopy(value != NULL && *value != '\0' ? value : UNKNOWN_NAME);
4378   }
4379
4380   tmp_music_file_info.basename = getStringCopy(basename);
4381   tmp_music_file_info.music = music;
4382   tmp_music_file_info.is_sound = is_sound;
4383
4384   new_music_file_info = checked_malloc(sizeof(struct MusicFileInfo));
4385   *new_music_file_info = tmp_music_file_info;
4386
4387   return new_music_file_info;
4388 }
4389
4390 static struct MusicFileInfo *get_music_file_info(char *basename, int music)
4391 {
4392   return get_music_file_info_ext(basename, music, FALSE);
4393 }
4394
4395 static struct MusicFileInfo *get_sound_file_info(char *basename, int sound)
4396 {
4397   return get_music_file_info_ext(basename, sound, TRUE);
4398 }
4399
4400 static boolean music_info_listed_ext(struct MusicFileInfo *list,
4401                                      char *basename, boolean is_sound)
4402 {
4403   for (; list != NULL; list = list->next)
4404     if (list->is_sound == is_sound && strcmp(list->basename, basename) == 0)
4405       return TRUE;
4406
4407   return FALSE;
4408 }
4409
4410 static boolean music_info_listed(struct MusicFileInfo *list, char *basename)
4411 {
4412   return music_info_listed_ext(list, basename, FALSE);
4413 }
4414
4415 static boolean sound_info_listed(struct MusicFileInfo *list, char *basename)
4416 {
4417   return music_info_listed_ext(list, basename, TRUE);
4418 }
4419
4420 void LoadMusicInfo()
4421 {
4422   char *music_directory = getCustomMusicDirectory();
4423   int num_music = getMusicListSize();
4424   int num_music_noconf = 0;
4425   int num_sounds = getSoundListSize();
4426   DIR *dir;
4427   struct dirent *dir_entry;
4428   struct FileInfo *music, *sound;
4429   struct MusicFileInfo *next, **new;
4430   int i;
4431
4432   while (music_file_info != NULL)
4433   {
4434     next = music_file_info->next;
4435
4436     checked_free(music_file_info->basename);
4437
4438     checked_free(music_file_info->title_header);
4439     checked_free(music_file_info->artist_header);
4440     checked_free(music_file_info->album_header);
4441     checked_free(music_file_info->year_header);
4442
4443     checked_free(music_file_info->title);
4444     checked_free(music_file_info->artist);
4445     checked_free(music_file_info->album);
4446     checked_free(music_file_info->year);
4447
4448     free(music_file_info);
4449
4450     music_file_info = next;
4451   }
4452
4453   new = &music_file_info;
4454
4455 #if 0
4456   printf("::: num_music == %d\n", num_music);
4457 #endif
4458
4459   for (i = 0; i < num_music; i++)
4460   {
4461     music = getMusicListEntry(i);
4462
4463 #if 0
4464     printf("::: %d [%08x]\n", i, music->filename);
4465 #endif
4466
4467     if (music->filename == NULL)
4468       continue;
4469
4470     if (strcmp(music->filename, UNDEFINED_FILENAME) == 0)
4471       continue;
4472
4473     /* a configured file may be not recognized as music */
4474     if (!FileIsMusic(music->filename))
4475       continue;
4476
4477 #if 0
4478     printf("::: -> '%s' (configured)\n", music->filename);
4479 #endif
4480
4481     if (!music_info_listed(music_file_info, music->filename))
4482     {
4483       *new = get_music_file_info(music->filename, i);
4484       if (*new != NULL)
4485         new = &(*new)->next;
4486     }
4487   }
4488
4489   if ((dir = opendir(music_directory)) == NULL)
4490   {
4491     Error(ERR_WARN, "cannot read music directory '%s'", music_directory);
4492     return;
4493   }
4494
4495   while ((dir_entry = readdir(dir)) != NULL)    /* loop until last dir entry */
4496   {
4497     char *basename = dir_entry->d_name;
4498     boolean music_already_used = FALSE;
4499     int i;
4500
4501     /* skip all music files that are configured in music config file */
4502     for (i = 0; i < num_music; i++)
4503     {
4504       music = getMusicListEntry(i);
4505
4506       if (music->filename == NULL)
4507         continue;
4508
4509       if (strcmp(basename, music->filename) == 0)
4510       {
4511         music_already_used = TRUE;
4512         break;
4513       }
4514     }
4515
4516     if (music_already_used)
4517       continue;
4518
4519     if (!FileIsMusic(basename))
4520       continue;
4521
4522 #if 0
4523     printf("::: -> '%s' (found in directory)\n", basename);
4524 #endif
4525
4526     if (!music_info_listed(music_file_info, basename))
4527     {
4528       *new = get_music_file_info(basename, MAP_NOCONF_MUSIC(num_music_noconf));
4529       if (*new != NULL)
4530         new = &(*new)->next;
4531     }
4532
4533     num_music_noconf++;
4534   }
4535
4536   closedir(dir);
4537
4538   for (i = 0; i < num_sounds; i++)
4539   {
4540     sound = getSoundListEntry(i);
4541
4542     if (sound->filename == NULL)
4543       continue;
4544
4545     if (strcmp(sound->filename, UNDEFINED_FILENAME) == 0)
4546       continue;
4547
4548     /* a configured file may be not recognized as sound */
4549     if (!FileIsSound(sound->filename))
4550       continue;
4551
4552 #if 0
4553     printf("::: -> '%s' (configured)\n", sound->filename);
4554 #endif
4555
4556     if (!sound_info_listed(music_file_info, sound->filename))
4557     {
4558       *new = get_sound_file_info(sound->filename, i);
4559       if (*new != NULL)
4560         new = &(*new)->next;
4561     }
4562   }
4563
4564 #if 0
4565   /* TEST-ONLY */
4566   for (next = music_file_info; next != NULL; next = next->next)
4567     printf("::: title == '%s'\n", next->title);
4568 #endif
4569 }
4570
4571 void add_helpanim_entry(int element, int action, int direction, int delay,
4572                         int *num_list_entries)
4573 {
4574   struct HelpAnimInfo *new_list_entry;
4575   (*num_list_entries)++;
4576
4577   helpanim_info =
4578     checked_realloc(helpanim_info,
4579                     *num_list_entries * sizeof(struct HelpAnimInfo));
4580   new_list_entry = &helpanim_info[*num_list_entries - 1];
4581
4582   new_list_entry->element = element;
4583   new_list_entry->action = action;
4584   new_list_entry->direction = direction;
4585   new_list_entry->delay = delay;
4586 }
4587
4588 void print_unknown_token(char *filename, char *token, int token_nr)
4589 {
4590   if (token_nr == 0)
4591   {
4592     Error(ERR_RETURN_LINE, "-");
4593     Error(ERR_RETURN, "warning: unknown token(s) found in config file:");
4594     Error(ERR_RETURN, "- config file: '%s'", filename);
4595   }
4596
4597   Error(ERR_RETURN, "- token: '%s'", token);
4598 }
4599
4600 void print_unknown_token_end(int token_nr)
4601 {
4602   if (token_nr > 0)
4603     Error(ERR_RETURN_LINE, "-");
4604 }
4605
4606 void LoadHelpAnimInfo()
4607 {
4608   char *filename = getHelpAnimFilename();
4609   SetupFileList *setup_file_list = NULL, *list;
4610   SetupFileHash *element_hash, *action_hash, *direction_hash;
4611   int num_list_entries = 0;
4612   int num_unknown_tokens = 0;
4613   int i;
4614
4615   if (fileExists(filename))
4616     setup_file_list = loadSetupFileList(filename);
4617
4618   if (setup_file_list == NULL)
4619   {
4620     /* use reliable default values from static configuration */
4621     SetupFileList *insert_ptr;
4622
4623     insert_ptr = setup_file_list =
4624       newSetupFileList(helpanim_config[0].token,
4625                        helpanim_config[0].value);
4626
4627     for (i = 1; helpanim_config[i].token; i++)
4628       insert_ptr = addListEntry(insert_ptr,
4629                                 helpanim_config[i].token,
4630                                 helpanim_config[i].value);
4631   }
4632
4633   element_hash   = newSetupFileHash();
4634   action_hash    = newSetupFileHash();
4635   direction_hash = newSetupFileHash();
4636
4637   for (i = 0; i < MAX_NUM_ELEMENTS; i++)
4638     setHashEntry(element_hash, element_info[i].token_name, i_to_a(i));
4639
4640   for (i = 0; i < NUM_ACTIONS; i++)
4641     setHashEntry(action_hash, element_action_info[i].suffix,
4642                  i_to_a(element_action_info[i].value));
4643
4644   /* do not store direction index (bit) here, but direction value! */
4645   for (i = 0; i < NUM_DIRECTIONS; i++)
4646     setHashEntry(direction_hash, element_direction_info[i].suffix,
4647                  i_to_a(1 << element_direction_info[i].value));
4648
4649   for (list = setup_file_list; list != NULL; list = list->next)
4650   {
4651     char *element_token, *action_token, *direction_token;
4652     char *element_value, *action_value, *direction_value;
4653     int delay = atoi(list->value);
4654
4655     if (strcmp(list->token, "end") == 0)
4656     {
4657       add_helpanim_entry(HELPANIM_LIST_NEXT, -1, -1, -1, &num_list_entries);
4658
4659       continue;
4660     }
4661
4662     /* first try to break element into element/action/direction parts;
4663        if this does not work, also accept combined "element[.act][.dir]"
4664        elements (like "dynamite.active"), which are unique elements */
4665
4666     if (strchr(list->token, '.') == NULL)       /* token contains no '.' */
4667     {
4668       element_value = getHashEntry(element_hash, list->token);
4669       if (element_value != NULL)        /* element found */
4670         add_helpanim_entry(atoi(element_value), -1, -1, delay,
4671                            &num_list_entries);
4672       else
4673       {
4674         /* no further suffixes found -- this is not an element */
4675         print_unknown_token(filename, list->token, num_unknown_tokens++);
4676       }
4677
4678       continue;
4679     }
4680
4681     /* token has format "<prefix>.<something>" */
4682
4683     action_token = strchr(list->token, '.');    /* suffix may be action ... */
4684     direction_token = action_token;             /* ... or direction */
4685
4686     element_token = getStringCopy(list->token);
4687     *strchr(element_token, '.') = '\0';
4688
4689     element_value = getHashEntry(element_hash, element_token);
4690
4691     if (element_value == NULL)          /* this is no element */
4692     {
4693       element_value = getHashEntry(element_hash, list->token);
4694       if (element_value != NULL)        /* combined element found */
4695         add_helpanim_entry(atoi(element_value), -1, -1, delay,
4696                            &num_list_entries);
4697       else
4698         print_unknown_token(filename, list->token, num_unknown_tokens++);
4699
4700       free(element_token);
4701
4702       continue;
4703     }
4704
4705     action_value = getHashEntry(action_hash, action_token);
4706
4707     if (action_value != NULL)           /* action found */
4708     {
4709       add_helpanim_entry(atoi(element_value), atoi(action_value), -1, delay,
4710                     &num_list_entries);
4711
4712       free(element_token);
4713
4714       continue;
4715     }
4716
4717     direction_value = getHashEntry(direction_hash, direction_token);
4718
4719     if (direction_value != NULL)        /* direction found */
4720     {
4721       add_helpanim_entry(atoi(element_value), -1, atoi(direction_value), delay,
4722                          &num_list_entries);
4723
4724       free(element_token);
4725
4726       continue;
4727     }
4728
4729     if (strchr(action_token + 1, '.') == NULL)
4730     {
4731       /* no further suffixes found -- this is not an action nor direction */
4732
4733       element_value = getHashEntry(element_hash, list->token);
4734       if (element_value != NULL)        /* combined element found */
4735         add_helpanim_entry(atoi(element_value), -1, -1, delay,
4736                            &num_list_entries);
4737       else
4738         print_unknown_token(filename, list->token, num_unknown_tokens++);
4739
4740       free(element_token);
4741
4742       continue;
4743     }
4744
4745     /* token has format "<prefix>.<suffix>.<something>" */
4746
4747     direction_token = strchr(action_token + 1, '.');
4748
4749     action_token = getStringCopy(action_token);
4750     *strchr(action_token + 1, '.') = '\0';
4751
4752     action_value = getHashEntry(action_hash, action_token);
4753
4754     if (action_value == NULL)           /* this is no action */
4755     {
4756       element_value = getHashEntry(element_hash, list->token);
4757       if (element_value != NULL)        /* combined element found */
4758         add_helpanim_entry(atoi(element_value), -1, -1, delay,
4759                            &num_list_entries);
4760       else
4761         print_unknown_token(filename, list->token, num_unknown_tokens++);
4762
4763       free(element_token);
4764       free(action_token);
4765
4766       continue;
4767     }
4768
4769     direction_value = getHashEntry(direction_hash, direction_token);
4770
4771     if (direction_value != NULL)        /* direction found */
4772     {
4773       add_helpanim_entry(atoi(element_value), atoi(action_value),
4774                          atoi(direction_value), delay, &num_list_entries);
4775
4776       free(element_token);
4777       free(action_token);
4778
4779       continue;
4780     }
4781
4782     /* this is no direction */
4783
4784     element_value = getHashEntry(element_hash, list->token);
4785     if (element_value != NULL)          /* combined element found */
4786       add_helpanim_entry(atoi(element_value), -1, -1, delay,
4787                          &num_list_entries);
4788     else
4789       print_unknown_token(filename, list->token, num_unknown_tokens++);
4790
4791     free(element_token);
4792     free(action_token);
4793   }
4794
4795   print_unknown_token_end(num_unknown_tokens);
4796
4797   add_helpanim_entry(HELPANIM_LIST_NEXT, -1, -1, -1, &num_list_entries);
4798   add_helpanim_entry(HELPANIM_LIST_END,  -1, -1, -1, &num_list_entries);
4799
4800   freeSetupFileList(setup_file_list);
4801   freeSetupFileHash(element_hash);
4802   freeSetupFileHash(action_hash);
4803   freeSetupFileHash(direction_hash);
4804
4805 #if 0
4806   /* TEST ONLY */
4807   for (i = 0; i < num_list_entries; i++)
4808     printf("::: %d, %d, %d => %d\n",
4809            helpanim_info[i].element,
4810            helpanim_info[i].action,
4811            helpanim_info[i].direction,
4812            helpanim_info[i].delay);
4813 #endif
4814 }
4815
4816 void LoadHelpTextInfo()
4817 {
4818   char *filename = getHelpTextFilename();
4819   int i;
4820
4821   if (helptext_info != NULL)
4822   {
4823     freeSetupFileHash(helptext_info);
4824     helptext_info = NULL;
4825   }
4826
4827   if (fileExists(filename))
4828     helptext_info = loadSetupFileHash(filename);
4829
4830   if (helptext_info == NULL)
4831   {
4832     /* use reliable default values from static configuration */
4833     helptext_info = newSetupFileHash();
4834
4835     for (i = 0; helptext_config[i].token; i++)
4836       setHashEntry(helptext_info,
4837                    helptext_config[i].token,
4838                    helptext_config[i].value);
4839   }
4840
4841 #if 0
4842   /* TEST ONLY */
4843   BEGIN_HASH_ITERATION(helptext_info, itr)
4844   {
4845     printf("::: '%s' => '%s'\n",
4846            HASH_ITERATION_TOKEN(itr), HASH_ITERATION_VALUE(itr));
4847   }
4848   END_HASH_ITERATION(hash, itr)
4849 #endif
4850 }
4851
4852
4853 /* ------------------------------------------------------------------------- *
4854  * convert levels
4855  * ------------------------------------------------------------------------- */
4856
4857 #define MAX_NUM_CONVERT_LEVELS          1000
4858
4859 void ConvertLevels()
4860 {
4861   static LevelDirTree *convert_leveldir = NULL;
4862   static int convert_level_nr = -1;
4863   static int num_levels_handled = 0;
4864   static int num_levels_converted = 0;
4865   static boolean levels_failed[MAX_NUM_CONVERT_LEVELS];
4866   int i;
4867
4868   convert_leveldir = getTreeInfoFromIdentifier(leveldir_first,
4869                                                global.convert_leveldir);
4870
4871   if (convert_leveldir == NULL)
4872     Error(ERR_EXIT, "no such level identifier: '%s'",
4873           global.convert_leveldir);
4874
4875   leveldir_current = convert_leveldir;
4876
4877   if (global.convert_level_nr != -1)
4878   {
4879     convert_leveldir->first_level = global.convert_level_nr;
4880     convert_leveldir->last_level  = global.convert_level_nr;
4881   }
4882
4883   convert_level_nr = convert_leveldir->first_level;
4884
4885   printf_line("=", 79);
4886   printf("Converting levels\n");
4887   printf_line("-", 79);
4888   printf("Level series identifier: '%s'\n", convert_leveldir->identifier);
4889   printf("Level series name:       '%s'\n", convert_leveldir->name);
4890   printf("Level series author:     '%s'\n", convert_leveldir->author);
4891   printf("Number of levels:        %d\n",   convert_leveldir->levels);
4892   printf_line("=", 79);
4893   printf("\n");
4894
4895   for (i = 0; i < MAX_NUM_CONVERT_LEVELS; i++)
4896     levels_failed[i] = FALSE;
4897
4898   while (convert_level_nr <= convert_leveldir->last_level)
4899   {
4900     char *level_filename;
4901     boolean new_level;
4902
4903     level_nr = convert_level_nr++;
4904
4905     printf("Level %03d: ", level_nr);
4906
4907     LoadLevel(level_nr);
4908     if (level.no_valid_file)
4909     {
4910       printf("(no level)\n");
4911       continue;
4912     }
4913
4914     printf("converting level ... ");
4915
4916     level_filename = getDefaultLevelFilename(level_nr);
4917     new_level = !fileExists(level_filename);
4918
4919     if (new_level)
4920     {
4921       SaveLevel(level_nr);
4922
4923       num_levels_converted++;
4924
4925       printf("converted.\n");
4926     }
4927     else
4928     {
4929       if (level_nr >= 0 && level_nr < MAX_NUM_CONVERT_LEVELS)
4930         levels_failed[level_nr] = TRUE;
4931
4932       printf("NOT CONVERTED -- LEVEL ALREADY EXISTS.\n");
4933     }
4934
4935     num_levels_handled++;
4936   }
4937
4938   printf("\n");
4939   printf_line("=", 79);
4940   printf("Number of levels handled: %d\n", num_levels_handled);
4941   printf("Number of levels converted: %d (%d%%)\n", num_levels_converted,
4942          (num_levels_handled ?
4943           num_levels_converted * 100 / num_levels_handled : 0));
4944   printf_line("-", 79);
4945   printf("Summary (for automatic parsing by scripts):\n");
4946   printf("LEVELDIR '%s', CONVERTED %d/%d (%d%%)",
4947          convert_leveldir->identifier, num_levels_converted,
4948          num_levels_handled,
4949          (num_levels_handled ?
4950           num_levels_converted * 100 / num_levels_handled : 0));
4951
4952   if (num_levels_handled != num_levels_converted)
4953   {
4954     printf(", FAILED:");
4955     for (i = 0; i < MAX_NUM_CONVERT_LEVELS; i++)
4956       if (levels_failed[i])
4957         printf(" %03d", i);
4958   }
4959
4960   printf("\n");
4961   printf_line("=", 79);
4962
4963   CloseAllAndExit(0);
4964 }