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