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   CopyNativeLevel_Native_to_RND(level);
2512 }
2513
2514 void LoadLevelFromFilename(struct LevelInfo *level, char *filename)
2515 {
2516   static struct LevelFileInfo level_file_info;
2517
2518   /* always start with reliable default values */
2519   setFileInfoToDefaults(&level_file_info);
2520
2521   level_file_info.nr = 0;                       /* unknown level number */
2522   level_file_info.type = LEVEL_FILE_TYPE_RND;   /* no others supported yet */
2523   level_file_info.filename = filename;
2524
2525   LoadLevelFromFileInfo(level, &level_file_info);
2526 }
2527
2528 static void LoadLevel_InitVersion(struct LevelInfo *level, char *filename)
2529 {
2530   if (leveldir_current == NULL)         /* only when dumping level */
2531     return;
2532
2533 #if 0
2534   printf("::: sort_priority: %d\n", leveldir_current->sort_priority);
2535 #endif
2536
2537   /* determine correct game engine version of current level */
2538 #if 1
2539   if (!leveldir_current->latest_engine)
2540 #else
2541   if (IS_LEVELCLASS_CONTRIB(leveldir_current) ||
2542       IS_LEVELCLASS_PRIVATE(leveldir_current) ||
2543       IS_LEVELCLASS_UNDEFINED(leveldir_current))
2544 #endif
2545   {
2546 #if 0
2547     printf("\n::: This level is private or contributed: '%s'\n", filename);
2548 #endif
2549
2550 #if 0
2551     printf("\n::: Use the stored game engine version for this level\n");
2552 #endif
2553
2554     /* For all levels which are not forced to use the latest game engine
2555        version (normally user contributed, private and undefined levels),
2556        use the version of the game engine the levels were created for.
2557
2558        Since 2.0.1, the game engine version is now directly stored
2559        in the level file (chunk "VERS"), so there is no need anymore
2560        to set the game version from the file version (except for old,
2561        pre-2.0 levels, where the game version is still taken from the
2562        file format version used to store the level -- see above). */
2563
2564 #if 1
2565     /* player was faster than enemies in 1.0.0 and before */
2566     if (level->file_version == FILE_VERSION_1_0)
2567       level->double_speed = TRUE;
2568 #else
2569     /* do some special adjustments to support older level versions */
2570     if (level->file_version == FILE_VERSION_1_0)
2571     {
2572       Error(ERR_WARN, "level file '%s' has version number 1.0", filename);
2573       Error(ERR_WARN, "using high speed movement for player");
2574
2575       /* player was faster than monsters in (pre-)1.0 levels */
2576       level->double_speed = TRUE;
2577     }
2578 #endif
2579
2580     /* default behaviour for EM style gems was "slippery" only in 2.0.1 */
2581     if (level->game_version == VERSION_IDENT(2,0,1,0))
2582       level->em_slippery_gems = TRUE;
2583
2584     /* springs could be pushed over pits before (pre-release version) 2.2.0 */
2585     if (level->game_version < VERSION_IDENT(2,2,0,0))
2586       level->use_spring_bug = TRUE;
2587
2588     /* only few elements were able to actively move into acid before 3.1.0 */
2589     if (level->game_version < VERSION_IDENT(3,1,0,0))
2590     {
2591       int i, j;
2592
2593       level->can_move_into_acid_bits = 0; /* nothing can move into acid */
2594       level->dont_collide_with_bits = 0; /* nothing is deadly when colliding */
2595
2596       setMoveIntoAcidProperty(level, EL_ROBOT,     TRUE);
2597       setMoveIntoAcidProperty(level, EL_SATELLITE, TRUE);
2598       setMoveIntoAcidProperty(level, EL_PENGUIN,   TRUE);
2599       setMoveIntoAcidProperty(level, EL_BALLOON,   TRUE);
2600
2601       for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2602         SET_PROPERTY(EL_CUSTOM_START + i, EP_CAN_MOVE_INTO_ACID, TRUE);
2603
2604       for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2605       {
2606         int element = EL_CUSTOM_START + i;
2607         struct ElementInfo *ei = &element_info[element];
2608
2609         for (j = 0; j < ei->num_change_pages; j++)
2610         {
2611           struct ElementChangeInfo *change = &ei->change_page[j];
2612
2613           change->trigger_player = CH_PLAYER_ANY;
2614           change->trigger_page = CH_PAGE_ANY;
2615         }
2616       }
2617     }
2618
2619 #if 1   /* USE_NEW_BLOCK_STYLE */
2620     /* blocking the last field when moving was corrected in version 3.1.1 */
2621     if (level->game_version < VERSION_IDENT(3,1,1,0))
2622     {
2623 #if 0
2624       printf("::: %d\n", level->block_last_field);
2625 #endif
2626
2627       /* even "not blocking" was blocking the last field for one frame */
2628       level->block_delay    = (level->block_last_field    ? 7 : 1);
2629       level->sp_block_delay = (level->sp_block_last_field ? 7 : 1);
2630
2631       level->block_last_field = TRUE;
2632       level->sp_block_last_field = TRUE;
2633     }
2634 #endif
2635   }
2636   else          /* always use the latest game engine version */
2637   {
2638 #if 0
2639     printf("\n::: ALWAYS USE LATEST ENGINE FOR THIS LEVEL: [%d] '%s'\n",
2640            leveldir_current->sort_priority, filename);
2641 #endif
2642
2643 #if 0
2644     printf("\n::: Use latest game engine version for this level.\n");
2645 #endif
2646
2647     /* For all levels which are forced to use the latest game engine version
2648        (normally all but user contributed, private and undefined levels), set
2649        the game engine version to the actual version; this allows for actual
2650        corrections in the game engine to take effect for existing, converted
2651        levels (from "classic" or other existing games) to make the emulation
2652        of the corresponding game more accurate, while (hopefully) not breaking
2653        existing levels created from other players. */
2654
2655 #if 0
2656     printf("::: changing engine from %d to %d\n",
2657            level->game_version, GAME_VERSION_ACTUAL);
2658 #endif
2659
2660     level->game_version = GAME_VERSION_ACTUAL;
2661
2662     /* Set special EM style gems behaviour: EM style gems slip down from
2663        normal, steel and growing wall. As this is a more fundamental change,
2664        it seems better to set the default behaviour to "off" (as it is more
2665        natural) and make it configurable in the level editor (as a property
2666        of gem style elements). Already existing converted levels (neither
2667        private nor contributed levels) are changed to the new behaviour. */
2668
2669     if (level->file_version < FILE_VERSION_2_0)
2670       level->em_slippery_gems = TRUE;
2671   }
2672
2673 #if 0
2674   printf("::: => %d\n", level->game_version);
2675 #endif
2676 }
2677
2678 static void LoadLevel_InitElements(struct LevelInfo *level, char *filename)
2679 {
2680   int i, j, x, y;
2681
2682   /* map custom element change events that have changed in newer versions
2683      (these following values were accidentally changed in version 3.0.1) */
2684   if (level->game_version <= VERSION_IDENT(3,0,0,0))
2685   {
2686     for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2687     {
2688       int element = EL_CUSTOM_START + i;
2689
2690       /* order of checking and copying events to be mapped is important */
2691       for (j = CE_BY_OTHER_ACTION; j >= CE_BY_PLAYER_OBSOLETE; j--)
2692       {
2693         if (HAS_CHANGE_EVENT(element, j - 2))
2694         {
2695           SET_CHANGE_EVENT(element, j - 2, FALSE);
2696           SET_CHANGE_EVENT(element, j, TRUE);
2697         }
2698       }
2699
2700       /* order of checking and copying events to be mapped is important */
2701       for (j = CE_OTHER_GETS_COLLECTED; j >= CE_HITTING_SOMETHING; j--)
2702       {
2703         if (HAS_CHANGE_EVENT(element, j - 1))
2704         {
2705           SET_CHANGE_EVENT(element, j - 1, FALSE);
2706           SET_CHANGE_EVENT(element, j, TRUE);
2707         }
2708       }
2709     }
2710   }
2711
2712   /* some custom element change events get mapped since version 3.0.3 */
2713   for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2714   {
2715     int element = EL_CUSTOM_START + i;
2716
2717     if (HAS_CHANGE_EVENT(element, CE_BY_PLAYER_OBSOLETE) ||
2718         HAS_CHANGE_EVENT(element, CE_BY_COLLISION_OBSOLETE))
2719     {
2720       SET_CHANGE_EVENT(element, CE_BY_PLAYER_OBSOLETE, FALSE);
2721       SET_CHANGE_EVENT(element, CE_BY_COLLISION_OBSOLETE, FALSE);
2722
2723       SET_CHANGE_EVENT(element, CE_BY_DIRECT_ACTION, TRUE);
2724     }
2725   }
2726
2727   /* initialize "can_change" field for old levels with only one change page */
2728   if (level->game_version <= VERSION_IDENT(3,0,2,0))
2729   {
2730     for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2731     {
2732       int element = EL_CUSTOM_START + i;
2733
2734       if (CAN_CHANGE(element))
2735         element_info[element].change->can_change = TRUE;
2736     }
2737   }
2738
2739   /* correct custom element values (for old levels without these options) */
2740   for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2741   {
2742     int element = EL_CUSTOM_START + i;
2743     struct ElementInfo *ei = &element_info[element];
2744
2745     if (ei->access_direction == MV_NO_MOVING)
2746       ei->access_direction = MV_ALL_DIRECTIONS;
2747
2748     for (j = 0; j < ei->num_change_pages; j++)
2749     {
2750       struct ElementChangeInfo *change = &ei->change_page[j];
2751
2752       if (change->trigger_side == CH_SIDE_NONE)
2753         change->trigger_side = CH_SIDE_ANY;
2754     }
2755   }
2756
2757   /* initialize "can_explode" field for old levels which did not store this */
2758   /* !!! CHECK THIS -- "<= 3,1,0,0" IS PROBABLY WRONG !!! */
2759   if (level->game_version <= VERSION_IDENT(3,1,0,0))
2760   {
2761     for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2762     {
2763       int element = EL_CUSTOM_START + i;
2764
2765       if (EXPLODES_1X1_OLD(element))
2766         element_info[element].explosion_type = EXPLODES_1X1;
2767
2768       SET_PROPERTY(element, EP_CAN_EXPLODE, (EXPLODES_BY_FIRE(element) ||
2769                                              EXPLODES_SMASHED(element) ||
2770                                              EXPLODES_IMPACT(element)));
2771     }
2772   }
2773
2774   /* correct previously hard-coded move delay values for maze runner style */
2775   if (level->game_version < VERSION_IDENT(3,1,1,0))
2776   {
2777     for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2778     {
2779       int element = EL_CUSTOM_START + i;
2780
2781       if (element_info[element].move_pattern & MV_MAZE_RUNNER_STYLE)
2782       {
2783         /* previously hard-coded and therefore ignored */
2784         element_info[element].move_delay_fixed = 9;
2785         element_info[element].move_delay_random = 0;
2786       }
2787     }
2788   }
2789
2790 #if 0
2791   /* set default push delay values (corrected since version 3.0.7-1) */
2792   if (level->game_version < VERSION_IDENT(3,0,7,1))
2793   {
2794     game.default_push_delay_fixed = 2;
2795     game.default_push_delay_random = 8;
2796   }
2797   else
2798   {
2799     game.default_push_delay_fixed = 8;
2800     game.default_push_delay_random = 8;
2801   }
2802
2803   /* set uninitialized push delay values of custom elements in older levels */
2804   for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2805   {
2806     int element = EL_CUSTOM_START + i;
2807
2808     if (element_info[element].push_delay_fixed == -1)
2809       element_info[element].push_delay_fixed = game.default_push_delay_fixed;
2810     if (element_info[element].push_delay_random == -1)
2811       element_info[element].push_delay_random = game.default_push_delay_random;
2812   }
2813 #endif
2814
2815   /* map elements that have changed in newer versions */
2816   level->amoeba_content = getMappedElementByVersion(level->amoeba_content,
2817                                                     level->game_version);
2818   for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
2819     for (x = 0; x < 3; x++)
2820       for (y = 0; y < 3; y++)
2821         level->yamyam_content[i][x][y] =
2822           getMappedElementByVersion(level->yamyam_content[i][x][y],
2823                                     level->game_version);
2824
2825   /* initialize element properties for level editor etc. */
2826   InitElementPropertiesEngine(level->game_version);
2827 }
2828
2829 static void LoadLevel_InitPlayfield(struct LevelInfo *level, char *filename)
2830 {
2831   int x, y;
2832
2833   /* map elements that have changed in newer versions */
2834   for (y = 0; y < level->fieldy; y++)
2835   {
2836     for (x = 0; x < level->fieldx; x++)
2837     {
2838       int element = level->field[x][y];
2839
2840 #if 1
2841       element = getMappedElementByVersion(element, level->game_version);
2842 #else
2843       if (level->game_version <= VERSION_IDENT(2,2,0,0))
2844       {
2845         /* map game font elements */
2846         element = (element == EL_CHAR('[')  ? EL_CHAR_AUMLAUT :
2847                    element == EL_CHAR('\\') ? EL_CHAR_OUMLAUT :
2848                    element == EL_CHAR(']')  ? EL_CHAR_UUMLAUT :
2849                    element == EL_CHAR('^')  ? EL_CHAR_COPYRIGHT : element);
2850       }
2851
2852       if (level->game_version < VERSION_IDENT(3,0,0,0))
2853       {
2854         /* map Supaplex gravity tube elements */
2855         element = (element == EL_SP_GRAVITY_PORT_LEFT  ? EL_SP_PORT_LEFT  :
2856                    element == EL_SP_GRAVITY_PORT_RIGHT ? EL_SP_PORT_RIGHT :
2857                    element == EL_SP_GRAVITY_PORT_UP    ? EL_SP_PORT_UP    :
2858                    element == EL_SP_GRAVITY_PORT_DOWN  ? EL_SP_PORT_DOWN  :
2859                    element);
2860       }
2861 #endif
2862
2863       level->field[x][y] = element;
2864     }
2865   }
2866
2867   /* copy elements to runtime playfield array */
2868   for (x = 0; x < MAX_LEV_FIELDX; x++)
2869     for (y = 0; y < MAX_LEV_FIELDY; y++)
2870       Feld[x][y] = level->field[x][y];
2871
2872   /* initialize level size variables for faster access */
2873   lev_fieldx = level->fieldx;
2874   lev_fieldy = level->fieldy;
2875
2876   /* determine border element for this level */
2877   SetBorderElement();
2878 }
2879
2880 void LoadLevelTemplate(int nr)
2881 {
2882 #if 1
2883   char *filename;
2884
2885   setLevelFileInfo(&level_template.file_info, nr);
2886   filename = level_template.file_info.filename;
2887
2888   LoadLevelFromFileInfo(&level_template, &level_template.file_info);
2889
2890 #else
2891
2892 #if 1
2893   struct LevelFileInfo *level_file_info = getLevelFileInfo(nr);
2894   char *filename = level_file_info->filename;
2895
2896   LoadLevelFromFileInfo(&level_template, level_file_info);
2897 #else
2898   char *filename = getDefaultLevelFilename(nr);
2899
2900   LoadLevelFromFilename_RND(&level_template, filename);
2901 #endif
2902 #endif
2903
2904 #if 1
2905   LoadLevel_InitVersion(&level_template, filename);
2906   LoadLevel_InitElements(&level_template, filename);
2907 #else
2908   LoadLevel_InitVersion(&level, filename);
2909   LoadLevel_InitElements(&level, filename);
2910 #endif
2911
2912   ActivateLevelTemplate();
2913 }
2914
2915 void LoadLevel(int nr)
2916 {
2917 #if 1
2918   char *filename;
2919
2920   setLevelFileInfo(&level.file_info, nr);
2921   filename = level.file_info.filename;
2922
2923   LoadLevelFromFileInfo(&level, &level.file_info);
2924
2925 #else
2926
2927 #if 1
2928   struct LevelFileInfo *level_file_info = getLevelFileInfo(nr);
2929   char *filename = level_file_info->filename;
2930
2931   LoadLevelFromFileInfo(&level, level_file_info);
2932 #else
2933   char *filename = getLevelFilename(nr);
2934
2935   LoadLevelFromFilename_RND(&level, filename);
2936 #endif
2937 #endif
2938
2939   if (level.use_custom_template)
2940     LoadLevelTemplate(-1);
2941
2942 #if 1
2943   LoadLevel_InitVersion(&level, filename);
2944   LoadLevel_InitElements(&level, filename);
2945   LoadLevel_InitPlayfield(&level, filename);
2946 #else
2947   LoadLevel_InitLevel(&level, filename);
2948 #endif
2949 }
2950
2951 static void SaveLevel_VERS(FILE *file, struct LevelInfo *level)
2952 {
2953   putFileVersion(file, level->file_version);
2954   putFileVersion(file, level->game_version);
2955 }
2956
2957 static void SaveLevel_HEAD(FILE *file, struct LevelInfo *level)
2958 {
2959   int i, x, y;
2960
2961   putFile8Bit(file, level->fieldx);
2962   putFile8Bit(file, level->fieldy);
2963
2964   putFile16BitBE(file, level->time);
2965   putFile16BitBE(file, level->gems_needed);
2966
2967   for (i = 0; i < MAX_LEVEL_NAME_LEN; i++)
2968     putFile8Bit(file, level->name[i]);
2969
2970   for (i = 0; i < LEVEL_SCORE_ELEMENTS; i++)
2971     putFile8Bit(file, level->score[i]);
2972
2973   for (i = 0; i < STD_ELEMENT_CONTENTS; i++)
2974     for (y = 0; y < 3; y++)
2975       for (x = 0; x < 3; x++)
2976         putFile8Bit(file, (level->encoding_16bit_yamyam ? EL_EMPTY :
2977                            level->yamyam_content[i][x][y]));
2978   putFile8Bit(file, level->amoeba_speed);
2979   putFile8Bit(file, level->time_magic_wall);
2980   putFile8Bit(file, level->time_wheel);
2981   putFile8Bit(file, (level->encoding_16bit_amoeba ? EL_EMPTY :
2982                      level->amoeba_content));
2983   putFile8Bit(file, (level->double_speed ? 1 : 0));
2984   putFile8Bit(file, (level->initial_gravity ? 1 : 0));
2985   putFile8Bit(file, (level->encoding_16bit_field ? 1 : 0));
2986   putFile8Bit(file, (level->em_slippery_gems ? 1 : 0));
2987
2988   putFile8Bit(file, (level->use_custom_template ? 1 : 0));
2989
2990   putFile8Bit(file, (level->block_last_field ? 1 : 0));
2991   putFile8Bit(file, (level->sp_block_last_field ? 1 : 0));
2992   putFile32BitBE(file, level->can_move_into_acid_bits);
2993   putFile8Bit(file, level->dont_collide_with_bits);
2994
2995   putFile8Bit(file, (level->use_spring_bug ? 1 : 0));
2996   putFile8Bit(file, (level->use_step_counter ? 1 : 0));
2997
2998   putFile8Bit(file, (level->instant_relocation ? 1 : 0));
2999   putFile8Bit(file, (level->can_pass_to_walkable ? 1 : 0));
3000   putFile8Bit(file, (level->grow_into_diggable ? 1 : 0));
3001
3002   putFile8Bit(file, level->game_engine_type);
3003
3004   WriteUnusedBytesToFile(file, LEVEL_HEADER_UNUSED);
3005 }
3006
3007 static void SaveLevel_AUTH(FILE *file, struct LevelInfo *level)
3008 {
3009   int i;
3010
3011   for (i = 0; i < MAX_LEVEL_AUTHOR_LEN; i++)
3012     putFile8Bit(file, level->author[i]);
3013 }
3014
3015 static void SaveLevel_BODY(FILE *file, struct LevelInfo *level)
3016 {
3017   int x, y;
3018
3019   for (y = 0; y < level->fieldy; y++)
3020     for (x = 0; x < level->fieldx; x++)
3021       if (level->encoding_16bit_field)
3022         putFile16BitBE(file, level->field[x][y]);
3023       else
3024         putFile8Bit(file, level->field[x][y]);
3025 }
3026
3027 #if 0
3028 static void SaveLevel_CONT(FILE *file, struct LevelInfo *level)
3029 {
3030   int i, x, y;
3031
3032   putFile8Bit(file, EL_YAMYAM);
3033   putFile8Bit(file, level->num_yamyam_contents);
3034   putFile8Bit(file, 0);
3035   putFile8Bit(file, 0);
3036
3037   for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
3038     for (y = 0; y < 3; y++)
3039       for (x = 0; x < 3; x++)
3040         if (level->encoding_16bit_field)
3041           putFile16BitBE(file, level->yamyam_content[i][x][y]);
3042         else
3043           putFile8Bit(file, level->yamyam_content[i][x][y]);
3044 }
3045 #endif
3046
3047 static void SaveLevel_CNT2(FILE *file, struct LevelInfo *level, int element)
3048 {
3049   int i, x, y;
3050   int num_contents, content_xsize, content_ysize;
3051   int content_array[MAX_ELEMENT_CONTENTS][3][3];
3052
3053   if (element == EL_YAMYAM)
3054   {
3055     num_contents = level->num_yamyam_contents;
3056     content_xsize = 3;
3057     content_ysize = 3;
3058
3059     for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
3060       for (y = 0; y < 3; y++)
3061         for (x = 0; x < 3; x++)
3062           content_array[i][x][y] = level->yamyam_content[i][x][y];
3063   }
3064   else if (element == EL_BD_AMOEBA)
3065   {
3066     num_contents = 1;
3067     content_xsize = 1;
3068     content_ysize = 1;
3069
3070     for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
3071       for (y = 0; y < 3; y++)
3072         for (x = 0; x < 3; x++)
3073           content_array[i][x][y] = EL_EMPTY;
3074     content_array[0][0][0] = level->amoeba_content;
3075   }
3076   else
3077   {
3078     /* chunk header already written -- write empty chunk data */
3079     WriteUnusedBytesToFile(file, LEVEL_CHUNK_CNT2_SIZE);
3080
3081     Error(ERR_WARN, "cannot save content for element '%d'", element);
3082     return;
3083   }
3084
3085   putFile16BitBE(file, element);
3086   putFile8Bit(file, num_contents);
3087   putFile8Bit(file, content_xsize);
3088   putFile8Bit(file, content_ysize);
3089
3090   WriteUnusedBytesToFile(file, LEVEL_CHUNK_CNT2_UNUSED);
3091
3092   for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
3093     for (y = 0; y < 3; y++)
3094       for (x = 0; x < 3; x++)
3095         putFile16BitBE(file, content_array[i][x][y]);
3096 }
3097
3098 static void SaveLevel_CNT3(FILE *file, struct LevelInfo *level, int element)
3099 {
3100   int i;
3101   int envelope_nr = element - EL_ENVELOPE_1;
3102   int envelope_len = strlen(level->envelope_text[envelope_nr]) + 1;
3103
3104   putFile16BitBE(file, element);
3105   putFile16BitBE(file, envelope_len);
3106   putFile8Bit(file, level->envelope_xsize[envelope_nr]);
3107   putFile8Bit(file, level->envelope_ysize[envelope_nr]);
3108
3109   WriteUnusedBytesToFile(file, LEVEL_CHUNK_CNT3_UNUSED);
3110
3111   for (i = 0; i < envelope_len; i++)
3112     putFile8Bit(file, level->envelope_text[envelope_nr][i]);
3113 }
3114
3115 #if 0
3116 static void SaveLevel_CUS1(FILE *file, struct LevelInfo *level,
3117                            int num_changed_custom_elements)
3118 {
3119   int i, check = 0;
3120
3121   putFile16BitBE(file, num_changed_custom_elements);
3122
3123   for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
3124   {
3125     int element = EL_CUSTOM_START + i;
3126
3127     if (Properties[element][EP_BITFIELD_BASE] != EP_BITMASK_DEFAULT)
3128     {
3129       if (check < num_changed_custom_elements)
3130       {
3131         putFile16BitBE(file, element);
3132         putFile32BitBE(file, Properties[element][EP_BITFIELD_BASE]);
3133       }
3134
3135       check++;
3136     }
3137   }
3138
3139   if (check != num_changed_custom_elements)     /* should not happen */
3140     Error(ERR_WARN, "inconsistent number of custom element properties");
3141 }
3142 #endif
3143
3144 #if 0
3145 static void SaveLevel_CUS2(FILE *file, struct LevelInfo *level,
3146                            int num_changed_custom_elements)
3147 {
3148   int i, check = 0;
3149
3150   putFile16BitBE(file, num_changed_custom_elements);
3151
3152   for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
3153   {
3154     int element = EL_CUSTOM_START + i;
3155
3156     if (element_info[element].change->target_element != EL_EMPTY_SPACE)
3157     {
3158       if (check < num_changed_custom_elements)
3159       {
3160         putFile16BitBE(file, element);
3161         putFile16BitBE(file, element_info[element].change->target_element);
3162       }
3163
3164       check++;
3165     }
3166   }
3167
3168   if (check != num_changed_custom_elements)     /* should not happen */
3169     Error(ERR_WARN, "inconsistent number of custom target elements");
3170 }
3171 #endif
3172
3173 #if 0
3174 static void SaveLevel_CUS3(FILE *file, struct LevelInfo *level,
3175                            int num_changed_custom_elements)
3176 {
3177   int i, j, x, y, check = 0;
3178
3179   putFile16BitBE(file, num_changed_custom_elements);
3180
3181   for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
3182   {
3183     int element = EL_CUSTOM_START + i;
3184
3185     if (element_info[element].modified_settings)
3186     {
3187       if (check < num_changed_custom_elements)
3188       {
3189         putFile16BitBE(file, element);
3190
3191         for (j = 0; j < MAX_ELEMENT_NAME_LEN; j++)
3192           putFile8Bit(file, element_info[element].description[j]);
3193
3194         putFile32BitBE(file, Properties[element][EP_BITFIELD_BASE]);
3195
3196         /* some free bytes for future properties and padding */
3197         WriteUnusedBytesToFile(file, 7);
3198
3199         putFile8Bit(file, element_info[element].use_gfx_element);
3200         putFile16BitBE(file, element_info[element].gfx_element);
3201
3202         putFile8Bit(file, element_info[element].collect_score);
3203         putFile8Bit(file, element_info[element].collect_count);
3204
3205         putFile16BitBE(file, element_info[element].push_delay_fixed);
3206         putFile16BitBE(file, element_info[element].push_delay_random);
3207         putFile16BitBE(file, element_info[element].move_delay_fixed);
3208         putFile16BitBE(file, element_info[element].move_delay_random);
3209
3210         putFile16BitBE(file, element_info[element].move_pattern);
3211         putFile8Bit(file, element_info[element].move_direction_initial);
3212         putFile8Bit(file, element_info[element].move_stepsize);
3213
3214         for (y = 0; y < 3; y++)
3215           for (x = 0; x < 3; x++)
3216             putFile16BitBE(file, element_info[element].content[x][y]);
3217
3218         putFile32BitBE(file, element_info[element].change->events);
3219
3220         putFile16BitBE(file, element_info[element].change->target_element);
3221
3222         putFile16BitBE(file, element_info[element].change->delay_fixed);
3223         putFile16BitBE(file, element_info[element].change->delay_random);
3224         putFile16BitBE(file, element_info[element].change->delay_frames);
3225
3226         putFile16BitBE(file, element_info[element].change->trigger_element);
3227
3228         putFile8Bit(file, element_info[element].change->explode);
3229         putFile8Bit(file, element_info[element].change->use_target_content);
3230         putFile8Bit(file, element_info[element].change->only_if_complete);
3231         putFile8Bit(file, element_info[element].change->use_random_replace);
3232
3233         putFile8Bit(file, element_info[element].change->random_percentage);
3234         putFile8Bit(file, element_info[element].change->replace_when);
3235
3236         for (y = 0; y < 3; y++)
3237           for (x = 0; x < 3; x++)
3238             putFile16BitBE(file, element_info[element].change->content[x][y]);
3239
3240         putFile8Bit(file, element_info[element].slippery_type);
3241
3242         /* some free bytes for future properties and padding */
3243         WriteUnusedBytesToFile(file, LEVEL_CPART_CUS3_UNUSED);
3244       }
3245
3246       check++;
3247     }
3248   }
3249
3250   if (check != num_changed_custom_elements)     /* should not happen */
3251     Error(ERR_WARN, "inconsistent number of custom element properties");
3252 }
3253 #endif
3254
3255 static void SaveLevel_CUS4(FILE *file, struct LevelInfo *level, int element)
3256 {
3257   struct ElementInfo *ei = &element_info[element];
3258   int i, x, y;
3259
3260   putFile16BitBE(file, element);
3261
3262   for (i = 0; i < MAX_ELEMENT_NAME_LEN; i++)
3263     putFile8Bit(file, ei->description[i]);
3264
3265   putFile32BitBE(file, Properties[element][EP_BITFIELD_BASE]);
3266   WriteUnusedBytesToFile(file, 4);      /* reserved for more base properties */
3267
3268   putFile8Bit(file, ei->num_change_pages);
3269
3270   /* some free bytes for future base property values and padding */
3271   WriteUnusedBytesToFile(file, 5);
3272
3273   /* write custom property values */
3274
3275   putFile8Bit(file, ei->use_gfx_element);
3276   putFile16BitBE(file, ei->gfx_element);
3277
3278   putFile8Bit(file, ei->collect_score);
3279   putFile8Bit(file, ei->collect_count);
3280
3281   putFile8Bit(file, ei->drop_delay_fixed);
3282   putFile8Bit(file, ei->push_delay_fixed);
3283   putFile8Bit(file, ei->drop_delay_random);
3284   putFile8Bit(file, ei->push_delay_random);
3285   putFile16BitBE(file, ei->move_delay_fixed);
3286   putFile16BitBE(file, ei->move_delay_random);
3287
3288   /* bits 0 - 15 of "move_pattern" ... */
3289   putFile16BitBE(file, ei->move_pattern & 0xffff);
3290   putFile8Bit(file, ei->move_direction_initial);
3291   putFile8Bit(file, ei->move_stepsize);
3292
3293   putFile8Bit(file, ei->slippery_type);
3294
3295   for (y = 0; y < 3; y++)
3296     for (x = 0; x < 3; x++)
3297       putFile16BitBE(file, ei->content[x][y]);
3298
3299   putFile16BitBE(file, ei->move_enter_element);
3300   putFile16BitBE(file, ei->move_leave_element);
3301   putFile8Bit(file, ei->move_leave_type);
3302
3303   /* ... bits 16 - 31 of "move_pattern" (not nice, but downward compatible) */
3304   putFile16BitBE(file, (ei->move_pattern >> 16) & 0xffff);
3305
3306   putFile8Bit(file, ei->access_direction);
3307
3308   putFile8Bit(file, ei->explosion_delay);
3309   putFile8Bit(file, ei->ignition_delay);
3310   putFile8Bit(file, ei->explosion_type);
3311
3312   /* some free bytes for future custom property values and padding */
3313   WriteUnusedBytesToFile(file, 1);
3314
3315   /* write change property values */
3316
3317   for (i = 0; i < ei->num_change_pages; i++)
3318   {
3319     struct ElementChangeInfo *change = &ei->change_page[i];
3320
3321     putFile32BitBE(file, change->events);
3322
3323     putFile16BitBE(file, change->target_element);
3324
3325     putFile16BitBE(file, change->delay_fixed);
3326     putFile16BitBE(file, change->delay_random);
3327     putFile16BitBE(file, change->delay_frames);
3328
3329     putFile16BitBE(file, change->trigger_element);
3330
3331     putFile8Bit(file, change->explode);
3332     putFile8Bit(file, change->use_target_content);
3333     putFile8Bit(file, change->only_if_complete);
3334     putFile8Bit(file, change->use_random_replace);
3335
3336     putFile8Bit(file, change->random_percentage);
3337     putFile8Bit(file, change->replace_when);
3338
3339     for (y = 0; y < 3; y++)
3340       for (x = 0; x < 3; x++)
3341         putFile16BitBE(file, change->target_content[x][y]);
3342
3343     putFile8Bit(file, change->can_change);
3344
3345     putFile8Bit(file, change->trigger_side);
3346
3347 #if 1
3348     putFile8Bit(file, change->trigger_player);
3349     putFile8Bit(file, (change->trigger_page == CH_PAGE_ANY ? CH_PAGE_ANY_FILE :
3350                        log_2(change->trigger_page)));
3351
3352     /* some free bytes for future change property values and padding */
3353     WriteUnusedBytesToFile(file, 6);
3354
3355 #else
3356
3357     /* some free bytes for future change property values and padding */
3358     WriteUnusedBytesToFile(file, 8);
3359 #endif
3360   }
3361 }
3362
3363 static void SaveLevel_GRP1(FILE *file, struct LevelInfo *level, int element)
3364 {
3365   struct ElementInfo *ei = &element_info[element];
3366   struct ElementGroupInfo *group = ei->group;
3367   int i;
3368
3369   putFile16BitBE(file, element);
3370
3371   for (i = 0; i < MAX_ELEMENT_NAME_LEN; i++)
3372     putFile8Bit(file, ei->description[i]);
3373
3374   putFile8Bit(file, group->num_elements);
3375
3376   putFile8Bit(file, ei->use_gfx_element);
3377   putFile16BitBE(file, ei->gfx_element);
3378
3379   putFile8Bit(file, group->choice_mode);
3380
3381   /* some free bytes for future values and padding */
3382   WriteUnusedBytesToFile(file, 3);
3383
3384   for (i = 0; i < MAX_ELEMENTS_IN_GROUP; i++)
3385     putFile16BitBE(file, group->element[i]);
3386 }
3387
3388 static void SaveLevelFromFilename(struct LevelInfo *level, char *filename)
3389 {
3390   int body_chunk_size;
3391   int i, x, y;
3392   FILE *file;
3393
3394   if (!(file = fopen(filename, MODE_WRITE)))
3395   {
3396     Error(ERR_WARN, "cannot save level file '%s'", filename);
3397     return;
3398   }
3399
3400   level->file_version = FILE_VERSION_ACTUAL;
3401   level->game_version = GAME_VERSION_ACTUAL;
3402
3403   /* check level field for 16-bit elements */
3404   level->encoding_16bit_field = FALSE;
3405   for (y = 0; y < level->fieldy; y++)
3406     for (x = 0; x < level->fieldx; x++)
3407       if (level->field[x][y] > 255)
3408         level->encoding_16bit_field = TRUE;
3409
3410   /* check yamyam content for 16-bit elements */
3411   level->encoding_16bit_yamyam = FALSE;
3412   for (i = 0; i < level->num_yamyam_contents; i++)
3413     for (y = 0; y < 3; y++)
3414       for (x = 0; x < 3; x++)
3415         if (level->yamyam_content[i][x][y] > 255)
3416           level->encoding_16bit_yamyam = TRUE;
3417
3418   /* check amoeba content for 16-bit elements */
3419   level->encoding_16bit_amoeba = FALSE;
3420   if (level->amoeba_content > 255)
3421     level->encoding_16bit_amoeba = TRUE;
3422
3423   /* calculate size of "BODY" chunk */
3424   body_chunk_size =
3425     level->fieldx * level->fieldy * (level->encoding_16bit_field ? 2 : 1);
3426
3427   putFileChunkBE(file, "RND1", CHUNK_SIZE_UNDEFINED);
3428   putFileChunkBE(file, "CAVE", CHUNK_SIZE_NONE);
3429
3430   putFileChunkBE(file, "VERS", FILE_VERS_CHUNK_SIZE);
3431   SaveLevel_VERS(file, level);
3432
3433   putFileChunkBE(file, "HEAD", LEVEL_HEADER_SIZE);
3434   SaveLevel_HEAD(file, level);
3435
3436   putFileChunkBE(file, "AUTH", MAX_LEVEL_AUTHOR_LEN);
3437   SaveLevel_AUTH(file, level);
3438
3439   putFileChunkBE(file, "BODY", body_chunk_size);
3440   SaveLevel_BODY(file, level);
3441
3442   if (level->encoding_16bit_yamyam ||
3443       level->num_yamyam_contents != STD_ELEMENT_CONTENTS)
3444   {
3445     putFileChunkBE(file, "CNT2", LEVEL_CHUNK_CNT2_SIZE);
3446     SaveLevel_CNT2(file, level, EL_YAMYAM);
3447   }
3448
3449   if (level->encoding_16bit_amoeba)
3450   {
3451     putFileChunkBE(file, "CNT2", LEVEL_CHUNK_CNT2_SIZE);
3452     SaveLevel_CNT2(file, level, EL_BD_AMOEBA);
3453   }
3454
3455   /* check for envelope content */
3456   for (i = 0; i < 4; i++)
3457   {
3458     if (strlen(level->envelope_text[i]) > 0)
3459     {
3460       int envelope_len = strlen(level->envelope_text[i]) + 1;
3461
3462       putFileChunkBE(file, "CNT3", LEVEL_CHUNK_CNT3_SIZE(envelope_len));
3463       SaveLevel_CNT3(file, level, EL_ENVELOPE_1 + i);
3464     }
3465   }
3466
3467   /* check for non-default custom elements (unless using template level) */
3468   if (!level->use_custom_template)
3469   {
3470     for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
3471     {
3472       int element = EL_CUSTOM_START + i;
3473
3474       if (element_info[element].modified_settings)
3475       {
3476         int num_change_pages = element_info[element].num_change_pages;
3477
3478         putFileChunkBE(file, "CUS4", LEVEL_CHUNK_CUS4_SIZE(num_change_pages));
3479         SaveLevel_CUS4(file, level, element);
3480       }
3481     }
3482   }
3483
3484   /* check for non-default group elements (unless using template level) */
3485   if (!level->use_custom_template)
3486   {
3487     for (i = 0; i < NUM_GROUP_ELEMENTS; i++)
3488     {
3489       int element = EL_GROUP_START + i;
3490
3491       if (element_info[element].modified_settings)
3492       {
3493         putFileChunkBE(file, "GRP1", LEVEL_CHUNK_GRP1_SIZE);
3494         SaveLevel_GRP1(file, level, element);
3495       }
3496     }
3497   }
3498
3499   fclose(file);
3500
3501   SetFilePermissions(filename, PERMS_PRIVATE);
3502 }
3503
3504 void SaveLevel(int nr)
3505 {
3506   char *filename = getDefaultLevelFilename(nr);
3507
3508   SaveLevelFromFilename(&level, filename);
3509 }
3510
3511 void SaveLevelTemplate()
3512 {
3513   char *filename = getDefaultLevelFilename(-1);
3514
3515   SaveLevelFromFilename(&level, filename);
3516 }
3517
3518 void DumpLevel(struct LevelInfo *level)
3519 {
3520   if (level->no_valid_file)
3521   {
3522     Error(ERR_WARN, "cannot dump -- no valid level file found");
3523
3524     return;
3525   }
3526
3527   printf_line("-", 79);
3528   printf("Level xxx (file version %08d, game version %08d)\n",
3529          level->file_version, level->game_version);
3530   printf_line("-", 79);
3531
3532   printf("Level author: '%s'\n", level->author);
3533   printf("Level title:  '%s'\n", level->name);
3534   printf("\n");
3535   printf("Playfield size: %d x %d\n", level->fieldx, level->fieldy);
3536   printf("\n");
3537   printf("Level time:  %d seconds\n", level->time);
3538   printf("Gems needed: %d\n", level->gems_needed);
3539   printf("\n");
3540   printf("Time for magic wall: %d seconds\n", level->time_magic_wall);
3541   printf("Time for wheel:      %d seconds\n", level->time_wheel);
3542   printf("Time for light:      %d seconds\n", level->time_light);
3543   printf("Time for timegate:   %d seconds\n", level->time_timegate);
3544   printf("\n");
3545   printf("Amoeba speed: %d\n", level->amoeba_speed);
3546   printf("\n");
3547   printf("Initial gravity:             %s\n", (level->initial_gravity ? "yes" : "no"));
3548   printf("Double speed movement:       %s\n", (level->double_speed ? "yes" : "no"));
3549   printf("EM style slippery gems:      %s\n", (level->em_slippery_gems ? "yes" : "no"));
3550   printf("Player blocks last field:    %s\n", (level->block_last_field ? "yes" : "no"));
3551   printf("SP player blocks last field: %s\n", (level->sp_block_last_field ? "yes" : "no"));
3552   printf("use spring bug: %s\n", (level->use_spring_bug ? "yes" : "no"));
3553   printf("use step counter: %s\n", (level->use_step_counter ? "yes" : "no"));
3554
3555   printf_line("-", 79);
3556 }
3557
3558
3559 /* ========================================================================= */
3560 /* tape file functions                                                       */
3561 /* ========================================================================= */
3562
3563 static void setTapeInfoToDefaults()
3564 {
3565   int i;
3566
3567   /* always start with reliable default values (empty tape) */
3568   TapeErase();
3569
3570   /* default values (also for pre-1.2 tapes) with only the first player */
3571   tape.player_participates[0] = TRUE;
3572   for (i = 1; i < MAX_PLAYERS; i++)
3573     tape.player_participates[i] = FALSE;
3574
3575   /* at least one (default: the first) player participates in every tape */
3576   tape.num_participating_players = 1;
3577
3578   tape.level_nr = level_nr;
3579   tape.counter = 0;
3580   tape.changed = FALSE;
3581
3582   tape.recording = FALSE;
3583   tape.playing = FALSE;
3584   tape.pausing = FALSE;
3585
3586   tape.no_valid_file = FALSE;
3587 }
3588
3589 static int LoadTape_VERS(FILE *file, int chunk_size, struct TapeInfo *tape)
3590 {
3591   tape->file_version = getFileVersion(file);
3592   tape->game_version = getFileVersion(file);
3593
3594   return chunk_size;
3595 }
3596
3597 static int LoadTape_HEAD(FILE *file, int chunk_size, struct TapeInfo *tape)
3598 {
3599   int i;
3600
3601   tape->random_seed = getFile32BitBE(file);
3602   tape->date        = getFile32BitBE(file);
3603   tape->length      = getFile32BitBE(file);
3604
3605   /* read header fields that are new since version 1.2 */
3606   if (tape->file_version >= FILE_VERSION_1_2)
3607   {
3608     byte store_participating_players = getFile8Bit(file);
3609     int engine_version;
3610
3611     /* since version 1.2, tapes store which players participate in the tape */
3612     tape->num_participating_players = 0;
3613     for (i = 0; i < MAX_PLAYERS; i++)
3614     {
3615       tape->player_participates[i] = FALSE;
3616
3617       if (store_participating_players & (1 << i))
3618       {
3619         tape->player_participates[i] = TRUE;
3620         tape->num_participating_players++;
3621       }
3622     }
3623
3624     ReadUnusedBytesFromFile(file, TAPE_HEADER_UNUSED);
3625
3626     engine_version = getFileVersion(file);
3627     if (engine_version > 0)
3628       tape->engine_version = engine_version;
3629     else
3630       tape->engine_version = tape->game_version;
3631   }
3632
3633   return chunk_size;
3634 }
3635
3636 static int LoadTape_INFO(FILE *file, int chunk_size, struct TapeInfo *tape)
3637 {
3638   int level_identifier_size;
3639   int i;
3640
3641   level_identifier_size = getFile16BitBE(file);
3642
3643   tape->level_identifier =
3644     checked_realloc(tape->level_identifier, level_identifier_size);
3645
3646   for (i = 0; i < level_identifier_size; i++)
3647     tape->level_identifier[i] = getFile8Bit(file);
3648
3649   tape->level_nr = getFile16BitBE(file);
3650
3651   chunk_size = 2 + level_identifier_size + 2;
3652
3653   return chunk_size;
3654 }
3655
3656 static int LoadTape_BODY(FILE *file, int chunk_size, struct TapeInfo *tape)
3657 {
3658   int i, j;
3659   int chunk_size_expected =
3660     (tape->num_participating_players + 1) * tape->length;
3661
3662   if (chunk_size_expected != chunk_size)
3663   {
3664     ReadUnusedBytesFromFile(file, chunk_size);
3665     return chunk_size_expected;
3666   }
3667
3668   for (i = 0; i < tape->length; i++)
3669   {
3670     if (i >= MAX_TAPELEN)
3671       break;
3672
3673     for (j = 0; j < MAX_PLAYERS; j++)
3674     {
3675       tape->pos[i].action[j] = MV_NO_MOVING;
3676
3677       if (tape->player_participates[j])
3678         tape->pos[i].action[j] = getFile8Bit(file);
3679     }
3680
3681     tape->pos[i].delay = getFile8Bit(file);
3682
3683     if (tape->file_version == FILE_VERSION_1_0)
3684     {
3685       /* eliminate possible diagonal moves in old tapes */
3686       /* this is only for backward compatibility */
3687
3688       byte joy_dir[4] = { JOY_LEFT, JOY_RIGHT, JOY_UP, JOY_DOWN };
3689       byte action = tape->pos[i].action[0];
3690       int k, num_moves = 0;
3691
3692       for (k = 0; k<4; k++)
3693       {
3694         if (action & joy_dir[k])
3695         {
3696           tape->pos[i + num_moves].action[0] = joy_dir[k];
3697           if (num_moves > 0)
3698             tape->pos[i + num_moves].delay = 0;
3699           num_moves++;
3700         }
3701       }
3702
3703       if (num_moves > 1)
3704       {
3705         num_moves--;
3706         i += num_moves;
3707         tape->length += num_moves;
3708       }
3709     }
3710     else if (tape->file_version < FILE_VERSION_2_0)
3711     {
3712       /* convert pre-2.0 tapes to new tape format */
3713
3714       if (tape->pos[i].delay > 1)
3715       {
3716         /* action part */
3717         tape->pos[i + 1] = tape->pos[i];
3718         tape->pos[i + 1].delay = 1;
3719
3720         /* delay part */
3721         for (j = 0; j < MAX_PLAYERS; j++)
3722           tape->pos[i].action[j] = MV_NO_MOVING;
3723         tape->pos[i].delay--;
3724
3725         i++;
3726         tape->length++;
3727       }
3728     }
3729
3730     if (feof(file))
3731       break;
3732   }
3733
3734   if (i != tape->length)
3735     chunk_size = (tape->num_participating_players + 1) * i;
3736
3737   return chunk_size;
3738 }
3739
3740 void LoadTapeFromFilename(char *filename)
3741 {
3742   char cookie[MAX_LINE_LEN];
3743   char chunk_name[CHUNK_ID_LEN + 1];
3744   FILE *file;
3745   int chunk_size;
3746
3747   /* always start with reliable default values */
3748   setTapeInfoToDefaults();
3749
3750   if (!(file = fopen(filename, MODE_READ)))
3751   {
3752     tape.no_valid_file = TRUE;
3753
3754 #if 0
3755     Error(ERR_WARN, "cannot read tape '%s' -- using empty tape", filename);
3756 #endif
3757
3758     return;
3759   }
3760
3761   getFileChunkBE(file, chunk_name, NULL);
3762   if (strcmp(chunk_name, "RND1") == 0)
3763   {
3764     getFile32BitBE(file);               /* not used */
3765
3766     getFileChunkBE(file, chunk_name, NULL);
3767     if (strcmp(chunk_name, "TAPE") != 0)
3768     {
3769       tape.no_valid_file = TRUE;
3770
3771       Error(ERR_WARN, "unknown format of tape file '%s'", filename);
3772       fclose(file);
3773       return;
3774     }
3775   }
3776   else  /* check for pre-2.0 file format with cookie string */
3777   {
3778     strcpy(cookie, chunk_name);
3779     fgets(&cookie[4], MAX_LINE_LEN - 4, file);
3780     if (strlen(cookie) > 0 && cookie[strlen(cookie) - 1] == '\n')
3781       cookie[strlen(cookie) - 1] = '\0';
3782
3783     if (!checkCookieString(cookie, TAPE_COOKIE_TMPL))
3784     {
3785       tape.no_valid_file = TRUE;
3786
3787       Error(ERR_WARN, "unknown format of tape file '%s'", filename);
3788       fclose(file);
3789       return;
3790     }
3791
3792     if ((tape.file_version = getFileVersionFromCookieString(cookie)) == -1)
3793     {
3794       tape.no_valid_file = TRUE;
3795
3796       Error(ERR_WARN, "unsupported version of tape file '%s'", filename);
3797       fclose(file);
3798       return;
3799     }
3800
3801     /* pre-2.0 tape files have no game version, so use file version here */
3802     tape.game_version = tape.file_version;
3803   }
3804
3805   if (tape.file_version < FILE_VERSION_1_2)
3806   {
3807     /* tape files from versions before 1.2.0 without chunk structure */
3808     LoadTape_HEAD(file, TAPE_HEADER_SIZE, &tape);
3809     LoadTape_BODY(file, 2 * tape.length,  &tape);
3810   }
3811   else
3812   {
3813     static struct
3814     {
3815       char *name;
3816       int size;
3817       int (*loader)(FILE *, int, struct TapeInfo *);
3818     }
3819     chunk_info[] =
3820     {
3821       { "VERS", FILE_VERS_CHUNK_SIZE,   LoadTape_VERS },
3822       { "HEAD", TAPE_HEADER_SIZE,       LoadTape_HEAD },
3823       { "INFO", -1,                     LoadTape_INFO },
3824       { "BODY", -1,                     LoadTape_BODY },
3825       {  NULL,  0,                      NULL }
3826     };
3827
3828     while (getFileChunkBE(file, chunk_name, &chunk_size))
3829     {
3830       int i = 0;
3831
3832       while (chunk_info[i].name != NULL &&
3833              strcmp(chunk_name, chunk_info[i].name) != 0)
3834         i++;
3835
3836       if (chunk_info[i].name == NULL)
3837       {
3838         Error(ERR_WARN, "unknown chunk '%s' in tape file '%s'",
3839               chunk_name, filename);
3840         ReadUnusedBytesFromFile(file, chunk_size);
3841       }
3842       else if (chunk_info[i].size != -1 &&
3843                chunk_info[i].size != chunk_size)
3844       {
3845         Error(ERR_WARN, "wrong size (%d) of chunk '%s' in tape file '%s'",
3846               chunk_size, chunk_name, filename);
3847         ReadUnusedBytesFromFile(file, chunk_size);
3848       }
3849       else
3850       {
3851         /* call function to load this tape chunk */
3852         int chunk_size_expected =
3853           (chunk_info[i].loader)(file, chunk_size, &tape);
3854
3855         /* the size of some chunks cannot be checked before reading other
3856            chunks first (like "HEAD" and "BODY") that contain some header
3857            information, so check them here */
3858         if (chunk_size_expected != chunk_size)
3859         {
3860           Error(ERR_WARN, "wrong size (%d) of chunk '%s' in tape file '%s'",
3861                 chunk_size, chunk_name, filename);
3862         }
3863       }
3864     }
3865   }
3866
3867   fclose(file);
3868
3869   tape.length_seconds = GetTapeLength();
3870
3871 #if 0
3872   printf("::: tape game version: %d\n", tape.game_version);
3873   printf("::: tape engine version: %d\n", tape.engine_version);
3874 #endif
3875 }
3876
3877 void LoadTape(int nr)
3878 {
3879   char *filename = getTapeFilename(nr);
3880
3881   LoadTapeFromFilename(filename);
3882 }
3883
3884 void LoadSolutionTape(int nr)
3885 {
3886   char *filename = getSolutionTapeFilename(nr);
3887
3888   LoadTapeFromFilename(filename);
3889 }
3890
3891 static void SaveTape_VERS(FILE *file, struct TapeInfo *tape)
3892 {
3893   putFileVersion(file, tape->file_version);
3894   putFileVersion(file, tape->game_version);
3895 }
3896
3897 static void SaveTape_HEAD(FILE *file, struct TapeInfo *tape)
3898 {
3899   int i;
3900   byte store_participating_players = 0;
3901
3902   /* set bits for participating players for compact storage */
3903   for (i = 0; i < MAX_PLAYERS; i++)
3904     if (tape->player_participates[i])
3905       store_participating_players |= (1 << i);
3906
3907   putFile32BitBE(file, tape->random_seed);
3908   putFile32BitBE(file, tape->date);
3909   putFile32BitBE(file, tape->length);
3910
3911   putFile8Bit(file, store_participating_players);
3912
3913   /* unused bytes not at the end here for 4-byte alignment of engine_version */
3914   WriteUnusedBytesToFile(file, TAPE_HEADER_UNUSED);
3915
3916   putFileVersion(file, tape->engine_version);
3917 }
3918
3919 static void SaveTape_INFO(FILE *file, struct TapeInfo *tape)
3920 {
3921   int level_identifier_size = strlen(tape->level_identifier) + 1;
3922   int i;
3923
3924   putFile16BitBE(file, level_identifier_size);
3925
3926   for (i = 0; i < level_identifier_size; i++)
3927     putFile8Bit(file, tape->level_identifier[i]);
3928
3929   putFile16BitBE(file, tape->level_nr);
3930 }
3931
3932 static void SaveTape_BODY(FILE *file, struct TapeInfo *tape)
3933 {
3934   int i, j;
3935
3936   for (i = 0; i < tape->length; i++)
3937   {
3938     for (j = 0; j < MAX_PLAYERS; j++)
3939       if (tape->player_participates[j])
3940         putFile8Bit(file, tape->pos[i].action[j]);
3941
3942     putFile8Bit(file, tape->pos[i].delay);
3943   }
3944 }
3945
3946 void SaveTape(int nr)
3947 {
3948   char *filename = getTapeFilename(nr);
3949   FILE *file;
3950   boolean new_tape = TRUE;
3951   int num_participating_players = 0;
3952   int info_chunk_size;
3953   int body_chunk_size;
3954   int i;
3955
3956   InitTapeDirectory(leveldir_current->subdir);
3957
3958   /* if a tape still exists, ask to overwrite it */
3959   if (access(filename, F_OK) == 0)
3960   {
3961     new_tape = FALSE;
3962     if (!Request("Replace old tape ?", REQ_ASK))
3963       return;
3964   }
3965
3966   if (!(file = fopen(filename, MODE_WRITE)))
3967   {
3968     Error(ERR_WARN, "cannot save level recording file '%s'", filename);
3969     return;
3970   }
3971
3972   tape.file_version = FILE_VERSION_ACTUAL;
3973   tape.game_version = GAME_VERSION_ACTUAL;
3974
3975   /* count number of participating players  */
3976   for (i = 0; i < MAX_PLAYERS; i++)
3977     if (tape.player_participates[i])
3978       num_participating_players++;
3979
3980   info_chunk_size = 2 + (strlen(tape.level_identifier) + 1) + 2;
3981   body_chunk_size = (num_participating_players + 1) * tape.length;
3982
3983   putFileChunkBE(file, "RND1", CHUNK_SIZE_UNDEFINED);
3984   putFileChunkBE(file, "TAPE", CHUNK_SIZE_NONE);
3985
3986   putFileChunkBE(file, "VERS", FILE_VERS_CHUNK_SIZE);
3987   SaveTape_VERS(file, &tape);
3988
3989   putFileChunkBE(file, "HEAD", TAPE_HEADER_SIZE);
3990   SaveTape_HEAD(file, &tape);
3991
3992   putFileChunkBE(file, "INFO", info_chunk_size);
3993   SaveTape_INFO(file, &tape);
3994
3995   putFileChunkBE(file, "BODY", body_chunk_size);
3996   SaveTape_BODY(file, &tape);
3997
3998   fclose(file);
3999
4000   SetFilePermissions(filename, PERMS_PRIVATE);
4001
4002   tape.changed = FALSE;
4003
4004   if (new_tape)
4005     Request("tape saved !", REQ_CONFIRM);
4006 }
4007
4008 void DumpTape(struct TapeInfo *tape)
4009 {
4010   int i, j;
4011
4012 #if 1
4013   if (tape->no_valid_file)
4014   {
4015     Error(ERR_WARN, "cannot dump -- no valid tape file found");
4016
4017     return;
4018   }
4019 #else
4020   if (TAPE_IS_EMPTY(*tape))
4021   {
4022     Error(ERR_WARN, "no tape available for level %d", tape->level_nr);
4023
4024     return;
4025   }
4026 #endif
4027
4028   printf_line("-", 79);
4029   printf("Tape of Level %03d (file version %08d, game version %08d)\n",
4030          tape->level_nr, tape->file_version, tape->game_version);
4031   printf("                  (effective engine version %08d)\n",
4032          tape->engine_version);
4033   printf("Level series identifier: '%s'\n", tape->level_identifier);
4034   printf_line("-", 79);
4035
4036   for (i = 0; i < tape->length; i++)
4037   {
4038     if (i >= MAX_TAPELEN)
4039       break;
4040
4041     printf("%03d: ", i);
4042
4043     for (j = 0; j < MAX_PLAYERS; j++)
4044     {
4045       if (tape->player_participates[j])
4046       {
4047         int action = tape->pos[i].action[j];
4048
4049         printf("%d:%02x ", j, action);
4050         printf("[%c%c%c%c|%c%c] - ",
4051                (action & JOY_LEFT ? '<' : ' '),
4052                (action & JOY_RIGHT ? '>' : ' '),
4053                (action & JOY_UP ? '^' : ' '),
4054                (action & JOY_DOWN ? 'v' : ' '),
4055                (action & JOY_BUTTON_1 ? '1' : ' '),
4056                (action & JOY_BUTTON_2 ? '2' : ' '));
4057       }
4058     }
4059
4060     printf("(%03d)\n", tape->pos[i].delay);
4061   }
4062
4063   printf_line("-", 79);
4064 }
4065
4066
4067 /* ========================================================================= */
4068 /* score file functions                                                      */
4069 /* ========================================================================= */
4070
4071 void LoadScore(int nr)
4072 {
4073   int i;
4074   char *filename = getScoreFilename(nr);
4075   char cookie[MAX_LINE_LEN];
4076   char line[MAX_LINE_LEN];
4077   char *line_ptr;
4078   FILE *file;
4079
4080   /* always start with reliable default values */
4081   for (i = 0; i < MAX_SCORE_ENTRIES; i++)
4082   {
4083     strcpy(highscore[i].Name, EMPTY_PLAYER_NAME);
4084     highscore[i].Score = 0;
4085   }
4086
4087   if (!(file = fopen(filename, MODE_READ)))
4088     return;
4089
4090   /* check file identifier */
4091   fgets(cookie, MAX_LINE_LEN, file);
4092   if (strlen(cookie) > 0 && cookie[strlen(cookie) - 1] == '\n')
4093     cookie[strlen(cookie) - 1] = '\0';
4094
4095   if (!checkCookieString(cookie, SCORE_COOKIE))
4096   {
4097     Error(ERR_WARN, "unknown format of score file '%s'", filename);
4098     fclose(file);
4099     return;
4100   }
4101
4102   for (i = 0; i < MAX_SCORE_ENTRIES; i++)
4103   {
4104     fscanf(file, "%d", &highscore[i].Score);
4105     fgets(line, MAX_LINE_LEN, file);
4106
4107     if (line[strlen(line) - 1] == '\n')
4108       line[strlen(line) - 1] = '\0';
4109
4110     for (line_ptr = line; *line_ptr; line_ptr++)
4111     {
4112       if (*line_ptr != ' ' && *line_ptr != '\t' && *line_ptr != '\0')
4113       {
4114         strncpy(highscore[i].Name, line_ptr, MAX_PLAYER_NAME_LEN);
4115         highscore[i].Name[MAX_PLAYER_NAME_LEN] = '\0';
4116         break;
4117       }
4118     }
4119   }
4120
4121   fclose(file);
4122 }
4123
4124 void SaveScore(int nr)
4125 {
4126   int i;
4127   char *filename = getScoreFilename(nr);
4128   FILE *file;
4129
4130   InitScoreDirectory(leveldir_current->subdir);
4131
4132   if (!(file = fopen(filename, MODE_WRITE)))
4133   {
4134     Error(ERR_WARN, "cannot save score for level %d", nr);
4135     return;
4136   }
4137
4138   fprintf(file, "%s\n\n", SCORE_COOKIE);
4139
4140   for (i = 0; i < MAX_SCORE_ENTRIES; i++)
4141     fprintf(file, "%d %s\n", highscore[i].Score, highscore[i].Name);
4142
4143   fclose(file);
4144
4145   SetFilePermissions(filename, PERMS_PUBLIC);
4146 }
4147
4148
4149 /* ========================================================================= */
4150 /* setup file functions                                                      */
4151 /* ========================================================================= */
4152
4153 #define TOKEN_STR_PLAYER_PREFIX                 "player_"
4154
4155 /* global setup */
4156 #define SETUP_TOKEN_PLAYER_NAME                 0
4157 #define SETUP_TOKEN_SOUND                       1
4158 #define SETUP_TOKEN_SOUND_LOOPS                 2
4159 #define SETUP_TOKEN_SOUND_MUSIC                 3
4160 #define SETUP_TOKEN_SOUND_SIMPLE                4
4161 #define SETUP_TOKEN_TOONS                       5
4162 #define SETUP_TOKEN_SCROLL_DELAY                6
4163 #define SETUP_TOKEN_SOFT_SCROLLING              7
4164 #define SETUP_TOKEN_FADING                      8
4165 #define SETUP_TOKEN_AUTORECORD                  9
4166 #define SETUP_TOKEN_QUICK_DOORS                 10
4167 #define SETUP_TOKEN_TEAM_MODE                   11
4168 #define SETUP_TOKEN_HANDICAP                    12
4169 #define SETUP_TOKEN_TIME_LIMIT                  13
4170 #define SETUP_TOKEN_FULLSCREEN                  14
4171 #define SETUP_TOKEN_ASK_ON_ESCAPE               15
4172 #define SETUP_TOKEN_GRAPHICS_SET                16
4173 #define SETUP_TOKEN_SOUNDS_SET                  17
4174 #define SETUP_TOKEN_MUSIC_SET                   18
4175 #define SETUP_TOKEN_OVERRIDE_LEVEL_GRAPHICS     19
4176 #define SETUP_TOKEN_OVERRIDE_LEVEL_SOUNDS       20
4177 #define SETUP_TOKEN_OVERRIDE_LEVEL_MUSIC        21
4178
4179 #define NUM_GLOBAL_SETUP_TOKENS                 22
4180
4181 /* editor setup */
4182 #define SETUP_TOKEN_EDITOR_EL_BOULDERDASH       0
4183 #define SETUP_TOKEN_EDITOR_EL_EMERALD_MINE      1
4184 #define SETUP_TOKEN_EDITOR_EL_EMERALD_MINE_CLUB 2
4185 #define SETUP_TOKEN_EDITOR_EL_MORE              3
4186 #define SETUP_TOKEN_EDITOR_EL_SOKOBAN           4
4187 #define SETUP_TOKEN_EDITOR_EL_SUPAPLEX          5
4188 #define SETUP_TOKEN_EDITOR_EL_DIAMOND_CAVES     6
4189 #define SETUP_TOKEN_EDITOR_EL_DX_BOULDERDASH    7
4190 #define SETUP_TOKEN_EDITOR_EL_CHARS             8
4191 #define SETUP_TOKEN_EDITOR_EL_CUSTOM            9
4192 #define SETUP_TOKEN_EDITOR_EL_CUSTOM_MORE       10
4193 #define SETUP_TOKEN_EDITOR_EL_HEADLINES         11
4194 #define SETUP_TOKEN_EDITOR_EL_USER_DEFINED      12
4195
4196 #define NUM_EDITOR_SETUP_TOKENS                 13
4197
4198 /* shortcut setup */
4199 #define SETUP_TOKEN_SHORTCUT_SAVE_GAME          0
4200 #define SETUP_TOKEN_SHORTCUT_LOAD_GAME          1
4201 #define SETUP_TOKEN_SHORTCUT_TOGGLE_PAUSE       2
4202
4203 #define NUM_SHORTCUT_SETUP_TOKENS               3
4204
4205 /* player setup */
4206 #define SETUP_TOKEN_PLAYER_USE_JOYSTICK         0
4207 #define SETUP_TOKEN_PLAYER_JOY_DEVICE_NAME      1
4208 #define SETUP_TOKEN_PLAYER_JOY_XLEFT            2
4209 #define SETUP_TOKEN_PLAYER_JOY_XMIDDLE          3
4210 #define SETUP_TOKEN_PLAYER_JOY_XRIGHT           4
4211 #define SETUP_TOKEN_PLAYER_JOY_YUPPER           5
4212 #define SETUP_TOKEN_PLAYER_JOY_YMIDDLE          6
4213 #define SETUP_TOKEN_PLAYER_JOY_YLOWER           7
4214 #define SETUP_TOKEN_PLAYER_JOY_SNAP             8
4215 #define SETUP_TOKEN_PLAYER_JOY_DROP             9
4216 #define SETUP_TOKEN_PLAYER_KEY_LEFT             10
4217 #define SETUP_TOKEN_PLAYER_KEY_RIGHT            11
4218 #define SETUP_TOKEN_PLAYER_KEY_UP               12
4219 #define SETUP_TOKEN_PLAYER_KEY_DOWN             13
4220 #define SETUP_TOKEN_PLAYER_KEY_SNAP             14
4221 #define SETUP_TOKEN_PLAYER_KEY_DROP             15
4222
4223 #define NUM_PLAYER_SETUP_TOKENS                 16
4224
4225 /* system setup */
4226 #define SETUP_TOKEN_SYSTEM_SDL_AUDIODRIVER      0
4227 #define SETUP_TOKEN_SYSTEM_AUDIO_FRAGMENT_SIZE  1
4228
4229 #define NUM_SYSTEM_SETUP_TOKENS                 2
4230
4231 /* options setup */
4232 #define SETUP_TOKEN_OPTIONS_VERBOSE             0
4233
4234 #define NUM_OPTIONS_SETUP_TOKENS                1
4235
4236
4237 static struct SetupInfo si;
4238 static struct SetupEditorInfo sei;
4239 static struct SetupShortcutInfo ssi;
4240 static struct SetupInputInfo sii;
4241 static struct SetupSystemInfo syi;
4242 static struct OptionInfo soi;
4243
4244 static struct TokenInfo global_setup_tokens[] =
4245 {
4246   { TYPE_STRING, &si.player_name,       "player_name"                   },
4247   { TYPE_SWITCH, &si.sound,             "sound"                         },
4248   { TYPE_SWITCH, &si.sound_loops,       "repeating_sound_loops"         },
4249   { TYPE_SWITCH, &si.sound_music,       "background_music"              },
4250   { TYPE_SWITCH, &si.sound_simple,      "simple_sound_effects"          },
4251   { TYPE_SWITCH, &si.toons,             "toons"                         },
4252   { TYPE_SWITCH, &si.scroll_delay,      "scroll_delay"                  },
4253   { TYPE_SWITCH, &si.soft_scrolling,    "soft_scrolling"                },
4254   { TYPE_SWITCH, &si.fading,            "screen_fading"                 },
4255   { TYPE_SWITCH, &si.autorecord,        "automatic_tape_recording"      },
4256   { TYPE_SWITCH, &si.quick_doors,       "quick_doors"                   },
4257   { TYPE_SWITCH, &si.team_mode,         "team_mode"                     },
4258   { TYPE_SWITCH, &si.handicap,          "handicap"                      },
4259   { TYPE_SWITCH, &si.time_limit,        "time_limit"                    },
4260   { TYPE_SWITCH, &si.fullscreen,        "fullscreen"                    },
4261   { TYPE_SWITCH, &si.ask_on_escape,     "ask_on_escape"                 },
4262   { TYPE_STRING, &si.graphics_set,      "graphics_set"                  },
4263   { TYPE_STRING, &si.sounds_set,        "sounds_set"                    },
4264   { TYPE_STRING, &si.music_set,         "music_set"                     },
4265   { TYPE_SWITCH, &si.override_level_graphics, "override_level_graphics" },
4266   { TYPE_SWITCH, &si.override_level_sounds,   "override_level_sounds"   },
4267   { TYPE_SWITCH, &si.override_level_music,    "override_level_music"    },
4268 };
4269
4270 static struct TokenInfo editor_setup_tokens[] =
4271 {
4272   { TYPE_SWITCH, &sei.el_boulderdash,   "editor.el_boulderdash"         },
4273   { TYPE_SWITCH, &sei.el_emerald_mine,  "editor.el_emerald_mine"        },
4274   { TYPE_SWITCH, &sei.el_emerald_mine_club,"editor.el_emerald_mine_club"},
4275   { TYPE_SWITCH, &sei.el_more,          "editor.el_more"                },
4276   { TYPE_SWITCH, &sei.el_sokoban,       "editor.el_sokoban"             },
4277   { TYPE_SWITCH, &sei.el_supaplex,      "editor.el_supaplex"            },
4278   { TYPE_SWITCH, &sei.el_diamond_caves, "editor.el_diamond_caves"       },
4279   { TYPE_SWITCH, &sei.el_dx_boulderdash,"editor.el_dx_boulderdash"      },
4280   { TYPE_SWITCH, &sei.el_chars,         "editor.el_chars"               },
4281   { TYPE_SWITCH, &sei.el_custom,        "editor.el_custom"              },
4282   { TYPE_SWITCH, &sei.el_custom_more,   "editor.el_custom_more"         },
4283   { TYPE_SWITCH, &sei.el_headlines,     "editor.el_headlines"           },
4284   { TYPE_SWITCH, &sei.el_user_defined,  "editor.el_user_defined"        },
4285 };
4286
4287 static struct TokenInfo shortcut_setup_tokens[] =
4288 {
4289   { TYPE_KEY_X11, &ssi.save_game,       "shortcut.save_game"            },
4290   { TYPE_KEY_X11, &ssi.load_game,       "shortcut.load_game"            },
4291   { TYPE_KEY_X11, &ssi.toggle_pause,    "shortcut.toggle_pause"         }
4292 };
4293
4294 static struct TokenInfo player_setup_tokens[] =
4295 {
4296   { TYPE_BOOLEAN, &sii.use_joystick,    ".use_joystick"                 },
4297   { TYPE_STRING,  &sii.joy.device_name, ".joy.device_name"              },
4298   { TYPE_INTEGER, &sii.joy.xleft,       ".joy.xleft"                    },
4299   { TYPE_INTEGER, &sii.joy.xmiddle,     ".joy.xmiddle"                  },
4300   { TYPE_INTEGER, &sii.joy.xright,      ".joy.xright"                   },
4301   { TYPE_INTEGER, &sii.joy.yupper,      ".joy.yupper"                   },
4302   { TYPE_INTEGER, &sii.joy.ymiddle,     ".joy.ymiddle"                  },
4303   { TYPE_INTEGER, &sii.joy.ylower,      ".joy.ylower"                   },
4304   { TYPE_INTEGER, &sii.joy.snap,        ".joy.snap_field"               },
4305   { TYPE_INTEGER, &sii.joy.drop,        ".joy.place_bomb"               },
4306   { TYPE_KEY_X11, &sii.key.left,        ".key.move_left"                },
4307   { TYPE_KEY_X11, &sii.key.right,       ".key.move_right"               },
4308   { TYPE_KEY_X11, &sii.key.up,          ".key.move_up"                  },
4309   { TYPE_KEY_X11, &sii.key.down,        ".key.move_down"                },
4310   { TYPE_KEY_X11, &sii.key.snap,        ".key.snap_field"               },
4311   { TYPE_KEY_X11, &sii.key.drop,        ".key.place_bomb"               }
4312 };
4313
4314 static struct TokenInfo system_setup_tokens[] =
4315 {
4316   { TYPE_STRING,  &syi.sdl_audiodriver, "system.sdl_audiodriver"        },
4317   { TYPE_INTEGER, &syi.audio_fragment_size,"system.audio_fragment_size" }
4318 };
4319
4320 static struct TokenInfo options_setup_tokens[] =
4321 {
4322   { TYPE_BOOLEAN, &soi.verbose,         "options.verbose"               }
4323 };
4324
4325 static char *get_corrected_login_name(char *login_name)
4326 {
4327   /* needed because player name must be a fixed length string */
4328   char *login_name_new = checked_malloc(MAX_PLAYER_NAME_LEN + 1);
4329
4330   strncpy(login_name_new, login_name, MAX_PLAYER_NAME_LEN);
4331   login_name_new[MAX_PLAYER_NAME_LEN] = '\0';
4332
4333   if (strlen(login_name) > MAX_PLAYER_NAME_LEN)         /* name has been cut */
4334     if (strchr(login_name_new, ' '))
4335       *strchr(login_name_new, ' ') = '\0';
4336
4337   return login_name_new;
4338 }
4339
4340 static void setSetupInfoToDefaults(struct SetupInfo *si)
4341 {
4342   int i;
4343
4344   si->player_name = get_corrected_login_name(getLoginName());
4345
4346   si->sound = TRUE;
4347   si->sound_loops = TRUE;
4348   si->sound_music = TRUE;
4349   si->sound_simple = TRUE;
4350   si->toons = TRUE;
4351   si->double_buffering = TRUE;
4352   si->direct_draw = !si->double_buffering;
4353   si->scroll_delay = TRUE;
4354   si->soft_scrolling = TRUE;
4355   si->fading = FALSE;
4356   si->autorecord = TRUE;
4357   si->quick_doors = FALSE;
4358   si->team_mode = FALSE;
4359   si->handicap = TRUE;
4360   si->time_limit = TRUE;
4361   si->fullscreen = FALSE;
4362   si->ask_on_escape = TRUE;
4363
4364   si->graphics_set = getStringCopy(GFX_CLASSIC_SUBDIR);
4365   si->sounds_set = getStringCopy(SND_CLASSIC_SUBDIR);
4366   si->music_set = getStringCopy(MUS_CLASSIC_SUBDIR);
4367   si->override_level_graphics = FALSE;
4368   si->override_level_sounds = FALSE;
4369   si->override_level_music = FALSE;
4370
4371   si->editor.el_boulderdash       = TRUE;
4372   si->editor.el_emerald_mine      = TRUE;
4373   si->editor.el_emerald_mine_club = TRUE;
4374   si->editor.el_more              = TRUE;
4375   si->editor.el_sokoban           = TRUE;
4376   si->editor.el_supaplex          = TRUE;
4377   si->editor.el_diamond_caves     = TRUE;
4378   si->editor.el_dx_boulderdash    = TRUE;
4379   si->editor.el_chars             = TRUE;
4380   si->editor.el_custom            = TRUE;
4381   si->editor.el_custom_more       = FALSE;
4382
4383   si->editor.el_headlines = TRUE;
4384   si->editor.el_user_defined = FALSE;
4385
4386   si->shortcut.save_game = DEFAULT_KEY_SAVE_GAME;
4387   si->shortcut.load_game = DEFAULT_KEY_LOAD_GAME;
4388   si->shortcut.toggle_pause = DEFAULT_KEY_TOGGLE_PAUSE;
4389
4390   for (i = 0; i < MAX_PLAYERS; i++)
4391   {
4392     si->input[i].use_joystick = FALSE;
4393     si->input[i].joy.device_name=getStringCopy(getDeviceNameFromJoystickNr(i));
4394     si->input[i].joy.xleft   = JOYSTICK_XLEFT;
4395     si->input[i].joy.xmiddle = JOYSTICK_XMIDDLE;
4396     si->input[i].joy.xright  = JOYSTICK_XRIGHT;
4397     si->input[i].joy.yupper  = JOYSTICK_YUPPER;
4398     si->input[i].joy.ymiddle = JOYSTICK_YMIDDLE;
4399     si->input[i].joy.ylower  = JOYSTICK_YLOWER;
4400     si->input[i].joy.snap  = (i == 0 ? JOY_BUTTON_1 : 0);
4401     si->input[i].joy.drop  = (i == 0 ? JOY_BUTTON_2 : 0);
4402     si->input[i].key.left  = (i == 0 ? DEFAULT_KEY_LEFT  : KSYM_UNDEFINED);
4403     si->input[i].key.right = (i == 0 ? DEFAULT_KEY_RIGHT : KSYM_UNDEFINED);
4404     si->input[i].key.up    = (i == 0 ? DEFAULT_KEY_UP    : KSYM_UNDEFINED);
4405     si->input[i].key.down  = (i == 0 ? DEFAULT_KEY_DOWN  : KSYM_UNDEFINED);
4406     si->input[i].key.snap  = (i == 0 ? DEFAULT_KEY_SNAP  : KSYM_UNDEFINED);
4407     si->input[i].key.drop  = (i == 0 ? DEFAULT_KEY_DROP  : KSYM_UNDEFINED);
4408   }
4409
4410   si->system.sdl_audiodriver = getStringCopy(ARG_DEFAULT);
4411   si->system.audio_fragment_size = DEFAULT_AUDIO_FRAGMENT_SIZE;
4412
4413   si->options.verbose = FALSE;
4414 }
4415
4416 static void decodeSetupFileHash(SetupFileHash *setup_file_hash)
4417 {
4418   int i, pnr;
4419
4420   if (!setup_file_hash)
4421     return;
4422
4423   /* global setup */
4424   si = setup;
4425   for (i = 0; i < NUM_GLOBAL_SETUP_TOKENS; i++)
4426     setSetupInfo(global_setup_tokens, i,
4427                  getHashEntry(setup_file_hash, global_setup_tokens[i].text));
4428   setup = si;
4429
4430   /* editor setup */
4431   sei = setup.editor;
4432   for (i = 0; i < NUM_EDITOR_SETUP_TOKENS; i++)
4433     setSetupInfo(editor_setup_tokens, i,
4434                  getHashEntry(setup_file_hash,editor_setup_tokens[i].text));
4435   setup.editor = sei;
4436
4437   /* shortcut setup */
4438   ssi = setup.shortcut;
4439   for (i = 0; i < NUM_SHORTCUT_SETUP_TOKENS; i++)
4440     setSetupInfo(shortcut_setup_tokens, i,
4441                  getHashEntry(setup_file_hash,shortcut_setup_tokens[i].text));
4442   setup.shortcut = ssi;
4443
4444   /* player setup */
4445   for (pnr = 0; pnr < MAX_PLAYERS; pnr++)
4446   {
4447     char prefix[30];
4448
4449     sprintf(prefix, "%s%d", TOKEN_STR_PLAYER_PREFIX, pnr + 1);
4450
4451     sii = setup.input[pnr];
4452     for (i = 0; i < NUM_PLAYER_SETUP_TOKENS; i++)
4453     {
4454       char full_token[100];
4455
4456       sprintf(full_token, "%s%s", prefix, player_setup_tokens[i].text);
4457       setSetupInfo(player_setup_tokens, i,
4458                    getHashEntry(setup_file_hash, full_token));
4459     }
4460     setup.input[pnr] = sii;
4461   }
4462
4463   /* system setup */
4464   syi = setup.system;
4465   for (i = 0; i < NUM_SYSTEM_SETUP_TOKENS; i++)
4466     setSetupInfo(system_setup_tokens, i,
4467                  getHashEntry(setup_file_hash, system_setup_tokens[i].text));
4468   setup.system = syi;
4469
4470   /* options setup */
4471   soi = setup.options;
4472   for (i = 0; i < NUM_OPTIONS_SETUP_TOKENS; i++)
4473     setSetupInfo(options_setup_tokens, i,
4474                  getHashEntry(setup_file_hash, options_setup_tokens[i].text));
4475   setup.options = soi;
4476 }
4477
4478 void LoadSetup()
4479 {
4480   char *filename = getSetupFilename();
4481   SetupFileHash *setup_file_hash = NULL;
4482
4483   /* always start with reliable default values */
4484   setSetupInfoToDefaults(&setup);
4485
4486   setup_file_hash = loadSetupFileHash(filename);
4487
4488   if (setup_file_hash)
4489   {
4490     char *player_name_new;
4491
4492     checkSetupFileHashIdentifier(setup_file_hash, getCookie("SETUP"));
4493     decodeSetupFileHash(setup_file_hash);
4494
4495     setup.direct_draw = !setup.double_buffering;
4496
4497     freeSetupFileHash(setup_file_hash);
4498
4499     /* needed to work around problems with fixed length strings */
4500     player_name_new = get_corrected_login_name(setup.player_name);
4501     free(setup.player_name);
4502     setup.player_name = player_name_new;
4503   }
4504   else
4505     Error(ERR_WARN, "using default setup values");
4506 }
4507
4508 void SaveSetup()
4509 {
4510   char *filename = getSetupFilename();
4511   FILE *file;
4512   int i, pnr;
4513
4514   InitUserDataDirectory();
4515
4516   if (!(file = fopen(filename, MODE_WRITE)))
4517   {
4518     Error(ERR_WARN, "cannot write setup file '%s'", filename);
4519     return;
4520   }
4521
4522   fprintf(file, "%s\n", getFormattedSetupEntry(TOKEN_STR_FILE_IDENTIFIER,
4523                                                getCookie("SETUP")));
4524   fprintf(file, "\n");
4525
4526   /* global setup */
4527   si = setup;
4528   for (i = 0; i < NUM_GLOBAL_SETUP_TOKENS; i++)
4529   {
4530     /* just to make things nicer :) */
4531     if (i == SETUP_TOKEN_PLAYER_NAME + 1 ||
4532         i == SETUP_TOKEN_GRAPHICS_SET)
4533       fprintf(file, "\n");
4534
4535     fprintf(file, "%s\n", getSetupLine(global_setup_tokens, "", i));
4536   }
4537
4538   /* editor setup */
4539   sei = setup.editor;
4540   fprintf(file, "\n");
4541   for (i = 0; i < NUM_EDITOR_SETUP_TOKENS; i++)
4542     fprintf(file, "%s\n", getSetupLine(editor_setup_tokens, "", i));
4543
4544   /* shortcut setup */
4545   ssi = setup.shortcut;
4546   fprintf(file, "\n");
4547   for (i = 0; i < NUM_SHORTCUT_SETUP_TOKENS; i++)
4548     fprintf(file, "%s\n", getSetupLine(shortcut_setup_tokens, "", i));
4549
4550   /* player setup */
4551   for (pnr = 0; pnr < MAX_PLAYERS; pnr++)
4552   {
4553     char prefix[30];
4554
4555     sprintf(prefix, "%s%d", TOKEN_STR_PLAYER_PREFIX, pnr + 1);
4556     fprintf(file, "\n");
4557
4558     sii = setup.input[pnr];
4559     for (i = 0; i < NUM_PLAYER_SETUP_TOKENS; i++)
4560       fprintf(file, "%s\n", getSetupLine(player_setup_tokens, prefix, i));
4561   }
4562
4563   /* system setup */
4564   syi = setup.system;
4565   fprintf(file, "\n");
4566   for (i = 0; i < NUM_SYSTEM_SETUP_TOKENS; i++)
4567     fprintf(file, "%s\n", getSetupLine(system_setup_tokens, "", i));
4568
4569   /* options setup */
4570   soi = setup.options;
4571   fprintf(file, "\n");
4572   for (i = 0; i < NUM_OPTIONS_SETUP_TOKENS; i++)
4573     fprintf(file, "%s\n", getSetupLine(options_setup_tokens, "", i));
4574
4575   fclose(file);
4576
4577   SetFilePermissions(filename, PERMS_PRIVATE);
4578 }
4579
4580 void LoadCustomElementDescriptions()
4581 {
4582   char *filename = getCustomArtworkConfigFilename(ARTWORK_TYPE_GRAPHICS);
4583   SetupFileHash *setup_file_hash;
4584   int i;
4585
4586   for (i = 0; i < NUM_FILE_ELEMENTS; i++)
4587   {
4588     if (element_info[i].custom_description != NULL)
4589     {
4590       free(element_info[i].custom_description);
4591       element_info[i].custom_description = NULL;
4592     }
4593   }
4594
4595   if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
4596     return;
4597
4598   for (i = 0; i < NUM_FILE_ELEMENTS; i++)
4599   {
4600     char *token = getStringCat2(element_info[i].token_name, ".name");
4601     char *value = getHashEntry(setup_file_hash, token);
4602
4603     if (value != NULL)
4604       element_info[i].custom_description = getStringCopy(value);
4605
4606     free(token);
4607   }
4608
4609   freeSetupFileHash(setup_file_hash);
4610 }
4611
4612 void LoadSpecialMenuDesignSettings()
4613 {
4614   char *filename = getCustomArtworkConfigFilename(ARTWORK_TYPE_GRAPHICS);
4615   SetupFileHash *setup_file_hash;
4616   int i, j;
4617
4618   /* always start with reliable default values from default config */
4619   for (i = 0; image_config_vars[i].token != NULL; i++)
4620     for (j = 0; image_config[j].token != NULL; j++)
4621       if (strcmp(image_config_vars[i].token, image_config[j].token) == 0)
4622         *image_config_vars[i].value =
4623           get_auto_parameter_value(image_config_vars[i].token,
4624                                    image_config[j].value);
4625
4626   if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
4627     return;
4628
4629   /* special case: initialize with default values that may be overwritten */
4630   for (i = 0; i < NUM_SPECIAL_GFX_ARGS; i++)
4631   {
4632     char *value_x = getHashEntry(setup_file_hash, "menu.draw_xoffset");
4633     char *value_y = getHashEntry(setup_file_hash, "menu.draw_yoffset");
4634     char *list_size = getHashEntry(setup_file_hash, "menu.list_size");
4635
4636     if (value_x != NULL)
4637       menu.draw_xoffset[i] = get_integer_from_string(value_x);
4638     if (value_y != NULL)
4639       menu.draw_yoffset[i] = get_integer_from_string(value_y);
4640     if (list_size != NULL)
4641       menu.list_size[i] = get_integer_from_string(list_size);
4642   }
4643
4644   /* read (and overwrite with) values that may be specified in config file */
4645   for (i = 0; image_config_vars[i].token != NULL; i++)
4646   {
4647     char *value = getHashEntry(setup_file_hash, image_config_vars[i].token);
4648
4649     if (value != NULL)
4650       *image_config_vars[i].value =
4651         get_auto_parameter_value(image_config_vars[i].token, value);
4652   }
4653
4654   freeSetupFileHash(setup_file_hash);
4655 }
4656
4657 void LoadUserDefinedEditorElementList(int **elements, int *num_elements)
4658 {
4659   char *filename = getEditorSetupFilename();
4660   SetupFileList *setup_file_list, *list;
4661   SetupFileHash *element_hash;
4662   int num_unknown_tokens = 0;
4663   int i;
4664
4665   if ((setup_file_list = loadSetupFileList(filename)) == NULL)
4666     return;
4667
4668   element_hash = newSetupFileHash();
4669
4670   for (i = 0; i < NUM_FILE_ELEMENTS; i++)
4671     setHashEntry(element_hash, element_info[i].token_name, i_to_a(i));
4672
4673   /* determined size may be larger than needed (due to unknown elements) */
4674   *num_elements = 0;
4675   for (list = setup_file_list; list != NULL; list = list->next)
4676     (*num_elements)++;
4677
4678   /* add space for up to 3 more elements for padding that may be needed */
4679   *num_elements += 3;
4680
4681   *elements = checked_malloc(*num_elements * sizeof(int));
4682
4683   *num_elements = 0;
4684   for (list = setup_file_list; list != NULL; list = list->next)
4685   {
4686     char *value = getHashEntry(element_hash, list->token);
4687
4688     if (value)
4689     {
4690       (*elements)[(*num_elements)++] = atoi(value);
4691     }
4692     else
4693     {
4694       if (num_unknown_tokens == 0)
4695       {
4696         Error(ERR_RETURN_LINE, "-");
4697         Error(ERR_RETURN, "warning: unknown token(s) found in config file:");
4698         Error(ERR_RETURN, "- config file: '%s'", filename);
4699
4700         num_unknown_tokens++;
4701       }
4702
4703       Error(ERR_RETURN, "- token: '%s'", list->token);
4704     }
4705   }
4706
4707   if (num_unknown_tokens > 0)
4708     Error(ERR_RETURN_LINE, "-");
4709
4710   while (*num_elements % 4)     /* pad with empty elements, if needed */
4711     (*elements)[(*num_elements)++] = EL_EMPTY;
4712
4713   freeSetupFileList(setup_file_list);
4714   freeSetupFileHash(element_hash);
4715
4716 #if 0
4717   /* TEST-ONLY */
4718   for (i = 0; i < *num_elements; i++)
4719     printf("editor: element '%s' [%d]\n",
4720            element_info[(*elements)[i]].token_name, (*elements)[i]);
4721 #endif
4722 }
4723
4724 static struct MusicFileInfo *get_music_file_info_ext(char *basename, int music,
4725                                                      boolean is_sound)
4726 {
4727   SetupFileHash *setup_file_hash = NULL;
4728   struct MusicFileInfo tmp_music_file_info, *new_music_file_info;
4729   char *filename_music, *filename_prefix, *filename_info;
4730   struct
4731   {
4732     char *token;
4733     char **value_ptr;
4734   }
4735   token_to_value_ptr[] =
4736   {
4737     { "title_header",   &tmp_music_file_info.title_header       },
4738     { "artist_header",  &tmp_music_file_info.artist_header      },
4739     { "album_header",   &tmp_music_file_info.album_header       },
4740     { "year_header",    &tmp_music_file_info.year_header        },
4741
4742     { "title",          &tmp_music_file_info.title              },
4743     { "artist",         &tmp_music_file_info.artist             },
4744     { "album",          &tmp_music_file_info.album              },
4745     { "year",           &tmp_music_file_info.year               },
4746
4747     { NULL,             NULL                                    },
4748   };
4749   int i;
4750
4751   filename_music = (is_sound ? getCustomSoundFilename(basename) :
4752                     getCustomMusicFilename(basename));
4753
4754   if (filename_music == NULL)
4755     return NULL;
4756
4757   /* ---------- try to replace file extension ---------- */
4758
4759   filename_prefix = getStringCopy(filename_music);
4760   if (strrchr(filename_prefix, '.') != NULL)
4761     *strrchr(filename_prefix, '.') = '\0';
4762   filename_info = getStringCat2(filename_prefix, ".txt");
4763
4764 #if 0
4765   printf("trying to load file '%s'...\n", filename_info);
4766 #endif
4767
4768   if (fileExists(filename_info))
4769     setup_file_hash = loadSetupFileHash(filename_info);
4770
4771   free(filename_prefix);
4772   free(filename_info);
4773
4774   if (setup_file_hash == NULL)
4775   {
4776     /* ---------- try to add file extension ---------- */
4777
4778     filename_prefix = getStringCopy(filename_music);
4779     filename_info = getStringCat2(filename_prefix, ".txt");
4780
4781 #if 0
4782     printf("trying to load file '%s'...\n", filename_info);
4783 #endif
4784
4785     if (fileExists(filename_info))
4786       setup_file_hash = loadSetupFileHash(filename_info);
4787
4788     free(filename_prefix);
4789     free(filename_info);
4790   }
4791
4792   if (setup_file_hash == NULL)
4793     return NULL;
4794
4795   /* ---------- music file info found ---------- */
4796
4797   memset(&tmp_music_file_info, 0, sizeof(struct MusicFileInfo));
4798
4799   for (i = 0; token_to_value_ptr[i].token != NULL; i++)
4800   {
4801     char *value = getHashEntry(setup_file_hash, token_to_value_ptr[i].token);
4802
4803     *token_to_value_ptr[i].value_ptr =
4804       getStringCopy(value != NULL && *value != '\0' ? value : UNKNOWN_NAME);
4805   }
4806
4807   tmp_music_file_info.basename = getStringCopy(basename);
4808   tmp_music_file_info.music = music;
4809   tmp_music_file_info.is_sound = is_sound;
4810
4811   new_music_file_info = checked_malloc(sizeof(struct MusicFileInfo));
4812   *new_music_file_info = tmp_music_file_info;
4813
4814   return new_music_file_info;
4815 }
4816
4817 static struct MusicFileInfo *get_music_file_info(char *basename, int music)
4818 {
4819   return get_music_file_info_ext(basename, music, FALSE);
4820 }
4821
4822 static struct MusicFileInfo *get_sound_file_info(char *basename, int sound)
4823 {
4824   return get_music_file_info_ext(basename, sound, TRUE);
4825 }
4826
4827 static boolean music_info_listed_ext(struct MusicFileInfo *list,
4828                                      char *basename, boolean is_sound)
4829 {
4830   for (; list != NULL; list = list->next)
4831     if (list->is_sound == is_sound && strcmp(list->basename, basename) == 0)
4832       return TRUE;
4833
4834   return FALSE;
4835 }
4836
4837 static boolean music_info_listed(struct MusicFileInfo *list, char *basename)
4838 {
4839   return music_info_listed_ext(list, basename, FALSE);
4840 }
4841
4842 static boolean sound_info_listed(struct MusicFileInfo *list, char *basename)
4843 {
4844   return music_info_listed_ext(list, basename, TRUE);
4845 }
4846
4847 void LoadMusicInfo()
4848 {
4849   char *music_directory = getCustomMusicDirectory();
4850   int num_music = getMusicListSize();
4851   int num_music_noconf = 0;
4852   int num_sounds = getSoundListSize();
4853   DIR *dir;
4854   struct dirent *dir_entry;
4855   struct FileInfo *music, *sound;
4856   struct MusicFileInfo *next, **new;
4857   int i;
4858
4859   while (music_file_info != NULL)
4860   {
4861     next = music_file_info->next;
4862
4863     checked_free(music_file_info->basename);
4864
4865     checked_free(music_file_info->title_header);
4866     checked_free(music_file_info->artist_header);
4867     checked_free(music_file_info->album_header);
4868     checked_free(music_file_info->year_header);
4869
4870     checked_free(music_file_info->title);
4871     checked_free(music_file_info->artist);
4872     checked_free(music_file_info->album);
4873     checked_free(music_file_info->year);
4874
4875     free(music_file_info);
4876
4877     music_file_info = next;
4878   }
4879
4880   new = &music_file_info;
4881
4882 #if 0
4883   printf("::: num_music == %d\n", num_music);
4884 #endif
4885
4886   for (i = 0; i < num_music; i++)
4887   {
4888     music = getMusicListEntry(i);
4889
4890 #if 0
4891     printf("::: %d [%08x]\n", i, music->filename);
4892 #endif
4893
4894     if (music->filename == NULL)
4895       continue;
4896
4897     if (strcmp(music->filename, UNDEFINED_FILENAME) == 0)
4898       continue;
4899
4900     /* a configured file may be not recognized as music */
4901     if (!FileIsMusic(music->filename))
4902       continue;
4903
4904 #if 0
4905     printf("::: -> '%s' (configured)\n", music->filename);
4906 #endif
4907
4908     if (!music_info_listed(music_file_info, music->filename))
4909     {
4910       *new = get_music_file_info(music->filename, i);
4911       if (*new != NULL)
4912         new = &(*new)->next;
4913     }
4914   }
4915
4916   if ((dir = opendir(music_directory)) == NULL)
4917   {
4918     Error(ERR_WARN, "cannot read music directory '%s'", music_directory);
4919     return;
4920   }
4921
4922   while ((dir_entry = readdir(dir)) != NULL)    /* loop until last dir entry */
4923   {
4924     char *basename = dir_entry->d_name;
4925     boolean music_already_used = FALSE;
4926     int i;
4927
4928     /* skip all music files that are configured in music config file */
4929     for (i = 0; i < num_music; i++)
4930     {
4931       music = getMusicListEntry(i);
4932
4933       if (music->filename == NULL)
4934         continue;
4935
4936       if (strcmp(basename, music->filename) == 0)
4937       {
4938         music_already_used = TRUE;
4939         break;
4940       }
4941     }
4942
4943     if (music_already_used)
4944       continue;
4945
4946     if (!FileIsMusic(basename))
4947       continue;
4948
4949 #if 0
4950     printf("::: -> '%s' (found in directory)\n", basename);
4951 #endif
4952
4953     if (!music_info_listed(music_file_info, basename))
4954     {
4955       *new = get_music_file_info(basename, MAP_NOCONF_MUSIC(num_music_noconf));
4956       if (*new != NULL)
4957         new = &(*new)->next;
4958     }
4959
4960     num_music_noconf++;
4961   }
4962
4963   closedir(dir);
4964
4965   for (i = 0; i < num_sounds; i++)
4966   {
4967     sound = getSoundListEntry(i);
4968
4969     if (sound->filename == NULL)
4970       continue;
4971
4972     if (strcmp(sound->filename, UNDEFINED_FILENAME) == 0)
4973       continue;
4974
4975     /* a configured file may be not recognized as sound */
4976     if (!FileIsSound(sound->filename))
4977       continue;
4978
4979 #if 0
4980     printf("::: -> '%s' (configured)\n", sound->filename);
4981 #endif
4982
4983     if (!sound_info_listed(music_file_info, sound->filename))
4984     {
4985       *new = get_sound_file_info(sound->filename, i);
4986       if (*new != NULL)
4987         new = &(*new)->next;
4988     }
4989   }
4990
4991 #if 0
4992   /* TEST-ONLY */
4993   for (next = music_file_info; next != NULL; next = next->next)
4994     printf("::: title == '%s'\n", next->title);
4995 #endif
4996 }
4997
4998 void add_helpanim_entry(int element, int action, int direction, int delay,
4999                         int *num_list_entries)
5000 {
5001   struct HelpAnimInfo *new_list_entry;
5002   (*num_list_entries)++;
5003
5004   helpanim_info =
5005     checked_realloc(helpanim_info,
5006                     *num_list_entries * sizeof(struct HelpAnimInfo));
5007   new_list_entry = &helpanim_info[*num_list_entries - 1];
5008
5009   new_list_entry->element = element;
5010   new_list_entry->action = action;
5011   new_list_entry->direction = direction;
5012   new_list_entry->delay = delay;
5013 }
5014
5015 void print_unknown_token(char *filename, char *token, int token_nr)
5016 {
5017   if (token_nr == 0)
5018   {
5019     Error(ERR_RETURN_LINE, "-");
5020     Error(ERR_RETURN, "warning: unknown token(s) found in config file:");
5021     Error(ERR_RETURN, "- config file: '%s'", filename);
5022   }
5023
5024   Error(ERR_RETURN, "- token: '%s'", token);
5025 }
5026
5027 void print_unknown_token_end(int token_nr)
5028 {
5029   if (token_nr > 0)
5030     Error(ERR_RETURN_LINE, "-");
5031 }
5032
5033 void LoadHelpAnimInfo()
5034 {
5035   char *filename = getHelpAnimFilename();
5036   SetupFileList *setup_file_list = NULL, *list;
5037   SetupFileHash *element_hash, *action_hash, *direction_hash;
5038   int num_list_entries = 0;
5039   int num_unknown_tokens = 0;
5040   int i;
5041
5042   if (fileExists(filename))
5043     setup_file_list = loadSetupFileList(filename);
5044
5045   if (setup_file_list == NULL)
5046   {
5047     /* use reliable default values from static configuration */
5048     SetupFileList *insert_ptr;
5049
5050     insert_ptr = setup_file_list =
5051       newSetupFileList(helpanim_config[0].token,
5052                        helpanim_config[0].value);
5053
5054     for (i = 1; helpanim_config[i].token; i++)
5055       insert_ptr = addListEntry(insert_ptr,
5056                                 helpanim_config[i].token,
5057                                 helpanim_config[i].value);
5058   }
5059
5060   element_hash   = newSetupFileHash();
5061   action_hash    = newSetupFileHash();
5062   direction_hash = newSetupFileHash();
5063
5064   for (i = 0; i < MAX_NUM_ELEMENTS; i++)
5065     setHashEntry(element_hash, element_info[i].token_name, i_to_a(i));
5066
5067   for (i = 0; i < NUM_ACTIONS; i++)
5068     setHashEntry(action_hash, element_action_info[i].suffix,
5069                  i_to_a(element_action_info[i].value));
5070
5071   /* do not store direction index (bit) here, but direction value! */
5072   for (i = 0; i < NUM_DIRECTIONS; i++)
5073     setHashEntry(direction_hash, element_direction_info[i].suffix,
5074                  i_to_a(1 << element_direction_info[i].value));
5075
5076   for (list = setup_file_list; list != NULL; list = list->next)
5077   {
5078     char *element_token, *action_token, *direction_token;
5079     char *element_value, *action_value, *direction_value;
5080     int delay = atoi(list->value);
5081
5082     if (strcmp(list->token, "end") == 0)
5083     {
5084       add_helpanim_entry(HELPANIM_LIST_NEXT, -1, -1, -1, &num_list_entries);
5085
5086       continue;
5087     }
5088
5089     /* first try to break element into element/action/direction parts;
5090        if this does not work, also accept combined "element[.act][.dir]"
5091        elements (like "dynamite.active"), which are unique elements */
5092
5093     if (strchr(list->token, '.') == NULL)       /* token contains no '.' */
5094     {
5095       element_value = getHashEntry(element_hash, list->token);
5096       if (element_value != NULL)        /* element found */
5097         add_helpanim_entry(atoi(element_value), -1, -1, delay,
5098                            &num_list_entries);
5099       else
5100       {
5101         /* no further suffixes found -- this is not an element */
5102         print_unknown_token(filename, list->token, num_unknown_tokens++);
5103       }
5104
5105       continue;
5106     }
5107
5108     /* token has format "<prefix>.<something>" */
5109
5110     action_token = strchr(list->token, '.');    /* suffix may be action ... */
5111     direction_token = action_token;             /* ... or direction */
5112
5113     element_token = getStringCopy(list->token);
5114     *strchr(element_token, '.') = '\0';
5115
5116     element_value = getHashEntry(element_hash, element_token);
5117
5118     if (element_value == NULL)          /* this is no element */
5119     {
5120       element_value = getHashEntry(element_hash, list->token);
5121       if (element_value != NULL)        /* combined element found */
5122         add_helpanim_entry(atoi(element_value), -1, -1, delay,
5123                            &num_list_entries);
5124       else
5125         print_unknown_token(filename, list->token, num_unknown_tokens++);
5126
5127       free(element_token);
5128
5129       continue;
5130     }
5131
5132     action_value = getHashEntry(action_hash, action_token);
5133
5134     if (action_value != NULL)           /* action found */
5135     {
5136       add_helpanim_entry(atoi(element_value), atoi(action_value), -1, delay,
5137                     &num_list_entries);
5138
5139       free(element_token);
5140
5141       continue;
5142     }
5143
5144     direction_value = getHashEntry(direction_hash, direction_token);
5145
5146     if (direction_value != NULL)        /* direction found */
5147     {
5148       add_helpanim_entry(atoi(element_value), -1, atoi(direction_value), delay,
5149                          &num_list_entries);
5150
5151       free(element_token);
5152
5153       continue;
5154     }
5155
5156     if (strchr(action_token + 1, '.') == NULL)
5157     {
5158       /* no further suffixes found -- this is not an action nor direction */
5159
5160       element_value = getHashEntry(element_hash, list->token);
5161       if (element_value != NULL)        /* combined element found */
5162         add_helpanim_entry(atoi(element_value), -1, -1, delay,
5163                            &num_list_entries);
5164       else
5165         print_unknown_token(filename, list->token, num_unknown_tokens++);
5166
5167       free(element_token);
5168
5169       continue;
5170     }
5171
5172     /* token has format "<prefix>.<suffix>.<something>" */
5173
5174     direction_token = strchr(action_token + 1, '.');
5175
5176     action_token = getStringCopy(action_token);
5177     *strchr(action_token + 1, '.') = '\0';
5178
5179     action_value = getHashEntry(action_hash, action_token);
5180
5181     if (action_value == NULL)           /* this is no action */
5182     {
5183       element_value = getHashEntry(element_hash, list->token);
5184       if (element_value != NULL)        /* combined element found */
5185         add_helpanim_entry(atoi(element_value), -1, -1, delay,
5186                            &num_list_entries);
5187       else
5188         print_unknown_token(filename, list->token, num_unknown_tokens++);
5189
5190       free(element_token);
5191       free(action_token);
5192
5193       continue;
5194     }
5195
5196     direction_value = getHashEntry(direction_hash, direction_token);
5197
5198     if (direction_value != NULL)        /* direction found */
5199     {
5200       add_helpanim_entry(atoi(element_value), atoi(action_value),
5201                          atoi(direction_value), delay, &num_list_entries);
5202
5203       free(element_token);
5204       free(action_token);
5205
5206       continue;
5207     }
5208
5209     /* this is no direction */
5210
5211     element_value = getHashEntry(element_hash, list->token);
5212     if (element_value != NULL)          /* combined element found */
5213       add_helpanim_entry(atoi(element_value), -1, -1, delay,
5214                          &num_list_entries);
5215     else
5216       print_unknown_token(filename, list->token, num_unknown_tokens++);
5217
5218     free(element_token);
5219     free(action_token);
5220   }
5221
5222   print_unknown_token_end(num_unknown_tokens);
5223
5224   add_helpanim_entry(HELPANIM_LIST_NEXT, -1, -1, -1, &num_list_entries);
5225   add_helpanim_entry(HELPANIM_LIST_END,  -1, -1, -1, &num_list_entries);
5226
5227   freeSetupFileList(setup_file_list);
5228   freeSetupFileHash(element_hash);
5229   freeSetupFileHash(action_hash);
5230   freeSetupFileHash(direction_hash);
5231
5232 #if 0
5233   /* TEST ONLY */
5234   for (i = 0; i < num_list_entries; i++)
5235     printf("::: %d, %d, %d => %d\n",
5236            helpanim_info[i].element,
5237            helpanim_info[i].action,
5238            helpanim_info[i].direction,
5239            helpanim_info[i].delay);
5240 #endif
5241 }
5242
5243 void LoadHelpTextInfo()
5244 {
5245   char *filename = getHelpTextFilename();
5246   int i;
5247
5248   if (helptext_info != NULL)
5249   {
5250     freeSetupFileHash(helptext_info);
5251     helptext_info = NULL;
5252   }
5253
5254   if (fileExists(filename))
5255     helptext_info = loadSetupFileHash(filename);
5256
5257   if (helptext_info == NULL)
5258   {
5259     /* use reliable default values from static configuration */
5260     helptext_info = newSetupFileHash();
5261
5262     for (i = 0; helptext_config[i].token; i++)
5263       setHashEntry(helptext_info,
5264                    helptext_config[i].token,
5265                    helptext_config[i].value);
5266   }
5267
5268 #if 0
5269   /* TEST ONLY */
5270   BEGIN_HASH_ITERATION(helptext_info, itr)
5271   {
5272     printf("::: '%s' => '%s'\n",
5273            HASH_ITERATION_TOKEN(itr), HASH_ITERATION_VALUE(itr));
5274   }
5275   END_HASH_ITERATION(hash, itr)
5276 #endif
5277 }
5278
5279
5280 /* ------------------------------------------------------------------------- *
5281  * convert levels
5282  * ------------------------------------------------------------------------- */
5283
5284 #define MAX_NUM_CONVERT_LEVELS          1000
5285
5286 void ConvertLevels()
5287 {
5288   static LevelDirTree *convert_leveldir = NULL;
5289   static int convert_level_nr = -1;
5290   static int num_levels_handled = 0;
5291   static int num_levels_converted = 0;
5292   static boolean levels_failed[MAX_NUM_CONVERT_LEVELS];
5293   int i;
5294
5295   convert_leveldir = getTreeInfoFromIdentifier(leveldir_first,
5296                                                global.convert_leveldir);
5297
5298   if (convert_leveldir == NULL)
5299     Error(ERR_EXIT, "no such level identifier: '%s'",
5300           global.convert_leveldir);
5301
5302   leveldir_current = convert_leveldir;
5303
5304   if (global.convert_level_nr != -1)
5305   {
5306     convert_leveldir->first_level = global.convert_level_nr;
5307     convert_leveldir->last_level  = global.convert_level_nr;
5308   }
5309
5310   convert_level_nr = convert_leveldir->first_level;
5311
5312   printf_line("=", 79);
5313   printf("Converting levels\n");
5314   printf_line("-", 79);
5315   printf("Level series identifier: '%s'\n", convert_leveldir->identifier);
5316   printf("Level series name:       '%s'\n", convert_leveldir->name);
5317   printf("Level series author:     '%s'\n", convert_leveldir->author);
5318   printf("Number of levels:        %d\n",   convert_leveldir->levels);
5319   printf_line("=", 79);
5320   printf("\n");
5321
5322   for (i = 0; i < MAX_NUM_CONVERT_LEVELS; i++)
5323     levels_failed[i] = FALSE;
5324
5325   while (convert_level_nr <= convert_leveldir->last_level)
5326   {
5327     char *level_filename;
5328     boolean new_level;
5329
5330     level_nr = convert_level_nr++;
5331
5332     printf("Level %03d: ", level_nr);
5333
5334     LoadLevel(level_nr);
5335     if (level.no_valid_file)
5336     {
5337       printf("(no level)\n");
5338       continue;
5339     }
5340
5341     printf("converting level ... ");
5342
5343     level_filename = getDefaultLevelFilename(level_nr);
5344     new_level = !fileExists(level_filename);
5345
5346     if (new_level)
5347     {
5348       SaveLevel(level_nr);
5349
5350       num_levels_converted++;
5351
5352       printf("converted.\n");
5353     }
5354     else
5355     {
5356       if (level_nr >= 0 && level_nr < MAX_NUM_CONVERT_LEVELS)
5357         levels_failed[level_nr] = TRUE;
5358
5359       printf("NOT CONVERTED -- LEVEL ALREADY EXISTS.\n");
5360     }
5361
5362     num_levels_handled++;
5363   }
5364
5365   printf("\n");
5366   printf_line("=", 79);
5367   printf("Number of levels handled: %d\n", num_levels_handled);
5368   printf("Number of levels converted: %d (%d%%)\n", num_levels_converted,
5369          (num_levels_handled ?
5370           num_levels_converted * 100 / num_levels_handled : 0));
5371   printf_line("-", 79);
5372   printf("Summary (for automatic parsing by scripts):\n");
5373   printf("LEVELDIR '%s', CONVERTED %d/%d (%d%%)",
5374          convert_leveldir->identifier, num_levels_converted,
5375          num_levels_handled,
5376          (num_levels_handled ?
5377           num_levels_converted * 100 / num_levels_handled : 0));
5378
5379   if (num_levels_handled != num_levels_converted)
5380   {
5381     printf(", FAILED:");
5382     for (i = 0; i < MAX_NUM_CONVERT_LEVELS; i++)
5383       if (levels_failed[i])
5384         printf(" %03d", i);
5385   }
5386
5387   printf("\n");
5388   printf_line("=", 79);
5389
5390   CloseAllAndExit(0);
5391 }