src/files.c

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