src/files.c

   1 // ============================================================================
   2 // Rocks'n'Diamonds - McDuffin Strikes Back!
   3 // ----------------------------------------------------------------------------
   4 // (c) 1995-2014 by Artsoft Entertainment
   5 //                  Holger Schemel
   6 //                  info@artsoft.org
   7 //                  http://www.artsoft.org/
   8 // ----------------------------------------------------------------------------
   9 // files.c
  10 // ============================================================================
  11
  12 #include <ctype.h>
  13 #include <sys/stat.h>
  14 #include <dirent.h>
  15 #include <math.h>
  16
  17 #include "libgame/libgame.h"
  18
  19 #include "files.h"
  20 #include "init.h"
  21 #include "tools.h"
  22 #include "tape.h"
  23 #include "config.h"
  24
  25 #define ENABLE_UNUSED_CODE      0       /* currently unused functions */
  26 #define ENABLE_HISTORIC_CHUNKS  0       /* only for historic reference */
  27 #define ENABLE_RESERVED_CODE    0       /* reserved for later use */
  28
  29 #define CHUNK_ID_LEN            4       /* IFF style chunk id length  */
  30 #define CHUNK_SIZE_UNDEFINED    0       /* undefined chunk size == 0  */
  31 #define CHUNK_SIZE_NONE         -1      /* do not write chunk size    */
  32
  33 #define LEVEL_CHUNK_NAME_SIZE   MAX_LEVEL_NAME_LEN
  34 #define LEVEL_CHUNK_AUTH_SIZE   MAX_LEVEL_AUTHOR_LEN
  35
  36 #define LEVEL_CHUNK_VERS_SIZE   8       /* size of file version chunk */
  37 #define LEVEL_CHUNK_DATE_SIZE   4       /* size of file date chunk    */
  38 #define LEVEL_CHUNK_HEAD_SIZE   80      /* size of level file header  */
  39 #define LEVEL_CHUNK_HEAD_UNUSED 0       /* unused level header bytes  */
  40 #define LEVEL_CHUNK_CNT2_SIZE   160     /* size of level CNT2 chunk   */
  41 #define LEVEL_CHUNK_CNT2_UNUSED 11      /* unused CNT2 chunk bytes    */
  42 #define LEVEL_CHUNK_CNT3_HEADER 16      /* size of level CNT3 header  */
  43 #define LEVEL_CHUNK_CNT3_UNUSED 10      /* unused CNT3 chunk bytes    */
  44 #define LEVEL_CPART_CUS3_SIZE   134     /* size of CUS3 chunk part    */
  45 #define LEVEL_CPART_CUS3_UNUSED 15      /* unused CUS3 bytes / part   */
  46 #define LEVEL_CHUNK_GRP1_SIZE   74      /* size of level GRP1 chunk   */
  47
  48 /* (element number, number of change pages, change page number) */
  49 #define LEVEL_CHUNK_CUSX_UNCHANGED      (2 + (1 + 1) + (1 + 1))
  50
  51 /* (element number only) */
  52 #define LEVEL_CHUNK_GRPX_UNCHANGED      2
  53 #define LEVEL_CHUNK_NOTE_UNCHANGED      2
  54
  55 /* (nothing at all if unchanged) */
  56 #define LEVEL_CHUNK_ELEM_UNCHANGED      0
  57
  58 #define TAPE_CHUNK_VERS_SIZE    8       /* size of file version chunk */
  59 #define TAPE_CHUNK_HEAD_SIZE    20      /* size of tape file header   */
  60 #define TAPE_CHUNK_HEAD_UNUSED  3       /* unused tape header bytes   */
  61
  62 #define LEVEL_CHUNK_CNT3_SIZE(x)         (LEVEL_CHUNK_CNT3_HEADER + (x))
  63 #define LEVEL_CHUNK_CUS3_SIZE(x)         (2 + (x) * LEVEL_CPART_CUS3_SIZE)
  64 #define LEVEL_CHUNK_CUS4_SIZE(x)         (96 + (x) * 48)
  65
  66 /* file identifier strings */
  67 #define LEVEL_COOKIE_TMPL               "ROCKSNDIAMONDS_LEVEL_FILE_VERSION_x.x"
  68 #define TAPE_COOKIE_TMPL                "ROCKSNDIAMONDS_TAPE_FILE_VERSION_x.x"
  69 #define SCORE_COOKIE                    "ROCKSNDIAMONDS_SCORE_FILE_VERSION_1.2"
  70
  71 /* values for deciding when (not) to save configuration data */
  72 #define SAVE_CONF_NEVER                 0
  73 #define SAVE_CONF_ALWAYS                1
  74 #define SAVE_CONF_WHEN_CHANGED          -1
  75
  76 /* values for chunks using micro chunks */
  77 #define CONF_MASK_1_BYTE                0x00
  78 #define CONF_MASK_2_BYTE                0x40
  79 #define CONF_MASK_4_BYTE                0x80
  80 #define CONF_MASK_MULTI_BYTES           0xc0
  81
  82 #define CONF_MASK_BYTES                 0xc0
  83 #define CONF_MASK_TOKEN                 0x3f
  84
  85 #define CONF_VALUE_1_BYTE(x)            (CONF_MASK_1_BYTE       | (x))
  86 #define CONF_VALUE_2_BYTE(x)            (CONF_MASK_2_BYTE       | (x))
  87 #define CONF_VALUE_4_BYTE(x)            (CONF_MASK_4_BYTE       | (x))
  88 #define CONF_VALUE_MULTI_BYTES(x)       (CONF_MASK_MULTI_BYTES  | (x))
  89
  90 /* these definitions are just for convenience of use and readability */
  91 #define CONF_VALUE_8_BIT(x)             CONF_VALUE_1_BYTE(x)
  92 #define CONF_VALUE_16_BIT(x)            CONF_VALUE_2_BYTE(x)
  93 #define CONF_VALUE_32_BIT(x)            CONF_VALUE_4_BYTE(x)
  94 #define CONF_VALUE_BYTES(x)             CONF_VALUE_MULTI_BYTES(x)
  95
  96 #define CONF_VALUE_NUM_BYTES(x)         ((x) == CONF_MASK_1_BYTE ? 1 :  \
  97                                          (x) == CONF_MASK_2_BYTE ? 2 :  \
  98                                          (x) == CONF_MASK_4_BYTE ? 4 : 0)
  99
 100 #define CONF_CONTENT_NUM_ELEMENTS       (3 * 3)
 101 #define CONF_CONTENT_NUM_BYTES          (CONF_CONTENT_NUM_ELEMENTS * 2)
 102 #define CONF_ELEMENT_NUM_BYTES          (2)
 103
 104 #define CONF_ENTITY_NUM_BYTES(t)        ((t) == TYPE_ELEMENT ||         \
 105                                          (t) == TYPE_ELEMENT_LIST ?     \
 106                                          CONF_ELEMENT_NUM_BYTES :       \
 107                                          (t) == TYPE_CONTENT ||         \
 108                                          (t) == TYPE_CONTENT_LIST ?     \
 109                                          CONF_CONTENT_NUM_BYTES : 1)
 110
 111 #define CONF_ELEMENT_BYTE_POS(i)        ((i) * CONF_ELEMENT_NUM_BYTES)
 112 #define CONF_ELEMENTS_ELEMENT(b,i)     ((b[CONF_ELEMENT_BYTE_POS(i)] << 8) |  \
 113                                         (b[CONF_ELEMENT_BYTE_POS(i) + 1]))
 114
 115 #define CONF_CONTENT_ELEMENT_POS(c,x,y) ((c) * CONF_CONTENT_NUM_ELEMENTS +    \
 116                                          (y) * 3 + (x))
 117 #define CONF_CONTENT_BYTE_POS(c,x,y)    (CONF_CONTENT_ELEMENT_POS(c,x,y) *    \
 118                                          CONF_ELEMENT_NUM_BYTES)
 119 #define CONF_CONTENTS_ELEMENT(b,c,x,y) ((b[CONF_CONTENT_BYTE_POS(c,x,y)]<< 8)|\
 120                                         (b[CONF_CONTENT_BYTE_POS(c,x,y) + 1]))
 121
 122 /* temporary variables used to store pointers to structure members */
 123 static struct LevelInfo li;
 124 static struct ElementInfo xx_ei, yy_ei;
 125 static struct ElementChangeInfo xx_change;
 126 static struct ElementGroupInfo xx_group;
 127 static struct EnvelopeInfo xx_envelope;
 128 static unsigned int xx_event_bits[NUM_CE_BITFIELDS];
 129 static char xx_default_description[MAX_ELEMENT_NAME_LEN + 1];
 130 static int xx_num_contents;
 131 static int xx_current_change_page;
 132 static char xx_default_string_empty[1] = "";
 133 static int xx_string_length_unused;
 134
 135 struct LevelFileConfigInfo
 136 {
 137   int element;                  /* element for which data is to be stored */
 138   int save_type;                /* save data always, never or when changed */
 139   int data_type;                /* data type (used internally, not stored) */
 140   int conf_type;                /* micro chunk identifier (stored in file) */
 141
 142   /* (mandatory) */
 143   void *value;                  /* variable that holds the data to be stored */
 144   int default_value;            /* initial default value for this variable */
 145
 146   /* (optional) */
 147   void *value_copy;             /* variable that holds the data to be copied */
 148   void *num_entities;           /* number of entities for multi-byte data */
 149   int default_num_entities;     /* default number of entities for this data */
 150   int max_num_entities;         /* maximal number of entities for this data */
 151   char *default_string;         /* optional default string for string data */
 152 };
 153
 154 static struct LevelFileConfigInfo chunk_config_INFO[] =
 155 {
 156   /* ---------- values not related to single elements ----------------------- */
 157
 158   {
 159     -1,                                 SAVE_CONF_ALWAYS,
 160     TYPE_INTEGER,                       CONF_VALUE_8_BIT(1),
 161     &li.game_engine_type,               GAME_ENGINE_TYPE_RND
 162   },
 163
 164   {
 165     -1,                                 SAVE_CONF_ALWAYS,
 166     TYPE_INTEGER,                       CONF_VALUE_16_BIT(1),
 167     &li.fieldx,                         STD_LEV_FIELDX
 168   },
 169   {
 170     -1,                                 SAVE_CONF_ALWAYS,
 171     TYPE_INTEGER,                       CONF_VALUE_16_BIT(2),
 172     &li.fieldy,                         STD_LEV_FIELDY
 173   },
 174
 175   {
 176     -1,                                 SAVE_CONF_ALWAYS,
 177     TYPE_INTEGER,                       CONF_VALUE_16_BIT(3),
 178     &li.time,                           100
 179   },
 180
 181   {
 182     -1,                                 SAVE_CONF_ALWAYS,
 183     TYPE_INTEGER,                       CONF_VALUE_16_BIT(4),
 184     &li.gems_needed,                    0
 185   },
 186
 187   {
 188     -1,                                 -1,
 189     TYPE_INTEGER,                       CONF_VALUE_32_BIT(2),
 190     &li.random_seed,                    0
 191   },
 192
 193   {
 194     -1,                                 -1,
 195     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(2),
 196     &li.use_step_counter,               FALSE
 197   },
 198
 199   {
 200     -1,                                 -1,
 201     TYPE_BITFIELD,                      CONF_VALUE_8_BIT(4),
 202     &li.wind_direction_initial,         MV_NONE
 203   },
 204
 205   {
 206     -1,                                 -1,
 207     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(5),
 208     &li.em_slippery_gems,               FALSE
 209   },
 210
 211   {
 212     -1,                                 -1,
 213     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(6),
 214     &li.use_custom_template,            FALSE
 215   },
 216
 217   {
 218     -1,                                 -1,
 219     TYPE_BITFIELD,                      CONF_VALUE_32_BIT(1),
 220     &li.can_move_into_acid_bits,        ~0      /* default: everything can */
 221   },
 222
 223   {
 224     -1,                                 -1,
 225     TYPE_BITFIELD,                      CONF_VALUE_8_BIT(7),
 226     &li.dont_collide_with_bits,         ~0      /* default: always deadly */
 227   },
 228
 229   {
 230     -1,                                 -1,
 231     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(8),
 232     &li.em_explodes_by_fire,            FALSE
 233   },
 234
 235   {
 236     -1,                                 -1,
 237     TYPE_INTEGER,                       CONF_VALUE_16_BIT(5),
 238     &li.score[SC_TIME_BONUS],           1
 239   },
 240
 241   {
 242     -1,                                 -1,
 243     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(9),
 244     &li.auto_exit_sokoban,              FALSE
 245   },
 246
 247   {
 248     -1,                                 -1,
 249     -1,                                 -1,
 250     NULL,                               -1
 251   }
 252 };
 253
 254 static struct LevelFileConfigInfo chunk_config_ELEM[] =
 255 {
 256   /* (these values are the same for each player) */
 257   {
 258     EL_PLAYER_1,                        -1,
 259     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(1),
 260     &li.block_last_field,               FALSE   /* default case for EM levels */
 261   },
 262   {
 263     EL_PLAYER_1,                        -1,
 264     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(2),
 265     &li.sp_block_last_field,            TRUE    /* default case for SP levels */
 266   },
 267   {
 268     EL_PLAYER_1,                        -1,
 269     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(3),
 270     &li.instant_relocation,             FALSE
 271   },
 272   {
 273     EL_PLAYER_1,                        -1,
 274     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(4),
 275     &li.can_pass_to_walkable,           FALSE
 276   },
 277   {
 278     EL_PLAYER_1,                        -1,
 279     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(5),
 280     &li.block_snap_field,               TRUE
 281   },
 282   {
 283     EL_PLAYER_1,                        -1,
 284     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(6),
 285     &li.continuous_snapping,            TRUE
 286   },
 287   {
 288     EL_PLAYER_1,                        -1,
 289     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(12),
 290     &li.shifted_relocation,             FALSE
 291   },
 292   {
 293     EL_PLAYER_1,                        -1,
 294     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(15),
 295     &li.lazy_relocation,                FALSE
 296   },
 297
 298   /* (these values are different for each player) */
 299   {
 300     EL_PLAYER_1,                        -1,
 301     TYPE_INTEGER,                       CONF_VALUE_8_BIT(7),
 302     &li.initial_player_stepsize[0],     STEPSIZE_NORMAL
 303   },
 304   {
 305     EL_PLAYER_1,                        -1,
 306     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(8),
 307     &li.initial_player_gravity[0],      FALSE
 308   },
 309   {
 310     EL_PLAYER_1,                        -1,
 311     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(9),
 312     &li.use_start_element[0],           FALSE
 313   },
 314   {
 315     EL_PLAYER_1,                        -1,
 316     TYPE_ELEMENT,                       CONF_VALUE_16_BIT(1),
 317     &li.start_element[0],               EL_PLAYER_1
 318   },
 319   {
 320     EL_PLAYER_1,                        -1,
 321     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(10),
 322     &li.use_artwork_element[0],         FALSE
 323   },
 324   {
 325     EL_PLAYER_1,                        -1,
 326     TYPE_ELEMENT,                       CONF_VALUE_16_BIT(2),
 327     &li.artwork_element[0],             EL_PLAYER_1
 328   },
 329   {
 330     EL_PLAYER_1,                        -1,
 331     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(11),
 332     &li.use_explosion_element[0],       FALSE
 333   },
 334   {
 335     EL_PLAYER_1,                        -1,
 336     TYPE_ELEMENT,                       CONF_VALUE_16_BIT(3),
 337     &li.explosion_element[0],           EL_PLAYER_1
 338   },
 339   {
 340     EL_PLAYER_1,                        -1,
 341     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(13),
 342     &li.use_initial_inventory[0],       FALSE
 343   },
 344   {
 345     EL_PLAYER_1,                        -1,
 346     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(14),
 347     &li.initial_inventory_size[0],      1
 348   },
 349   {
 350     EL_PLAYER_1,                        -1,
 351     TYPE_ELEMENT_LIST,                  CONF_VALUE_BYTES(1),
 352     &li.initial_inventory_content[0][0],EL_EMPTY, NULL,
 353     &li.initial_inventory_size[0],      1, MAX_INITIAL_INVENTORY_SIZE
 354   },
 355
 356   {
 357     EL_PLAYER_2,                        -1,
 358     TYPE_INTEGER,                       CONF_VALUE_8_BIT(7),
 359     &li.initial_player_stepsize[1],     STEPSIZE_NORMAL
 360   },
 361   {
 362     EL_PLAYER_2,                        -1,
 363     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(8),
 364     &li.initial_player_gravity[1],      FALSE
 365   },
 366   {
 367     EL_PLAYER_2,                        -1,
 368     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(9),
 369     &li.use_start_element[1],           FALSE
 370   },
 371   {
 372     EL_PLAYER_2,                        -1,
 373     TYPE_ELEMENT,                       CONF_VALUE_16_BIT(1),
 374     &li.start_element[1],               EL_PLAYER_2
 375   },
 376   {
 377     EL_PLAYER_2,                        -1,
 378     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(10),
 379     &li.use_artwork_element[1],         FALSE
 380   },
 381   {
 382     EL_PLAYER_2,                        -1,
 383     TYPE_ELEMENT,                       CONF_VALUE_16_BIT(2),
 384     &li.artwork_element[1],             EL_PLAYER_2
 385   },
 386   {
 387     EL_PLAYER_2,                        -1,
 388     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(11),
 389     &li.use_explosion_element[1],       FALSE
 390   },
 391   {
 392     EL_PLAYER_2,                        -1,
 393     TYPE_ELEMENT,                       CONF_VALUE_16_BIT(3),
 394     &li.explosion_element[1],           EL_PLAYER_2
 395   },
 396   {
 397     EL_PLAYER_2,                        -1,
 398     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(13),
 399     &li.use_initial_inventory[1],       FALSE
 400   },
 401   {
 402     EL_PLAYER_2,                        -1,
 403     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(14),
 404     &li.initial_inventory_size[1],      1
 405   },
 406   {
 407     EL_PLAYER_2,                        -1,
 408     TYPE_ELEMENT_LIST,                  CONF_VALUE_BYTES(1),
 409     &li.initial_inventory_content[1][0],EL_EMPTY, NULL,
 410     &li.initial_inventory_size[1],      1, MAX_INITIAL_INVENTORY_SIZE
 411   },
 412
 413   {
 414     EL_PLAYER_3,                        -1,
 415     TYPE_INTEGER,                       CONF_VALUE_8_BIT(7),
 416     &li.initial_player_stepsize[2],     STEPSIZE_NORMAL
 417   },
 418   {
 419     EL_PLAYER_3,                        -1,
 420     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(8),
 421     &li.initial_player_gravity[2],      FALSE
 422   },
 423   {
 424     EL_PLAYER_3,                        -1,
 425     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(9),
 426     &li.use_start_element[2],           FALSE
 427   },
 428   {
 429     EL_PLAYER_3,                        -1,
 430     TYPE_ELEMENT,                       CONF_VALUE_16_BIT(1),
 431     &li.start_element[2],               EL_PLAYER_3
 432   },
 433   {
 434     EL_PLAYER_3,                        -1,
 435     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(10),
 436     &li.use_artwork_element[2],         FALSE
 437   },
 438   {
 439     EL_PLAYER_3,                        -1,
 440     TYPE_ELEMENT,                       CONF_VALUE_16_BIT(2),
 441     &li.artwork_element[2],             EL_PLAYER_3
 442   },
 443   {
 444     EL_PLAYER_3,                        -1,
 445     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(11),
 446     &li.use_explosion_element[2],       FALSE
 447   },
 448   {
 449     EL_PLAYER_3,                        -1,
 450     TYPE_ELEMENT,                       CONF_VALUE_16_BIT(3),
 451     &li.explosion_element[2],           EL_PLAYER_3
 452   },
 453   {
 454     EL_PLAYER_3,                        -1,
 455     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(13),
 456     &li.use_initial_inventory[2],       FALSE
 457   },
 458   {
 459     EL_PLAYER_3,                        -1,
 460     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(14),
 461     &li.initial_inventory_size[2],      1
 462   },
 463   {
 464     EL_PLAYER_3,                        -1,
 465     TYPE_ELEMENT_LIST,                  CONF_VALUE_BYTES(1),
 466     &li.initial_inventory_content[2][0],EL_EMPTY, NULL,
 467     &li.initial_inventory_size[2],      1, MAX_INITIAL_INVENTORY_SIZE
 468   },
 469
 470   {
 471     EL_PLAYER_4,                        -1,
 472     TYPE_INTEGER,                       CONF_VALUE_8_BIT(7),
 473     &li.initial_player_stepsize[3],     STEPSIZE_NORMAL
 474   },
 475   {
 476     EL_PLAYER_4,                        -1,
 477     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(8),
 478     &li.initial_player_gravity[3],      FALSE
 479   },
 480   {
 481     EL_PLAYER_4,                        -1,
 482     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(9),
 483     &li.use_start_element[3],           FALSE
 484   },
 485   {
 486     EL_PLAYER_4,                        -1,
 487     TYPE_ELEMENT,                       CONF_VALUE_16_BIT(1),
 488     &li.start_element[3],               EL_PLAYER_4
 489   },
 490   {
 491     EL_PLAYER_4,                        -1,
 492     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(10),
 493     &li.use_artwork_element[3],         FALSE
 494   },
 495   {
 496     EL_PLAYER_4,                        -1,
 497     TYPE_ELEMENT,                       CONF_VALUE_16_BIT(2),
 498     &li.artwork_element[3],             EL_PLAYER_4
 499   },
 500   {
 501     EL_PLAYER_4,                        -1,
 502     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(11),
 503     &li.use_explosion_element[3],       FALSE
 504   },
 505   {
 506     EL_PLAYER_4,                        -1,
 507     TYPE_ELEMENT,                       CONF_VALUE_16_BIT(3),
 508     &li.explosion_element[3],           EL_PLAYER_4
 509   },
 510   {
 511     EL_PLAYER_4,                        -1,
 512     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(13),
 513     &li.use_initial_inventory[3],       FALSE
 514   },
 515   {
 516     EL_PLAYER_4,                        -1,
 517     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(14),
 518     &li.initial_inventory_size[3],      1
 519   },
 520   {
 521     EL_PLAYER_4,                        -1,
 522     TYPE_ELEMENT_LIST,                  CONF_VALUE_BYTES(1),
 523     &li.initial_inventory_content[3][0],EL_EMPTY, NULL,
 524     &li.initial_inventory_size[3],      1, MAX_INITIAL_INVENTORY_SIZE
 525   },
 526
 527   {
 528     EL_EMERALD,                         -1,
 529     TYPE_INTEGER,                       CONF_VALUE_16_BIT(1),
 530     &li.score[SC_EMERALD],              10
 531   },
 532
 533   {
 534     EL_DIAMOND,                         -1,
 535     TYPE_INTEGER,                       CONF_VALUE_16_BIT(1),
 536     &li.score[SC_DIAMOND],              10
 537   },
 538
 539   {
 540     EL_BUG,                             -1,
 541     TYPE_INTEGER,                       CONF_VALUE_16_BIT(1),
 542     &li.score[SC_BUG],                  10
 543   },
 544
 545   {
 546     EL_SPACESHIP,                       -1,
 547     TYPE_INTEGER,                       CONF_VALUE_16_BIT(1),
 548     &li.score[SC_SPACESHIP],            10
 549   },
 550
 551   {
 552     EL_PACMAN,                          -1,
 553     TYPE_INTEGER,                       CONF_VALUE_16_BIT(1),
 554     &li.score[SC_PACMAN],               10
 555   },
 556
 557   {
 558     EL_NUT,                             -1,
 559     TYPE_INTEGER,                       CONF_VALUE_16_BIT(1),
 560     &li.score[SC_NUT],                  10
 561   },
 562
 563   {
 564     EL_DYNAMITE,                        -1,
 565     TYPE_INTEGER,                       CONF_VALUE_16_BIT(1),
 566     &li.score[SC_DYNAMITE],             10
 567   },
 568
 569   {
 570     EL_KEY_1,                           -1,
 571     TYPE_INTEGER,                       CONF_VALUE_16_BIT(1),
 572     &li.score[SC_KEY],                  10
 573   },
 574
 575   {
 576     EL_PEARL,                           -1,
 577     TYPE_INTEGER,                       CONF_VALUE_16_BIT(1),
 578     &li.score[SC_PEARL],                10
 579   },
 580
 581   {
 582     EL_CRYSTAL,                         -1,
 583     TYPE_INTEGER,                       CONF_VALUE_16_BIT(1),
 584     &li.score[SC_CRYSTAL],              10
 585   },
 586
 587   {
 588     EL_BD_AMOEBA,                       -1,
 589     TYPE_ELEMENT,                       CONF_VALUE_16_BIT(1),
 590     &li.amoeba_content,                 EL_DIAMOND
 591   },
 592   {
 593     EL_BD_AMOEBA,                       -1,
 594     TYPE_INTEGER,                       CONF_VALUE_16_BIT(2),
 595     &li.amoeba_speed,                   10
 596   },
 597   {
 598     EL_BD_AMOEBA,                       -1,
 599     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(1),
 600     &li.grow_into_diggable,             TRUE
 601   },
 602
 603   {
 604     EL_YAMYAM,                          -1,
 605     TYPE_CONTENT_LIST,                  CONF_VALUE_BYTES(1),
 606     &li.yamyam_content,                 EL_ROCK, NULL,
 607     &li.num_yamyam_contents,            4, MAX_ELEMENT_CONTENTS
 608   },
 609   {
 610     EL_YAMYAM,                          -1,
 611     TYPE_INTEGER,                       CONF_VALUE_16_BIT(1),
 612     &li.score[SC_YAMYAM],               10
 613   },
 614
 615   {
 616     EL_ROBOT,                           -1,
 617     TYPE_INTEGER,                       CONF_VALUE_16_BIT(1),
 618     &li.score[SC_ROBOT],                10
 619   },
 620   {
 621     EL_ROBOT,                           -1,
 622     TYPE_INTEGER,                       CONF_VALUE_16_BIT(2),
 623     &li.slurp_score,                    10
 624   },
 625
 626   {
 627     EL_ROBOT_WHEEL,                     -1,
 628     TYPE_INTEGER,                       CONF_VALUE_16_BIT(1),
 629     &li.time_wheel,                     10
 630   },
 631
 632   {
 633     EL_MAGIC_WALL,                      -1,
 634     TYPE_INTEGER,                       CONF_VALUE_16_BIT(1),
 635     &li.time_magic_wall,                10
 636   },
 637
 638   {
 639     EL_GAME_OF_LIFE,                    -1,
 640     TYPE_INTEGER,                       CONF_VALUE_8_BIT(1),
 641     &li.game_of_life[0],                2
 642   },
 643   {
 644     EL_GAME_OF_LIFE,                    -1,
 645     TYPE_INTEGER,                       CONF_VALUE_8_BIT(2),
 646     &li.game_of_life[1],                3
 647   },
 648   {
 649     EL_GAME_OF_LIFE,                    -1,
 650     TYPE_INTEGER,                       CONF_VALUE_8_BIT(3),
 651     &li.game_of_life[2],                3
 652   },
 653   {
 654     EL_GAME_OF_LIFE,                    -1,
 655     TYPE_INTEGER,                       CONF_VALUE_8_BIT(4),
 656     &li.game_of_life[3],                3
 657   },
 658
 659   {
 660     EL_BIOMAZE,                         -1,
 661     TYPE_INTEGER,                       CONF_VALUE_8_BIT(1),
 662     &li.biomaze[0],                     2
 663   },
 664   {
 665     EL_BIOMAZE,                         -1,
 666     TYPE_INTEGER,                       CONF_VALUE_8_BIT(2),
 667     &li.biomaze[1],                     3
 668   },
 669   {
 670     EL_BIOMAZE,                         -1,
 671     TYPE_INTEGER,                       CONF_VALUE_8_BIT(3),
 672     &li.biomaze[2],                     3
 673   },
 674   {
 675     EL_BIOMAZE,                         -1,
 676     TYPE_INTEGER,                       CONF_VALUE_8_BIT(4),
 677     &li.biomaze[3],                     3
 678   },
 679
 680   {
 681     EL_TIMEGATE_SWITCH,                 -1,
 682     TYPE_INTEGER,                       CONF_VALUE_16_BIT(1),
 683     &li.time_timegate,                  10
 684   },
 685
 686   {
 687     EL_LIGHT_SWITCH_ACTIVE,             -1,
 688     TYPE_INTEGER,                       CONF_VALUE_16_BIT(1),
 689     &li.time_light,                     10
 690   },
 691
 692   {
 693     EL_SHIELD_NORMAL,                   -1,
 694     TYPE_INTEGER,                       CONF_VALUE_16_BIT(1),
 695     &li.shield_normal_time,             10
 696   },
 697   {
 698     EL_SHIELD_NORMAL,                   -1,
 699     TYPE_INTEGER,                       CONF_VALUE_16_BIT(2),
 700     &li.score[SC_SHIELD],               10
 701   },
 702
 703   {
 704     EL_SHIELD_DEADLY,                   -1,
 705     TYPE_INTEGER,                       CONF_VALUE_16_BIT(1),
 706     &li.shield_deadly_time,             10
 707   },
 708   {
 709     EL_SHIELD_DEADLY,                   -1,
 710     TYPE_INTEGER,                       CONF_VALUE_16_BIT(2),
 711     &li.score[SC_SHIELD],               10
 712   },
 713
 714   {
 715     EL_EXTRA_TIME,                      -1,
 716     TYPE_INTEGER,                       CONF_VALUE_16_BIT(1),
 717     &li.extra_time,                     10
 718   },
 719   {
 720     EL_EXTRA_TIME,                      -1,
 721     TYPE_INTEGER,                       CONF_VALUE_16_BIT(2),
 722     &li.extra_time_score,               10
 723   },
 724
 725   {
 726     EL_TIME_ORB_FULL,                   -1,
 727     TYPE_INTEGER,                       CONF_VALUE_16_BIT(1),
 728     &li.time_orb_time,                  10
 729   },
 730   {
 731     EL_TIME_ORB_FULL,                   -1,
 732     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(1),
 733     &li.use_time_orb_bug,               FALSE
 734   },
 735
 736   {
 737     EL_SPRING,                          -1,
 738     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(1),
 739     &li.use_spring_bug,                 FALSE
 740   },
 741
 742   {
 743     EL_EMC_ANDROID,                     -1,
 744     TYPE_INTEGER,                       CONF_VALUE_16_BIT(1),
 745     &li.android_move_time,              10
 746   },
 747   {
 748     EL_EMC_ANDROID,                     -1,
 749     TYPE_INTEGER,                       CONF_VALUE_16_BIT(2),
 750     &li.android_clone_time,             10
 751   },
 752   {
 753     EL_EMC_ANDROID,                     -1,
 754     TYPE_ELEMENT_LIST,                  CONF_VALUE_BYTES(1),
 755     &li.android_clone_element[0],       EL_EMPTY, NULL,
 756     &li.num_android_clone_elements,     1, MAX_ANDROID_ELEMENTS
 757   },
 758
 759   {
 760     EL_EMC_LENSES,                      -1,
 761     TYPE_INTEGER,                       CONF_VALUE_16_BIT(1),
 762     &li.lenses_score,                   10
 763   },
 764   {
 765     EL_EMC_LENSES,                      -1,
 766     TYPE_INTEGER,                       CONF_VALUE_16_BIT(2),
 767     &li.lenses_time,                    10
 768   },
 769
 770   {
 771     EL_EMC_MAGNIFIER,                   -1,
 772     TYPE_INTEGER,                       CONF_VALUE_16_BIT(1),
 773     &li.magnify_score,                  10
 774   },
 775   {
 776     EL_EMC_MAGNIFIER,                   -1,
 777     TYPE_INTEGER,                       CONF_VALUE_16_BIT(2),
 778     &li.magnify_time,                   10
 779   },
 780
 781   {
 782     EL_EMC_MAGIC_BALL,                  -1,
 783     TYPE_INTEGER,                       CONF_VALUE_16_BIT(1),
 784     &li.ball_time,                      10
 785   },
 786   {
 787     EL_EMC_MAGIC_BALL,                  -1,
 788     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(1),
 789     &li.ball_random,                    FALSE
 790   },
 791   {
 792     EL_EMC_MAGIC_BALL,                  -1,
 793     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(2),
 794     &li.ball_state_initial,             FALSE
 795   },
 796   {
 797     EL_EMC_MAGIC_BALL,                  -1,
 798     TYPE_CONTENT_LIST,                  CONF_VALUE_BYTES(1),
 799     &li.ball_content,                   EL_EMPTY, NULL,
 800     &li.num_ball_contents,              4, MAX_ELEMENT_CONTENTS
 801   },
 802
 803   /* ---------- unused values ----------------------------------------------- */
 804
 805   {
 806     EL_UNKNOWN,                         SAVE_CONF_NEVER,
 807     TYPE_INTEGER,                       CONF_VALUE_16_BIT(1),
 808     &li.score[SC_UNKNOWN_14],           10
 809   },
 810   {
 811     EL_UNKNOWN,                         SAVE_CONF_NEVER,
 812     TYPE_INTEGER,                       CONF_VALUE_16_BIT(2),
 813     &li.score[SC_UNKNOWN_15],           10
 814   },
 815
 816   {
 817     -1,                                 -1,
 818     -1,                                 -1,
 819     NULL,                               -1
 820   }
 821 };
 822
 823 static struct LevelFileConfigInfo chunk_config_NOTE[] =
 824 {
 825   {
 826     -1,                                 -1,
 827     TYPE_INTEGER,                       CONF_VALUE_8_BIT(1),
 828     &xx_envelope.xsize,                 MAX_ENVELOPE_XSIZE,
 829   },
 830   {
 831     -1,                                 -1,
 832     TYPE_INTEGER,                       CONF_VALUE_8_BIT(2),
 833     &xx_envelope.ysize,                 MAX_ENVELOPE_YSIZE,
 834   },
 835
 836   {
 837     -1,                                 -1,
 838     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(3),
 839     &xx_envelope.autowrap,              FALSE
 840   },
 841   {
 842     -1,                                 -1,
 843     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(4),
 844     &xx_envelope.centered,              FALSE
 845   },
 846
 847   {
 848     -1,                                 -1,
 849     TYPE_STRING,                        CONF_VALUE_BYTES(1),
 850     &xx_envelope.text,                  -1, NULL,
 851     &xx_string_length_unused,           -1, MAX_ENVELOPE_TEXT_LEN,
 852     &xx_default_string_empty[0]
 853   },
 854
 855   {
 856     -1,                                 -1,
 857     -1,                                 -1,
 858     NULL,                               -1
 859   }
 860 };
 861
 862 static struct LevelFileConfigInfo chunk_config_CUSX_base[] =
 863 {
 864   {
 865     -1,                                 -1,
 866     TYPE_STRING,                        CONF_VALUE_BYTES(1),
 867     &xx_ei.description[0],              -1,
 868     &yy_ei.description[0],
 869     &xx_string_length_unused,           -1, MAX_ELEMENT_NAME_LEN,
 870     &xx_default_description[0]
 871   },
 872
 873   {
 874     -1,                                 -1,
 875     TYPE_BITFIELD,                      CONF_VALUE_32_BIT(1),
 876     &xx_ei.properties[EP_BITFIELD_BASE_NR], EP_BITMASK_BASE_DEFAULT,
 877     &yy_ei.properties[EP_BITFIELD_BASE_NR]
 878   },
 879 #if ENABLE_RESERVED_CODE
 880   /* (reserved for later use) */
 881   {
 882     -1,                                 -1,
 883     TYPE_BITFIELD,                      CONF_VALUE_32_BIT(2),
 884     &xx_ei.properties[EP_BITFIELD_BASE_NR + 1], EP_BITMASK_DEFAULT,
 885     &yy_ei.properties[EP_BITFIELD_BASE_NR + 1]
 886   },
 887 #endif
 888
 889   {
 890     -1,                                 -1,
 891     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(1),
 892     &xx_ei.use_gfx_element,             FALSE,
 893     &yy_ei.use_gfx_element
 894   },
 895   {
 896     -1,                                 -1,
 897     TYPE_ELEMENT,                       CONF_VALUE_16_BIT(1),
 898     &xx_ei.gfx_element_initial,         EL_EMPTY_SPACE,
 899     &yy_ei.gfx_element_initial
 900   },
 901
 902   {
 903     -1,                                 -1,
 904     TYPE_BITFIELD,                      CONF_VALUE_8_BIT(2),
 905     &xx_ei.access_direction,            MV_ALL_DIRECTIONS,
 906     &yy_ei.access_direction
 907   },
 908
 909   {
 910     -1,                                 -1,
 911     TYPE_INTEGER,                       CONF_VALUE_16_BIT(2),
 912     &xx_ei.collect_score_initial,       10,
 913     &yy_ei.collect_score_initial
 914   },
 915   {
 916     -1,                                 -1,
 917     TYPE_INTEGER,                       CONF_VALUE_16_BIT(3),
 918     &xx_ei.collect_count_initial,       1,
 919     &yy_ei.collect_count_initial
 920   },
 921
 922   {
 923     -1,                                 -1,
 924     TYPE_INTEGER,                       CONF_VALUE_16_BIT(4),
 925     &xx_ei.ce_value_fixed_initial,      0,
 926     &yy_ei.ce_value_fixed_initial
 927   },
 928   {
 929     -1,                                 -1,
 930     TYPE_INTEGER,                       CONF_VALUE_16_BIT(5),
 931     &xx_ei.ce_value_random_initial,     0,
 932     &yy_ei.ce_value_random_initial
 933   },
 934   {
 935     -1,                                 -1,
 936     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(3),
 937     &xx_ei.use_last_ce_value,           FALSE,
 938     &yy_ei.use_last_ce_value
 939   },
 940
 941   {
 942     -1,                                 -1,
 943     TYPE_INTEGER,                       CONF_VALUE_16_BIT(6),
 944     &xx_ei.push_delay_fixed,            8,
 945     &yy_ei.push_delay_fixed
 946   },
 947   {
 948     -1,                                 -1,
 949     TYPE_INTEGER,                       CONF_VALUE_16_BIT(7),
 950     &xx_ei.push_delay_random,           8,
 951     &yy_ei.push_delay_random
 952   },
 953   {
 954     -1,                                 -1,
 955     TYPE_INTEGER,                       CONF_VALUE_16_BIT(8),
 956     &xx_ei.drop_delay_fixed,            0,
 957     &yy_ei.drop_delay_fixed
 958   },
 959   {
 960     -1,                                 -1,
 961     TYPE_INTEGER,                       CONF_VALUE_16_BIT(9),
 962     &xx_ei.drop_delay_random,           0,
 963     &yy_ei.drop_delay_random
 964   },
 965   {
 966     -1,                                 -1,
 967     TYPE_INTEGER,                       CONF_VALUE_16_BIT(10),
 968     &xx_ei.move_delay_fixed,            0,
 969     &yy_ei.move_delay_fixed
 970   },
 971   {
 972     -1,                                 -1,
 973     TYPE_INTEGER,                       CONF_VALUE_16_BIT(11),
 974     &xx_ei.move_delay_random,           0,
 975     &yy_ei.move_delay_random
 976   },
 977
 978   {
 979     -1,                                 -1,
 980     TYPE_BITFIELD,                      CONF_VALUE_32_BIT(3),
 981     &xx_ei.move_pattern,                MV_ALL_DIRECTIONS,
 982     &yy_ei.move_pattern
 983   },
 984   {
 985     -1,                                 -1,
 986     TYPE_BITFIELD,                      CONF_VALUE_8_BIT(4),
 987     &xx_ei.move_direction_initial,      MV_START_AUTOMATIC,
 988     &yy_ei.move_direction_initial
 989   },
 990   {
 991     -1,                                 -1,
 992     TYPE_INTEGER,                       CONF_VALUE_8_BIT(5),
 993     &xx_ei.move_stepsize,               TILEX / 8,
 994     &yy_ei.move_stepsize
 995   },
 996
 997   {
 998     -1,                                 -1,
 999     TYPE_ELEMENT,                       CONF_VALUE_16_BIT(12),
1000     &xx_ei.move_enter_element,          EL_EMPTY_SPACE,
1001     &yy_ei.move_enter_element
1002   },
1003   {
1004     -1,                                 -1,
1005     TYPE_ELEMENT,                       CONF_VALUE_16_BIT(13),
1006     &xx_ei.move_leave_element,          EL_EMPTY_SPACE,
1007     &yy_ei.move_leave_element
1008   },
1009   {
1010     -1,                                 -1,
1011     TYPE_INTEGER,                       CONF_VALUE_8_BIT(6),
1012     &xx_ei.move_leave_type,             LEAVE_TYPE_UNLIMITED,
1013     &yy_ei.move_leave_type
1014   },
1015
1016   {
1017     -1,                                 -1,
1018     TYPE_INTEGER,                       CONF_VALUE_8_BIT(7),
1019     &xx_ei.slippery_type,               SLIPPERY_ANY_RANDOM,
1020     &yy_ei.slippery_type
1021   },
1022
1023   {
1024     -1,                                 -1,
1025     TYPE_INTEGER,                       CONF_VALUE_8_BIT(8),
1026     &xx_ei.explosion_type,              EXPLODES_3X3,
1027     &yy_ei.explosion_type
1028   },
1029   {
1030     -1,                                 -1,
1031     TYPE_INTEGER,                       CONF_VALUE_16_BIT(14),
1032     &xx_ei.explosion_delay,             16,
1033     &yy_ei.explosion_delay
1034   },
1035   {
1036     -1,                                 -1,
1037     TYPE_INTEGER,                       CONF_VALUE_16_BIT(15),
1038     &xx_ei.ignition_delay,              8,
1039     &yy_ei.ignition_delay
1040   },
1041
1042   {
1043     -1,                                 -1,
1044     TYPE_CONTENT_LIST,                  CONF_VALUE_BYTES(2),
1045     &xx_ei.content,                     EL_EMPTY_SPACE,
1046     &yy_ei.content,
1047     &xx_num_contents,                   1, 1
1048   },
1049
1050   /* ---------- "num_change_pages" must be the last entry ------------------- */
1051
1052   {
1053     -1,                                 SAVE_CONF_ALWAYS,
1054     TYPE_INTEGER,                       CONF_VALUE_8_BIT(9),
1055     &xx_ei.num_change_pages,            1,
1056     &yy_ei.num_change_pages
1057   },
1058
1059   {
1060     -1,                                 -1,
1061     -1,                                 -1,
1062     NULL,                               -1,
1063     NULL
1064   }
1065 };
1066
1067 static struct LevelFileConfigInfo chunk_config_CUSX_change[] =
1068 {
1069   /* ---------- "current_change_page" must be the first entry --------------- */
1070
1071   {
1072     -1,                                 SAVE_CONF_ALWAYS,
1073     TYPE_INTEGER,                       CONF_VALUE_8_BIT(1),
1074     &xx_current_change_page,            -1
1075   },
1076
1077   /* ---------- (the remaining entries can be in any order) ----------------- */
1078
1079   {
1080     -1,                                 -1,
1081     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(2),
1082     &xx_change.can_change,              FALSE
1083   },
1084
1085   {
1086     -1,                                 -1,
1087     TYPE_BITFIELD,                      CONF_VALUE_32_BIT(1),
1088     &xx_event_bits[0],                  0
1089   },
1090   {
1091     -1,                                 -1,
1092     TYPE_BITFIELD,                      CONF_VALUE_32_BIT(2),
1093     &xx_event_bits[1],                  0
1094   },
1095
1096   {
1097     -1,                                 -1,
1098     TYPE_BITFIELD,                      CONF_VALUE_8_BIT(3),
1099     &xx_change.trigger_player,          CH_PLAYER_ANY
1100   },
1101   {
1102     -1,                                 -1,
1103     TYPE_BITFIELD,                      CONF_VALUE_8_BIT(4),
1104     &xx_change.trigger_side,            CH_SIDE_ANY
1105   },
1106   {
1107     -1,                                 -1,
1108     TYPE_BITFIELD,                      CONF_VALUE_32_BIT(3),
1109     &xx_change.trigger_page,            CH_PAGE_ANY
1110   },
1111
1112   {
1113     -1,                                 -1,
1114     TYPE_ELEMENT,                       CONF_VALUE_16_BIT(1),
1115     &xx_change.target_element,          EL_EMPTY_SPACE
1116   },
1117
1118   {
1119     -1,                                 -1,
1120     TYPE_INTEGER,                       CONF_VALUE_16_BIT(2),
1121     &xx_change.delay_fixed,             0
1122   },
1123   {
1124     -1,                                 -1,
1125     TYPE_INTEGER,                       CONF_VALUE_16_BIT(3),
1126     &xx_change.delay_random,            0
1127   },
1128   {
1129     -1,                                 -1,
1130     TYPE_INTEGER,                       CONF_VALUE_16_BIT(4),
1131     &xx_change.delay_frames,            FRAMES_PER_SECOND
1132   },
1133
1134   {
1135     -1,                                 -1,
1136     TYPE_ELEMENT,                       CONF_VALUE_16_BIT(5),
1137     &xx_change.initial_trigger_element, EL_EMPTY_SPACE
1138   },
1139
1140   {
1141     -1,                                 -1,
1142     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(6),
1143     &xx_change.explode,                 FALSE
1144   },
1145   {
1146     -1,                                 -1,
1147     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(7),
1148     &xx_change.use_target_content,      FALSE
1149   },
1150   {
1151     -1,                                 -1,
1152     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(8),
1153     &xx_change.only_if_complete,        FALSE
1154   },
1155   {
1156     -1,                                 -1,
1157     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(9),
1158     &xx_change.use_random_replace,      FALSE
1159   },
1160   {
1161     -1,                                 -1,
1162     TYPE_INTEGER,                       CONF_VALUE_8_BIT(10),
1163     &xx_change.random_percentage,       100
1164   },
1165   {
1166     -1,                                 -1,
1167     TYPE_INTEGER,                       CONF_VALUE_8_BIT(11),
1168     &xx_change.replace_when,            CP_WHEN_EMPTY
1169   },
1170
1171   {
1172     -1,                                 -1,
1173     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(12),
1174     &xx_change.has_action,              FALSE
1175   },
1176   {
1177     -1,                                 -1,
1178     TYPE_INTEGER,                       CONF_VALUE_8_BIT(13),
1179     &xx_change.action_type,             CA_NO_ACTION
1180   },
1181   {
1182     -1,                                 -1,
1183     TYPE_INTEGER,                       CONF_VALUE_8_BIT(14),
1184     &xx_change.action_mode,             CA_MODE_UNDEFINED
1185   },
1186   {
1187     -1,                                 -1,
1188     TYPE_INTEGER,                       CONF_VALUE_16_BIT(6),
1189     &xx_change.action_arg,              CA_ARG_UNDEFINED
1190   },
1191
1192   {
1193     -1,                                 -1,
1194     TYPE_ELEMENT,                       CONF_VALUE_16_BIT(7),
1195     &xx_change.action_element,          EL_EMPTY_SPACE
1196   },
1197
1198   {
1199     -1,                                 -1,
1200     TYPE_CONTENT_LIST,                  CONF_VALUE_BYTES(1),
1201     &xx_change.target_content,          EL_EMPTY_SPACE, NULL,
1202     &xx_num_contents,                   1, 1
1203   },
1204
1205   {
1206     -1,                                 -1,
1207     -1,                                 -1,
1208     NULL,                               -1
1209   }
1210 };
1211
1212 static struct LevelFileConfigInfo chunk_config_GRPX[] =
1213 {
1214   {
1215     -1,                                 -1,
1216     TYPE_STRING,                        CONF_VALUE_BYTES(1),
1217     &xx_ei.description[0],              -1, NULL,
1218     &xx_string_length_unused,           -1, MAX_ELEMENT_NAME_LEN,
1219     &xx_default_description[0]
1220   },
1221
1222   {
1223     -1,                                 -1,
1224     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(1),
1225     &xx_ei.use_gfx_element,             FALSE
1226   },
1227   {
1228     -1,                                 -1,
1229     TYPE_ELEMENT,                       CONF_VALUE_16_BIT(1),
1230     &xx_ei.gfx_element_initial,         EL_EMPTY_SPACE
1231   },
1232
1233   {
1234     -1,                                 -1,
1235     TYPE_INTEGER,                       CONF_VALUE_8_BIT(2),
1236     &xx_group.choice_mode,              ANIM_RANDOM
1237   },
1238
1239   {
1240     -1,                                 -1,
1241     TYPE_ELEMENT_LIST,                  CONF_VALUE_BYTES(2),
1242     &xx_group.element[0],               EL_EMPTY_SPACE, NULL,
1243     &xx_group.num_elements,             1, MAX_ELEMENTS_IN_GROUP
1244   },
1245
1246   {
1247     -1,                                 -1,
1248     -1,                                 -1,
1249     NULL,                               -1
1250   }
1251 };
1252
1253 static struct LevelFileConfigInfo chunk_config_CONF[] =         /* (OBSOLETE) */
1254 {
1255   {
1256     EL_PLAYER_1,                        -1,
1257     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(9),
1258     &li.block_snap_field,               TRUE
1259   },
1260   {
1261     EL_PLAYER_1,                        -1,
1262     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(13),
1263     &li.continuous_snapping,            TRUE
1264   },
1265   {
1266     EL_PLAYER_1,                        -1,
1267     TYPE_INTEGER,                       CONF_VALUE_8_BIT(1),
1268     &li.initial_player_stepsize[0],     STEPSIZE_NORMAL
1269   },
1270   {
1271     EL_PLAYER_1,                        -1,
1272     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(10),
1273     &li.use_start_element[0],           FALSE
1274   },
1275   {
1276     EL_PLAYER_1,                        -1,
1277     TYPE_ELEMENT,                       CONF_VALUE_16_BIT(1),
1278     &li.start_element[0],               EL_PLAYER_1
1279   },
1280   {
1281     EL_PLAYER_1,                        -1,
1282     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(11),
1283     &li.use_artwork_element[0],         FALSE
1284   },
1285   {
1286     EL_PLAYER_1,                        -1,
1287     TYPE_ELEMENT,                       CONF_VALUE_16_BIT(2),
1288     &li.artwork_element[0],             EL_PLAYER_1
1289   },
1290   {
1291     EL_PLAYER_1,                        -1,
1292     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(12),
1293     &li.use_explosion_element[0],       FALSE
1294   },
1295   {
1296     EL_PLAYER_1,                        -1,
1297     TYPE_ELEMENT,                       CONF_VALUE_16_BIT(3),
1298     &li.explosion_element[0],           EL_PLAYER_1
1299   },
1300
1301   {
1302     -1,                                 -1,
1303     -1,                                 -1,
1304     NULL,                               -1
1305   }
1306 };
1307
1308 static struct
1309 {
1310   int filetype;
1311   char *id;
1312 }
1313 filetype_id_list[] =
1314 {
1315   { LEVEL_FILE_TYPE_RND,        "RND"   },
1316   { LEVEL_FILE_TYPE_BD,         "BD"    },
1317   { LEVEL_FILE_TYPE_EM,         "EM"    },
1318   { LEVEL_FILE_TYPE_SP,         "SP"    },
1319   { LEVEL_FILE_TYPE_DX,         "DX"    },
1320   { LEVEL_FILE_TYPE_SB,         "SB"    },
1321   { LEVEL_FILE_TYPE_DC,         "DC"    },
1322   { -1,                         NULL    },
1323 };
1324
1325
1326 /* ========================================================================= */
1327 /* level file functions                                                      */
1328 /* ========================================================================= */
1329
1330 static boolean check_special_flags(char *flag)
1331 {
1332   if (strEqual(options.special_flags, flag) ||
1333       strEqual(leveldir_current->special_flags, flag))
1334     return TRUE;
1335
1336   return FALSE;
1337 }
1338
1339 static struct DateInfo getCurrentDate()
1340 {
1341   time_t epoch_seconds = time(NULL);
1342   struct tm *now = localtime(&epoch_seconds);
1343   struct DateInfo date;
1344
1345   date.year  = now->tm_year + 1900;
1346   date.month = now->tm_mon  + 1;
1347   date.day   = now->tm_mday;
1348
1349   date.src   = DATE_SRC_CLOCK;
1350
1351   return date;
1352 }
1353
1354 static void resetEventFlags(struct ElementChangeInfo *change)
1355 {
1356   int i;
1357
1358   for (i = 0; i < NUM_CHANGE_EVENTS; i++)
1359     change->has_event[i] = FALSE;
1360 }
1361
1362 static void resetEventBits()
1363 {
1364   int i;
1365
1366   for (i = 0; i < NUM_CE_BITFIELDS; i++)
1367     xx_event_bits[i] = 0;
1368 }
1369
1370 static void setEventFlagsFromEventBits(struct ElementChangeInfo *change)
1371 {
1372   int i;
1373
1374   /* important: only change event flag if corresponding event bit is set
1375      (this is because all xx_event_bits[] values are loaded separately,
1376      and all xx_event_bits[] values are set back to zero before loading
1377      another value xx_event_bits[x] (each value representing 32 flags)) */
1378
1379   for (i = 0; i < NUM_CHANGE_EVENTS; i++)
1380     if (xx_event_bits[CH_EVENT_BITFIELD_NR(i)] & CH_EVENT_BIT(i))
1381       change->has_event[i] = TRUE;
1382 }
1383
1384 static void setEventBitsFromEventFlags(struct ElementChangeInfo *change)
1385 {
1386   int i;
1387
1388   /* in contrast to the above function setEventFlagsFromEventBits(), it
1389      would also be possible to set all bits in xx_event_bits[] to 0 or 1
1390      depending on the corresponding change->has_event[i] values here, as
1391      all xx_event_bits[] values are reset in resetEventBits() before */
1392
1393   for (i = 0; i < NUM_CHANGE_EVENTS; i++)
1394     if (change->has_event[i])
1395       xx_event_bits[CH_EVENT_BITFIELD_NR(i)] |= CH_EVENT_BIT(i);
1396 }
1397
1398 static char *getDefaultElementDescription(struct ElementInfo *ei)
1399 {
1400   static char description[MAX_ELEMENT_NAME_LEN + 1];
1401   char *default_description = (ei->custom_description != NULL ?
1402                                ei->custom_description :
1403                                ei->editor_description);
1404   int i;
1405
1406   /* always start with reliable default values */
1407   for (i = 0; i < MAX_ELEMENT_NAME_LEN + 1; i++)
1408     description[i] = '\0';
1409
1410   /* truncate element description to MAX_ELEMENT_NAME_LEN bytes */
1411   strncpy(description, default_description, MAX_ELEMENT_NAME_LEN);
1412
1413   return &description[0];
1414 }
1415
1416 static void setElementDescriptionToDefault(struct ElementInfo *ei)
1417 {
1418   char *default_description = getDefaultElementDescription(ei);
1419   int i;
1420
1421   for (i = 0; i < MAX_ELEMENT_NAME_LEN + 1; i++)
1422     ei->description[i] = default_description[i];
1423 }
1424
1425 static void setConfigToDefaultsFromConfigList(struct LevelFileConfigInfo *conf)
1426 {
1427   int i;
1428
1429   for (i = 0; conf[i].data_type != -1; i++)
1430   {
1431     int default_value = conf[i].default_value;
1432     int data_type = conf[i].data_type;
1433     int conf_type = conf[i].conf_type;
1434     int byte_mask = conf_type & CONF_MASK_BYTES;
1435
1436     if (byte_mask == CONF_MASK_MULTI_BYTES)
1437     {
1438       int default_num_entities = conf[i].default_num_entities;
1439       int max_num_entities = conf[i].max_num_entities;
1440
1441       *(int *)(conf[i].num_entities) = default_num_entities;
1442
1443       if (data_type == TYPE_STRING)
1444       {
1445         char *default_string = conf[i].default_string;
1446         char *string = (char *)(conf[i].value);
1447
1448         strncpy(string, default_string, max_num_entities);
1449       }
1450       else if (data_type == TYPE_ELEMENT_LIST)
1451       {
1452         int *element_array = (int *)(conf[i].value);
1453         int j;
1454
1455         for (j = 0; j < max_num_entities; j++)
1456           element_array[j] = default_value;
1457       }
1458       else if (data_type == TYPE_CONTENT_LIST)
1459       {
1460         struct Content *content = (struct Content *)(conf[i].value);
1461         int c, x, y;
1462
1463         for (c = 0; c < max_num_entities; c++)
1464           for (y = 0; y < 3; y++)
1465             for (x = 0; x < 3; x++)
1466               content[c].e[x][y] = default_value;
1467       }
1468     }
1469     else        /* constant size configuration data (1, 2 or 4 bytes) */
1470     {
1471       if (data_type == TYPE_BOOLEAN)
1472         *(boolean *)(conf[i].value) = default_value;
1473       else
1474         *(int *)    (conf[i].value) = default_value;
1475     }
1476   }
1477 }
1478
1479 static void copyConfigFromConfigList(struct LevelFileConfigInfo *conf)
1480 {
1481   int i;
1482
1483   for (i = 0; conf[i].data_type != -1; i++)
1484   {
1485     int data_type = conf[i].data_type;
1486     int conf_type = conf[i].conf_type;
1487     int byte_mask = conf_type & CONF_MASK_BYTES;
1488
1489     if (byte_mask == CONF_MASK_MULTI_BYTES)
1490     {
1491       int max_num_entities = conf[i].max_num_entities;
1492
1493       if (data_type == TYPE_STRING)
1494       {
1495         char *string      = (char *)(conf[i].value);
1496         char *string_copy = (char *)(conf[i].value_copy);
1497
1498         strncpy(string_copy, string, max_num_entities);
1499       }
1500       else if (data_type == TYPE_ELEMENT_LIST)
1501       {
1502         int *element_array      = (int *)(conf[i].value);
1503         int *element_array_copy = (int *)(conf[i].value_copy);
1504         int j;
1505
1506         for (j = 0; j < max_num_entities; j++)
1507           element_array_copy[j] = element_array[j];
1508       }
1509       else if (data_type == TYPE_CONTENT_LIST)
1510       {
1511         struct Content *content      = (struct Content *)(conf[i].value);
1512         struct Content *content_copy = (struct Content *)(conf[i].value_copy);
1513         int c, x, y;
1514
1515         for (c = 0; c < max_num_entities; c++)
1516           for (y = 0; y < 3; y++)
1517             for (x = 0; x < 3; x++)
1518               content_copy[c].e[x][y] = content[c].e[x][y];
1519       }
1520     }
1521     else        /* constant size configuration data (1, 2 or 4 bytes) */
1522     {
1523       if (data_type == TYPE_BOOLEAN)
1524         *(boolean *)(conf[i].value_copy) = *(boolean *)(conf[i].value);
1525       else
1526         *(int *)    (conf[i].value_copy) = *(int *)    (conf[i].value);
1527     }
1528   }
1529 }
1530
1531 void copyElementInfo(struct ElementInfo *ei_from, struct ElementInfo *ei_to)
1532 {
1533   int i;
1534
1535   xx_ei = *ei_from;     /* copy element data into temporary buffer */
1536   yy_ei = *ei_to;       /* copy element data into temporary buffer */
1537
1538   copyConfigFromConfigList(chunk_config_CUSX_base);
1539
1540   *ei_from = xx_ei;
1541   *ei_to   = yy_ei;
1542
1543   /* ---------- reinitialize and copy change pages ---------- */
1544
1545   ei_to->num_change_pages = ei_from->num_change_pages;
1546   ei_to->current_change_page = ei_from->current_change_page;
1547
1548   setElementChangePages(ei_to, ei_to->num_change_pages);
1549
1550   for (i = 0; i < ei_to->num_change_pages; i++)
1551     ei_to->change_page[i] = ei_from->change_page[i];
1552
1553   /* ---------- copy group element info ---------- */
1554   if (ei_from->group != NULL && ei_to->group != NULL)   /* group or internal */
1555     *ei_to->group = *ei_from->group;
1556
1557   /* mark this custom element as modified */
1558   ei_to->modified_settings = TRUE;
1559 }
1560
1561 void setElementChangePages(struct ElementInfo *ei, int change_pages)
1562 {
1563   int change_page_size = sizeof(struct ElementChangeInfo);
1564
1565   ei->num_change_pages = MAX(1, change_pages);
1566
1567   ei->change_page =
1568     checked_realloc(ei->change_page, ei->num_change_pages * change_page_size);
1569
1570   if (ei->current_change_page >= ei->num_change_pages)
1571     ei->current_change_page = ei->num_change_pages - 1;
1572
1573   ei->change = &ei->change_page[ei->current_change_page];
1574 }
1575
1576 void setElementChangeInfoToDefaults(struct ElementChangeInfo *change)
1577 {
1578   xx_change = *change;          /* copy change data into temporary buffer */
1579
1580   setConfigToDefaultsFromConfigList(chunk_config_CUSX_change);
1581
1582   *change = xx_change;
1583
1584   resetEventFlags(change);
1585
1586   change->direct_action = 0;
1587   change->other_action = 0;
1588
1589   change->pre_change_function = NULL;
1590   change->change_function = NULL;
1591   change->post_change_function = NULL;
1592 }
1593
1594 static void setLevelInfoToDefaults_Level(struct LevelInfo *level)
1595 {
1596   int i, x, y;
1597
1598   li = *level;          /* copy level data into temporary buffer */
1599   setConfigToDefaultsFromConfigList(chunk_config_INFO);
1600   *level = li;          /* copy temporary buffer back to level data */
1601
1602   setLevelInfoToDefaults_EM();
1603   setLevelInfoToDefaults_SP();
1604
1605   level->native_em_level = &native_em_level;
1606   level->native_sp_level = &native_sp_level;
1607
1608   level->file_version = FILE_VERSION_ACTUAL;
1609   level->game_version = GAME_VERSION_ACTUAL;
1610
1611   level->creation_date = getCurrentDate();
1612
1613   level->encoding_16bit_field  = TRUE;
1614   level->encoding_16bit_yamyam = TRUE;
1615   level->encoding_16bit_amoeba = TRUE;
1616
1617   /* clear level name and level author string buffers */
1618   for (i = 0; i < MAX_LEVEL_NAME_LEN; i++)
1619     level->name[i] = '\0';
1620   for (i = 0; i < MAX_LEVEL_AUTHOR_LEN; i++)
1621     level->author[i] = '\0';
1622
1623   /* set level name and level author to default values */
1624   strcpy(level->name, NAMELESS_LEVEL_NAME);
1625   strcpy(level->author, ANONYMOUS_NAME);
1626
1627   /* set level playfield to playable default level with player and exit */
1628   for (x = 0; x < MAX_LEV_FIELDX; x++)
1629     for (y = 0; y < MAX_LEV_FIELDY; y++)
1630       level->field[x][y] = EL_SAND;
1631
1632   level->field[0][0] = EL_PLAYER_1;
1633   level->field[STD_LEV_FIELDX - 1][STD_LEV_FIELDY - 1] = EL_EXIT_CLOSED;
1634
1635   BorderElement = EL_STEELWALL;
1636
1637   /* set all bug compatibility flags to "false" => do not emulate this bug */
1638   level->use_action_after_change_bug = FALSE;
1639
1640   if (leveldir_current)
1641   {
1642     /* try to determine better author name than 'anonymous' */
1643     if (!strEqual(leveldir_current->author, ANONYMOUS_NAME))
1644     {
1645       strncpy(level->author, leveldir_current->author, MAX_LEVEL_AUTHOR_LEN);
1646       level->author[MAX_LEVEL_AUTHOR_LEN] = '\0';
1647     }
1648     else
1649     {
1650       switch (LEVELCLASS(leveldir_current))
1651       {
1652         case LEVELCLASS_TUTORIAL:
1653           strcpy(level->author, PROGRAM_AUTHOR_STRING);
1654           break;
1655
1656         case LEVELCLASS_CONTRIB:
1657           strncpy(level->author, leveldir_current->name, MAX_LEVEL_AUTHOR_LEN);
1658           level->author[MAX_LEVEL_AUTHOR_LEN] = '\0';
1659           break;
1660
1661         case LEVELCLASS_PRIVATE:
1662           strncpy(level->author, getRealName(), MAX_LEVEL_AUTHOR_LEN);
1663           level->author[MAX_LEVEL_AUTHOR_LEN] = '\0';
1664           break;
1665
1666         default:
1667           /* keep default value */
1668           break;
1669       }
1670     }
1671   }
1672 }
1673
1674 static void setLevelInfoToDefaults_Elements(struct LevelInfo *level)
1675 {
1676   static boolean clipboard_elements_initialized = FALSE;
1677   int i;
1678
1679   InitElementPropertiesStatic();
1680
1681   li = *level;          /* copy level data into temporary buffer */
1682   setConfigToDefaultsFromConfigList(chunk_config_ELEM);
1683   *level = li;          /* copy temporary buffer back to level data */
1684
1685   for (i = 0; i < MAX_NUM_ELEMENTS; i++)
1686   {
1687     int element = i;
1688     struct ElementInfo *ei = &element_info[element];
1689
1690     /* never initialize clipboard elements after the very first time */
1691     /* (to be able to use clipboard elements between several levels) */
1692     if (IS_CLIPBOARD_ELEMENT(element) && clipboard_elements_initialized)
1693       continue;
1694
1695     if (IS_ENVELOPE(element))
1696     {
1697       int envelope_nr = element - EL_ENVELOPE_1;
1698
1699       setConfigToDefaultsFromConfigList(chunk_config_NOTE);
1700
1701       level->envelope[envelope_nr] = xx_envelope;
1702     }
1703
1704     if (IS_CUSTOM_ELEMENT(element) ||
1705         IS_GROUP_ELEMENT(element) ||
1706         IS_INTERNAL_ELEMENT(element))
1707     {
1708       xx_ei = *ei;      /* copy element data into temporary buffer */
1709
1710       setConfigToDefaultsFromConfigList(chunk_config_CUSX_base);
1711
1712       *ei = xx_ei;
1713     }
1714
1715     setElementChangePages(ei, 1);
1716     setElementChangeInfoToDefaults(ei->change);
1717
1718     if (IS_CUSTOM_ELEMENT(element) ||
1719         IS_GROUP_ELEMENT(element) ||
1720         IS_INTERNAL_ELEMENT(element))
1721     {
1722       setElementDescriptionToDefault(ei);
1723
1724       ei->modified_settings = FALSE;
1725     }
1726
1727     if (IS_CUSTOM_ELEMENT(element) ||
1728         IS_INTERNAL_ELEMENT(element))
1729     {
1730       /* internal values used in level editor */
1731
1732       ei->access_type = 0;
1733       ei->access_layer = 0;
1734       ei->access_protected = 0;
1735       ei->walk_to_action = 0;
1736       ei->smash_targets = 0;
1737       ei->deadliness = 0;
1738
1739       ei->can_explode_by_fire = FALSE;
1740       ei->can_explode_smashed = FALSE;
1741       ei->can_explode_impact = FALSE;
1742
1743       ei->current_change_page = 0;
1744     }
1745
1746     if (IS_GROUP_ELEMENT(element) ||
1747         IS_INTERNAL_ELEMENT(element))
1748     {
1749       struct ElementGroupInfo *group;
1750
1751       /* initialize memory for list of elements in group */
1752       if (ei->group == NULL)
1753         ei->group = checked_malloc(sizeof(struct ElementGroupInfo));
1754
1755       group = ei->group;
1756
1757       xx_group = *group;        /* copy group data into temporary buffer */
1758
1759       setConfigToDefaultsFromConfigList(chunk_config_GRPX);
1760
1761       *group = xx_group;
1762     }
1763   }
1764
1765   clipboard_elements_initialized = TRUE;
1766 }
1767
1768 static void setLevelInfoToDefaults(struct LevelInfo *level,
1769                                    boolean level_info_only,
1770                                    boolean reset_file_status)
1771 {
1772   setLevelInfoToDefaults_Level(level);
1773
1774   if (!level_info_only)
1775     setLevelInfoToDefaults_Elements(level);
1776
1777   if (reset_file_status)
1778   {
1779     level->no_valid_file = FALSE;
1780     level->no_level_file = FALSE;
1781   }
1782
1783   level->changed = FALSE;
1784 }
1785
1786 static void setFileInfoToDefaults(struct LevelFileInfo *level_file_info)
1787 {
1788   level_file_info->nr = 0;
1789   level_file_info->type = LEVEL_FILE_TYPE_UNKNOWN;
1790   level_file_info->packed = FALSE;
1791   level_file_info->basename = NULL;
1792   level_file_info->filename = NULL;
1793 }
1794
1795 int getMappedElement_SB(int, boolean);
1796
1797 static void ActivateLevelTemplate()
1798 {
1799   int x, y;
1800
1801   if (check_special_flags("load_xsb_to_ces"))
1802   {
1803     /* fill smaller playfields with padding "beyond border wall" elements */
1804     if (level.fieldx < level_template.fieldx ||
1805         level.fieldy < level_template.fieldy)
1806     {
1807       short field[level.fieldx][level.fieldy];
1808       int new_fieldx = MAX(level.fieldx, level_template.fieldx);
1809       int new_fieldy = MAX(level.fieldy, level_template.fieldy);
1810       int pos_fieldx = (new_fieldx - level.fieldx) / 2;
1811       int pos_fieldy = (new_fieldy - level.fieldy) / 2;
1812
1813       /* copy old playfield (which is smaller than the visible area) */
1814       for (y = 0; y < level.fieldy; y++) for (x = 0; x < level.fieldx; x++)
1815         field[x][y] = level.field[x][y];
1816
1817       /* fill new, larger playfield with "beyond border wall" elements */
1818       for (y = 0; y < new_fieldy; y++) for (x = 0; x < new_fieldx; x++)
1819         level.field[x][y] = getMappedElement_SB('_', TRUE);
1820
1821       /* copy the old playfield to the middle of the new playfield */
1822       for (y = 0; y < level.fieldy; y++) for (x = 0; x < level.fieldx; x++)
1823         level.field[pos_fieldx + x][pos_fieldy + y] = field[x][y];
1824
1825       level.fieldx = new_fieldx;
1826       level.fieldy = new_fieldy;
1827     }
1828   }
1829
1830   /* Currently there is no special action needed to activate the template
1831      data, because 'element_info' property settings overwrite the original
1832      level data, while all other variables do not change. */
1833
1834   /* Exception: 'from_level_template' elements in the original level playfield
1835      are overwritten with the corresponding elements at the same position in
1836      playfield from the level template. */
1837
1838   for (x = 0; x < level.fieldx; x++)
1839     for (y = 0; y < level.fieldy; y++)
1840       if (level.field[x][y] == EL_FROM_LEVEL_TEMPLATE)
1841         level.field[x][y] = level_template.field[x][y];
1842
1843   if (check_special_flags("load_xsb_to_ces"))
1844   {
1845     struct LevelInfo level_backup = level;
1846
1847     /* overwrite all individual level settings from template level settings */
1848     level = level_template;
1849
1850     /* restore playfield size */
1851     level.fieldx = level_backup.fieldx;
1852     level.fieldy = level_backup.fieldy;
1853
1854     /* restore playfield content */
1855     for (x = 0; x < level.fieldx; x++)
1856       for (y = 0; y < level.fieldy; y++)
1857         level.field[x][y] = level_backup.field[x][y];
1858
1859     /* restore name and author from individual level */
1860     strcpy(level.name,   level_backup.name);
1861     strcpy(level.author, level_backup.author);
1862
1863     /* restore flag "use_custom_template" */
1864     level.use_custom_template = level_backup.use_custom_template;
1865   }
1866 }
1867
1868 static char *getLevelFilenameFromBasename(char *basename)
1869 {
1870   static char *filename[2] = { NULL, NULL };
1871   int pos = (strEqual(basename, LEVELTEMPLATE_FILENAME) ? 0 : 1);
1872
1873   checked_free(filename[pos]);
1874
1875   filename[pos] = getPath2(getCurrentLevelDir(), basename);
1876
1877   return filename[pos];
1878 }
1879
1880 static int getFileTypeFromBasename(char *basename)
1881 {
1882   /* !!! ALSO SEE COMMENT IN checkForPackageFromBasename() !!! */
1883
1884   static char *filename = NULL;
1885   struct stat file_status;
1886
1887   /* ---------- try to determine file type from filename ---------- */
1888
1889   /* check for typical filename of a Supaplex level package file */
1890   if (strlen(basename) == 10 && strPrefixLower(basename, "levels.d"))
1891     return LEVEL_FILE_TYPE_SP;
1892
1893   /* check for typical filename of a Diamond Caves II level package file */
1894   if (strSuffixLower(basename, ".dc") ||
1895       strSuffixLower(basename, ".dc2"))
1896     return LEVEL_FILE_TYPE_DC;
1897
1898   /* check for typical filename of a Sokoban level package file */
1899   if (strSuffixLower(basename, ".xsb") &&
1900       strchr(basename, '%') == NULL)
1901     return LEVEL_FILE_TYPE_SB;
1902
1903   /* ---------- try to determine file type from filesize ---------- */
1904
1905   checked_free(filename);
1906   filename = getPath2(getCurrentLevelDir(), basename);
1907
1908   if (stat(filename, &file_status) == 0)
1909   {
1910     /* check for typical filesize of a Supaplex level package file */
1911     if (file_status.st_size == 170496)
1912       return LEVEL_FILE_TYPE_SP;
1913   }
1914
1915   return LEVEL_FILE_TYPE_UNKNOWN;
1916 }
1917
1918 static boolean checkForPackageFromBasename(char *basename)
1919 {
1920   /* !!! WON'T WORK ANYMORE IF getFileTypeFromBasename() ALSO DETECTS !!!
1921      !!! SINGLE LEVELS (CURRENTLY ONLY DETECTS LEVEL PACKAGES         !!! */
1922
1923   return (getFileTypeFromBasename(basename) != LEVEL_FILE_TYPE_UNKNOWN);
1924 }
1925
1926 static char *getSingleLevelBasenameExt(int nr, char *extension)
1927 {
1928   static char basename[MAX_FILENAME_LEN];
1929
1930   if (nr < 0)
1931     sprintf(basename, "%s", LEVELTEMPLATE_FILENAME);
1932   else
1933     sprintf(basename, "%03d.%s", nr, extension);
1934
1935   return basename;
1936 }
1937
1938 static char *getSingleLevelBasename(int nr)
1939 {
1940   return getSingleLevelBasenameExt(nr, LEVELFILE_EXTENSION);
1941 }
1942
1943 static char *getPackedLevelBasename(int type)
1944 {
1945   static char basename[MAX_FILENAME_LEN];
1946   char *directory = getCurrentLevelDir();
1947   Directory *dir;
1948   DirectoryEntry *dir_entry;
1949
1950   strcpy(basename, UNDEFINED_FILENAME);         /* default: undefined file */
1951
1952   if ((dir = openDirectory(directory)) == NULL)
1953   {
1954     Error(ERR_WARN, "cannot read current level directory '%s'", directory);
1955
1956     return basename;
1957   }
1958
1959   while ((dir_entry = readDirectory(dir)) != NULL)      /* loop all entries */
1960   {
1961     char *entry_basename = dir_entry->basename;
1962     int entry_type = getFileTypeFromBasename(entry_basename);
1963
1964     if (entry_type != LEVEL_FILE_TYPE_UNKNOWN)  /* found valid level package */
1965     {
1966       if (type == LEVEL_FILE_TYPE_UNKNOWN ||
1967           type == entry_type)
1968       {
1969         strcpy(basename, entry_basename);
1970
1971         break;
1972       }
1973     }
1974   }
1975
1976   closeDirectory(dir);
1977
1978   return basename;
1979 }
1980
1981 static char *getSingleLevelFilename(int nr)
1982 {
1983   return getLevelFilenameFromBasename(getSingleLevelBasename(nr));
1984 }
1985
1986 #if ENABLE_UNUSED_CODE
1987 static char *getPackedLevelFilename(int type)
1988 {
1989   return getLevelFilenameFromBasename(getPackedLevelBasename(type));
1990 }
1991 #endif
1992
1993 char *getDefaultLevelFilename(int nr)
1994 {
1995   return getSingleLevelFilename(nr);
1996 }
1997
1998 #if ENABLE_UNUSED_CODE
1999 static void setLevelFileInfo_SingleLevelFilename(struct LevelFileInfo *lfi,
2000                                                  int type)
2001 {
2002   lfi->type = type;
2003   lfi->packed = FALSE;
2004   lfi->basename = getSingleLevelBasename(lfi->nr, lfi->type);
2005   lfi->filename = getLevelFilenameFromBasename(lfi->basename);
2006 }
2007 #endif
2008
2009 static void setLevelFileInfo_FormatLevelFilename(struct LevelFileInfo *lfi,
2010                                                  int type, char *format, ...)
2011 {
2012   static char basename[MAX_FILENAME_LEN];
2013   va_list ap;
2014
2015   va_start(ap, format);
2016   vsprintf(basename, format, ap);
2017   va_end(ap);
2018
2019   lfi->type = type;
2020   lfi->packed = FALSE;
2021   lfi->basename = basename;
2022   lfi->filename = getLevelFilenameFromBasename(lfi->basename);
2023 }
2024
2025 static void setLevelFileInfo_PackedLevelFilename(struct LevelFileInfo *lfi,
2026                                                  int type)
2027 {
2028   lfi->type = type;
2029   lfi->packed = TRUE;
2030   lfi->basename = getPackedLevelBasename(lfi->type);
2031   lfi->filename = getLevelFilenameFromBasename(lfi->basename);
2032 }
2033
2034 static int getFiletypeFromID(char *filetype_id)
2035 {
2036   char *filetype_id_lower;
2037   int filetype = LEVEL_FILE_TYPE_UNKNOWN;
2038   int i;
2039
2040   if (filetype_id == NULL)
2041     return LEVEL_FILE_TYPE_UNKNOWN;
2042
2043   filetype_id_lower = getStringToLower(filetype_id);
2044
2045   for (i = 0; filetype_id_list[i].id != NULL; i++)
2046   {
2047     char *id_lower = getStringToLower(filetype_id_list[i].id);
2048
2049     if (strEqual(filetype_id_lower, id_lower))
2050       filetype = filetype_id_list[i].filetype;
2051
2052     free(id_lower);
2053
2054     if (filetype != LEVEL_FILE_TYPE_UNKNOWN)
2055       break;
2056   }
2057
2058   free(filetype_id_lower);
2059
2060   return filetype;
2061 }
2062
2063 char *getLocalLevelTemplateFilename()
2064 {
2065   return getDefaultLevelFilename(-1);
2066 }
2067
2068 char *getGlobalLevelTemplateFilename()
2069 {
2070   /* global variable "leveldir_current" must be modified in the loop below */
2071   LevelDirTree *leveldir_current_last = leveldir_current;
2072   char *filename = NULL;
2073
2074   /* check for template level in path from current to topmost tree node */
2075
2076   while (leveldir_current != NULL)
2077   {
2078     filename = getDefaultLevelFilename(-1);
2079
2080     if (fileExists(filename))
2081       break;
2082
2083     leveldir_current = leveldir_current->node_parent;
2084   }
2085
2086   /* restore global variable "leveldir_current" modified in above loop */
2087   leveldir_current = leveldir_current_last;
2088
2089   return filename;
2090 }
2091
2092 static void determineLevelFileInfo_Filename(struct LevelFileInfo *lfi)
2093 {
2094   int nr = lfi->nr;
2095
2096   /* special case: level number is negative => check for level template file */
2097   if (nr < 0)
2098   {
2099     setLevelFileInfo_FormatLevelFilename(lfi, LEVEL_FILE_TYPE_RND,
2100                                          getSingleLevelBasename(-1));
2101
2102     /* replace local level template filename with global template filename */
2103     lfi->filename = getGlobalLevelTemplateFilename();
2104
2105     /* no fallback if template file not existing */
2106     return;
2107   }
2108
2109   /* special case: check for file name/pattern specified in "levelinfo.conf" */
2110   if (leveldir_current->level_filename != NULL)
2111   {
2112     int filetype = getFiletypeFromID(leveldir_current->level_filetype);
2113
2114     setLevelFileInfo_FormatLevelFilename(lfi, filetype,
2115                                          leveldir_current->level_filename, nr);
2116
2117     lfi->packed = checkForPackageFromBasename(leveldir_current->level_filename);
2118
2119     if (fileExists(lfi->filename))
2120       return;
2121   }
2122
2123   /* check for native Rocks'n'Diamonds level file */
2124   setLevelFileInfo_FormatLevelFilename(lfi, LEVEL_FILE_TYPE_RND,
2125                                        "%03d.%s", nr, LEVELFILE_EXTENSION);
2126   if (fileExists(lfi->filename))
2127     return;
2128
2129   /* check for Emerald Mine level file (V1) */
2130   setLevelFileInfo_FormatLevelFilename(lfi, LEVEL_FILE_TYPE_EM, "a%c%c",
2131                                        'a' + (nr / 10) % 26, '0' + nr % 10);
2132   if (fileExists(lfi->filename))
2133     return;
2134   setLevelFileInfo_FormatLevelFilename(lfi, LEVEL_FILE_TYPE_EM, "A%c%c",
2135                                        'A' + (nr / 10) % 26, '0' + nr % 10);
2136   if (fileExists(lfi->filename))
2137     return;
2138
2139   /* check for Emerald Mine level file (V2 to V5) */
2140   setLevelFileInfo_FormatLevelFilename(lfi, LEVEL_FILE_TYPE_EM, "%d", nr);
2141   if (fileExists(lfi->filename))
2142     return;
2143
2144   /* check for Emerald Mine level file (V6 / single mode) */
2145   setLevelFileInfo_FormatLevelFilename(lfi, LEVEL_FILE_TYPE_EM, "%02ds", nr);
2146   if (fileExists(lfi->filename))
2147     return;
2148   setLevelFileInfo_FormatLevelFilename(lfi, LEVEL_FILE_TYPE_EM, "%02dS", nr);
2149   if (fileExists(lfi->filename))
2150     return;
2151
2152   /* check for Emerald Mine level file (V6 / teamwork mode) */
2153   setLevelFileInfo_FormatLevelFilename(lfi, LEVEL_FILE_TYPE_EM, "%02dt", nr);
2154   if (fileExists(lfi->filename))
2155     return;
2156   setLevelFileInfo_FormatLevelFilename(lfi, LEVEL_FILE_TYPE_EM, "%02dT", nr);
2157   if (fileExists(lfi->filename))
2158     return;
2159
2160   /* check for various packed level file formats */
2161   setLevelFileInfo_PackedLevelFilename(lfi, LEVEL_FILE_TYPE_UNKNOWN);
2162   if (fileExists(lfi->filename))
2163     return;
2164
2165   /* no known level file found -- use default values (and fail later) */
2166   setLevelFileInfo_FormatLevelFilename(lfi, LEVEL_FILE_TYPE_RND,
2167                                        "%03d.%s", nr, LEVELFILE_EXTENSION);
2168 }
2169
2170 static void determineLevelFileInfo_Filetype(struct LevelFileInfo *lfi)
2171 {
2172   if (lfi->type == LEVEL_FILE_TYPE_UNKNOWN)
2173     lfi->type = getFileTypeFromBasename(lfi->basename);
2174 }
2175
2176 static void setLevelFileInfo(struct LevelFileInfo *level_file_info, int nr)
2177 {
2178   /* always start with reliable default values */
2179   setFileInfoToDefaults(level_file_info);
2180
2181   level_file_info->nr = nr;     /* set requested level number */
2182
2183   determineLevelFileInfo_Filename(level_file_info);
2184   determineLevelFileInfo_Filetype(level_file_info);
2185 }
2186
2187 /* ------------------------------------------------------------------------- */
2188 /* functions for loading R'n'D level                                         */
2189 /* ------------------------------------------------------------------------- */
2190
2191 int getMappedElement(int element)
2192 {
2193   /* remap some (historic, now obsolete) elements */
2194
2195   switch (element)
2196   {
2197     case EL_PLAYER_OBSOLETE:
2198       element = EL_PLAYER_1;
2199       break;
2200
2201     case EL_KEY_OBSOLETE:
2202       element = EL_KEY_1;
2203       break;
2204
2205     case EL_EM_KEY_1_FILE_OBSOLETE:
2206       element = EL_EM_KEY_1;
2207       break;
2208
2209     case EL_EM_KEY_2_FILE_OBSOLETE:
2210       element = EL_EM_KEY_2;
2211       break;
2212
2213     case EL_EM_KEY_3_FILE_OBSOLETE:
2214       element = EL_EM_KEY_3;
2215       break;
2216
2217     case EL_EM_KEY_4_FILE_OBSOLETE:
2218       element = EL_EM_KEY_4;
2219       break;
2220
2221     case EL_ENVELOPE_OBSOLETE:
2222       element = EL_ENVELOPE_1;
2223       break;
2224
2225     case EL_SP_EMPTY:
2226       element = EL_EMPTY;
2227       break;
2228
2229     default:
2230       if (element >= NUM_FILE_ELEMENTS)
2231       {
2232         Error(ERR_WARN, "invalid level element %d", element);
2233
2234         element = EL_UNKNOWN;
2235       }
2236       break;
2237   }
2238
2239   return element;
2240 }
2241
2242 int getMappedElementByVersion(int element, int game_version)
2243 {
2244   /* remap some elements due to certain game version */
2245
2246   if (game_version <= VERSION_IDENT(2,2,0,0))
2247   {
2248     /* map game font elements */
2249     element = (element == EL_CHAR('[')  ? EL_CHAR_AUMLAUT :
2250                element == EL_CHAR('\\') ? EL_CHAR_OUMLAUT :
2251                element == EL_CHAR(']')  ? EL_CHAR_UUMLAUT :
2252                element == EL_CHAR('^')  ? EL_CHAR_COPYRIGHT : element);
2253   }
2254
2255   if (game_version < VERSION_IDENT(3,0,0,0))
2256   {
2257     /* map Supaplex gravity tube elements */
2258     element = (element == EL_SP_GRAVITY_PORT_LEFT  ? EL_SP_PORT_LEFT  :
2259                element == EL_SP_GRAVITY_PORT_RIGHT ? EL_SP_PORT_RIGHT :
2260                element == EL_SP_GRAVITY_PORT_UP    ? EL_SP_PORT_UP    :
2261                element == EL_SP_GRAVITY_PORT_DOWN  ? EL_SP_PORT_DOWN  :
2262                element);
2263   }
2264
2265   return element;
2266 }
2267
2268 static int LoadLevel_VERS(File *file, int chunk_size, struct LevelInfo *level)
2269 {
2270   level->file_version = getFileVersion(file);
2271   level->game_version = getFileVersion(file);
2272
2273   return chunk_size;
2274 }
2275
2276 static int LoadLevel_DATE(File *file, int chunk_size, struct LevelInfo *level)
2277 {
2278   level->creation_date.year  = getFile16BitBE(file);
2279   level->creation_date.month = getFile8Bit(file);
2280   level->creation_date.day   = getFile8Bit(file);
2281
2282   level->creation_date.src   = DATE_SRC_LEVELFILE;
2283
2284   return chunk_size;
2285 }
2286
2287 static int LoadLevel_HEAD(File *file, int chunk_size, struct LevelInfo *level)
2288 {
2289   int initial_player_stepsize;
2290   int initial_player_gravity;
2291   int i, x, y;
2292
2293   level->fieldx = getFile8Bit(file);
2294   level->fieldy = getFile8Bit(file);
2295
2296   level->time           = getFile16BitBE(file);
2297   level->gems_needed    = getFile16BitBE(file);
2298
2299   for (i = 0; i < MAX_LEVEL_NAME_LEN; i++)
2300     level->name[i] = getFile8Bit(file);
2301   level->name[MAX_LEVEL_NAME_LEN] = 0;
2302
2303   for (i = 0; i < LEVEL_SCORE_ELEMENTS; i++)
2304     level->score[i] = getFile8Bit(file);
2305
2306   level->num_yamyam_contents = STD_ELEMENT_CONTENTS;
2307   for (i = 0; i < STD_ELEMENT_CONTENTS; i++)
2308     for (y = 0; y < 3; y++)
2309       for (x = 0; x < 3; x++)
2310         level->yamyam_content[i].e[x][y] = getMappedElement(getFile8Bit(file));
2311
2312   level->amoeba_speed           = getFile8Bit(file);
2313   level->time_magic_wall        = getFile8Bit(file);
2314   level->time_wheel             = getFile8Bit(file);
2315   level->amoeba_content         = getMappedElement(getFile8Bit(file));
2316
2317   initial_player_stepsize       = (getFile8Bit(file) == 1 ? STEPSIZE_FAST :
2318                                    STEPSIZE_NORMAL);
2319
2320   for (i = 0; i < MAX_PLAYERS; i++)
2321     level->initial_player_stepsize[i] = initial_player_stepsize;
2322
2323   initial_player_gravity        = (getFile8Bit(file) == 1 ? TRUE : FALSE);
2324
2325   for (i = 0; i < MAX_PLAYERS; i++)
2326     level->initial_player_gravity[i] = initial_player_gravity;
2327
2328   level->encoding_16bit_field   = (getFile8Bit(file) == 1 ? TRUE : FALSE);
2329   level->em_slippery_gems       = (getFile8Bit(file) == 1 ? TRUE : FALSE);
2330
2331   level->use_custom_template    = (getFile8Bit(file) == 1 ? TRUE : FALSE);
2332
2333   level->block_last_field       = (getFile8Bit(file) == 1 ? TRUE : FALSE);
2334   level->sp_block_last_field    = (getFile8Bit(file) == 1 ? TRUE : FALSE);
2335   level->can_move_into_acid_bits = getFile32BitBE(file);
2336   level->dont_collide_with_bits = getFile8Bit(file);
2337
2338   level->use_spring_bug         = (getFile8Bit(file) == 1 ? TRUE : FALSE);
2339   level->use_step_counter       = (getFile8Bit(file) == 1 ? TRUE : FALSE);
2340
2341   level->instant_relocation     = (getFile8Bit(file) == 1 ? TRUE : FALSE);
2342   level->can_pass_to_walkable   = (getFile8Bit(file) == 1 ? TRUE : FALSE);
2343   level->grow_into_diggable     = (getFile8Bit(file) == 1 ? TRUE : FALSE);
2344
2345   level->game_engine_type       = getFile8Bit(file);
2346
2347   ReadUnusedBytesFromFile(file, LEVEL_CHUNK_HEAD_UNUSED);
2348
2349   return chunk_size;
2350 }
2351
2352 static int LoadLevel_NAME(File *file, int chunk_size, struct LevelInfo *level)
2353 {
2354   int i;
2355
2356   for (i = 0; i < MAX_LEVEL_NAME_LEN; i++)
2357     level->name[i] = getFile8Bit(file);
2358   level->name[MAX_LEVEL_NAME_LEN] = 0;
2359
2360   return chunk_size;
2361 }
2362
2363 static int LoadLevel_AUTH(File *file, int chunk_size, struct LevelInfo *level)
2364 {
2365   int i;
2366
2367   for (i = 0; i < MAX_LEVEL_AUTHOR_LEN; i++)
2368     level->author[i] = getFile8Bit(file);
2369   level->author[MAX_LEVEL_AUTHOR_LEN] = 0;
2370
2371   return chunk_size;
2372 }
2373
2374 static int LoadLevel_BODY(File *file, int chunk_size, struct LevelInfo *level)
2375 {
2376   int x, y;
2377   int chunk_size_expected = level->fieldx * level->fieldy;
2378
2379   /* Note: "chunk_size" was wrong before version 2.0 when elements are
2380      stored with 16-bit encoding (and should be twice as big then).
2381      Even worse, playfield data was stored 16-bit when only yamyam content
2382      contained 16-bit elements and vice versa. */
2383
2384   if (level->encoding_16bit_field && level->file_version >= FILE_VERSION_2_0)
2385     chunk_size_expected *= 2;
2386
2387   if (chunk_size_expected != chunk_size)
2388   {
2389     ReadUnusedBytesFromFile(file, chunk_size);
2390     return chunk_size_expected;
2391   }
2392
2393   for (y = 0; y < level->fieldy; y++)
2394     for (x = 0; x < level->fieldx; x++)
2395       level->field[x][y] =
2396         getMappedElement(level->encoding_16bit_field ? getFile16BitBE(file) :
2397                          getFile8Bit(file));
2398   return chunk_size;
2399 }
2400
2401 static int LoadLevel_CONT(File *file, int chunk_size, struct LevelInfo *level)
2402 {
2403   int i, x, y;
2404   int header_size = 4;
2405   int content_size = MAX_ELEMENT_CONTENTS * 3 * 3;
2406   int chunk_size_expected = header_size + content_size;
2407
2408   /* Note: "chunk_size" was wrong before version 2.0 when elements are
2409      stored with 16-bit encoding (and should be twice as big then).
2410      Even worse, playfield data was stored 16-bit when only yamyam content
2411      contained 16-bit elements and vice versa. */
2412
2413   if (level->encoding_16bit_field && level->file_version >= FILE_VERSION_2_0)
2414     chunk_size_expected += content_size;
2415
2416   if (chunk_size_expected != chunk_size)
2417   {
2418     ReadUnusedBytesFromFile(file, chunk_size);
2419     return chunk_size_expected;
2420   }
2421
2422   getFile8Bit(file);
2423   level->num_yamyam_contents = getFile8Bit(file);
2424   getFile8Bit(file);
2425   getFile8Bit(file);
2426
2427   /* correct invalid number of content fields -- should never happen */
2428   if (level->num_yamyam_contents < 1 ||
2429       level->num_yamyam_contents > MAX_ELEMENT_CONTENTS)
2430     level->num_yamyam_contents = STD_ELEMENT_CONTENTS;
2431
2432   for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
2433     for (y = 0; y < 3; y++)
2434       for (x = 0; x < 3; x++)
2435         level->yamyam_content[i].e[x][y] =
2436           getMappedElement(level->encoding_16bit_field ?
2437                            getFile16BitBE(file) : getFile8Bit(file));
2438   return chunk_size;
2439 }
2440
2441 static int LoadLevel_CNT2(File *file, int chunk_size, struct LevelInfo *level)
2442 {
2443   int i, x, y;
2444   int element;
2445   int num_contents;
2446   int content_array[MAX_ELEMENT_CONTENTS][3][3];
2447
2448   element = getMappedElement(getFile16BitBE(file));
2449   num_contents = getFile8Bit(file);
2450
2451   getFile8Bit(file);    /* content x size (unused) */
2452   getFile8Bit(file);    /* content y size (unused) */
2453
2454   ReadUnusedBytesFromFile(file, LEVEL_CHUNK_CNT2_UNUSED);
2455
2456   for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
2457     for (y = 0; y < 3; y++)
2458       for (x = 0; x < 3; x++)
2459         content_array[i][x][y] = getMappedElement(getFile16BitBE(file));
2460
2461   /* correct invalid number of content fields -- should never happen */
2462   if (num_contents < 1 || num_contents > MAX_ELEMENT_CONTENTS)
2463     num_contents = STD_ELEMENT_CONTENTS;
2464
2465   if (element == EL_YAMYAM)
2466   {
2467     level->num_yamyam_contents = num_contents;
2468
2469     for (i = 0; i < num_contents; i++)
2470       for (y = 0; y < 3; y++)
2471         for (x = 0; x < 3; x++)
2472           level->yamyam_content[i].e[x][y] = content_array[i][x][y];
2473   }
2474   else if (element == EL_BD_AMOEBA)
2475   {
2476     level->amoeba_content = content_array[0][0][0];
2477   }
2478   else
2479   {
2480     Error(ERR_WARN, "cannot load content for element '%d'", element);
2481   }
2482
2483   return chunk_size;
2484 }
2485
2486 static int LoadLevel_CNT3(File *file, int chunk_size, struct LevelInfo *level)
2487 {
2488   int i;
2489   int element;
2490   int envelope_nr;
2491   int envelope_len;
2492   int chunk_size_expected;
2493
2494   element = getMappedElement(getFile16BitBE(file));
2495   if (!IS_ENVELOPE(element))
2496     element = EL_ENVELOPE_1;
2497
2498   envelope_nr = element - EL_ENVELOPE_1;
2499
2500   envelope_len = getFile16BitBE(file);
2501
2502   level->envelope[envelope_nr].xsize = getFile8Bit(file);
2503   level->envelope[envelope_nr].ysize = getFile8Bit(file);
2504
2505   ReadUnusedBytesFromFile(file, LEVEL_CHUNK_CNT3_UNUSED);
2506
2507   chunk_size_expected = LEVEL_CHUNK_CNT3_SIZE(envelope_len);
2508   if (chunk_size_expected != chunk_size)
2509   {
2510     ReadUnusedBytesFromFile(file, chunk_size - LEVEL_CHUNK_CNT3_HEADER);
2511     return chunk_size_expected;
2512   }
2513
2514   for (i = 0; i < envelope_len; i++)
2515     level->envelope[envelope_nr].text[i] = getFile8Bit(file);
2516
2517   return chunk_size;
2518 }
2519
2520 static int LoadLevel_CUS1(File *file, int chunk_size, struct LevelInfo *level)
2521 {
2522   int num_changed_custom_elements = getFile16BitBE(file);
2523   int chunk_size_expected = 2 + num_changed_custom_elements * 6;
2524   int i;
2525
2526   if (chunk_size_expected != chunk_size)
2527   {
2528     ReadUnusedBytesFromFile(file, chunk_size - 2);
2529     return chunk_size_expected;
2530   }
2531
2532   for (i = 0; i < num_changed_custom_elements; i++)
2533   {
2534     int element = getMappedElement(getFile16BitBE(file));
2535     int properties = getFile32BitBE(file);
2536
2537     if (IS_CUSTOM_ELEMENT(element))
2538       element_info[element].properties[EP_BITFIELD_BASE_NR] = properties;
2539     else
2540       Error(ERR_WARN, "invalid custom element number %d", element);
2541
2542     /* older game versions that wrote level files with CUS1 chunks used
2543        different default push delay values (not yet stored in level file) */
2544     element_info[element].push_delay_fixed = 2;
2545     element_info[element].push_delay_random = 8;
2546   }
2547
2548   return chunk_size;
2549 }
2550
2551 static int LoadLevel_CUS2(File *file, int chunk_size, struct LevelInfo *level)
2552 {
2553   int num_changed_custom_elements = getFile16BitBE(file);
2554   int chunk_size_expected = 2 + num_changed_custom_elements * 4;
2555   int i;
2556
2557   if (chunk_size_expected != chunk_size)
2558   {
2559     ReadUnusedBytesFromFile(file, chunk_size - 2);
2560     return chunk_size_expected;
2561   }
2562
2563   for (i = 0; i < num_changed_custom_elements; i++)
2564   {
2565     int element = getMappedElement(getFile16BitBE(file));
2566     int custom_target_element = getMappedElement(getFile16BitBE(file));
2567
2568     if (IS_CUSTOM_ELEMENT(element))
2569       element_info[element].change->target_element = custom_target_element;
2570     else
2571       Error(ERR_WARN, "invalid custom element number %d", element);
2572   }
2573
2574   return chunk_size;
2575 }
2576
2577 static int LoadLevel_CUS3(File *file, int chunk_size, struct LevelInfo *level)
2578 {
2579   int num_changed_custom_elements = getFile16BitBE(file);
2580   int chunk_size_expected = LEVEL_CHUNK_CUS3_SIZE(num_changed_custom_elements);
2581   int i, j, x, y;
2582
2583   if (chunk_size_expected != chunk_size)
2584   {
2585     ReadUnusedBytesFromFile(file, chunk_size - 2);
2586     return chunk_size_expected;
2587   }
2588
2589   for (i = 0; i < num_changed_custom_elements; i++)
2590   {
2591     int element = getMappedElement(getFile16BitBE(file));
2592     struct ElementInfo *ei = &element_info[element];
2593     unsigned int event_bits;
2594
2595     if (!IS_CUSTOM_ELEMENT(element))
2596     {
2597       Error(ERR_WARN, "invalid custom element number %d", element);
2598
2599       element = EL_INTERNAL_DUMMY;
2600     }
2601
2602     for (j = 0; j < MAX_ELEMENT_NAME_LEN; j++)
2603       ei->description[j] = getFile8Bit(file);
2604     ei->description[MAX_ELEMENT_NAME_LEN] = 0;
2605
2606     ei->properties[EP_BITFIELD_BASE_NR] = getFile32BitBE(file);
2607
2608     /* some free bytes for future properties and padding */
2609     ReadUnusedBytesFromFile(file, 7);
2610
2611     ei->use_gfx_element = getFile8Bit(file);
2612     ei->gfx_element_initial = getMappedElement(getFile16BitBE(file));
2613
2614     ei->collect_score_initial = getFile8Bit(file);
2615     ei->collect_count_initial = getFile8Bit(file);
2616
2617     ei->push_delay_fixed = getFile16BitBE(file);
2618     ei->push_delay_random = getFile16BitBE(file);
2619     ei->move_delay_fixed = getFile16BitBE(file);
2620     ei->move_delay_random = getFile16BitBE(file);
2621
2622     ei->move_pattern = getFile16BitBE(file);
2623     ei->move_direction_initial = getFile8Bit(file);
2624     ei->move_stepsize = getFile8Bit(file);
2625
2626     for (y = 0; y < 3; y++)
2627       for (x = 0; x < 3; x++)
2628         ei->content.e[x][y] = getMappedElement(getFile16BitBE(file));
2629
2630     event_bits = getFile32BitBE(file);
2631     for (j = 0; j < NUM_CHANGE_EVENTS; j++)
2632       if (event_bits & (1 << j))
2633         ei->change->has_event[j] = TRUE;
2634
2635     ei->change->target_element = getMappedElement(getFile16BitBE(file));
2636
2637     ei->change->delay_fixed = getFile16BitBE(file);
2638     ei->change->delay_random = getFile16BitBE(file);
2639     ei->change->delay_frames = getFile16BitBE(file);
2640
2641     ei->change->initial_trigger_element= getMappedElement(getFile16BitBE(file));
2642
2643     ei->change->explode = getFile8Bit(file);
2644     ei->change->use_target_content = getFile8Bit(file);
2645     ei->change->only_if_complete = getFile8Bit(file);
2646     ei->change->use_random_replace = getFile8Bit(file);
2647
2648     ei->change->random_percentage = getFile8Bit(file);
2649     ei->change->replace_when = getFile8Bit(file);
2650
2651     for (y = 0; y < 3; y++)
2652       for (x = 0; x < 3; x++)
2653         ei->change->target_content.e[x][y] =
2654           getMappedElement(getFile16BitBE(file));
2655
2656     ei->slippery_type = getFile8Bit(file);
2657
2658     /* some free bytes for future properties and padding */
2659     ReadUnusedBytesFromFile(file, LEVEL_CPART_CUS3_UNUSED);
2660
2661     /* mark that this custom element has been modified */
2662     ei->modified_settings = TRUE;
2663   }
2664
2665   return chunk_size;
2666 }
2667
2668 static int LoadLevel_CUS4(File *file, int chunk_size, struct LevelInfo *level)
2669 {
2670   struct ElementInfo *ei;
2671   int chunk_size_expected;
2672   int element;
2673   int i, j, x, y;
2674
2675   /* ---------- custom element base property values (96 bytes) ------------- */
2676
2677   element = getMappedElement(getFile16BitBE(file));
2678
2679   if (!IS_CUSTOM_ELEMENT(element))
2680   {
2681     Error(ERR_WARN, "invalid custom element number %d", element);
2682
2683     ReadUnusedBytesFromFile(file, chunk_size - 2);
2684     return chunk_size;
2685   }
2686
2687   ei = &element_info[element];
2688
2689   for (i = 0; i < MAX_ELEMENT_NAME_LEN; i++)
2690     ei->description[i] = getFile8Bit(file);
2691   ei->description[MAX_ELEMENT_NAME_LEN] = 0;
2692
2693   ei->properties[EP_BITFIELD_BASE_NR] = getFile32BitBE(file);
2694
2695   ReadUnusedBytesFromFile(file, 4);     /* reserved for more base properties */
2696
2697   ei->num_change_pages = getFile8Bit(file);
2698
2699   chunk_size_expected = LEVEL_CHUNK_CUS4_SIZE(ei->num_change_pages);
2700   if (chunk_size_expected != chunk_size)
2701   {
2702     ReadUnusedBytesFromFile(file, chunk_size - 43);
2703     return chunk_size_expected;
2704   }
2705
2706   ei->ce_value_fixed_initial = getFile16BitBE(file);
2707   ei->ce_value_random_initial = getFile16BitBE(file);
2708   ei->use_last_ce_value = getFile8Bit(file);
2709
2710   ei->use_gfx_element = getFile8Bit(file);
2711   ei->gfx_element_initial = getMappedElement(getFile16BitBE(file));
2712
2713   ei->collect_score_initial = getFile8Bit(file);
2714   ei->collect_count_initial = getFile8Bit(file);
2715
2716   ei->drop_delay_fixed = getFile8Bit(file);
2717   ei->push_delay_fixed = getFile8Bit(file);
2718   ei->drop_delay_random = getFile8Bit(file);
2719   ei->push_delay_random = getFile8Bit(file);
2720   ei->move_delay_fixed = getFile16BitBE(file);
2721   ei->move_delay_random = getFile16BitBE(file);
2722
2723   /* bits 0 - 15 of "move_pattern" ... */
2724   ei->move_pattern = getFile16BitBE(file);
2725   ei->move_direction_initial = getFile8Bit(file);
2726   ei->move_stepsize = getFile8Bit(file);
2727
2728   ei->slippery_type = getFile8Bit(file);
2729
2730   for (y = 0; y < 3; y++)
2731     for (x = 0; x < 3; x++)
2732       ei->content.e[x][y] = getMappedElement(getFile16BitBE(file));
2733
2734   ei->move_enter_element = getMappedElement(getFile16BitBE(file));
2735   ei->move_leave_element = getMappedElement(getFile16BitBE(file));
2736   ei->move_leave_type = getFile8Bit(file);
2737
2738   /* ... bits 16 - 31 of "move_pattern" (not nice, but downward compatible) */
2739   ei->move_pattern |= (getFile16BitBE(file) << 16);
2740
2741   ei->access_direction = getFile8Bit(file);
2742
2743   ei->explosion_delay = getFile8Bit(file);
2744   ei->ignition_delay = getFile8Bit(file);
2745   ei->explosion_type = getFile8Bit(file);
2746
2747   /* some free bytes for future custom property values and padding */
2748   ReadUnusedBytesFromFile(file, 1);
2749
2750   /* ---------- change page property values (48 bytes) --------------------- */
2751
2752   setElementChangePages(ei, ei->num_change_pages);
2753
2754   for (i = 0; i < ei->num_change_pages; i++)
2755   {
2756     struct ElementChangeInfo *change = &ei->change_page[i];
2757     unsigned int event_bits;
2758
2759     /* always start with reliable default values */
2760     setElementChangeInfoToDefaults(change);
2761
2762     /* bits 0 - 31 of "has_event[]" ... */
2763     event_bits = getFile32BitBE(file);
2764     for (j = 0; j < MIN(NUM_CHANGE_EVENTS, 32); j++)
2765       if (event_bits & (1 << j))
2766         change->has_event[j] = TRUE;
2767
2768     change->target_element = getMappedElement(getFile16BitBE(file));
2769
2770     change->delay_fixed = getFile16BitBE(file);
2771     change->delay_random = getFile16BitBE(file);
2772     change->delay_frames = getFile16BitBE(file);
2773
2774     change->initial_trigger_element = getMappedElement(getFile16BitBE(file));
2775
2776     change->explode = getFile8Bit(file);
2777     change->use_target_content = getFile8Bit(file);
2778     change->only_if_complete = getFile8Bit(file);
2779     change->use_random_replace = getFile8Bit(file);
2780
2781     change->random_percentage = getFile8Bit(file);
2782     change->replace_when = getFile8Bit(file);
2783
2784     for (y = 0; y < 3; y++)
2785       for (x = 0; x < 3; x++)
2786         change->target_content.e[x][y]= getMappedElement(getFile16BitBE(file));
2787
2788     change->can_change = getFile8Bit(file);
2789
2790     change->trigger_side = getFile8Bit(file);
2791
2792     change->trigger_player = getFile8Bit(file);
2793     change->trigger_page = getFile8Bit(file);
2794
2795     change->trigger_page = (change->trigger_page == CH_PAGE_ANY_FILE ?
2796                             CH_PAGE_ANY : (1 << change->trigger_page));
2797
2798     change->has_action = getFile8Bit(file);
2799     change->action_type = getFile8Bit(file);
2800     change->action_mode = getFile8Bit(file);
2801     change->action_arg = getFile16BitBE(file);
2802
2803     /* ... bits 32 - 39 of "has_event[]" (not nice, but downward compatible) */
2804     event_bits = getFile8Bit(file);
2805     for (j = 32; j < NUM_CHANGE_EVENTS; j++)
2806       if (event_bits & (1 << (j - 32)))
2807         change->has_event[j] = TRUE;
2808   }
2809
2810   /* mark this custom element as modified */
2811   ei->modified_settings = TRUE;
2812
2813   return chunk_size;
2814 }
2815
2816 static int LoadLevel_GRP1(File *file, int chunk_size, struct LevelInfo *level)
2817 {
2818   struct ElementInfo *ei;
2819   struct ElementGroupInfo *group;
2820   int element;
2821   int i;
2822
2823   element = getMappedElement(getFile16BitBE(file));
2824
2825   if (!IS_GROUP_ELEMENT(element))
2826   {
2827     Error(ERR_WARN, "invalid group element number %d", element);
2828
2829     ReadUnusedBytesFromFile(file, chunk_size - 2);
2830     return chunk_size;
2831   }
2832
2833   ei = &element_info[element];
2834
2835   for (i = 0; i < MAX_ELEMENT_NAME_LEN; i++)
2836     ei->description[i] = getFile8Bit(file);
2837   ei->description[MAX_ELEMENT_NAME_LEN] = 0;
2838
2839   group = element_info[element].group;
2840
2841   group->num_elements = getFile8Bit(file);
2842
2843   ei->use_gfx_element = getFile8Bit(file);
2844   ei->gfx_element_initial = getMappedElement(getFile16BitBE(file));
2845
2846   group->choice_mode = getFile8Bit(file);
2847
2848   /* some free bytes for future values and padding */
2849   ReadUnusedBytesFromFile(file, 3);
2850
2851   for (i = 0; i < MAX_ELEMENTS_IN_GROUP; i++)
2852     group->element[i] = getMappedElement(getFile16BitBE(file));
2853
2854   /* mark this group element as modified */
2855   element_info[element].modified_settings = TRUE;
2856
2857   return chunk_size;
2858 }
2859
2860 static int LoadLevel_MicroChunk(File *file, struct LevelFileConfigInfo *conf,
2861                                 int element, int real_element)
2862 {
2863   int micro_chunk_size = 0;
2864   int conf_type = getFile8Bit(file);
2865   int byte_mask = conf_type & CONF_MASK_BYTES;
2866   boolean element_found = FALSE;
2867   int i;
2868
2869   micro_chunk_size += 1;
2870
2871   if (byte_mask == CONF_MASK_MULTI_BYTES)
2872   {
2873     int num_bytes = getFile16BitBE(file);
2874     byte *buffer = checked_malloc(num_bytes);
2875
2876     ReadBytesFromFile(file, buffer, num_bytes);
2877
2878     for (i = 0; conf[i].data_type != -1; i++)
2879     {
2880       if (conf[i].element == element &&
2881           conf[i].conf_type == conf_type)
2882       {
2883         int data_type = conf[i].data_type;
2884         int num_entities = num_bytes / CONF_ENTITY_NUM_BYTES(data_type);
2885         int max_num_entities = conf[i].max_num_entities;
2886
2887         if (num_entities > max_num_entities)
2888         {
2889           Error(ERR_WARN,
2890                 "truncating number of entities for element %d from %d to %d",
2891                 element, num_entities, max_num_entities);
2892
2893           num_entities = max_num_entities;
2894         }
2895
2896         if (num_entities == 0 && (data_type == TYPE_ELEMENT_LIST ||
2897                                   data_type == TYPE_CONTENT_LIST))
2898         {
2899           /* for element and content lists, zero entities are not allowed */
2900           Error(ERR_WARN, "found empty list of entities for element %d",
2901                 element);
2902
2903           /* do not set "num_entities" here to prevent reading behind buffer */
2904
2905           *(int *)(conf[i].num_entities) = 1;   /* at least one is required */
2906         }
2907         else
2908         {
2909           *(int *)(conf[i].num_entities) = num_entities;
2910         }
2911
2912         element_found = TRUE;
2913
2914         if (data_type == TYPE_STRING)
2915         {
2916           char *string = (char *)(conf[i].value);
2917           int j;
2918
2919           for (j = 0; j < max_num_entities; j++)
2920             string[j] = (j < num_entities ? buffer[j] : '\0');
2921         }
2922         else if (data_type == TYPE_ELEMENT_LIST)
2923         {
2924           int *element_array = (int *)(conf[i].value);
2925           int j;
2926
2927           for (j = 0; j < num_entities; j++)
2928             element_array[j] =
2929               getMappedElement(CONF_ELEMENTS_ELEMENT(buffer, j));
2930         }
2931         else if (data_type == TYPE_CONTENT_LIST)
2932         {
2933           struct Content *content= (struct Content *)(conf[i].value);
2934           int c, x, y;
2935
2936           for (c = 0; c < num_entities; c++)
2937             for (y = 0; y < 3; y++)
2938               for (x = 0; x < 3; x++)
2939                 content[c].e[x][y] =
2940                   getMappedElement(CONF_CONTENTS_ELEMENT(buffer, c, x, y));
2941         }
2942         else
2943           element_found = FALSE;
2944
2945         break;
2946       }
2947     }
2948
2949     checked_free(buffer);
2950
2951     micro_chunk_size += 2 + num_bytes;
2952   }
2953   else          /* constant size configuration data (1, 2 or 4 bytes) */
2954   {
2955     int value = (byte_mask == CONF_MASK_1_BYTE ? getFile8Bit   (file) :
2956                  byte_mask == CONF_MASK_2_BYTE ? getFile16BitBE(file) :
2957                  byte_mask == CONF_MASK_4_BYTE ? getFile32BitBE(file) : 0);
2958
2959     for (i = 0; conf[i].data_type != -1; i++)
2960     {
2961       if (conf[i].element == element &&
2962           conf[i].conf_type == conf_type)
2963       {
2964         int data_type = conf[i].data_type;
2965
2966         if (data_type == TYPE_ELEMENT)
2967           value = getMappedElement(value);
2968
2969         if (data_type == TYPE_BOOLEAN)
2970           *(boolean *)(conf[i].value) = value;
2971         else
2972           *(int *)    (conf[i].value) = value;
2973
2974         element_found = TRUE;
2975
2976         break;
2977       }
2978     }
2979
2980     micro_chunk_size += CONF_VALUE_NUM_BYTES(byte_mask);
2981   }
2982
2983   if (!element_found)
2984   {
2985     char *error_conf_chunk_bytes =
2986       (byte_mask == CONF_MASK_1_BYTE ? "CONF_VALUE_8_BIT" :
2987        byte_mask == CONF_MASK_2_BYTE ? "CONF_VALUE_16_BIT" :
2988        byte_mask == CONF_MASK_4_BYTE ? "CONF_VALUE_32_BIT" :"CONF_VALUE_BYTES");
2989     int error_conf_chunk_token = conf_type & CONF_MASK_TOKEN;
2990     int error_element = real_element;
2991
2992     Error(ERR_WARN, "cannot load micro chunk '%s(%d)' value for element %d ['%s']",
2993           error_conf_chunk_bytes, error_conf_chunk_token,
2994           error_element, EL_NAME(error_element));
2995   }
2996
2997   return micro_chunk_size;
2998 }
2999
3000 static int LoadLevel_INFO(File *file, int chunk_size, struct LevelInfo *level)
3001 {
3002   int real_chunk_size = 0;
3003
3004   li = *level;          /* copy level data into temporary buffer */
3005
3006   while (!checkEndOfFile(file))
3007   {
3008     real_chunk_size += LoadLevel_MicroChunk(file, chunk_config_INFO, -1, -1);
3009
3010     if (real_chunk_size >= chunk_size)
3011       break;
3012   }
3013
3014   *level = li;          /* copy temporary buffer back to level data */
3015
3016   return real_chunk_size;
3017 }
3018
3019 static int LoadLevel_CONF(File *file, int chunk_size, struct LevelInfo *level)
3020 {
3021   int real_chunk_size = 0;
3022
3023   li = *level;          /* copy level data into temporary buffer */
3024
3025   while (!checkEndOfFile(file))
3026   {
3027     int element = getMappedElement(getFile16BitBE(file));
3028
3029     real_chunk_size += 2;
3030     real_chunk_size += LoadLevel_MicroChunk(file, chunk_config_CONF,
3031                                             element, element);
3032     if (real_chunk_size >= chunk_size)
3033       break;
3034   }
3035
3036   *level = li;          /* copy temporary buffer back to level data */
3037
3038   return real_chunk_size;
3039 }
3040
3041 static int LoadLevel_ELEM(File *file, int chunk_size, struct LevelInfo *level)
3042 {
3043   int real_chunk_size = 0;
3044
3045   li = *level;          /* copy level data into temporary buffer */
3046
3047   while (!checkEndOfFile(file))
3048   {
3049     int element = getMappedElement(getFile16BitBE(file));
3050
3051     real_chunk_size += 2;
3052     real_chunk_size += LoadLevel_MicroChunk(file, chunk_config_ELEM,
3053                                             element, element);
3054     if (real_chunk_size >= chunk_size)
3055       break;
3056   }
3057
3058   *level = li;          /* copy temporary buffer back to level data */
3059
3060   return real_chunk_size;
3061 }
3062
3063 static int LoadLevel_NOTE(File *file, int chunk_size, struct LevelInfo *level)
3064 {
3065   int element = getMappedElement(getFile16BitBE(file));
3066   int envelope_nr = element - EL_ENVELOPE_1;
3067   int real_chunk_size = 2;
3068
3069   xx_envelope = level->envelope[envelope_nr];   /* copy into temporary buffer */
3070
3071   while (!checkEndOfFile(file))
3072   {
3073     real_chunk_size += LoadLevel_MicroChunk(file, chunk_config_NOTE,
3074                                             -1, element);
3075
3076     if (real_chunk_size >= chunk_size)
3077       break;
3078   }
3079
3080   level->envelope[envelope_nr] = xx_envelope;   /* copy from temporary buffer */
3081
3082   return real_chunk_size;
3083 }
3084
3085 static int LoadLevel_CUSX(File *file, int chunk_size, struct LevelInfo *level)
3086 {
3087   int element = getMappedElement(getFile16BitBE(file));
3088   int real_chunk_size = 2;
3089   struct ElementInfo *ei = &element_info[element];
3090   int i;
3091
3092   xx_ei = *ei;          /* copy element data into temporary buffer */
3093
3094   xx_ei.num_change_pages = -1;
3095
3096   while (!checkEndOfFile(file))
3097   {
3098     real_chunk_size += LoadLevel_MicroChunk(file, chunk_config_CUSX_base,
3099                                             -1, element);
3100     if (xx_ei.num_change_pages != -1)
3101       break;
3102
3103     if (real_chunk_size >= chunk_size)
3104       break;
3105   }
3106
3107   *ei = xx_ei;
3108
3109   if (ei->num_change_pages == -1)
3110   {
3111     Error(ERR_WARN, "LoadLevel_CUSX(): missing 'num_change_pages' for '%s'",
3112           EL_NAME(element));
3113
3114     ei->num_change_pages = 1;
3115
3116     setElementChangePages(ei, 1);
3117     setElementChangeInfoToDefaults(ei->change);
3118
3119     return real_chunk_size;
3120   }
3121
3122   /* initialize number of change pages stored for this custom element */
3123   setElementChangePages(ei, ei->num_change_pages);
3124   for (i = 0; i < ei->num_change_pages; i++)
3125     setElementChangeInfoToDefaults(&ei->change_page[i]);
3126
3127   /* start with reading properties for the first change page */
3128   xx_current_change_page = 0;
3129
3130   while (!checkEndOfFile(file))
3131   {
3132     struct ElementChangeInfo *change = &ei->change_page[xx_current_change_page];
3133
3134     xx_change = *change;        /* copy change data into temporary buffer */
3135
3136     resetEventBits();           /* reset bits; change page might have changed */
3137
3138     real_chunk_size += LoadLevel_MicroChunk(file, chunk_config_CUSX_change,
3139                                             -1, element);
3140
3141     *change = xx_change;
3142
3143     setEventFlagsFromEventBits(change);
3144
3145     if (real_chunk_size >= chunk_size)
3146       break;
3147   }
3148
3149   return real_chunk_size;
3150 }
3151
3152 static int LoadLevel_GRPX(File *file, int chunk_size, struct LevelInfo *level)
3153 {
3154   int element = getMappedElement(getFile16BitBE(file));
3155   int real_chunk_size = 2;
3156   struct ElementInfo *ei = &element_info[element];
3157   struct ElementGroupInfo *group = ei->group;
3158
3159   xx_ei = *ei;          /* copy element data into temporary buffer */
3160   xx_group = *group;    /* copy group data into temporary buffer */
3161
3162   while (!checkEndOfFile(file))
3163   {
3164     real_chunk_size += LoadLevel_MicroChunk(file, chunk_config_GRPX,
3165                                             -1, element);
3166
3167     if (real_chunk_size >= chunk_size)
3168       break;
3169   }
3170
3171   *ei = xx_ei;
3172   *group = xx_group;
3173
3174   return real_chunk_size;
3175 }
3176
3177 static void LoadLevelFromFileInfo_RND(struct LevelInfo *level,
3178                                       struct LevelFileInfo *level_file_info,
3179                                       boolean level_info_only)
3180 {
3181   char *filename = level_file_info->filename;
3182   char cookie[MAX_LINE_LEN];
3183   char chunk_name[CHUNK_ID_LEN + 1];
3184   int chunk_size;
3185   File *file;
3186
3187   if (!(file = openFile(filename, MODE_READ)))
3188   {
3189     level->no_valid_file = TRUE;
3190     level->no_level_file = TRUE;
3191
3192     if (level_info_only)
3193       return;
3194
3195     Error(ERR_WARN, "cannot read level '%s' -- using empty level", filename);
3196
3197     if (!setup.editor.use_template_for_new_levels)
3198       return;
3199
3200     /* if level file not found, try to initialize level data from template */
3201     filename = getGlobalLevelTemplateFilename();
3202
3203     if (!(file = openFile(filename, MODE_READ)))
3204       return;
3205
3206     /* default: for empty levels, use level template for custom elements */
3207     level->use_custom_template = TRUE;
3208
3209     level->no_valid_file = FALSE;
3210   }
3211
3212   getFileChunkBE(file, chunk_name, NULL);
3213   if (strEqual(chunk_name, "RND1"))
3214   {
3215     getFile32BitBE(file);               /* not used */
3216
3217     getFileChunkBE(file, chunk_name, NULL);
3218     if (!strEqual(chunk_name, "CAVE"))
3219     {
3220       level->no_valid_file = TRUE;
3221
3222       Error(ERR_WARN, "unknown format of level file '%s'", filename);
3223
3224       closeFile(file);
3225
3226       return;
3227     }
3228   }
3229   else  /* check for pre-2.0 file format with cookie string */
3230   {
3231     strcpy(cookie, chunk_name);
3232     if (getStringFromFile(file, &cookie[4], MAX_LINE_LEN - 4) == NULL)
3233       cookie[4] = '\0';
3234     if (strlen(cookie) > 0 && cookie[strlen(cookie) - 1] == '\n')
3235       cookie[strlen(cookie) - 1] = '\0';
3236
3237     if (!checkCookieString(cookie, LEVEL_COOKIE_TMPL))
3238     {
3239       level->no_valid_file = TRUE;
3240
3241       Error(ERR_WARN, "unknown format of level file '%s'", filename);
3242
3243       closeFile(file);
3244
3245       return;
3246     }
3247
3248     if ((level->file_version = getFileVersionFromCookieString(cookie)) == -1)
3249     {
3250       level->no_valid_file = TRUE;
3251
3252       Error(ERR_WARN, "unsupported version of level file '%s'", filename);
3253
3254       closeFile(file);
3255
3256       return;
3257     }
3258
3259     /* pre-2.0 level files have no game version, so use file version here */
3260     level->game_version = level->file_version;
3261   }
3262
3263   if (level->file_version < FILE_VERSION_1_2)
3264   {
3265     /* level files from versions before 1.2.0 without chunk structure */
3266     LoadLevel_HEAD(file, LEVEL_CHUNK_HEAD_SIZE,         level);
3267     LoadLevel_BODY(file, level->fieldx * level->fieldy, level);
3268   }
3269   else
3270   {
3271     static struct
3272     {
3273       char *name;
3274       int size;
3275       int (*loader)(File *, int, struct LevelInfo *);
3276     }
3277     chunk_info[] =
3278     {
3279       { "VERS", LEVEL_CHUNK_VERS_SIZE,  LoadLevel_VERS },
3280       { "DATE", LEVEL_CHUNK_DATE_SIZE,  LoadLevel_DATE },
3281       { "HEAD", LEVEL_CHUNK_HEAD_SIZE,  LoadLevel_HEAD },
3282       { "NAME", LEVEL_CHUNK_NAME_SIZE,  LoadLevel_NAME },
3283       { "AUTH", LEVEL_CHUNK_AUTH_SIZE,  LoadLevel_AUTH },
3284       { "INFO", -1,                     LoadLevel_INFO },
3285       { "BODY", -1,                     LoadLevel_BODY },
3286       { "CONT", -1,                     LoadLevel_CONT },
3287       { "CNT2", LEVEL_CHUNK_CNT2_SIZE,  LoadLevel_CNT2 },
3288       { "CNT3", -1,                     LoadLevel_CNT3 },
3289       { "CUS1", -1,                     LoadLevel_CUS1 },
3290       { "CUS2", -1,                     LoadLevel_CUS2 },
3291       { "CUS3", -1,                     LoadLevel_CUS3 },
3292       { "CUS4", -1,                     LoadLevel_CUS4 },
3293       { "GRP1", -1,                     LoadLevel_GRP1 },
3294       { "CONF", -1,                     LoadLevel_CONF },
3295       { "ELEM", -1,                     LoadLevel_ELEM },
3296       { "NOTE", -1,                     LoadLevel_NOTE },
3297       { "CUSX", -1,                     LoadLevel_CUSX },
3298       { "GRPX", -1,                     LoadLevel_GRPX },
3299
3300       {  NULL,  0,                      NULL }
3301     };
3302
3303     while (getFileChunkBE(file, chunk_name, &chunk_size))
3304     {
3305       int i = 0;
3306
3307       while (chunk_info[i].name != NULL &&
3308              !strEqual(chunk_name, chunk_info[i].name))
3309         i++;
3310
3311       if (chunk_info[i].name == NULL)
3312       {
3313         Error(ERR_WARN, "unknown chunk '%s' in level file '%s'",
3314               chunk_name, filename);
3315         ReadUnusedBytesFromFile(file, chunk_size);
3316       }
3317       else if (chunk_info[i].size != -1 &&
3318                chunk_info[i].size != chunk_size)
3319       {
3320         Error(ERR_WARN, "wrong size (%d) of chunk '%s' in level file '%s'",
3321               chunk_size, chunk_name, filename);
3322         ReadUnusedBytesFromFile(file, chunk_size);
3323       }
3324       else
3325       {
3326         /* call function to load this level chunk */
3327         int chunk_size_expected =
3328           (chunk_info[i].loader)(file, chunk_size, level);
3329
3330         /* the size of some chunks cannot be checked before reading other
3331            chunks first (like "HEAD" and "BODY") that contain some header
3332            information, so check them here */
3333         if (chunk_size_expected != chunk_size)
3334         {
3335           Error(ERR_WARN, "wrong size (%d) of chunk '%s' in level file '%s'",
3336                 chunk_size, chunk_name, filename);
3337         }
3338       }
3339     }
3340   }
3341
3342   closeFile(file);
3343 }
3344
3345
3346 /* ------------------------------------------------------------------------- */
3347 /* functions for loading EM level                                            */
3348 /* ------------------------------------------------------------------------- */
3349
3350 void CopyNativeLevel_RND_to_EM(struct LevelInfo *level)
3351 {
3352   static int ball_xy[8][2] =
3353   {
3354     { 0, 0 },
3355     { 1, 0 },
3356     { 2, 0 },
3357     { 0, 1 },
3358     { 2, 1 },
3359     { 0, 2 },
3360     { 1, 2 },
3361     { 2, 2 },
3362   };
3363   struct LevelInfo_EM *level_em = level->native_em_level;
3364   struct LEVEL *lev = level_em->lev;
3365   struct PLAYER **ply = level_em->ply;
3366   int i, j, x, y;
3367
3368   lev->width  = MIN(level->fieldx, EM_MAX_CAVE_WIDTH);
3369   lev->height = MIN(level->fieldy, EM_MAX_CAVE_HEIGHT);
3370
3371   lev->time_seconds     = level->time;
3372   lev->required_initial = level->gems_needed;
3373
3374   lev->emerald_score    = level->score[SC_EMERALD];
3375   lev->diamond_score    = level->score[SC_DIAMOND];
3376   lev->alien_score      = level->score[SC_ROBOT];
3377   lev->tank_score       = level->score[SC_SPACESHIP];
3378   lev->bug_score        = level->score[SC_BUG];
3379   lev->eater_score      = level->score[SC_YAMYAM];
3380   lev->nut_score        = level->score[SC_NUT];
3381   lev->dynamite_score   = level->score[SC_DYNAMITE];
3382   lev->key_score        = level->score[SC_KEY];
3383   lev->exit_score       = level->score[SC_TIME_BONUS];
3384
3385   for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
3386     for (y = 0; y < 3; y++)
3387       for (x = 0; x < 3; x++)
3388         lev->eater_array[i][y * 3 + x] =
3389           map_element_RND_to_EM(level->yamyam_content[i].e[x][y]);
3390
3391   lev->amoeba_time              = level->amoeba_speed;
3392   lev->wonderwall_time_initial  = level->time_magic_wall;
3393   lev->wheel_time               = level->time_wheel;
3394
3395   lev->android_move_time        = level->android_move_time;
3396   lev->android_clone_time       = level->android_clone_time;
3397   lev->ball_random              = level->ball_random;
3398   lev->ball_state_initial       = level->ball_state_initial;
3399   lev->ball_time                = level->ball_time;
3400   lev->num_ball_arrays          = level->num_ball_contents;
3401
3402   lev->lenses_score             = level->lenses_score;
3403   lev->magnify_score            = level->magnify_score;
3404   lev->slurp_score              = level->slurp_score;
3405
3406   lev->lenses_time              = level->lenses_time;
3407   lev->magnify_time             = level->magnify_time;
3408
3409   lev->wind_direction_initial =
3410     map_direction_RND_to_EM(level->wind_direction_initial);
3411   lev->wind_cnt_initial = (level->wind_direction_initial != MV_NONE ?
3412                            lev->wind_time : 0);
3413
3414   for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
3415     for (j = 0; j < 8; j++)
3416       lev->ball_array[i][j] =
3417         map_element_RND_to_EM(level->
3418                               ball_content[i].e[ball_xy[j][0]][ball_xy[j][1]]);
3419
3420   map_android_clone_elements_RND_to_EM(level);
3421
3422   /* first fill the complete playfield with the default border element */
3423   for (y = 0; y < EM_MAX_CAVE_HEIGHT; y++)
3424     for (x = 0; x < EM_MAX_CAVE_WIDTH; x++)
3425       level_em->cave[x][y] = ZBORDER;
3426
3427   if (BorderElement == EL_STEELWALL)
3428   {
3429     for (y = 0; y < lev->height + 2; y++)
3430       for (x = 0; x < lev->width + 2; x++)
3431         level_em->cave[x + 1][y + 1] = map_element_RND_to_EM(EL_STEELWALL);
3432   }
3433
3434   /* then copy the real level contents from level file into the playfield */
3435   for (y = 0; y < lev->height; y++) for (x = 0; x < lev->width; x++)
3436   {
3437     int new_element = map_element_RND_to_EM(level->field[x][y]);
3438     int offset = (BorderElement == EL_STEELWALL ? 1 : 0);
3439     int xx = x + 1 + offset;
3440     int yy = y + 1 + offset;
3441
3442     if (level->field[x][y] == EL_AMOEBA_DEAD)
3443       new_element = map_element_RND_to_EM(EL_AMOEBA_WET);
3444
3445     level_em->cave[xx][yy] = new_element;
3446   }
3447
3448   for (i = 0; i < MAX_PLAYERS; i++)
3449   {
3450     ply[i]->x_initial = 0;
3451     ply[i]->y_initial = 0;
3452   }
3453
3454   /* initialize player positions and delete players from the playfield */
3455   for (y = 0; y < lev->height; y++) for (x = 0; x < lev->width; x++)
3456   {
3457     if (ELEM_IS_PLAYER(level->field[x][y]))
3458     {
3459       int player_nr = GET_PLAYER_NR(level->field[x][y]);
3460       int offset = (BorderElement == EL_STEELWALL ? 1 : 0);
3461       int xx = x + 1 + offset;
3462       int yy = y + 1 + offset;
3463
3464       ply[player_nr]->x_initial = xx;
3465       ply[player_nr]->y_initial = yy;
3466
3467       level_em->cave[xx][yy] = map_element_RND_to_EM(EL_EMPTY);
3468     }
3469   }
3470
3471   if (BorderElement == EL_STEELWALL)
3472   {
3473     lev->width  += 2;
3474     lev->height += 2;
3475   }
3476 }
3477
3478 void CopyNativeLevel_EM_to_RND(struct LevelInfo *level)
3479 {
3480   static int ball_xy[8][2] =
3481   {
3482     { 0, 0 },
3483     { 1, 0 },
3484     { 2, 0 },
3485     { 0, 1 },
3486     { 2, 1 },
3487     { 0, 2 },
3488     { 1, 2 },
3489     { 2, 2 },
3490   };
3491   struct LevelInfo_EM *level_em = level->native_em_level;
3492   struct LEVEL *lev = level_em->lev;
3493   struct PLAYER **ply = level_em->ply;
3494   int i, j, x, y;
3495
3496   level->fieldx = MIN(lev->width,  MAX_LEV_FIELDX);
3497   level->fieldy = MIN(lev->height, MAX_LEV_FIELDY);
3498
3499   level->time        = lev->time_seconds;
3500   level->gems_needed = lev->required_initial;
3501
3502   sprintf(level->name, "Level %d", level->file_info.nr);
3503
3504   level->score[SC_EMERALD]      = lev->emerald_score;
3505   level->score[SC_DIAMOND]      = lev->diamond_score;
3506   level->score[SC_ROBOT]        = lev->alien_score;
3507   level->score[SC_SPACESHIP]    = lev->tank_score;
3508   level->score[SC_BUG]          = lev->bug_score;
3509   level->score[SC_YAMYAM]       = lev->eater_score;
3510   level->score[SC_NUT]          = lev->nut_score;
3511   level->score[SC_DYNAMITE]     = lev->dynamite_score;
3512   level->score[SC_KEY]          = lev->key_score;
3513   level->score[SC_TIME_BONUS]   = lev->exit_score;
3514
3515   level->num_yamyam_contents = MAX_ELEMENT_CONTENTS;
3516
3517   for (i = 0; i < level->num_yamyam_contents; i++)
3518     for (y = 0; y < 3; y++)
3519       for (x = 0; x < 3; x++)
3520         level->yamyam_content[i].e[x][y] =
3521           map_element_EM_to_RND(lev->eater_array[i][y * 3 + x]);
3522
3523   level->amoeba_speed           = lev->amoeba_time;
3524   level->time_magic_wall        = lev->wonderwall_time_initial;
3525   level->time_wheel             = lev->wheel_time;
3526
3527   level->android_move_time      = lev->android_move_time;
3528   level->android_clone_time     = lev->android_clone_time;
3529   level->ball_random            = lev->ball_random;
3530   level->ball_state_initial     = lev->ball_state_initial;
3531   level->ball_time              = lev->ball_time;
3532   level->num_ball_contents      = lev->num_ball_arrays;
3533
3534   level->lenses_score           = lev->lenses_score;
3535   level->magnify_score          = lev->magnify_score;
3536   level->slurp_score            = lev->slurp_score;
3537
3538   level->lenses_time            = lev->lenses_time;
3539   level->magnify_time           = lev->magnify_time;
3540
3541   level->wind_direction_initial =
3542     map_direction_EM_to_RND(lev->wind_direction_initial);
3543
3544   for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
3545     for (j = 0; j < 8; j++)
3546       level->ball_content[i].e[ball_xy[j][0]][ball_xy[j][1]] =
3547         map_element_EM_to_RND(lev->ball_array[i][j]);
3548
3549   map_android_clone_elements_EM_to_RND(level);
3550
3551   /* convert the playfield (some elements need special treatment) */
3552   for (y = 0; y < level->fieldy; y++) for (x = 0; x < level->fieldx; x++)
3553   {
3554     int new_element = map_element_EM_to_RND(level_em->cave[x + 1][y + 1]);
3555
3556     if (new_element == EL_AMOEBA_WET && level->amoeba_speed == 0)
3557       new_element = EL_AMOEBA_DEAD;
3558
3559     level->field[x][y] = new_element;
3560   }
3561
3562   for (i = 0; i < MAX_PLAYERS; i++)
3563   {
3564     /* in case of all players set to the same field, use the first player */
3565     int nr = MAX_PLAYERS - i - 1;
3566     int jx = ply[nr]->x_initial - 1;
3567     int jy = ply[nr]->y_initial - 1;
3568
3569     if (jx != -1 && jy != -1)
3570       level->field[jx][jy] = EL_PLAYER_1 + nr;
3571   }
3572 }
3573
3574
3575 /* ------------------------------------------------------------------------- */
3576 /* functions for loading SP level                                            */
3577 /* ------------------------------------------------------------------------- */
3578
3579 void CopyNativeLevel_RND_to_SP(struct LevelInfo *level)
3580 {
3581   struct LevelInfo_SP *level_sp = level->native_sp_level;
3582   LevelInfoType *header = &level_sp->header;
3583   int i, x, y;
3584
3585   level_sp->width  = level->fieldx;
3586   level_sp->height = level->fieldy;
3587
3588   for (x = 0; x < level->fieldx; x++)
3589     for (y = 0; y < level->fieldy; y++)
3590       level_sp->playfield[x][y] = map_element_RND_to_SP(level->field[x][y]);
3591
3592   header->InitialGravity = (level->initial_player_gravity[0] ? 1 : 0);
3593
3594   for (i = 0; i < SP_LEVEL_NAME_LEN; i++)
3595     header->LevelTitle[i] = level->name[i];
3596   /* !!! NO STRING TERMINATION IN SUPAPLEX VB CODE YET -- FIX THIS !!! */
3597
3598   header->InfotronsNeeded = level->gems_needed;
3599
3600   header->SpecialPortCount = 0;
3601
3602   for (x = 0; x < level->fieldx; x++) for (y = 0; y < level->fieldy; y++)
3603   {
3604     boolean gravity_port_found = FALSE;
3605     boolean gravity_port_valid = FALSE;
3606     int gravity_port_flag;
3607     int gravity_port_base_element;
3608     int element = level->field[x][y];
3609
3610     if (element >= EL_SP_GRAVITY_ON_PORT_RIGHT &&
3611         element <= EL_SP_GRAVITY_ON_PORT_UP)
3612     {
3613       gravity_port_found = TRUE;
3614       gravity_port_valid = TRUE;
3615       gravity_port_flag = 1;
3616       gravity_port_base_element = EL_SP_GRAVITY_ON_PORT_RIGHT;
3617     }
3618     else if (element >= EL_SP_GRAVITY_OFF_PORT_RIGHT &&
3619              element <= EL_SP_GRAVITY_OFF_PORT_UP)
3620     {
3621       gravity_port_found = TRUE;
3622       gravity_port_valid = TRUE;
3623       gravity_port_flag = 0;
3624       gravity_port_base_element = EL_SP_GRAVITY_OFF_PORT_RIGHT;
3625     }
3626     else if (element >= EL_SP_GRAVITY_PORT_RIGHT &&
3627              element <= EL_SP_GRAVITY_PORT_UP)
3628     {
3629       /* change R'n'D style gravity inverting special port to normal port
3630          (there are no gravity inverting ports in native Supaplex engine) */
3631
3632       gravity_port_found = TRUE;
3633       gravity_port_valid = FALSE;
3634       gravity_port_base_element = EL_SP_GRAVITY_PORT_RIGHT;
3635     }
3636
3637     if (gravity_port_found)
3638     {
3639       if (gravity_port_valid &&
3640           header->SpecialPortCount < SP_MAX_SPECIAL_PORTS)
3641       {
3642         SpecialPortType *port = &header->SpecialPort[header->SpecialPortCount];
3643
3644         port->PortLocation = (y * level->fieldx + x) * 2;
3645         port->Gravity = gravity_port_flag;
3646
3647         element += EL_SP_GRAVITY_PORT_RIGHT - gravity_port_base_element;
3648
3649         header->SpecialPortCount++;
3650       }
3651       else
3652       {
3653         /* change special gravity port to normal port */
3654
3655         element += EL_SP_PORT_RIGHT - gravity_port_base_element;
3656       }
3657
3658       level_sp->playfield[x][y] = element - EL_SP_START;
3659     }
3660   }
3661 }
3662
3663 void CopyNativeLevel_SP_to_RND(struct LevelInfo *level)
3664 {
3665   struct LevelInfo_SP *level_sp = level->native_sp_level;
3666   LevelInfoType *header = &level_sp->header;
3667   int i, x, y;
3668
3669   level->fieldx = level_sp->width;
3670   level->fieldy = level_sp->height;
3671
3672   for (x = 0; x < level->fieldx; x++)
3673   {
3674     for (y = 0; y < level->fieldy; y++)
3675     {
3676       int element_old = level_sp->playfield[x][y];
3677       int element_new = getMappedElement(map_element_SP_to_RND(element_old));
3678
3679       if (element_new == EL_UNKNOWN)
3680         Error(ERR_WARN, "invalid element %d at position %d, %d",
3681               element_old, x, y);
3682
3683       level->field[x][y] = element_new;
3684     }
3685   }
3686
3687   for (i = 0; i < MAX_PLAYERS; i++)
3688     level->initial_player_gravity[i] =
3689       (header->InitialGravity == 1 ? TRUE : FALSE);
3690
3691   for (i = 0; i < SP_LEVEL_NAME_LEN; i++)
3692     level->name[i] = header->LevelTitle[i];
3693   level->name[SP_LEVEL_NAME_LEN] = '\0';
3694
3695   level->gems_needed = header->InfotronsNeeded;
3696
3697   for (i = 0; i < header->SpecialPortCount; i++)
3698   {
3699     SpecialPortType *port = &header->SpecialPort[i];
3700     int port_location = port->PortLocation;
3701     int gravity = port->Gravity;
3702     int port_x, port_y, port_element;
3703
3704     port_x = (port_location / 2) % level->fieldx;
3705     port_y = (port_location / 2) / level->fieldx;
3706
3707     if (port_x < 0 || port_x >= level->fieldx ||
3708         port_y < 0 || port_y >= level->fieldy)
3709     {
3710       Error(ERR_WARN, "special port position (%d, %d) out of bounds",
3711             port_x, port_y);
3712
3713       continue;
3714     }
3715
3716     port_element = level->field[port_x][port_y];
3717
3718     if (port_element < EL_SP_GRAVITY_PORT_RIGHT ||
3719         port_element > EL_SP_GRAVITY_PORT_UP)
3720     {
3721       Error(ERR_WARN, "no special port at position (%d, %d)", port_x, port_y);
3722
3723       continue;
3724     }
3725
3726     /* change previous (wrong) gravity inverting special port to either
3727        gravity enabling special port or gravity disabling special port */
3728     level->field[port_x][port_y] +=
3729       (gravity == 1 ? EL_SP_GRAVITY_ON_PORT_RIGHT :
3730        EL_SP_GRAVITY_OFF_PORT_RIGHT) - EL_SP_GRAVITY_PORT_RIGHT;
3731   }
3732
3733   /* change special gravity ports without database entries to normal ports */
3734   for (x = 0; x < level->fieldx; x++)
3735     for (y = 0; y < level->fieldy; y++)
3736       if (level->field[x][y] >= EL_SP_GRAVITY_PORT_RIGHT &&
3737           level->field[x][y] <= EL_SP_GRAVITY_PORT_UP)
3738         level->field[x][y] += EL_SP_PORT_RIGHT - EL_SP_GRAVITY_PORT_RIGHT;
3739
3740   level->time = 0;                      /* no time limit */
3741   level->amoeba_speed = 0;
3742   level->time_magic_wall = 0;
3743   level->time_wheel = 0;
3744   level->amoeba_content = EL_EMPTY;
3745
3746 #if 1
3747   /* original Supaplex does not use score values -- use default values */
3748 #else
3749   for (i = 0; i < LEVEL_SCORE_ELEMENTS; i++)
3750     level->score[i] = 0;
3751 #endif
3752
3753   /* there are no yamyams in supaplex levels */
3754   for (i = 0; i < level->num_yamyam_contents; i++)
3755     for (x = 0; x < 3; x++)
3756       for (y = 0; y < 3; y++)
3757         level->yamyam_content[i].e[x][y] = EL_EMPTY;
3758 }
3759
3760 static void CopyNativeTape_RND_to_SP(struct LevelInfo *level)
3761 {
3762   struct LevelInfo_SP *level_sp = level->native_sp_level;
3763   struct DemoInfo_SP *demo = &level_sp->demo;
3764   int i, j;
3765
3766   /* always start with reliable default values */
3767   demo->is_available = FALSE;
3768   demo->length = 0;
3769
3770   if (TAPE_IS_EMPTY(tape))
3771     return;
3772
3773   demo->level_nr = tape.level_nr;       /* (currently not used) */
3774
3775   level_sp->header.DemoRandomSeed = tape.random_seed;
3776
3777   demo->length = 0;
3778   for (i = 0; i < tape.length; i++)
3779   {
3780     int demo_action = map_key_RND_to_SP(tape.pos[i].action[0]);
3781     int demo_repeat = tape.pos[i].delay;
3782
3783     for (j = 0; j < demo_repeat / 16; j++)
3784       demo->data[demo->length++] = 0xf0 | demo_action;
3785
3786     if (demo_repeat % 16)
3787       demo->data[demo->length++] = ((demo_repeat % 16 - 1) << 4) | demo_action;
3788   }
3789
3790   demo->data[demo->length++] = 0xff;
3791
3792   demo->is_available = TRUE;
3793 }
3794
3795 static void setTapeInfoToDefaults();
3796
3797 static void CopyNativeTape_SP_to_RND(struct LevelInfo *level)
3798 {
3799   struct LevelInfo_SP *level_sp = level->native_sp_level;
3800   struct DemoInfo_SP *demo = &level_sp->demo;
3801   char *filename = level->file_info.filename;
3802   int i;
3803
3804   /* always start with reliable default values */
3805   setTapeInfoToDefaults();
3806
3807   if (!demo->is_available)
3808     return;
3809
3810   tape.level_nr = demo->level_nr;       /* (currently not used) */
3811   tape.length = demo->length - 1;       /* without "end of demo" byte */
3812   tape.random_seed = level_sp->header.DemoRandomSeed;
3813
3814   TapeSetDateFromEpochSeconds(getFileTimestampEpochSeconds(filename));
3815
3816   for (i = 0; i < demo->length - 1; i++)
3817   {
3818     int demo_action = demo->data[i] & 0x0f;
3819     int demo_repeat = (demo->data[i] & 0xf0) >> 4;
3820
3821     tape.pos[i].action[0] = map_key_SP_to_RND(demo_action);
3822     tape.pos[i].delay = demo_repeat + 1;
3823   }
3824
3825   tape.length_frames  = GetTapeLengthFrames();
3826   tape.length_seconds = GetTapeLengthSeconds();
3827 }
3828
3829
3830 /* ------------------------------------------------------------------------- */
3831 /* functions for loading DC level                                            */
3832 /* ------------------------------------------------------------------------- */
3833
3834 #define DC_LEVEL_HEADER_SIZE            344
3835
3836 unsigned short getDecodedWord_DC(unsigned short data_encoded, boolean init)
3837 {
3838   static int last_data_encoded;
3839   static int offset1;
3840   static int offset2;
3841   int diff;
3842   int diff_hi, diff_lo;
3843   int data_hi, data_lo;
3844   unsigned short data_decoded;
3845
3846   if (init)
3847   {
3848     last_data_encoded = 0;
3849     offset1 = -1;
3850     offset2 = 0;
3851
3852     return 0;
3853   }
3854
3855   diff = data_encoded - last_data_encoded;
3856   diff_hi = diff & ~0xff;
3857   diff_lo = diff &  0xff;
3858
3859   offset2 += diff_lo;
3860
3861   data_hi = diff_hi - (offset1 << 8) + (offset2 & 0xff00);
3862   data_lo = (diff_lo + (data_hi >> 16)) & 0x00ff;
3863   data_hi = data_hi & 0xff00;
3864
3865   data_decoded = data_hi | data_lo;
3866
3867   last_data_encoded = data_encoded;
3868
3869   offset1 = (offset1 + 1) % 31;
3870   offset2 = offset2 & 0xff;
3871
3872   return data_decoded;
3873 }
3874
3875 int getMappedElement_DC(int element)
3876 {
3877   switch (element)
3878   {
3879     case 0x0000:
3880       element = EL_ROCK;
3881       break;
3882
3883       /* 0x0117 - 0x036e: (?) */
3884       /* EL_DIAMOND */
3885
3886       /* 0x042d - 0x0684: (?) */
3887       /* EL_EMERALD */
3888
3889     case 0x06f1:
3890       element = EL_NUT;
3891       break;
3892
3893     case 0x074c:
3894       element = EL_BOMB;
3895       break;
3896
3897     case 0x07a4:
3898       element = EL_PEARL;
3899       break;
3900
3901     case 0x0823:
3902       element = EL_CRYSTAL;
3903       break;
3904
3905     case 0x0e77:        /* quicksand (boulder) */
3906       element = EL_QUICKSAND_FAST_FULL;
3907       break;
3908
3909     case 0x0e99:        /* slow quicksand (boulder) */
3910       element = EL_QUICKSAND_FULL;
3911       break;
3912
3913     case 0x0ed2:
3914       element = EL_EM_EXIT_OPEN;
3915       break;
3916
3917     case 0x0ee3:
3918       element = EL_EM_EXIT_CLOSED;
3919       break;
3920
3921     case 0x0eeb:
3922       element = EL_EM_STEEL_EXIT_OPEN;
3923       break;
3924
3925     case 0x0efc:
3926       element = EL_EM_STEEL_EXIT_CLOSED;
3927       break;
3928
3929     case 0x0f4f:        /* dynamite (lit 1) */
3930       element = EL_EM_DYNAMITE_ACTIVE;
3931       break;
3932
3933     case 0x0f57:        /* dynamite (lit 2) */
3934       element = EL_EM_DYNAMITE_ACTIVE;
3935       break;
3936
3937     case 0x0f5f:        /* dynamite (lit 3) */
3938       element = EL_EM_DYNAMITE_ACTIVE;
3939       break;
3940
3941     case 0x0f67:        /* dynamite (lit 4) */
3942       element = EL_EM_DYNAMITE_ACTIVE;
3943       break;
3944
3945     case 0x0f81:
3946     case 0x0f82:
3947     case 0x0f83:
3948     case 0x0f84:
3949       element = EL_AMOEBA_WET;
3950       break;
3951
3952     case 0x0f85:
3953       element = EL_AMOEBA_DROP;
3954       break;
3955
3956     case 0x0fb9:
3957       element = EL_DC_MAGIC_WALL;
3958       break;
3959
3960     case 0x0fd0:
3961       element = EL_SPACESHIP_UP;
3962       break;
3963
3964     case 0x0fd9:
3965       element = EL_SPACESHIP_DOWN;
3966       break;
3967
3968     case 0x0ff1:
3969       element = EL_SPACESHIP_LEFT;
3970       break;
3971
3972     case 0x0ff9:
3973       element = EL_SPACESHIP_RIGHT;
3974       break;
3975
3976     case 0x1057:
3977       element = EL_BUG_UP;
3978       break;
3979
3980     case 0x1060:
3981       element = EL_BUG_DOWN;
3982       break;
3983
3984     case 0x1078:
3985       element = EL_BUG_LEFT;
3986       break;
3987
3988     case 0x1080:
3989       element = EL_BUG_RIGHT;
3990       break;
3991
3992     case 0x10de:
3993       element = EL_MOLE_UP;
3994       break;
3995
3996     case 0x10e7:
3997       element = EL_MOLE_DOWN;
3998       break;
3999
4000     case 0x10ff:
4001       element = EL_MOLE_LEFT;
4002       break;
4003
4004     case 0x1107:
4005       element = EL_MOLE_RIGHT;
4006       break;
4007
4008     case 0x11c0:
4009       element = EL_ROBOT;
4010       break;
4011
4012     case 0x13f5:
4013       element = EL_YAMYAM;
4014       break;
4015
4016     case 0x1425:
4017       element = EL_SWITCHGATE_OPEN;
4018       break;
4019
4020     case 0x1426:
4021       element = EL_SWITCHGATE_CLOSED;
4022       break;
4023
4024     case 0x1437:
4025       element = EL_DC_SWITCHGATE_SWITCH_UP;
4026       break;
4027
4028     case 0x143a:
4029       element = EL_TIMEGATE_CLOSED;
4030       break;
4031
4032     case 0x144c:        /* conveyor belt switch (green) */
4033       element = EL_CONVEYOR_BELT_3_SWITCH_MIDDLE;
4034       break;
4035
4036     case 0x144f:        /* conveyor belt switch (red) */
4037       element = EL_CONVEYOR_BELT_1_SWITCH_MIDDLE;
4038       break;
4039
4040     case 0x1452:        /* conveyor belt switch (blue) */
4041       element = EL_CONVEYOR_BELT_4_SWITCH_MIDDLE;
4042       break;
4043
4044     case 0x145b:
4045       element = EL_CONVEYOR_BELT_3_MIDDLE;
4046       break;
4047
4048     case 0x1463:
4049       element = EL_CONVEYOR_BELT_3_LEFT;
4050       break;
4051
4052     case 0x146b:
4053       element = EL_CONVEYOR_BELT_3_RIGHT;
4054       break;
4055
4056     case 0x1473:
4057       element = EL_CONVEYOR_BELT_1_MIDDLE;
4058       break;
4059
4060     case 0x147b:
4061       element = EL_CONVEYOR_BELT_1_LEFT;
4062       break;
4063
4064     case 0x1483:
4065       element = EL_CONVEYOR_BELT_1_RIGHT;
4066       break;
4067
4068     case 0x148b:
4069       element = EL_CONVEYOR_BELT_4_MIDDLE;
4070       break;
4071
4072     case 0x1493:
4073       element = EL_CONVEYOR_BELT_4_LEFT;
4074       break;
4075
4076     case 0x149b:
4077       element = EL_CONVEYOR_BELT_4_RIGHT;
4078       break;
4079
4080     case 0x14ac:
4081       element = EL_EXPANDABLE_WALL_HORIZONTAL;
4082       break;
4083
4084     case 0x14bd:
4085       element = EL_EXPANDABLE_WALL_VERTICAL;
4086       break;
4087
4088     case 0x14c6:
4089       element = EL_EXPANDABLE_WALL_ANY;
4090       break;
4091
4092     case 0x14ce:        /* growing steel wall (left/right) */
4093       element = EL_EXPANDABLE_STEELWALL_HORIZONTAL;
4094       break;
4095
4096     case 0x14df:        /* growing steel wall (up/down) */
4097       element = EL_EXPANDABLE_STEELWALL_VERTICAL;
4098       break;
4099
4100     case 0x14e8:        /* growing steel wall (up/down/left/right) */
4101       element = EL_EXPANDABLE_STEELWALL_ANY;
4102       break;
4103
4104     case 0x14e9:
4105       element = EL_SHIELD_DEADLY;
4106       break;
4107
4108     case 0x1501:
4109       element = EL_EXTRA_TIME;
4110       break;
4111
4112     case 0x154f:
4113       element = EL_ACID;
4114       break;
4115
4116     case 0x1577:
4117       element = EL_EMPTY_SPACE;
4118       break;
4119
4120     case 0x1578:        /* quicksand (empty) */
4121       element = EL_QUICKSAND_FAST_EMPTY;
4122       break;
4123
4124     case 0x1579:        /* slow quicksand (empty) */
4125       element = EL_QUICKSAND_EMPTY;
4126       break;
4127
4128       /* 0x157c - 0x158b: */
4129       /* EL_SAND */
4130
4131       /* 0x1590 - 0x159f: */
4132       /* EL_DC_LANDMINE */
4133
4134     case 0x15a0:
4135       element = EL_EM_DYNAMITE;
4136       break;
4137
4138     case 0x15a1:        /* key (red) */
4139       element = EL_EM_KEY_1;
4140       break;
4141
4142     case 0x15a2:        /* key (yellow) */
4143       element = EL_EM_KEY_2;
4144       break;
4145
4146     case 0x15a3:        /* key (blue) */
4147       element = EL_EM_KEY_4;
4148       break;
4149
4150     case 0x15a4:        /* key (green) */
4151       element = EL_EM_KEY_3;
4152       break;
4153
4154     case 0x15a5:        /* key (white) */
4155       element = EL_DC_KEY_WHITE;
4156       break;
4157
4158     case 0x15a6:
4159       element = EL_WALL_SLIPPERY;
4160       break;
4161
4162     case 0x15a7:
4163       element = EL_WALL;
4164       break;
4165
4166     case 0x15a8:        /* wall (not round) */
4167       element = EL_WALL;
4168       break;
4169
4170     case 0x15a9:        /* (blue) */
4171       element = EL_CHAR_A;
4172       break;
4173
4174     case 0x15aa:        /* (blue) */
4175       element = EL_CHAR_B;
4176       break;
4177
4178     case 0x15ab:        /* (blue) */
4179       element = EL_CHAR_C;
4180       break;
4181
4182     case 0x15ac:        /* (blue) */
4183       element = EL_CHAR_D;
4184       break;
4185
4186     case 0x15ad:        /* (blue) */
4187       element = EL_CHAR_E;
4188       break;
4189
4190     case 0x15ae:        /* (blue) */
4191       element = EL_CHAR_F;
4192       break;
4193
4194     case 0x15af:        /* (blue) */
4195       element = EL_CHAR_G;
4196       break;
4197
4198     case 0x15b0:        /* (blue) */
4199       element = EL_CHAR_H;
4200       break;
4201
4202     case 0x15b1:        /* (blue) */
4203       element = EL_CHAR_I;
4204       break;
4205
4206     case 0x15b2:        /* (blue) */
4207       element = EL_CHAR_J;
4208       break;
4209
4210     case 0x15b3:        /* (blue) */
4211       element = EL_CHAR_K;
4212       break;
4213
4214     case 0x15b4:        /* (blue) */
4215       element = EL_CHAR_L;
4216       break;
4217
4218     case 0x15b5:        /* (blue) */
4219       element = EL_CHAR_M;
4220       break;
4221
4222     case 0x15b6:        /* (blue) */
4223       element = EL_CHAR_N;
4224       break;
4225
4226     case 0x15b7:        /* (blue) */
4227       element = EL_CHAR_O;
4228       break;
4229
4230     case 0x15b8:        /* (blue) */
4231       element = EL_CHAR_P;
4232       break;
4233
4234     case 0x15b9:        /* (blue) */
4235       element = EL_CHAR_Q;
4236       break;
4237
4238     case 0x15ba:        /* (blue) */
4239       element = EL_CHAR_R;
4240       break;
4241
4242     case 0x15bb:        /* (blue) */
4243       element = EL_CHAR_S;
4244       break;
4245
4246     case 0x15bc:        /* (blue) */
4247       element = EL_CHAR_T;
4248       break;
4249
4250     case 0x15bd:        /* (blue) */
4251       element = EL_CHAR_U;
4252       break;
4253
4254     case 0x15be:        /* (blue) */
4255       element = EL_CHAR_V;
4256       break;
4257
4258     case 0x15bf:        /* (blue) */
4259       element = EL_CHAR_W;
4260       break;
4261
4262     case 0x15c0:        /* (blue) */
4263       element = EL_CHAR_X;
4264       break;
4265
4266     case 0x15c1:        /* (blue) */
4267       element = EL_CHAR_Y;
4268       break;
4269
4270     case 0x15c2:        /* (blue) */
4271       element = EL_CHAR_Z;
4272       break;
4273
4274     case 0x15c3:        /* (blue) */
4275       element = EL_CHAR_AUMLAUT;
4276       break;
4277
4278     case 0x15c4:        /* (blue) */
4279       element = EL_CHAR_OUMLAUT;
4280       break;
4281
4282     case 0x15c5:        /* (blue) */
4283       element = EL_CHAR_UUMLAUT;
4284       break;
4285
4286     case 0x15c6:        /* (blue) */
4287       element = EL_CHAR_0;
4288       break;
4289
4290     case 0x15c7:        /* (blue) */
4291       element = EL_CHAR_1;
4292       break;
4293
4294     case 0x15c8:        /* (blue) */
4295       element = EL_CHAR_2;
4296       break;
4297
4298     case 0x15c9:        /* (blue) */
4299       element = EL_CHAR_3;
4300       break;
4301
4302     case 0x15ca:        /* (blue) */
4303       element = EL_CHAR_4;
4304       break;
4305
4306     case 0x15cb:        /* (blue) */
4307       element = EL_CHAR_5;
4308       break;
4309
4310     case 0x15cc:        /* (blue) */
4311       element = EL_CHAR_6;
4312       break;
4313
4314     case 0x15cd:        /* (blue) */
4315       element = EL_CHAR_7;
4316       break;
4317
4318     case 0x15ce:        /* (blue) */
4319       element = EL_CHAR_8;
4320       break;
4321
4322     case 0x15cf:        /* (blue) */
4323       element = EL_CHAR_9;
4324       break;
4325
4326     case 0x15d0:        /* (blue) */
4327       element = EL_CHAR_PERIOD;
4328       break;
4329
4330     case 0x15d1:        /* (blue) */
4331       element = EL_CHAR_EXCLAM;
4332       break;
4333
4334     case 0x15d2:        /* (blue) */
4335       element = EL_CHAR_COLON;
4336       break;
4337
4338     case 0x15d3:        /* (blue) */
4339       element = EL_CHAR_LESS;
4340       break;
4341
4342     case 0x15d4:        /* (blue) */
4343       element = EL_CHAR_GREATER;
4344       break;
4345
4346     case 0x15d5:        /* (blue) */
4347       element = EL_CHAR_QUESTION;
4348       break;
4349
4350     case 0x15d6:        /* (blue) */
4351       element = EL_CHAR_COPYRIGHT;
4352       break;
4353
4354     case 0x15d7:        /* (blue) */
4355       element = EL_CHAR_UP;
4356       break;
4357
4358     case 0x15d8:        /* (blue) */
4359       element = EL_CHAR_DOWN;
4360       break;
4361
4362     case 0x15d9:        /* (blue) */
4363       element = EL_CHAR_BUTTON;
4364       break;
4365
4366     case 0x15da:        /* (blue) */
4367       element = EL_CHAR_PLUS;
4368       break;
4369
4370     case 0x15db:        /* (blue) */
4371       element = EL_CHAR_MINUS;
4372       break;
4373
4374     case 0x15dc:        /* (blue) */
4375       element = EL_CHAR_APOSTROPHE;
4376       break;
4377
4378     case 0x15dd:        /* (blue) */
4379       element = EL_CHAR_PARENLEFT;
4380       break;
4381
4382     case 0x15de:        /* (blue) */
4383       element = EL_CHAR_PARENRIGHT;
4384       break;
4385
4386     case 0x15df:        /* (green) */
4387       element = EL_CHAR_A;
4388       break;
4389
4390     case 0x15e0:        /* (green) */
4391       element = EL_CHAR_B;
4392       break;
4393
4394     case 0x15e1:        /* (green) */
4395       element = EL_CHAR_C;
4396       break;
4397
4398     case 0x15e2:        /* (green) */
4399       element = EL_CHAR_D;
4400       break;
4401
4402     case 0x15e3:        /* (green) */
4403       element = EL_CHAR_E;
4404       break;
4405
4406     case 0x15e4:        /* (green) */
4407       element = EL_CHAR_F;
4408       break;
4409
4410     case 0x15e5:        /* (green) */
4411       element = EL_CHAR_G;
4412       break;
4413
4414     case 0x15e6:        /* (green) */
4415       element = EL_CHAR_H;
4416       break;
4417
4418     case 0x15e7:        /* (green) */
4419       element = EL_CHAR_I;
4420       break;
4421
4422     case 0x15e8:        /* (green) */
4423       element = EL_CHAR_J;
4424       break;
4425
4426     case 0x15e9:        /* (green) */
4427       element = EL_CHAR_K;
4428       break;
4429
4430     case 0x15ea:        /* (green) */
4431       element = EL_CHAR_L;
4432       break;
4433
4434     case 0x15eb:        /* (green) */
4435       element = EL_CHAR_M;
4436       break;
4437
4438     case 0x15ec:        /* (green) */
4439       element = EL_CHAR_N;
4440       break;
4441
4442     case 0x15ed:        /* (green) */
4443       element = EL_CHAR_O;
4444       break;
4445
4446     case 0x15ee:        /* (green) */
4447       element = EL_CHAR_P;
4448       break;
4449
4450     case 0x15ef:        /* (green) */
4451       element = EL_CHAR_Q;
4452       break;
4453
4454     case 0x15f0:        /* (green) */
4455       element = EL_CHAR_R;
4456       break;
4457
4458     case 0x15f1:        /* (green) */
4459       element = EL_CHAR_S;
4460       break;
4461
4462     case 0x15f2:        /* (green) */
4463       element = EL_CHAR_T;
4464       break;
4465
4466     case 0x15f3:        /* (green) */
4467       element = EL_CHAR_U;
4468       break;
4469
4470     case 0x15f4:        /* (green) */
4471       element = EL_CHAR_V;
4472       break;
4473
4474     case 0x15f5:        /* (green) */
4475       element = EL_CHAR_W;
4476       break;
4477
4478     case 0x15f6:        /* (green) */
4479       element = EL_CHAR_X;
4480       break;
4481
4482     case 0x15f7:        /* (green) */
4483       element = EL_CHAR_Y;
4484       break;
4485
4486     case 0x15f8:        /* (green) */
4487       element = EL_CHAR_Z;
4488       break;
4489
4490     case 0x15f9:        /* (green) */
4491       element = EL_CHAR_AUMLAUT;
4492       break;
4493
4494     case 0x15fa:        /* (green) */
4495       element = EL_CHAR_OUMLAUT;
4496       break;
4497
4498     case 0x15fb:        /* (green) */
4499       element = EL_CHAR_UUMLAUT;
4500       break;
4501
4502     case 0x15fc:        /* (green) */
4503       element = EL_CHAR_0;
4504       break;
4505
4506     case 0x15fd:        /* (green) */
4507       element = EL_CHAR_1;
4508       break;
4509
4510     case 0x15fe:        /* (green) */
4511       element = EL_CHAR_2;
4512       break;
4513
4514     case 0x15ff:        /* (green) */
4515       element = EL_CHAR_3;
4516       break;
4517
4518     case 0x1600:        /* (green) */
4519       element = EL_CHAR_4;
4520       break;
4521
4522     case 0x1601:        /* (green) */
4523       element = EL_CHAR_5;
4524       break;
4525
4526     case 0x1602:        /* (green) */
4527       element = EL_CHAR_6;
4528       break;
4529
4530     case 0x1603:        /* (green) */
4531       element = EL_CHAR_7;
4532       break;
4533
4534     case 0x1604:        /* (green) */
4535       element = EL_CHAR_8;
4536       break;
4537
4538     case 0x1605:        /* (green) */
4539       element = EL_CHAR_9;
4540       break;
4541
4542     case 0x1606:        /* (green) */
4543       element = EL_CHAR_PERIOD;
4544       break;
4545
4546     case 0x1607:        /* (green) */
4547       element = EL_CHAR_EXCLAM;
4548       break;
4549
4550     case 0x1608:        /* (green) */
4551       element = EL_CHAR_COLON;
4552       break;
4553
4554     case 0x1609:        /* (green) */
4555       element = EL_CHAR_LESS;
4556       break;
4557
4558     case 0x160a:        /* (green) */
4559       element = EL_CHAR_GREATER;
4560       break;
4561
4562     case 0x160b:        /* (green) */
4563       element = EL_CHAR_QUESTION;
4564       break;
4565
4566     case 0x160c:        /* (green) */
4567       element = EL_CHAR_COPYRIGHT;
4568       break;
4569
4570     case 0x160d:        /* (green) */
4571       element = EL_CHAR_UP;
4572       break;
4573
4574     case 0x160e:        /* (green) */
4575       element = EL_CHAR_DOWN;
4576       break;
4577
4578     case 0x160f:        /* (green) */
4579       element = EL_CHAR_BUTTON;
4580       break;
4581
4582     case 0x1610:        /* (green) */
4583       element = EL_CHAR_PLUS;
4584       break;
4585
4586     case 0x1611:        /* (green) */
4587       element = EL_CHAR_MINUS;
4588       break;
4589
4590     case 0x1612:        /* (green) */
4591       element = EL_CHAR_APOSTROPHE;
4592       break;
4593
4594     case 0x1613:        /* (green) */
4595       element = EL_CHAR_PARENLEFT;
4596       break;
4597
4598     case 0x1614:        /* (green) */
4599       element = EL_CHAR_PARENRIGHT;
4600       break;
4601
4602     case 0x1615:        /* (blue steel) */
4603       element = EL_STEEL_CHAR_A;
4604       break;
4605
4606     case 0x1616:        /* (blue steel) */
4607       element = EL_STEEL_CHAR_B;
4608       break;
4609
4610     case 0x1617:        /* (blue steel) */
4611       element = EL_STEEL_CHAR_C;
4612       break;
4613
4614     case 0x1618:        /* (blue steel) */
4615       element = EL_STEEL_CHAR_D;
4616       break;
4617
4618     case 0x1619:        /* (blue steel) */
4619       element = EL_STEEL_CHAR_E;
4620       break;
4621
4622     case 0x161a:        /* (blue steel) */
4623       element = EL_STEEL_CHAR_F;
4624       break;
4625
4626     case 0x161b:        /* (blue steel) */
4627       element = EL_STEEL_CHAR_G;
4628       break;
4629
4630     case 0x161c:        /* (blue steel) */
4631       element = EL_STEEL_CHAR_H;
4632       break;
4633
4634     case 0x161d:        /* (blue steel) */
4635       element = EL_STEEL_CHAR_I;
4636       break;
4637
4638     case 0x161e:        /* (blue steel) */
4639       element = EL_STEEL_CHAR_J;
4640       break;
4641
4642     case 0x161f:        /* (blue steel) */
4643       element = EL_STEEL_CHAR_K;
4644       break;
4645
4646     case 0x1620:        /* (blue steel) */
4647       element = EL_STEEL_CHAR_L;
4648       break;
4649
4650     case 0x1621:        /* (blue steel) */
4651       element = EL_STEEL_CHAR_M;
4652       break;
4653
4654     case 0x1622:        /* (blue steel) */
4655       element = EL_STEEL_CHAR_N;
4656       break;
4657
4658     case 0x1623:        /* (blue steel) */
4659       element = EL_STEEL_CHAR_O;
4660       break;
4661
4662     case 0x1624:        /* (blue steel) */
4663       element = EL_STEEL_CHAR_P;
4664       break;
4665
4666     case 0x1625:        /* (blue steel) */
4667       element = EL_STEEL_CHAR_Q;
4668       break;
4669
4670     case 0x1626:        /* (blue steel) */
4671       element = EL_STEEL_CHAR_R;
4672       break;
4673
4674     case 0x1627:        /* (blue steel) */
4675       element = EL_STEEL_CHAR_S;
4676       break;
4677
4678     case 0x1628:        /* (blue steel) */
4679       element = EL_STEEL_CHAR_T;
4680       break;
4681
4682     case 0x1629:        /* (blue steel) */
4683       element = EL_STEEL_CHAR_U;
4684       break;
4685
4686     case 0x162a:        /* (blue steel) */
4687       element = EL_STEEL_CHAR_V;
4688       break;
4689
4690     case 0x162b:        /* (blue steel) */
4691       element = EL_STEEL_CHAR_W;
4692       break;
4693
4694     case 0x162c:        /* (blue steel) */
4695       element = EL_STEEL_CHAR_X;
4696       break;
4697
4698     case 0x162d:        /* (blue steel) */
4699       element = EL_STEEL_CHAR_Y;
4700       break;
4701
4702     case 0x162e:        /* (blue steel) */
4703       element = EL_STEEL_CHAR_Z;
4704       break;
4705
4706     case 0x162f:        /* (blue steel) */
4707       element = EL_STEEL_CHAR_AUMLAUT;
4708       break;
4709
4710     case 0x1630:        /* (blue steel) */
4711       element = EL_STEEL_CHAR_OUMLAUT;
4712       break;
4713
4714     case 0x1631:        /* (blue steel) */
4715       element = EL_STEEL_CHAR_UUMLAUT;
4716       break;
4717
4718     case 0x1632:        /* (blue steel) */
4719       element = EL_STEEL_CHAR_0;
4720       break;
4721
4722     case 0x1633:        /* (blue steel) */
4723       element = EL_STEEL_CHAR_1;
4724       break;
4725
4726     case 0x1634:        /* (blue steel) */
4727       element = EL_STEEL_CHAR_2;
4728       break;
4729
4730     case 0x1635:        /* (blue steel) */
4731       element = EL_STEEL_CHAR_3;
4732       break;
4733
4734     case 0x1636:        /* (blue steel) */
4735       element = EL_STEEL_CHAR_4;
4736       break;
4737
4738     case 0x1637:        /* (blue steel) */
4739       element = EL_STEEL_CHAR_5;
4740       break;
4741
4742     case 0x1638:        /* (blue steel) */
4743       element = EL_STEEL_CHAR_6;
4744       break;
4745
4746     case 0x1639:        /* (blue steel) */
4747       element = EL_STEEL_CHAR_7;
4748       break;
4749
4750     case 0x163a:        /* (blue steel) */
4751       element = EL_STEEL_CHAR_8;
4752       break;
4753
4754     case 0x163b:        /* (blue steel) */
4755       element = EL_STEEL_CHAR_9;
4756       break;
4757
4758     case 0x163c:        /* (blue steel) */
4759       element = EL_STEEL_CHAR_PERIOD;
4760       break;
4761
4762     case 0x163d:        /* (blue steel) */
4763       element = EL_STEEL_CHAR_EXCLAM;
4764       break;
4765
4766     case 0x163e:        /* (blue steel) */
4767       element = EL_STEEL_CHAR_COLON;
4768       break;
4769
4770     case 0x163f:        /* (blue steel) */
4771       element = EL_STEEL_CHAR_LESS;
4772       break;
4773
4774     case 0x1640:        /* (blue steel) */
4775       element = EL_STEEL_CHAR_GREATER;
4776       break;
4777
4778     case 0x1641:        /* (blue steel) */
4779       element = EL_STEEL_CHAR_QUESTION;
4780       break;
4781
4782     case 0x1642:        /* (blue steel) */
4783       element = EL_STEEL_CHAR_COPYRIGHT;
4784       break;
4785
4786     case 0x1643:        /* (blue steel) */
4787       element = EL_STEEL_CHAR_UP;
4788       break;
4789
4790     case 0x1644:        /* (blue steel) */
4791       element = EL_STEEL_CHAR_DOWN;
4792       break;
4793
4794     case 0x1645:        /* (blue steel) */
4795       element = EL_STEEL_CHAR_BUTTON;
4796       break;
4797
4798     case 0x1646:        /* (blue steel) */
4799       element = EL_STEEL_CHAR_PLUS;
4800       break;
4801
4802     case 0x1647:        /* (blue steel) */
4803       element = EL_STEEL_CHAR_MINUS;
4804       break;
4805
4806     case 0x1648:        /* (blue steel) */
4807       element = EL_STEEL_CHAR_APOSTROPHE;
4808       break;
4809
4810     case 0x1649:        /* (blue steel) */
4811       element = EL_STEEL_CHAR_PARENLEFT;
4812       break;
4813
4814     case 0x164a:        /* (blue steel) */
4815       element = EL_STEEL_CHAR_PARENRIGHT;
4816       break;
4817
4818     case 0x164b:        /* (green steel) */
4819       element = EL_STEEL_CHAR_A;
4820       break;
4821
4822     case 0x164c:        /* (green steel) */
4823       element = EL_STEEL_CHAR_B;
4824       break;
4825
4826     case 0x164d:        /* (green steel) */
4827       element = EL_STEEL_CHAR_C;
4828       break;
4829
4830     case 0x164e:        /* (green steel) */
4831       element = EL_STEEL_CHAR_D;
4832       break;
4833
4834     case 0x164f:        /* (green steel) */
4835       element = EL_STEEL_CHAR_E;
4836       break;
4837
4838     case 0x1650:        /* (green steel) */
4839       element = EL_STEEL_CHAR_F;
4840       break;
4841
4842     case 0x1651:        /* (green steel) */
4843       element = EL_STEEL_CHAR_G;
4844       break;
4845
4846     case 0x1652:        /* (green steel) */
4847       element = EL_STEEL_CHAR_H;
4848       break;
4849
4850     case 0x1653:        /* (green steel) */
4851       element = EL_STEEL_CHAR_I;
4852       break;
4853
4854     case 0x1654:        /* (green steel) */
4855       element = EL_STEEL_CHAR_J;
4856       break;
4857
4858     case 0x1655:        /* (green steel) */
4859       element = EL_STEEL_CHAR_K;
4860       break;
4861
4862     case 0x1656:        /* (green steel) */
4863       element = EL_STEEL_CHAR_L;
4864       break;
4865
4866     case 0x1657:        /* (green steel) */
4867       element = EL_STEEL_CHAR_M;
4868       break;
4869
4870     case 0x1658:        /* (green steel) */
4871       element = EL_STEEL_CHAR_N;
4872       break;
4873
4874     case 0x1659:        /* (green steel) */
4875       element = EL_STEEL_CHAR_O;
4876       break;
4877
4878     case 0x165a:        /* (green steel) */
4879       element = EL_STEEL_CHAR_P;
4880       break;
4881
4882     case 0x165b:        /* (green steel) */
4883       element = EL_STEEL_CHAR_Q;
4884       break;
4885
4886     case 0x165c:        /* (green steel) */
4887       element = EL_STEEL_CHAR_R;
4888       break;
4889
4890     case 0x165d:        /* (green steel) */
4891       element = EL_STEEL_CHAR_S;
4892       break;
4893
4894     case 0x165e:        /* (green steel) */
4895       element = EL_STEEL_CHAR_T;
4896       break;
4897
4898     case 0x165f:        /* (green steel) */
4899       element = EL_STEEL_CHAR_U;
4900       break;
4901
4902     case 0x1660:        /* (green steel) */
4903       element = EL_STEEL_CHAR_V;
4904       break;
4905
4906     case 0x1661:        /* (green steel) */
4907       element = EL_STEEL_CHAR_W;
4908       break;
4909
4910     case 0x1662:        /* (green steel) */
4911       element = EL_STEEL_CHAR_X;
4912       break;
4913
4914     case 0x1663:        /* (green steel) */
4915       element = EL_STEEL_CHAR_Y;
4916       break;
4917
4918     case 0x1664:        /* (green steel) */
4919       element = EL_STEEL_CHAR_Z;
4920       break;
4921
4922     case 0x1665:        /* (green steel) */
4923       element = EL_STEEL_CHAR_AUMLAUT;
4924       break;
4925
4926     case 0x1666:        /* (green steel) */
4927       element = EL_STEEL_CHAR_OUMLAUT;
4928       break;
4929
4930     case 0x1667:        /* (green steel) */
4931       element = EL_STEEL_CHAR_UUMLAUT;
4932       break;
4933
4934     case 0x1668:        /* (green steel) */
4935       element = EL_STEEL_CHAR_0;
4936       break;
4937
4938     case 0x1669:        /* (green steel) */
4939       element = EL_STEEL_CHAR_1;
4940       break;
4941
4942     case 0x166a:        /* (green steel) */
4943       element = EL_STEEL_CHAR_2;
4944       break;
4945
4946     case 0x166b:        /* (green steel) */
4947       element = EL_STEEL_CHAR_3;
4948       break;
4949
4950     case 0x166c:        /* (green steel) */
4951       element = EL_STEEL_CHAR_4;
4952       break;
4953
4954     case 0x166d:        /* (green steel) */
4955       element = EL_STEEL_CHAR_5;
4956       break;
4957
4958     case 0x166e:        /* (green steel) */
4959       element = EL_STEEL_CHAR_6;
4960       break;
4961
4962     case 0x166f:        /* (green steel) */
4963       element = EL_STEEL_CHAR_7;
4964       break;
4965
4966     case 0x1670:        /* (green steel) */
4967       element = EL_STEEL_CHAR_8;
4968       break;
4969
4970     case 0x1671:        /* (green steel) */
4971       element = EL_STEEL_CHAR_9;
4972       break;
4973
4974     case 0x1672:        /* (green steel) */
4975       element = EL_STEEL_CHAR_PERIOD;
4976       break;
4977
4978     case 0x1673:        /* (green steel) */
4979       element = EL_STEEL_CHAR_EXCLAM;
4980       break;
4981
4982     case 0x1674:        /* (green steel) */
4983       element = EL_STEEL_CHAR_COLON;
4984       break;
4985
4986     case 0x1675:        /* (green steel) */
4987       element = EL_STEEL_CHAR_LESS;
4988       break;
4989
4990     case 0x1676:        /* (green steel) */
4991       element = EL_STEEL_CHAR_GREATER;
4992       break;
4993
4994     case 0x1677:        /* (green steel) */
4995       element = EL_STEEL_CHAR_QUESTION;
4996       break;
4997
4998     case 0x1678:        /* (green steel) */
4999       element = EL_STEEL_CHAR_COPYRIGHT;
5000       break;
5001
5002     case 0x1679:        /* (green steel) */
5003       element = EL_STEEL_CHAR_UP;
5004       break;
5005
5006     case 0x167a:        /* (green steel) */
5007       element = EL_STEEL_CHAR_DOWN;
5008       break;
5009
5010     case 0x167b:        /* (green steel) */
5011       element = EL_STEEL_CHAR_BUTTON;
5012       break;
5013
5014     case 0x167c:        /* (green steel) */
5015       element = EL_STEEL_CHAR_PLUS;
5016       break;
5017
5018     case 0x167d:        /* (green steel) */
5019       element = EL_STEEL_CHAR_MINUS;
5020       break;
5021
5022     case 0x167e:        /* (green steel) */
5023       element = EL_STEEL_CHAR_APOSTROPHE;
5024       break;
5025
5026     case 0x167f:        /* (green steel) */
5027       element = EL_STEEL_CHAR_PARENLEFT;
5028       break;
5029
5030     case 0x1680:        /* (green steel) */
5031       element = EL_STEEL_CHAR_PARENRIGHT;
5032       break;
5033
5034     case 0x1681:        /* gate (red) */
5035       element = EL_EM_GATE_1;
5036       break;
5037
5038     case 0x1682:        /* secret gate (red) */
5039       element = EL_GATE_1_GRAY;
5040       break;
5041
5042     case 0x1683:        /* gate (yellow) */
5043       element = EL_EM_GATE_2;
5044       break;
5045
5046     case 0x1684:        /* secret gate (yellow) */
5047       element = EL_GATE_2_GRAY;
5048       break;
5049
5050     case 0x1685:        /* gate (blue) */
5051       element = EL_EM_GATE_4;
5052       break;
5053
5054     case 0x1686:        /* secret gate (blue) */
5055       element = EL_GATE_4_GRAY;
5056       break;
5057
5058     case 0x1687:        /* gate (green) */
5059       element = EL_EM_GATE_3;
5060       break;
5061
5062     case 0x1688:        /* secret gate (green) */
5063       element = EL_GATE_3_GRAY;
5064       break;
5065
5066     case 0x1689:        /* gate (white) */
5067       element = EL_DC_GATE_WHITE;
5068       break;
5069
5070     case 0x168a:        /* secret gate (white) */
5071       element = EL_DC_GATE_WHITE_GRAY;
5072       break;
5073
5074     case 0x168b:        /* secret gate (no key) */
5075       element = EL_DC_GATE_FAKE_GRAY;
5076       break;
5077
5078     case 0x168c:
5079       element = EL_ROBOT_WHEEL;
5080       break;
5081
5082     case 0x168d:
5083       element = EL_DC_TIMEGATE_SWITCH;
5084       break;
5085
5086     case 0x168e:
5087       element = EL_ACID_POOL_BOTTOM;
5088       break;
5089
5090     case 0x168f:
5091       element = EL_ACID_POOL_TOPLEFT;
5092       break;
5093
5094     case 0x1690:
5095       element = EL_ACID_POOL_TOPRIGHT;
5096       break;
5097
5098     case 0x1691:
5099       element = EL_ACID_POOL_BOTTOMLEFT;
5100       break;
5101
5102     case 0x1692:
5103       element = EL_ACID_POOL_BOTTOMRIGHT;
5104       break;
5105
5106     case 0x1693:
5107       element = EL_STEELWALL;
5108       break;
5109
5110     case 0x1694:
5111       element = EL_STEELWALL_SLIPPERY;
5112       break;
5113
5114     case 0x1695:        /* steel wall (not round) */
5115       element = EL_STEELWALL;
5116       break;
5117
5118     case 0x1696:        /* steel wall (left) */
5119       element = EL_DC_STEELWALL_1_LEFT;
5120       break;
5121
5122     case 0x1697:        /* steel wall (bottom) */
5123       element = EL_DC_STEELWALL_1_BOTTOM;
5124       break;
5125
5126     case 0x1698:        /* steel wall (right) */
5127       element = EL_DC_STEELWALL_1_RIGHT;
5128       break;
5129
5130     case 0x1699:        /* steel wall (top) */
5131       element = EL_DC_STEELWALL_1_TOP;
5132       break;
5133
5134     case 0x169a:        /* steel wall (left/bottom) */
5135       element = EL_DC_STEELWALL_1_BOTTOMLEFT;
5136       break;
5137
5138     case 0x169b:        /* steel wall (right/bottom) */
5139       element = EL_DC_STEELWALL_1_BOTTOMRIGHT;
5140       break;
5141
5142     case 0x169c:        /* steel wall (right/top) */
5143       element = EL_DC_STEELWALL_1_TOPRIGHT;
5144       break;
5145
5146     case 0x169d:        /* steel wall (left/top) */
5147       element = EL_DC_STEELWALL_1_TOPLEFT;
5148       break;
5149
5150     case 0x169e:        /* steel wall (right/bottom small) */
5151       element = EL_DC_STEELWALL_1_BOTTOMRIGHT_2;
5152       break;
5153
5154     case 0x169f:        /* steel wall (left/bottom small) */
5155       element = EL_DC_STEELWALL_1_BOTTOMLEFT_2;
5156       break;
5157
5158     case 0x16a0:        /* steel wall (right/top small) */
5159       element = EL_DC_STEELWALL_1_TOPRIGHT_2;
5160       break;
5161
5162     case 0x16a1:        /* steel wall (left/top small) */
5163       element = EL_DC_STEELWALL_1_TOPLEFT_2;
5164       break;
5165
5166     case 0x16a2:        /* steel wall (left/right) */
5167       element = EL_DC_STEELWALL_1_VERTICAL;
5168       break;
5169
5170     case 0x16a3:        /* steel wall (top/bottom) */
5171       element = EL_DC_STEELWALL_1_HORIZONTAL;
5172       break;
5173
5174     case 0x16a4:        /* steel wall 2 (left end) */
5175       element = EL_DC_STEELWALL_2_LEFT;
5176       break;
5177
5178     case 0x16a5:        /* steel wall 2 (right end) */
5179       element = EL_DC_STEELWALL_2_RIGHT;
5180       break;
5181
5182     case 0x16a6:        /* steel wall 2 (top end) */
5183       element = EL_DC_STEELWALL_2_TOP;
5184       break;
5185
5186     case 0x16a7:        /* steel wall 2 (bottom end) */
5187       element = EL_DC_STEELWALL_2_BOTTOM;
5188       break;
5189
5190     case 0x16a8:        /* steel wall 2 (left/right) */
5191       element = EL_DC_STEELWALL_2_HORIZONTAL;
5192       break;
5193
5194     case 0x16a9:        /* steel wall 2 (up/down) */
5195       element = EL_DC_STEELWALL_2_VERTICAL;
5196       break;
5197
5198     case 0x16aa:        /* steel wall 2 (mid) */
5199       element = EL_DC_STEELWALL_2_MIDDLE;
5200       break;
5201
5202     case 0x16ab:
5203       element = EL_SIGN_EXCLAMATION;
5204       break;
5205
5206     case 0x16ac:
5207       element = EL_SIGN_RADIOACTIVITY;
5208       break;
5209
5210     case 0x16ad:
5211       element = EL_SIGN_STOP;
5212       break;
5213
5214     case 0x16ae:
5215       element = EL_SIGN_WHEELCHAIR;
5216       break;
5217
5218     case 0x16af:
5219       element = EL_SIGN_PARKING;
5220       break;
5221
5222     case 0x16b0:
5223       element = EL_SIGN_NO_ENTRY;
5224       break;
5225
5226     case 0x16b1:
5227       element = EL_SIGN_HEART;
5228       break;
5229
5230     case 0x16b2:
5231       element = EL_SIGN_GIVE_WAY;
5232       break;
5233
5234     case 0x16b3:
5235       element = EL_SIGN_ENTRY_FORBIDDEN;
5236       break;
5237
5238     case 0x16b4:
5239       element = EL_SIGN_EMERGENCY_EXIT;
5240       break;
5241
5242     case 0x16b5:
5243       element = EL_SIGN_YIN_YANG;
5244       break;
5245
5246     case 0x16b6:
5247       element = EL_WALL_EMERALD;
5248       break;
5249
5250     case 0x16b7:
5251       element = EL_WALL_DIAMOND;
5252       break;
5253
5254     case 0x16b8:
5255       element = EL_WALL_PEARL;
5256       break;
5257
5258     case 0x16b9:
5259       element = EL_WALL_CRYSTAL;
5260       break;
5261
5262     case 0x16ba:
5263       element = EL_INVISIBLE_WALL;
5264       break;
5265
5266     case 0x16bb:
5267       element = EL_INVISIBLE_STEELWALL;
5268       break;
5269
5270       /* 0x16bc - 0x16cb: */
5271       /* EL_INVISIBLE_SAND */
5272
5273     case 0x16cc:
5274       element = EL_LIGHT_SWITCH;
5275       break;
5276
5277     case 0x16cd:
5278       element = EL_ENVELOPE_1;
5279       break;
5280
5281     default:
5282       if (element >= 0x0117 && element <= 0x036e)       /* (?) */
5283         element = EL_DIAMOND;
5284       else if (element >= 0x042d && element <= 0x0684)  /* (?) */
5285         element = EL_EMERALD;
5286       else if (element >= 0x157c && element <= 0x158b)
5287         element = EL_SAND;
5288       else if (element >= 0x1590 && element <= 0x159f)
5289         element = EL_DC_LANDMINE;
5290       else if (element >= 0x16bc && element <= 0x16cb)
5291         element = EL_INVISIBLE_SAND;
5292       else
5293       {
5294         Error(ERR_WARN, "unknown Diamond Caves element 0x%04x", element);
5295         element = EL_UNKNOWN;
5296       }
5297       break;
5298   }
5299
5300   return getMappedElement(element);
5301 }
5302
5303 static void LoadLevelFromFileStream_DC(File *file, struct LevelInfo *level,
5304                                        int nr)
5305 {
5306   byte header[DC_LEVEL_HEADER_SIZE];
5307   int envelope_size;
5308   int envelope_header_pos = 62;
5309   int envelope_content_pos = 94;
5310   int level_name_pos = 251;
5311   int level_author_pos = 292;
5312   int envelope_header_len;
5313   int envelope_content_len;
5314   int level_name_len;
5315   int level_author_len;
5316   int fieldx, fieldy;
5317   int num_yamyam_contents;
5318   int i, x, y;
5319
5320   getDecodedWord_DC(0, TRUE);           /* initialize DC2 decoding engine */
5321
5322   for (i = 0; i < DC_LEVEL_HEADER_SIZE / 2; i++)
5323   {
5324     unsigned short header_word = getDecodedWord_DC(getFile16BitBE(file), FALSE);
5325
5326     header[i * 2 + 0] = header_word >> 8;
5327     header[i * 2 + 1] = header_word & 0xff;
5328   }
5329
5330   /* read some values from level header to check level decoding integrity */
5331   fieldx = header[6] | (header[7] << 8);
5332   fieldy = header[8] | (header[9] << 8);
5333   num_yamyam_contents = header[60] | (header[61] << 8);
5334
5335   /* do some simple sanity checks to ensure that level was correctly decoded */
5336   if (fieldx < 1 || fieldx > 256 ||
5337       fieldy < 1 || fieldy > 256 ||
5338       num_yamyam_contents < 1 || num_yamyam_contents > 8)
5339   {
5340     level->no_valid_file = TRUE;
5341
5342     Error(ERR_WARN, "cannot decode level from stream -- using empty level");
5343
5344     return;
5345   }
5346
5347   /* maximum envelope header size is 31 bytes */
5348   envelope_header_len   = header[envelope_header_pos];
5349   /* maximum envelope content size is 110 (156?) bytes */
5350   envelope_content_len  = header[envelope_content_pos];
5351
5352   /* maximum level title size is 40 bytes */
5353   level_name_len        = MIN(header[level_name_pos],   MAX_LEVEL_NAME_LEN);
5354   /* maximum level author size is 30 (51?) bytes */
5355   level_author_len      = MIN(header[level_author_pos], MAX_LEVEL_AUTHOR_LEN);
5356
5357   envelope_size = 0;
5358
5359   for (i = 0; i < envelope_header_len; i++)
5360     if (envelope_size < MAX_ENVELOPE_TEXT_LEN)
5361       level->envelope[0].text[envelope_size++] =
5362         header[envelope_header_pos + 1 + i];
5363
5364   if (envelope_header_len > 0 && envelope_content_len > 0)
5365   {
5366     if (envelope_size < MAX_ENVELOPE_TEXT_LEN)
5367       level->envelope[0].text[envelope_size++] = '\n';
5368     if (envelope_size < MAX_ENVELOPE_TEXT_LEN)
5369       level->envelope[0].text[envelope_size++] = '\n';
5370   }
5371
5372   for (i = 0; i < envelope_content_len; i++)
5373     if (envelope_size < MAX_ENVELOPE_TEXT_LEN)
5374       level->envelope[0].text[envelope_size++] =
5375         header[envelope_content_pos + 1 + i];
5376
5377   level->envelope[0].text[envelope_size] = '\0';
5378
5379   level->envelope[0].xsize = MAX_ENVELOPE_XSIZE;
5380   level->envelope[0].ysize = 10;
5381   level->envelope[0].autowrap = TRUE;
5382   level->envelope[0].centered = TRUE;
5383
5384   for (i = 0; i < level_name_len; i++)
5385     level->name[i] = header[level_name_pos + 1 + i];
5386   level->name[level_name_len] = '\0';
5387
5388   for (i = 0; i < level_author_len; i++)
5389     level->author[i] = header[level_author_pos + 1 + i];
5390   level->author[level_author_len] = '\0';
5391
5392   num_yamyam_contents = header[60] | (header[61] << 8);
5393   level->num_yamyam_contents =
5394     MIN(MAX(MIN_ELEMENT_CONTENTS, num_yamyam_contents), MAX_ELEMENT_CONTENTS);
5395
5396   for (i = 0; i < num_yamyam_contents; i++)
5397   {
5398     for (y = 0; y < 3; y++) for (x = 0; x < 3; x++)
5399     {
5400       unsigned short word = getDecodedWord_DC(getFile16BitBE(file), FALSE);
5401       int element_dc = ((word & 0xff) << 8) | ((word >> 8) & 0xff);
5402
5403       if (i < MAX_ELEMENT_CONTENTS)
5404         level->yamyam_content[i].e[x][y] = getMappedElement_DC(element_dc);
5405     }
5406   }
5407
5408   fieldx = header[6] | (header[7] << 8);
5409   fieldy = header[8] | (header[9] << 8);
5410   level->fieldx = MIN(MAX(MIN_LEV_FIELDX, fieldx), MAX_LEV_FIELDX);
5411   level->fieldy = MIN(MAX(MIN_LEV_FIELDY, fieldy), MAX_LEV_FIELDY);
5412
5413   for (y = 0; y < fieldy; y++) for (x = 0; x < fieldx; x++)
5414   {
5415     unsigned short word = getDecodedWord_DC(getFile16BitBE(file), FALSE);
5416     int element_dc = ((word & 0xff) << 8) | ((word >> 8) & 0xff);
5417
5418     if (x < MAX_LEV_FIELDX && y < MAX_LEV_FIELDY)
5419       level->field[x][y] = getMappedElement_DC(element_dc);
5420   }
5421
5422   x = MIN(MAX(0, (header[10] | (header[11] << 8)) - 1), MAX_LEV_FIELDX - 1);
5423   y = MIN(MAX(0, (header[12] | (header[13] << 8)) - 1), MAX_LEV_FIELDY - 1);
5424   level->field[x][y] = EL_PLAYER_1;
5425
5426   x = MIN(MAX(0, (header[14] | (header[15] << 8)) - 1), MAX_LEV_FIELDX - 1);
5427   y = MIN(MAX(0, (header[16] | (header[17] << 8)) - 1), MAX_LEV_FIELDY - 1);
5428   level->field[x][y] = EL_PLAYER_2;
5429
5430   level->gems_needed            = header[18] | (header[19] << 8);
5431
5432   level->score[SC_EMERALD]      = header[20] | (header[21] << 8);
5433   level->score[SC_DIAMOND]      = header[22] | (header[23] << 8);
5434   level->score[SC_PEARL]        = header[24] | (header[25] << 8);
5435   level->score[SC_CRYSTAL]      = header[26] | (header[27] << 8);
5436   level->score[SC_NUT]          = header[28] | (header[29] << 8);
5437   level->score[SC_ROBOT]        = header[30] | (header[31] << 8);
5438   level->score[SC_SPACESHIP]    = header[32] | (header[33] << 8);
5439   level->score[SC_BUG]          = header[34] | (header[35] << 8);
5440   level->score[SC_YAMYAM]       = header[36] | (header[37] << 8);
5441   level->score[SC_DYNAMITE]     = header[38] | (header[39] << 8);
5442   level->score[SC_KEY]          = header[40] | (header[41] << 8);
5443   level->score[SC_TIME_BONUS]   = header[42] | (header[43] << 8);
5444
5445   level->time                   = header[44] | (header[45] << 8);
5446
5447   level->amoeba_speed           = header[46] | (header[47] << 8);
5448   level->time_light             = header[48] | (header[49] << 8);
5449   level->time_timegate          = header[50] | (header[51] << 8);
5450   level->time_wheel             = header[52] | (header[53] << 8);
5451   level->time_magic_wall        = header[54] | (header[55] << 8);
5452   level->extra_time             = header[56] | (header[57] << 8);
5453   level->shield_normal_time     = header[58] | (header[59] << 8);
5454
5455   /* Diamond Caves has the same (strange) behaviour as Emerald Mine that gems
5456      can slip down from flat walls, like normal walls and steel walls */
5457   level->em_slippery_gems = TRUE;
5458 }
5459
5460 static void LoadLevelFromFileInfo_DC(struct LevelInfo *level,
5461                                      struct LevelFileInfo *level_file_info,
5462                                      boolean level_info_only)
5463 {
5464   char *filename = level_file_info->filename;
5465   File *file;
5466   int num_magic_bytes = 8;
5467   char magic_bytes[num_magic_bytes + 1];
5468   int num_levels_to_skip = level_file_info->nr - leveldir_current->first_level;
5469
5470   if (!(file = openFile(filename, MODE_READ)))
5471   {
5472     level->no_valid_file = TRUE;
5473
5474     if (!level_info_only)
5475       Error(ERR_WARN, "cannot read level '%s' -- using empty level", filename);
5476
5477     return;
5478   }
5479
5480   // fseek(file, 0x0000, SEEK_SET);
5481
5482   if (level_file_info->packed)
5483   {
5484     /* read "magic bytes" from start of file */
5485     if (getStringFromFile(file, magic_bytes, num_magic_bytes + 1) == NULL)
5486       magic_bytes[0] = '\0';
5487
5488     /* check "magic bytes" for correct file format */
5489     if (!strPrefix(magic_bytes, "DC2"))
5490     {
5491       level->no_valid_file = TRUE;
5492
5493       Error(ERR_WARN, "unknown DC level file '%s' -- using empty level",
5494             filename);
5495
5496       return;
5497     }
5498
5499     if (strPrefix(magic_bytes, "DC2Win95") ||
5500         strPrefix(magic_bytes, "DC2Win98"))
5501     {
5502       int position_first_level = 0x00fa;
5503       int extra_bytes = 4;
5504       int skip_bytes;
5505
5506       /* advance file stream to first level inside the level package */
5507       skip_bytes = position_first_level - num_magic_bytes - extra_bytes;
5508
5509       /* each block of level data is followed by block of non-level data */
5510       num_levels_to_skip *= 2;
5511
5512       /* at least skip header bytes, therefore use ">= 0" instead of "> 0" */
5513       while (num_levels_to_skip >= 0)
5514       {
5515         /* advance file stream to next level inside the level package */
5516         if (seekFile(file, skip_bytes, SEEK_CUR) != 0)
5517         {
5518           level->no_valid_file = TRUE;
5519
5520           Error(ERR_WARN, "cannot fseek in file '%s' -- using empty level",
5521                 filename);
5522
5523           return;
5524         }
5525
5526         /* skip apparently unused extra bytes following each level */
5527         ReadUnusedBytesFromFile(file, extra_bytes);
5528
5529         /* read size of next level in level package */
5530         skip_bytes = getFile32BitLE(file);
5531
5532         num_levels_to_skip--;
5533       }
5534     }
5535     else
5536     {
5537       level->no_valid_file = TRUE;
5538
5539       Error(ERR_WARN, "unknown DC2 level file '%s' -- using empty level",
5540             filename);
5541
5542       return;
5543     }
5544   }
5545
5546   LoadLevelFromFileStream_DC(file, level, level_file_info->nr);
5547
5548   closeFile(file);
5549 }
5550
5551
5552 /* ------------------------------------------------------------------------- */
5553 /* functions for loading SB level                                            */
5554 /* ------------------------------------------------------------------------- */
5555
5556 int getMappedElement_SB(int element_ascii, boolean use_ces)
5557 {
5558   static struct
5559   {
5560     int ascii;
5561     int sb;
5562     int ce;
5563   }
5564   sb_element_mapping[] =
5565   {
5566     { ' ', EL_EMPTY,                EL_CUSTOM_1 },  /* floor (space) */
5567     { '#', EL_STEELWALL,            EL_CUSTOM_2 },  /* wall */
5568     { '@', EL_PLAYER_1,             EL_CUSTOM_3 },  /* player */
5569     { '$', EL_SOKOBAN_OBJECT,       EL_CUSTOM_4 },  /* box */
5570     { '.', EL_SOKOBAN_FIELD_EMPTY,  EL_CUSTOM_5 },  /* goal square */
5571     { '*', EL_SOKOBAN_FIELD_FULL,   EL_CUSTOM_6 },  /* box on goal square */
5572     { '+', EL_SOKOBAN_FIELD_PLAYER, EL_CUSTOM_7 },  /* player on goal square */
5573     { '_', EL_INVISIBLE_STEELWALL,  EL_FROM_LEVEL_TEMPLATE },  /* floor beyond border */
5574
5575     { 0,   -1,                      -1          },
5576   };
5577
5578   int i;
5579
5580   for (i = 0; sb_element_mapping[i].ascii != 0; i++)
5581     if (element_ascii == sb_element_mapping[i].ascii)
5582       return (use_ces ? sb_element_mapping[i].ce : sb_element_mapping[i].sb);
5583
5584   return EL_UNDEFINED;
5585 }
5586
5587 static void LoadLevelFromFileInfo_SB(struct LevelInfo *level,
5588                                      struct LevelFileInfo *level_file_info,
5589                                      boolean level_info_only)
5590 {
5591   char *filename = level_file_info->filename;
5592   char line[MAX_LINE_LEN], line_raw[MAX_LINE_LEN], previous_line[MAX_LINE_LEN];
5593   char last_comment[MAX_LINE_LEN];
5594   char level_name[MAX_LINE_LEN];
5595   char *line_ptr;
5596   File *file;
5597   int num_levels_to_skip = level_file_info->nr - leveldir_current->first_level;
5598   boolean read_continued_line = FALSE;
5599   boolean reading_playfield = FALSE;
5600   boolean got_valid_playfield_line = FALSE;
5601   boolean invalid_playfield_char = FALSE;
5602   boolean load_xsb_to_ces = check_special_flags("load_xsb_to_ces");
5603   int file_level_nr = 0;
5604   int line_nr = 0;
5605   int x = 0, y = 0;             /* initialized to make compilers happy */
5606
5607   last_comment[0] = '\0';
5608   level_name[0] = '\0';
5609
5610   if (!(file = openFile(filename, MODE_READ)))
5611   {
5612     level->no_valid_file = TRUE;
5613
5614     if (!level_info_only)
5615       Error(ERR_WARN, "cannot read level '%s' -- using empty level", filename);
5616
5617     return;
5618   }
5619
5620   while (!checkEndOfFile(file))
5621   {
5622     /* level successfully read, but next level may follow here */
5623     if (!got_valid_playfield_line && reading_playfield)
5624     {
5625       /* read playfield from single level file -- skip remaining file */
5626       if (!level_file_info->packed)
5627         break;
5628
5629       if (file_level_nr >= num_levels_to_skip)
5630         break;
5631
5632       file_level_nr++;
5633
5634       last_comment[0] = '\0';
5635       level_name[0] = '\0';
5636
5637       reading_playfield = FALSE;
5638     }
5639
5640     got_valid_playfield_line = FALSE;
5641
5642     /* read next line of input file */
5643     if (!getStringFromFile(file, line, MAX_LINE_LEN))
5644       break;
5645
5646     /* check if line was completely read and is terminated by line break */
5647     if (strlen(line) > 0 && line[strlen(line) - 1] == '\n')
5648       line_nr++;
5649
5650     /* cut trailing line break (this can be newline and/or carriage return) */
5651     for (line_ptr = &line[strlen(line)]; line_ptr >= line; line_ptr--)
5652       if ((*line_ptr == '\n' || *line_ptr == '\r') && *(line_ptr + 1) == '\0')
5653         *line_ptr = '\0';
5654
5655     /* copy raw input line for later use (mainly debugging output) */
5656     strcpy(line_raw, line);
5657
5658     if (read_continued_line)
5659     {
5660       /* append new line to existing line, if there is enough space */
5661       if (strlen(previous_line) + strlen(line_ptr) < MAX_LINE_LEN)
5662         strcat(previous_line, line_ptr);
5663
5664       strcpy(line, previous_line);      /* copy storage buffer to line */
5665
5666       read_continued_line = FALSE;
5667     }
5668
5669     /* if the last character is '\', continue at next line */
5670     if (strlen(line) > 0 && line[strlen(line) - 1] == '\\')
5671     {
5672       line[strlen(line) - 1] = '\0';    /* cut off trailing backslash */
5673       strcpy(previous_line, line);      /* copy line to storage buffer */
5674
5675       read_continued_line = TRUE;
5676
5677       continue;
5678     }
5679
5680     /* skip empty lines */
5681     if (line[0] == '\0')
5682       continue;
5683
5684     /* extract comment text from comment line */
5685     if (line[0] == ';')
5686     {
5687       for (line_ptr = line; *line_ptr; line_ptr++)
5688         if (*line_ptr != ' ' && *line_ptr != '\t' && *line_ptr != ';')
5689           break;
5690
5691       strcpy(last_comment, line_ptr);
5692
5693       continue;
5694     }
5695
5696     /* extract level title text from line containing level title */
5697     if (line[0] == '\'')
5698     {
5699       strcpy(level_name, &line[1]);
5700
5701       if (strlen(level_name) > 0 && level_name[strlen(level_name) - 1] == '\'')
5702         level_name[strlen(level_name) - 1] = '\0';
5703
5704       continue;
5705     }
5706
5707     /* skip lines containing only spaces (or empty lines) */
5708     for (line_ptr = line; *line_ptr; line_ptr++)
5709       if (*line_ptr != ' ')
5710         break;
5711     if (*line_ptr == '\0')
5712       continue;
5713
5714     /* at this point, we have found a line containing part of a playfield */
5715
5716     got_valid_playfield_line = TRUE;
5717
5718     if (!reading_playfield)
5719     {
5720       reading_playfield = TRUE;
5721       invalid_playfield_char = FALSE;
5722
5723       for (x = 0; x < MAX_LEV_FIELDX; x++)
5724         for (y = 0; y < MAX_LEV_FIELDY; y++)
5725           level->field[x][y] = getMappedElement_SB(' ', load_xsb_to_ces);
5726
5727       level->fieldx = 0;
5728       level->fieldy = 0;
5729
5730       /* start with topmost tile row */
5731       y = 0;
5732     }
5733
5734     /* skip playfield line if larger row than allowed */
5735     if (y >= MAX_LEV_FIELDY)
5736       continue;
5737
5738     /* start with leftmost tile column */
5739     x = 0;
5740
5741     /* read playfield elements from line */
5742     for (line_ptr = line; *line_ptr; line_ptr++)
5743     {
5744       int mapped_sb_element = getMappedElement_SB(*line_ptr, load_xsb_to_ces);
5745
5746       /* stop parsing playfield line if larger column than allowed */
5747       if (x >= MAX_LEV_FIELDX)
5748         break;
5749
5750       if (mapped_sb_element == EL_UNDEFINED)
5751       {
5752         invalid_playfield_char = TRUE;
5753
5754         break;
5755       }
5756
5757       level->field[x][y] = mapped_sb_element;
5758
5759       /* continue with next tile column */
5760       x++;
5761
5762       level->fieldx = MAX(x, level->fieldx);
5763     }
5764
5765     if (invalid_playfield_char)
5766     {
5767       /* if first playfield line, treat invalid lines as comment lines */
5768       if (y == 0)
5769         reading_playfield = FALSE;
5770
5771       continue;
5772     }
5773
5774     /* continue with next tile row */
5775     y++;
5776   }
5777
5778   closeFile(file);
5779
5780   level->fieldy = y;
5781
5782   level->fieldx = MIN(MAX(MIN_LEV_FIELDX, level->fieldx), MAX_LEV_FIELDX);
5783   level->fieldy = MIN(MAX(MIN_LEV_FIELDY, level->fieldy), MAX_LEV_FIELDY);
5784
5785   if (!reading_playfield)
5786   {
5787     level->no_valid_file = TRUE;
5788
5789     Error(ERR_WARN, "cannot read level '%s' -- using empty level", filename);
5790
5791     return;
5792   }
5793
5794   if (*level_name != '\0')
5795   {
5796     strncpy(level->name, level_name, MAX_LEVEL_NAME_LEN);
5797     level->name[MAX_LEVEL_NAME_LEN] = '\0';
5798   }
5799   else if (*last_comment != '\0')
5800   {
5801     strncpy(level->name, last_comment, MAX_LEVEL_NAME_LEN);
5802     level->name[MAX_LEVEL_NAME_LEN] = '\0';
5803   }
5804   else
5805   {
5806     sprintf(level->name, "--> Level %d <--", level_file_info->nr);
5807   }
5808
5809   /* set all empty fields beyond the border walls to invisible steel wall */
5810   for (y = 0; y < level->fieldy; y++) for (x = 0; x < level->fieldx; x++)
5811   {
5812     if ((x == 0 || x == level->fieldx - 1 ||
5813          y == 0 || y == level->fieldy - 1) &&
5814         level->field[x][y] == getMappedElement_SB(' ', load_xsb_to_ces))
5815       FloodFillLevel(x, y, getMappedElement_SB('_', load_xsb_to_ces),
5816                      level->field, level->fieldx, level->fieldy);
5817   }
5818
5819   /* set special level settings for Sokoban levels */
5820
5821   level->time = 0;
5822   level->use_step_counter = TRUE;
5823
5824   if (load_xsb_to_ces)
5825   {
5826     /* special global settings can now be set in level template */
5827
5828     level->use_custom_template = TRUE;
5829   }
5830 }
5831
5832
5833 /* ------------------------------------------------------------------------- */
5834 /* functions for handling native levels                                      */
5835 /* ------------------------------------------------------------------------- */
5836
5837 static void LoadLevelFromFileInfo_EM(struct LevelInfo *level,
5838                                      struct LevelFileInfo *level_file_info,
5839                                      boolean level_info_only)
5840 {
5841   if (!LoadNativeLevel_EM(level_file_info->filename, level_info_only))
5842     level->no_valid_file = TRUE;
5843 }
5844
5845 static void LoadLevelFromFileInfo_SP(struct LevelInfo *level,
5846                                      struct LevelFileInfo *level_file_info,
5847                                      boolean level_info_only)
5848 {
5849   int pos = 0;
5850
5851   /* determine position of requested level inside level package */
5852   if (level_file_info->packed)
5853     pos = level_file_info->nr - leveldir_current->first_level;
5854
5855   if (!LoadNativeLevel_SP(level_file_info->filename, pos, level_info_only))
5856     level->no_valid_file = TRUE;
5857 }
5858
5859 void CopyNativeLevel_RND_to_Native(struct LevelInfo *level)
5860 {
5861   if (level->game_engine_type == GAME_ENGINE_TYPE_EM)
5862     CopyNativeLevel_RND_to_EM(level);
5863   else if (level->game_engine_type == GAME_ENGINE_TYPE_SP)
5864     CopyNativeLevel_RND_to_SP(level);
5865 }
5866
5867 void CopyNativeLevel_Native_to_RND(struct LevelInfo *level)
5868 {
5869   if (level->game_engine_type == GAME_ENGINE_TYPE_EM)
5870     CopyNativeLevel_EM_to_RND(level);
5871   else if (level->game_engine_type == GAME_ENGINE_TYPE_SP)
5872     CopyNativeLevel_SP_to_RND(level);
5873 }
5874
5875 void SaveNativeLevel(struct LevelInfo *level)
5876 {
5877   if (level->game_engine_type == GAME_ENGINE_TYPE_SP)
5878   {
5879     char *basename = getSingleLevelBasenameExt(level->file_info.nr, "sp");
5880     char *filename = getLevelFilenameFromBasename(basename);
5881
5882     CopyNativeLevel_RND_to_SP(level);
5883     CopyNativeTape_RND_to_SP(level);
5884
5885     SaveNativeLevel_SP(filename);
5886   }
5887 }
5888
5889
5890 /* ------------------------------------------------------------------------- */
5891 /* functions for loading generic level                                       */
5892 /* ------------------------------------------------------------------------- */
5893
5894 static void LoadLevelFromFileInfo(struct LevelInfo *level,
5895                                   struct LevelFileInfo *level_file_info,
5896                                   boolean level_info_only)
5897 {
5898   /* always start with reliable default values */
5899   setLevelInfoToDefaults(level, level_info_only, TRUE);
5900
5901   switch (level_file_info->type)
5902   {
5903     case LEVEL_FILE_TYPE_RND:
5904       LoadLevelFromFileInfo_RND(level, level_file_info, level_info_only);
5905       break;
5906
5907     case LEVEL_FILE_TYPE_EM:
5908       LoadLevelFromFileInfo_EM(level, level_file_info, level_info_only);
5909       level->game_engine_type = GAME_ENGINE_TYPE_EM;
5910       break;
5911
5912     case LEVEL_FILE_TYPE_SP:
5913       LoadLevelFromFileInfo_SP(level, level_file_info, level_info_only);
5914       level->game_engine_type = GAME_ENGINE_TYPE_SP;
5915       break;
5916
5917     case LEVEL_FILE_TYPE_DC:
5918       LoadLevelFromFileInfo_DC(level, level_file_info, level_info_only);
5919       break;
5920
5921     case LEVEL_FILE_TYPE_SB:
5922       LoadLevelFromFileInfo_SB(level, level_file_info, level_info_only);
5923       break;
5924
5925     default:
5926       LoadLevelFromFileInfo_RND(level, level_file_info, level_info_only);
5927       break;
5928   }
5929
5930   /* if level file is invalid, restore level structure to default values */
5931   if (level->no_valid_file)
5932     setLevelInfoToDefaults(level, level_info_only, FALSE);
5933
5934   if (level->game_engine_type == GAME_ENGINE_TYPE_UNKNOWN)
5935     level->game_engine_type = GAME_ENGINE_TYPE_RND;
5936
5937   if (level_file_info->type != LEVEL_FILE_TYPE_RND)
5938     CopyNativeLevel_Native_to_RND(level);
5939 }
5940
5941 void LoadLevelFromFilename(struct LevelInfo *level, char *filename)
5942 {
5943   static struct LevelFileInfo level_file_info;
5944
5945   /* always start with reliable default values */
5946   setFileInfoToDefaults(&level_file_info);
5947
5948   level_file_info.nr = 0;                       /* unknown level number */
5949   level_file_info.type = LEVEL_FILE_TYPE_RND;   /* no others supported yet */
5950   level_file_info.filename = filename;
5951
5952   LoadLevelFromFileInfo(level, &level_file_info, FALSE);
5953 }
5954
5955 static void LoadLevel_InitVersion(struct LevelInfo *level, char *filename)
5956 {
5957   int i, j;
5958
5959   if (leveldir_current == NULL)         /* only when dumping level */
5960     return;
5961
5962   /* all engine modifications also valid for levels which use latest engine */
5963   if (level->game_version < VERSION_IDENT(3,2,0,5))
5964   {
5965     /* time bonus score was given for 10 s instead of 1 s before 3.2.0-5 */
5966     level->score[SC_TIME_BONUS] /= 10;
5967   }
5968
5969   if (leveldir_current->latest_engine)
5970   {
5971     /* ---------- use latest game engine ----------------------------------- */
5972
5973     /* For all levels which are forced to use the latest game engine version
5974        (normally all but user contributed, private and undefined levels), set
5975        the game engine version to the actual version; this allows for actual
5976        corrections in the game engine to take effect for existing, converted
5977        levels (from "classic" or other existing games) to make the emulation
5978        of the corresponding game more accurate, while (hopefully) not breaking
5979        existing levels created from other players. */
5980
5981     level->game_version = GAME_VERSION_ACTUAL;
5982
5983     /* Set special EM style gems behaviour: EM style gems slip down from
5984        normal, steel and growing wall. As this is a more fundamental change,
5985        it seems better to set the default behaviour to "off" (as it is more
5986        natural) and make it configurable in the level editor (as a property
5987        of gem style elements). Already existing converted levels (neither
5988        private nor contributed levels) are changed to the new behaviour. */
5989
5990     if (level->file_version < FILE_VERSION_2_0)
5991       level->em_slippery_gems = TRUE;
5992
5993     return;
5994   }
5995
5996   /* ---------- use game engine the level was created with ----------------- */
5997
5998   /* For all levels which are not forced to use the latest game engine
5999      version (normally user contributed, private and undefined levels),
6000      use the version of the game engine the levels were created for.
6001
6002      Since 2.0.1, the game engine version is now directly stored
6003      in the level file (chunk "VERS"), so there is no need anymore
6004      to set the game version from the file version (except for old,
6005      pre-2.0 levels, where the game version is still taken from the
6006      file format version used to store the level -- see above). */
6007
6008   /* player was faster than enemies in 1.0.0 and before */
6009   if (level->file_version == FILE_VERSION_1_0)
6010     for (i = 0; i < MAX_PLAYERS; i++)
6011       level->initial_player_stepsize[i] = STEPSIZE_FAST;
6012
6013   /* default behaviour for EM style gems was "slippery" only in 2.0.1 */
6014   if (level->game_version == VERSION_IDENT(2,0,1,0))
6015     level->em_slippery_gems = TRUE;
6016
6017   /* springs could be pushed over pits before (pre-release version) 2.2.0 */
6018   if (level->game_version < VERSION_IDENT(2,2,0,0))
6019     level->use_spring_bug = TRUE;
6020
6021   if (level->game_version < VERSION_IDENT(3,2,0,5))
6022   {
6023     /* time orb caused limited time in endless time levels before 3.2.0-5 */
6024     level->use_time_orb_bug = TRUE;
6025
6026     /* default behaviour for snapping was "no snap delay" before 3.2.0-5 */
6027     level->block_snap_field = FALSE;
6028
6029     /* extra time score was same value as time left score before 3.2.0-5 */
6030     level->extra_time_score = level->score[SC_TIME_BONUS];
6031   }
6032
6033   if (level->game_version < VERSION_IDENT(3,2,0,7))
6034   {
6035     /* default behaviour for snapping was "not continuous" before 3.2.0-7 */
6036     level->continuous_snapping = FALSE;
6037   }
6038
6039   /* only few elements were able to actively move into acid before 3.1.0 */
6040   /* trigger settings did not exist before 3.1.0; set to default "any" */
6041   if (level->game_version < VERSION_IDENT(3,1,0,0))
6042   {
6043     /* correct "can move into acid" settings (all zero in old levels) */
6044
6045     level->can_move_into_acid_bits = 0; /* nothing can move into acid */
6046     level->dont_collide_with_bits = 0; /* nothing is deadly when colliding */
6047
6048     setMoveIntoAcidProperty(level, EL_ROBOT,     TRUE);
6049     setMoveIntoAcidProperty(level, EL_SATELLITE, TRUE);
6050     setMoveIntoAcidProperty(level, EL_PENGUIN,   TRUE);
6051     setMoveIntoAcidProperty(level, EL_BALLOON,   TRUE);
6052
6053     for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
6054       SET_PROPERTY(EL_CUSTOM_START + i, EP_CAN_MOVE_INTO_ACID, TRUE);
6055
6056     /* correct trigger settings (stored as zero == "none" in old levels) */
6057
6058     for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
6059     {
6060       int element = EL_CUSTOM_START + i;
6061       struct ElementInfo *ei = &element_info[element];
6062
6063       for (j = 0; j < ei->num_change_pages; j++)
6064       {
6065         struct ElementChangeInfo *change = &ei->change_page[j];
6066
6067         change->trigger_player = CH_PLAYER_ANY;
6068         change->trigger_page = CH_PAGE_ANY;
6069       }
6070     }
6071   }
6072
6073   /* try to detect and fix "Snake Bite" levels, which are broken with 3.2.0 */
6074   {
6075     int element = EL_CUSTOM_256;
6076     struct ElementInfo *ei = &element_info[element];
6077     struct ElementChangeInfo *change = &ei->change_page[0];
6078
6079     /* This is needed to fix a problem that was caused by a bugfix in function
6080        game.c/CreateFieldExt() introduced with 3.2.0 that corrects the behaviour
6081        when a custom element changes to EL_SOKOBAN_FIELD_PLAYER (before, it did
6082        not replace walkable elements, but instead just placed the player on it,
6083        without placing the Sokoban field under the player). Unfortunately, this
6084        breaks "Snake Bite" style levels when the snake is halfway through a door
6085        that just closes (the snake head is still alive and can be moved in this
6086        case). This can be fixed by replacing the EL_SOKOBAN_FIELD_PLAYER by the
6087        player (without Sokoban element) which then gets killed as designed). */
6088
6089     if ((strncmp(leveldir_current->identifier, "snake_bite", 10) == 0 ||
6090          strncmp(ei->description, "pause b4 death", 14) == 0) &&
6091         change->target_element == EL_SOKOBAN_FIELD_PLAYER)
6092       change->target_element = EL_PLAYER_1;
6093   }
6094
6095   /* try to detect and fix "Zelda" style levels, which are broken with 3.2.5 */
6096   if (level->game_version < VERSION_IDENT(3,2,5,0))
6097   {
6098     /* This is needed to fix a problem that was caused by a bugfix in function
6099        game.c/CheckTriggeredElementChangeExt() introduced with 3.2.5 that
6100        corrects the behaviour when a custom element changes to another custom
6101        element with a higher element number that has change actions defined.
6102        Normally, only one change per frame is allowed for custom elements.
6103        Therefore, it is checked if a custom element already changed in the
6104        current frame; if it did, subsequent changes are suppressed.
6105        Unfortunately, this is only checked for element changes, but not for
6106        change actions, which are still executed. As the function above loops
6107        through all custom elements from lower to higher, an element change
6108        resulting in a lower CE number won't be checked again, while a target
6109        element with a higher number will also be checked, and potential change
6110        actions will get executed for this CE, too (which is wrong), while
6111        further changes are ignored (which is correct). As this bugfix breaks
6112        Zelda II (and introduces graphical bugs to Zelda I, and also breaks a
6113        few other levels like Alan Bond's "FMV"), allow the previous, incorrect
6114        behaviour for existing levels and tapes that make use of this bug */
6115
6116     level->use_action_after_change_bug = TRUE;
6117   }
6118
6119   /* not centering level after relocating player was default only in 3.2.3 */
6120   if (level->game_version == VERSION_IDENT(3,2,3,0))    /* (no pre-releases) */
6121     level->shifted_relocation = TRUE;
6122
6123   /* EM style elements always chain-exploded in R'n'D engine before 3.2.6 */
6124   if (level->game_version < VERSION_IDENT(3,2,6,0))
6125     level->em_explodes_by_fire = TRUE;
6126 }
6127
6128 static void LoadLevel_InitElements(struct LevelInfo *level, char *filename)
6129 {
6130   int i, j, x, y;
6131
6132   /* map custom element change events that have changed in newer versions
6133      (these following values were accidentally changed in version 3.0.1)
6134      (this seems to be needed only for 'ab_levelset3' and 'ab_levelset4') */
6135   if (level->game_version <= VERSION_IDENT(3,0,0,0))
6136   {
6137     for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
6138     {
6139       int element = EL_CUSTOM_START + i;
6140
6141       /* order of checking and copying events to be mapped is important */
6142       /* (do not change the start and end value -- they are constant) */
6143       for (j = CE_BY_OTHER_ACTION; j >= CE_VALUE_GETS_ZERO; j--)
6144       {
6145         if (HAS_CHANGE_EVENT(element, j - 2))
6146         {
6147           SET_CHANGE_EVENT(element, j - 2, FALSE);
6148           SET_CHANGE_EVENT(element, j, TRUE);
6149         }
6150       }
6151
6152       /* order of checking and copying events to be mapped is important */
6153       /* (do not change the start and end value -- they are constant) */
6154       for (j = CE_PLAYER_COLLECTS_X; j >= CE_HITTING_SOMETHING; j--)
6155       {
6156         if (HAS_CHANGE_EVENT(element, j - 1))
6157         {
6158           SET_CHANGE_EVENT(element, j - 1, FALSE);
6159           SET_CHANGE_EVENT(element, j, TRUE);
6160         }
6161       }
6162     }
6163   }
6164
6165   /* initialize "can_change" field for old levels with only one change page */
6166   if (level->game_version <= VERSION_IDENT(3,0,2,0))
6167   {
6168     for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
6169     {
6170       int element = EL_CUSTOM_START + i;
6171
6172       if (CAN_CHANGE(element))
6173         element_info[element].change->can_change = TRUE;
6174     }
6175   }
6176
6177   /* correct custom element values (for old levels without these options) */
6178   if (level->game_version < VERSION_IDENT(3,1,1,0))
6179   {
6180     for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
6181     {
6182       int element = EL_CUSTOM_START + i;
6183       struct ElementInfo *ei = &element_info[element];
6184
6185       if (ei->access_direction == MV_NO_DIRECTION)
6186         ei->access_direction = MV_ALL_DIRECTIONS;
6187     }
6188   }
6189
6190   /* correct custom element values (fix invalid values for all versions) */
6191   if (1)
6192   {
6193     for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
6194     {
6195       int element = EL_CUSTOM_START + i;
6196       struct ElementInfo *ei = &element_info[element];
6197
6198       for (j = 0; j < ei->num_change_pages; j++)
6199       {
6200         struct ElementChangeInfo *change = &ei->change_page[j];
6201
6202         if (change->trigger_player == CH_PLAYER_NONE)
6203           change->trigger_player = CH_PLAYER_ANY;
6204
6205         if (change->trigger_side == CH_SIDE_NONE)
6206           change->trigger_side = CH_SIDE_ANY;
6207       }
6208     }
6209   }
6210
6211   /* initialize "can_explode" field for old levels which did not store this */
6212   /* !!! CHECK THIS -- "<= 3,1,0,0" IS PROBABLY WRONG !!! */
6213   if (level->game_version <= VERSION_IDENT(3,1,0,0))
6214   {
6215     for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
6216     {
6217       int element = EL_CUSTOM_START + i;
6218
6219       if (EXPLODES_1X1_OLD(element))
6220         element_info[element].explosion_type = EXPLODES_1X1;
6221
6222       SET_PROPERTY(element, EP_CAN_EXPLODE, (EXPLODES_BY_FIRE(element) ||
6223                                              EXPLODES_SMASHED(element) ||
6224                                              EXPLODES_IMPACT(element)));
6225     }
6226   }
6227
6228   /* correct previously hard-coded move delay values for maze runner style */
6229   if (level->game_version < VERSION_IDENT(3,1,1,0))
6230   {
6231     for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
6232     {
6233       int element = EL_CUSTOM_START + i;
6234
6235       if (element_info[element].move_pattern & MV_MAZE_RUNNER_STYLE)
6236       {
6237         /* previously hard-coded and therefore ignored */
6238         element_info[element].move_delay_fixed = 9;
6239         element_info[element].move_delay_random = 0;
6240       }
6241     }
6242   }
6243
6244   /* map elements that have changed in newer versions */
6245   level->amoeba_content = getMappedElementByVersion(level->amoeba_content,
6246                                                     level->game_version);
6247   for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
6248     for (x = 0; x < 3; x++)
6249       for (y = 0; y < 3; y++)
6250         level->yamyam_content[i].e[x][y] =
6251           getMappedElementByVersion(level->yamyam_content[i].e[x][y],
6252                                     level->game_version);
6253
6254   /* initialize element properties for level editor etc. */
6255   InitElementPropertiesEngine(level->game_version);
6256   InitElementPropertiesAfterLoading(level->game_version);
6257   InitElementPropertiesGfxElement();
6258 }
6259
6260 static void LoadLevel_InitPlayfield(struct LevelInfo *level, char *filename)
6261 {
6262   int x, y;
6263
6264   /* map elements that have changed in newer versions */
6265   for (y = 0; y < level->fieldy; y++)
6266     for (x = 0; x < level->fieldx; x++)
6267       level->field[x][y] = getMappedElementByVersion(level->field[x][y],
6268                                                      level->game_version);
6269
6270   /* clear unused playfield data (nicer if level gets resized in editor) */
6271   for (x = 0; x < MAX_LEV_FIELDX; x++)
6272     for (y = 0; y < MAX_LEV_FIELDY; y++)
6273       if (x >= level->fieldx || y >= level->fieldy)
6274         level->field[x][y] = EL_EMPTY;
6275
6276   /* copy elements to runtime playfield array */
6277   for (x = 0; x < MAX_LEV_FIELDX; x++)
6278     for (y = 0; y < MAX_LEV_FIELDY; y++)
6279       Feld[x][y] = level->field[x][y];
6280
6281   /* initialize level size variables for faster access */
6282   lev_fieldx = level->fieldx;
6283   lev_fieldy = level->fieldy;
6284
6285   /* determine border element for this level */
6286   if (level->file_info.type == LEVEL_FILE_TYPE_DC)
6287     BorderElement = EL_EMPTY;   /* (in editor, SetBorderElement() is used) */
6288   else
6289     SetBorderElement();
6290 }
6291
6292 static void LoadLevel_InitNativeEngines(struct LevelInfo *level,char *filename)
6293 {
6294   struct LevelFileInfo *level_file_info = &level->file_info;
6295
6296   if (level_file_info->type == LEVEL_FILE_TYPE_RND)
6297     CopyNativeLevel_RND_to_Native(level);
6298 }
6299
6300 void LoadLevelTemplate(int nr)
6301 {
6302   char *filename;
6303
6304   setLevelFileInfo(&level_template.file_info, nr);
6305   filename = level_template.file_info.filename;
6306
6307   LoadLevelFromFileInfo(&level_template, &level_template.file_info, FALSE);
6308
6309   LoadLevel_InitVersion(&level_template, filename);
6310   LoadLevel_InitElements(&level_template, filename);
6311
6312   ActivateLevelTemplate();
6313 }
6314
6315 void LoadLevel(int nr)
6316 {
6317   char *filename;
6318
6319   setLevelFileInfo(&level.file_info, nr);
6320   filename = level.file_info.filename;
6321
6322   LoadLevelFromFileInfo(&level, &level.file_info, FALSE);
6323
6324   if (level.use_custom_template)
6325     LoadLevelTemplate(-1);
6326
6327   LoadLevel_InitVersion(&level, filename);
6328   LoadLevel_InitElements(&level, filename);
6329   LoadLevel_InitPlayfield(&level, filename);
6330
6331   LoadLevel_InitNativeEngines(&level, filename);
6332 }
6333
6334 void LoadLevelInfoOnly(int nr)
6335 {
6336   setLevelFileInfo(&level.file_info, nr);
6337
6338   LoadLevelFromFileInfo(&level, &level.file_info, TRUE);
6339 }
6340
6341 static int SaveLevel_VERS(FILE *file, struct LevelInfo *level)
6342 {
6343   int chunk_size = 0;
6344
6345   chunk_size += putFileVersion(file, level->file_version);
6346   chunk_size += putFileVersion(file, level->game_version);
6347
6348   return chunk_size;
6349 }
6350
6351 static int SaveLevel_DATE(FILE *file, struct LevelInfo *level)
6352 {
6353   int chunk_size = 0;
6354
6355   chunk_size += putFile16BitBE(file, level->creation_date.year);
6356   chunk_size += putFile8Bit(file,    level->creation_date.month);
6357   chunk_size += putFile8Bit(file,    level->creation_date.day);
6358
6359   return chunk_size;
6360 }
6361
6362 #if ENABLE_HISTORIC_CHUNKS
6363 static void SaveLevel_HEAD(FILE *file, struct LevelInfo *level)
6364 {
6365   int i, x, y;
6366
6367   putFile8Bit(file, level->fieldx);
6368   putFile8Bit(file, level->fieldy);
6369
6370   putFile16BitBE(file, level->time);
6371   putFile16BitBE(file, level->gems_needed);
6372
6373   for (i = 0; i < MAX_LEVEL_NAME_LEN; i++)
6374     putFile8Bit(file, level->name[i]);
6375
6376   for (i = 0; i < LEVEL_SCORE_ELEMENTS; i++)
6377     putFile8Bit(file, level->score[i]);
6378
6379   for (i = 0; i < STD_ELEMENT_CONTENTS; i++)
6380     for (y = 0; y < 3; y++)
6381       for (x = 0; x < 3; x++)
6382         putFile8Bit(file, (level->encoding_16bit_yamyam ? EL_EMPTY :
6383                            level->yamyam_content[i].e[x][y]));
6384   putFile8Bit(file, level->amoeba_speed);
6385   putFile8Bit(file, level->time_magic_wall);
6386   putFile8Bit(file, level->time_wheel);
6387   putFile8Bit(file, (level->encoding_16bit_amoeba ? EL_EMPTY :
6388                      level->amoeba_content));
6389   putFile8Bit(file, (level->initial_player_stepsize == STEPSIZE_FAST ? 1 : 0));
6390   putFile8Bit(file, (level->initial_gravity ? 1 : 0));
6391   putFile8Bit(file, (level->encoding_16bit_field ? 1 : 0));
6392   putFile8Bit(file, (level->em_slippery_gems ? 1 : 0));
6393
6394   putFile8Bit(file, (level->use_custom_template ? 1 : 0));
6395
6396   putFile8Bit(file, (level->block_last_field ? 1 : 0));
6397   putFile8Bit(file, (level->sp_block_last_field ? 1 : 0));
6398   putFile32BitBE(file, level->can_move_into_acid_bits);
6399   putFile8Bit(file, level->dont_collide_with_bits);
6400
6401   putFile8Bit(file, (level->use_spring_bug ? 1 : 0));
6402   putFile8Bit(file, (level->use_step_counter ? 1 : 0));
6403
6404   putFile8Bit(file, (level->instant_relocation ? 1 : 0));
6405   putFile8Bit(file, (level->can_pass_to_walkable ? 1 : 0));
6406   putFile8Bit(file, (level->grow_into_diggable ? 1 : 0));
6407
6408   putFile8Bit(file, level->game_engine_type);
6409
6410   WriteUnusedBytesToFile(file, LEVEL_CHUNK_HEAD_UNUSED);
6411 }
6412 #endif
6413
6414 static int SaveLevel_NAME(FILE *file, struct LevelInfo *level)
6415 {
6416   int chunk_size = 0;
6417   int i;
6418
6419   for (i = 0; i < MAX_LEVEL_NAME_LEN; i++)
6420     chunk_size += putFile8Bit(file, level->name[i]);
6421
6422   return chunk_size;
6423 }
6424
6425 static int SaveLevel_AUTH(FILE *file, struct LevelInfo *level)
6426 {
6427   int chunk_size = 0;
6428   int i;
6429
6430   for (i = 0; i < MAX_LEVEL_AUTHOR_LEN; i++)
6431     chunk_size += putFile8Bit(file, level->author[i]);
6432
6433   return chunk_size;
6434 }
6435
6436 #if ENABLE_HISTORIC_CHUNKS
6437 static int SaveLevel_BODY(FILE *file, struct LevelInfo *level)
6438 {
6439   int chunk_size = 0;
6440   int x, y;
6441
6442   for (y = 0; y < level->fieldy; y++)
6443     for (x = 0; x < level->fieldx; x++)
6444       if (level->encoding_16bit_field)
6445         chunk_size += putFile16BitBE(file, level->field[x][y]);
6446       else
6447         chunk_size += putFile8Bit(file, level->field[x][y]);
6448
6449   return chunk_size;
6450 }
6451 #endif
6452
6453 static int SaveLevel_BODY(FILE *file, struct LevelInfo *level)
6454 {
6455   int chunk_size = 0;
6456   int x, y;
6457
6458   for (y = 0; y < level->fieldy; y++)
6459     for (x = 0; x < level->fieldx; x++)
6460       chunk_size += putFile16BitBE(file, level->field[x][y]);
6461
6462   return chunk_size;
6463 }
6464
6465 #if ENABLE_HISTORIC_CHUNKS
6466 static void SaveLevel_CONT(FILE *file, struct LevelInfo *level)
6467 {
6468   int i, x, y;
6469
6470   putFile8Bit(file, EL_YAMYAM);
6471   putFile8Bit(file, level->num_yamyam_contents);
6472   putFile8Bit(file, 0);
6473   putFile8Bit(file, 0);
6474
6475   for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
6476     for (y = 0; y < 3; y++)
6477       for (x = 0; x < 3; x++)
6478         if (level->encoding_16bit_field)
6479           putFile16BitBE(file, level->yamyam_content[i].e[x][y]);
6480         else
6481           putFile8Bit(file, level->yamyam_content[i].e[x][y]);
6482 }
6483 #endif
6484
6485 #if ENABLE_HISTORIC_CHUNKS
6486 static void SaveLevel_CNT2(FILE *file, struct LevelInfo *level, int element)
6487 {
6488   int i, x, y;
6489   int num_contents, content_xsize, content_ysize;
6490   int content_array[MAX_ELEMENT_CONTENTS][3][3];
6491
6492   if (element == EL_YAMYAM)
6493   {
6494     num_contents = level->num_yamyam_contents;
6495     content_xsize = 3;
6496     content_ysize = 3;
6497
6498     for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
6499       for (y = 0; y < 3; y++)
6500         for (x = 0; x < 3; x++)
6501           content_array[i][x][y] = level->yamyam_content[i].e[x][y];
6502   }
6503   else if (element == EL_BD_AMOEBA)
6504   {
6505     num_contents = 1;
6506     content_xsize = 1;
6507     content_ysize = 1;
6508
6509     for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
6510       for (y = 0; y < 3; y++)
6511         for (x = 0; x < 3; x++)
6512           content_array[i][x][y] = EL_EMPTY;
6513     content_array[0][0][0] = level->amoeba_content;
6514   }
6515   else
6516   {
6517     /* chunk header already written -- write empty chunk data */
6518     WriteUnusedBytesToFile(file, LEVEL_CHUNK_CNT2_SIZE);
6519
6520     Error(ERR_WARN, "cannot save content for element '%d'", element);
6521     return;
6522   }
6523
6524   putFile16BitBE(file, element);
6525   putFile8Bit(file, num_contents);
6526   putFile8Bit(file, content_xsize);
6527   putFile8Bit(file, content_ysize);
6528
6529   WriteUnusedBytesToFile(file, LEVEL_CHUNK_CNT2_UNUSED);
6530
6531   for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
6532     for (y = 0; y < 3; y++)
6533       for (x = 0; x < 3; x++)
6534         putFile16BitBE(file, content_array[i][x][y]);
6535 }
6536 #endif
6537
6538 #if ENABLE_HISTORIC_CHUNKS
6539 static int SaveLevel_CNT3(FILE *file, struct LevelInfo *level, int element)
6540 {
6541   int envelope_nr = element - EL_ENVELOPE_1;
6542   int envelope_len = strlen(level->envelope_text[envelope_nr]) + 1;
6543   int chunk_size = 0;
6544   int i;
6545
6546   chunk_size += putFile16BitBE(file, element);
6547   chunk_size += putFile16BitBE(file, envelope_len);
6548   chunk_size += putFile8Bit(file, level->envelope_xsize[envelope_nr]);
6549   chunk_size += putFile8Bit(file, level->envelope_ysize[envelope_nr]);
6550
6551   WriteUnusedBytesToFile(file, LEVEL_CHUNK_CNT3_UNUSED);
6552   chunk_size += LEVEL_CHUNK_CNT3_UNUSED;
6553
6554   for (i = 0; i < envelope_len; i++)
6555     chunk_size += putFile8Bit(file, level->envelope_text[envelope_nr][i]);
6556
6557   return chunk_size;
6558 }
6559 #endif
6560
6561 #if ENABLE_HISTORIC_CHUNKS
6562 static void SaveLevel_CUS1(FILE *file, struct LevelInfo *level,
6563                            int num_changed_custom_elements)
6564 {
6565   int i, check = 0;
6566
6567   putFile16BitBE(file, num_changed_custom_elements);
6568
6569   for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
6570   {
6571     int element = EL_CUSTOM_START + i;
6572
6573     struct ElementInfo *ei = &element_info[element];
6574
6575     if (ei->properties[EP_BITFIELD_BASE_NR] != EP_BITMASK_DEFAULT)
6576     {
6577       if (check < num_changed_custom_elements)
6578       {
6579         putFile16BitBE(file, element);
6580         putFile32BitBE(file, ei->properties[EP_BITFIELD_BASE_NR]);
6581       }
6582
6583       check++;
6584     }
6585   }
6586
6587   if (check != num_changed_custom_elements)     /* should not happen */
6588     Error(ERR_WARN, "inconsistent number of custom element properties");
6589 }
6590 #endif
6591
6592 #if ENABLE_HISTORIC_CHUNKS
6593 static void SaveLevel_CUS2(FILE *file, struct LevelInfo *level,
6594                            int num_changed_custom_elements)
6595 {
6596   int i, check = 0;
6597
6598   putFile16BitBE(file, num_changed_custom_elements);
6599
6600   for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
6601   {
6602     int element = EL_CUSTOM_START + i;
6603
6604     if (element_info[element].change->target_element != EL_EMPTY_SPACE)
6605     {
6606       if (check < num_changed_custom_elements)
6607       {
6608         putFile16BitBE(file, element);
6609         putFile16BitBE(file, element_info[element].change->target_element);
6610       }
6611
6612       check++;
6613     }
6614   }
6615
6616   if (check != num_changed_custom_elements)     /* should not happen */
6617     Error(ERR_WARN, "inconsistent number of custom target elements");
6618 }
6619 #endif
6620
6621 #if ENABLE_HISTORIC_CHUNKS
6622 static void SaveLevel_CUS3(FILE *file, struct LevelInfo *level,
6623                            int num_changed_custom_elements)
6624 {
6625   int i, j, x, y, check = 0;
6626
6627   putFile16BitBE(file, num_changed_custom_elements);
6628
6629   for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
6630   {
6631     int element = EL_CUSTOM_START + i;
6632     struct ElementInfo *ei = &element_info[element];
6633
6634     if (ei->modified_settings)
6635     {
6636       if (check < num_changed_custom_elements)
6637       {
6638         putFile16BitBE(file, element);
6639
6640         for (j = 0; j < MAX_ELEMENT_NAME_LEN; j++)
6641           putFile8Bit(file, ei->description[j]);
6642
6643         putFile32BitBE(file, ei->properties[EP_BITFIELD_BASE_NR]);
6644
6645         /* some free bytes for future properties and padding */
6646         WriteUnusedBytesToFile(file, 7);
6647
6648         putFile8Bit(file, ei->use_gfx_element);
6649         putFile16BitBE(file, ei->gfx_element_initial);
6650
6651         putFile8Bit(file, ei->collect_score_initial);
6652         putFile8Bit(file, ei->collect_count_initial);
6653
6654         putFile16BitBE(file, ei->push_delay_fixed);
6655         putFile16BitBE(file, ei->push_delay_random);
6656         putFile16BitBE(file, ei->move_delay_fixed);
6657         putFile16BitBE(file, ei->move_delay_random);
6658
6659         putFile16BitBE(file, ei->move_pattern);
6660         putFile8Bit(file, ei->move_direction_initial);
6661         putFile8Bit(file, ei->move_stepsize);
6662
6663         for (y = 0; y < 3; y++)
6664           for (x = 0; x < 3; x++)
6665             putFile16BitBE(file, ei->content.e[x][y]);
6666
6667         putFile32BitBE(file, ei->change->events);
6668
6669         putFile16BitBE(file, ei->change->target_element);
6670
6671         putFile16BitBE(file, ei->change->delay_fixed);
6672         putFile16BitBE(file, ei->change->delay_random);
6673         putFile16BitBE(file, ei->change->delay_frames);
6674
6675         putFile16BitBE(file, ei->change->initial_trigger_element);
6676
6677         putFile8Bit(file, ei->change->explode);
6678         putFile8Bit(file, ei->change->use_target_content);
6679         putFile8Bit(file, ei->change->only_if_complete);
6680         putFile8Bit(file, ei->change->use_random_replace);
6681
6682         putFile8Bit(file, ei->change->random_percentage);
6683         putFile8Bit(file, ei->change->replace_when);
6684
6685         for (y = 0; y < 3; y++)
6686           for (x = 0; x < 3; x++)
6687             putFile16BitBE(file, ei->change->content.e[x][y]);
6688
6689         putFile8Bit(file, ei->slippery_type);
6690
6691         /* some free bytes for future properties and padding */
6692         WriteUnusedBytesToFile(file, LEVEL_CPART_CUS3_UNUSED);
6693       }
6694
6695       check++;
6696     }
6697   }
6698
6699   if (check != num_changed_custom_elements)     /* should not happen */
6700     Error(ERR_WARN, "inconsistent number of custom element properties");
6701 }
6702 #endif
6703
6704 #if ENABLE_HISTORIC_CHUNKS
6705 static void SaveLevel_CUS4(FILE *file, struct LevelInfo *level, int element)
6706 {
6707   struct ElementInfo *ei = &element_info[element];
6708   int i, j, x, y;
6709
6710   /* ---------- custom element base property values (96 bytes) ------------- */
6711
6712   putFile16BitBE(file, element);
6713
6714   for (i = 0; i < MAX_ELEMENT_NAME_LEN; i++)
6715     putFile8Bit(file, ei->description[i]);
6716
6717   putFile32BitBE(file, ei->properties[EP_BITFIELD_BASE_NR]);
6718
6719   WriteUnusedBytesToFile(file, 4);      /* reserved for more base properties */
6720
6721   putFile8Bit(file, ei->num_change_pages);
6722
6723   putFile16BitBE(file, ei->ce_value_fixed_initial);
6724   putFile16BitBE(file, ei->ce_value_random_initial);
6725   putFile8Bit(file, ei->use_last_ce_value);
6726
6727   putFile8Bit(file, ei->use_gfx_element);
6728   putFile16BitBE(file, ei->gfx_element_initial);
6729
6730   putFile8Bit(file, ei->collect_score_initial);
6731   putFile8Bit(file, ei->collect_count_initial);
6732
6733   putFile8Bit(file, ei->drop_delay_fixed);
6734   putFile8Bit(file, ei->push_delay_fixed);
6735   putFile8Bit(file, ei->drop_delay_random);
6736   putFile8Bit(file, ei->push_delay_random);
6737   putFile16BitBE(file, ei->move_delay_fixed);
6738   putFile16BitBE(file, ei->move_delay_random);
6739
6740   /* bits 0 - 15 of "move_pattern" ... */
6741   putFile16BitBE(file, ei->move_pattern & 0xffff);
6742   putFile8Bit(file, ei->move_direction_initial);
6743   putFile8Bit(file, ei->move_stepsize);
6744
6745   putFile8Bit(file, ei->slippery_type);
6746
6747   for (y = 0; y < 3; y++)
6748     for (x = 0; x < 3; x++)
6749       putFile16BitBE(file, ei->content.e[x][y]);
6750
6751   putFile16BitBE(file, ei->move_enter_element);
6752   putFile16BitBE(file, ei->move_leave_element);
6753   putFile8Bit(file, ei->move_leave_type);
6754
6755   /* ... bits 16 - 31 of "move_pattern" (not nice, but downward compatible) */
6756   putFile16BitBE(file, (ei->move_pattern >> 16) & 0xffff);
6757
6758   putFile8Bit(file, ei->access_direction);
6759
6760   putFile8Bit(file, ei->explosion_delay);
6761   putFile8Bit(file, ei->ignition_delay);
6762   putFile8Bit(file, ei->explosion_type);
6763
6764   /* some free bytes for future custom property values and padding */
6765   WriteUnusedBytesToFile(file, 1);
6766
6767   /* ---------- change page property values (48 bytes) --------------------- */
6768
6769   for (i = 0; i < ei->num_change_pages; i++)
6770   {
6771     struct ElementChangeInfo *change = &ei->change_page[i];
6772     unsigned int event_bits;
6773
6774     /* bits 0 - 31 of "has_event[]" ... */
6775     event_bits = 0;
6776     for (j = 0; j < MIN(NUM_CHANGE_EVENTS, 32); j++)
6777       if (change->has_event[j])
6778         event_bits |= (1 << j);
6779     putFile32BitBE(file, event_bits);
6780
6781     putFile16BitBE(file, change->target_element);
6782
6783     putFile16BitBE(file, change->delay_fixed);
6784     putFile16BitBE(file, change->delay_random);
6785     putFile16BitBE(file, change->delay_frames);
6786
6787     putFile16BitBE(file, change->initial_trigger_element);
6788
6789     putFile8Bit(file, change->explode);
6790     putFile8Bit(file, change->use_target_content);
6791     putFile8Bit(file, change->only_if_complete);
6792     putFile8Bit(file, change->use_random_replace);
6793
6794     putFile8Bit(file, change->random_percentage);
6795     putFile8Bit(file, change->replace_when);
6796
6797     for (y = 0; y < 3; y++)
6798       for (x = 0; x < 3; x++)
6799         putFile16BitBE(file, change->target_content.e[x][y]);
6800
6801     putFile8Bit(file, change->can_change);
6802
6803     putFile8Bit(file, change->trigger_side);
6804
6805     putFile8Bit(file, change->trigger_player);
6806     putFile8Bit(file, (change->trigger_page == CH_PAGE_ANY ? CH_PAGE_ANY_FILE :
6807                        log_2(change->trigger_page)));
6808
6809     putFile8Bit(file, change->has_action);
6810     putFile8Bit(file, change->action_type);
6811     putFile8Bit(file, change->action_mode);
6812     putFile16BitBE(file, change->action_arg);
6813
6814     /* ... bits 32 - 39 of "has_event[]" (not nice, but downward compatible) */
6815     event_bits = 0;
6816     for (j = 32; j < NUM_CHANGE_EVENTS; j++)
6817       if (change->has_event[j])
6818         event_bits |= (1 << (j - 32));
6819     putFile8Bit(file, event_bits);
6820   }
6821 }
6822 #endif
6823
6824 #if ENABLE_HISTORIC_CHUNKS
6825 static void SaveLevel_GRP1(FILE *file, struct LevelInfo *level, int element)
6826 {
6827   struct ElementInfo *ei = &element_info[element];
6828   struct ElementGroupInfo *group = ei->group;
6829   int i;
6830
6831   putFile16BitBE(file, element);
6832
6833   for (i = 0; i < MAX_ELEMENT_NAME_LEN; i++)
6834     putFile8Bit(file, ei->description[i]);
6835
6836   putFile8Bit(file, group->num_elements);
6837
6838   putFile8Bit(file, ei->use_gfx_element);
6839   putFile16BitBE(file, ei->gfx_element_initial);
6840
6841   putFile8Bit(file, group->choice_mode);
6842
6843   /* some free bytes for future values and padding */
6844   WriteUnusedBytesToFile(file, 3);
6845
6846   for (i = 0; i < MAX_ELEMENTS_IN_GROUP; i++)
6847     putFile16BitBE(file, group->element[i]);
6848 }
6849 #endif
6850
6851 static int SaveLevel_MicroChunk(FILE *file, struct LevelFileConfigInfo *entry,
6852                                 boolean write_element)
6853 {
6854   int save_type = entry->save_type;
6855   int data_type = entry->data_type;
6856   int conf_type = entry->conf_type;
6857   int byte_mask = conf_type & CONF_MASK_BYTES;
6858   int element = entry->element;
6859   int default_value = entry->default_value;
6860   int num_bytes = 0;
6861   boolean modified = FALSE;
6862
6863   if (byte_mask != CONF_MASK_MULTI_BYTES)
6864   {
6865     void *value_ptr = entry->value;
6866     int value = (data_type == TYPE_BOOLEAN ? *(boolean *)value_ptr :
6867                  *(int *)value_ptr);
6868
6869     /* check if any settings have been modified before saving them */
6870     if (value != default_value)
6871       modified = TRUE;
6872
6873     /* do not save if explicitly told or if unmodified default settings */
6874     if ((save_type == SAVE_CONF_NEVER) ||
6875         (save_type == SAVE_CONF_WHEN_CHANGED && !modified))
6876       return 0;
6877
6878     if (write_element)
6879       num_bytes += putFile16BitBE(file, element);
6880
6881     num_bytes += putFile8Bit(file, conf_type);
6882     num_bytes += (byte_mask == CONF_MASK_1_BYTE ? putFile8Bit   (file, value) :
6883                   byte_mask == CONF_MASK_2_BYTE ? putFile16BitBE(file, value) :
6884                   byte_mask == CONF_MASK_4_BYTE ? putFile32BitBE(file, value) :
6885                   0);
6886   }
6887   else if (data_type == TYPE_STRING)
6888   {
6889     char *default_string = entry->default_string;
6890     char *string = (char *)(entry->value);
6891     int string_length = strlen(string);
6892     int i;
6893
6894     /* check if any settings have been modified before saving them */
6895     if (!strEqual(string, default_string))
6896       modified = TRUE;
6897
6898     /* do not save if explicitly told or if unmodified default settings */
6899     if ((save_type == SAVE_CONF_NEVER) ||
6900         (save_type == SAVE_CONF_WHEN_CHANGED && !modified))
6901       return 0;
6902
6903     if (write_element)
6904       num_bytes += putFile16BitBE(file, element);
6905
6906     num_bytes += putFile8Bit(file, conf_type);
6907     num_bytes += putFile16BitBE(file, string_length);
6908
6909     for (i = 0; i < string_length; i++)
6910       num_bytes += putFile8Bit(file, string[i]);
6911   }
6912   else if (data_type == TYPE_ELEMENT_LIST)
6913   {
6914     int *element_array = (int *)(entry->value);
6915     int num_elements = *(int *)(entry->num_entities);
6916     int i;
6917
6918     /* check if any settings have been modified before saving them */
6919     for (i = 0; i < num_elements; i++)
6920       if (element_array[i] != default_value)
6921         modified = TRUE;
6922
6923     /* do not save if explicitly told or if unmodified default settings */
6924     if ((save_type == SAVE_CONF_NEVER) ||
6925         (save_type == SAVE_CONF_WHEN_CHANGED && !modified))
6926       return 0;
6927
6928     if (write_element)
6929       num_bytes += putFile16BitBE(file, element);
6930
6931     num_bytes += putFile8Bit(file, conf_type);
6932     num_bytes += putFile16BitBE(file, num_elements * CONF_ELEMENT_NUM_BYTES);
6933
6934     for (i = 0; i < num_elements; i++)
6935       num_bytes += putFile16BitBE(file, element_array[i]);
6936   }
6937   else if (data_type == TYPE_CONTENT_LIST)
6938   {
6939     struct Content *content = (struct Content *)(entry->value);
6940     int num_contents = *(int *)(entry->num_entities);
6941     int i, x, y;
6942
6943     /* check if any settings have been modified before saving them */
6944     for (i = 0; i < num_contents; i++)
6945       for (y = 0; y < 3; y++)
6946         for (x = 0; x < 3; x++)
6947           if (content[i].e[x][y] != default_value)
6948             modified = TRUE;
6949
6950     /* do not save if explicitly told or if unmodified default settings */
6951     if ((save_type == SAVE_CONF_NEVER) ||
6952         (save_type == SAVE_CONF_WHEN_CHANGED && !modified))
6953       return 0;
6954
6955     if (write_element)
6956       num_bytes += putFile16BitBE(file, element);
6957
6958     num_bytes += putFile8Bit(file, conf_type);
6959     num_bytes += putFile16BitBE(file, num_contents * CONF_CONTENT_NUM_BYTES);
6960
6961     for (i = 0; i < num_contents; i++)
6962       for (y = 0; y < 3; y++)
6963         for (x = 0; x < 3; x++)
6964           num_bytes += putFile16BitBE(file, content[i].e[x][y]);
6965   }
6966
6967   return num_bytes;
6968 }
6969
6970 static int SaveLevel_INFO(FILE *file, struct LevelInfo *level)
6971 {
6972   int chunk_size = 0;
6973   int i;
6974
6975   li = *level;          /* copy level data into temporary buffer */
6976
6977   for (i = 0; chunk_config_INFO[i].data_type != -1; i++)
6978     chunk_size += SaveLevel_MicroChunk(file, &chunk_config_INFO[i], FALSE);
6979
6980   return chunk_size;
6981 }
6982
6983 static int SaveLevel_ELEM(FILE *file, struct LevelInfo *level)
6984 {
6985   int chunk_size = 0;
6986   int i;
6987
6988   li = *level;          /* copy level data into temporary buffer */
6989
6990   for (i = 0; chunk_config_ELEM[i].data_type != -1; i++)
6991     chunk_size += SaveLevel_MicroChunk(file, &chunk_config_ELEM[i], TRUE);
6992
6993   return chunk_size;
6994 }
6995
6996 static int SaveLevel_NOTE(FILE *file, struct LevelInfo *level, int element)
6997 {
6998   int envelope_nr = element - EL_ENVELOPE_1;
6999   int chunk_size = 0;
7000   int i;
7001
7002   chunk_size += putFile16BitBE(file, element);
7003
7004   /* copy envelope data into temporary buffer */
7005   xx_envelope = level->envelope[envelope_nr];
7006
7007   for (i = 0; chunk_config_NOTE[i].data_type != -1; i++)
7008     chunk_size += SaveLevel_MicroChunk(file, &chunk_config_NOTE[i], FALSE);
7009
7010   return chunk_size;
7011 }
7012
7013 static int SaveLevel_CUSX(FILE *file, struct LevelInfo *level, int element)
7014 {
7015   struct ElementInfo *ei = &element_info[element];
7016   int chunk_size = 0;
7017   int i, j;
7018
7019   chunk_size += putFile16BitBE(file, element);
7020
7021   xx_ei = *ei;          /* copy element data into temporary buffer */
7022
7023   /* set default description string for this specific element */
7024   strcpy(xx_default_description, getDefaultElementDescription(ei));
7025
7026   for (i = 0; chunk_config_CUSX_base[i].data_type != -1; i++)
7027     chunk_size += SaveLevel_MicroChunk(file, &chunk_config_CUSX_base[i], FALSE);
7028
7029   for (i = 0; i < ei->num_change_pages; i++)
7030   {
7031     struct ElementChangeInfo *change = &ei->change_page[i];
7032
7033     xx_current_change_page = i;
7034
7035     xx_change = *change;        /* copy change data into temporary buffer */
7036
7037     resetEventBits();
7038     setEventBitsFromEventFlags(change);
7039
7040     for (j = 0; chunk_config_CUSX_change[j].data_type != -1; j++)
7041       chunk_size += SaveLevel_MicroChunk(file, &chunk_config_CUSX_change[j],
7042                                          FALSE);
7043   }
7044
7045   return chunk_size;
7046 }
7047
7048 static int SaveLevel_GRPX(FILE *file, struct LevelInfo *level, int element)
7049 {
7050   struct ElementInfo *ei = &element_info[element];
7051   struct ElementGroupInfo *group = ei->group;
7052   int chunk_size = 0;
7053   int i;
7054
7055   chunk_size += putFile16BitBE(file, element);
7056
7057   xx_ei = *ei;          /* copy element data into temporary buffer */
7058   xx_group = *group;    /* copy group data into temporary buffer */
7059
7060   /* set default description string for this specific element */
7061   strcpy(xx_default_description, getDefaultElementDescription(ei));
7062
7063   for (i = 0; chunk_config_GRPX[i].data_type != -1; i++)
7064     chunk_size += SaveLevel_MicroChunk(file, &chunk_config_GRPX[i], FALSE);
7065
7066   return chunk_size;
7067 }
7068
7069 static void SaveLevelFromFilename(struct LevelInfo *level, char *filename,
7070                                   boolean save_as_template)
7071 {
7072   int chunk_size;
7073   int i;
7074   FILE *file;
7075
7076   if (!(file = fopen(filename, MODE_WRITE)))
7077   {
7078     Error(ERR_WARN, "cannot save level file '%s'", filename);
7079     return;
7080   }
7081
7082   level->file_version = FILE_VERSION_ACTUAL;
7083   level->game_version = GAME_VERSION_ACTUAL;
7084
7085   level->creation_date = getCurrentDate();
7086
7087   putFileChunkBE(file, "RND1", CHUNK_SIZE_UNDEFINED);
7088   putFileChunkBE(file, "CAVE", CHUNK_SIZE_NONE);
7089
7090   chunk_size = SaveLevel_VERS(NULL, level);
7091   putFileChunkBE(file, "VERS", chunk_size);
7092   SaveLevel_VERS(file, level);
7093
7094   chunk_size = SaveLevel_DATE(NULL, level);
7095   putFileChunkBE(file, "DATE", chunk_size);
7096   SaveLevel_DATE(file, level);
7097
7098   chunk_size = SaveLevel_NAME(NULL, level);
7099   putFileChunkBE(file, "NAME", chunk_size);
7100   SaveLevel_NAME(file, level);
7101
7102   chunk_size = SaveLevel_AUTH(NULL, level);
7103   putFileChunkBE(file, "AUTH", chunk_size);
7104   SaveLevel_AUTH(file, level);
7105
7106   chunk_size = SaveLevel_INFO(NULL, level);
7107   putFileChunkBE(file, "INFO", chunk_size);
7108   SaveLevel_INFO(file, level);
7109
7110   chunk_size = SaveLevel_BODY(NULL, level);
7111   putFileChunkBE(file, "BODY", chunk_size);
7112   SaveLevel_BODY(file, level);
7113
7114   chunk_size = SaveLevel_ELEM(NULL, level);
7115   if (chunk_size > LEVEL_CHUNK_ELEM_UNCHANGED)          /* save if changed */
7116   {
7117     putFileChunkBE(file, "ELEM", chunk_size);
7118     SaveLevel_ELEM(file, level);
7119   }
7120
7121   for (i = 0; i < NUM_ENVELOPES; i++)
7122   {
7123     int element = EL_ENVELOPE_1 + i;
7124
7125     chunk_size = SaveLevel_NOTE(NULL, level, element);
7126     if (chunk_size > LEVEL_CHUNK_NOTE_UNCHANGED)        /* save if changed */
7127     {
7128       putFileChunkBE(file, "NOTE", chunk_size);
7129       SaveLevel_NOTE(file, level, element);
7130     }
7131   }
7132
7133   /* if not using template level, check for non-default custom/group elements */
7134   if (!level->use_custom_template || save_as_template)
7135   {
7136     for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
7137     {
7138       int element = EL_CUSTOM_START + i;
7139
7140       chunk_size = SaveLevel_CUSX(NULL, level, element);
7141       if (chunk_size > LEVEL_CHUNK_CUSX_UNCHANGED)      /* save if changed */
7142       {
7143         putFileChunkBE(file, "CUSX", chunk_size);
7144         SaveLevel_CUSX(file, level, element);
7145       }
7146     }
7147
7148     for (i = 0; i < NUM_GROUP_ELEMENTS; i++)
7149     {
7150       int element = EL_GROUP_START + i;
7151
7152       chunk_size = SaveLevel_GRPX(NULL, level, element);
7153       if (chunk_size > LEVEL_CHUNK_GRPX_UNCHANGED)      /* save if changed */
7154       {
7155         putFileChunkBE(file, "GRPX", chunk_size);
7156         SaveLevel_GRPX(file, level, element);
7157       }
7158     }
7159   }
7160
7161   fclose(file);
7162
7163   SetFilePermissions(filename, PERMS_PRIVATE);
7164 }
7165
7166 void SaveLevel(int nr)
7167 {
7168   char *filename = getDefaultLevelFilename(nr);
7169
7170   SaveLevelFromFilename(&level, filename, FALSE);
7171 }
7172
7173 void SaveLevelTemplate()
7174 {
7175   char *filename = getLocalLevelTemplateFilename();
7176
7177   SaveLevelFromFilename(&level, filename, TRUE);
7178 }
7179
7180 boolean SaveLevelChecked(int nr)
7181 {
7182   char *filename = getDefaultLevelFilename(nr);
7183   boolean new_level = !fileExists(filename);
7184   boolean level_saved = FALSE;
7185
7186   if (new_level || Request("Save this level and kill the old?", REQ_ASK))
7187   {
7188     SaveLevel(nr);
7189
7190     if (new_level)
7191       Request("Level saved!", REQ_CONFIRM);
7192
7193     level_saved = TRUE;
7194   }
7195
7196   return level_saved;
7197 }
7198
7199 void DumpLevel(struct LevelInfo *level)
7200 {
7201   if (level->no_level_file || level->no_valid_file)
7202   {
7203     Error(ERR_WARN, "cannot dump -- no valid level file found");
7204
7205     return;
7206   }
7207
7208   PrintLine("-", 79);
7209   Print("Level xxx (file version %08d, game version %08d)\n",
7210         level->file_version, level->game_version);
7211   PrintLine("-", 79);
7212
7213   Print("Level author: '%s'\n", level->author);
7214   Print("Level title:  '%s'\n", level->name);
7215   Print("\n");
7216   Print("Playfield size: %d x %d\n", level->fieldx, level->fieldy);
7217   Print("\n");
7218   Print("Level time:  %d seconds\n", level->time);
7219   Print("Gems needed: %d\n", level->gems_needed);
7220   Print("\n");
7221   Print("Time for magic wall: %d seconds\n", level->time_magic_wall);
7222   Print("Time for wheel:      %d seconds\n", level->time_wheel);
7223   Print("Time for light:      %d seconds\n", level->time_light);
7224   Print("Time for timegate:   %d seconds\n", level->time_timegate);
7225   Print("\n");
7226   Print("Amoeba speed: %d\n", level->amoeba_speed);
7227   Print("\n");
7228
7229   Print("EM style slippery gems:      %s\n", (level->em_slippery_gems ? "yes" : "no"));
7230   Print("Player blocks last field:    %s\n", (level->block_last_field ? "yes" : "no"));
7231   Print("SP player blocks last field: %s\n", (level->sp_block_last_field ? "yes" : "no"));
7232   Print("use spring bug: %s\n", (level->use_spring_bug ? "yes" : "no"));
7233   Print("use step counter: %s\n", (level->use_step_counter ? "yes" : "no"));
7234
7235   PrintLine("-", 79);
7236 }
7237
7238
7239 /* ========================================================================= */
7240 /* tape file functions                                                       */
7241 /* ========================================================================= */
7242
7243 static void setTapeInfoToDefaults()
7244 {
7245   int i;
7246
7247   /* always start with reliable default values (empty tape) */
7248   TapeErase();
7249
7250   /* default values (also for pre-1.2 tapes) with only the first player */
7251   tape.player_participates[0] = TRUE;
7252   for (i = 1; i < MAX_PLAYERS; i++)
7253     tape.player_participates[i] = FALSE;
7254
7255   /* at least one (default: the first) player participates in every tape */
7256   tape.num_participating_players = 1;
7257
7258   tape.level_nr = level_nr;
7259   tape.counter = 0;
7260   tape.changed = FALSE;
7261
7262   tape.recording = FALSE;
7263   tape.playing = FALSE;
7264   tape.pausing = FALSE;
7265
7266   tape.no_valid_file = FALSE;
7267 }
7268
7269 static int LoadTape_VERS(File *file, int chunk_size, struct TapeInfo *tape)
7270 {
7271   tape->file_version = getFileVersion(file);
7272   tape->game_version = getFileVersion(file);
7273
7274   return chunk_size;
7275 }
7276
7277 static int LoadTape_HEAD(File *file, int chunk_size, struct TapeInfo *tape)
7278 {
7279   int i;
7280
7281   tape->random_seed = getFile32BitBE(file);
7282   tape->date        = getFile32BitBE(file);
7283   tape->length      = getFile32BitBE(file);
7284
7285   /* read header fields that are new since version 1.2 */
7286   if (tape->file_version >= FILE_VERSION_1_2)
7287   {
7288     byte store_participating_players = getFile8Bit(file);
7289     int engine_version;
7290
7291     /* since version 1.2, tapes store which players participate in the tape */
7292     tape->num_participating_players = 0;
7293     for (i = 0; i < MAX_PLAYERS; i++)
7294     {
7295       tape->player_participates[i] = FALSE;
7296
7297       if (store_participating_players & (1 << i))
7298       {
7299         tape->player_participates[i] = TRUE;
7300         tape->num_participating_players++;
7301       }
7302     }
7303
7304     ReadUnusedBytesFromFile(file, TAPE_CHUNK_HEAD_UNUSED);
7305
7306     engine_version = getFileVersion(file);
7307     if (engine_version > 0)
7308       tape->engine_version = engine_version;
7309     else
7310       tape->engine_version = tape->game_version;
7311   }
7312
7313   return chunk_size;
7314 }
7315
7316 static int LoadTape_INFO(File *file, int chunk_size, struct TapeInfo *tape)
7317 {
7318   int level_identifier_size;
7319   int i;
7320
7321   level_identifier_size = getFile16BitBE(file);
7322
7323   tape->level_identifier =
7324     checked_realloc(tape->level_identifier, level_identifier_size);
7325
7326   for (i = 0; i < level_identifier_size; i++)
7327     tape->level_identifier[i] = getFile8Bit(file);
7328
7329   tape->level_nr = getFile16BitBE(file);
7330
7331   chunk_size = 2 + level_identifier_size + 2;
7332
7333   return chunk_size;
7334 }
7335
7336 static int LoadTape_BODY(File *file, int chunk_size, struct TapeInfo *tape)
7337 {
7338   int i, j;
7339   int chunk_size_expected =
7340     (tape->num_participating_players + 1) * tape->length;
7341
7342   if (chunk_size_expected != chunk_size)
7343   {
7344     ReadUnusedBytesFromFile(file, chunk_size);
7345     return chunk_size_expected;
7346   }
7347
7348   for (i = 0; i < tape->length; i++)
7349   {
7350     if (i >= MAX_TAPE_LEN)
7351       break;
7352
7353     for (j = 0; j < MAX_PLAYERS; j++)
7354     {
7355       tape->pos[i].action[j] = MV_NONE;
7356
7357       if (tape->player_participates[j])
7358         tape->pos[i].action[j] = getFile8Bit(file);
7359     }
7360
7361     tape->pos[i].delay = getFile8Bit(file);
7362
7363     if (tape->file_version == FILE_VERSION_1_0)
7364     {
7365       /* eliminate possible diagonal moves in old tapes */
7366       /* this is only for backward compatibility */
7367
7368       byte joy_dir[4] = { JOY_LEFT, JOY_RIGHT, JOY_UP, JOY_DOWN };
7369       byte action = tape->pos[i].action[0];
7370       int k, num_moves = 0;
7371
7372       for (k = 0; k<4; k++)
7373       {
7374         if (action & joy_dir[k])
7375         {
7376           tape->pos[i + num_moves].action[0] = joy_dir[k];
7377           if (num_moves > 0)
7378             tape->pos[i + num_moves].delay = 0;
7379           num_moves++;
7380         }
7381       }
7382
7383       if (num_moves > 1)
7384       {
7385         num_moves--;
7386         i += num_moves;
7387         tape->length += num_moves;
7388       }
7389     }
7390     else if (tape->file_version < FILE_VERSION_2_0)
7391     {
7392       /* convert pre-2.0 tapes to new tape format */
7393
7394       if (tape->pos[i].delay > 1)
7395       {
7396         /* action part */
7397         tape->pos[i + 1] = tape->pos[i];
7398         tape->pos[i + 1].delay = 1;
7399
7400         /* delay part */
7401         for (j = 0; j < MAX_PLAYERS; j++)
7402           tape->pos[i].action[j] = MV_NONE;
7403         tape->pos[i].delay--;
7404
7405         i++;
7406         tape->length++;
7407       }
7408     }
7409
7410     if (checkEndOfFile(file))
7411       break;
7412   }
7413
7414   if (i != tape->length)
7415     chunk_size = (tape->num_participating_players + 1) * i;
7416
7417   return chunk_size;
7418 }
7419
7420 void LoadTape_SokobanSolution(char *filename)
7421 {
7422   File *file;
7423   int move_delay = TILESIZE / level.initial_player_stepsize[0];
7424
7425   if (!(file = openFile(filename, MODE_READ)))
7426   {
7427     tape.no_valid_file = TRUE;
7428
7429     return;
7430   }
7431
7432   while (!checkEndOfFile(file))
7433   {
7434     unsigned char c = getByteFromFile(file);
7435
7436     if (checkEndOfFile(file))
7437       break;
7438
7439     switch (c)
7440     {
7441       case 'u':
7442       case 'U':
7443         tape.pos[tape.length].action[0] = MV_UP;
7444         tape.pos[tape.length].delay = move_delay + (c < 'a' ? 2 : 0);
7445         tape.length++;
7446         break;
7447
7448       case 'd':
7449       case 'D':
7450         tape.pos[tape.length].action[0] = MV_DOWN;
7451         tape.pos[tape.length].delay = move_delay + (c < 'a' ? 2 : 0);
7452         tape.length++;
7453         break;
7454
7455       case 'l':
7456       case 'L':
7457         tape.pos[tape.length].action[0] = MV_LEFT;
7458         tape.pos[tape.length].delay = move_delay + (c < 'a' ? 2 : 0);
7459         tape.length++;
7460         break;
7461
7462       case 'r':
7463       case 'R':
7464         tape.pos[tape.length].action[0] = MV_RIGHT;
7465         tape.pos[tape.length].delay = move_delay + (c < 'a' ? 2 : 0);
7466         tape.length++;
7467         break;
7468
7469       case '\n':
7470       case '\r':
7471       case '\t':
7472       case ' ':
7473         /* ignore white-space characters */
7474         break;
7475
7476       default:
7477         tape.no_valid_file = TRUE;
7478
7479         Error(ERR_WARN, "unsupported Sokoban solution file '%s' ['%d']", filename, c);
7480
7481         break;
7482     }
7483   }
7484
7485   closeFile(file);
7486
7487   if (tape.no_valid_file)
7488     return;
7489
7490   tape.length_frames  = GetTapeLengthFrames();
7491   tape.length_seconds = GetTapeLengthSeconds();
7492 }
7493
7494 void LoadTapeFromFilename(char *filename)
7495 {
7496   char cookie[MAX_LINE_LEN];
7497   char chunk_name[CHUNK_ID_LEN + 1];
7498   File *file;
7499   int chunk_size;
7500
7501   /* always start with reliable default values */
7502   setTapeInfoToDefaults();
7503
7504   if (strSuffix(filename, ".sln"))
7505   {
7506     LoadTape_SokobanSolution(filename);
7507
7508     return;
7509   }
7510
7511   if (!(file = openFile(filename, MODE_READ)))
7512   {
7513     tape.no_valid_file = TRUE;
7514
7515     return;
7516   }
7517
7518   getFileChunkBE(file, chunk_name, NULL);
7519   if (strEqual(chunk_name, "RND1"))
7520   {
7521     getFile32BitBE(file);               /* not used */
7522
7523     getFileChunkBE(file, chunk_name, NULL);
7524     if (!strEqual(chunk_name, "TAPE"))
7525     {
7526       tape.no_valid_file = TRUE;
7527
7528       Error(ERR_WARN, "unknown format of tape file '%s'", filename);
7529
7530       closeFile(file);
7531
7532       return;
7533     }
7534   }
7535   else  /* check for pre-2.0 file format with cookie string */
7536   {
7537     strcpy(cookie, chunk_name);
7538     if (getStringFromFile(file, &cookie[4], MAX_LINE_LEN - 4) == NULL)
7539       cookie[4] = '\0';
7540     if (strlen(cookie) > 0 && cookie[strlen(cookie) - 1] == '\n')
7541       cookie[strlen(cookie) - 1] = '\0';
7542
7543     if (!checkCookieString(cookie, TAPE_COOKIE_TMPL))
7544     {
7545       tape.no_valid_file = TRUE;
7546
7547       Error(ERR_WARN, "unknown format of tape file '%s'", filename);
7548
7549       closeFile(file);
7550
7551       return;
7552     }
7553
7554     if ((tape.file_version = getFileVersionFromCookieString(cookie)) == -1)
7555     {
7556       tape.no_valid_file = TRUE;
7557
7558       Error(ERR_WARN, "unsupported version of tape file '%s'", filename);
7559
7560       closeFile(file);
7561
7562       return;
7563     }
7564
7565     /* pre-2.0 tape files have no game version, so use file version here */
7566     tape.game_version = tape.file_version;
7567   }
7568
7569   if (tape.file_version < FILE_VERSION_1_2)
7570   {
7571     /* tape files from versions before 1.2.0 without chunk structure */
7572     LoadTape_HEAD(file, TAPE_CHUNK_HEAD_SIZE, &tape);
7573     LoadTape_BODY(file, 2 * tape.length,      &tape);
7574   }
7575   else
7576   {
7577     static struct
7578     {
7579       char *name;
7580       int size;
7581       int (*loader)(File *, int, struct TapeInfo *);
7582     }
7583     chunk_info[] =
7584     {
7585       { "VERS", TAPE_CHUNK_VERS_SIZE,   LoadTape_VERS },
7586       { "HEAD", TAPE_CHUNK_HEAD_SIZE,   LoadTape_HEAD },
7587       { "INFO", -1,                     LoadTape_INFO },
7588       { "BODY", -1,                     LoadTape_BODY },
7589       {  NULL,  0,                      NULL }
7590     };
7591
7592     while (getFileChunkBE(file, chunk_name, &chunk_size))
7593     {
7594       int i = 0;
7595
7596       while (chunk_info[i].name != NULL &&
7597              !strEqual(chunk_name, chunk_info[i].name))
7598         i++;
7599
7600       if (chunk_info[i].name == NULL)
7601       {
7602         Error(ERR_WARN, "unknown chunk '%s' in tape file '%s'",
7603               chunk_name, filename);
7604         ReadUnusedBytesFromFile(file, chunk_size);
7605       }
7606       else if (chunk_info[i].size != -1 &&
7607                chunk_info[i].size != chunk_size)
7608       {
7609         Error(ERR_WARN, "wrong size (%d) of chunk '%s' in tape file '%s'",
7610               chunk_size, chunk_name, filename);
7611         ReadUnusedBytesFromFile(file, chunk_size);
7612       }
7613       else
7614       {
7615         /* call function to load this tape chunk */
7616         int chunk_size_expected =
7617           (chunk_info[i].loader)(file, chunk_size, &tape);
7618
7619         /* the size of some chunks cannot be checked before reading other
7620            chunks first (like "HEAD" and "BODY") that contain some header
7621            information, so check them here */
7622         if (chunk_size_expected != chunk_size)
7623         {
7624           Error(ERR_WARN, "wrong size (%d) of chunk '%s' in tape file '%s'",
7625                 chunk_size, chunk_name, filename);
7626         }
7627       }
7628     }
7629   }
7630
7631   closeFile(file);
7632
7633   tape.length_frames  = GetTapeLengthFrames();
7634   tape.length_seconds = GetTapeLengthSeconds();
7635
7636 #if 0
7637   printf("::: tape file version: %d\n",   tape.file_version);
7638   printf("::: tape game version: %d\n",   tape.game_version);
7639   printf("::: tape engine version: %d\n", tape.engine_version);
7640 #endif
7641 }
7642
7643 void LoadTape(int nr)
7644 {
7645   char *filename = getTapeFilename(nr);
7646
7647   LoadTapeFromFilename(filename);
7648 }
7649
7650 void LoadSolutionTape(int nr)
7651 {
7652   char *filename = getSolutionTapeFilename(nr);
7653
7654   LoadTapeFromFilename(filename);
7655
7656   if (TAPE_IS_EMPTY(tape) &&
7657       level.game_engine_type == GAME_ENGINE_TYPE_SP &&
7658       level.native_sp_level->demo.is_available)
7659     CopyNativeTape_SP_to_RND(&level);
7660 }
7661
7662 static void SaveTape_VERS(FILE *file, struct TapeInfo *tape)
7663 {
7664   putFileVersion(file, tape->file_version);
7665   putFileVersion(file, tape->game_version);
7666 }
7667
7668 static void SaveTape_HEAD(FILE *file, struct TapeInfo *tape)
7669 {
7670   int i;
7671   byte store_participating_players = 0;
7672
7673   /* set bits for participating players for compact storage */
7674   for (i = 0; i < MAX_PLAYERS; i++)
7675     if (tape->player_participates[i])
7676       store_participating_players |= (1 << i);
7677
7678   putFile32BitBE(file, tape->random_seed);
7679   putFile32BitBE(file, tape->date);
7680   putFile32BitBE(file, tape->length);
7681
7682   putFile8Bit(file, store_participating_players);
7683
7684   /* unused bytes not at the end here for 4-byte alignment of engine_version */
7685   WriteUnusedBytesToFile(file, TAPE_CHUNK_HEAD_UNUSED);
7686
7687   putFileVersion(file, tape->engine_version);
7688 }
7689
7690 static void SaveTape_INFO(FILE *file, struct TapeInfo *tape)
7691 {
7692   int level_identifier_size = strlen(tape->level_identifier) + 1;
7693   int i;
7694
7695   putFile16BitBE(file, level_identifier_size);
7696
7697   for (i = 0; i < level_identifier_size; i++)
7698     putFile8Bit(file, tape->level_identifier[i]);
7699
7700   putFile16BitBE(file, tape->level_nr);
7701 }
7702
7703 static void SaveTape_BODY(FILE *file, struct TapeInfo *tape)
7704 {
7705   int i, j;
7706
7707   for (i = 0; i < tape->length; i++)
7708   {
7709     for (j = 0; j < MAX_PLAYERS; j++)
7710       if (tape->player_participates[j])
7711         putFile8Bit(file, tape->pos[i].action[j]);
7712
7713     putFile8Bit(file, tape->pos[i].delay);
7714   }
7715 }
7716
7717 void SaveTape(int nr)
7718 {
7719   char *filename = getTapeFilename(nr);
7720   FILE *file;
7721   int num_participating_players = 0;
7722   int info_chunk_size;
7723   int body_chunk_size;
7724   int i;
7725
7726   InitTapeDirectory(leveldir_current->subdir);
7727
7728   if (!(file = fopen(filename, MODE_WRITE)))
7729   {
7730     Error(ERR_WARN, "cannot save level recording file '%s'", filename);
7731     return;
7732   }
7733
7734   tape.file_version = FILE_VERSION_ACTUAL;
7735   tape.game_version = GAME_VERSION_ACTUAL;
7736
7737   /* count number of participating players  */
7738   for (i = 0; i < MAX_PLAYERS; i++)
7739     if (tape.player_participates[i])
7740       num_participating_players++;
7741
7742   info_chunk_size = 2 + (strlen(tape.level_identifier) + 1) + 2;
7743   body_chunk_size = (num_participating_players + 1) * tape.length;
7744
7745   putFileChunkBE(file, "RND1", CHUNK_SIZE_UNDEFINED);
7746   putFileChunkBE(file, "TAPE", CHUNK_SIZE_NONE);
7747
7748   putFileChunkBE(file, "VERS", TAPE_CHUNK_VERS_SIZE);
7749   SaveTape_VERS(file, &tape);
7750
7751   putFileChunkBE(file, "HEAD", TAPE_CHUNK_HEAD_SIZE);
7752   SaveTape_HEAD(file, &tape);
7753
7754   putFileChunkBE(file, "INFO", info_chunk_size);
7755   SaveTape_INFO(file, &tape);
7756
7757   putFileChunkBE(file, "BODY", body_chunk_size);
7758   SaveTape_BODY(file, &tape);
7759
7760   fclose(file);
7761
7762   SetFilePermissions(filename, PERMS_PRIVATE);
7763
7764   tape.changed = FALSE;
7765 }
7766
7767 boolean SaveTapeChecked(int nr)
7768 {
7769   char *filename = getTapeFilename(nr);
7770   boolean new_tape = !fileExists(filename);
7771   boolean tape_saved = FALSE;
7772
7773   if (new_tape || Request("Replace old tape?", REQ_ASK))
7774   {
7775     SaveTape(nr);
7776
7777     if (new_tape)
7778       Request("Tape saved!", REQ_CONFIRM);
7779
7780     tape_saved = TRUE;
7781   }
7782
7783   return tape_saved;
7784 }
7785
7786 void DumpTape(struct TapeInfo *tape)
7787 {
7788   int tape_frame_counter;
7789   int i, j;
7790
7791   if (tape->no_valid_file)
7792   {
7793     Error(ERR_WARN, "cannot dump -- no valid tape file found");
7794
7795     return;
7796   }
7797
7798   PrintLine("-", 79);
7799   Print("Tape of Level %03d (file version %08d, game version %08d)\n",
7800         tape->level_nr, tape->file_version, tape->game_version);
7801   Print("                  (effective engine version %08d)\n",
7802         tape->engine_version);
7803   Print("Level series identifier: '%s'\n", tape->level_identifier);
7804   PrintLine("-", 79);
7805
7806   tape_frame_counter = 0;
7807
7808   for (i = 0; i < tape->length; i++)
7809   {
7810     if (i >= MAX_TAPE_LEN)
7811       break;
7812
7813     Print("%04d: ", i);
7814
7815     for (j = 0; j < MAX_PLAYERS; j++)
7816     {
7817       if (tape->player_participates[j])
7818       {
7819         int action = tape->pos[i].action[j];
7820
7821         Print("%d:%02x ", j, action);
7822         Print("[%c%c%c%c|%c%c] - ",
7823               (action & JOY_LEFT ? '<' : ' '),
7824               (action & JOY_RIGHT ? '>' : ' '),
7825               (action & JOY_UP ? '^' : ' '),
7826               (action & JOY_DOWN ? 'v' : ' '),
7827               (action & JOY_BUTTON_1 ? '1' : ' '),
7828               (action & JOY_BUTTON_2 ? '2' : ' '));
7829       }
7830     }
7831
7832     Print("(%03d) ", tape->pos[i].delay);
7833     Print("[%05d]\n", tape_frame_counter);
7834
7835     tape_frame_counter += tape->pos[i].delay;
7836   }
7837
7838   PrintLine("-", 79);
7839 }
7840
7841
7842 /* ========================================================================= */
7843 /* score file functions                                                      */
7844 /* ========================================================================= */
7845
7846 void LoadScore(int nr)
7847 {
7848   int i;
7849   char *filename = getScoreFilename(nr);
7850   char cookie[MAX_LINE_LEN];
7851   char line[MAX_LINE_LEN];
7852   char *line_ptr;
7853   FILE *file;
7854
7855   /* always start with reliable default values */
7856   for (i = 0; i < MAX_SCORE_ENTRIES; i++)
7857   {
7858     strcpy(highscore[i].Name, EMPTY_PLAYER_NAME);
7859     highscore[i].Score = 0;
7860   }
7861
7862   if (!(file = fopen(filename, MODE_READ)))
7863     return;
7864
7865   /* check file identifier */
7866   if (fgets(cookie, MAX_LINE_LEN, file) == NULL)
7867     cookie[0] = '\0';
7868   if (strlen(cookie) > 0 && cookie[strlen(cookie) - 1] == '\n')
7869     cookie[strlen(cookie) - 1] = '\0';
7870
7871   if (!checkCookieString(cookie, SCORE_COOKIE))
7872   {
7873     Error(ERR_WARN, "unknown format of score file '%s'", filename);
7874     fclose(file);
7875     return;
7876   }
7877
7878   for (i = 0; i < MAX_SCORE_ENTRIES; i++)
7879   {
7880     if (fscanf(file, "%d", &highscore[i].Score) == EOF)
7881       Error(ERR_WARN, "fscanf() failed; %s", strerror(errno));
7882     if (fgets(line, MAX_LINE_LEN, file) == NULL)
7883       line[0] = '\0';
7884
7885     if (strlen(line) > 0 && line[strlen(line) - 1] == '\n')
7886       line[strlen(line) - 1] = '\0';
7887
7888     for (line_ptr = line; *line_ptr; line_ptr++)
7889     {
7890       if (*line_ptr != ' ' && *line_ptr != '\t' && *line_ptr != '\0')
7891       {
7892         strncpy(highscore[i].Name, line_ptr, MAX_PLAYER_NAME_LEN);
7893         highscore[i].Name[MAX_PLAYER_NAME_LEN] = '\0';
7894         break;
7895       }
7896     }
7897   }
7898
7899   fclose(file);
7900 }
7901
7902 void SaveScore(int nr)
7903 {
7904   int i;
7905   int permissions = (program.global_scores ? PERMS_PUBLIC : PERMS_PRIVATE);
7906   char *filename = getScoreFilename(nr);
7907   FILE *file;
7908
7909   InitScoreDirectory(leveldir_current->subdir);
7910
7911   if (!(file = fopen(filename, MODE_WRITE)))
7912   {
7913     Error(ERR_WARN, "cannot save score for level %d", nr);
7914     return;
7915   }
7916
7917   fprintf(file, "%s\n\n", SCORE_COOKIE);
7918
7919   for (i = 0; i < MAX_SCORE_ENTRIES; i++)
7920     fprintf(file, "%d %s\n", highscore[i].Score, highscore[i].Name);
7921
7922   fclose(file);
7923
7924   SetFilePermissions(filename, permissions);
7925 }
7926
7927
7928 /* ========================================================================= */
7929 /* setup file functions                                                      */
7930 /* ========================================================================= */
7931
7932 #define TOKEN_STR_PLAYER_PREFIX                 "player_"
7933
7934 /* global setup */
7935 #define SETUP_TOKEN_PLAYER_NAME                 0
7936 #define SETUP_TOKEN_SOUND                       1
7937 #define SETUP_TOKEN_SOUND_LOOPS                 2
7938 #define SETUP_TOKEN_SOUND_MUSIC                 3
7939 #define SETUP_TOKEN_SOUND_SIMPLE                4
7940 #define SETUP_TOKEN_TOONS                       5
7941 #define SETUP_TOKEN_SCROLL_DELAY                6
7942 #define SETUP_TOKEN_SCROLL_DELAY_VALUE          7
7943 #define SETUP_TOKEN_ENGINE_SNAPSHOT_MODE        8
7944 #define SETUP_TOKEN_ENGINE_SNAPSHOT_MEMORY      9
7945 #define SETUP_TOKEN_FADE_SCREENS                10
7946 #define SETUP_TOKEN_AUTORECORD                  11
7947 #define SETUP_TOKEN_SHOW_TITLESCREEN            12
7948 #define SETUP_TOKEN_QUICK_DOORS                 13
7949 #define SETUP_TOKEN_TEAM_MODE                   14
7950 #define SETUP_TOKEN_HANDICAP                    15
7951 #define SETUP_TOKEN_SKIP_LEVELS                 16
7952 #define SETUP_TOKEN_INCREMENT_LEVELS            17
7953 #define SETUP_TOKEN_TIME_LIMIT                  18
7954 #define SETUP_TOKEN_FULLSCREEN                  19
7955 #define SETUP_TOKEN_WINDOW_SCALING_PERCENT      20
7956 #define SETUP_TOKEN_WINDOW_SCALING_QUALITY      21
7957 #define SETUP_TOKEN_SCREEN_RENDERING_MODE       22
7958 #define SETUP_TOKEN_ASK_ON_ESCAPE               23
7959 #define SETUP_TOKEN_ASK_ON_ESCAPE_EDITOR        24
7960 #define SETUP_TOKEN_QUICK_SWITCH                25
7961 #define SETUP_TOKEN_INPUT_ON_FOCUS              26
7962 #define SETUP_TOKEN_PREFER_AGA_GRAPHICS         27
7963 #define SETUP_TOKEN_GAME_FRAME_DELAY            28
7964 #define SETUP_TOKEN_SP_SHOW_BORDER_ELEMENTS     29
7965 #define SETUP_TOKEN_SMALL_GAME_GRAPHICS         30
7966 #define SETUP_TOKEN_SHOW_SNAPSHOT_BUTTONS       31
7967 #define SETUP_TOKEN_GRAPHICS_SET                32
7968 #define SETUP_TOKEN_SOUNDS_SET                  33
7969 #define SETUP_TOKEN_MUSIC_SET                   34
7970 #define SETUP_TOKEN_OVERRIDE_LEVEL_GRAPHICS     35
7971 #define SETUP_TOKEN_OVERRIDE_LEVEL_SOUNDS       36
7972 #define SETUP_TOKEN_OVERRIDE_LEVEL_MUSIC        37
7973 #define SETUP_TOKEN_VOLUME_SIMPLE               38
7974 #define SETUP_TOKEN_VOLUME_LOOPS                39
7975 #define SETUP_TOKEN_VOLUME_MUSIC                40
7976 #define SETUP_TOKEN_TOUCH_CONTROL_TYPE          41
7977 #define SETUP_TOKEN_TOUCH_MOVE_DISTANCE         42
7978 #define SETUP_TOKEN_TOUCH_DROP_DISTANCE         43
7979
7980 #define NUM_GLOBAL_SETUP_TOKENS                 44
7981
7982 /* editor setup */
7983 #define SETUP_TOKEN_EDITOR_EL_CLASSIC           0
7984 #define SETUP_TOKEN_EDITOR_EL_CUSTOM            1
7985 #define SETUP_TOKEN_EDITOR_EL_USER_DEFINED      2
7986 #define SETUP_TOKEN_EDITOR_EL_DYNAMIC           3
7987 #define SETUP_TOKEN_EDITOR_EL_HEADLINES         4
7988 #define SETUP_TOKEN_EDITOR_SHOW_ELEMENT_TOKEN   5
7989
7990 #define NUM_EDITOR_SETUP_TOKENS                 6
7991
7992 /* editor cascade setup */
7993 #define SETUP_TOKEN_EDITOR_CASCADE_BD           0
7994 #define SETUP_TOKEN_EDITOR_CASCADE_EM           1
7995 #define SETUP_TOKEN_EDITOR_CASCADE_EMC          2
7996 #define SETUP_TOKEN_EDITOR_CASCADE_RND          3
7997 #define SETUP_TOKEN_EDITOR_CASCADE_SB           4
7998 #define SETUP_TOKEN_EDITOR_CASCADE_SP           5
7999 #define SETUP_TOKEN_EDITOR_CASCADE_DC           6
8000 #define SETUP_TOKEN_EDITOR_CASCADE_DX           7
8001 #define SETUP_TOKEN_EDITOR_CASCADE_TEXT         8
8002 #define SETUP_TOKEN_EDITOR_CASCADE_STEELTEXT    9
8003 #define SETUP_TOKEN_EDITOR_CASCADE_CE           10
8004 #define SETUP_TOKEN_EDITOR_CASCADE_GE           11
8005 #define SETUP_TOKEN_EDITOR_CASCADE_REF          12
8006 #define SETUP_TOKEN_EDITOR_CASCADE_USER         13
8007 #define SETUP_TOKEN_EDITOR_CASCADE_DYNAMIC      14
8008
8009 #define NUM_EDITOR_CASCADE_SETUP_TOKENS         15
8010
8011 /* shortcut setup */
8012 #define SETUP_TOKEN_SHORTCUT_SAVE_GAME          0
8013 #define SETUP_TOKEN_SHORTCUT_LOAD_GAME          1
8014 #define SETUP_TOKEN_SHORTCUT_TOGGLE_PAUSE       2
8015 #define SETUP_TOKEN_SHORTCUT_FOCUS_PLAYER_1     3
8016 #define SETUP_TOKEN_SHORTCUT_FOCUS_PLAYER_2     4
8017 #define SETUP_TOKEN_SHORTCUT_FOCUS_PLAYER_3     5
8018 #define SETUP_TOKEN_SHORTCUT_FOCUS_PLAYER_4     6
8019 #define SETUP_TOKEN_SHORTCUT_FOCUS_PLAYER_ALL   7
8020 #define SETUP_TOKEN_SHORTCUT_TAPE_EJECT         8
8021 #define SETUP_TOKEN_SHORTCUT_TAPE_EXTRA         9
8022 #define SETUP_TOKEN_SHORTCUT_TAPE_STOP          10
8023 #define SETUP_TOKEN_SHORTCUT_TAPE_PAUSE         11
8024 #define SETUP_TOKEN_SHORTCUT_TAPE_RECORD        12
8025 #define SETUP_TOKEN_SHORTCUT_TAPE_PLAY          13
8026 #define SETUP_TOKEN_SHORTCUT_SOUND_SIMPLE       14
8027 #define SETUP_TOKEN_SHORTCUT_SOUND_LOOPS        15
8028 #define SETUP_TOKEN_SHORTCUT_SOUND_MUSIC        16
8029 #define SETUP_TOKEN_SHORTCUT_SNAP_LEFT          17
8030 #define SETUP_TOKEN_SHORTCUT_SNAP_RIGHT         18
8031 #define SETUP_TOKEN_SHORTCUT_SNAP_UP            19
8032 #define SETUP_TOKEN_SHORTCUT_SNAP_DOWN          20
8033
8034 #define NUM_SHORTCUT_SETUP_TOKENS               21
8035
8036 /* player setup */
8037 #define SETUP_TOKEN_PLAYER_USE_JOYSTICK         0
8038 #define SETUP_TOKEN_PLAYER_JOY_DEVICE_NAME      1
8039 #define SETUP_TOKEN_PLAYER_JOY_XLEFT            2
8040 #define SETUP_TOKEN_PLAYER_JOY_XMIDDLE          3
8041 #define SETUP_TOKEN_PLAYER_JOY_XRIGHT           4
8042 #define SETUP_TOKEN_PLAYER_JOY_YUPPER           5
8043 #define SETUP_TOKEN_PLAYER_JOY_YMIDDLE          6
8044 #define SETUP_TOKEN_PLAYER_JOY_YLOWER           7
8045 #define SETUP_TOKEN_PLAYER_JOY_SNAP             8
8046 #define SETUP_TOKEN_PLAYER_JOY_DROP             9
8047 #define SETUP_TOKEN_PLAYER_KEY_LEFT             10
8048 #define SETUP_TOKEN_PLAYER_KEY_RIGHT            11
8049 #define SETUP_TOKEN_PLAYER_KEY_UP               12
8050 #define SETUP_TOKEN_PLAYER_KEY_DOWN             13
8051 #define SETUP_TOKEN_PLAYER_KEY_SNAP             14
8052 #define SETUP_TOKEN_PLAYER_KEY_DROP             15
8053
8054 #define NUM_PLAYER_SETUP_TOKENS                 16
8055
8056 /* system setup */
8057 #define SETUP_TOKEN_SYSTEM_SDL_VIDEODRIVER      0
8058 #define SETUP_TOKEN_SYSTEM_SDL_AUDIODRIVER      1
8059 #define SETUP_TOKEN_SYSTEM_AUDIO_FRAGMENT_SIZE  2
8060
8061 #define NUM_SYSTEM_SETUP_TOKENS                 3
8062
8063 /* internal setup */
8064 #define SETUP_TOKEN_INT_PROGRAM_TITLE           0
8065 #define SETUP_TOKEN_INT_PROGRAM_VERSION         1
8066 #define SETUP_TOKEN_INT_PROGRAM_AUTHOR          2
8067 #define SETUP_TOKEN_INT_PROGRAM_EMAIL           3
8068 #define SETUP_TOKEN_INT_PROGRAM_WEBSITE         4
8069 #define SETUP_TOKEN_INT_PROGRAM_COPYRIGHT       5
8070 #define SETUP_TOKEN_INT_PROGRAM_COMPANY         6
8071 #define SETUP_TOKEN_INT_PROGRAM_ICON_FILE       7
8072 #define SETUP_TOKEN_INT_DEFAULT_GRAPHICS_SET    8
8073 #define SETUP_TOKEN_INT_DEFAULT_SOUNDS_SET      9
8074 #define SETUP_TOKEN_INT_DEFAULT_MUSIC_SET       10
8075 #define SETUP_TOKEN_INT_FALLBACK_GRAPHICS_FILE  11
8076 #define SETUP_TOKEN_INT_FALLBACK_SOUNDS_FILE    12
8077 #define SETUP_TOKEN_INT_FALLBACK_MUSIC_FILE     13
8078 #define SETUP_TOKEN_INT_DEFAULT_LEVEL_SERIES    14
8079 #define SETUP_TOKEN_INT_CHOOSE_FROM_TOP_LEVELDIR 15
8080 #define SETUP_TOKEN_INT_SHOW_SCALING_IN_TITLE   16
8081 #define SETUP_TOKEN_INT_DEFAULT_WINDOW_WIDTH    17
8082 #define SETUP_TOKEN_INT_DEFAULT_WINDOW_HEIGHT   18
8083
8084 #define NUM_INTERNAL_SETUP_TOKENS               19
8085
8086 /* debug setup */
8087 #define SETUP_TOKEN_DEBUG_FRAME_DELAY_0         0
8088 #define SETUP_TOKEN_DEBUG_FRAME_DELAY_1         1
8089 #define SETUP_TOKEN_DEBUG_FRAME_DELAY_2         2
8090 #define SETUP_TOKEN_DEBUG_FRAME_DELAY_3         3
8091 #define SETUP_TOKEN_DEBUG_FRAME_DELAY_4         4
8092 #define SETUP_TOKEN_DEBUG_FRAME_DELAY_5         5
8093 #define SETUP_TOKEN_DEBUG_FRAME_DELAY_6         6
8094 #define SETUP_TOKEN_DEBUG_FRAME_DELAY_7         7
8095 #define SETUP_TOKEN_DEBUG_FRAME_DELAY_8         8
8096 #define SETUP_TOKEN_DEBUG_FRAME_DELAY_9         9
8097 #define SETUP_TOKEN_DEBUG_FRAME_DELAY_KEY_0     10
8098 #define SETUP_TOKEN_DEBUG_FRAME_DELAY_KEY_1     11
8099 #define SETUP_TOKEN_DEBUG_FRAME_DELAY_KEY_2     12
8100 #define SETUP_TOKEN_DEBUG_FRAME_DELAY_KEY_3     13
8101 #define SETUP_TOKEN_DEBUG_FRAME_DELAY_KEY_4     14
8102 #define SETUP_TOKEN_DEBUG_FRAME_DELAY_KEY_5     15
8103 #define SETUP_TOKEN_DEBUG_FRAME_DELAY_KEY_6     16
8104 #define SETUP_TOKEN_DEBUG_FRAME_DELAY_KEY_7     17
8105 #define SETUP_TOKEN_DEBUG_FRAME_DELAY_KEY_8     18
8106 #define SETUP_TOKEN_DEBUG_FRAME_DELAY_KEY_9     19
8107 #define SETUP_TOKEN_DEBUG_FRAME_DELAY_USE_MOD_KEY 20
8108 #define SETUP_TOKEN_DEBUG_FRAME_DELAY_GAME_ONLY 21
8109 #define SETUP_TOKEN_DEBUG_SHOW_FRAMES_PER_SECOND 22
8110
8111 #define NUM_DEBUG_SETUP_TOKENS                  23
8112
8113 /* options setup */
8114 #define SETUP_TOKEN_OPTIONS_VERBOSE             0
8115
8116 #define NUM_OPTIONS_SETUP_TOKENS                1
8117
8118
8119 static struct SetupInfo si;
8120 static struct SetupEditorInfo sei;
8121 static struct SetupEditorCascadeInfo seci;
8122 static struct SetupShortcutInfo ssi;
8123 static struct SetupInputInfo sii;
8124 static struct SetupSystemInfo syi;
8125 static struct SetupInternalInfo sxi;
8126 static struct SetupDebugInfo sdi;
8127 static struct OptionInfo soi;
8128
8129 static struct TokenInfo global_setup_tokens[] =
8130 {
8131   { TYPE_STRING, &si.player_name,             "player_name"             },
8132   { TYPE_SWITCH, &si.sound,                   "sound"                   },
8133   { TYPE_SWITCH, &si.sound_loops,             "repeating_sound_loops"   },
8134   { TYPE_SWITCH, &si.sound_music,             "background_music"        },
8135   { TYPE_SWITCH, &si.sound_simple,            "simple_sound_effects"    },
8136   { TYPE_SWITCH, &si.toons,                   "toons"                   },
8137   { TYPE_SWITCH, &si.scroll_delay,            "scroll_delay"            },
8138   { TYPE_INTEGER,&si.scroll_delay_value,      "scroll_delay_value"      },
8139   { TYPE_STRING, &si.engine_snapshot_mode,    "engine_snapshot_mode"    },
8140   { TYPE_INTEGER,&si.engine_snapshot_memory,  "engine_snapshot_memory"  },
8141   { TYPE_SWITCH, &si.fade_screens,            "fade_screens"            },
8142   { TYPE_SWITCH, &si.autorecord,              "automatic_tape_recording"},
8143   { TYPE_SWITCH, &si.show_titlescreen,        "show_titlescreen"        },
8144   { TYPE_SWITCH, &si.quick_doors,             "quick_doors"             },
8145   { TYPE_SWITCH, &si.team_mode,               "team_mode"               },
8146   { TYPE_SWITCH, &si.handicap,                "handicap"                },
8147   { TYPE_SWITCH, &si.skip_levels,             "skip_levels"             },
8148   { TYPE_SWITCH, &si.increment_levels,        "increment_levels"        },
8149   { TYPE_SWITCH, &si.time_limit,              "time_limit"              },
8150   { TYPE_SWITCH, &si.fullscreen,              "fullscreen"              },
8151   { TYPE_INTEGER,&si.window_scaling_percent,  "window_scaling_percent"  },
8152   { TYPE_STRING, &si.window_scaling_quality,  "window_scaling_quality"  },
8153   { TYPE_STRING, &si.screen_rendering_mode,   "screen_rendering_mode"   },
8154   { TYPE_SWITCH, &si.ask_on_escape,           "ask_on_escape"           },
8155   { TYPE_SWITCH, &si.ask_on_escape_editor,    "ask_on_escape_editor"    },
8156   { TYPE_SWITCH, &si.quick_switch,            "quick_player_switch"     },
8157   { TYPE_SWITCH, &si.input_on_focus,          "input_on_focus"          },
8158   { TYPE_SWITCH, &si.prefer_aga_graphics,     "prefer_aga_graphics"     },
8159   { TYPE_INTEGER,&si.game_frame_delay,        "game_frame_delay"        },
8160   { TYPE_SWITCH, &si.sp_show_border_elements, "sp_show_border_elements" },
8161   { TYPE_SWITCH, &si.small_game_graphics,     "small_game_graphics"     },
8162   { TYPE_SWITCH, &si.show_snapshot_buttons,   "show_snapshot_buttons"   },
8163   { TYPE_STRING, &si.graphics_set,            "graphics_set"            },
8164   { TYPE_STRING, &si.sounds_set,              "sounds_set"              },
8165   { TYPE_STRING, &si.music_set,               "music_set"               },
8166   { TYPE_SWITCH3,&si.override_level_graphics, "override_level_graphics" },
8167   { TYPE_SWITCH3,&si.override_level_sounds,   "override_level_sounds"   },
8168   { TYPE_SWITCH3,&si.override_level_music,    "override_level_music"    },
8169   { TYPE_INTEGER,&si.volume_simple,           "volume_simple"           },
8170   { TYPE_INTEGER,&si.volume_loops,            "volume_loops"            },
8171   { TYPE_INTEGER,&si.volume_music,            "volume_music"            },
8172   { TYPE_STRING, &si.touch.control_type,      "touch.control_type"      },
8173   { TYPE_INTEGER,&si.touch.move_distance,     "touch.move_distance"     },
8174   { TYPE_INTEGER,&si.touch.drop_distance,     "touch.drop_distance"     },
8175 };
8176
8177 static struct TokenInfo editor_setup_tokens[] =
8178 {
8179   { TYPE_SWITCH, &sei.el_classic,       "editor.el_classic"             },
8180   { TYPE_SWITCH, &sei.el_custom,        "editor.el_custom"              },
8181   { TYPE_SWITCH, &sei.el_user_defined,  "editor.el_user_defined"        },
8182   { TYPE_SWITCH, &sei.el_dynamic,       "editor.el_dynamic"             },
8183   { TYPE_SWITCH, &sei.el_headlines,     "editor.el_headlines"           },
8184   { TYPE_SWITCH, &sei.show_element_token,"editor.show_element_token"    },
8185 };
8186
8187 static struct TokenInfo editor_cascade_setup_tokens[] =
8188 {
8189   { TYPE_SWITCH, &seci.el_bd,           "editor.cascade.el_bd"          },
8190   { TYPE_SWITCH, &seci.el_em,           "editor.cascade.el_em"          },
8191   { TYPE_SWITCH, &seci.el_emc,          "editor.cascade.el_emc"         },
8192   { TYPE_SWITCH, &seci.el_rnd,          "editor.cascade.el_rnd"         },
8193   { TYPE_SWITCH, &seci.el_sb,           "editor.cascade.el_sb"          },
8194   { TYPE_SWITCH, &seci.el_sp,           "editor.cascade.el_sp"          },
8195   { TYPE_SWITCH, &seci.el_dc,           "editor.cascade.el_dc"          },
8196   { TYPE_SWITCH, &seci.el_dx,           "editor.cascade.el_dx"          },
8197   { TYPE_SWITCH, &seci.el_chars,        "editor.cascade.el_chars"       },
8198   { TYPE_SWITCH, &seci.el_steel_chars,  "editor.cascade.el_steel_chars" },
8199   { TYPE_SWITCH, &seci.el_ce,           "editor.cascade.el_ce"          },
8200   { TYPE_SWITCH, &seci.el_ge,           "editor.cascade.el_ge"          },
8201   { TYPE_SWITCH, &seci.el_ref,          "editor.cascade.el_ref"         },
8202   { TYPE_SWITCH, &seci.el_user,         "editor.cascade.el_user"        },
8203   { TYPE_SWITCH, &seci.el_dynamic,      "editor.cascade.el_dynamic"     },
8204 };
8205
8206 static struct TokenInfo shortcut_setup_tokens[] =
8207 {
8208   { TYPE_KEY_X11, &ssi.save_game,       "shortcut.save_game"            },
8209   { TYPE_KEY_X11, &ssi.load_game,       "shortcut.load_game"            },
8210   { TYPE_KEY_X11, &ssi.toggle_pause,    "shortcut.toggle_pause"         },
8211   { TYPE_KEY_X11, &ssi.focus_player[0], "shortcut.focus_player_1"       },
8212   { TYPE_KEY_X11, &ssi.focus_player[1], "shortcut.focus_player_2"       },
8213   { TYPE_KEY_X11, &ssi.focus_player[2], "shortcut.focus_player_3"       },
8214   { TYPE_KEY_X11, &ssi.focus_player[3], "shortcut.focus_player_4"       },
8215   { TYPE_KEY_X11, &ssi.focus_player_all,"shortcut.focus_player_all"     },
8216   { TYPE_KEY_X11, &ssi.tape_eject,      "shortcut.tape_eject"           },
8217   { TYPE_KEY_X11, &ssi.tape_extra,      "shortcut.tape_extra"           },
8218   { TYPE_KEY_X11, &ssi.tape_stop,       "shortcut.tape_stop"            },
8219   { TYPE_KEY_X11, &ssi.tape_pause,      "shortcut.tape_pause"           },
8220   { TYPE_KEY_X11, &ssi.tape_record,     "shortcut.tape_record"          },
8221   { TYPE_KEY_X11, &ssi.tape_play,       "shortcut.tape_play"            },
8222   { TYPE_KEY_X11, &ssi.sound_simple,    "shortcut.sound_simple"         },
8223   { TYPE_KEY_X11, &ssi.sound_loops,     "shortcut.sound_loops"          },
8224   { TYPE_KEY_X11, &ssi.sound_music,     "shortcut.sound_music"          },
8225   { TYPE_KEY_X11, &ssi.snap_left,       "shortcut.snap_left"            },
8226   { TYPE_KEY_X11, &ssi.snap_right,      "shortcut.snap_right"           },
8227   { TYPE_KEY_X11, &ssi.snap_up,         "shortcut.snap_up"              },
8228   { TYPE_KEY_X11, &ssi.snap_down,       "shortcut.snap_down"            },
8229 };
8230
8231 static struct TokenInfo player_setup_tokens[] =
8232 {
8233   { TYPE_BOOLEAN, &sii.use_joystick,    ".use_joystick"                 },
8234   { TYPE_STRING,  &sii.joy.device_name, ".joy.device_name"              },
8235   { TYPE_INTEGER, &sii.joy.xleft,       ".joy.xleft"                    },
8236   { TYPE_INTEGER, &sii.joy.xmiddle,     ".joy.xmiddle"                  },
8237   { TYPE_INTEGER, &sii.joy.xright,      ".joy.xright"                   },
8238   { TYPE_INTEGER, &sii.joy.yupper,      ".joy.yupper"                   },
8239   { TYPE_INTEGER, &sii.joy.ymiddle,     ".joy.ymiddle"                  },
8240   { TYPE_INTEGER, &sii.joy.ylower,      ".joy.ylower"                   },
8241   { TYPE_INTEGER, &sii.joy.snap,        ".joy.snap_field"               },
8242   { TYPE_INTEGER, &sii.joy.drop,        ".joy.place_bomb"               },
8243   { TYPE_KEY_X11, &sii.key.left,        ".key.move_left"                },
8244   { TYPE_KEY_X11, &sii.key.right,       ".key.move_right"               },
8245   { TYPE_KEY_X11, &sii.key.up,          ".key.move_up"                  },
8246   { TYPE_KEY_X11, &sii.key.down,        ".key.move_down"                },
8247   { TYPE_KEY_X11, &sii.key.snap,        ".key.snap_field"               },
8248   { TYPE_KEY_X11, &sii.key.drop,        ".key.place_bomb"               },
8249 };
8250
8251 static struct TokenInfo system_setup_tokens[] =
8252 {
8253   { TYPE_STRING,  &syi.sdl_videodriver,    "system.sdl_videodriver"     },
8254   { TYPE_STRING,  &syi.sdl_audiodriver,    "system.sdl_audiodriver"     },
8255   { TYPE_INTEGER, &syi.audio_fragment_size,"system.audio_fragment_size" },
8256 };
8257
8258 static struct TokenInfo internal_setup_tokens[] =
8259 {
8260   { TYPE_STRING, &sxi.program_title,            "program_title"         },
8261   { TYPE_STRING, &sxi.program_version,          "program_version"       },
8262   { TYPE_STRING, &sxi.program_author,           "program_author"        },
8263   { TYPE_STRING, &sxi.program_email,            "program_email"         },
8264   { TYPE_STRING, &sxi.program_website,          "program_website"       },
8265   { TYPE_STRING, &sxi.program_copyright,        "program_copyright"     },
8266   { TYPE_STRING, &sxi.program_company,          "program_company"       },
8267   { TYPE_STRING, &sxi.program_icon_file,        "program_icon_file"     },
8268   { TYPE_STRING, &sxi.default_graphics_set,     "default_graphics_set"  },
8269   { TYPE_STRING, &sxi.default_sounds_set,       "default_sounds_set"    },
8270   { TYPE_STRING, &sxi.default_music_set,        "default_music_set"     },
8271   { TYPE_STRING, &sxi.fallback_graphics_file,   "fallback_graphics_file"},
8272   { TYPE_STRING, &sxi.fallback_sounds_file,     "fallback_sounds_file"  },
8273   { TYPE_STRING, &sxi.fallback_music_file,      "fallback_music_file"   },
8274   { TYPE_STRING, &sxi.default_level_series,     "default_level_series"  },
8275   { TYPE_BOOLEAN,&sxi.choose_from_top_leveldir, "choose_from_top_leveldir" },
8276   { TYPE_BOOLEAN,&sxi.show_scaling_in_title,    "show_scaling_in_title" },
8277   { TYPE_INTEGER,&sxi.default_window_width,     "default_window_width"  },
8278   { TYPE_INTEGER,&sxi.default_window_height,    "default_window_height" },
8279 };
8280
8281 static struct TokenInfo debug_setup_tokens[] =
8282 {
8283   { TYPE_INTEGER, &sdi.frame_delay[0],          "debug.frame_delay_0"   },
8284   { TYPE_INTEGER, &sdi.frame_delay[1],          "debug.frame_delay_1"   },
8285   { TYPE_INTEGER, &sdi.frame_delay[2],          "debug.frame_delay_2"   },
8286   { TYPE_INTEGER, &sdi.frame_delay[3],          "debug.frame_delay_3"   },
8287   { TYPE_INTEGER, &sdi.frame_delay[4],          "debug.frame_delay_4"   },
8288   { TYPE_INTEGER, &sdi.frame_delay[5],          "debug.frame_delay_5"   },
8289   { TYPE_INTEGER, &sdi.frame_delay[6],          "debug.frame_delay_6"   },
8290   { TYPE_INTEGER, &sdi.frame_delay[7],          "debug.frame_delay_7"   },
8291   { TYPE_INTEGER, &sdi.frame_delay[8],          "debug.frame_delay_8"   },
8292   { TYPE_INTEGER, &sdi.frame_delay[9],          "debug.frame_delay_9"   },
8293   { TYPE_KEY_X11, &sdi.frame_delay_key[0],      "debug.key.frame_delay_0" },
8294   { TYPE_KEY_X11, &sdi.frame_delay_key[1],      "debug.key.frame_delay_1" },
8295   { TYPE_KEY_X11, &sdi.frame_delay_key[2],      "debug.key.frame_delay_2" },
8296   { TYPE_KEY_X11, &sdi.frame_delay_key[3],      "debug.key.frame_delay_3" },
8297   { TYPE_KEY_X11, &sdi.frame_delay_key[4],      "debug.key.frame_delay_4" },
8298   { TYPE_KEY_X11, &sdi.frame_delay_key[5],      "debug.key.frame_delay_5" },
8299   { TYPE_KEY_X11, &sdi.frame_delay_key[6],      "debug.key.frame_delay_6" },
8300   { TYPE_KEY_X11, &sdi.frame_delay_key[7],      "debug.key.frame_delay_7" },
8301   { TYPE_KEY_X11, &sdi.frame_delay_key[8],      "debug.key.frame_delay_8" },
8302   { TYPE_KEY_X11, &sdi.frame_delay_key[9],      "debug.key.frame_delay_9" },
8303   { TYPE_BOOLEAN, &sdi.frame_delay_use_mod_key,"debug.frame_delay.use_mod_key"},
8304   { TYPE_BOOLEAN, &sdi.frame_delay_game_only,  "debug.frame_delay.game_only" },
8305   { TYPE_BOOLEAN, &sdi.show_frames_per_second, "debug.show_frames_per_second" },
8306 };
8307
8308 static struct TokenInfo options_setup_tokens[] =
8309 {
8310   { TYPE_BOOLEAN, &soi.verbose,         "options.verbose"               },
8311 };
8312
8313 static char *get_corrected_login_name(char *login_name)
8314 {
8315   /* needed because player name must be a fixed length string */
8316   char *login_name_new = checked_malloc(MAX_PLAYER_NAME_LEN + 1);
8317
8318   strncpy(login_name_new, login_name, MAX_PLAYER_NAME_LEN);
8319   login_name_new[MAX_PLAYER_NAME_LEN] = '\0';
8320
8321   if (strlen(login_name) > MAX_PLAYER_NAME_LEN)         /* name has been cut */
8322     if (strchr(login_name_new, ' '))
8323       *strchr(login_name_new, ' ') = '\0';
8324
8325   return login_name_new;
8326 }
8327
8328 static void setSetupInfoToDefaults(struct SetupInfo *si)
8329 {
8330   int i;
8331
8332   si->player_name = get_corrected_login_name(getLoginName());
8333
8334   si->sound = TRUE;
8335   si->sound_loops = TRUE;
8336   si->sound_music = TRUE;
8337   si->sound_simple = TRUE;
8338   si->toons = TRUE;
8339   si->scroll_delay = TRUE;
8340   si->scroll_delay_value = STD_SCROLL_DELAY;
8341   si->engine_snapshot_mode = getStringCopy(STR_SNAPSHOT_MODE_DEFAULT);
8342   si->engine_snapshot_memory = SNAPSHOT_MEMORY_DEFAULT;
8343   si->fade_screens = TRUE;
8344   si->autorecord = TRUE;
8345   si->show_titlescreen = TRUE;
8346   si->quick_doors = FALSE;
8347   si->team_mode = FALSE;
8348   si->handicap = TRUE;
8349   si->skip_levels = TRUE;
8350   si->increment_levels = TRUE;
8351   si->time_limit = TRUE;
8352   si->fullscreen = FALSE;
8353   si->window_scaling_percent = STD_WINDOW_SCALING_PERCENT;
8354   si->window_scaling_quality = getStringCopy(SCALING_QUALITY_DEFAULT);
8355   si->screen_rendering_mode = getStringCopy(STR_SPECIAL_RENDERING_DEFAULT);
8356   si->ask_on_escape = TRUE;
8357   si->ask_on_escape_editor = TRUE;
8358   si->quick_switch = FALSE;
8359   si->input_on_focus = FALSE;
8360   si->prefer_aga_graphics = TRUE;
8361   si->game_frame_delay = GAME_FRAME_DELAY;
8362   si->sp_show_border_elements = FALSE;
8363   si->small_game_graphics = FALSE;
8364   si->show_snapshot_buttons = FALSE;
8365
8366   si->graphics_set = getStringCopy(GFX_CLASSIC_SUBDIR);
8367   si->sounds_set   = getStringCopy(SND_CLASSIC_SUBDIR);
8368   si->music_set    = getStringCopy(MUS_CLASSIC_SUBDIR);
8369
8370   si->override_level_graphics = FALSE;
8371   si->override_level_sounds = FALSE;
8372   si->override_level_music = FALSE;
8373
8374   si->volume_simple = 100;              /* percent */
8375   si->volume_loops = 100;               /* percent */
8376   si->volume_music = 100;               /* percent */
8377
8378   si->touch.control_type = getStringCopy(TOUCH_CONTROL_DEFAULT);
8379   si->touch.move_distance = TOUCH_MOVE_DISTANCE_DEFAULT;        /* percent */
8380   si->touch.drop_distance = TOUCH_DROP_DISTANCE_DEFAULT;        /* percent */
8381
8382   si->editor.el_boulderdash             = TRUE;
8383   si->editor.el_emerald_mine            = TRUE;
8384   si->editor.el_emerald_mine_club       = TRUE;
8385   si->editor.el_more                    = TRUE;
8386   si->editor.el_sokoban                 = TRUE;
8387   si->editor.el_supaplex                = TRUE;
8388   si->editor.el_diamond_caves           = TRUE;
8389   si->editor.el_dx_boulderdash          = TRUE;
8390   si->editor.el_chars                   = TRUE;
8391   si->editor.el_steel_chars             = TRUE;
8392
8393   si->editor.el_classic                 = TRUE;
8394   si->editor.el_custom                  = TRUE;
8395
8396   si->editor.el_user_defined            = FALSE;
8397   si->editor.el_dynamic                 = TRUE;
8398
8399   si->editor.el_headlines               = TRUE;
8400
8401   si->editor.show_element_token         = FALSE;
8402
8403   si->editor.use_template_for_new_levels = TRUE;
8404
8405   si->shortcut.save_game        = DEFAULT_KEY_SAVE_GAME;
8406   si->shortcut.load_game        = DEFAULT_KEY_LOAD_GAME;
8407   si->shortcut.toggle_pause     = DEFAULT_KEY_TOGGLE_PAUSE;
8408
8409   si->shortcut.focus_player[0]  = DEFAULT_KEY_FOCUS_PLAYER_1;
8410   si->shortcut.focus_player[1]  = DEFAULT_KEY_FOCUS_PLAYER_2;
8411   si->shortcut.focus_player[2]  = DEFAULT_KEY_FOCUS_PLAYER_3;
8412   si->shortcut.focus_player[3]  = DEFAULT_KEY_FOCUS_PLAYER_4;
8413   si->shortcut.focus_player_all = DEFAULT_KEY_FOCUS_PLAYER_ALL;
8414
8415   si->shortcut.tape_eject       = DEFAULT_KEY_TAPE_EJECT;
8416   si->shortcut.tape_extra       = DEFAULT_KEY_TAPE_EXTRA;
8417   si->shortcut.tape_stop        = DEFAULT_KEY_TAPE_STOP;
8418   si->shortcut.tape_pause       = DEFAULT_KEY_TAPE_PAUSE;
8419   si->shortcut.tape_record      = DEFAULT_KEY_TAPE_RECORD;
8420   si->shortcut.tape_play        = DEFAULT_KEY_TAPE_PLAY;
8421
8422   si->shortcut.sound_simple     = DEFAULT_KEY_SOUND_SIMPLE;
8423   si->shortcut.sound_loops      = DEFAULT_KEY_SOUND_LOOPS;
8424   si->shortcut.sound_music      = DEFAULT_KEY_SOUND_MUSIC;
8425
8426   si->shortcut.snap_left        = DEFAULT_KEY_SNAP_LEFT;
8427   si->shortcut.snap_right       = DEFAULT_KEY_SNAP_RIGHT;
8428   si->shortcut.snap_up          = DEFAULT_KEY_SNAP_UP;
8429   si->shortcut.snap_down        = DEFAULT_KEY_SNAP_DOWN;
8430
8431   for (i = 0; i < MAX_PLAYERS; i++)
8432   {
8433     si->input[i].use_joystick = FALSE;
8434     si->input[i].joy.device_name=getStringCopy(getDeviceNameFromJoystickNr(i));
8435     si->input[i].joy.xleft   = JOYSTICK_XLEFT;
8436     si->input[i].joy.xmiddle = JOYSTICK_XMIDDLE;
8437     si->input[i].joy.xright  = JOYSTICK_XRIGHT;
8438     si->input[i].joy.yupper  = JOYSTICK_YUPPER;
8439     si->input[i].joy.ymiddle = JOYSTICK_YMIDDLE;
8440     si->input[i].joy.ylower  = JOYSTICK_YLOWER;
8441     si->input[i].joy.snap  = (i == 0 ? JOY_BUTTON_1 : 0);
8442     si->input[i].joy.drop  = (i == 0 ? JOY_BUTTON_2 : 0);
8443     si->input[i].key.left  = (i == 0 ? DEFAULT_KEY_LEFT  : KSYM_UNDEFINED);
8444     si->input[i].key.right = (i == 0 ? DEFAULT_KEY_RIGHT : KSYM_UNDEFINED);
8445     si->input[i].key.up    = (i == 0 ? DEFAULT_KEY_UP    : KSYM_UNDEFINED);
8446     si->input[i].key.down  = (i == 0 ? DEFAULT_KEY_DOWN  : KSYM_UNDEFINED);
8447     si->input[i].key.snap  = (i == 0 ? DEFAULT_KEY_SNAP  : KSYM_UNDEFINED);
8448     si->input[i].key.drop  = (i == 0 ? DEFAULT_KEY_DROP  : KSYM_UNDEFINED);
8449   }
8450
8451   si->system.sdl_videodriver = getStringCopy(ARG_DEFAULT);
8452   si->system.sdl_audiodriver = getStringCopy(ARG_DEFAULT);
8453   si->system.audio_fragment_size = DEFAULT_AUDIO_FRAGMENT_SIZE;
8454
8455   si->internal.program_title     = getStringCopy(PROGRAM_TITLE_STRING);
8456   si->internal.program_version   = getStringCopy(getProgramRealVersionString());
8457   si->internal.program_author    = getStringCopy(PROGRAM_AUTHOR_STRING);
8458   si->internal.program_email     = getStringCopy(PROGRAM_EMAIL_STRING);
8459   si->internal.program_website   = getStringCopy(PROGRAM_WEBSITE_STRING);
8460   si->internal.program_copyright = getStringCopy(PROGRAM_COPYRIGHT_STRING);
8461   si->internal.program_company   = getStringCopy(PROGRAM_COMPANY_STRING);
8462
8463   si->internal.program_icon_file = getStringCopy(PROGRAM_ICON_FILENAME);
8464
8465   si->internal.default_graphics_set = getStringCopy(GFX_CLASSIC_SUBDIR);
8466   si->internal.default_sounds_set   = getStringCopy(SND_CLASSIC_SUBDIR);
8467   si->internal.default_music_set    = getStringCopy(MUS_CLASSIC_SUBDIR);
8468
8469   si->internal.fallback_graphics_file = getStringCopy(UNDEFINED_FILENAME);
8470   si->internal.fallback_sounds_file   = getStringCopy(UNDEFINED_FILENAME);
8471   si->internal.fallback_music_file    = getStringCopy(UNDEFINED_FILENAME);
8472
8473   si->internal.default_level_series = getStringCopy(UNDEFINED_LEVELSET);
8474   si->internal.choose_from_top_leveldir = FALSE;
8475   si->internal.show_scaling_in_title = TRUE;
8476
8477   si->internal.default_window_width  = WIN_XSIZE_DEFAULT;
8478   si->internal.default_window_height = WIN_YSIZE_DEFAULT;
8479
8480   si->debug.frame_delay[0] = DEFAULT_FRAME_DELAY_0;
8481   si->debug.frame_delay[1] = DEFAULT_FRAME_DELAY_1;
8482   si->debug.frame_delay[2] = DEFAULT_FRAME_DELAY_2;
8483   si->debug.frame_delay[3] = DEFAULT_FRAME_DELAY_3;
8484   si->debug.frame_delay[4] = DEFAULT_FRAME_DELAY_4;
8485   si->debug.frame_delay[5] = DEFAULT_FRAME_DELAY_5;
8486   si->debug.frame_delay[6] = DEFAULT_FRAME_DELAY_6;
8487   si->debug.frame_delay[7] = DEFAULT_FRAME_DELAY_7;
8488   si->debug.frame_delay[8] = DEFAULT_FRAME_DELAY_8;
8489   si->debug.frame_delay[9] = DEFAULT_FRAME_DELAY_9;
8490
8491   si->debug.frame_delay_key[0] = DEFAULT_KEY_FRAME_DELAY_0;
8492   si->debug.frame_delay_key[1] = DEFAULT_KEY_FRAME_DELAY_1;
8493   si->debug.frame_delay_key[2] = DEFAULT_KEY_FRAME_DELAY_2;
8494   si->debug.frame_delay_key[3] = DEFAULT_KEY_FRAME_DELAY_3;
8495   si->debug.frame_delay_key[4] = DEFAULT_KEY_FRAME_DELAY_4;
8496   si->debug.frame_delay_key[5] = DEFAULT_KEY_FRAME_DELAY_5;
8497   si->debug.frame_delay_key[6] = DEFAULT_KEY_FRAME_DELAY_6;
8498   si->debug.frame_delay_key[7] = DEFAULT_KEY_FRAME_DELAY_7;
8499   si->debug.frame_delay_key[8] = DEFAULT_KEY_FRAME_DELAY_8;
8500   si->debug.frame_delay_key[9] = DEFAULT_KEY_FRAME_DELAY_9;
8501
8502   si->debug.frame_delay_use_mod_key = DEFAULT_FRAME_DELAY_USE_MOD_KEY;
8503   si->debug.frame_delay_game_only   = DEFAULT_FRAME_DELAY_GAME_ONLY;
8504
8505   si->debug.show_frames_per_second = FALSE;
8506
8507   si->options.verbose = FALSE;
8508
8509 #if defined(PLATFORM_ANDROID)
8510   si->fullscreen = TRUE;
8511 #endif
8512 }
8513
8514 static void setSetupInfoToDefaults_EditorCascade(struct SetupInfo *si)
8515 {
8516   si->editor_cascade.el_bd              = TRUE;
8517   si->editor_cascade.el_em              = TRUE;
8518   si->editor_cascade.el_emc             = TRUE;
8519   si->editor_cascade.el_rnd             = TRUE;
8520   si->editor_cascade.el_sb              = TRUE;
8521   si->editor_cascade.el_sp              = TRUE;
8522   si->editor_cascade.el_dc              = TRUE;
8523   si->editor_cascade.el_dx              = TRUE;
8524
8525   si->editor_cascade.el_chars           = FALSE;
8526   si->editor_cascade.el_steel_chars     = FALSE;
8527   si->editor_cascade.el_ce              = FALSE;
8528   si->editor_cascade.el_ge              = FALSE;
8529   si->editor_cascade.el_ref             = FALSE;
8530   si->editor_cascade.el_user            = FALSE;
8531   si->editor_cascade.el_dynamic         = FALSE;
8532 }
8533
8534 #define MAX_HIDE_SETUP_TOKEN_SIZE               20
8535
8536 static char *getHideSetupToken(void *setup_value)
8537 {
8538   static char hide_setup_token[MAX_HIDE_SETUP_TOKEN_SIZE];
8539
8540   if (setup_value != NULL)
8541     snprintf(hide_setup_token, MAX_HIDE_SETUP_TOKEN_SIZE, "%p", setup_value);
8542
8543   return hide_setup_token;
8544 }
8545
8546 static void setHideSetupEntry(void *setup_value_raw)
8547 {
8548   /* !!! DIRTY WORKAROUND; TO BE FIXED AFTER THE MM ENGINE RELEASE !!! */
8549   void *setup_value = setup_value_raw - (void *)&si + (void *)&setup;
8550
8551   char *hide_setup_token = getHideSetupToken(setup_value);
8552
8553   if (setup_value != NULL)
8554     setHashEntry(hide_setup_hash, hide_setup_token, "");
8555 }
8556
8557 boolean hideSetupEntry(void *setup_value)
8558 {
8559   char *hide_setup_token = getHideSetupToken(setup_value);
8560
8561   return (setup_value != NULL &&
8562           getHashEntry(hide_setup_hash, hide_setup_token) != NULL);
8563 }
8564
8565 static void setSetupInfoFromTokenText(SetupFileHash *setup_file_hash,
8566                                       struct TokenInfo *token_info,
8567                                       int token_nr, char *token_text)
8568 {
8569   char *token_hide_text = getStringCat2(token_text, ".hide");
8570   char *token_hide_value = getHashEntry(setup_file_hash, token_hide_text);
8571
8572   /* set the value of this setup option in the setup option structure */
8573   setSetupInfo(token_info, token_nr, getHashEntry(setup_file_hash, token_text));
8574
8575   /* check if this setup option should be hidden in the setup menu */
8576   if (token_hide_value != NULL && get_boolean_from_string(token_hide_value))
8577     setHideSetupEntry(token_info[token_nr].value);
8578 }
8579
8580 static void setSetupInfoFromTokenInfo(SetupFileHash *setup_file_hash,
8581                                       struct TokenInfo *token_info,
8582                                       int token_nr)
8583 {
8584   setSetupInfoFromTokenText(setup_file_hash, token_info, token_nr,
8585                             token_info[token_nr].text);
8586 }
8587
8588 static void decodeSetupFileHash(SetupFileHash *setup_file_hash)
8589 {
8590   int i, pnr;
8591
8592   if (!setup_file_hash)
8593     return;
8594
8595   if (hide_setup_hash == NULL)
8596     hide_setup_hash = newSetupFileHash();
8597
8598   /* global setup */
8599   si = setup;
8600   for (i = 0; i < NUM_GLOBAL_SETUP_TOKENS; i++)
8601     setSetupInfoFromTokenInfo(setup_file_hash, global_setup_tokens, i);
8602   setup = si;
8603
8604   /* editor setup */
8605   sei = setup.editor;
8606   for (i = 0; i < NUM_EDITOR_SETUP_TOKENS; i++)
8607     setSetupInfoFromTokenInfo(setup_file_hash, editor_setup_tokens, i);
8608   setup.editor = sei;
8609
8610   /* shortcut setup */
8611   ssi = setup.shortcut;
8612   for (i = 0; i < NUM_SHORTCUT_SETUP_TOKENS; i++)
8613     setSetupInfoFromTokenInfo(setup_file_hash, shortcut_setup_tokens, i);
8614   setup.shortcut = ssi;
8615
8616   /* player setup */
8617   for (pnr = 0; pnr < MAX_PLAYERS; pnr++)
8618   {
8619     char prefix[30];
8620
8621     sprintf(prefix, "%s%d", TOKEN_STR_PLAYER_PREFIX, pnr + 1);
8622
8623     sii = setup.input[pnr];
8624     for (i = 0; i < NUM_PLAYER_SETUP_TOKENS; i++)
8625     {
8626       char full_token[100];
8627
8628       sprintf(full_token, "%s%s", prefix, player_setup_tokens[i].text);
8629       setSetupInfoFromTokenText(setup_file_hash, player_setup_tokens, i,
8630                                 full_token);
8631     }
8632     setup.input[pnr] = sii;
8633   }
8634
8635   /* system setup */
8636   syi = setup.system;
8637   for (i = 0; i < NUM_SYSTEM_SETUP_TOKENS; i++)
8638     setSetupInfoFromTokenInfo(setup_file_hash, system_setup_tokens, i);
8639   setup.system = syi;
8640
8641   /* internal setup */
8642   sxi = setup.internal;
8643   for (i = 0; i < NUM_INTERNAL_SETUP_TOKENS; i++)
8644     setSetupInfoFromTokenInfo(setup_file_hash, internal_setup_tokens, i);
8645   setup.internal = sxi;
8646
8647   /* debug setup */
8648   sdi = setup.debug;
8649   for (i = 0; i < NUM_DEBUG_SETUP_TOKENS; i++)
8650     setSetupInfoFromTokenInfo(setup_file_hash, debug_setup_tokens, i);
8651   setup.debug = sdi;
8652
8653   /* options setup */
8654   soi = setup.options;
8655   for (i = 0; i < NUM_OPTIONS_SETUP_TOKENS; i++)
8656     setSetupInfoFromTokenInfo(setup_file_hash, options_setup_tokens, i);
8657   setup.options = soi;
8658 }
8659
8660 static void decodeSetupFileHash_EditorCascade(SetupFileHash *setup_file_hash)
8661 {
8662   int i;
8663
8664   if (!setup_file_hash)
8665     return;
8666
8667   /* editor cascade setup */
8668   seci = setup.editor_cascade;
8669   for (i = 0; i < NUM_EDITOR_CASCADE_SETUP_TOKENS; i++)
8670     setSetupInfo(editor_cascade_setup_tokens, i,
8671                  getHashEntry(setup_file_hash,
8672                               editor_cascade_setup_tokens[i].text));
8673   setup.editor_cascade = seci;
8674 }
8675
8676 void LoadSetupFromFilename(char *filename)
8677 {
8678   SetupFileHash *setup_file_hash = loadSetupFileHash(filename);
8679
8680   if (setup_file_hash)
8681   {
8682     decodeSetupFileHash(setup_file_hash);
8683
8684     freeSetupFileHash(setup_file_hash);
8685   }
8686   else
8687   {
8688     Error(ERR_DEBUG, "using default setup values");
8689   }
8690 }
8691
8692 static void LoadSetup_SpecialPostProcessing()
8693 {
8694   char *player_name_new;
8695
8696   /* needed to work around problems with fixed length strings */
8697   player_name_new = get_corrected_login_name(setup.player_name);
8698   free(setup.player_name);
8699   setup.player_name = player_name_new;
8700
8701   /* "scroll_delay: on(3) / off(0)" was replaced by scroll delay value */
8702   if (setup.scroll_delay == FALSE)
8703   {
8704     setup.scroll_delay_value = MIN_SCROLL_DELAY;
8705     setup.scroll_delay = TRUE;                  /* now always "on" */
8706   }
8707
8708   /* make sure that scroll delay value stays inside valid range */
8709   setup.scroll_delay_value =
8710     MIN(MAX(MIN_SCROLL_DELAY, setup.scroll_delay_value), MAX_SCROLL_DELAY);
8711 }
8712
8713 void LoadSetup()
8714 {
8715   char *filename;
8716
8717   /* always start with reliable default values */
8718   setSetupInfoToDefaults(&setup);
8719
8720   /* try to load setup values from default setup file */
8721   filename = getDefaultSetupFilename();
8722
8723   if (fileExists(filename))
8724     LoadSetupFromFilename(filename);
8725
8726   /* try to load setup values from user setup file */
8727   filename = getSetupFilename();
8728
8729   LoadSetupFromFilename(filename);
8730
8731   LoadSetup_SpecialPostProcessing();
8732 }
8733
8734 void LoadSetup_EditorCascade()
8735 {
8736   char *filename = getPath2(getSetupDir(), EDITORCASCADE_FILENAME);
8737   SetupFileHash *setup_file_hash = NULL;
8738
8739   /* always start with reliable default values */
8740   setSetupInfoToDefaults_EditorCascade(&setup);
8741
8742   setup_file_hash = loadSetupFileHash(filename);
8743
8744   if (setup_file_hash)
8745   {
8746     decodeSetupFileHash_EditorCascade(setup_file_hash);
8747
8748     freeSetupFileHash(setup_file_hash);
8749   }
8750
8751   free(filename);
8752 }
8753
8754 static void addGameControllerMappingToHash(SetupFileHash *mappings_hash,
8755                                            char *mapping_line)
8756 {
8757   char mapping_guid[MAX_LINE_LEN];
8758   char *mapping_start, *mapping_end;
8759
8760   // get GUID from game controller mapping line: copy complete line
8761   strncpy(mapping_guid, mapping_line, MAX_LINE_LEN - 1);
8762   mapping_guid[MAX_LINE_LEN - 1] = '\0';
8763
8764   // get GUID from game controller mapping line: cut after GUID part
8765   mapping_start = strchr(mapping_guid, ',');
8766   if (mapping_start != NULL)
8767     *mapping_start = '\0';
8768
8769   // cut newline from game controller mapping line
8770   mapping_end = strchr(mapping_line, '\n');
8771   if (mapping_end != NULL)
8772     *mapping_end = '\0';
8773
8774   // add mapping entry to game controller mappings hash
8775   setHashEntry(mappings_hash, mapping_guid, mapping_line);
8776 }
8777
8778 static void LoadSetup_ReadGameControllerMappings(SetupFileHash *mappings_hash,
8779                                                  char *filename)
8780 {
8781   FILE *file;
8782
8783   if (!(file = fopen(filename, MODE_READ)))
8784   {
8785     Error(ERR_WARN, "cannot read game controller mappings file '%s'", filename);
8786
8787     return;
8788   }
8789
8790   while (!feof(file))
8791   {
8792     char line[MAX_LINE_LEN];
8793
8794     if (!fgets(line, MAX_LINE_LEN, file))
8795       break;
8796
8797     addGameControllerMappingToHash(mappings_hash, line);
8798   }
8799
8800   fclose(file);
8801 }
8802
8803 void SaveSetup()
8804 {
8805   char *filename = getSetupFilename();
8806   FILE *file;
8807   int i, pnr;
8808
8809   InitUserDataDirectory();
8810
8811   if (!(file = fopen(filename, MODE_WRITE)))
8812   {
8813     Error(ERR_WARN, "cannot write setup file '%s'", filename);
8814     return;
8815   }
8816
8817   fprintFileHeader(file, SETUP_FILENAME);
8818
8819   /* global setup */
8820   si = setup;
8821   for (i = 0; i < NUM_GLOBAL_SETUP_TOKENS; i++)
8822   {
8823     /* just to make things nicer :) */
8824     if (i == SETUP_TOKEN_PLAYER_NAME + 1 ||
8825         i == SETUP_TOKEN_GRAPHICS_SET ||
8826         i == SETUP_TOKEN_VOLUME_SIMPLE ||
8827         i == SETUP_TOKEN_TOUCH_CONTROL_TYPE)
8828       fprintf(file, "\n");
8829
8830     fprintf(file, "%s\n", getSetupLine(global_setup_tokens, "", i));
8831   }
8832
8833   /* editor setup */
8834   sei = setup.editor;
8835   fprintf(file, "\n");
8836   for (i = 0; i < NUM_EDITOR_SETUP_TOKENS; i++)
8837     fprintf(file, "%s\n", getSetupLine(editor_setup_tokens, "", i));
8838
8839   /* shortcut setup */
8840   ssi = setup.shortcut;
8841   fprintf(file, "\n");
8842   for (i = 0; i < NUM_SHORTCUT_SETUP_TOKENS; i++)
8843     fprintf(file, "%s\n", getSetupLine(shortcut_setup_tokens, "", i));
8844
8845   /* player setup */
8846   for (pnr = 0; pnr < MAX_PLAYERS; pnr++)
8847   {
8848     char prefix[30];
8849
8850     sprintf(prefix, "%s%d", TOKEN_STR_PLAYER_PREFIX, pnr + 1);
8851     fprintf(file, "\n");
8852
8853     sii = setup.input[pnr];
8854     for (i = 0; i < NUM_PLAYER_SETUP_TOKENS; i++)
8855       fprintf(file, "%s\n", getSetupLine(player_setup_tokens, prefix, i));
8856   }
8857
8858   /* system setup */
8859   syi = setup.system;
8860   fprintf(file, "\n");
8861   for (i = 0; i < NUM_SYSTEM_SETUP_TOKENS; i++)
8862     fprintf(file, "%s\n", getSetupLine(system_setup_tokens, "", i));
8863
8864   /* internal setup */
8865   /* (internal setup values not saved to user setup file) */
8866
8867   /* debug setup */
8868   sdi = setup.debug;
8869   fprintf(file, "\n");
8870   for (i = 0; i < NUM_DEBUG_SETUP_TOKENS; i++)
8871     fprintf(file, "%s\n", getSetupLine(debug_setup_tokens, "", i));
8872
8873   /* options setup */
8874   soi = setup.options;
8875   fprintf(file, "\n");
8876   for (i = 0; i < NUM_OPTIONS_SETUP_TOKENS; i++)
8877     fprintf(file, "%s\n", getSetupLine(options_setup_tokens, "", i));
8878
8879   fclose(file);
8880
8881   SetFilePermissions(filename, PERMS_PRIVATE);
8882 }
8883
8884 void SaveSetup_EditorCascade()
8885 {
8886   char *filename = getPath2(getSetupDir(), EDITORCASCADE_FILENAME);
8887   FILE *file;
8888   int i;
8889
8890   InitUserDataDirectory();
8891
8892   if (!(file = fopen(filename, MODE_WRITE)))
8893   {
8894     Error(ERR_WARN, "cannot write editor cascade state file '%s'", filename);
8895     free(filename);
8896     return;
8897   }
8898
8899   fprintFileHeader(file, EDITORCASCADE_FILENAME);
8900
8901   seci = setup.editor_cascade;
8902   for (i = 0; i < NUM_EDITOR_CASCADE_SETUP_TOKENS; i++)
8903     fprintf(file, "%s\n", getSetupLine(editor_cascade_setup_tokens, "", i));
8904
8905   fclose(file);
8906
8907   SetFilePermissions(filename, PERMS_PRIVATE);
8908
8909   free(filename);
8910 }
8911
8912 static void SaveSetup_WriteGameControllerMappings(SetupFileHash *mappings_hash,
8913                                                   char *filename)
8914 {
8915   FILE *file;
8916
8917   if (!(file = fopen(filename, MODE_WRITE)))
8918   {
8919     Error(ERR_WARN, "cannot write game controller mappings file '%s'",filename);
8920
8921     return;
8922   }
8923
8924   BEGIN_HASH_ITERATION(mappings_hash, itr)
8925   {
8926     fprintf(file, "%s\n", HASH_ITERATION_VALUE(itr));
8927   }
8928   END_HASH_ITERATION(mappings_hash, itr)
8929
8930   fclose(file);
8931 }
8932
8933 void SaveSetup_AddGameControllerMapping(char *mapping)
8934 {
8935   char *filename = getPath2(getSetupDir(), GAMECONTROLLER_BASENAME);
8936   SetupFileHash *mappings_hash = newSetupFileHash();
8937
8938   InitUserDataDirectory();
8939
8940   // load existing personal game controller mappings
8941   LoadSetup_ReadGameControllerMappings(mappings_hash, filename);
8942
8943   // add new mapping to personal game controller mappings
8944   addGameControllerMappingToHash(mappings_hash, mapping);
8945
8946   // save updated personal game controller mappings
8947   SaveSetup_WriteGameControllerMappings(mappings_hash, filename);
8948
8949   freeSetupFileHash(mappings_hash);
8950   free(filename);
8951 }
8952
8953 void LoadCustomElementDescriptions()
8954 {
8955   char *filename = getCustomArtworkConfigFilename(ARTWORK_TYPE_GRAPHICS);
8956   SetupFileHash *setup_file_hash;
8957   int i;
8958
8959   for (i = 0; i < NUM_FILE_ELEMENTS; i++)
8960   {
8961     if (element_info[i].custom_description != NULL)
8962     {
8963       free(element_info[i].custom_description);
8964       element_info[i].custom_description = NULL;
8965     }
8966   }
8967
8968   if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
8969     return;
8970
8971   for (i = 0; i < NUM_FILE_ELEMENTS; i++)
8972   {
8973     char *token = getStringCat2(element_info[i].token_name, ".name");
8974     char *value = getHashEntry(setup_file_hash, token);
8975
8976     if (value != NULL)
8977       element_info[i].custom_description = getStringCopy(value);
8978
8979     free(token);
8980   }
8981
8982   freeSetupFileHash(setup_file_hash);
8983 }
8984
8985 static int getElementFromToken(char *token)
8986 {
8987   char *value = getHashEntry(element_token_hash, token);
8988
8989   if (value != NULL)
8990     return atoi(value);
8991
8992   Error(ERR_WARN, "unknown element token '%s'", token);
8993
8994   return EL_UNDEFINED;
8995 }
8996
8997 static int get_token_parameter_value(char *token, char *value_raw)
8998 {
8999   char *suffix;
9000
9001   if (token == NULL || value_raw == NULL)
9002     return ARG_UNDEFINED_VALUE;
9003
9004   suffix = strrchr(token, '.');
9005   if (suffix == NULL)
9006     suffix = token;
9007
9008   if (strEqual(suffix, ".element"))
9009     return getElementFromToken(value_raw);
9010
9011   /* !!! USE CORRECT VALUE TYPE (currently works also for TYPE_BOOLEAN) !!! */
9012   return get_parameter_value(value_raw, suffix, TYPE_INTEGER);
9013 }
9014
9015 void InitMenuDesignSettings_Static()
9016 {
9017   int i;
9018
9019   /* always start with reliable default values from static default config */
9020   for (i = 0; image_config_vars[i].token != NULL; i++)
9021   {
9022     char *value = getHashEntry(image_config_hash, image_config_vars[i].token);
9023
9024     if (value != NULL)
9025       *image_config_vars[i].value =
9026         get_token_parameter_value(image_config_vars[i].token, value);
9027   }
9028 }
9029
9030 static void InitMenuDesignSettings_SpecialPreProcessing()
9031 {
9032   int i;
9033
9034   /* the following initializes hierarchical values from static configuration */
9035
9036   /* special case: initialize "ARG_DEFAULT" values in static default config */
9037   /* (e.g., initialize "[titlemessage].fade_mode" from "[title].fade_mode") */
9038   titlescreen_initial_first_default.fade_mode  =
9039     title_initial_first_default.fade_mode;
9040   titlescreen_initial_first_default.fade_delay =
9041     title_initial_first_default.fade_delay;
9042   titlescreen_initial_first_default.post_delay =
9043     title_initial_first_default.post_delay;
9044   titlescreen_initial_first_default.auto_delay =
9045     title_initial_first_default.auto_delay;
9046   titlescreen_first_default.fade_mode  = title_first_default.fade_mode;
9047   titlescreen_first_default.fade_delay = title_first_default.fade_delay;
9048   titlescreen_first_default.post_delay = title_first_default.post_delay;
9049   titlescreen_first_default.auto_delay = title_first_default.auto_delay;
9050   titlemessage_initial_first_default.fade_mode  =
9051     title_initial_first_default.fade_mode;
9052   titlemessage_initial_first_default.fade_delay =
9053     title_initial_first_default.fade_delay;
9054   titlemessage_initial_first_default.post_delay =
9055     title_initial_first_default.post_delay;
9056   titlemessage_initial_first_default.auto_delay =
9057     title_initial_first_default.auto_delay;
9058   titlemessage_first_default.fade_mode  = title_first_default.fade_mode;
9059   titlemessage_first_default.fade_delay = title_first_default.fade_delay;
9060   titlemessage_first_default.post_delay = title_first_default.post_delay;
9061   titlemessage_first_default.auto_delay = title_first_default.auto_delay;
9062
9063   titlescreen_initial_default.fade_mode  = title_initial_default.fade_mode;
9064   titlescreen_initial_default.fade_delay = title_initial_default.fade_delay;
9065   titlescreen_initial_default.post_delay = title_initial_default.post_delay;
9066   titlescreen_initial_default.auto_delay = title_initial_default.auto_delay;
9067   titlescreen_default.fade_mode  = title_default.fade_mode;
9068   titlescreen_default.fade_delay = title_default.fade_delay;
9069   titlescreen_default.post_delay = title_default.post_delay;
9070   titlescreen_default.auto_delay = title_default.auto_delay;
9071   titlemessage_initial_default.fade_mode  = title_initial_default.fade_mode;
9072   titlemessage_initial_default.fade_delay = title_initial_default.fade_delay;
9073   titlemessage_initial_default.post_delay = title_initial_default.post_delay;
9074   titlemessage_initial_default.auto_delay = title_initial_default.auto_delay;
9075   titlemessage_default.fade_mode  = title_default.fade_mode;
9076   titlemessage_default.fade_delay = title_default.fade_delay;
9077   titlemessage_default.post_delay = title_default.post_delay;
9078   titlemessage_default.auto_delay = title_default.auto_delay;
9079
9080   /* special case: initialize "ARG_DEFAULT" values in static default config */
9081   /* (e.g., init "titlemessage_1.fade_mode" from "[titlemessage].fade_mode") */
9082   for (i = 0; i < MAX_NUM_TITLE_MESSAGES; i++)
9083   {
9084     titlescreen_initial_first[i] = titlescreen_initial_first_default;
9085     titlescreen_first[i] = titlescreen_first_default;
9086     titlemessage_initial_first[i] = titlemessage_initial_first_default;
9087     titlemessage_first[i] = titlemessage_first_default;
9088
9089     titlescreen_initial[i] = titlescreen_initial_default;
9090     titlescreen[i] = titlescreen_default;
9091     titlemessage_initial[i] = titlemessage_initial_default;
9092     titlemessage[i] = titlemessage_default;
9093   }
9094
9095   /* special case: initialize "ARG_DEFAULT" values in static default config */
9096   /* (eg, init "menu.enter_screen.SCORES.xyz" from "menu.enter_screen.xyz") */
9097   for (i = 0; i < NUM_SPECIAL_GFX_ARGS; i++)
9098   {
9099     if (i == GFX_SPECIAL_ARG_TITLE)     /* title values already initialized */
9100       continue;
9101
9102     menu.enter_screen[i] = menu.enter_screen[GFX_SPECIAL_ARG_DEFAULT];
9103     menu.leave_screen[i] = menu.leave_screen[GFX_SPECIAL_ARG_DEFAULT];
9104     menu.next_screen[i]  = menu.next_screen[GFX_SPECIAL_ARG_DEFAULT];
9105   }
9106
9107   /* special case: initialize "ARG_DEFAULT" values in static default config */
9108   /* (eg, init "viewport.door_1.MAIN.xyz" from "viewport.door_1.xyz") */
9109   for (i = 0; i < NUM_SPECIAL_GFX_ARGS; i++)
9110   {
9111     viewport.window[i]    = viewport.window[GFX_SPECIAL_ARG_DEFAULT];
9112     viewport.playfield[i] = viewport.playfield[GFX_SPECIAL_ARG_DEFAULT];
9113     viewport.door_1[i]    = viewport.door_1[GFX_SPECIAL_ARG_DEFAULT];
9114
9115     if (i == GFX_SPECIAL_ARG_EDITOR)    /* editor values already initialized */
9116       continue;
9117
9118     viewport.door_2[i] = viewport.door_2[GFX_SPECIAL_ARG_DEFAULT];
9119   }
9120 }
9121
9122 static void InitMenuDesignSettings_SpecialPostProcessing()
9123 {
9124   static struct
9125   {
9126     struct XY *dst, *src;
9127   }
9128   game_buttons_xy[] =
9129   {
9130     { &game.button.save,        &game.button.stop       },
9131     { &game.button.pause2,      &game.button.pause      },
9132     { &game.button.load,        &game.button.play       },
9133     { &game.button.undo,        &game.button.stop       },
9134     { &game.button.redo,        &game.button.play       },
9135
9136     { NULL,                     NULL                    }
9137   };
9138   int i;
9139
9140   /* special case: initialize later added SETUP list size from LEVELS value */
9141   if (menu.list_size[GAME_MODE_SETUP] == -1)
9142     menu.list_size[GAME_MODE_SETUP] = menu.list_size[GAME_MODE_LEVELS];
9143
9144   /* set default position for snapshot buttons to stop/pause/play buttons */
9145   for (i = 0; game_buttons_xy[i].dst != NULL; i++)
9146     if ((*game_buttons_xy[i].dst).x == -1 &&
9147         (*game_buttons_xy[i].dst).y == -1)
9148       *game_buttons_xy[i].dst = *game_buttons_xy[i].src;
9149 }
9150
9151 static void InitMenuDesignSettings_SpecialPostProcessing_AfterGraphics()
9152 {
9153   static struct
9154   {
9155     struct XYTileSize *dst, *src;
9156     int graphic;
9157   }
9158   editor_buttons_xy[] =
9159   {
9160     {
9161       &editor.button.element_left,      &editor.palette.element_left,
9162       IMG_GFX_EDITOR_BUTTON_ELEMENT_LEFT
9163     },
9164     {
9165       &editor.button.element_middle,    &editor.palette.element_middle,
9166       IMG_GFX_EDITOR_BUTTON_ELEMENT_MIDDLE
9167     },
9168     {
9169       &editor.button.element_right,     &editor.palette.element_right,
9170       IMG_GFX_EDITOR_BUTTON_ELEMENT_RIGHT
9171     },
9172
9173     { NULL,                     NULL                    }
9174   };
9175   int i;
9176
9177   /* set default position for element buttons to element graphics */
9178   for (i = 0; editor_buttons_xy[i].dst != NULL; i++)
9179   {
9180     if ((*editor_buttons_xy[i].dst).x == -1 &&
9181         (*editor_buttons_xy[i].dst).y == -1)
9182     {
9183       struct GraphicInfo *gd = &graphic_info[editor_buttons_xy[i].graphic];
9184
9185       gd->width = gd->height = editor_buttons_xy[i].src->tile_size;
9186
9187       *editor_buttons_xy[i].dst = *editor_buttons_xy[i].src;
9188     }
9189   }
9190 }
9191
9192 static void LoadMenuDesignSettingsFromFilename(char *filename)
9193 {
9194   static struct TitleFadingInfo tfi;
9195   static struct TitleMessageInfo tmi;
9196   static struct TokenInfo title_tokens[] =
9197   {
9198     { TYPE_INTEGER,     &tfi.fade_mode,         ".fade_mode"            },
9199     { TYPE_INTEGER,     &tfi.fade_delay,        ".fade_delay"           },
9200     { TYPE_INTEGER,     &tfi.post_delay,        ".post_delay"           },
9201     { TYPE_INTEGER,     &tfi.auto_delay,        ".auto_delay"           },
9202
9203     { -1,               NULL,                   NULL                    }
9204   };
9205   static struct TokenInfo titlemessage_tokens[] =
9206   {
9207     { TYPE_INTEGER,     &tmi.x,                 ".x"                    },
9208     { TYPE_INTEGER,     &tmi.y,                 ".y"                    },
9209     { TYPE_INTEGER,     &tmi.width,             ".width"                },
9210     { TYPE_INTEGER,     &tmi.height,            ".height"               },
9211     { TYPE_INTEGER,     &tmi.chars,             ".chars"                },
9212     { TYPE_INTEGER,     &tmi.lines,             ".lines"                },
9213     { TYPE_INTEGER,     &tmi.align,             ".align"                },
9214     { TYPE_INTEGER,     &tmi.valign,            ".valign"               },
9215     { TYPE_INTEGER,     &tmi.font,              ".font"                 },
9216     { TYPE_BOOLEAN,     &tmi.autowrap,          ".autowrap"             },
9217     { TYPE_BOOLEAN,     &tmi.centered,          ".centered"             },
9218     { TYPE_BOOLEAN,     &tmi.parse_comments,    ".parse_comments"       },
9219     { TYPE_INTEGER,     &tmi.sort_priority,     ".sort_priority"        },
9220     { TYPE_INTEGER,     &tmi.fade_mode,         ".fade_mode"            },
9221     { TYPE_INTEGER,     &tmi.fade_delay,        ".fade_delay"           },
9222     { TYPE_INTEGER,     &tmi.post_delay,        ".post_delay"           },
9223     { TYPE_INTEGER,     &tmi.auto_delay,        ".auto_delay"           },
9224
9225     { -1,               NULL,                   NULL                    }
9226   };
9227   static struct
9228   {
9229     struct TitleFadingInfo *info;
9230     char *text;
9231   }
9232   title_info[] =
9233   {
9234     /* initialize first titles from "enter screen" definitions, if defined */
9235     { &title_initial_first_default,     "menu.enter_screen.TITLE"       },
9236     { &title_first_default,             "menu.enter_screen.TITLE"       },
9237
9238     /* initialize title screens from "next screen" definitions, if defined */
9239     { &title_initial_default,           "menu.next_screen.TITLE"        },
9240     { &title_default,                   "menu.next_screen.TITLE"        },
9241
9242     { NULL,                             NULL                            }
9243   };
9244   static struct
9245   {
9246     struct TitleMessageInfo *array;
9247     char *text;
9248   }
9249   titlemessage_arrays[] =
9250   {
9251     /* initialize first titles from "enter screen" definitions, if defined */
9252     { titlescreen_initial_first,        "menu.enter_screen.TITLE"       },
9253     { titlescreen_first,                "menu.enter_screen.TITLE"       },
9254     { titlemessage_initial_first,       "menu.enter_screen.TITLE"       },
9255     { titlemessage_first,               "menu.enter_screen.TITLE"       },
9256
9257     /* initialize titles from "next screen" definitions, if defined */
9258     { titlescreen_initial,              "menu.next_screen.TITLE"        },
9259     { titlescreen,                      "menu.next_screen.TITLE"        },
9260     { titlemessage_initial,             "menu.next_screen.TITLE"        },
9261     { titlemessage,                     "menu.next_screen.TITLE"        },
9262
9263     /* overwrite titles with title definitions, if defined */
9264     { titlescreen_initial_first,        "[title_initial]"               },
9265     { titlescreen_first,                "[title]"                       },
9266     { titlemessage_initial_first,       "[title_initial]"               },
9267     { titlemessage_first,               "[title]"                       },
9268
9269     { titlescreen_initial,              "[title_initial]"               },
9270     { titlescreen,                      "[title]"                       },
9271     { titlemessage_initial,             "[title_initial]"               },
9272     { titlemessage,                     "[title]"                       },
9273
9274     /* overwrite titles with title screen/message definitions, if defined */
9275     { titlescreen_initial_first,        "[titlescreen_initial]"         },
9276     { titlescreen_first,                "[titlescreen]"                 },
9277     { titlemessage_initial_first,       "[titlemessage_initial]"        },
9278     { titlemessage_first,               "[titlemessage]"                },
9279
9280     { titlescreen_initial,              "[titlescreen_initial]"         },
9281     { titlescreen,                      "[titlescreen]"                 },
9282     { titlemessage_initial,             "[titlemessage_initial]"        },
9283     { titlemessage,                     "[titlemessage]"                },
9284
9285     { NULL,                             NULL                            }
9286   };
9287   SetupFileHash *setup_file_hash;
9288   int i, j, k;
9289
9290   if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
9291     return;
9292
9293   /* the following initializes hierarchical values from dynamic configuration */
9294
9295   /* special case: initialize with default values that may be overwritten */
9296   /* (e.g., init "menu.draw_xoffset.INFO" from "menu.draw_xoffset") */
9297   for (i = 0; i < NUM_SPECIAL_GFX_ARGS; i++)
9298   {
9299     char *value_1 = getHashEntry(setup_file_hash, "menu.draw_xoffset");
9300     char *value_2 = getHashEntry(setup_file_hash, "menu.draw_yoffset");
9301     char *value_3 = getHashEntry(setup_file_hash, "menu.list_size");
9302
9303     if (value_1 != NULL)
9304       menu.draw_xoffset[i] = get_integer_from_string(value_1);
9305     if (value_2 != NULL)
9306       menu.draw_yoffset[i] = get_integer_from_string(value_2);
9307     if (value_3 != NULL)
9308       menu.list_size[i] = get_integer_from_string(value_3);
9309   }
9310
9311   /* special case: initialize with default values that may be overwritten */
9312   /* (eg, init "menu.draw_xoffset.INFO[XXX]" from "menu.draw_xoffset.INFO") */
9313   for (i = 0; i < NUM_SPECIAL_GFX_INFO_ARGS; i++)
9314   {
9315     char *value_1 = getHashEntry(setup_file_hash, "menu.draw_xoffset.INFO");
9316     char *value_2 = getHashEntry(setup_file_hash, "menu.draw_yoffset.INFO");
9317
9318     if (value_1 != NULL)
9319       menu.draw_xoffset_info[i] = get_integer_from_string(value_1);
9320     if (value_2 != NULL)
9321       menu.draw_yoffset_info[i] = get_integer_from_string(value_2);
9322
9323     if (i == GFX_SPECIAL_ARG_INFO_ELEMENTS)
9324     {
9325       char *value_1 = getHashEntry(setup_file_hash, "menu.list_size.INFO");
9326
9327       if (value_1 != NULL)
9328         menu.list_size_info[i] = get_integer_from_string(value_1);
9329     }
9330   }
9331
9332   /* special case: initialize with default values that may be overwritten */
9333   /* (eg, init "menu.draw_xoffset.SETUP[XXX]" from "menu.draw_xoffset.SETUP") */
9334   for (i = 0; i < NUM_SPECIAL_GFX_SETUP_ARGS; i++)
9335   {
9336     char *value_1 = getHashEntry(setup_file_hash, "menu.draw_xoffset.SETUP");
9337     char *value_2 = getHashEntry(setup_file_hash, "menu.draw_yoffset.SETUP");
9338
9339     if (value_1 != NULL)
9340       menu.draw_xoffset_setup[i] = get_integer_from_string(value_1);
9341     if (value_2 != NULL)
9342       menu.draw_yoffset_setup[i] = get_integer_from_string(value_2);
9343   }
9344
9345   /* special case: initialize with default values that may be overwritten */
9346   /* (eg, init "menu.enter_screen.SCORES.xyz" from "menu.enter_screen.xyz") */
9347   for (i = 0; i < NUM_SPECIAL_GFX_ARGS; i++)
9348   {
9349     char *token_1 = "menu.enter_screen.fade_mode";
9350     char *token_2 = "menu.enter_screen.fade_delay";
9351     char *token_3 = "menu.enter_screen.post_delay";
9352     char *token_4 = "menu.leave_screen.fade_mode";
9353     char *token_5 = "menu.leave_screen.fade_delay";
9354     char *token_6 = "menu.leave_screen.post_delay";
9355     char *token_7 = "menu.next_screen.fade_mode";
9356     char *token_8 = "menu.next_screen.fade_delay";
9357     char *token_9 = "menu.next_screen.post_delay";
9358     char *value_1 = getHashEntry(setup_file_hash, token_1);
9359     char *value_2 = getHashEntry(setup_file_hash, token_2);
9360     char *value_3 = getHashEntry(setup_file_hash, token_3);
9361     char *value_4 = getHashEntry(setup_file_hash, token_4);
9362     char *value_5 = getHashEntry(setup_file_hash, token_5);
9363     char *value_6 = getHashEntry(setup_file_hash, token_6);
9364     char *value_7 = getHashEntry(setup_file_hash, token_7);
9365     char *value_8 = getHashEntry(setup_file_hash, token_8);
9366     char *value_9 = getHashEntry(setup_file_hash, token_9);
9367
9368     if (value_1 != NULL)
9369       menu.enter_screen[i].fade_mode = get_token_parameter_value(token_1,
9370                                                                  value_1);
9371     if (value_2 != NULL)
9372       menu.enter_screen[i].fade_delay = get_token_parameter_value(token_2,
9373                                                                   value_2);
9374     if (value_3 != NULL)
9375       menu.enter_screen[i].post_delay = get_token_parameter_value(token_3,
9376                                                                   value_3);
9377     if (value_4 != NULL)
9378       menu.leave_screen[i].fade_mode = get_token_parameter_value(token_4,
9379                                                                  value_4);
9380     if (value_5 != NULL)
9381       menu.leave_screen[i].fade_delay = get_token_parameter_value(token_5,
9382                                                                   value_5);
9383     if (value_6 != NULL)
9384       menu.leave_screen[i].post_delay = get_token_parameter_value(token_6,
9385                                                                   value_6);
9386     if (value_7 != NULL)
9387       menu.next_screen[i].fade_mode = get_token_parameter_value(token_7,
9388                                                                 value_7);
9389     if (value_8 != NULL)
9390       menu.next_screen[i].fade_delay = get_token_parameter_value(token_8,
9391                                                                  value_8);
9392     if (value_9 != NULL)
9393       menu.next_screen[i].post_delay = get_token_parameter_value(token_9,
9394                                                                  value_9);
9395   }
9396
9397   /* special case: initialize with default values that may be overwritten */
9398   /* (eg, init "viewport.door_1.MAIN.xyz" from "viewport.door_1.xyz") */
9399   for (i = 0; i < NUM_SPECIAL_GFX_ARGS; i++)
9400   {
9401     char *token_w1 = "viewport.window.width";
9402     char *token_w2 = "viewport.window.height";
9403     char *token_01 = "viewport.playfield.x";
9404     char *token_02 = "viewport.playfield.y";
9405     char *token_03 = "viewport.playfield.width";
9406     char *token_04 = "viewport.playfield.height";
9407     char *token_05 = "viewport.playfield.border_size";
9408     char *token_06 = "viewport.door_1.x";
9409     char *token_07 = "viewport.door_1.y";
9410     char *token_08 = "viewport.door_1.width";
9411     char *token_09 = "viewport.door_1.height";
9412     char *token_10 = "viewport.door_1.border_size";
9413     char *token_11 = "viewport.door_2.x";
9414     char *token_12 = "viewport.door_2.y";
9415     char *token_13 = "viewport.door_2.width";
9416     char *token_14 = "viewport.door_2.height";
9417     char *token_15 = "viewport.door_2.border_size";
9418     char *value_w1 = getHashEntry(setup_file_hash, token_w1);
9419     char *value_w2 = getHashEntry(setup_file_hash, token_w2);
9420     char *value_01 = getHashEntry(setup_file_hash, token_01);
9421     char *value_02 = getHashEntry(setup_file_hash, token_02);
9422     char *value_03 = getHashEntry(setup_file_hash, token_03);
9423     char *value_04 = getHashEntry(setup_file_hash, token_04);
9424     char *value_05 = getHashEntry(setup_file_hash, token_05);
9425     char *value_06 = getHashEntry(setup_file_hash, token_06);
9426     char *value_07 = getHashEntry(setup_file_hash, token_07);
9427     char *value_08 = getHashEntry(setup_file_hash, token_08);
9428     char *value_09 = getHashEntry(setup_file_hash, token_09);
9429     char *value_10 = getHashEntry(setup_file_hash, token_10);
9430     char *value_11 = getHashEntry(setup_file_hash, token_11);
9431     char *value_12 = getHashEntry(setup_file_hash, token_12);
9432     char *value_13 = getHashEntry(setup_file_hash, token_13);
9433     char *value_14 = getHashEntry(setup_file_hash, token_14);
9434     char *value_15 = getHashEntry(setup_file_hash, token_15);
9435
9436     if (value_w1 != NULL)
9437       viewport.window[i].width = get_token_parameter_value(token_w1, value_w1);
9438     if (value_w2 != NULL)
9439       viewport.window[i].height = get_token_parameter_value(token_w2, value_w2);
9440     if (value_01 != NULL)
9441       viewport.playfield[i].x = get_token_parameter_value(token_01, value_01);
9442     if (value_02 != NULL)
9443       viewport.playfield[i].y = get_token_parameter_value(token_02, value_02);
9444     if (value_03 != NULL)
9445       viewport.playfield[i].width = get_token_parameter_value(token_03,
9446                                                               value_03);
9447     if (value_04 != NULL)
9448       viewport.playfield[i].height = get_token_parameter_value(token_04,
9449                                                                value_04);
9450     if (value_05 != NULL)
9451       viewport.playfield[i].border_size = get_token_parameter_value(token_05,
9452                                                                     value_05);
9453     if (value_06 != NULL)
9454       viewport.door_1[i].x = get_token_parameter_value(token_06, value_06);
9455     if (value_07 != NULL)
9456       viewport.door_1[i].y = get_token_parameter_value(token_07, value_07);
9457     if (value_08 != NULL)
9458       viewport.door_1[i].width = get_token_parameter_value(token_08, value_08);
9459     if (value_09 != NULL)
9460       viewport.door_1[i].height = get_token_parameter_value(token_09, value_09);
9461     if (value_10 != NULL)
9462       viewport.door_1[i].border_size = get_token_parameter_value(token_10,
9463                                                                  value_10);
9464     if (value_11 != NULL)
9465       viewport.door_2[i].x = get_token_parameter_value(token_11, value_11);
9466     if (value_12 != NULL)
9467       viewport.door_2[i].y = get_token_parameter_value(token_12, value_12);
9468     if (value_13 != NULL)
9469       viewport.door_2[i].width = get_token_parameter_value(token_13, value_13);
9470     if (value_14 != NULL)
9471       viewport.door_2[i].height = get_token_parameter_value(token_14, value_14);
9472     if (value_15 != NULL)
9473       viewport.door_1[i].border_size = get_token_parameter_value(token_15,
9474                                                                  value_15);
9475   }
9476
9477   /* special case: initialize with default values that may be overwritten */
9478   /* (e.g., init "[title].fade_mode" from "menu.next_screen.TITLE.fade_mode") */
9479   for (i = 0; title_info[i].info != NULL; i++)
9480   {
9481     struct TitleFadingInfo *info = title_info[i].info;
9482     char *base_token = title_info[i].text;
9483
9484     for (j = 0; title_tokens[j].type != -1; j++)
9485     {
9486       char *token = getStringCat2(base_token, title_tokens[j].text);
9487       char *value = getHashEntry(setup_file_hash, token);
9488
9489       if (value != NULL)
9490       {
9491         int parameter_value = get_token_parameter_value(token, value);
9492
9493         tfi = *info;
9494
9495         *(int *)title_tokens[j].value = (int)parameter_value;
9496
9497         *info = tfi;
9498       }
9499
9500       free(token);
9501     }
9502   }
9503
9504   /* special case: initialize with default values that may be overwritten */
9505   /* (e.g., init "titlemessage_1.fade_mode" from "[titlemessage].fade_mode") */
9506   for (i = 0; titlemessage_arrays[i].array != NULL; i++)
9507   {
9508     struct TitleMessageInfo *array = titlemessage_arrays[i].array;
9509     char *base_token = titlemessage_arrays[i].text;
9510
9511     for (j = 0; titlemessage_tokens[j].type != -1; j++)
9512     {
9513       char *token = getStringCat2(base_token, titlemessage_tokens[j].text);
9514       char *value = getHashEntry(setup_file_hash, token);
9515
9516       if (value != NULL)
9517       {
9518         int parameter_value = get_token_parameter_value(token, value);
9519
9520         for (k = 0; k < MAX_NUM_TITLE_MESSAGES; k++)
9521         {
9522           tmi = array[k];
9523
9524           if (titlemessage_tokens[j].type == TYPE_INTEGER)
9525             *(int     *)titlemessage_tokens[j].value = (int)parameter_value;
9526           else
9527             *(boolean *)titlemessage_tokens[j].value = (boolean)parameter_value;
9528
9529           array[k] = tmi;
9530         }
9531       }
9532
9533       free(token);
9534     }
9535   }
9536
9537   /* read (and overwrite with) values that may be specified in config file */
9538   for (i = 0; image_config_vars[i].token != NULL; i++)
9539   {
9540     char *value = getHashEntry(setup_file_hash, image_config_vars[i].token);
9541
9542     /* (ignore definitions set to "[DEFAULT]" which are already initialized) */
9543     if (value != NULL && !strEqual(value, ARG_DEFAULT))
9544       *image_config_vars[i].value =
9545         get_token_parameter_value(image_config_vars[i].token, value);
9546   }
9547
9548   freeSetupFileHash(setup_file_hash);
9549 }
9550
9551 void LoadMenuDesignSettings()
9552 {
9553   char *filename_base = UNDEFINED_FILENAME, *filename_local;
9554
9555   InitMenuDesignSettings_Static();
9556   InitMenuDesignSettings_SpecialPreProcessing();
9557
9558   if (!GFX_OVERRIDE_ARTWORK(ARTWORK_TYPE_GRAPHICS))
9559   {
9560     /* first look for special settings configured in level series config */
9561     filename_base = getCustomArtworkLevelConfigFilename(ARTWORK_TYPE_GRAPHICS);
9562
9563     if (fileExists(filename_base))
9564       LoadMenuDesignSettingsFromFilename(filename_base);
9565   }
9566
9567   filename_local = getCustomArtworkConfigFilename(ARTWORK_TYPE_GRAPHICS);
9568
9569   if (filename_local != NULL && !strEqual(filename_base, filename_local))
9570     LoadMenuDesignSettingsFromFilename(filename_local);
9571
9572   InitMenuDesignSettings_SpecialPostProcessing();
9573 }
9574
9575 void LoadMenuDesignSettings_AfterGraphics()
9576 {
9577   InitMenuDesignSettings_SpecialPostProcessing_AfterGraphics();
9578 }
9579
9580 void LoadUserDefinedEditorElementList(int **elements, int *num_elements)
9581 {
9582   char *filename = getEditorSetupFilename();
9583   SetupFileList *setup_file_list, *list;
9584   SetupFileHash *element_hash;
9585   int num_unknown_tokens = 0;
9586   int i;
9587
9588   if ((setup_file_list = loadSetupFileList(filename)) == NULL)
9589     return;
9590
9591   element_hash = newSetupFileHash();
9592
9593   for (i = 0; i < NUM_FILE_ELEMENTS; i++)
9594     setHashEntry(element_hash, element_info[i].token_name, i_to_a(i));
9595
9596   /* determined size may be larger than needed (due to unknown elements) */
9597   *num_elements = 0;
9598   for (list = setup_file_list; list != NULL; list = list->next)
9599     (*num_elements)++;
9600
9601   /* add space for up to 3 more elements for padding that may be needed */
9602   *num_elements += 3;
9603
9604   /* free memory for old list of elements, if needed */
9605   checked_free(*elements);
9606
9607   /* allocate memory for new list of elements */
9608   *elements = checked_malloc(*num_elements * sizeof(int));
9609
9610   *num_elements = 0;
9611   for (list = setup_file_list; list != NULL; list = list->next)
9612   {
9613     char *value = getHashEntry(element_hash, list->token);
9614
9615     if (value == NULL)          /* try to find obsolete token mapping */
9616     {
9617       char *mapped_token = get_mapped_token(list->token);
9618
9619       if (mapped_token != NULL)
9620       {
9621         value = getHashEntry(element_hash, mapped_token);
9622
9623         free(mapped_token);
9624       }
9625     }
9626
9627     if (value != NULL)
9628     {
9629       (*elements)[(*num_elements)++] = atoi(value);
9630     }
9631     else
9632     {
9633       if (num_unknown_tokens == 0)
9634       {
9635         Error(ERR_INFO_LINE, "-");
9636         Error(ERR_INFO, "warning: unknown token(s) found in config file:");
9637         Error(ERR_INFO, "- config file: '%s'", filename);
9638
9639         num_unknown_tokens++;
9640       }
9641
9642       Error(ERR_INFO, "- token: '%s'", list->token);
9643     }
9644   }
9645
9646   if (num_unknown_tokens > 0)
9647     Error(ERR_INFO_LINE, "-");
9648
9649   while (*num_elements % 4)     /* pad with empty elements, if needed */
9650     (*elements)[(*num_elements)++] = EL_EMPTY;
9651
9652   freeSetupFileList(setup_file_list);
9653   freeSetupFileHash(element_hash);
9654
9655 #if 0
9656   for (i = 0; i < *num_elements; i++)
9657     printf("editor: element '%s' [%d]\n",
9658            element_info[(*elements)[i]].token_name, (*elements)[i]);
9659 #endif
9660 }
9661
9662 static struct MusicFileInfo *get_music_file_info_ext(char *basename, int music,
9663                                                      boolean is_sound)
9664 {
9665   SetupFileHash *setup_file_hash = NULL;
9666   struct MusicFileInfo tmp_music_file_info, *new_music_file_info;
9667   char *filename_music, *filename_prefix, *filename_info;
9668   struct
9669   {
9670     char *token;
9671     char **value_ptr;
9672   }
9673   token_to_value_ptr[] =
9674   {
9675     { "title_header",   &tmp_music_file_info.title_header       },
9676     { "artist_header",  &tmp_music_file_info.artist_header      },
9677     { "album_header",   &tmp_music_file_info.album_header       },
9678     { "year_header",    &tmp_music_file_info.year_header        },
9679
9680     { "title",          &tmp_music_file_info.title              },
9681     { "artist",         &tmp_music_file_info.artist             },
9682     { "album",          &tmp_music_file_info.album              },
9683     { "year",           &tmp_music_file_info.year               },
9684
9685     { NULL,             NULL                                    },
9686   };
9687   int i;
9688
9689   filename_music = (is_sound ? getCustomSoundFilename(basename) :
9690                     getCustomMusicFilename(basename));
9691
9692   if (filename_music == NULL)
9693     return NULL;
9694
9695   /* ---------- try to replace file extension ---------- */
9696
9697   filename_prefix = getStringCopy(filename_music);
9698   if (strrchr(filename_prefix, '.') != NULL)
9699     *strrchr(filename_prefix, '.') = '\0';
9700   filename_info = getStringCat2(filename_prefix, ".txt");
9701
9702   if (fileExists(filename_info))
9703     setup_file_hash = loadSetupFileHash(filename_info);
9704
9705   free(filename_prefix);
9706   free(filename_info);
9707
9708   if (setup_file_hash == NULL)
9709   {
9710     /* ---------- try to add file extension ---------- */
9711
9712     filename_prefix = getStringCopy(filename_music);
9713     filename_info = getStringCat2(filename_prefix, ".txt");
9714
9715     if (fileExists(filename_info))
9716       setup_file_hash = loadSetupFileHash(filename_info);
9717
9718     free(filename_prefix);
9719     free(filename_info);
9720   }
9721
9722   if (setup_file_hash == NULL)
9723     return NULL;
9724
9725   /* ---------- music file info found ---------- */
9726
9727   clear_mem(&tmp_music_file_info, sizeof(struct MusicFileInfo));
9728
9729   for (i = 0; token_to_value_ptr[i].token != NULL; i++)
9730   {
9731     char *value = getHashEntry(setup_file_hash, token_to_value_ptr[i].token);
9732
9733     *token_to_value_ptr[i].value_ptr =
9734       getStringCopy(value != NULL && *value != '\0' ? value : UNKNOWN_NAME);
9735   }
9736
9737   tmp_music_file_info.basename = getStringCopy(basename);
9738   tmp_music_file_info.music = music;
9739   tmp_music_file_info.is_sound = is_sound;
9740
9741   new_music_file_info = checked_malloc(sizeof(struct MusicFileInfo));
9742   *new_music_file_info = tmp_music_file_info;
9743
9744   return new_music_file_info;
9745 }
9746
9747 static struct MusicFileInfo *get_music_file_info(char *basename, int music)
9748 {
9749   return get_music_file_info_ext(basename, music, FALSE);
9750 }
9751
9752 static struct MusicFileInfo *get_sound_file_info(char *basename, int sound)
9753 {
9754   return get_music_file_info_ext(basename, sound, TRUE);
9755 }
9756
9757 static boolean music_info_listed_ext(struct MusicFileInfo *list,
9758                                      char *basename, boolean is_sound)
9759 {
9760   for (; list != NULL; list = list->next)
9761     if (list->is_sound == is_sound && strEqual(list->basename, basename))
9762       return TRUE;
9763
9764   return FALSE;
9765 }
9766
9767 static boolean music_info_listed(struct MusicFileInfo *list, char *basename)
9768 {
9769   return music_info_listed_ext(list, basename, FALSE);
9770 }
9771
9772 static boolean sound_info_listed(struct MusicFileInfo *list, char *basename)
9773 {
9774   return music_info_listed_ext(list, basename, TRUE);
9775 }
9776
9777 void LoadMusicInfo()
9778 {
9779   char *music_directory = getCustomMusicDirectory();
9780   int num_music = getMusicListSize();
9781   int num_music_noconf = 0;
9782   int num_sounds = getSoundListSize();
9783   Directory *dir;
9784   DirectoryEntry *dir_entry;
9785   struct FileInfo *music, *sound;
9786   struct MusicFileInfo *next, **new;
9787   int i;
9788
9789   while (music_file_info != NULL)
9790   {
9791     next = music_file_info->next;
9792
9793     checked_free(music_file_info->basename);
9794
9795     checked_free(music_file_info->title_header);
9796     checked_free(music_file_info->artist_header);
9797     checked_free(music_file_info->album_header);
9798     checked_free(music_file_info->year_header);
9799
9800     checked_free(music_file_info->title);
9801     checked_free(music_file_info->artist);
9802     checked_free(music_file_info->album);
9803     checked_free(music_file_info->year);
9804
9805     free(music_file_info);
9806
9807     music_file_info = next;
9808   }
9809
9810   new = &music_file_info;
9811
9812   for (i = 0; i < num_music; i++)
9813   {
9814     music = getMusicListEntry(i);
9815
9816     if (music->filename == NULL)
9817       continue;
9818
9819     if (strEqual(music->filename, UNDEFINED_FILENAME))
9820       continue;
9821
9822     /* a configured file may be not recognized as music */
9823     if (!FileIsMusic(music->filename))
9824       continue;
9825
9826     if (!music_info_listed(music_file_info, music->filename))
9827     {
9828       *new = get_music_file_info(music->filename, i);
9829
9830       if (*new != NULL)
9831         new = &(*new)->next;
9832     }
9833   }
9834
9835   if ((dir = openDirectory(music_directory)) == NULL)
9836   {
9837     Error(ERR_WARN, "cannot read music directory '%s'", music_directory);
9838     return;
9839   }
9840
9841   while ((dir_entry = readDirectory(dir)) != NULL)      /* loop all entries */
9842   {
9843     char *basename = dir_entry->basename;
9844     boolean music_already_used = FALSE;
9845     int i;
9846
9847     /* skip all music files that are configured in music config file */
9848     for (i = 0; i < num_music; i++)
9849     {
9850       music = getMusicListEntry(i);
9851
9852       if (music->filename == NULL)
9853         continue;
9854
9855       if (strEqual(basename, music->filename))
9856       {
9857         music_already_used = TRUE;
9858         break;
9859       }
9860     }
9861
9862     if (music_already_used)
9863       continue;
9864
9865     if (!FileIsMusic(dir_entry->filename))
9866       continue;
9867
9868     if (!music_info_listed(music_file_info, basename))
9869     {
9870       *new = get_music_file_info(basename, MAP_NOCONF_MUSIC(num_music_noconf));
9871
9872       if (*new != NULL)
9873         new = &(*new)->next;
9874     }
9875
9876     num_music_noconf++;
9877   }
9878
9879   closeDirectory(dir);
9880
9881   for (i = 0; i < num_sounds; i++)
9882   {
9883     sound = getSoundListEntry(i);
9884
9885     if (sound->filename == NULL)
9886       continue;
9887
9888     if (strEqual(sound->filename, UNDEFINED_FILENAME))
9889       continue;
9890
9891     /* a configured file may be not recognized as sound */
9892     if (!FileIsSound(sound->filename))
9893       continue;
9894
9895     if (!sound_info_listed(music_file_info, sound->filename))
9896     {
9897       *new = get_sound_file_info(sound->filename, i);
9898       if (*new != NULL)
9899         new = &(*new)->next;
9900     }
9901   }
9902 }
9903
9904 void add_helpanim_entry(int element, int action, int direction, int delay,
9905                         int *num_list_entries)
9906 {
9907   struct HelpAnimInfo *new_list_entry;
9908   (*num_list_entries)++;
9909
9910   helpanim_info =
9911     checked_realloc(helpanim_info,
9912                     *num_list_entries * sizeof(struct HelpAnimInfo));
9913   new_list_entry = &helpanim_info[*num_list_entries - 1];
9914
9915   new_list_entry->element = element;
9916   new_list_entry->action = action;
9917   new_list_entry->direction = direction;
9918   new_list_entry->delay = delay;
9919 }
9920
9921 void print_unknown_token(char *filename, char *token, int token_nr)
9922 {
9923   if (token_nr == 0)
9924   {
9925     Error(ERR_INFO_LINE, "-");
9926     Error(ERR_INFO, "warning: unknown token(s) found in config file:");
9927     Error(ERR_INFO, "- config file: '%s'", filename);
9928   }
9929
9930   Error(ERR_INFO, "- token: '%s'", token);
9931 }
9932
9933 void print_unknown_token_end(int token_nr)
9934 {
9935   if (token_nr > 0)
9936     Error(ERR_INFO_LINE, "-");
9937 }
9938
9939 void LoadHelpAnimInfo()
9940 {
9941   char *filename = getHelpAnimFilename();
9942   SetupFileList *setup_file_list = NULL, *list;
9943   SetupFileHash *element_hash, *action_hash, *direction_hash;
9944   int num_list_entries = 0;
9945   int num_unknown_tokens = 0;
9946   int i;
9947
9948   if (fileExists(filename))
9949     setup_file_list = loadSetupFileList(filename);
9950
9951   if (setup_file_list == NULL)
9952   {
9953     /* use reliable default values from static configuration */
9954     SetupFileList *insert_ptr;
9955
9956     insert_ptr = setup_file_list =
9957       newSetupFileList(helpanim_config[0].token,
9958                        helpanim_config[0].value);
9959
9960     for (i = 1; helpanim_config[i].token; i++)
9961       insert_ptr = addListEntry(insert_ptr,
9962                                 helpanim_config[i].token,
9963                                 helpanim_config[i].value);
9964   }
9965
9966   element_hash   = newSetupFileHash();
9967   action_hash    = newSetupFileHash();
9968   direction_hash = newSetupFileHash();
9969
9970   for (i = 0; i < MAX_NUM_ELEMENTS; i++)
9971     setHashEntry(element_hash, element_info[i].token_name, i_to_a(i));
9972
9973   for (i = 0; i < NUM_ACTIONS; i++)
9974     setHashEntry(action_hash, element_action_info[i].suffix,
9975                  i_to_a(element_action_info[i].value));
9976
9977   /* do not store direction index (bit) here, but direction value! */
9978   for (i = 0; i < NUM_DIRECTIONS_FULL; i++)
9979     setHashEntry(direction_hash, element_direction_info[i].suffix,
9980                  i_to_a(1 << element_direction_info[i].value));
9981
9982   for (list = setup_file_list; list != NULL; list = list->next)
9983   {
9984     char *element_token, *action_token, *direction_token;
9985     char *element_value, *action_value, *direction_value;
9986     int delay = atoi(list->value);
9987
9988     if (strEqual(list->token, "end"))
9989     {
9990       add_helpanim_entry(HELPANIM_LIST_NEXT, -1, -1, -1, &num_list_entries);
9991
9992       continue;
9993     }
9994
9995     /* first try to break element into element/action/direction parts;
9996        if this does not work, also accept combined "element[.act][.dir]"
9997        elements (like "dynamite.active"), which are unique elements */
9998
9999     if (strchr(list->token, '.') == NULL)       /* token contains no '.' */
10000     {
10001       element_value = getHashEntry(element_hash, list->token);
10002       if (element_value != NULL)        /* element found */
10003         add_helpanim_entry(atoi(element_value), -1, -1, delay,
10004                            &num_list_entries);
10005       else
10006       {
10007         /* no further suffixes found -- this is not an element */
10008         print_unknown_token(filename, list->token, num_unknown_tokens++);
10009       }
10010
10011       continue;
10012     }
10013
10014     /* token has format "<prefix>.<something>" */
10015
10016     action_token = strchr(list->token, '.');    /* suffix may be action ... */
10017     direction_token = action_token;             /* ... or direction */
10018
10019     element_token = getStringCopy(list->token);
10020     *strchr(element_token, '.') = '\0';
10021
10022     element_value = getHashEntry(element_hash, element_token);
10023
10024     if (element_value == NULL)          /* this is no element */
10025     {
10026       element_value = getHashEntry(element_hash, list->token);
10027       if (element_value != NULL)        /* combined element found */
10028         add_helpanim_entry(atoi(element_value), -1, -1, delay,
10029                            &num_list_entries);
10030       else
10031         print_unknown_token(filename, list->token, num_unknown_tokens++);
10032
10033       free(element_token);
10034
10035       continue;
10036     }
10037
10038     action_value = getHashEntry(action_hash, action_token);
10039
10040     if (action_value != NULL)           /* action found */
10041     {
10042       add_helpanim_entry(atoi(element_value), atoi(action_value), -1, delay,
10043                     &num_list_entries);
10044
10045       free(element_token);
10046
10047       continue;
10048     }
10049
10050     direction_value = getHashEntry(direction_hash, direction_token);
10051
10052     if (direction_value != NULL)        /* direction found */
10053     {
10054       add_helpanim_entry(atoi(element_value), -1, atoi(direction_value), delay,
10055                          &num_list_entries);
10056
10057       free(element_token);
10058
10059       continue;
10060     }
10061
10062     if (strchr(action_token + 1, '.') == NULL)
10063     {
10064       /* no further suffixes found -- this is not an action nor direction */
10065
10066       element_value = getHashEntry(element_hash, list->token);
10067       if (element_value != NULL)        /* combined element found */
10068         add_helpanim_entry(atoi(element_value), -1, -1, delay,
10069                            &num_list_entries);
10070       else
10071         print_unknown_token(filename, list->token, num_unknown_tokens++);
10072
10073       free(element_token);
10074
10075       continue;
10076     }
10077
10078     /* token has format "<prefix>.<suffix>.<something>" */
10079
10080     direction_token = strchr(action_token + 1, '.');
10081
10082     action_token = getStringCopy(action_token);
10083     *strchr(action_token + 1, '.') = '\0';
10084
10085     action_value = getHashEntry(action_hash, action_token);
10086
10087     if (action_value == NULL)           /* this is no action */
10088     {
10089       element_value = getHashEntry(element_hash, list->token);
10090       if (element_value != NULL)        /* combined element found */
10091         add_helpanim_entry(atoi(element_value), -1, -1, delay,
10092                            &num_list_entries);
10093       else
10094         print_unknown_token(filename, list->token, num_unknown_tokens++);
10095
10096       free(element_token);
10097       free(action_token);
10098
10099       continue;
10100     }
10101
10102     direction_value = getHashEntry(direction_hash, direction_token);
10103
10104     if (direction_value != NULL)        /* direction found */
10105     {
10106       add_helpanim_entry(atoi(element_value), atoi(action_value),
10107                          atoi(direction_value), delay, &num_list_entries);
10108
10109       free(element_token);
10110       free(action_token);
10111
10112       continue;
10113     }
10114
10115     /* this is no direction */
10116
10117     element_value = getHashEntry(element_hash, list->token);
10118     if (element_value != NULL)          /* combined element found */
10119       add_helpanim_entry(atoi(element_value), -1, -1, delay,
10120                          &num_list_entries);
10121     else
10122       print_unknown_token(filename, list->token, num_unknown_tokens++);
10123
10124     free(element_token);
10125     free(action_token);
10126   }
10127
10128   print_unknown_token_end(num_unknown_tokens);
10129
10130   add_helpanim_entry(HELPANIM_LIST_NEXT, -1, -1, -1, &num_list_entries);
10131   add_helpanim_entry(HELPANIM_LIST_END,  -1, -1, -1, &num_list_entries);
10132
10133   freeSetupFileList(setup_file_list);
10134   freeSetupFileHash(element_hash);
10135   freeSetupFileHash(action_hash);
10136   freeSetupFileHash(direction_hash);
10137
10138 #if 0
10139   for (i = 0; i < num_list_entries; i++)
10140     printf("::: '%s': %d, %d, %d => %d\n",
10141            EL_NAME(helpanim_info[i].element),
10142            helpanim_info[i].element,
10143            helpanim_info[i].action,
10144            helpanim_info[i].direction,
10145            helpanim_info[i].delay);
10146 #endif
10147 }
10148
10149 void LoadHelpTextInfo()
10150 {
10151   char *filename = getHelpTextFilename();
10152   int i;
10153
10154   if (helptext_info != NULL)
10155   {
10156     freeSetupFileHash(helptext_info);
10157     helptext_info = NULL;
10158   }
10159
10160   if (fileExists(filename))
10161     helptext_info = loadSetupFileHash(filename);
10162
10163   if (helptext_info == NULL)
10164   {
10165     /* use reliable default values from static configuration */
10166     helptext_info = newSetupFileHash();
10167
10168     for (i = 0; helptext_config[i].token; i++)
10169       setHashEntry(helptext_info,
10170                    helptext_config[i].token,
10171                    helptext_config[i].value);
10172   }
10173
10174 #if 0
10175   BEGIN_HASH_ITERATION(helptext_info, itr)
10176   {
10177     printf("::: '%s' => '%s'\n",
10178            HASH_ITERATION_TOKEN(itr), HASH_ITERATION_VALUE(itr));
10179   }
10180   END_HASH_ITERATION(hash, itr)
10181 #endif
10182 }
10183
10184
10185 /* ------------------------------------------------------------------------- */
10186 /* convert levels                                                            */
10187 /* ------------------------------------------------------------------------- */
10188
10189 #define MAX_NUM_CONVERT_LEVELS          1000
10190
10191 void ConvertLevels()
10192 {
10193   static LevelDirTree *convert_leveldir = NULL;
10194   static int convert_level_nr = -1;
10195   static int num_levels_handled = 0;
10196   static int num_levels_converted = 0;
10197   static boolean levels_failed[MAX_NUM_CONVERT_LEVELS];
10198   int i;
10199
10200   convert_leveldir = getTreeInfoFromIdentifier(leveldir_first,
10201                                                global.convert_leveldir);
10202
10203   if (convert_leveldir == NULL)
10204     Error(ERR_EXIT, "no such level identifier: '%s'",
10205           global.convert_leveldir);
10206
10207   leveldir_current = convert_leveldir;
10208
10209   if (global.convert_level_nr != -1)
10210   {
10211     convert_leveldir->first_level = global.convert_level_nr;
10212     convert_leveldir->last_level  = global.convert_level_nr;
10213   }
10214
10215   convert_level_nr = convert_leveldir->first_level;
10216
10217   PrintLine("=", 79);
10218   Print("Converting levels\n");
10219   PrintLine("-", 79);
10220   Print("Level series identifier: '%s'\n", convert_leveldir->identifier);
10221   Print("Level series name:       '%s'\n", convert_leveldir->name);
10222   Print("Level series author:     '%s'\n", convert_leveldir->author);
10223   Print("Number of levels:        %d\n",   convert_leveldir->levels);
10224   PrintLine("=", 79);
10225   Print("\n");
10226
10227   for (i = 0; i < MAX_NUM_CONVERT_LEVELS; i++)
10228     levels_failed[i] = FALSE;
10229
10230   while (convert_level_nr <= convert_leveldir->last_level)
10231   {
10232     char *level_filename;
10233     boolean new_level;
10234
10235     level_nr = convert_level_nr++;
10236
10237     Print("Level %03d: ", level_nr);
10238
10239     LoadLevel(level_nr);
10240     if (level.no_level_file || level.no_valid_file)
10241     {
10242       Print("(no level)\n");
10243       continue;
10244     }
10245
10246     Print("converting level ... ");
10247
10248     level_filename = getDefaultLevelFilename(level_nr);
10249     new_level = !fileExists(level_filename);
10250
10251     if (new_level)
10252     {
10253       SaveLevel(level_nr);
10254
10255       num_levels_converted++;
10256
10257       Print("converted.\n");
10258     }
10259     else
10260     {
10261       if (level_nr >= 0 && level_nr < MAX_NUM_CONVERT_LEVELS)
10262         levels_failed[level_nr] = TRUE;
10263
10264       Print("NOT CONVERTED -- LEVEL ALREADY EXISTS.\n");
10265     }
10266
10267     num_levels_handled++;
10268   }
10269
10270   Print("\n");
10271   PrintLine("=", 79);
10272   Print("Number of levels handled: %d\n", num_levels_handled);
10273   Print("Number of levels converted: %d (%d%%)\n", num_levels_converted,
10274          (num_levels_handled ?
10275           num_levels_converted * 100 / num_levels_handled : 0));
10276   PrintLine("-", 79);
10277   Print("Summary (for automatic parsing by scripts):\n");
10278   Print("LEVELDIR '%s', CONVERTED %d/%d (%d%%)",
10279          convert_leveldir->identifier, num_levels_converted,
10280          num_levels_handled,
10281          (num_levels_handled ?
10282           num_levels_converted * 100 / num_levels_handled : 0));
10283
10284   if (num_levels_handled != num_levels_converted)
10285   {
10286     Print(", FAILED:");
10287     for (i = 0; i < MAX_NUM_CONVERT_LEVELS; i++)
10288       if (levels_failed[i])
10289         Print(" %03d", i);
10290   }
10291
10292   Print("\n");
10293   PrintLine("=", 79);
10294
10295   CloseAllAndExit(0);
10296 }
10297
10298
10299 /* ------------------------------------------------------------------------- */
10300 /* create and save images for use in level sketches (raw BMP format)         */
10301 /* ------------------------------------------------------------------------- */
10302
10303 void CreateLevelSketchImages()
10304 {
10305 #if defined(TARGET_SDL)
10306   Bitmap *bitmap1;
10307   Bitmap *bitmap2;
10308   int i;
10309
10310   InitElementPropertiesGfxElement();
10311
10312   bitmap1 = CreateBitmap(TILEX, TILEY, DEFAULT_DEPTH);
10313   bitmap2 = CreateBitmap(MINI_TILEX, MINI_TILEY, DEFAULT_DEPTH);
10314
10315   for (i = 0; i < NUM_FILE_ELEMENTS; i++)
10316   {
10317     Bitmap *src_bitmap;
10318     int src_x, src_y;
10319     int element = getMappedElement(i);
10320     int graphic = el2edimg(element);
10321     char basename1[16];
10322     char basename2[16];
10323     char *filename1;
10324     char *filename2;
10325
10326     sprintf(basename1, "%03d.bmp", i);
10327     sprintf(basename2, "%03ds.bmp", i);
10328
10329     filename1 = getPath2(global.create_images_dir, basename1);
10330     filename2 = getPath2(global.create_images_dir, basename2);
10331
10332     getFixedGraphicSource(graphic, 0, &src_bitmap, &src_x, &src_y);
10333     BlitBitmap(src_bitmap, bitmap1, src_x, src_y, TILEX, TILEY,
10334                0, 0);
10335
10336     if (SDL_SaveBMP(bitmap1->surface, filename1) != 0)
10337       Error(ERR_EXIT, "cannot save level sketch image file '%s'", filename1);
10338
10339     getMiniGraphicSource(graphic, &src_bitmap, &src_x, &src_y);
10340     BlitBitmap(src_bitmap, bitmap2, src_x, src_y, MINI_TILEX, MINI_TILEY, 0, 0);
10341
10342     if (SDL_SaveBMP(bitmap2->surface, filename2) != 0)
10343       Error(ERR_EXIT, "cannot save level sketch image file '%s'", filename2);
10344
10345     free(filename1);
10346     free(filename2);
10347
10348     if (options.debug)
10349       printf("%03d `%03d%c", i, i, (i % 10 < 9 ? ' ' : '\n'));
10350   }
10351
10352   FreeBitmap(bitmap1);
10353   FreeBitmap(bitmap2);
10354
10355   if (options.debug)
10356     printf("\n");
10357
10358   Error(ERR_INFO, "%d normal and small images created", NUM_FILE_ELEMENTS);
10359
10360   CloseAllAndExit(0);
10361 #endif
10362 }
10363
10364
10365 /* ------------------------------------------------------------------------- */
10366 /* create and save images for custom and group elements (raw BMP format)     */
10367 /* ------------------------------------------------------------------------- */
10368
10369 void CreateCustomElementImages(char *directory)
10370 {
10371 #if defined(TARGET_SDL)
10372   char *src_basename = "RocksCE-template.ilbm";
10373   char *dst_basename = "RocksCE.bmp";
10374   char *src_filename = getPath2(directory, src_basename);
10375   char *dst_filename = getPath2(directory, dst_basename);
10376   Bitmap *src_bitmap;
10377   Bitmap *bitmap;
10378   int yoffset_ce = 0;
10379   int yoffset_ge = (TILEY * NUM_CUSTOM_ELEMENTS / 16);
10380   int i;
10381
10382   SDLInitVideoDisplay();
10383
10384   ReCreateBitmap(&backbuffer, video.width, video.height);
10385
10386   src_bitmap = LoadImage(src_filename);
10387
10388   bitmap = CreateBitmap(TILEX * 16 * 2,
10389                         TILEY * (NUM_CUSTOM_ELEMENTS + NUM_GROUP_ELEMENTS) / 16,
10390                         DEFAULT_DEPTH);
10391
10392   for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
10393   {
10394     int x = i % 16;
10395     int y = i / 16;
10396     int ii = i + 1;
10397     int j;
10398
10399     BlitBitmap(src_bitmap, bitmap, 0, 0, TILEX, TILEY,
10400                TILEX * x, TILEY * y + yoffset_ce);
10401
10402     BlitBitmap(src_bitmap, bitmap, 0, TILEY,
10403                TILEX, TILEY,
10404                TILEX * x + TILEX * 16,
10405                TILEY * y + yoffset_ce);
10406
10407     for (j = 2; j >= 0; j--)
10408     {
10409       int c = ii % 10;
10410
10411       BlitBitmap(src_bitmap, bitmap,
10412                  TILEX + c * 7, 0, 6, 10,
10413                  TILEX * x + 6 + j * 7,
10414                  TILEY * y + 11 + yoffset_ce);
10415
10416       BlitBitmap(src_bitmap, bitmap,
10417                  TILEX + c * 8, TILEY, 6, 10,
10418                  TILEX * 16 + TILEX * x + 6 + j * 8,
10419                  TILEY * y + 10 + yoffset_ce);
10420
10421       ii /= 10;
10422     }
10423   }
10424
10425   for (i = 0; i < NUM_GROUP_ELEMENTS; i++)
10426   {
10427     int x = i % 16;
10428     int y = i / 16;
10429     int ii = i + 1;
10430     int j;
10431
10432     BlitBitmap(src_bitmap, bitmap, 0, 0, TILEX, TILEY,
10433                TILEX * x, TILEY * y + yoffset_ge);
10434
10435     BlitBitmap(src_bitmap, bitmap, 0, TILEY,
10436                TILEX, TILEY,
10437                TILEX * x + TILEX * 16,
10438                TILEY * y + yoffset_ge);
10439
10440     for (j = 1; j >= 0; j--)
10441     {
10442       int c = ii % 10;
10443
10444       BlitBitmap(src_bitmap, bitmap, TILEX + c * 10, 11, 10, 10,
10445                  TILEX * x + 6 + j * 10,
10446                  TILEY * y + 11 + yoffset_ge);
10447
10448       BlitBitmap(src_bitmap, bitmap,
10449                  TILEX + c * 8, TILEY + 12, 6, 10,
10450                  TILEX * 16 + TILEX * x + 10 + j * 8,
10451                  TILEY * y + 10 + yoffset_ge);
10452
10453       ii /= 10;
10454     }
10455   }
10456
10457   if (SDL_SaveBMP(bitmap->surface, dst_filename) != 0)
10458     Error(ERR_EXIT, "cannot save CE graphics file '%s'", dst_filename);
10459
10460   FreeBitmap(bitmap);
10461
10462   CloseAllAndExit(0);
10463 #endif
10464 }