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