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