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