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