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 //                  https://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 "screens.h"
  22 #include "tools.h"
  23 #include "tape.h"
  24 #include "config.h"
  25 #include "api.h"
  26
  27 #define ENABLE_UNUSED_CODE      0       // currently unused functions
  28 #define ENABLE_HISTORIC_CHUNKS  0       // only for historic reference
  29 #define ENABLE_RESERVED_CODE    0       // reserved for later use
  30
  31 #define CHUNK_ID_LEN            4       // IFF style chunk id length
  32 #define CHUNK_SIZE_UNDEFINED    0       // undefined chunk size == 0
  33 #define CHUNK_SIZE_NONE         -1      // do not write chunk size
  34
  35 #define LEVEL_CHUNK_NAME_SIZE   MAX_LEVEL_NAME_LEN
  36 #define LEVEL_CHUNK_AUTH_SIZE   MAX_LEVEL_AUTHOR_LEN
  37
  38 #define LEVEL_CHUNK_VERS_SIZE   8       // size of file version chunk
  39 #define LEVEL_CHUNK_DATE_SIZE   4       // size of file date chunk
  40 #define LEVEL_CHUNK_HEAD_SIZE   80      // size of level file header
  41 #define LEVEL_CHUNK_HEAD_UNUSED 0       // unused level header bytes
  42 #define LEVEL_CHUNK_CNT2_SIZE   160     // size of level CNT2 chunk
  43 #define LEVEL_CHUNK_CNT2_UNUSED 11      // unused CNT2 chunk bytes
  44 #define LEVEL_CHUNK_CNT3_HEADER 16      // size of level CNT3 header
  45 #define LEVEL_CHUNK_CNT3_UNUSED 10      // unused CNT3 chunk bytes
  46 #define LEVEL_CPART_CUS3_SIZE   134     // size of CUS3 chunk part
  47 #define LEVEL_CPART_CUS3_UNUSED 15      // unused CUS3 bytes / part
  48 #define LEVEL_CHUNK_GRP1_SIZE   74      // size of level GRP1 chunk
  49
  50 // (element number, number of change pages, change page number)
  51 #define LEVEL_CHUNK_CUSX_UNCHANGED      (2 + (1 + 1) + (1 + 1))
  52
  53 // (element number only)
  54 #define LEVEL_CHUNK_GRPX_UNCHANGED      2
  55 #define LEVEL_CHUNK_EMPX_UNCHANGED      2
  56 #define LEVEL_CHUNK_NOTE_UNCHANGED      2
  57
  58 // (nothing at all if unchanged)
  59 #define LEVEL_CHUNK_ELEM_UNCHANGED      0
  60
  61 #define TAPE_CHUNK_VERS_SIZE    8       // size of file version chunk
  62 #define TAPE_CHUNK_HEAD_SIZE    20      // size of tape file header
  63 #define TAPE_CHUNK_SCRN_SIZE    2       // size of screen size chunk
  64
  65 #define SCORE_CHUNK_VERS_SIZE   8       // size of file version chunk
  66
  67 #define LEVEL_CHUNK_CNT3_SIZE(x)         (LEVEL_CHUNK_CNT3_HEADER + (x))
  68 #define LEVEL_CHUNK_CUS3_SIZE(x)         (2 + (x) * LEVEL_CPART_CUS3_SIZE)
  69 #define LEVEL_CHUNK_CUS4_SIZE(x)         (96 + (x) * 48)
  70
  71 // file identifier strings
  72 #define LEVEL_COOKIE_TMPL               "ROCKSNDIAMONDS_LEVEL_FILE_VERSION_x.x"
  73 #define TAPE_COOKIE_TMPL                "ROCKSNDIAMONDS_TAPE_FILE_VERSION_x.x"
  74 #define SCORE_COOKIE_TMPL               "ROCKSNDIAMONDS_SCORE_FILE_VERSION_x.x"
  75
  76 // values for deciding when (not) to save configuration data
  77 #define SAVE_CONF_NEVER                 0
  78 #define SAVE_CONF_ALWAYS                1
  79 #define SAVE_CONF_WHEN_CHANGED          -1
  80
  81 // values for chunks using micro chunks
  82 #define CONF_MASK_1_BYTE                0x00
  83 #define CONF_MASK_2_BYTE                0x40
  84 #define CONF_MASK_4_BYTE                0x80
  85 #define CONF_MASK_MULTI_BYTES           0xc0
  86
  87 #define CONF_MASK_BYTES                 0xc0
  88 #define CONF_MASK_TOKEN                 0x3f
  89
  90 #define CONF_VALUE_1_BYTE(x)            (CONF_MASK_1_BYTE       | (x))
  91 #define CONF_VALUE_2_BYTE(x)            (CONF_MASK_2_BYTE       | (x))
  92 #define CONF_VALUE_4_BYTE(x)            (CONF_MASK_4_BYTE       | (x))
  93 #define CONF_VALUE_MULTI_BYTES(x)       (CONF_MASK_MULTI_BYTES  | (x))
  94
  95 // these definitions are just for convenience of use and readability
  96 #define CONF_VALUE_8_BIT(x)             CONF_VALUE_1_BYTE(x)
  97 #define CONF_VALUE_16_BIT(x)            CONF_VALUE_2_BYTE(x)
  98 #define CONF_VALUE_32_BIT(x)            CONF_VALUE_4_BYTE(x)
  99 #define CONF_VALUE_BYTES(x)             CONF_VALUE_MULTI_BYTES(x)
 100
 101 #define CONF_VALUE_NUM_BYTES(x)         ((x) == CONF_MASK_1_BYTE ? 1 :  \
 102                                          (x) == CONF_MASK_2_BYTE ? 2 :  \
 103                                          (x) == CONF_MASK_4_BYTE ? 4 : 0)
 104
 105 #define CONF_CONTENT_NUM_ELEMENTS       (3 * 3)
 106 #define CONF_CONTENT_NUM_BYTES          (CONF_CONTENT_NUM_ELEMENTS * 2)
 107 #define CONF_ELEMENT_NUM_BYTES          (2)
 108
 109 #define CONF_ENTITY_NUM_BYTES(t)        ((t) == TYPE_ELEMENT ||         \
 110                                          (t) == TYPE_ELEMENT_LIST ?     \
 111                                          CONF_ELEMENT_NUM_BYTES :       \
 112                                          (t) == TYPE_CONTENT ||         \
 113                                          (t) == TYPE_CONTENT_LIST ?     \
 114                                          CONF_CONTENT_NUM_BYTES : 1)
 115
 116 #define CONF_ELEMENT_BYTE_POS(i)        ((i) * CONF_ELEMENT_NUM_BYTES)
 117 #define CONF_ELEMENTS_ELEMENT(b, i)     ((b[CONF_ELEMENT_BYTE_POS(i)] << 8) | \
 118                                         (b[CONF_ELEMENT_BYTE_POS(i) + 1]))
 119
 120 #define CONF_CONTENT_ELEMENT_POS(c,x,y) ((c) * CONF_CONTENT_NUM_ELEMENTS +    \
 121                                          (y) * 3 + (x))
 122 #define CONF_CONTENT_BYTE_POS(c,x,y)    (CONF_CONTENT_ELEMENT_POS(c,x,y) *    \
 123                                          CONF_ELEMENT_NUM_BYTES)
 124 #define CONF_CONTENTS_ELEMENT(b,c,x,y) ((b[CONF_CONTENT_BYTE_POS(c,x,y)]<< 8)|\
 125                                         (b[CONF_CONTENT_BYTE_POS(c,x,y) + 1]))
 126
 127 // temporary variables used to store pointers to structure members
 128 static struct LevelInfo li;
 129 static struct ElementInfo xx_ei, yy_ei;
 130 static struct ElementChangeInfo xx_change;
 131 static struct ElementGroupInfo xx_group;
 132 static struct EnvelopeInfo xx_envelope;
 133 static unsigned int xx_event_bits[NUM_CE_BITFIELDS];
 134 static char xx_default_description[MAX_ELEMENT_NAME_LEN + 1];
 135 static int xx_num_contents;
 136 static int xx_current_change_page;
 137 static char xx_default_string_empty[1] = "";
 138 static int xx_string_length_unused;
 139
 140 struct LevelFileConfigInfo
 141 {
 142   int element;                  // element for which data is to be stored
 143   int save_type;                // save data always, never or when changed
 144   int data_type;                // data type (used internally, not stored)
 145   int conf_type;                // micro chunk identifier (stored in file)
 146
 147   // (mandatory)
 148   void *value;                  // variable that holds the data to be stored
 149   int default_value;            // initial default value for this variable
 150
 151   // (optional)
 152   void *value_copy;             // variable that holds the data to be copied
 153   void *num_entities;           // number of entities for multi-byte data
 154   int default_num_entities;     // default number of entities for this data
 155   int max_num_entities;         // maximal number of entities for this data
 156   char *default_string;         // optional default string for string data
 157 };
 158
 159 static struct LevelFileConfigInfo chunk_config_INFO[] =
 160 {
 161   // ---------- values not related to single elements -------------------------
 162
 163   {
 164     -1,                                 SAVE_CONF_ALWAYS,
 165     TYPE_INTEGER,                       CONF_VALUE_8_BIT(1),
 166     &li.game_engine_type,               GAME_ENGINE_TYPE_RND
 167   },
 168
 169   {
 170     -1,                                 SAVE_CONF_ALWAYS,
 171     TYPE_INTEGER,                       CONF_VALUE_16_BIT(1),
 172     &li.fieldx,                         STD_LEV_FIELDX
 173   },
 174   {
 175     -1,                                 SAVE_CONF_ALWAYS,
 176     TYPE_INTEGER,                       CONF_VALUE_16_BIT(2),
 177     &li.fieldy,                         STD_LEV_FIELDY
 178   },
 179
 180   {
 181     -1,                                 SAVE_CONF_ALWAYS,
 182     TYPE_INTEGER,                       CONF_VALUE_16_BIT(3),
 183     &li.time,                           100
 184   },
 185
 186   {
 187     -1,                                 SAVE_CONF_ALWAYS,
 188     TYPE_INTEGER,                       CONF_VALUE_16_BIT(4),
 189     &li.gems_needed,                    0
 190   },
 191
 192   {
 193     -1,                                 -1,
 194     TYPE_INTEGER,                       CONF_VALUE_32_BIT(2),
 195     &li.random_seed,                    0
 196   },
 197
 198   {
 199     -1,                                 -1,
 200     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(2),
 201     &li.use_step_counter,               FALSE
 202   },
 203
 204   {
 205     -1,                                 -1,
 206     TYPE_BITFIELD,                      CONF_VALUE_8_BIT(4),
 207     &li.wind_direction_initial,         MV_NONE
 208   },
 209
 210   {
 211     -1,                                 -1,
 212     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(5),
 213     &li.em_slippery_gems,               FALSE
 214   },
 215
 216   {
 217     -1,                                 -1,
 218     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(6),
 219     &li.use_custom_template,            FALSE
 220   },
 221
 222   {
 223     -1,                                 -1,
 224     TYPE_BITFIELD,                      CONF_VALUE_32_BIT(1),
 225     &li.can_move_into_acid_bits,        ~0      // default: everything can
 226   },
 227
 228   {
 229     -1,                                 -1,
 230     TYPE_BITFIELD,                      CONF_VALUE_8_BIT(7),
 231     &li.dont_collide_with_bits,         ~0      // default: always deadly
 232   },
 233
 234   {
 235     -1,                                 -1,
 236     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(8),
 237     &li.em_explodes_by_fire,            FALSE
 238   },
 239
 240   {
 241     -1,                                 -1,
 242     TYPE_INTEGER,                       CONF_VALUE_16_BIT(5),
 243     &li.score[SC_TIME_BONUS],           1
 244   },
 245
 246   {
 247     -1,                                 -1,
 248     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(9),
 249     &li.auto_exit_sokoban,              FALSE
 250   },
 251
 252   {
 253     -1,                                 -1,
 254     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(10),
 255     &li.auto_count_gems,                FALSE
 256   },
 257
 258   {
 259     -1,                                 -1,
 260     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(11),
 261     &li.solved_by_one_player,           FALSE
 262   },
 263
 264   {
 265     -1,                                 -1,
 266     TYPE_INTEGER,                       CONF_VALUE_8_BIT(12),
 267     &li.time_score_base,                1
 268   },
 269
 270   {
 271     -1,                                 -1,
 272     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(13),
 273     &li.rate_time_over_score,           FALSE
 274   },
 275
 276   {
 277     -1,                                 -1,
 278     -1,                                 -1,
 279     NULL,                               -1
 280   }
 281 };
 282
 283 static struct LevelFileConfigInfo chunk_config_ELEM[] =
 284 {
 285   // (these values are the same for each player)
 286   {
 287     EL_PLAYER_1,                        -1,
 288     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(1),
 289     &li.block_last_field,               FALSE   // default case for EM levels
 290   },
 291   {
 292     EL_PLAYER_1,                        -1,
 293     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(2),
 294     &li.sp_block_last_field,            TRUE    // default case for SP levels
 295   },
 296   {
 297     EL_PLAYER_1,                        -1,
 298     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(3),
 299     &li.instant_relocation,             FALSE
 300   },
 301   {
 302     EL_PLAYER_1,                        -1,
 303     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(4),
 304     &li.can_pass_to_walkable,           FALSE
 305   },
 306   {
 307     EL_PLAYER_1,                        -1,
 308     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(5),
 309     &li.block_snap_field,               TRUE
 310   },
 311   {
 312     EL_PLAYER_1,                        -1,
 313     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(6),
 314     &li.continuous_snapping,            TRUE
 315   },
 316   {
 317     EL_PLAYER_1,                        -1,
 318     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(12),
 319     &li.shifted_relocation,             FALSE
 320   },
 321   {
 322     EL_PLAYER_1,                        -1,
 323     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(15),
 324     &li.lazy_relocation,                FALSE
 325   },
 326   {
 327     EL_PLAYER_1,                        -1,
 328     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(16),
 329     &li.finish_dig_collect,             TRUE
 330   },
 331   {
 332     EL_PLAYER_1,                        -1,
 333     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(17),
 334     &li.keep_walkable_ce,               FALSE
 335   },
 336
 337   // (these values are different for each player)
 338   {
 339     EL_PLAYER_1,                        -1,
 340     TYPE_INTEGER,                       CONF_VALUE_8_BIT(7),
 341     &li.initial_player_stepsize[0],     STEPSIZE_NORMAL
 342   },
 343   {
 344     EL_PLAYER_1,                        -1,
 345     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(8),
 346     &li.initial_player_gravity[0],      FALSE
 347   },
 348   {
 349     EL_PLAYER_1,                        -1,
 350     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(9),
 351     &li.use_start_element[0],           FALSE
 352   },
 353   {
 354     EL_PLAYER_1,                        -1,
 355     TYPE_ELEMENT,                       CONF_VALUE_16_BIT(1),
 356     &li.start_element[0],               EL_PLAYER_1
 357   },
 358   {
 359     EL_PLAYER_1,                        -1,
 360     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(10),
 361     &li.use_artwork_element[0],         FALSE
 362   },
 363   {
 364     EL_PLAYER_1,                        -1,
 365     TYPE_ELEMENT,                       CONF_VALUE_16_BIT(2),
 366     &li.artwork_element[0],             EL_PLAYER_1
 367   },
 368   {
 369     EL_PLAYER_1,                        -1,
 370     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(11),
 371     &li.use_explosion_element[0],       FALSE
 372   },
 373   {
 374     EL_PLAYER_1,                        -1,
 375     TYPE_ELEMENT,                       CONF_VALUE_16_BIT(3),
 376     &li.explosion_element[0],           EL_PLAYER_1
 377   },
 378   {
 379     EL_PLAYER_1,                        -1,
 380     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(13),
 381     &li.use_initial_inventory[0],       FALSE
 382   },
 383   {
 384     EL_PLAYER_1,                        -1,
 385     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(14),
 386     &li.initial_inventory_size[0],      1
 387   },
 388   {
 389     EL_PLAYER_1,                        -1,
 390     TYPE_ELEMENT_LIST,                  CONF_VALUE_BYTES(1),
 391     &li.initial_inventory_content[0][0],EL_EMPTY, NULL,
 392     &li.initial_inventory_size[0],      1, MAX_INITIAL_INVENTORY_SIZE
 393   },
 394
 395   {
 396     EL_PLAYER_2,                        -1,
 397     TYPE_INTEGER,                       CONF_VALUE_8_BIT(7),
 398     &li.initial_player_stepsize[1],     STEPSIZE_NORMAL
 399   },
 400   {
 401     EL_PLAYER_2,                        -1,
 402     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(8),
 403     &li.initial_player_gravity[1],      FALSE
 404   },
 405   {
 406     EL_PLAYER_2,                        -1,
 407     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(9),
 408     &li.use_start_element[1],           FALSE
 409   },
 410   {
 411     EL_PLAYER_2,                        -1,
 412     TYPE_ELEMENT,                       CONF_VALUE_16_BIT(1),
 413     &li.start_element[1],               EL_PLAYER_2
 414   },
 415   {
 416     EL_PLAYER_2,                        -1,
 417     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(10),
 418     &li.use_artwork_element[1],         FALSE
 419   },
 420   {
 421     EL_PLAYER_2,                        -1,
 422     TYPE_ELEMENT,                       CONF_VALUE_16_BIT(2),
 423     &li.artwork_element[1],             EL_PLAYER_2
 424   },
 425   {
 426     EL_PLAYER_2,                        -1,
 427     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(11),
 428     &li.use_explosion_element[1],       FALSE
 429   },
 430   {
 431     EL_PLAYER_2,                        -1,
 432     TYPE_ELEMENT,                       CONF_VALUE_16_BIT(3),
 433     &li.explosion_element[1],           EL_PLAYER_2
 434   },
 435   {
 436     EL_PLAYER_2,                        -1,
 437     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(13),
 438     &li.use_initial_inventory[1],       FALSE
 439   },
 440   {
 441     EL_PLAYER_2,                        -1,
 442     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(14),
 443     &li.initial_inventory_size[1],      1
 444   },
 445   {
 446     EL_PLAYER_2,                        -1,
 447     TYPE_ELEMENT_LIST,                  CONF_VALUE_BYTES(1),
 448     &li.initial_inventory_content[1][0],EL_EMPTY, NULL,
 449     &li.initial_inventory_size[1],      1, MAX_INITIAL_INVENTORY_SIZE
 450   },
 451
 452   {
 453     EL_PLAYER_3,                        -1,
 454     TYPE_INTEGER,                       CONF_VALUE_8_BIT(7),
 455     &li.initial_player_stepsize[2],     STEPSIZE_NORMAL
 456   },
 457   {
 458     EL_PLAYER_3,                        -1,
 459     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(8),
 460     &li.initial_player_gravity[2],      FALSE
 461   },
 462   {
 463     EL_PLAYER_3,                        -1,
 464     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(9),
 465     &li.use_start_element[2],           FALSE
 466   },
 467   {
 468     EL_PLAYER_3,                        -1,
 469     TYPE_ELEMENT,                       CONF_VALUE_16_BIT(1),
 470     &li.start_element[2],               EL_PLAYER_3
 471   },
 472   {
 473     EL_PLAYER_3,                        -1,
 474     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(10),
 475     &li.use_artwork_element[2],         FALSE
 476   },
 477   {
 478     EL_PLAYER_3,                        -1,
 479     TYPE_ELEMENT,                       CONF_VALUE_16_BIT(2),
 480     &li.artwork_element[2],             EL_PLAYER_3
 481   },
 482   {
 483     EL_PLAYER_3,                        -1,
 484     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(11),
 485     &li.use_explosion_element[2],       FALSE
 486   },
 487   {
 488     EL_PLAYER_3,                        -1,
 489     TYPE_ELEMENT,                       CONF_VALUE_16_BIT(3),
 490     &li.explosion_element[2],           EL_PLAYER_3
 491   },
 492   {
 493     EL_PLAYER_3,                        -1,
 494     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(13),
 495     &li.use_initial_inventory[2],       FALSE
 496   },
 497   {
 498     EL_PLAYER_3,                        -1,
 499     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(14),
 500     &li.initial_inventory_size[2],      1
 501   },
 502   {
 503     EL_PLAYER_3,                        -1,
 504     TYPE_ELEMENT_LIST,                  CONF_VALUE_BYTES(1),
 505     &li.initial_inventory_content[2][0],EL_EMPTY, NULL,
 506     &li.initial_inventory_size[2],      1, MAX_INITIAL_INVENTORY_SIZE
 507   },
 508
 509   {
 510     EL_PLAYER_4,                        -1,
 511     TYPE_INTEGER,                       CONF_VALUE_8_BIT(7),
 512     &li.initial_player_stepsize[3],     STEPSIZE_NORMAL
 513   },
 514   {
 515     EL_PLAYER_4,                        -1,
 516     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(8),
 517     &li.initial_player_gravity[3],      FALSE
 518   },
 519   {
 520     EL_PLAYER_4,                        -1,
 521     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(9),
 522     &li.use_start_element[3],           FALSE
 523   },
 524   {
 525     EL_PLAYER_4,                        -1,
 526     TYPE_ELEMENT,                       CONF_VALUE_16_BIT(1),
 527     &li.start_element[3],               EL_PLAYER_4
 528   },
 529   {
 530     EL_PLAYER_4,                        -1,
 531     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(10),
 532     &li.use_artwork_element[3],         FALSE
 533   },
 534   {
 535     EL_PLAYER_4,                        -1,
 536     TYPE_ELEMENT,                       CONF_VALUE_16_BIT(2),
 537     &li.artwork_element[3],             EL_PLAYER_4
 538   },
 539   {
 540     EL_PLAYER_4,                        -1,
 541     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(11),
 542     &li.use_explosion_element[3],       FALSE
 543   },
 544   {
 545     EL_PLAYER_4,                        -1,
 546     TYPE_ELEMENT,                       CONF_VALUE_16_BIT(3),
 547     &li.explosion_element[3],           EL_PLAYER_4
 548   },
 549   {
 550     EL_PLAYER_4,                        -1,
 551     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(13),
 552     &li.use_initial_inventory[3],       FALSE
 553   },
 554   {
 555     EL_PLAYER_4,                        -1,
 556     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(14),
 557     &li.initial_inventory_size[3],      1
 558   },
 559   {
 560     EL_PLAYER_4,                        -1,
 561     TYPE_ELEMENT_LIST,                  CONF_VALUE_BYTES(1),
 562     &li.initial_inventory_content[3][0],EL_EMPTY, NULL,
 563     &li.initial_inventory_size[3],      1, MAX_INITIAL_INVENTORY_SIZE
 564   },
 565
 566   {
 567     EL_EMERALD,                         -1,
 568     TYPE_INTEGER,                       CONF_VALUE_16_BIT(1),
 569     &li.score[SC_EMERALD],              10
 570   },
 571
 572   {
 573     EL_DIAMOND,                         -1,
 574     TYPE_INTEGER,                       CONF_VALUE_16_BIT(1),
 575     &li.score[SC_DIAMOND],              10
 576   },
 577
 578   {
 579     EL_BUG,                             -1,
 580     TYPE_INTEGER,                       CONF_VALUE_16_BIT(1),
 581     &li.score[SC_BUG],                  10
 582   },
 583
 584   {
 585     EL_SPACESHIP,                       -1,
 586     TYPE_INTEGER,                       CONF_VALUE_16_BIT(1),
 587     &li.score[SC_SPACESHIP],            10
 588   },
 589
 590   {
 591     EL_PACMAN,                          -1,
 592     TYPE_INTEGER,                       CONF_VALUE_16_BIT(1),
 593     &li.score[SC_PACMAN],               10
 594   },
 595
 596   {
 597     EL_NUT,                             -1,
 598     TYPE_INTEGER,                       CONF_VALUE_16_BIT(1),
 599     &li.score[SC_NUT],                  10
 600   },
 601
 602   {
 603     EL_DYNAMITE,                        -1,
 604     TYPE_INTEGER,                       CONF_VALUE_16_BIT(1),
 605     &li.score[SC_DYNAMITE],             10
 606   },
 607
 608   {
 609     EL_KEY_1,                           -1,
 610     TYPE_INTEGER,                       CONF_VALUE_16_BIT(1),
 611     &li.score[SC_KEY],                  10
 612   },
 613
 614   {
 615     EL_PEARL,                           -1,
 616     TYPE_INTEGER,                       CONF_VALUE_16_BIT(1),
 617     &li.score[SC_PEARL],                10
 618   },
 619
 620   {
 621     EL_CRYSTAL,                         -1,
 622     TYPE_INTEGER,                       CONF_VALUE_16_BIT(1),
 623     &li.score[SC_CRYSTAL],              10
 624   },
 625
 626   {
 627     EL_BD_AMOEBA,                       -1,
 628     TYPE_ELEMENT,                       CONF_VALUE_16_BIT(1),
 629     &li.amoeba_content,                 EL_DIAMOND
 630   },
 631   {
 632     EL_BD_AMOEBA,                       -1,
 633     TYPE_INTEGER,                       CONF_VALUE_16_BIT(2),
 634     &li.amoeba_speed,                   10
 635   },
 636   {
 637     EL_BD_AMOEBA,                       -1,
 638     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(1),
 639     &li.grow_into_diggable,             TRUE
 640   },
 641
 642   {
 643     EL_YAMYAM,                          -1,
 644     TYPE_CONTENT_LIST,                  CONF_VALUE_BYTES(1),
 645     &li.yamyam_content,                 EL_ROCK, NULL,
 646     &li.num_yamyam_contents,            4, MAX_ELEMENT_CONTENTS
 647   },
 648   {
 649     EL_YAMYAM,                          -1,
 650     TYPE_INTEGER,                       CONF_VALUE_16_BIT(1),
 651     &li.score[SC_YAMYAM],               10
 652   },
 653
 654   {
 655     EL_ROBOT,                           -1,
 656     TYPE_INTEGER,                       CONF_VALUE_16_BIT(1),
 657     &li.score[SC_ROBOT],                10
 658   },
 659   {
 660     EL_ROBOT,                           -1,
 661     TYPE_INTEGER,                       CONF_VALUE_16_BIT(2),
 662     &li.slurp_score,                    10
 663   },
 664
 665   {
 666     EL_ROBOT_WHEEL,                     -1,
 667     TYPE_INTEGER,                       CONF_VALUE_16_BIT(1),
 668     &li.time_wheel,                     10
 669   },
 670
 671   {
 672     EL_MAGIC_WALL,                      -1,
 673     TYPE_INTEGER,                       CONF_VALUE_16_BIT(1),
 674     &li.time_magic_wall,                10
 675   },
 676
 677   {
 678     EL_GAME_OF_LIFE,                    -1,
 679     TYPE_INTEGER,                       CONF_VALUE_8_BIT(1),
 680     &li.game_of_life[0],                2
 681   },
 682   {
 683     EL_GAME_OF_LIFE,                    -1,
 684     TYPE_INTEGER,                       CONF_VALUE_8_BIT(2),
 685     &li.game_of_life[1],                3
 686   },
 687   {
 688     EL_GAME_OF_LIFE,                    -1,
 689     TYPE_INTEGER,                       CONF_VALUE_8_BIT(3),
 690     &li.game_of_life[2],                3
 691   },
 692   {
 693     EL_GAME_OF_LIFE,                    -1,
 694     TYPE_INTEGER,                       CONF_VALUE_8_BIT(4),
 695     &li.game_of_life[3],                3
 696   },
 697   {
 698     EL_GAME_OF_LIFE,                    -1,
 699     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(5),
 700     &li.use_life_bugs,                  FALSE
 701   },
 702
 703   {
 704     EL_BIOMAZE,                         -1,
 705     TYPE_INTEGER,                       CONF_VALUE_8_BIT(1),
 706     &li.biomaze[0],                     2
 707   },
 708   {
 709     EL_BIOMAZE,                         -1,
 710     TYPE_INTEGER,                       CONF_VALUE_8_BIT(2),
 711     &li.biomaze[1],                     3
 712   },
 713   {
 714     EL_BIOMAZE,                         -1,
 715     TYPE_INTEGER,                       CONF_VALUE_8_BIT(3),
 716     &li.biomaze[2],                     3
 717   },
 718   {
 719     EL_BIOMAZE,                         -1,
 720     TYPE_INTEGER,                       CONF_VALUE_8_BIT(4),
 721     &li.biomaze[3],                     3
 722   },
 723
 724   {
 725     EL_TIMEGATE_SWITCH,                 -1,
 726     TYPE_INTEGER,                       CONF_VALUE_16_BIT(1),
 727     &li.time_timegate,                  10
 728   },
 729
 730   {
 731     EL_LIGHT_SWITCH_ACTIVE,             -1,
 732     TYPE_INTEGER,                       CONF_VALUE_16_BIT(1),
 733     &li.time_light,                     10
 734   },
 735
 736   {
 737     EL_SHIELD_NORMAL,                   -1,
 738     TYPE_INTEGER,                       CONF_VALUE_16_BIT(1),
 739     &li.shield_normal_time,             10
 740   },
 741   {
 742     EL_SHIELD_NORMAL,                   -1,
 743     TYPE_INTEGER,                       CONF_VALUE_16_BIT(2),
 744     &li.score[SC_SHIELD],               10
 745   },
 746
 747   {
 748     EL_SHIELD_DEADLY,                   -1,
 749     TYPE_INTEGER,                       CONF_VALUE_16_BIT(1),
 750     &li.shield_deadly_time,             10
 751   },
 752   {
 753     EL_SHIELD_DEADLY,                   -1,
 754     TYPE_INTEGER,                       CONF_VALUE_16_BIT(2),
 755     &li.score[SC_SHIELD],               10
 756   },
 757
 758   {
 759     EL_EXTRA_TIME,                      -1,
 760     TYPE_INTEGER,                       CONF_VALUE_16_BIT(1),
 761     &li.extra_time,                     10
 762   },
 763   {
 764     EL_EXTRA_TIME,                      -1,
 765     TYPE_INTEGER,                       CONF_VALUE_16_BIT(2),
 766     &li.extra_time_score,               10
 767   },
 768
 769   {
 770     EL_TIME_ORB_FULL,                   -1,
 771     TYPE_INTEGER,                       CONF_VALUE_16_BIT(1),
 772     &li.time_orb_time,                  10
 773   },
 774   {
 775     EL_TIME_ORB_FULL,                   -1,
 776     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(1),
 777     &li.use_time_orb_bug,               FALSE
 778   },
 779
 780   {
 781     EL_SPRING,                          -1,
 782     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(1),
 783     &li.use_spring_bug,                 FALSE
 784   },
 785
 786   {
 787     EL_EMC_ANDROID,                     -1,
 788     TYPE_INTEGER,                       CONF_VALUE_16_BIT(1),
 789     &li.android_move_time,              10
 790   },
 791   {
 792     EL_EMC_ANDROID,                     -1,
 793     TYPE_INTEGER,                       CONF_VALUE_16_BIT(2),
 794     &li.android_clone_time,             10
 795   },
 796   {
 797     EL_EMC_ANDROID,                     SAVE_CONF_NEVER,
 798     TYPE_ELEMENT_LIST,                  CONF_VALUE_BYTES(1),
 799     &li.android_clone_element[0],       EL_EMPTY, NULL,
 800     &li.num_android_clone_elements,     1, MAX_ANDROID_ELEMENTS_OLD
 801   },
 802   {
 803     EL_EMC_ANDROID,                     -1,
 804     TYPE_ELEMENT_LIST,                  CONF_VALUE_BYTES(2),
 805     &li.android_clone_element[0],       EL_EMPTY, NULL,
 806     &li.num_android_clone_elements,     1, MAX_ANDROID_ELEMENTS
 807   },
 808
 809   {
 810     EL_EMC_LENSES,                      -1,
 811     TYPE_INTEGER,                       CONF_VALUE_16_BIT(1),
 812     &li.lenses_score,                   10
 813   },
 814   {
 815     EL_EMC_LENSES,                      -1,
 816     TYPE_INTEGER,                       CONF_VALUE_16_BIT(2),
 817     &li.lenses_time,                    10
 818   },
 819
 820   {
 821     EL_EMC_MAGNIFIER,                   -1,
 822     TYPE_INTEGER,                       CONF_VALUE_16_BIT(1),
 823     &li.magnify_score,                  10
 824   },
 825   {
 826     EL_EMC_MAGNIFIER,                   -1,
 827     TYPE_INTEGER,                       CONF_VALUE_16_BIT(2),
 828     &li.magnify_time,                   10
 829   },
 830
 831   {
 832     EL_EMC_MAGIC_BALL,                  -1,
 833     TYPE_INTEGER,                       CONF_VALUE_16_BIT(1),
 834     &li.ball_time,                      10
 835   },
 836   {
 837     EL_EMC_MAGIC_BALL,                  -1,
 838     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(1),
 839     &li.ball_random,                    FALSE
 840   },
 841   {
 842     EL_EMC_MAGIC_BALL,                  -1,
 843     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(2),
 844     &li.ball_active_initial,            FALSE
 845   },
 846   {
 847     EL_EMC_MAGIC_BALL,                  -1,
 848     TYPE_CONTENT_LIST,                  CONF_VALUE_BYTES(1),
 849     &li.ball_content,                   EL_EMPTY, NULL,
 850     &li.num_ball_contents,              4, MAX_ELEMENT_CONTENTS
 851   },
 852
 853   {
 854     EL_SOKOBAN_FIELD_EMPTY,             -1,
 855     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(1),
 856     &li.sb_fields_needed,               TRUE
 857   },
 858
 859   {
 860     EL_SOKOBAN_OBJECT,                  -1,
 861     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(1),
 862     &li.sb_objects_needed,              TRUE
 863   },
 864
 865   {
 866     EL_MM_MCDUFFIN,                     -1,
 867     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(1),
 868     &li.mm_laser_red,                   FALSE
 869   },
 870   {
 871     EL_MM_MCDUFFIN,                     -1,
 872     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(2),
 873     &li.mm_laser_green,                 FALSE
 874   },
 875   {
 876     EL_MM_MCDUFFIN,                     -1,
 877     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(3),
 878     &li.mm_laser_blue,                  TRUE
 879   },
 880
 881   {
 882     EL_DF_LASER,                        -1,
 883     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(1),
 884     &li.df_laser_red,                   TRUE
 885   },
 886   {
 887     EL_DF_LASER,                        -1,
 888     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(2),
 889     &li.df_laser_green,                 TRUE
 890   },
 891   {
 892     EL_DF_LASER,                        -1,
 893     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(3),
 894     &li.df_laser_blue,                  FALSE
 895   },
 896
 897   {
 898     EL_MM_FUSE_ACTIVE,                  -1,
 899     TYPE_INTEGER,                       CONF_VALUE_16_BIT(1),
 900     &li.mm_time_fuse,                   25
 901   },
 902   {
 903     EL_MM_BOMB,                         -1,
 904     TYPE_INTEGER,                       CONF_VALUE_16_BIT(1),
 905     &li.mm_time_bomb,                   75
 906   },
 907
 908   {
 909     EL_MM_GRAY_BALL,                    -1,
 910     TYPE_INTEGER,                       CONF_VALUE_16_BIT(1),
 911     &li.mm_time_ball,                   75
 912   },
 913   {
 914     EL_MM_GRAY_BALL,                    -1,
 915     TYPE_INTEGER,                       CONF_VALUE_8_BIT(1),
 916     &li.mm_ball_choice_mode,            ANIM_RANDOM
 917   },
 918   {
 919     EL_MM_GRAY_BALL,                    -1,
 920     TYPE_ELEMENT_LIST,                  CONF_VALUE_BYTES(1),
 921     &li.mm_ball_content,                EL_EMPTY, NULL,
 922     &li.num_mm_ball_contents,           8, MAX_MM_BALL_CONTENTS
 923   },
 924   {
 925     EL_MM_GRAY_BALL,                    -1,
 926     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(3),
 927     &li.rotate_mm_ball_content,         TRUE
 928   },
 929   {
 930     EL_MM_GRAY_BALL,                    -1,
 931     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(2),
 932     &li.explode_mm_ball,                FALSE
 933   },
 934
 935   {
 936     EL_MM_STEEL_BLOCK,                  -1,
 937     TYPE_INTEGER,                       CONF_VALUE_16_BIT(1),
 938     &li.mm_time_block,                  75
 939   },
 940   {
 941     EL_MM_LIGHTBALL,                    -1,
 942     TYPE_INTEGER,                       CONF_VALUE_16_BIT(1),
 943     &li.score[SC_ELEM_BONUS],           10
 944   },
 945
 946   // ---------- unused values -------------------------------------------------
 947
 948   {
 949     EL_UNKNOWN,                         SAVE_CONF_NEVER,
 950     TYPE_INTEGER,                       CONF_VALUE_16_BIT(1),
 951     &li.score[SC_UNKNOWN_15],           10
 952   },
 953
 954   {
 955     -1,                                 -1,
 956     -1,                                 -1,
 957     NULL,                               -1
 958   }
 959 };
 960
 961 static struct LevelFileConfigInfo chunk_config_NOTE[] =
 962 {
 963   {
 964     -1,                                 -1,
 965     TYPE_INTEGER,                       CONF_VALUE_8_BIT(1),
 966     &xx_envelope.xsize,                 MAX_ENVELOPE_XSIZE,
 967   },
 968   {
 969     -1,                                 -1,
 970     TYPE_INTEGER,                       CONF_VALUE_8_BIT(2),
 971     &xx_envelope.ysize,                 MAX_ENVELOPE_YSIZE,
 972   },
 973
 974   {
 975     -1,                                 -1,
 976     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(3),
 977     &xx_envelope.autowrap,              FALSE
 978   },
 979   {
 980     -1,                                 -1,
 981     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(4),
 982     &xx_envelope.centered,              FALSE
 983   },
 984
 985   {
 986     -1,                                 -1,
 987     TYPE_STRING,                        CONF_VALUE_BYTES(1),
 988     &xx_envelope.text,                  -1, NULL,
 989     &xx_string_length_unused,           -1, MAX_ENVELOPE_TEXT_LEN,
 990     &xx_default_string_empty[0]
 991   },
 992
 993   {
 994     -1,                                 -1,
 995     -1,                                 -1,
 996     NULL,                               -1
 997   }
 998 };
 999
1000 static struct LevelFileConfigInfo chunk_config_CUSX_base[] =
1001 {
1002   {
1003     -1,                                 -1,
1004     TYPE_STRING,                        CONF_VALUE_BYTES(1),
1005     &xx_ei.description[0],              -1,
1006     &yy_ei.description[0],
1007     &xx_string_length_unused,           -1, MAX_ELEMENT_NAME_LEN,
1008     &xx_default_description[0]
1009   },
1010
1011   {
1012     -1,                                 -1,
1013     TYPE_BITFIELD,                      CONF_VALUE_32_BIT(1),
1014     &xx_ei.properties[EP_BITFIELD_BASE_NR], EP_BITMASK_BASE_DEFAULT,
1015     &yy_ei.properties[EP_BITFIELD_BASE_NR]
1016   },
1017 #if ENABLE_RESERVED_CODE
1018   // (reserved for later use)
1019   {
1020     -1,                                 -1,
1021     TYPE_BITFIELD,                      CONF_VALUE_32_BIT(2),
1022     &xx_ei.properties[EP_BITFIELD_BASE_NR + 1], EP_BITMASK_DEFAULT,
1023     &yy_ei.properties[EP_BITFIELD_BASE_NR + 1]
1024   },
1025 #endif
1026
1027   {
1028     -1,                                 -1,
1029     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(1),
1030     &xx_ei.use_gfx_element,             FALSE,
1031     &yy_ei.use_gfx_element
1032   },
1033   {
1034     -1,                                 -1,
1035     TYPE_ELEMENT,                       CONF_VALUE_16_BIT(1),
1036     &xx_ei.gfx_element_initial,         EL_EMPTY_SPACE,
1037     &yy_ei.gfx_element_initial
1038   },
1039
1040   {
1041     -1,                                 -1,
1042     TYPE_BITFIELD,                      CONF_VALUE_8_BIT(2),
1043     &xx_ei.access_direction,            MV_ALL_DIRECTIONS,
1044     &yy_ei.access_direction
1045   },
1046
1047   {
1048     -1,                                 -1,
1049     TYPE_INTEGER,                       CONF_VALUE_16_BIT(2),
1050     &xx_ei.collect_score_initial,       10,
1051     &yy_ei.collect_score_initial
1052   },
1053   {
1054     -1,                                 -1,
1055     TYPE_INTEGER,                       CONF_VALUE_16_BIT(3),
1056     &xx_ei.collect_count_initial,       1,
1057     &yy_ei.collect_count_initial
1058   },
1059
1060   {
1061     -1,                                 -1,
1062     TYPE_INTEGER,                       CONF_VALUE_16_BIT(4),
1063     &xx_ei.ce_value_fixed_initial,      0,
1064     &yy_ei.ce_value_fixed_initial
1065   },
1066   {
1067     -1,                                 -1,
1068     TYPE_INTEGER,                       CONF_VALUE_16_BIT(5),
1069     &xx_ei.ce_value_random_initial,     0,
1070     &yy_ei.ce_value_random_initial
1071   },
1072   {
1073     -1,                                 -1,
1074     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(3),
1075     &xx_ei.use_last_ce_value,           FALSE,
1076     &yy_ei.use_last_ce_value
1077   },
1078
1079   {
1080     -1,                                 -1,
1081     TYPE_INTEGER,                       CONF_VALUE_16_BIT(6),
1082     &xx_ei.push_delay_fixed,            8,
1083     &yy_ei.push_delay_fixed
1084   },
1085   {
1086     -1,                                 -1,
1087     TYPE_INTEGER,                       CONF_VALUE_16_BIT(7),
1088     &xx_ei.push_delay_random,           8,
1089     &yy_ei.push_delay_random
1090   },
1091   {
1092     -1,                                 -1,
1093     TYPE_INTEGER,                       CONF_VALUE_16_BIT(8),
1094     &xx_ei.drop_delay_fixed,            0,
1095     &yy_ei.drop_delay_fixed
1096   },
1097   {
1098     -1,                                 -1,
1099     TYPE_INTEGER,                       CONF_VALUE_16_BIT(9),
1100     &xx_ei.drop_delay_random,           0,
1101     &yy_ei.drop_delay_random
1102   },
1103   {
1104     -1,                                 -1,
1105     TYPE_INTEGER,                       CONF_VALUE_16_BIT(10),
1106     &xx_ei.move_delay_fixed,            0,
1107     &yy_ei.move_delay_fixed
1108   },
1109   {
1110     -1,                                 -1,
1111     TYPE_INTEGER,                       CONF_VALUE_16_BIT(11),
1112     &xx_ei.move_delay_random,           0,
1113     &yy_ei.move_delay_random
1114   },
1115   {
1116     -1,                                 -1,
1117     TYPE_INTEGER,                       CONF_VALUE_16_BIT(16),
1118     &xx_ei.step_delay_fixed,            0,
1119     &yy_ei.step_delay_fixed
1120   },
1121   {
1122     -1,                                 -1,
1123     TYPE_INTEGER,                       CONF_VALUE_16_BIT(17),
1124     &xx_ei.step_delay_random,           0,
1125     &yy_ei.step_delay_random
1126   },
1127
1128   {
1129     -1,                                 -1,
1130     TYPE_BITFIELD,                      CONF_VALUE_32_BIT(3),
1131     &xx_ei.move_pattern,                MV_ALL_DIRECTIONS,
1132     &yy_ei.move_pattern
1133   },
1134   {
1135     -1,                                 -1,
1136     TYPE_BITFIELD,                      CONF_VALUE_8_BIT(4),
1137     &xx_ei.move_direction_initial,      MV_START_AUTOMATIC,
1138     &yy_ei.move_direction_initial
1139   },
1140   {
1141     -1,                                 -1,
1142     TYPE_INTEGER,                       CONF_VALUE_8_BIT(5),
1143     &xx_ei.move_stepsize,               TILEX / 8,
1144     &yy_ei.move_stepsize
1145   },
1146
1147   {
1148     -1,                                 -1,
1149     TYPE_ELEMENT,                       CONF_VALUE_16_BIT(12),
1150     &xx_ei.move_enter_element,          EL_EMPTY_SPACE,
1151     &yy_ei.move_enter_element
1152   },
1153   {
1154     -1,                                 -1,
1155     TYPE_ELEMENT,                       CONF_VALUE_16_BIT(13),
1156     &xx_ei.move_leave_element,          EL_EMPTY_SPACE,
1157     &yy_ei.move_leave_element
1158   },
1159   {
1160     -1,                                 -1,
1161     TYPE_INTEGER,                       CONF_VALUE_8_BIT(6),
1162     &xx_ei.move_leave_type,             LEAVE_TYPE_UNLIMITED,
1163     &yy_ei.move_leave_type
1164   },
1165
1166   {
1167     -1,                                 -1,
1168     TYPE_INTEGER,                       CONF_VALUE_8_BIT(7),
1169     &xx_ei.slippery_type,               SLIPPERY_ANY_RANDOM,
1170     &yy_ei.slippery_type
1171   },
1172
1173   {
1174     -1,                                 -1,
1175     TYPE_INTEGER,                       CONF_VALUE_8_BIT(8),
1176     &xx_ei.explosion_type,              EXPLODES_3X3,
1177     &yy_ei.explosion_type
1178   },
1179   {
1180     -1,                                 -1,
1181     TYPE_INTEGER,                       CONF_VALUE_16_BIT(14),
1182     &xx_ei.explosion_delay,             16,
1183     &yy_ei.explosion_delay
1184   },
1185   {
1186     -1,                                 -1,
1187     TYPE_INTEGER,                       CONF_VALUE_16_BIT(15),
1188     &xx_ei.ignition_delay,              8,
1189     &yy_ei.ignition_delay
1190   },
1191
1192   {
1193     -1,                                 -1,
1194     TYPE_CONTENT_LIST,                  CONF_VALUE_BYTES(2),
1195     &xx_ei.content,                     EL_EMPTY_SPACE,
1196     &yy_ei.content,
1197     &xx_num_contents,                   1, 1
1198   },
1199
1200   // ---------- "num_change_pages" must be the last entry ---------------------
1201
1202   {
1203     -1,                                 SAVE_CONF_ALWAYS,
1204     TYPE_INTEGER,                       CONF_VALUE_8_BIT(9),
1205     &xx_ei.num_change_pages,            1,
1206     &yy_ei.num_change_pages
1207   },
1208
1209   {
1210     -1,                                 -1,
1211     -1,                                 -1,
1212     NULL,                               -1,
1213     NULL
1214   }
1215 };
1216
1217 static struct LevelFileConfigInfo chunk_config_CUSX_change[] =
1218 {
1219   // ---------- "current_change_page" must be the first entry -----------------
1220
1221   {
1222     -1,                                 SAVE_CONF_ALWAYS,
1223     TYPE_INTEGER,                       CONF_VALUE_8_BIT(1),
1224     &xx_current_change_page,            -1
1225   },
1226
1227   // ---------- (the remaining entries can be in any order) -------------------
1228
1229   {
1230     -1,                                 -1,
1231     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(2),
1232     &xx_change.can_change,              FALSE
1233   },
1234
1235   {
1236     -1,                                 -1,
1237     TYPE_BITFIELD,                      CONF_VALUE_32_BIT(1),
1238     &xx_event_bits[0],                  0
1239   },
1240   {
1241     -1,                                 -1,
1242     TYPE_BITFIELD,                      CONF_VALUE_32_BIT(2),
1243     &xx_event_bits[1],                  0
1244   },
1245
1246   {
1247     -1,                                 -1,
1248     TYPE_BITFIELD,                      CONF_VALUE_8_BIT(3),
1249     &xx_change.trigger_player,          CH_PLAYER_ANY
1250   },
1251   {
1252     -1,                                 -1,
1253     TYPE_BITFIELD,                      CONF_VALUE_8_BIT(4),
1254     &xx_change.trigger_side,            CH_SIDE_ANY
1255   },
1256   {
1257     -1,                                 -1,
1258     TYPE_BITFIELD,                      CONF_VALUE_32_BIT(3),
1259     &xx_change.trigger_page,            CH_PAGE_ANY
1260   },
1261
1262   {
1263     -1,                                 -1,
1264     TYPE_ELEMENT,                       CONF_VALUE_16_BIT(1),
1265     &xx_change.target_element,          EL_EMPTY_SPACE
1266   },
1267
1268   {
1269     -1,                                 -1,
1270     TYPE_INTEGER,                       CONF_VALUE_16_BIT(2),
1271     &xx_change.delay_fixed,             0
1272   },
1273   {
1274     -1,                                 -1,
1275     TYPE_INTEGER,                       CONF_VALUE_16_BIT(3),
1276     &xx_change.delay_random,            0
1277   },
1278   {
1279     -1,                                 -1,
1280     TYPE_INTEGER,                       CONF_VALUE_16_BIT(4),
1281     &xx_change.delay_frames,            FRAMES_PER_SECOND
1282   },
1283
1284   {
1285     -1,                                 -1,
1286     TYPE_ELEMENT,                       CONF_VALUE_16_BIT(5),
1287     &xx_change.initial_trigger_element, EL_EMPTY_SPACE
1288   },
1289
1290   {
1291     -1,                                 -1,
1292     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(6),
1293     &xx_change.explode,                 FALSE
1294   },
1295   {
1296     -1,                                 -1,
1297     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(7),
1298     &xx_change.use_target_content,      FALSE
1299   },
1300   {
1301     -1,                                 -1,
1302     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(8),
1303     &xx_change.only_if_complete,        FALSE
1304   },
1305   {
1306     -1,                                 -1,
1307     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(9),
1308     &xx_change.use_random_replace,      FALSE
1309   },
1310   {
1311     -1,                                 -1,
1312     TYPE_INTEGER,                       CONF_VALUE_8_BIT(10),
1313     &xx_change.random_percentage,       100
1314   },
1315   {
1316     -1,                                 -1,
1317     TYPE_INTEGER,                       CONF_VALUE_8_BIT(11),
1318     &xx_change.replace_when,            CP_WHEN_EMPTY
1319   },
1320
1321   {
1322     -1,                                 -1,
1323     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(12),
1324     &xx_change.has_action,              FALSE
1325   },
1326   {
1327     -1,                                 -1,
1328     TYPE_INTEGER,                       CONF_VALUE_8_BIT(13),
1329     &xx_change.action_type,             CA_NO_ACTION
1330   },
1331   {
1332     -1,                                 -1,
1333     TYPE_INTEGER,                       CONF_VALUE_8_BIT(14),
1334     &xx_change.action_mode,             CA_MODE_UNDEFINED
1335   },
1336   {
1337     -1,                                 -1,
1338     TYPE_INTEGER,                       CONF_VALUE_16_BIT(6),
1339     &xx_change.action_arg,              CA_ARG_UNDEFINED
1340   },
1341
1342   {
1343     -1,                                 -1,
1344     TYPE_ELEMENT,                       CONF_VALUE_16_BIT(7),
1345     &xx_change.action_element,          EL_EMPTY_SPACE
1346   },
1347
1348   {
1349     -1,                                 -1,
1350     TYPE_CONTENT_LIST,                  CONF_VALUE_BYTES(1),
1351     &xx_change.target_content,          EL_EMPTY_SPACE, NULL,
1352     &xx_num_contents,                   1, 1
1353   },
1354
1355   {
1356     -1,                                 -1,
1357     -1,                                 -1,
1358     NULL,                               -1
1359   }
1360 };
1361
1362 static struct LevelFileConfigInfo chunk_config_GRPX[] =
1363 {
1364   {
1365     -1,                                 -1,
1366     TYPE_STRING,                        CONF_VALUE_BYTES(1),
1367     &xx_ei.description[0],              -1, NULL,
1368     &xx_string_length_unused,           -1, MAX_ELEMENT_NAME_LEN,
1369     &xx_default_description[0]
1370   },
1371
1372   {
1373     -1,                                 -1,
1374     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(1),
1375     &xx_ei.use_gfx_element,             FALSE
1376   },
1377   {
1378     -1,                                 -1,
1379     TYPE_ELEMENT,                       CONF_VALUE_16_BIT(1),
1380     &xx_ei.gfx_element_initial,         EL_EMPTY_SPACE
1381   },
1382
1383   {
1384     -1,                                 -1,
1385     TYPE_INTEGER,                       CONF_VALUE_8_BIT(2),
1386     &xx_group.choice_mode,              ANIM_RANDOM
1387   },
1388
1389   {
1390     -1,                                 -1,
1391     TYPE_ELEMENT_LIST,                  CONF_VALUE_BYTES(2),
1392     &xx_group.element[0],               EL_EMPTY_SPACE, NULL,
1393     &xx_group.num_elements,             1, MAX_ELEMENTS_IN_GROUP
1394   },
1395
1396   {
1397     -1,                                 -1,
1398     -1,                                 -1,
1399     NULL,                               -1
1400   }
1401 };
1402
1403 static struct LevelFileConfigInfo chunk_config_EMPX[] =
1404 {
1405   {
1406     -1,                                 -1,
1407     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(1),
1408     &xx_ei.use_gfx_element,             FALSE
1409   },
1410   {
1411     -1,                                 -1,
1412     TYPE_ELEMENT,                       CONF_VALUE_16_BIT(1),
1413     &xx_ei.gfx_element_initial,         EL_EMPTY_SPACE
1414   },
1415
1416   {
1417     -1,                                 -1,
1418     -1,                                 -1,
1419     NULL,                               -1
1420   }
1421 };
1422
1423 static struct LevelFileConfigInfo chunk_config_CONF[] =         // (OBSOLETE)
1424 {
1425   {
1426     EL_PLAYER_1,                        -1,
1427     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(9),
1428     &li.block_snap_field,               TRUE
1429   },
1430   {
1431     EL_PLAYER_1,                        -1,
1432     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(13),
1433     &li.continuous_snapping,            TRUE
1434   },
1435   {
1436     EL_PLAYER_1,                        -1,
1437     TYPE_INTEGER,                       CONF_VALUE_8_BIT(1),
1438     &li.initial_player_stepsize[0],     STEPSIZE_NORMAL
1439   },
1440   {
1441     EL_PLAYER_1,                        -1,
1442     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(10),
1443     &li.use_start_element[0],           FALSE
1444   },
1445   {
1446     EL_PLAYER_1,                        -1,
1447     TYPE_ELEMENT,                       CONF_VALUE_16_BIT(1),
1448     &li.start_element[0],               EL_PLAYER_1
1449   },
1450   {
1451     EL_PLAYER_1,                        -1,
1452     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(11),
1453     &li.use_artwork_element[0],         FALSE
1454   },
1455   {
1456     EL_PLAYER_1,                        -1,
1457     TYPE_ELEMENT,                       CONF_VALUE_16_BIT(2),
1458     &li.artwork_element[0],             EL_PLAYER_1
1459   },
1460   {
1461     EL_PLAYER_1,                        -1,
1462     TYPE_BOOLEAN,                       CONF_VALUE_8_BIT(12),
1463     &li.use_explosion_element[0],       FALSE
1464   },
1465   {
1466     EL_PLAYER_1,                        -1,
1467     TYPE_ELEMENT,                       CONF_VALUE_16_BIT(3),
1468     &li.explosion_element[0],           EL_PLAYER_1
1469   },
1470
1471   {
1472     -1,                                 -1,
1473     -1,                                 -1,
1474     NULL,                               -1
1475   }
1476 };
1477
1478 static struct
1479 {
1480   int filetype;
1481   char *id;
1482 }
1483 filetype_id_list[] =
1484 {
1485   { LEVEL_FILE_TYPE_RND,        "RND"   },
1486   { LEVEL_FILE_TYPE_BD,         "BD"    },
1487   { LEVEL_FILE_TYPE_EM,         "EM"    },
1488   { LEVEL_FILE_TYPE_SP,         "SP"    },
1489   { LEVEL_FILE_TYPE_DX,         "DX"    },
1490   { LEVEL_FILE_TYPE_SB,         "SB"    },
1491   { LEVEL_FILE_TYPE_DC,         "DC"    },
1492   { LEVEL_FILE_TYPE_MM,         "MM"    },
1493   { LEVEL_FILE_TYPE_MM,         "DF"    },
1494   { -1,                         NULL    },
1495 };
1496
1497
1498 // ============================================================================
1499 // level file functions
1500 // ============================================================================
1501
1502 static boolean check_special_flags(char *flag)
1503 {
1504   if (strEqual(options.special_flags, flag) ||
1505       strEqual(leveldir_current->special_flags, flag))
1506     return TRUE;
1507
1508   return FALSE;
1509 }
1510
1511 static struct DateInfo getCurrentDate(void)
1512 {
1513   time_t epoch_seconds = time(NULL);
1514   struct tm *now = localtime(&epoch_seconds);
1515   struct DateInfo date;
1516
1517   date.year  = now->tm_year + 1900;
1518   date.month = now->tm_mon  + 1;
1519   date.day   = now->tm_mday;
1520
1521   date.src   = DATE_SRC_CLOCK;
1522
1523   return date;
1524 }
1525
1526 static void resetEventFlags(struct ElementChangeInfo *change)
1527 {
1528   int i;
1529
1530   for (i = 0; i < NUM_CHANGE_EVENTS; i++)
1531     change->has_event[i] = FALSE;
1532 }
1533
1534 static void resetEventBits(void)
1535 {
1536   int i;
1537
1538   for (i = 0; i < NUM_CE_BITFIELDS; i++)
1539     xx_event_bits[i] = 0;
1540 }
1541
1542 static void setEventFlagsFromEventBits(struct ElementChangeInfo *change)
1543 {
1544   int i;
1545
1546   /* important: only change event flag if corresponding event bit is set
1547      (this is because all xx_event_bits[] values are loaded separately,
1548      and all xx_event_bits[] values are set back to zero before loading
1549      another value xx_event_bits[x] (each value representing 32 flags)) */
1550
1551   for (i = 0; i < NUM_CHANGE_EVENTS; i++)
1552     if (xx_event_bits[CH_EVENT_BITFIELD_NR(i)] & CH_EVENT_BIT(i))
1553       change->has_event[i] = TRUE;
1554 }
1555
1556 static void setEventBitsFromEventFlags(struct ElementChangeInfo *change)
1557 {
1558   int i;
1559
1560   /* in contrast to the above function setEventFlagsFromEventBits(), it
1561      would also be possible to set all bits in xx_event_bits[] to 0 or 1
1562      depending on the corresponding change->has_event[i] values here, as
1563      all xx_event_bits[] values are reset in resetEventBits() before */
1564
1565   for (i = 0; i < NUM_CHANGE_EVENTS; i++)
1566     if (change->has_event[i])
1567       xx_event_bits[CH_EVENT_BITFIELD_NR(i)] |= CH_EVENT_BIT(i);
1568 }
1569
1570 static char *getDefaultElementDescription(struct ElementInfo *ei)
1571 {
1572   static char description[MAX_ELEMENT_NAME_LEN + 1];
1573   char *default_description = (ei->custom_description != NULL ?
1574                                ei->custom_description :
1575                                ei->editor_description);
1576   int i;
1577
1578   // always start with reliable default values
1579   for (i = 0; i < MAX_ELEMENT_NAME_LEN + 1; i++)
1580     description[i] = '\0';
1581
1582   // truncate element description to MAX_ELEMENT_NAME_LEN bytes
1583   strncpy(description, default_description, MAX_ELEMENT_NAME_LEN);
1584
1585   return &description[0];
1586 }
1587
1588 static void setElementDescriptionToDefault(struct ElementInfo *ei)
1589 {
1590   char *default_description = getDefaultElementDescription(ei);
1591   int i;
1592
1593   for (i = 0; i < MAX_ELEMENT_NAME_LEN + 1; i++)
1594     ei->description[i] = default_description[i];
1595 }
1596
1597 static void setConfigToDefaultsFromConfigList(struct LevelFileConfigInfo *conf)
1598 {
1599   int i;
1600
1601   for (i = 0; conf[i].data_type != -1; i++)
1602   {
1603     int default_value = conf[i].default_value;
1604     int data_type = conf[i].data_type;
1605     int conf_type = conf[i].conf_type;
1606     int byte_mask = conf_type & CONF_MASK_BYTES;
1607
1608     if (byte_mask == CONF_MASK_MULTI_BYTES)
1609     {
1610       int default_num_entities = conf[i].default_num_entities;
1611       int max_num_entities = conf[i].max_num_entities;
1612
1613       *(int *)(conf[i].num_entities) = default_num_entities;
1614
1615       if (data_type == TYPE_STRING)
1616       {
1617         char *default_string = conf[i].default_string;
1618         char *string = (char *)(conf[i].value);
1619
1620         strncpy(string, default_string, max_num_entities);
1621       }
1622       else if (data_type == TYPE_ELEMENT_LIST)
1623       {
1624         int *element_array = (int *)(conf[i].value);
1625         int j;
1626
1627         for (j = 0; j < max_num_entities; j++)
1628           element_array[j] = default_value;
1629       }
1630       else if (data_type == TYPE_CONTENT_LIST)
1631       {
1632         struct Content *content = (struct Content *)(conf[i].value);
1633         int c, x, y;
1634
1635         for (c = 0; c < max_num_entities; c++)
1636           for (y = 0; y < 3; y++)
1637             for (x = 0; x < 3; x++)
1638               content[c].e[x][y] = default_value;
1639       }
1640     }
1641     else        // constant size configuration data (1, 2 or 4 bytes)
1642     {
1643       if (data_type == TYPE_BOOLEAN)
1644         *(boolean *)(conf[i].value) = default_value;
1645       else
1646         *(int *)    (conf[i].value) = default_value;
1647     }
1648   }
1649 }
1650
1651 static void copyConfigFromConfigList(struct LevelFileConfigInfo *conf)
1652 {
1653   int i;
1654
1655   for (i = 0; conf[i].data_type != -1; i++)
1656   {
1657     int data_type = conf[i].data_type;
1658     int conf_type = conf[i].conf_type;
1659     int byte_mask = conf_type & CONF_MASK_BYTES;
1660
1661     if (byte_mask == CONF_MASK_MULTI_BYTES)
1662     {
1663       int max_num_entities = conf[i].max_num_entities;
1664
1665       if (data_type == TYPE_STRING)
1666       {
1667         char *string      = (char *)(conf[i].value);
1668         char *string_copy = (char *)(conf[i].value_copy);
1669
1670         strncpy(string_copy, string, max_num_entities);
1671       }
1672       else if (data_type == TYPE_ELEMENT_LIST)
1673       {
1674         int *element_array      = (int *)(conf[i].value);
1675         int *element_array_copy = (int *)(conf[i].value_copy);
1676         int j;
1677
1678         for (j = 0; j < max_num_entities; j++)
1679           element_array_copy[j] = element_array[j];
1680       }
1681       else if (data_type == TYPE_CONTENT_LIST)
1682       {
1683         struct Content *content      = (struct Content *)(conf[i].value);
1684         struct Content *content_copy = (struct Content *)(conf[i].value_copy);
1685         int c, x, y;
1686
1687         for (c = 0; c < max_num_entities; c++)
1688           for (y = 0; y < 3; y++)
1689             for (x = 0; x < 3; x++)
1690               content_copy[c].e[x][y] = content[c].e[x][y];
1691       }
1692     }
1693     else        // constant size configuration data (1, 2 or 4 bytes)
1694     {
1695       if (data_type == TYPE_BOOLEAN)
1696         *(boolean *)(conf[i].value_copy) = *(boolean *)(conf[i].value);
1697       else
1698         *(int *)    (conf[i].value_copy) = *(int *)    (conf[i].value);
1699     }
1700   }
1701 }
1702
1703 void copyElementInfo(struct ElementInfo *ei_from, struct ElementInfo *ei_to)
1704 {
1705   int i;
1706
1707   xx_ei = *ei_from;     // copy element data into temporary buffer
1708   yy_ei = *ei_to;       // copy element data into temporary buffer
1709
1710   copyConfigFromConfigList(chunk_config_CUSX_base);
1711
1712   *ei_from = xx_ei;
1713   *ei_to   = yy_ei;
1714
1715   // ---------- reinitialize and copy change pages ----------
1716
1717   ei_to->num_change_pages = ei_from->num_change_pages;
1718   ei_to->current_change_page = ei_from->current_change_page;
1719
1720   setElementChangePages(ei_to, ei_to->num_change_pages);
1721
1722   for (i = 0; i < ei_to->num_change_pages; i++)
1723     ei_to->change_page[i] = ei_from->change_page[i];
1724
1725   // ---------- copy group element info ----------
1726   if (ei_from->group != NULL && ei_to->group != NULL)   // group or internal
1727     *ei_to->group = *ei_from->group;
1728
1729   // mark this custom element as modified
1730   ei_to->modified_settings = TRUE;
1731 }
1732
1733 void setElementChangePages(struct ElementInfo *ei, int change_pages)
1734 {
1735   int change_page_size = sizeof(struct ElementChangeInfo);
1736
1737   ei->num_change_pages = MAX(1, change_pages);
1738
1739   ei->change_page =
1740     checked_realloc(ei->change_page, ei->num_change_pages * change_page_size);
1741
1742   if (ei->current_change_page >= ei->num_change_pages)
1743     ei->current_change_page = ei->num_change_pages - 1;
1744
1745   ei->change = &ei->change_page[ei->current_change_page];
1746 }
1747
1748 void setElementChangeInfoToDefaults(struct ElementChangeInfo *change)
1749 {
1750   xx_change = *change;          // copy change data into temporary buffer
1751
1752   setConfigToDefaultsFromConfigList(chunk_config_CUSX_change);
1753
1754   *change = xx_change;
1755
1756   resetEventFlags(change);
1757
1758   change->direct_action = 0;
1759   change->other_action = 0;
1760
1761   change->pre_change_function = NULL;
1762   change->change_function = NULL;
1763   change->post_change_function = NULL;
1764 }
1765
1766 static void setLevelInfoToDefaults_Level(struct LevelInfo *level)
1767 {
1768   int i, x, y;
1769
1770   li = *level;          // copy level data into temporary buffer
1771   setConfigToDefaultsFromConfigList(chunk_config_INFO);
1772   *level = li;          // copy temporary buffer back to level data
1773
1774   setLevelInfoToDefaults_BD();
1775   setLevelInfoToDefaults_EM();
1776   setLevelInfoToDefaults_SP();
1777   setLevelInfoToDefaults_MM();
1778
1779   level->native_bd_level = &native_bd_level;
1780   level->native_em_level = &native_em_level;
1781   level->native_sp_level = &native_sp_level;
1782   level->native_mm_level = &native_mm_level;
1783
1784   level->file_version = FILE_VERSION_ACTUAL;
1785   level->game_version = GAME_VERSION_ACTUAL;
1786
1787   level->creation_date = getCurrentDate();
1788
1789   level->encoding_16bit_field  = TRUE;
1790   level->encoding_16bit_yamyam = TRUE;
1791   level->encoding_16bit_amoeba = TRUE;
1792
1793   // clear level name and level author string buffers
1794   for (i = 0; i < MAX_LEVEL_NAME_LEN; i++)
1795     level->name[i] = '\0';
1796   for (i = 0; i < MAX_LEVEL_AUTHOR_LEN; i++)
1797     level->author[i] = '\0';
1798
1799   // set level name and level author to default values
1800   strcpy(level->name, NAMELESS_LEVEL_NAME);
1801   strcpy(level->author, ANONYMOUS_NAME);
1802
1803   // set level playfield to playable default level with player and exit
1804   for (x = 0; x < MAX_LEV_FIELDX; x++)
1805     for (y = 0; y < MAX_LEV_FIELDY; y++)
1806       level->field[x][y] = EL_SAND;
1807
1808   level->field[0][0] = EL_PLAYER_1;
1809   level->field[STD_LEV_FIELDX - 1][STD_LEV_FIELDY - 1] = EL_EXIT_CLOSED;
1810
1811   BorderElement = EL_STEELWALL;
1812
1813   // detect custom elements when loading them
1814   level->file_has_custom_elements = FALSE;
1815
1816   // set all bug compatibility flags to "false" => do not emulate this bug
1817   level->use_action_after_change_bug = FALSE;
1818
1819   if (leveldir_current)
1820   {
1821     // try to determine better author name than 'anonymous'
1822     if (!strEqual(leveldir_current->author, ANONYMOUS_NAME))
1823     {
1824       strncpy(level->author, leveldir_current->author, MAX_LEVEL_AUTHOR_LEN);
1825       level->author[MAX_LEVEL_AUTHOR_LEN] = '\0';
1826     }
1827     else
1828     {
1829       switch (LEVELCLASS(leveldir_current))
1830       {
1831         case LEVELCLASS_TUTORIAL:
1832           strcpy(level->author, PROGRAM_AUTHOR_STRING);
1833           break;
1834
1835         case LEVELCLASS_CONTRIB:
1836           strncpy(level->author, leveldir_current->name, MAX_LEVEL_AUTHOR_LEN);
1837           level->author[MAX_LEVEL_AUTHOR_LEN] = '\0';
1838           break;
1839
1840         case LEVELCLASS_PRIVATE:
1841           strncpy(level->author, getRealName(), MAX_LEVEL_AUTHOR_LEN);
1842           level->author[MAX_LEVEL_AUTHOR_LEN] = '\0';
1843           break;
1844
1845         default:
1846           // keep default value
1847           break;
1848       }
1849     }
1850   }
1851 }
1852
1853 static void setLevelInfoToDefaults_Elements(struct LevelInfo *level)
1854 {
1855   static boolean clipboard_elements_initialized = FALSE;
1856   int i;
1857
1858   InitElementPropertiesStatic();
1859
1860   li = *level;          // copy level data into temporary buffer
1861   setConfigToDefaultsFromConfigList(chunk_config_ELEM);
1862   *level = li;          // copy temporary buffer back to level data
1863
1864   for (i = 0; i < MAX_NUM_ELEMENTS; i++)
1865   {
1866     int element = i;
1867     struct ElementInfo *ei = &element_info[element];
1868
1869     if (element == EL_MM_GRAY_BALL)
1870     {
1871       struct LevelInfo_MM *level_mm = level->native_mm_level;
1872       int j;
1873
1874       for (j = 0; j < level->num_mm_ball_contents; j++)
1875         level->mm_ball_content[j] =
1876           map_element_MM_to_RND(level_mm->ball_content[j]);
1877     }
1878
1879     // never initialize clipboard elements after the very first time
1880     // (to be able to use clipboard elements between several levels)
1881     if (IS_CLIPBOARD_ELEMENT(element) && clipboard_elements_initialized)
1882       continue;
1883
1884     if (IS_ENVELOPE(element))
1885     {
1886       int envelope_nr = element - EL_ENVELOPE_1;
1887
1888       setConfigToDefaultsFromConfigList(chunk_config_NOTE);
1889
1890       level->envelope[envelope_nr] = xx_envelope;
1891     }
1892
1893     if (IS_CUSTOM_ELEMENT(element) ||
1894         IS_GROUP_ELEMENT(element) ||
1895         IS_INTERNAL_ELEMENT(element))
1896     {
1897       xx_ei = *ei;      // copy element data into temporary buffer
1898
1899       setConfigToDefaultsFromConfigList(chunk_config_CUSX_base);
1900
1901       *ei = xx_ei;
1902     }
1903
1904     setElementChangePages(ei, 1);
1905     setElementChangeInfoToDefaults(ei->change);
1906
1907     if (IS_CUSTOM_ELEMENT(element) ||
1908         IS_GROUP_ELEMENT(element))
1909     {
1910       setElementDescriptionToDefault(ei);
1911
1912       ei->modified_settings = FALSE;
1913     }
1914
1915     if (IS_CUSTOM_ELEMENT(element) ||
1916         IS_INTERNAL_ELEMENT(element))
1917     {
1918       // internal values used in level editor
1919
1920       ei->access_type = 0;
1921       ei->access_layer = 0;
1922       ei->access_protected = 0;
1923       ei->walk_to_action = 0;
1924       ei->smash_targets = 0;
1925       ei->deadliness = 0;
1926
1927       ei->can_explode_by_fire = FALSE;
1928       ei->can_explode_smashed = FALSE;
1929       ei->can_explode_impact = FALSE;
1930
1931       ei->current_change_page = 0;
1932     }
1933
1934     if (IS_GROUP_ELEMENT(element) ||
1935         IS_INTERNAL_ELEMENT(element))
1936     {
1937       struct ElementGroupInfo *group;
1938
1939       // initialize memory for list of elements in group
1940       if (ei->group == NULL)
1941         ei->group = checked_malloc(sizeof(struct ElementGroupInfo));
1942
1943       group = ei->group;
1944
1945       xx_group = *group;        // copy group data into temporary buffer
1946
1947       setConfigToDefaultsFromConfigList(chunk_config_GRPX);
1948
1949       *group = xx_group;
1950     }
1951
1952     if (IS_EMPTY_ELEMENT(element) ||
1953         IS_INTERNAL_ELEMENT(element))
1954     {
1955       xx_ei = *ei;              // copy element data into temporary buffer
1956
1957       setConfigToDefaultsFromConfigList(chunk_config_EMPX);
1958
1959       *ei = xx_ei;
1960     }
1961   }
1962
1963   clipboard_elements_initialized = TRUE;
1964 }
1965
1966 static void setLevelInfoToDefaults(struct LevelInfo *level,
1967                                    boolean level_info_only,
1968                                    boolean reset_file_status)
1969 {
1970   setLevelInfoToDefaults_Level(level);
1971
1972   if (!level_info_only)
1973     setLevelInfoToDefaults_Elements(level);
1974
1975   if (reset_file_status)
1976   {
1977     level->no_valid_file = FALSE;
1978     level->no_level_file = FALSE;
1979   }
1980
1981   level->changed = FALSE;
1982 }
1983
1984 static void setFileInfoToDefaults(struct LevelFileInfo *level_file_info)
1985 {
1986   level_file_info->nr = 0;
1987   level_file_info->type = LEVEL_FILE_TYPE_UNKNOWN;
1988   level_file_info->packed = FALSE;
1989
1990   setString(&level_file_info->basename, NULL);
1991   setString(&level_file_info->filename, NULL);
1992 }
1993
1994 int getMappedElement_SB(int, boolean);
1995
1996 static void ActivateLevelTemplate(void)
1997 {
1998   int x, y;
1999
2000   if (check_special_flags("load_xsb_to_ces"))
2001   {
2002     // fill smaller playfields with padding "beyond border wall" elements
2003     if (level.fieldx < level_template.fieldx ||
2004         level.fieldy < level_template.fieldy)
2005     {
2006       short field[level.fieldx][level.fieldy];
2007       int new_fieldx = MAX(level.fieldx, level_template.fieldx);
2008       int new_fieldy = MAX(level.fieldy, level_template.fieldy);
2009       int pos_fieldx = (new_fieldx - level.fieldx) / 2;
2010       int pos_fieldy = (new_fieldy - level.fieldy) / 2;
2011
2012       // copy old playfield (which is smaller than the visible area)
2013       for (y = 0; y < level.fieldy; y++) for (x = 0; x < level.fieldx; x++)
2014         field[x][y] = level.field[x][y];
2015
2016       // fill new, larger playfield with "beyond border wall" elements
2017       for (y = 0; y < new_fieldy; y++) for (x = 0; x < new_fieldx; x++)
2018         level.field[x][y] = getMappedElement_SB('_', TRUE);
2019
2020       // copy the old playfield to the middle of the new playfield
2021       for (y = 0; y < level.fieldy; y++) for (x = 0; x < level.fieldx; x++)
2022         level.field[pos_fieldx + x][pos_fieldy + y] = field[x][y];
2023
2024       level.fieldx = new_fieldx;
2025       level.fieldy = new_fieldy;
2026     }
2027   }
2028
2029   // Currently there is no special action needed to activate the template
2030   // data, because 'element_info' property settings overwrite the original
2031   // level data, while all other variables do not change.
2032
2033   // Exception: 'from_level_template' elements in the original level playfield
2034   // are overwritten with the corresponding elements at the same position in
2035   // playfield from the level template.
2036
2037   for (x = 0; x < level.fieldx; x++)
2038     for (y = 0; y < level.fieldy; y++)
2039       if (level.field[x][y] == EL_FROM_LEVEL_TEMPLATE)
2040         level.field[x][y] = level_template.field[x][y];
2041
2042   if (check_special_flags("load_xsb_to_ces"))
2043   {
2044     struct LevelInfo level_backup = level;
2045
2046     // overwrite all individual level settings from template level settings
2047     level = level_template;
2048
2049     // restore level file info
2050     level.file_info = level_backup.file_info;
2051
2052     // restore playfield size
2053     level.fieldx = level_backup.fieldx;
2054     level.fieldy = level_backup.fieldy;
2055
2056     // restore playfield content
2057     for (x = 0; x < level.fieldx; x++)
2058       for (y = 0; y < level.fieldy; y++)
2059         level.field[x][y] = level_backup.field[x][y];
2060
2061     // restore name and author from individual level
2062     strcpy(level.name,   level_backup.name);
2063     strcpy(level.author, level_backup.author);
2064
2065     // restore flag "use_custom_template"
2066     level.use_custom_template = level_backup.use_custom_template;
2067   }
2068 }
2069
2070 static char *getLevelFilenameFromBasename(char *basename)
2071 {
2072   static char *filename = NULL;
2073
2074   checked_free(filename);
2075
2076   filename = getPath2(getCurrentLevelDir(), basename);
2077
2078   return filename;
2079 }
2080
2081 static int getFileTypeFromBasename(char *basename)
2082 {
2083   // !!! ALSO SEE COMMENT IN checkForPackageFromBasename() !!!
2084
2085   static char *filename = NULL;
2086   struct stat file_status;
2087
2088   // ---------- try to determine file type from filename ----------
2089
2090   // check for typical filename of a Supaplex level package file
2091   if (strlen(basename) == 10 && strPrefixLower(basename, "levels.d"))
2092     return LEVEL_FILE_TYPE_SP;
2093
2094   // check for typical filename of a Diamond Caves II level package file
2095   if (strSuffixLower(basename, ".dc") ||
2096       strSuffixLower(basename, ".dc2"))
2097     return LEVEL_FILE_TYPE_DC;
2098
2099   // check for typical filename of a Sokoban level package file
2100   if (strSuffixLower(basename, ".xsb") &&
2101       strchr(basename, '%') == NULL)
2102     return LEVEL_FILE_TYPE_SB;
2103
2104   // check for typical filename of a Boulder Dash (GDash) level package file
2105   if (strSuffixLower(basename, ".bd") ||
2106       strSuffixLower(basename, ".bdr") ||
2107       strSuffixLower(basename, ".brc") ||
2108       strSuffixLower(basename, ".gds"))
2109     return LEVEL_FILE_TYPE_BD;
2110
2111   // ---------- try to determine file type from filesize ----------
2112
2113   checked_free(filename);
2114   filename = getPath2(getCurrentLevelDir(), basename);
2115
2116   if (stat(filename, &file_status) == 0)
2117   {
2118     // check for typical filesize of a Supaplex level package file
2119     if (file_status.st_size == 170496)
2120       return LEVEL_FILE_TYPE_SP;
2121   }
2122
2123   return LEVEL_FILE_TYPE_UNKNOWN;
2124 }
2125
2126 static int getFileTypeFromMagicBytes(char *filename, int type)
2127 {
2128   File *file;
2129
2130   if ((file = openFile(filename, MODE_READ)))
2131   {
2132     char chunk_name[CHUNK_ID_LEN + 1];
2133
2134     getFileChunkBE(file, chunk_name, NULL);
2135
2136     if (strEqual(chunk_name, "MMII") ||
2137         strEqual(chunk_name, "MIRR"))
2138       type = LEVEL_FILE_TYPE_MM;
2139
2140     closeFile(file);
2141   }
2142
2143   return type;
2144 }
2145
2146 static boolean checkForPackageFromBasename(char *basename)
2147 {
2148   // !!! WON'T WORK ANYMORE IF getFileTypeFromBasename() ALSO DETECTS !!!
2149   // !!! SINGLE LEVELS (CURRENTLY ONLY DETECTS LEVEL PACKAGES         !!!
2150
2151   return (getFileTypeFromBasename(basename) != LEVEL_FILE_TYPE_UNKNOWN);
2152 }
2153
2154 static char *getSingleLevelBasenameExt(int nr, char *extension)
2155 {
2156   static char basename[MAX_FILENAME_LEN];
2157
2158   if (nr < 0)
2159     sprintf(basename, "%s", LEVELTEMPLATE_FILENAME);
2160   else
2161     sprintf(basename, "%03d.%s", nr, extension);
2162
2163   return basename;
2164 }
2165
2166 static char *getSingleLevelBasename(int nr)
2167 {
2168   return getSingleLevelBasenameExt(nr, LEVELFILE_EXTENSION);
2169 }
2170
2171 static char *getPackedLevelBasename(int type)
2172 {
2173   static char basename[MAX_FILENAME_LEN];
2174   char *directory = getCurrentLevelDir();
2175   Directory *dir;
2176   DirectoryEntry *dir_entry;
2177
2178   strcpy(basename, UNDEFINED_FILENAME);         // default: undefined file
2179
2180   if ((dir = openDirectory(directory)) == NULL)
2181   {
2182     Warn("cannot read current level directory '%s'", directory);
2183
2184     return basename;
2185   }
2186
2187   while ((dir_entry = readDirectory(dir)) != NULL)      // loop all entries
2188   {
2189     char *entry_basename = dir_entry->basename;
2190     int entry_type = getFileTypeFromBasename(entry_basename);
2191
2192     if (entry_type != LEVEL_FILE_TYPE_UNKNOWN)  // found valid level package
2193     {
2194       if (type == LEVEL_FILE_TYPE_UNKNOWN ||
2195           type == entry_type)
2196       {
2197         strcpy(basename, entry_basename);
2198
2199         break;
2200       }
2201     }
2202   }
2203
2204   closeDirectory(dir);
2205
2206   return basename;
2207 }
2208
2209 static char *getSingleLevelFilename(int nr)
2210 {
2211   return getLevelFilenameFromBasename(getSingleLevelBasename(nr));
2212 }
2213
2214 #if ENABLE_UNUSED_CODE
2215 static char *getPackedLevelFilename(int type)
2216 {
2217   return getLevelFilenameFromBasename(getPackedLevelBasename(type));
2218 }
2219 #endif
2220
2221 char *getDefaultLevelFilename(int nr)
2222 {
2223   return getSingleLevelFilename(nr);
2224 }
2225
2226 #if ENABLE_UNUSED_CODE
2227 static void setLevelFileInfo_SingleLevelFilename(struct LevelFileInfo *lfi,
2228                                                  int type)
2229 {
2230   lfi->type = type;
2231   lfi->packed = FALSE;
2232
2233   setString(&lfi->basename, getSingleLevelBasename(lfi->nr, lfi->type));
2234   setString(&lfi->filename, getLevelFilenameFromBasename(lfi->basename));
2235 }
2236 #endif
2237
2238 static void setLevelFileInfo_FormatLevelFilename(struct LevelFileInfo *lfi,
2239                                                  int type, char *format, ...)
2240 {
2241   static char basename[MAX_FILENAME_LEN];
2242   va_list ap;
2243
2244   va_start(ap, format);
2245   vsprintf(basename, format, ap);
2246   va_end(ap);
2247
2248   lfi->type = type;
2249   lfi->packed = FALSE;
2250
2251   setString(&lfi->basename, basename);
2252   setString(&lfi->filename, getLevelFilenameFromBasename(lfi->basename));
2253 }
2254
2255 static void setLevelFileInfo_PackedLevelFilename(struct LevelFileInfo *lfi,
2256                                                  int type)
2257 {
2258   lfi->type = type;
2259   lfi->packed = TRUE;
2260
2261   setString(&lfi->basename, getPackedLevelBasename(lfi->type));
2262   setString(&lfi->filename, getLevelFilenameFromBasename(lfi->basename));
2263 }
2264
2265 static int getFiletypeFromID(char *filetype_id)
2266 {
2267   char *filetype_id_lower;
2268   int filetype = LEVEL_FILE_TYPE_UNKNOWN;
2269   int i;
2270
2271   if (filetype_id == NULL)
2272     return LEVEL_FILE_TYPE_UNKNOWN;
2273
2274   filetype_id_lower = getStringToLower(filetype_id);
2275
2276   for (i = 0; filetype_id_list[i].id != NULL; i++)
2277   {
2278     char *id_lower = getStringToLower(filetype_id_list[i].id);
2279
2280     if (strEqual(filetype_id_lower, id_lower))
2281       filetype = filetype_id_list[i].filetype;
2282
2283     free(id_lower);
2284
2285     if (filetype != LEVEL_FILE_TYPE_UNKNOWN)
2286       break;
2287   }
2288
2289   free(filetype_id_lower);
2290
2291   return filetype;
2292 }
2293
2294 char *getLocalLevelTemplateFilename(void)
2295 {
2296   return getDefaultLevelFilename(-1);
2297 }
2298
2299 char *getGlobalLevelTemplateFilename(void)
2300 {
2301   // global variable "leveldir_current" must be modified in the loop below
2302   LevelDirTree *leveldir_current_last = leveldir_current;
2303   char *filename = NULL;
2304
2305   // check for template level in path from current to topmost tree node
2306
2307   while (leveldir_current != NULL)
2308   {
2309     filename = getDefaultLevelFilename(-1);
2310
2311     if (fileExists(filename))
2312       break;
2313
2314     leveldir_current = leveldir_current->node_parent;
2315   }
2316
2317   // restore global variable "leveldir_current" modified in above loop
2318   leveldir_current = leveldir_current_last;
2319
2320   return filename;
2321 }
2322
2323 static void determineLevelFileInfo_Filename(struct LevelFileInfo *lfi)
2324 {
2325   int nr = lfi->nr;
2326
2327   // special case: level number is negative => check for level template file
2328   if (nr < 0)
2329   {
2330     setLevelFileInfo_FormatLevelFilename(lfi, LEVEL_FILE_TYPE_RND,
2331                                          getSingleLevelBasename(-1));
2332
2333     // replace local level template filename with global template filename
2334     setString(&lfi->filename, getGlobalLevelTemplateFilename());
2335
2336     // no fallback if template file not existing
2337     return;
2338   }
2339
2340   // special case: check for file name/pattern specified in "levelinfo.conf"
2341   if (leveldir_current->level_filename != NULL)
2342   {
2343     int filetype = getFiletypeFromID(leveldir_current->level_filetype);
2344
2345     setLevelFileInfo_FormatLevelFilename(lfi, filetype,
2346                                          leveldir_current->level_filename, nr);
2347
2348     lfi->packed = checkForPackageFromBasename(leveldir_current->level_filename);
2349
2350     if (fileExists(lfi->filename))
2351       return;
2352   }
2353   else if (leveldir_current->level_filetype != NULL)
2354   {
2355     int filetype = getFiletypeFromID(leveldir_current->level_filetype);
2356
2357     // check for specified native level file with standard file name
2358     setLevelFileInfo_FormatLevelFilename(lfi, filetype,
2359                                          "%03d.%s", nr, LEVELFILE_EXTENSION);
2360     if (fileExists(lfi->filename))
2361       return;
2362   }
2363
2364   // check for native Rocks'n'Diamonds level file
2365   setLevelFileInfo_FormatLevelFilename(lfi, LEVEL_FILE_TYPE_RND,
2366                                        "%03d.%s", nr, LEVELFILE_EXTENSION);
2367   if (fileExists(lfi->filename))
2368     return;
2369
2370   // check for Emerald Mine level file (V1)
2371   setLevelFileInfo_FormatLevelFilename(lfi, LEVEL_FILE_TYPE_EM, "a%c%c",
2372                                        'a' + (nr / 10) % 26, '0' + nr % 10);
2373   if (fileExists(lfi->filename))
2374     return;
2375   setLevelFileInfo_FormatLevelFilename(lfi, LEVEL_FILE_TYPE_EM, "A%c%c",
2376                                        'A' + (nr / 10) % 26, '0' + nr % 10);
2377   if (fileExists(lfi->filename))
2378     return;
2379
2380   // check for Emerald Mine level file (V2 to V5)
2381   setLevelFileInfo_FormatLevelFilename(lfi, LEVEL_FILE_TYPE_EM, "%d", nr);
2382   if (fileExists(lfi->filename))
2383     return;
2384
2385   // check for Emerald Mine level file (V6 / single mode)
2386   setLevelFileInfo_FormatLevelFilename(lfi, LEVEL_FILE_TYPE_EM, "%02ds", nr);
2387   if (fileExists(lfi->filename))
2388     return;
2389   setLevelFileInfo_FormatLevelFilename(lfi, LEVEL_FILE_TYPE_EM, "%02dS", nr);
2390   if (fileExists(lfi->filename))
2391     return;
2392
2393   // check for Emerald Mine level file (V6 / teamwork mode)
2394   setLevelFileInfo_FormatLevelFilename(lfi, LEVEL_FILE_TYPE_EM, "%02dt", nr);
2395   if (fileExists(lfi->filename))
2396     return;
2397   setLevelFileInfo_FormatLevelFilename(lfi, LEVEL_FILE_TYPE_EM, "%02dT", nr);
2398   if (fileExists(lfi->filename))
2399     return;
2400
2401   // check for various packed level file formats
2402   setLevelFileInfo_PackedLevelFilename(lfi, LEVEL_FILE_TYPE_UNKNOWN);
2403   if (fileExists(lfi->filename))
2404     return;
2405
2406   // no known level file found -- use default values (and fail later)
2407   setLevelFileInfo_FormatLevelFilename(lfi, LEVEL_FILE_TYPE_RND,
2408                                        "%03d.%s", nr, LEVELFILE_EXTENSION);
2409 }
2410
2411 static void determineLevelFileInfo_Filetype(struct LevelFileInfo *lfi)
2412 {
2413   if (lfi->type == LEVEL_FILE_TYPE_UNKNOWN)
2414     lfi->type = getFileTypeFromBasename(lfi->basename);
2415
2416   if (lfi->type == LEVEL_FILE_TYPE_RND)
2417     lfi->type = getFileTypeFromMagicBytes(lfi->filename, lfi->type);
2418 }
2419
2420 static void setLevelFileInfo(struct LevelFileInfo *level_file_info, int nr)
2421 {
2422   // always start with reliable default values
2423   setFileInfoToDefaults(level_file_info);
2424
2425   level_file_info->nr = nr;     // set requested level number
2426
2427   determineLevelFileInfo_Filename(level_file_info);
2428   determineLevelFileInfo_Filetype(level_file_info);
2429 }
2430
2431 static void copyLevelFileInfo(struct LevelFileInfo *lfi_from,
2432                               struct LevelFileInfo *lfi_to)
2433 {
2434   lfi_to->nr     = lfi_from->nr;
2435   lfi_to->type   = lfi_from->type;
2436   lfi_to->packed = lfi_from->packed;
2437
2438   setString(&lfi_to->basename, lfi_from->basename);
2439   setString(&lfi_to->filename, lfi_from->filename);
2440 }
2441
2442 // ----------------------------------------------------------------------------
2443 // functions for loading R'n'D level
2444 // ----------------------------------------------------------------------------
2445
2446 int getMappedElement(int element)
2447 {
2448   // remap some (historic, now obsolete) elements
2449
2450   switch (element)
2451   {
2452     case EL_PLAYER_OBSOLETE:
2453       element = EL_PLAYER_1;
2454       break;
2455
2456     case EL_KEY_OBSOLETE:
2457       element = EL_KEY_1;
2458       break;
2459
2460     case EL_EM_KEY_1_FILE_OBSOLETE:
2461       element = EL_EM_KEY_1;
2462       break;
2463
2464     case EL_EM_KEY_2_FILE_OBSOLETE:
2465       element = EL_EM_KEY_2;
2466       break;
2467
2468     case EL_EM_KEY_3_FILE_OBSOLETE:
2469       element = EL_EM_KEY_3;
2470       break;
2471
2472     case EL_EM_KEY_4_FILE_OBSOLETE:
2473       element = EL_EM_KEY_4;
2474       break;
2475
2476     case EL_ENVELOPE_OBSOLETE:
2477       element = EL_ENVELOPE_1;
2478       break;
2479
2480     case EL_SP_EMPTY:
2481       element = EL_EMPTY;
2482       break;
2483
2484     default:
2485       if (element >= NUM_FILE_ELEMENTS)
2486       {
2487         Warn("invalid level element %d", element);
2488
2489         element = EL_UNKNOWN;
2490       }
2491       break;
2492   }
2493
2494   return element;
2495 }
2496
2497 static int getMappedElementByVersion(int element, int game_version)
2498 {
2499   // remap some elements due to certain game version
2500
2501   if (game_version <= VERSION_IDENT(2,2,0,0))
2502   {
2503     // map game font elements
2504     element = (element == EL_CHAR('[')  ? EL_CHAR_AUMLAUT :
2505                element == EL_CHAR('\\') ? EL_CHAR_OUMLAUT :
2506                element == EL_CHAR(']')  ? EL_CHAR_UUMLAUT :
2507                element == EL_CHAR('^')  ? EL_CHAR_COPYRIGHT : element);
2508   }
2509
2510   if (game_version < VERSION_IDENT(3,0,0,0))
2511   {
2512     // map Supaplex gravity tube elements
2513     element = (element == EL_SP_GRAVITY_PORT_LEFT  ? EL_SP_PORT_LEFT  :
2514                element == EL_SP_GRAVITY_PORT_RIGHT ? EL_SP_PORT_RIGHT :
2515                element == EL_SP_GRAVITY_PORT_UP    ? EL_SP_PORT_UP    :
2516                element == EL_SP_GRAVITY_PORT_DOWN  ? EL_SP_PORT_DOWN  :
2517                element);
2518   }
2519
2520   return element;
2521 }
2522
2523 static int LoadLevel_VERS(File *file, int chunk_size, struct LevelInfo *level)
2524 {
2525   level->file_version = getFileVersion(file);
2526   level->game_version = getFileVersion(file);
2527
2528   return chunk_size;
2529 }
2530
2531 static int LoadLevel_DATE(File *file, int chunk_size, struct LevelInfo *level)
2532 {
2533   level->creation_date.year  = getFile16BitBE(file);
2534   level->creation_date.month = getFile8Bit(file);
2535   level->creation_date.day   = getFile8Bit(file);
2536
2537   level->creation_date.src   = DATE_SRC_LEVELFILE;
2538
2539   return chunk_size;
2540 }
2541
2542 static int LoadLevel_HEAD(File *file, int chunk_size, struct LevelInfo *level)
2543 {
2544   int initial_player_stepsize;
2545   int initial_player_gravity;
2546   int i, x, y;
2547
2548   level->fieldx = getFile8Bit(file);
2549   level->fieldy = getFile8Bit(file);
2550
2551   level->time           = getFile16BitBE(file);
2552   level->gems_needed    = getFile16BitBE(file);
2553
2554   for (i = 0; i < MAX_LEVEL_NAME_LEN; i++)
2555     level->name[i] = getFile8Bit(file);
2556   level->name[MAX_LEVEL_NAME_LEN] = 0;
2557
2558   for (i = 0; i < LEVEL_SCORE_ELEMENTS; i++)
2559     level->score[i] = getFile8Bit(file);
2560
2561   level->num_yamyam_contents = STD_ELEMENT_CONTENTS;
2562   for (i = 0; i < STD_ELEMENT_CONTENTS; i++)
2563     for (y = 0; y < 3; y++)
2564       for (x = 0; x < 3; x++)
2565         level->yamyam_content[i].e[x][y] = getMappedElement(getFile8Bit(file));
2566
2567   level->amoeba_speed           = getFile8Bit(file);
2568   level->time_magic_wall        = getFile8Bit(file);
2569   level->time_wheel             = getFile8Bit(file);
2570   level->amoeba_content         = getMappedElement(getFile8Bit(file));
2571
2572   initial_player_stepsize       = (getFile8Bit(file) == 1 ? STEPSIZE_FAST :
2573                                    STEPSIZE_NORMAL);
2574
2575   for (i = 0; i < MAX_PLAYERS; i++)
2576     level->initial_player_stepsize[i] = initial_player_stepsize;
2577
2578   initial_player_gravity        = (getFile8Bit(file) == 1 ? TRUE : FALSE);
2579
2580   for (i = 0; i < MAX_PLAYERS; i++)
2581     level->initial_player_gravity[i] = initial_player_gravity;
2582
2583   level->encoding_16bit_field   = (getFile8Bit(file) == 1 ? TRUE : FALSE);
2584   level->em_slippery_gems       = (getFile8Bit(file) == 1 ? TRUE : FALSE);
2585
2586   level->use_custom_template    = (getFile8Bit(file) == 1 ? TRUE : FALSE);
2587
2588   level->block_last_field       = (getFile8Bit(file) == 1 ? TRUE : FALSE);
2589   level->sp_block_last_field    = (getFile8Bit(file) == 1 ? TRUE : FALSE);
2590   level->can_move_into_acid_bits = getFile32BitBE(file);
2591   level->dont_collide_with_bits = getFile8Bit(file);
2592
2593   level->use_spring_bug         = (getFile8Bit(file) == 1 ? TRUE : FALSE);
2594   level->use_step_counter       = (getFile8Bit(file) == 1 ? TRUE : FALSE);
2595
2596   level->instant_relocation     = (getFile8Bit(file) == 1 ? TRUE : FALSE);
2597   level->can_pass_to_walkable   = (getFile8Bit(file) == 1 ? TRUE : FALSE);
2598   level->grow_into_diggable     = (getFile8Bit(file) == 1 ? TRUE : FALSE);
2599
2600   level->game_engine_type       = getFile8Bit(file);
2601
2602   ReadUnusedBytesFromFile(file, LEVEL_CHUNK_HEAD_UNUSED);
2603
2604   return chunk_size;
2605 }
2606
2607 static int LoadLevel_NAME(File *file, int chunk_size, struct LevelInfo *level)
2608 {
2609   int i;
2610
2611   for (i = 0; i < MAX_LEVEL_NAME_LEN; i++)
2612     level->name[i] = getFile8Bit(file);
2613   level->name[MAX_LEVEL_NAME_LEN] = 0;
2614
2615   return chunk_size;
2616 }
2617
2618 static int LoadLevel_AUTH(File *file, int chunk_size, struct LevelInfo *level)
2619 {
2620   int i;
2621
2622   for (i = 0; i < MAX_LEVEL_AUTHOR_LEN; i++)
2623     level->author[i] = getFile8Bit(file);
2624   level->author[MAX_LEVEL_AUTHOR_LEN] = 0;
2625
2626   return chunk_size;
2627 }
2628
2629 static int LoadLevel_BODY(File *file, int chunk_size, struct LevelInfo *level)
2630 {
2631   int x, y;
2632   int chunk_size_expected = level->fieldx * level->fieldy;
2633
2634   /* Note: "chunk_size" was wrong before version 2.0 when elements are
2635      stored with 16-bit encoding (and should be twice as big then).
2636      Even worse, playfield data was stored 16-bit when only yamyam content
2637      contained 16-bit elements and vice versa. */
2638
2639   if (level->encoding_16bit_field && level->file_version >= FILE_VERSION_2_0)
2640     chunk_size_expected *= 2;
2641
2642   if (chunk_size_expected != chunk_size)
2643   {
2644     ReadUnusedBytesFromFile(file, chunk_size);
2645     return chunk_size_expected;
2646   }
2647
2648   for (y = 0; y < level->fieldy; y++)
2649     for (x = 0; x < level->fieldx; x++)
2650       level->field[x][y] =
2651         getMappedElement(level->encoding_16bit_field ? getFile16BitBE(file) :
2652                          getFile8Bit(file));
2653   return chunk_size;
2654 }
2655
2656 static int LoadLevel_CONT(File *file, int chunk_size, struct LevelInfo *level)
2657 {
2658   int i, x, y;
2659   int header_size = 4;
2660   int content_size = MAX_ELEMENT_CONTENTS * 3 * 3;
2661   int chunk_size_expected = header_size + content_size;
2662
2663   /* Note: "chunk_size" was wrong before version 2.0 when elements are
2664      stored with 16-bit encoding (and should be twice as big then).
2665      Even worse, playfield data was stored 16-bit when only yamyam content
2666      contained 16-bit elements and vice versa. */
2667
2668   if (level->encoding_16bit_field && level->file_version >= FILE_VERSION_2_0)
2669     chunk_size_expected += content_size;
2670
2671   if (chunk_size_expected != chunk_size)
2672   {
2673     ReadUnusedBytesFromFile(file, chunk_size);
2674     return chunk_size_expected;
2675   }
2676
2677   getFile8Bit(file);
2678   level->num_yamyam_contents = getFile8Bit(file);
2679   getFile8Bit(file);
2680   getFile8Bit(file);
2681
2682   // correct invalid number of content fields -- should never happen
2683   if (level->num_yamyam_contents < 1 ||
2684       level->num_yamyam_contents > MAX_ELEMENT_CONTENTS)
2685     level->num_yamyam_contents = STD_ELEMENT_CONTENTS;
2686
2687   for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
2688     for (y = 0; y < 3; y++)
2689       for (x = 0; x < 3; x++)
2690         level->yamyam_content[i].e[x][y] =
2691           getMappedElement(level->encoding_16bit_field ?
2692                            getFile16BitBE(file) : getFile8Bit(file));
2693   return chunk_size;
2694 }
2695
2696 static int LoadLevel_CNT2(File *file, int chunk_size, struct LevelInfo *level)
2697 {
2698   int i, x, y;
2699   int element;
2700   int num_contents;
2701   int content_array[MAX_ELEMENT_CONTENTS][3][3];
2702
2703   element = getMappedElement(getFile16BitBE(file));
2704   num_contents = getFile8Bit(file);
2705
2706   getFile8Bit(file);    // content x size (unused)
2707   getFile8Bit(file);    // content y size (unused)
2708
2709   ReadUnusedBytesFromFile(file, LEVEL_CHUNK_CNT2_UNUSED);
2710
2711   for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
2712     for (y = 0; y < 3; y++)
2713       for (x = 0; x < 3; x++)
2714         content_array[i][x][y] = getMappedElement(getFile16BitBE(file));
2715
2716   // correct invalid number of content fields -- should never happen
2717   if (num_contents < 1 || num_contents > MAX_ELEMENT_CONTENTS)
2718     num_contents = STD_ELEMENT_CONTENTS;
2719
2720   if (element == EL_YAMYAM)
2721   {
2722     level->num_yamyam_contents = num_contents;
2723
2724     for (i = 0; i < num_contents; i++)
2725       for (y = 0; y < 3; y++)
2726         for (x = 0; x < 3; x++)
2727           level->yamyam_content[i].e[x][y] = content_array[i][x][y];
2728   }
2729   else if (element == EL_BD_AMOEBA)
2730   {
2731     level->amoeba_content = content_array[0][0][0];
2732   }
2733   else
2734   {
2735     Warn("cannot load content for element '%d'", element);
2736   }
2737
2738   return chunk_size;
2739 }
2740
2741 static int LoadLevel_CNT3(File *file, int chunk_size, struct LevelInfo *level)
2742 {
2743   int i;
2744   int element;
2745   int envelope_nr;
2746   int envelope_len;
2747   int chunk_size_expected;
2748
2749   element = getMappedElement(getFile16BitBE(file));
2750   if (!IS_ENVELOPE(element))
2751     element = EL_ENVELOPE_1;
2752
2753   envelope_nr = element - EL_ENVELOPE_1;
2754
2755   envelope_len = getFile16BitBE(file);
2756
2757   level->envelope[envelope_nr].xsize = getFile8Bit(file);
2758   level->envelope[envelope_nr].ysize = getFile8Bit(file);
2759
2760   ReadUnusedBytesFromFile(file, LEVEL_CHUNK_CNT3_UNUSED);
2761
2762   chunk_size_expected = LEVEL_CHUNK_CNT3_SIZE(envelope_len);
2763   if (chunk_size_expected != chunk_size)
2764   {
2765     ReadUnusedBytesFromFile(file, chunk_size - LEVEL_CHUNK_CNT3_HEADER);
2766     return chunk_size_expected;
2767   }
2768
2769   for (i = 0; i < envelope_len; i++)
2770     level->envelope[envelope_nr].text[i] = getFile8Bit(file);
2771
2772   return chunk_size;
2773 }
2774
2775 static int LoadLevel_CUS1(File *file, int chunk_size, struct LevelInfo *level)
2776 {
2777   int num_changed_custom_elements = getFile16BitBE(file);
2778   int chunk_size_expected = 2 + num_changed_custom_elements * 6;
2779   int i;
2780
2781   if (chunk_size_expected != chunk_size)
2782   {
2783     ReadUnusedBytesFromFile(file, chunk_size - 2);
2784     return chunk_size_expected;
2785   }
2786
2787   for (i = 0; i < num_changed_custom_elements; i++)
2788   {
2789     int element = getMappedElement(getFile16BitBE(file));
2790     int properties = getFile32BitBE(file);
2791
2792     if (IS_CUSTOM_ELEMENT(element))
2793       element_info[element].properties[EP_BITFIELD_BASE_NR] = properties;
2794     else
2795       Warn("invalid custom element number %d", element);
2796
2797     // older game versions that wrote level files with CUS1 chunks used
2798     // different default push delay values (not yet stored in level file)
2799     element_info[element].push_delay_fixed = 2;
2800     element_info[element].push_delay_random = 8;
2801   }
2802
2803   level->file_has_custom_elements = TRUE;
2804
2805   return chunk_size;
2806 }
2807
2808 static int LoadLevel_CUS2(File *file, int chunk_size, struct LevelInfo *level)
2809 {
2810   int num_changed_custom_elements = getFile16BitBE(file);
2811   int chunk_size_expected = 2 + num_changed_custom_elements * 4;
2812   int i;
2813
2814   if (chunk_size_expected != chunk_size)
2815   {
2816     ReadUnusedBytesFromFile(file, chunk_size - 2);
2817     return chunk_size_expected;
2818   }
2819
2820   for (i = 0; i < num_changed_custom_elements; i++)
2821   {
2822     int element = getMappedElement(getFile16BitBE(file));
2823     int custom_target_element = getMappedElement(getFile16BitBE(file));
2824
2825     if (IS_CUSTOM_ELEMENT(element))
2826       element_info[element].change->target_element = custom_target_element;
2827     else
2828       Warn("invalid custom element number %d", element);
2829   }
2830
2831   level->file_has_custom_elements = TRUE;
2832
2833   return chunk_size;
2834 }
2835
2836 static int LoadLevel_CUS3(File *file, int chunk_size, struct LevelInfo *level)
2837 {
2838   int num_changed_custom_elements = getFile16BitBE(file);
2839   int chunk_size_expected = LEVEL_CHUNK_CUS3_SIZE(num_changed_custom_elements);
2840   int i, j, x, y;
2841
2842   if (chunk_size_expected != chunk_size)
2843   {
2844     ReadUnusedBytesFromFile(file, chunk_size - 2);
2845     return chunk_size_expected;
2846   }
2847
2848   for (i = 0; i < num_changed_custom_elements; i++)
2849   {
2850     int element = getMappedElement(getFile16BitBE(file));
2851     struct ElementInfo *ei = &element_info[element];
2852     unsigned int event_bits;
2853
2854     if (!IS_CUSTOM_ELEMENT(element))
2855     {
2856       Warn("invalid custom element number %d", element);
2857
2858       element = EL_INTERNAL_DUMMY;
2859     }
2860
2861     for (j = 0; j < MAX_ELEMENT_NAME_LEN; j++)
2862       ei->description[j] = getFile8Bit(file);
2863     ei->description[MAX_ELEMENT_NAME_LEN] = 0;
2864
2865     ei->properties[EP_BITFIELD_BASE_NR] = getFile32BitBE(file);
2866
2867     // some free bytes for future properties and padding
2868     ReadUnusedBytesFromFile(file, 7);
2869
2870     ei->use_gfx_element = getFile8Bit(file);
2871     ei->gfx_element_initial = getMappedElement(getFile16BitBE(file));
2872
2873     ei->collect_score_initial = getFile8Bit(file);
2874     ei->collect_count_initial = getFile8Bit(file);
2875
2876     ei->push_delay_fixed = getFile16BitBE(file);
2877     ei->push_delay_random = getFile16BitBE(file);
2878     ei->move_delay_fixed = getFile16BitBE(file);
2879     ei->move_delay_random = getFile16BitBE(file);
2880
2881     ei->move_pattern = getFile16BitBE(file);
2882     ei->move_direction_initial = getFile8Bit(file);
2883     ei->move_stepsize = getFile8Bit(file);
2884
2885     for (y = 0; y < 3; y++)
2886       for (x = 0; x < 3; x++)
2887         ei->content.e[x][y] = getMappedElement(getFile16BitBE(file));
2888
2889     // bits 0 - 31 of "has_event[]"
2890     event_bits = getFile32BitBE(file);
2891     for (j = 0; j < MIN(NUM_CHANGE_EVENTS, 32); j++)
2892       if (event_bits & (1u << j))
2893         ei->change->has_event[j] = TRUE;
2894
2895     ei->change->target_element = getMappedElement(getFile16BitBE(file));
2896
2897     ei->change->delay_fixed = getFile16BitBE(file);
2898     ei->change->delay_random = getFile16BitBE(file);
2899     ei->change->delay_frames = getFile16BitBE(file);
2900
2901     ei->change->initial_trigger_element = getMappedElement(getFile16BitBE(file));
2902
2903     ei->change->explode = getFile8Bit(file);
2904     ei->change->use_target_content = getFile8Bit(file);
2905     ei->change->only_if_complete = getFile8Bit(file);
2906     ei->change->use_random_replace = getFile8Bit(file);
2907
2908     ei->change->random_percentage = getFile8Bit(file);
2909     ei->change->replace_when = getFile8Bit(file);
2910
2911     for (y = 0; y < 3; y++)
2912       for (x = 0; x < 3; x++)
2913         ei->change->target_content.e[x][y] =
2914           getMappedElement(getFile16BitBE(file));
2915
2916     ei->slippery_type = getFile8Bit(file);
2917
2918     // some free bytes for future properties and padding
2919     ReadUnusedBytesFromFile(file, LEVEL_CPART_CUS3_UNUSED);
2920
2921     // mark that this custom element has been modified
2922     ei->modified_settings = TRUE;
2923   }
2924
2925   level->file_has_custom_elements = TRUE;
2926
2927   return chunk_size;
2928 }
2929
2930 static int LoadLevel_CUS4(File *file, int chunk_size, struct LevelInfo *level)
2931 {
2932   struct ElementInfo *ei;
2933   int chunk_size_expected;
2934   int element;
2935   int i, j, x, y;
2936
2937   // ---------- custom element base property values (96 bytes) ----------------
2938
2939   element = getMappedElement(getFile16BitBE(file));
2940
2941   if (!IS_CUSTOM_ELEMENT(element))
2942   {
2943     Warn("invalid custom element number %d", element);
2944
2945     ReadUnusedBytesFromFile(file, chunk_size - 2);
2946
2947     return chunk_size;
2948   }
2949
2950   ei = &element_info[element];
2951
2952   for (i = 0; i < MAX_ELEMENT_NAME_LEN; i++)
2953     ei->description[i] = getFile8Bit(file);
2954   ei->description[MAX_ELEMENT_NAME_LEN] = 0;
2955
2956   ei->properties[EP_BITFIELD_BASE_NR] = getFile32BitBE(file);
2957
2958   ReadUnusedBytesFromFile(file, 4);     // reserved for more base properties
2959
2960   ei->num_change_pages = getFile8Bit(file);
2961
2962   chunk_size_expected = LEVEL_CHUNK_CUS4_SIZE(ei->num_change_pages);
2963   if (chunk_size_expected != chunk_size)
2964   {
2965     ReadUnusedBytesFromFile(file, chunk_size - 43);
2966     return chunk_size_expected;
2967   }
2968
2969   ei->ce_value_fixed_initial = getFile16BitBE(file);
2970   ei->ce_value_random_initial = getFile16BitBE(file);
2971   ei->use_last_ce_value = getFile8Bit(file);
2972
2973   ei->use_gfx_element = getFile8Bit(file);
2974   ei->gfx_element_initial = getMappedElement(getFile16BitBE(file));
2975
2976   ei->collect_score_initial = getFile8Bit(file);
2977   ei->collect_count_initial = getFile8Bit(file);
2978
2979   ei->drop_delay_fixed = getFile8Bit(file);
2980   ei->push_delay_fixed = getFile8Bit(file);
2981   ei->drop_delay_random = getFile8Bit(file);
2982   ei->push_delay_random = getFile8Bit(file);
2983   ei->move_delay_fixed = getFile16BitBE(file);
2984   ei->move_delay_random = getFile16BitBE(file);
2985
2986   // bits 0 - 15 of "move_pattern" ...
2987   ei->move_pattern = getFile16BitBE(file);
2988   ei->move_direction_initial = getFile8Bit(file);
2989   ei->move_stepsize = getFile8Bit(file);
2990
2991   ei->slippery_type = getFile8Bit(file);
2992
2993   for (y = 0; y < 3; y++)
2994     for (x = 0; x < 3; x++)
2995       ei->content.e[x][y] = getMappedElement(getFile16BitBE(file));
2996
2997   ei->move_enter_element = getMappedElement(getFile16BitBE(file));
2998   ei->move_leave_element = getMappedElement(getFile16BitBE(file));
2999   ei->move_leave_type = getFile8Bit(file);
3000
3001   // ... bits 16 - 31 of "move_pattern" (not nice, but downward compatible)
3002   ei->move_pattern |= (getFile16BitBE(file) << 16);
3003
3004   ei->access_direction = getFile8Bit(file);
3005
3006   ei->explosion_delay = getFile8Bit(file);
3007   ei->ignition_delay = getFile8Bit(file);
3008   ei->explosion_type = getFile8Bit(file);
3009
3010   // some free bytes for future custom property values and padding
3011   ReadUnusedBytesFromFile(file, 1);
3012
3013   // ---------- change page property values (48 bytes) ------------------------
3014
3015   setElementChangePages(ei, ei->num_change_pages);
3016
3017   for (i = 0; i < ei->num_change_pages; i++)
3018   {
3019     struct ElementChangeInfo *change = &ei->change_page[i];
3020     unsigned int event_bits;
3021
3022     // always start with reliable default values
3023     setElementChangeInfoToDefaults(change);
3024
3025     // bits 0 - 31 of "has_event[]" ...
3026     event_bits = getFile32BitBE(file);
3027     for (j = 0; j < MIN(NUM_CHANGE_EVENTS, 32); j++)
3028       if (event_bits & (1u << j))
3029         change->has_event[j] = TRUE;
3030
3031     change->target_element = getMappedElement(getFile16BitBE(file));
3032
3033     change->delay_fixed = getFile16BitBE(file);
3034     change->delay_random = getFile16BitBE(file);
3035     change->delay_frames = getFile16BitBE(file);
3036
3037     change->initial_trigger_element = getMappedElement(getFile16BitBE(file));
3038
3039     change->explode = getFile8Bit(file);
3040     change->use_target_content = getFile8Bit(file);
3041     change->only_if_complete = getFile8Bit(file);
3042     change->use_random_replace = getFile8Bit(file);
3043
3044     change->random_percentage = getFile8Bit(file);
3045     change->replace_when = getFile8Bit(file);
3046
3047     for (y = 0; y < 3; y++)
3048       for (x = 0; x < 3; x++)
3049         change->target_content.e[x][y]= getMappedElement(getFile16BitBE(file));
3050
3051     change->can_change = getFile8Bit(file);
3052
3053     change->trigger_side = getFile8Bit(file);
3054
3055     change->trigger_player = getFile8Bit(file);
3056     change->trigger_page = getFile8Bit(file);
3057
3058     change->trigger_page = (change->trigger_page == CH_PAGE_ANY_FILE ?
3059                             CH_PAGE_ANY : (1 << change->trigger_page));
3060
3061     change->has_action = getFile8Bit(file);
3062     change->action_type = getFile8Bit(file);
3063     change->action_mode = getFile8Bit(file);
3064     change->action_arg = getFile16BitBE(file);
3065
3066     // ... bits 32 - 39 of "has_event[]" (not nice, but downward compatible)
3067     event_bits = getFile8Bit(file);
3068     for (j = 32; j < NUM_CHANGE_EVENTS; j++)
3069       if (event_bits & (1u << (j - 32)))
3070         change->has_event[j] = TRUE;
3071   }
3072
3073   // mark this custom element as modified
3074   ei->modified_settings = TRUE;
3075
3076   level->file_has_custom_elements = TRUE;
3077
3078   return chunk_size;
3079 }
3080
3081 static int LoadLevel_GRP1(File *file, int chunk_size, struct LevelInfo *level)
3082 {
3083   struct ElementInfo *ei;
3084   struct ElementGroupInfo *group;
3085   int element;
3086   int i;
3087
3088   element = getMappedElement(getFile16BitBE(file));
3089
3090   if (!IS_GROUP_ELEMENT(element))
3091   {
3092     Warn("invalid group element number %d", element);
3093
3094     ReadUnusedBytesFromFile(file, chunk_size - 2);
3095
3096     return chunk_size;
3097   }
3098
3099   ei = &element_info[element];
3100
3101   for (i = 0; i < MAX_ELEMENT_NAME_LEN; i++)
3102     ei->description[i] = getFile8Bit(file);
3103   ei->description[MAX_ELEMENT_NAME_LEN] = 0;
3104
3105   group = element_info[element].group;
3106
3107   group->num_elements = getFile8Bit(file);
3108
3109   ei->use_gfx_element = getFile8Bit(file);
3110   ei->gfx_element_initial = getMappedElement(getFile16BitBE(file));
3111
3112   group->choice_mode = getFile8Bit(file);
3113
3114   // some free bytes for future values and padding
3115   ReadUnusedBytesFromFile(file, 3);
3116
3117   for (i = 0; i < MAX_ELEMENTS_IN_GROUP; i++)
3118     group->element[i] = getMappedElement(getFile16BitBE(file));
3119
3120   // mark this group element as modified
3121   element_info[element].modified_settings = TRUE;
3122
3123   level->file_has_custom_elements = TRUE;
3124
3125   return chunk_size;
3126 }
3127
3128 static int LoadLevel_MicroChunk(File *file, struct LevelFileConfigInfo *conf,
3129                                 int element, int real_element)
3130 {
3131   int micro_chunk_size = 0;
3132   int conf_type = getFile8Bit(file);
3133   int byte_mask = conf_type & CONF_MASK_BYTES;
3134   boolean element_found = FALSE;
3135   int i;
3136
3137   micro_chunk_size += 1;
3138
3139   if (byte_mask == CONF_MASK_MULTI_BYTES)
3140   {
3141     int num_bytes = getFile16BitBE(file);
3142     byte *buffer = checked_malloc(num_bytes);
3143
3144     ReadBytesFromFile(file, buffer, num_bytes);
3145
3146     for (i = 0; conf[i].data_type != -1; i++)
3147     {
3148       if (conf[i].element == element &&
3149           conf[i].conf_type == conf_type)
3150       {
3151         int data_type = conf[i].data_type;
3152         int num_entities = num_bytes / CONF_ENTITY_NUM_BYTES(data_type);
3153         int max_num_entities = conf[i].max_num_entities;
3154
3155         if (num_entities > max_num_entities)
3156         {
3157           Warn("truncating number of entities for element %d from %d to %d",
3158                element, num_entities, max_num_entities);
3159
3160           num_entities = max_num_entities;
3161         }
3162
3163         if (num_entities == 0 && (data_type == TYPE_ELEMENT_LIST ||
3164                                   data_type == TYPE_CONTENT_LIST))
3165         {
3166           // for element and content lists, zero entities are not allowed
3167           Warn("found empty list of entities for element %d", element);
3168
3169           // do not set "num_entities" here to prevent reading behind buffer
3170
3171           *(int *)(conf[i].num_entities) = 1;   // at least one is required
3172         }
3173         else
3174         {
3175           *(int *)(conf[i].num_entities) = num_entities;
3176         }
3177
3178         element_found = TRUE;
3179
3180         if (data_type == TYPE_STRING)
3181         {
3182           char *string = (char *)(conf[i].value);
3183           int j;
3184
3185           for (j = 0; j < max_num_entities; j++)
3186             string[j] = (j < num_entities ? buffer[j] : '\0');
3187         }
3188         else if (data_type == TYPE_ELEMENT_LIST)
3189         {
3190           int *element_array = (int *)(conf[i].value);
3191           int j;
3192
3193           for (j = 0; j < num_entities; j++)
3194             element_array[j] =
3195               getMappedElement(CONF_ELEMENTS_ELEMENT(buffer, j));
3196         }
3197         else if (data_type == TYPE_CONTENT_LIST)
3198         {
3199           struct Content *content= (struct Content *)(conf[i].value);
3200           int c, x, y;
3201
3202           for (c = 0; c < num_entities; c++)
3203             for (y = 0; y < 3; y++)
3204               for (x = 0; x < 3; x++)
3205                 content[c].e[x][y] =
3206                   getMappedElement(CONF_CONTENTS_ELEMENT(buffer, c, x, y));
3207         }
3208         else
3209           element_found = FALSE;
3210
3211         break;
3212       }
3213     }
3214
3215     checked_free(buffer);
3216
3217     micro_chunk_size += 2 + num_bytes;
3218   }
3219   else          // constant size configuration data (1, 2 or 4 bytes)
3220   {
3221     int value = (byte_mask == CONF_MASK_1_BYTE ? getFile8Bit   (file) :
3222                  byte_mask == CONF_MASK_2_BYTE ? getFile16BitBE(file) :
3223                  byte_mask == CONF_MASK_4_BYTE ? getFile32BitBE(file) : 0);
3224
3225     for (i = 0; conf[i].data_type != -1; i++)
3226     {
3227       if (conf[i].element == element &&
3228           conf[i].conf_type == conf_type)
3229       {
3230         int data_type = conf[i].data_type;
3231
3232         if (data_type == TYPE_ELEMENT)
3233           value = getMappedElement(value);
3234
3235         if (data_type == TYPE_BOOLEAN)
3236           *(boolean *)(conf[i].value) = (value ? TRUE : FALSE);
3237         else
3238           *(int *)    (conf[i].value) = value;
3239
3240         element_found = TRUE;
3241
3242         break;
3243       }
3244     }
3245
3246     micro_chunk_size += CONF_VALUE_NUM_BYTES(byte_mask);
3247   }
3248
3249   if (!element_found)
3250   {
3251     char *error_conf_chunk_bytes =
3252       (byte_mask == CONF_MASK_1_BYTE ? "CONF_VALUE_8_BIT" :
3253        byte_mask == CONF_MASK_2_BYTE ? "CONF_VALUE_16_BIT" :
3254        byte_mask == CONF_MASK_4_BYTE ? "CONF_VALUE_32_BIT" :"CONF_VALUE_BYTES");
3255     int error_conf_chunk_token = conf_type & CONF_MASK_TOKEN;
3256     int error_element = real_element;
3257
3258     Warn("cannot load micro chunk '%s(%d)' value for element %d ['%s']",
3259          error_conf_chunk_bytes, error_conf_chunk_token,
3260          error_element, EL_NAME(error_element));
3261   }
3262
3263   return micro_chunk_size;
3264 }
3265
3266 static int LoadLevel_INFO(File *file, int chunk_size, struct LevelInfo *level)
3267 {
3268   int real_chunk_size = 0;
3269
3270   li = *level;          // copy level data into temporary buffer
3271
3272   while (!checkEndOfFile(file))
3273   {
3274     real_chunk_size += LoadLevel_MicroChunk(file, chunk_config_INFO, -1, -1);
3275
3276     if (real_chunk_size >= chunk_size)
3277       break;
3278   }
3279
3280   *level = li;          // copy temporary buffer back to level data
3281
3282   return real_chunk_size;
3283 }
3284
3285 static int LoadLevel_CONF(File *file, int chunk_size, struct LevelInfo *level)
3286 {
3287   int real_chunk_size = 0;
3288
3289   li = *level;          // copy level data into temporary buffer
3290
3291   while (!checkEndOfFile(file))
3292   {
3293     int element = getMappedElement(getFile16BitBE(file));
3294
3295     real_chunk_size += 2;
3296     real_chunk_size += LoadLevel_MicroChunk(file, chunk_config_CONF,
3297                                             element, element);
3298     if (real_chunk_size >= chunk_size)
3299       break;
3300   }
3301
3302   *level = li;          // copy temporary buffer back to level data
3303
3304   return real_chunk_size;
3305 }
3306
3307 static int LoadLevel_ELEM(File *file, int chunk_size, struct LevelInfo *level)
3308 {
3309   int real_chunk_size = 0;
3310
3311   li = *level;          // copy level data into temporary buffer
3312
3313   while (!checkEndOfFile(file))
3314   {
3315     int element = getMappedElement(getFile16BitBE(file));
3316
3317     real_chunk_size += 2;
3318     real_chunk_size += LoadLevel_MicroChunk(file, chunk_config_ELEM,
3319                                             element, element);
3320     if (real_chunk_size >= chunk_size)
3321       break;
3322   }
3323
3324   *level = li;          // copy temporary buffer back to level data
3325
3326   return real_chunk_size;
3327 }
3328
3329 static int LoadLevel_NOTE(File *file, int chunk_size, struct LevelInfo *level)
3330 {
3331   int element = getMappedElement(getFile16BitBE(file));
3332   int envelope_nr = element - EL_ENVELOPE_1;
3333   int real_chunk_size = 2;
3334
3335   xx_envelope = level->envelope[envelope_nr];   // copy into temporary buffer
3336
3337   while (!checkEndOfFile(file))
3338   {
3339     real_chunk_size += LoadLevel_MicroChunk(file, chunk_config_NOTE,
3340                                             -1, element);
3341
3342     if (real_chunk_size >= chunk_size)
3343       break;
3344   }
3345
3346   level->envelope[envelope_nr] = xx_envelope;   // copy from temporary buffer
3347
3348   return real_chunk_size;
3349 }
3350
3351 static int LoadLevel_CUSX(File *file, int chunk_size, struct LevelInfo *level)
3352 {
3353   int element = getMappedElement(getFile16BitBE(file));
3354   int real_chunk_size = 2;
3355   struct ElementInfo *ei = &element_info[element];
3356   int i;
3357
3358   xx_ei = *ei;          // copy element data into temporary buffer
3359
3360   xx_ei.num_change_pages = -1;
3361
3362   while (!checkEndOfFile(file))
3363   {
3364     real_chunk_size += LoadLevel_MicroChunk(file, chunk_config_CUSX_base,
3365                                             -1, element);
3366     if (xx_ei.num_change_pages != -1)
3367       break;
3368
3369     if (real_chunk_size >= chunk_size)
3370       break;
3371   }
3372
3373   *ei = xx_ei;
3374
3375   if (ei->num_change_pages == -1)
3376   {
3377     Warn("LoadLevel_CUSX(): missing 'num_change_pages' for '%s'",
3378          EL_NAME(element));
3379
3380     ei->num_change_pages = 1;
3381
3382     setElementChangePages(ei, 1);
3383     setElementChangeInfoToDefaults(ei->change);
3384
3385     return real_chunk_size;
3386   }
3387
3388   // initialize number of change pages stored for this custom element
3389   setElementChangePages(ei, ei->num_change_pages);
3390   for (i = 0; i < ei->num_change_pages; i++)
3391     setElementChangeInfoToDefaults(&ei->change_page[i]);
3392
3393   // start with reading properties for the first change page
3394   xx_current_change_page = 0;
3395
3396   while (!checkEndOfFile(file))
3397   {
3398     // level file might contain invalid change page number
3399     if (xx_current_change_page >= ei->num_change_pages)
3400       break;
3401
3402     struct ElementChangeInfo *change = &ei->change_page[xx_current_change_page];
3403
3404     xx_change = *change;        // copy change data into temporary buffer
3405
3406     resetEventBits();           // reset bits; change page might have changed
3407
3408     real_chunk_size += LoadLevel_MicroChunk(file, chunk_config_CUSX_change,
3409                                             -1, element);
3410
3411     *change = xx_change;
3412
3413     setEventFlagsFromEventBits(change);
3414
3415     if (real_chunk_size >= chunk_size)
3416       break;
3417   }
3418
3419   level->file_has_custom_elements = TRUE;
3420
3421   return real_chunk_size;
3422 }
3423
3424 static int LoadLevel_GRPX(File *file, int chunk_size, struct LevelInfo *level)
3425 {
3426   int element = getMappedElement(getFile16BitBE(file));
3427   int real_chunk_size = 2;
3428   struct ElementInfo *ei = &element_info[element];
3429   struct ElementGroupInfo *group = ei->group;
3430
3431   if (group == NULL)
3432     return -1;
3433
3434   xx_ei = *ei;          // copy element data into temporary buffer
3435   xx_group = *group;    // copy group data into temporary buffer
3436
3437   while (!checkEndOfFile(file))
3438   {
3439     real_chunk_size += LoadLevel_MicroChunk(file, chunk_config_GRPX,
3440                                             -1, element);
3441
3442     if (real_chunk_size >= chunk_size)
3443       break;
3444   }
3445
3446   *ei = xx_ei;
3447   *group = xx_group;
3448
3449   level->file_has_custom_elements = TRUE;
3450
3451   return real_chunk_size;
3452 }
3453
3454 static int LoadLevel_EMPX(File *file, int chunk_size, struct LevelInfo *level)
3455 {
3456   int element = getMappedElement(getFile16BitBE(file));
3457   int real_chunk_size = 2;
3458   struct ElementInfo *ei = &element_info[element];
3459
3460   xx_ei = *ei;          // copy element data into temporary buffer
3461
3462   while (!checkEndOfFile(file))
3463   {
3464     real_chunk_size += LoadLevel_MicroChunk(file, chunk_config_EMPX,
3465                                             -1, element);
3466
3467     if (real_chunk_size >= chunk_size)
3468       break;
3469   }
3470
3471   *ei = xx_ei;
3472
3473   level->file_has_custom_elements = TRUE;
3474
3475   return real_chunk_size;
3476 }
3477
3478 static void LoadLevelFromFileInfo_RND(struct LevelInfo *level,
3479                                       struct LevelFileInfo *level_file_info,
3480                                       boolean level_info_only)
3481 {
3482   char *filename = level_file_info->filename;
3483   char cookie[MAX_LINE_LEN];
3484   char chunk_name[CHUNK_ID_LEN + 1];
3485   int chunk_size;
3486   File *file;
3487
3488   if (!(file = openFile(filename, MODE_READ)))
3489   {
3490     level->no_valid_file = TRUE;
3491     level->no_level_file = TRUE;
3492
3493     if (level_info_only)
3494       return;
3495
3496     Warn("cannot read level '%s' -- using empty level", filename);
3497
3498     if (!setup.editor.use_template_for_new_levels)
3499       return;
3500
3501     // if level file not found, try to initialize level data from template
3502     filename = getGlobalLevelTemplateFilename();
3503
3504     if (!(file = openFile(filename, MODE_READ)))
3505       return;
3506
3507     // default: for empty levels, use level template for custom elements
3508     level->use_custom_template = TRUE;
3509
3510     level->no_valid_file = FALSE;
3511   }
3512
3513   getFileChunkBE(file, chunk_name, NULL);
3514   if (strEqual(chunk_name, "RND1"))
3515   {
3516     getFile32BitBE(file);               // not used
3517
3518     getFileChunkBE(file, chunk_name, NULL);
3519     if (!strEqual(chunk_name, "CAVE"))
3520     {
3521       level->no_valid_file = TRUE;
3522
3523       Warn("unknown format of level file '%s'", filename);
3524
3525       closeFile(file);
3526
3527       return;
3528     }
3529   }
3530   else  // check for pre-2.0 file format with cookie string
3531   {
3532     strcpy(cookie, chunk_name);
3533     if (getStringFromFile(file, &cookie[4], MAX_LINE_LEN - 4) == NULL)
3534       cookie[4] = '\0';
3535     if (strlen(cookie) > 0 && cookie[strlen(cookie) - 1] == '\n')
3536       cookie[strlen(cookie) - 1] = '\0';
3537
3538     if (!checkCookieString(cookie, LEVEL_COOKIE_TMPL))
3539     {
3540       level->no_valid_file = TRUE;
3541
3542       Warn("unknown format of level file '%s'", filename);
3543
3544       closeFile(file);
3545
3546       return;
3547     }
3548
3549     if ((level->file_version = getFileVersionFromCookieString(cookie)) == -1)
3550     {
3551       level->no_valid_file = TRUE;
3552
3553       Warn("unsupported version of level file '%s'", filename);
3554
3555       closeFile(file);
3556
3557       return;
3558     }
3559
3560     // pre-2.0 level files have no game version, so use file version here
3561     level->game_version = level->file_version;
3562   }
3563
3564   if (level->file_version < FILE_VERSION_1_2)
3565   {
3566     // level files from versions before 1.2.0 without chunk structure
3567     LoadLevel_HEAD(file, LEVEL_CHUNK_HEAD_SIZE,         level);
3568     LoadLevel_BODY(file, level->fieldx * level->fieldy, level);
3569   }
3570   else
3571   {
3572     static struct
3573     {
3574       char *name;
3575       int size;
3576       int (*loader)(File *, int, struct LevelInfo *);
3577     }
3578     chunk_info[] =
3579     {
3580       { "VERS", LEVEL_CHUNK_VERS_SIZE,  LoadLevel_VERS },
3581       { "DATE", LEVEL_CHUNK_DATE_SIZE,  LoadLevel_DATE },
3582       { "HEAD", LEVEL_CHUNK_HEAD_SIZE,  LoadLevel_HEAD },
3583       { "NAME", LEVEL_CHUNK_NAME_SIZE,  LoadLevel_NAME },
3584       { "AUTH", LEVEL_CHUNK_AUTH_SIZE,  LoadLevel_AUTH },
3585       { "INFO", -1,                     LoadLevel_INFO },
3586       { "BODY", -1,                     LoadLevel_BODY },
3587       { "CONT", -1,                     LoadLevel_CONT },
3588       { "CNT2", LEVEL_CHUNK_CNT2_SIZE,  LoadLevel_CNT2 },
3589       { "CNT3", -1,                     LoadLevel_CNT3 },
3590       { "CUS1", -1,                     LoadLevel_CUS1 },
3591       { "CUS2", -1,                     LoadLevel_CUS2 },
3592       { "CUS3", -1,                     LoadLevel_CUS3 },
3593       { "CUS4", -1,                     LoadLevel_CUS4 },
3594       { "GRP1", -1,                     LoadLevel_GRP1 },
3595       { "CONF", -1,                     LoadLevel_CONF },
3596       { "ELEM", -1,                     LoadLevel_ELEM },
3597       { "NOTE", -1,                     LoadLevel_NOTE },
3598       { "CUSX", -1,                     LoadLevel_CUSX },
3599       { "GRPX", -1,                     LoadLevel_GRPX },
3600       { "EMPX", -1,                     LoadLevel_EMPX },
3601
3602       {  NULL,  0,                      NULL }
3603     };
3604
3605     while (getFileChunkBE(file, chunk_name, &chunk_size))
3606     {
3607       int i = 0;
3608
3609       while (chunk_info[i].name != NULL &&
3610              !strEqual(chunk_name, chunk_info[i].name))
3611         i++;
3612
3613       if (chunk_info[i].name == NULL)
3614       {
3615         Warn("unknown chunk '%s' in level file '%s'",
3616              chunk_name, filename);
3617
3618         ReadUnusedBytesFromFile(file, chunk_size);
3619       }
3620       else if (chunk_info[i].size != -1 &&
3621                chunk_info[i].size != chunk_size)
3622       {
3623         Warn("wrong size (%d) of chunk '%s' in level file '%s'",
3624              chunk_size, chunk_name, filename);
3625
3626         ReadUnusedBytesFromFile(file, chunk_size);
3627       }
3628       else
3629       {
3630         // call function to load this level chunk
3631         int chunk_size_expected =
3632           (chunk_info[i].loader)(file, chunk_size, level);
3633
3634         if (chunk_size_expected < 0)
3635         {
3636           Warn("error reading chunk '%s' in level file '%s'",
3637                chunk_name, filename);
3638
3639           break;
3640         }
3641
3642         // the size of some chunks cannot be checked before reading other
3643         // chunks first (like "HEAD" and "BODY") that contain some header
3644         // information, so check them here
3645         if (chunk_size_expected != chunk_size)
3646         {
3647           Warn("wrong size (%d) of chunk '%s' in level file '%s'",
3648                chunk_size, chunk_name, filename);
3649
3650           break;
3651         }
3652       }
3653     }
3654   }
3655
3656   closeFile(file);
3657 }
3658
3659
3660 // ----------------------------------------------------------------------------
3661 // functions for loading BD level
3662 // ----------------------------------------------------------------------------
3663
3664 static void CopyNativeLevel_RND_to_BD(struct LevelInfo *level)
3665 {
3666   struct LevelInfo_BD *level_bd = level->native_bd_level;
3667   GdCave *cave = NULL;  // will be changed below
3668   int cave_w = MIN(level->fieldx, MAX_PLAYFIELD_WIDTH);
3669   int cave_h = MIN(level->fieldy, MAX_PLAYFIELD_HEIGHT);
3670   int i, x, y;
3671
3672   setLevelInfoToDefaults_BD_Ext(cave_w, cave_h);
3673
3674   // cave and map newly allocated when set to defaults above
3675   cave = level_bd->cave;
3676
3677   for (i = 0; i < 5; i++)
3678   {
3679     cave->level_time[i]                 = level->time;
3680     cave->level_diamonds[i]             = level->gems_needed;
3681     cave->level_magic_wall_time[i]      = level->time_magic_wall;
3682     cave->level_timevalue[i]            = level->score[SC_TIME_BONUS];
3683   }
3684
3685   cave->diamond_value                   = level->score[SC_DIAMOND];
3686   cave->extra_diamond_value             = level->score[SC_DIAMOND];
3687
3688   cave->level_speed[0]                  = 160;  // set cave speed
3689
3690   strncpy(cave->name, level->name, sizeof(GdString));
3691   cave->name[sizeof(GdString) - 1] = '\0';
3692
3693   for (x = 0; x < cave->w; x++)
3694     for (y = 0; y < cave->h; y++)
3695       cave->map[y][x] = map_element_RND_to_BD(level->field[x][y]);
3696 }
3697
3698 static void CopyNativeLevel_BD_to_RND(struct LevelInfo *level)
3699 {
3700   struct LevelInfo_BD *level_bd = level->native_bd_level;
3701   GdCave *cave = level_bd->cave;
3702   int bd_level_nr = level_bd->level_nr;
3703   int x, y;
3704
3705   level->fieldx = MIN(cave->w, MAX_LEV_FIELDX);
3706   level->fieldy = MIN(cave->h, MAX_LEV_FIELDY);
3707
3708   level->time                   = cave->level_time[bd_level_nr];
3709   level->gems_needed            = cave->level_diamonds[bd_level_nr];
3710   level->time_magic_wall        = cave->level_magic_wall_time[bd_level_nr];
3711
3712   level->score[SC_TIME_BONUS]   = cave->level_timevalue[bd_level_nr];
3713   level->score[SC_DIAMOND]      = cave->diamond_value;
3714
3715   strncpy(level->name, cave->name, MAX_LEVEL_NAME_LEN);
3716   level->name[MAX_LEVEL_NAME_LEN] = '\0';
3717
3718   for (x = 0; x < level->fieldx; x++)
3719     for (y = 0; y < level->fieldy; y++)
3720       level->field[x][y] = map_element_BD_to_RND(cave->map[y][x]);
3721 }
3722
3723 static void setTapeInfoToDefaults(void);
3724
3725 static void CopyNativeTape_BD_to_RND(struct LevelInfo *level)
3726 {
3727   struct LevelInfo_BD *level_bd = level->native_bd_level;
3728   GdCave *cave = level_bd->cave;
3729   GdReplay *replay = level_bd->replay;
3730   int i;
3731
3732   if (replay == NULL)
3733     return;
3734
3735   // always start with reliable default values
3736   setTapeInfoToDefaults();
3737
3738   tape.level_nr = level_nr;             // (currently not used)
3739   tape.random_seed = replay->seed;
3740
3741   TapeSetDateFromIsoDateString(replay->date);
3742
3743   tape.counter = 0;
3744   tape.pos[tape.counter].delay = 0;
3745
3746   tape.bd_replay = TRUE;
3747
3748   // all time calculations only used to display approximate tape time
3749   int cave_speed = cave->speed;
3750   int milliseconds_game = 0;
3751   int milliseconds_elapsed = 20;
3752
3753   for (i = 0; i < replay->movements->len; i++)
3754   {
3755     int replay_action = replay->movements->data[i];
3756     int tape_action = map_action_BD_to_RND(replay_action);
3757     byte action[MAX_TAPE_ACTIONS] = { tape_action };
3758     boolean success = 0;
3759
3760     while (1)
3761     {
3762       success = TapeAddAction(action);
3763
3764       milliseconds_game += milliseconds_elapsed;
3765
3766       if (milliseconds_game >= cave_speed)
3767       {
3768         milliseconds_game -= cave_speed;
3769
3770         break;
3771       }
3772     }
3773
3774     tape.counter++;
3775     tape.pos[tape.counter].delay = 0;
3776     tape.pos[tape.counter].action[0] = 0;
3777
3778     if (!success)
3779     {
3780       Warn("BD replay truncated: size exceeds maximum tape size %d", MAX_TAPE_LEN);
3781
3782       break;
3783     }
3784   }
3785
3786   TapeHaltRecording();
3787 }
3788
3789
3790 // ----------------------------------------------------------------------------
3791 // functions for loading EM level
3792 // ----------------------------------------------------------------------------
3793
3794 static void CopyNativeLevel_RND_to_EM(struct LevelInfo *level)
3795 {
3796   static int ball_xy[8][2] =
3797   {
3798     { 0, 0 },
3799     { 1, 0 },
3800     { 2, 0 },
3801     { 0, 1 },
3802     { 2, 1 },
3803     { 0, 2 },
3804     { 1, 2 },
3805     { 2, 2 },
3806   };
3807   struct LevelInfo_EM *level_em = level->native_em_level;
3808   struct CAVE *cav = level_em->cav;
3809   int i, j, x, y;
3810
3811   cav->width  = MIN(level->fieldx, MAX_PLAYFIELD_WIDTH);
3812   cav->height = MIN(level->fieldy, MAX_PLAYFIELD_HEIGHT);
3813
3814   cav->time_seconds     = level->time;
3815   cav->gems_needed      = level->gems_needed;
3816
3817   cav->emerald_score    = level->score[SC_EMERALD];
3818   cav->diamond_score    = level->score[SC_DIAMOND];
3819   cav->alien_score      = level->score[SC_ROBOT];
3820   cav->tank_score       = level->score[SC_SPACESHIP];
3821   cav->bug_score        = level->score[SC_BUG];
3822   cav->eater_score      = level->score[SC_YAMYAM];
3823   cav->nut_score        = level->score[SC_NUT];
3824   cav->dynamite_score   = level->score[SC_DYNAMITE];
3825   cav->key_score        = level->score[SC_KEY];
3826   cav->exit_score       = level->score[SC_TIME_BONUS];
3827
3828   cav->num_eater_arrays = level->num_yamyam_contents;
3829
3830   for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
3831     for (y = 0; y < 3; y++)
3832       for (x = 0; x < 3; x++)
3833         cav->eater_array[i][y * 3 + x] =
3834           map_element_RND_to_EM_cave(level->yamyam_content[i].e[x][y]);
3835
3836   cav->amoeba_time              = level->amoeba_speed;
3837   cav->wonderwall_time          = level->time_magic_wall;
3838   cav->wheel_time               = level->time_wheel;
3839
3840   cav->android_move_time        = level->android_move_time;
3841   cav->android_clone_time       = level->android_clone_time;
3842   cav->ball_random              = level->ball_random;
3843   cav->ball_active              = level->ball_active_initial;
3844   cav->ball_time                = level->ball_time;
3845   cav->num_ball_arrays          = level->num_ball_contents;
3846
3847   cav->lenses_score             = level->lenses_score;
3848   cav->magnify_score            = level->magnify_score;
3849   cav->slurp_score              = level->slurp_score;
3850
3851   cav->lenses_time              = level->lenses_time;
3852   cav->magnify_time             = level->magnify_time;
3853
3854   cav->wind_time = 9999;
3855   cav->wind_direction =
3856     map_direction_RND_to_EM(level->wind_direction_initial);
3857
3858   for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
3859     for (j = 0; j < 8; j++)
3860       cav->ball_array[i][j] =
3861         map_element_RND_to_EM_cave(level->ball_content[i].
3862                                    e[ball_xy[j][0]][ball_xy[j][1]]);
3863
3864   map_android_clone_elements_RND_to_EM(level);
3865
3866   // first fill the complete playfield with the empty space element
3867   for (y = 0; y < EM_MAX_CAVE_HEIGHT; y++)
3868     for (x = 0; x < EM_MAX_CAVE_WIDTH; x++)
3869       cav->cave[x][y] = Cblank;
3870
3871   // then copy the real level contents from level file into the playfield
3872   for (y = 0; y < cav->height; y++) for (x = 0; x < cav->width; x++)
3873   {
3874     int new_element = map_element_RND_to_EM_cave(level->field[x][y]);
3875
3876     if (level->field[x][y] == EL_AMOEBA_DEAD)
3877       new_element = map_element_RND_to_EM_cave(EL_AMOEBA_WET);
3878
3879     cav->cave[x][y] = new_element;
3880   }
3881
3882   for (i = 0; i < MAX_PLAYERS; i++)
3883   {
3884     cav->player_x[i] = -1;
3885     cav->player_y[i] = -1;
3886   }
3887
3888   // initialize player positions and delete players from the playfield
3889   for (y = 0; y < cav->height; y++) for (x = 0; x < cav->width; x++)
3890   {
3891     if (IS_PLAYER_ELEMENT(level->field[x][y]))
3892     {
3893       int player_nr = GET_PLAYER_NR(level->field[x][y]);
3894
3895       cav->player_x[player_nr] = x;
3896       cav->player_y[player_nr] = y;
3897
3898       cav->cave[x][y] = map_element_RND_to_EM_cave(EL_EMPTY);
3899     }
3900   }
3901 }
3902
3903 static void CopyNativeLevel_EM_to_RND(struct LevelInfo *level)
3904 {
3905   static int ball_xy[8][2] =
3906   {
3907     { 0, 0 },
3908     { 1, 0 },
3909     { 2, 0 },
3910     { 0, 1 },
3911     { 2, 1 },
3912     { 0, 2 },
3913     { 1, 2 },
3914     { 2, 2 },
3915   };
3916   struct LevelInfo_EM *level_em = level->native_em_level;
3917   struct CAVE *cav = level_em->cav;
3918   int i, j, x, y;
3919
3920   level->fieldx = MIN(cav->width,  MAX_LEV_FIELDX);
3921   level->fieldy = MIN(cav->height, MAX_LEV_FIELDY);
3922
3923   level->time        = cav->time_seconds;
3924   level->gems_needed = cav->gems_needed;
3925
3926   sprintf(level->name, "Level %d", level->file_info.nr);
3927
3928   level->score[SC_EMERALD]      = cav->emerald_score;
3929   level->score[SC_DIAMOND]      = cav->diamond_score;
3930   level->score[SC_ROBOT]        = cav->alien_score;
3931   level->score[SC_SPACESHIP]    = cav->tank_score;
3932   level->score[SC_BUG]          = cav->bug_score;
3933   level->score[SC_YAMYAM]       = cav->eater_score;
3934   level->score[SC_NUT]          = cav->nut_score;
3935   level->score[SC_DYNAMITE]     = cav->dynamite_score;
3936   level->score[SC_KEY]          = cav->key_score;
3937   level->score[SC_TIME_BONUS]   = cav->exit_score;
3938
3939   level->num_yamyam_contents    = cav->num_eater_arrays;
3940
3941   for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
3942     for (y = 0; y < 3; y++)
3943       for (x = 0; x < 3; x++)
3944         level->yamyam_content[i].e[x][y] =
3945           map_element_EM_to_RND_cave(cav->eater_array[i][y * 3 + x]);
3946
3947   level->amoeba_speed           = cav->amoeba_time;
3948   level->time_magic_wall        = cav->wonderwall_time;
3949   level->time_wheel             = cav->wheel_time;
3950
3951   level->android_move_time      = cav->android_move_time;
3952   level->android_clone_time     = cav->android_clone_time;
3953   level->ball_random            = cav->ball_random;
3954   level->ball_active_initial    = cav->ball_active;
3955   level->ball_time              = cav->ball_time;
3956   level->num_ball_contents      = cav->num_ball_arrays;
3957
3958   level->lenses_score           = cav->lenses_score;
3959   level->magnify_score          = cav->magnify_score;
3960   level->slurp_score            = cav->slurp_score;
3961
3962   level->lenses_time            = cav->lenses_time;
3963   level->magnify_time           = cav->magnify_time;
3964
3965   level->wind_direction_initial =
3966     map_direction_EM_to_RND(cav->wind_direction);
3967
3968   for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
3969     for (j = 0; j < 8; j++)
3970       level->ball_content[i].e[ball_xy[j][0]][ball_xy[j][1]] =
3971         map_element_EM_to_RND_cave(cav->ball_array[i][j]);
3972
3973   map_android_clone_elements_EM_to_RND(level);
3974
3975   // convert the playfield (some elements need special treatment)
3976   for (y = 0; y < level->fieldy; y++) for (x = 0; x < level->fieldx; x++)
3977   {
3978     int new_element = map_element_EM_to_RND_cave(cav->cave[x][y]);
3979
3980     if (new_element == EL_AMOEBA_WET && level->amoeba_speed == 0)
3981       new_element = EL_AMOEBA_DEAD;
3982
3983     level->field[x][y] = new_element;
3984   }
3985
3986   for (i = 0; i < MAX_PLAYERS; i++)
3987   {
3988     // in case of all players set to the same field, use the first player
3989     int nr = MAX_PLAYERS - i - 1;
3990     int jx = cav->player_x[nr];
3991     int jy = cav->player_y[nr];
3992
3993     if (jx != -1 && jy != -1)
3994       level->field[jx][jy] = EL_PLAYER_1 + nr;
3995   }
3996
3997   // time score is counted for each 10 seconds left in Emerald Mine levels
3998   level->time_score_base = 10;
3999 }
4000
4001
4002 // ----------------------------------------------------------------------------
4003 // functions for loading SP level
4004 // ----------------------------------------------------------------------------
4005
4006 static void CopyNativeLevel_RND_to_SP(struct LevelInfo *level)
4007 {
4008   struct LevelInfo_SP *level_sp = level->native_sp_level;
4009   LevelInfoType *header = &level_sp->header;
4010   int i, x, y;
4011
4012   level_sp->width  = level->fieldx;
4013   level_sp->height = level->fieldy;
4014
4015   for (x = 0; x < level->fieldx; x++)
4016     for (y = 0; y < level->fieldy; y++)
4017       level_sp->playfield[x][y] = map_element_RND_to_SP(level->field[x][y]);
4018
4019   header->InitialGravity = (level->initial_player_gravity[0] ? 1 : 0);
4020
4021   for (i = 0; i < SP_LEVEL_NAME_LEN; i++)
4022     header->LevelTitle[i] = level->name[i];
4023   // !!! NO STRING TERMINATION IN SUPAPLEX VB CODE YET -- FIX THIS !!!
4024
4025   header->InfotronsNeeded = level->gems_needed;
4026
4027   header->SpecialPortCount = 0;
4028
4029   for (x = 0; x < level->fieldx; x++) for (y = 0; y < level->fieldy; y++)
4030   {
4031     boolean gravity_port_found = FALSE;
4032     boolean gravity_port_valid = FALSE;
4033     int gravity_port_flag;
4034     int gravity_port_base_element;
4035     int element = level->field[x][y];
4036
4037     if (element >= EL_SP_GRAVITY_ON_PORT_RIGHT &&
4038         element <= EL_SP_GRAVITY_ON_PORT_UP)
4039     {
4040       gravity_port_found = TRUE;
4041       gravity_port_valid = TRUE;
4042       gravity_port_flag = 1;
4043       gravity_port_base_element = EL_SP_GRAVITY_ON_PORT_RIGHT;
4044     }
4045     else if (element >= EL_SP_GRAVITY_OFF_PORT_RIGHT &&
4046              element <= EL_SP_GRAVITY_OFF_PORT_UP)
4047     {
4048       gravity_port_found = TRUE;
4049       gravity_port_valid = TRUE;
4050       gravity_port_flag = 0;
4051       gravity_port_base_element = EL_SP_GRAVITY_OFF_PORT_RIGHT;
4052     }
4053     else if (element >= EL_SP_GRAVITY_PORT_RIGHT &&
4054              element <= EL_SP_GRAVITY_PORT_UP)
4055     {
4056       // change R'n'D style gravity inverting special port to normal port
4057       // (there are no gravity inverting ports in native Supaplex engine)
4058
4059       gravity_port_found = TRUE;
4060       gravity_port_valid = FALSE;
4061       gravity_port_base_element = EL_SP_GRAVITY_PORT_RIGHT;
4062     }
4063
4064     if (gravity_port_found)
4065     {
4066       if (gravity_port_valid &&
4067           header->SpecialPortCount < SP_MAX_SPECIAL_PORTS)
4068       {
4069         SpecialPortType *port = &header->SpecialPort[header->SpecialPortCount];
4070
4071         port->PortLocation = (y * level->fieldx + x) * 2;
4072         port->Gravity = gravity_port_flag;
4073
4074         element += EL_SP_GRAVITY_PORT_RIGHT - gravity_port_base_element;
4075
4076         header->SpecialPortCount++;
4077       }
4078       else
4079       {
4080         // change special gravity port to normal port
4081
4082         element += EL_SP_PORT_RIGHT - gravity_port_base_element;
4083       }
4084
4085       level_sp->playfield[x][y] = element - EL_SP_START;
4086     }
4087   }
4088 }
4089
4090 static void CopyNativeLevel_SP_to_RND(struct LevelInfo *level)
4091 {
4092   struct LevelInfo_SP *level_sp = level->native_sp_level;
4093   LevelInfoType *header = &level_sp->header;
4094   boolean num_invalid_elements = 0;
4095   int i, j, x, y;
4096
4097   level->fieldx = level_sp->width;
4098   level->fieldy = level_sp->height;
4099
4100   for (x = 0; x < level->fieldx; x++)
4101   {
4102     for (y = 0; y < level->fieldy; y++)
4103     {
4104       int element_old = level_sp->playfield[x][y];
4105       int element_new = getMappedElement(map_element_SP_to_RND(element_old));
4106
4107       if (element_new == EL_UNKNOWN)
4108       {
4109         num_invalid_elements++;
4110
4111         Debug("level:native:SP", "invalid element %d at position %d, %d",
4112               element_old, x, y);
4113       }
4114
4115       level->field[x][y] = element_new;
4116     }
4117   }
4118
4119   if (num_invalid_elements > 0)
4120     Warn("found %d invalid elements%s", num_invalid_elements,
4121          (!options.debug ? " (use '--debug' for more details)" : ""));
4122
4123   for (i = 0; i < MAX_PLAYERS; i++)
4124     level->initial_player_gravity[i] =
4125       (header->InitialGravity == 1 ? TRUE : FALSE);
4126
4127   // skip leading spaces
4128   for (i = 0; i < SP_LEVEL_NAME_LEN; i++)
4129     if (header->LevelTitle[i] != ' ')
4130       break;
4131
4132   // copy level title
4133   for (j = 0; i < SP_LEVEL_NAME_LEN; i++, j++)
4134     level->name[j] = header->LevelTitle[i];
4135   level->name[j] = '\0';
4136
4137   // cut trailing spaces
4138   for (; j > 0; j--)
4139     if (level->name[j - 1] == ' ' && level->name[j] == '\0')
4140       level->name[j - 1] = '\0';
4141
4142   level->gems_needed = header->InfotronsNeeded;
4143
4144   for (i = 0; i < header->SpecialPortCount; i++)
4145   {
4146     SpecialPortType *port = &header->SpecialPort[i];
4147     int port_location = port->PortLocation;
4148     int gravity = port->Gravity;
4149     int port_x, port_y, port_element;
4150
4151     port_x = (port_location / 2) % level->fieldx;
4152     port_y = (port_location / 2) / level->fieldx;
4153
4154     if (port_x < 0 || port_x >= level->fieldx ||
4155         port_y < 0 || port_y >= level->fieldy)
4156     {
4157       Warn("special port position (%d, %d) out of bounds", port_x, port_y);
4158
4159       continue;
4160     }
4161
4162     port_element = level->field[port_x][port_y];
4163
4164     if (port_element < EL_SP_GRAVITY_PORT_RIGHT ||
4165         port_element > EL_SP_GRAVITY_PORT_UP)
4166     {
4167       Warn("no special port at position (%d, %d)", port_x, port_y);
4168
4169       continue;
4170     }
4171
4172     // change previous (wrong) gravity inverting special port to either
4173     // gravity enabling special port or gravity disabling special port
4174     level->field[port_x][port_y] +=
4175       (gravity == 1 ? EL_SP_GRAVITY_ON_PORT_RIGHT :
4176        EL_SP_GRAVITY_OFF_PORT_RIGHT) - EL_SP_GRAVITY_PORT_RIGHT;
4177   }
4178
4179   // change special gravity ports without database entries to normal ports
4180   for (x = 0; x < level->fieldx; x++)
4181     for (y = 0; y < level->fieldy; y++)
4182       if (level->field[x][y] >= EL_SP_GRAVITY_PORT_RIGHT &&
4183           level->field[x][y] <= EL_SP_GRAVITY_PORT_UP)
4184         level->field[x][y] += EL_SP_PORT_RIGHT - EL_SP_GRAVITY_PORT_RIGHT;
4185
4186   level->time = 0;                      // no time limit
4187   level->amoeba_speed = 0;
4188   level->time_magic_wall = 0;
4189   level->time_wheel = 0;
4190   level->amoeba_content = EL_EMPTY;
4191
4192   // original Supaplex does not use score values -- rate by playing time
4193   for (i = 0; i < LEVEL_SCORE_ELEMENTS; i++)
4194     level->score[i] = 0;
4195
4196   level->rate_time_over_score = TRUE;
4197
4198   // there are no yamyams in supaplex levels
4199   for (i = 0; i < level->num_yamyam_contents; i++)
4200     for (x = 0; x < 3; x++)
4201       for (y = 0; y < 3; y++)
4202         level->yamyam_content[i].e[x][y] = EL_EMPTY;
4203 }
4204
4205 static void CopyNativeTape_RND_to_SP(struct LevelInfo *level)
4206 {
4207   struct LevelInfo_SP *level_sp = level->native_sp_level;
4208   struct DemoInfo_SP *demo = &level_sp->demo;
4209   int i, j;
4210
4211   // always start with reliable default values
4212   demo->is_available = FALSE;
4213   demo->length = 0;
4214
4215   if (TAPE_IS_EMPTY(tape))
4216     return;
4217
4218   demo->level_nr = tape.level_nr;       // (currently not used)
4219
4220   level_sp->header.DemoRandomSeed = tape.random_seed;
4221
4222   demo->length = 0;
4223
4224   for (i = 0; i < tape.length; i++)
4225   {
4226     int demo_action = map_key_RND_to_SP(tape.pos[i].action[0]);
4227     int demo_repeat = tape.pos[i].delay;
4228     int demo_entries = (demo_repeat + 15) / 16;
4229
4230     if (demo->length + demo_entries >= SP_MAX_TAPE_LEN)
4231     {
4232       Warn("tape truncated: size exceeds maximum SP demo size %d",
4233            SP_MAX_TAPE_LEN);
4234
4235       break;
4236     }
4237
4238     for (j = 0; j < demo_repeat / 16; j++)
4239       demo->data[demo->length++] = 0xf0 | demo_action;
4240
4241     if (demo_repeat % 16)
4242       demo->data[demo->length++] = ((demo_repeat % 16 - 1) << 4) | demo_action;
4243   }
4244
4245   demo->is_available = TRUE;
4246 }
4247
4248 static void CopyNativeTape_SP_to_RND(struct LevelInfo *level)
4249 {
4250   struct LevelInfo_SP *level_sp = level->native_sp_level;
4251   struct DemoInfo_SP *demo = &level_sp->demo;
4252   char *filename = level->file_info.filename;
4253   int i;
4254
4255   // always start with reliable default values
4256   setTapeInfoToDefaults();
4257
4258   if (!demo->is_available)
4259     return;
4260
4261   tape.level_nr = demo->level_nr;       // (currently not used)
4262   tape.random_seed = level_sp->header.DemoRandomSeed;
4263
4264   TapeSetDateFromEpochSeconds(getFileTimestampEpochSeconds(filename));
4265
4266   tape.counter = 0;
4267   tape.pos[tape.counter].delay = 0;
4268
4269   for (i = 0; i < demo->length; i++)
4270   {
4271     int demo_action = demo->data[i] & 0x0f;
4272     int demo_repeat = (demo->data[i] & 0xf0) >> 4;
4273     int tape_action = map_key_SP_to_RND(demo_action);
4274     int tape_repeat = demo_repeat + 1;
4275     byte action[MAX_TAPE_ACTIONS] = { tape_action };
4276     boolean success = 0;
4277     int j;
4278
4279     for (j = 0; j < tape_repeat; j++)
4280       success = TapeAddAction(action);
4281
4282     if (!success)
4283     {
4284       Warn("SP demo truncated: size exceeds maximum tape size %d",
4285            MAX_TAPE_LEN);
4286
4287       break;
4288     }
4289   }
4290
4291   TapeHaltRecording();
4292 }
4293
4294
4295 // ----------------------------------------------------------------------------
4296 // functions for loading MM level
4297 // ----------------------------------------------------------------------------
4298
4299 static void CopyNativeLevel_RND_to_MM(struct LevelInfo *level)
4300 {
4301   struct LevelInfo_MM *level_mm = level->native_mm_level;
4302   int i, x, y;
4303
4304   level_mm->fieldx = MIN(level->fieldx, MM_MAX_PLAYFIELD_WIDTH);
4305   level_mm->fieldy = MIN(level->fieldy, MM_MAX_PLAYFIELD_HEIGHT);
4306
4307   level_mm->time = level->time;
4308   level_mm->kettles_needed = level->gems_needed;
4309   level_mm->auto_count_kettles = level->auto_count_gems;
4310
4311   level_mm->mm_laser_red   = level->mm_laser_red;
4312   level_mm->mm_laser_green = level->mm_laser_green;
4313   level_mm->mm_laser_blue  = level->mm_laser_blue;
4314
4315   level_mm->df_laser_red   = level->df_laser_red;
4316   level_mm->df_laser_green = level->df_laser_green;
4317   level_mm->df_laser_blue  = level->df_laser_blue;
4318
4319   strcpy(level_mm->name, level->name);
4320   strcpy(level_mm->author, level->author);
4321
4322   level_mm->score[SC_EMERALD]    = level->score[SC_EMERALD];
4323   level_mm->score[SC_PACMAN]     = level->score[SC_PACMAN];
4324   level_mm->score[SC_KEY]        = level->score[SC_KEY];
4325   level_mm->score[SC_TIME_BONUS] = level->score[SC_TIME_BONUS];
4326   level_mm->score[SC_ELEM_BONUS] = level->score[SC_ELEM_BONUS];
4327
4328   level_mm->amoeba_speed = level->amoeba_speed;
4329   level_mm->time_fuse    = level->mm_time_fuse;
4330   level_mm->time_bomb    = level->mm_time_bomb;
4331   level_mm->time_ball    = level->mm_time_ball;
4332   level_mm->time_block   = level->mm_time_block;
4333
4334   level_mm->num_ball_contents = level->num_mm_ball_contents;
4335   level_mm->ball_choice_mode = level->mm_ball_choice_mode;
4336   level_mm->rotate_ball_content = level->rotate_mm_ball_content;
4337   level_mm->explode_ball = level->explode_mm_ball;
4338
4339   for (i = 0; i < level->num_mm_ball_contents; i++)
4340     level_mm->ball_content[i] =
4341       map_element_RND_to_MM(level->mm_ball_content[i]);
4342
4343   for (x = 0; x < level->fieldx; x++)
4344     for (y = 0; y < level->fieldy; y++)
4345       Ur[x][y] =
4346         level_mm->field[x][y] = map_element_RND_to_MM(level->field[x][y]);
4347 }
4348
4349 static void CopyNativeLevel_MM_to_RND(struct LevelInfo *level)
4350 {
4351   struct LevelInfo_MM *level_mm = level->native_mm_level;
4352   int i, x, y;
4353
4354   level->fieldx = MIN(level_mm->fieldx, MAX_LEV_FIELDX);
4355   level->fieldy = MIN(level_mm->fieldy, MAX_LEV_FIELDY);
4356
4357   level->time = level_mm->time;
4358   level->gems_needed = level_mm->kettles_needed;
4359   level->auto_count_gems = level_mm->auto_count_kettles;
4360
4361   level->mm_laser_red   = level_mm->mm_laser_red;
4362   level->mm_laser_green = level_mm->mm_laser_green;
4363   level->mm_laser_blue  = level_mm->mm_laser_blue;
4364
4365   level->df_laser_red   = level_mm->df_laser_red;
4366   level->df_laser_green = level_mm->df_laser_green;
4367   level->df_laser_blue  = level_mm->df_laser_blue;
4368
4369   strcpy(level->name, level_mm->name);
4370
4371   // only overwrite author from 'levelinfo.conf' if author defined in level
4372   if (!strEqual(level_mm->author, ANONYMOUS_NAME))
4373     strcpy(level->author, level_mm->author);
4374
4375   level->score[SC_EMERALD]    = level_mm->score[SC_EMERALD];
4376   level->score[SC_PACMAN]     = level_mm->score[SC_PACMAN];
4377   level->score[SC_KEY]        = level_mm->score[SC_KEY];
4378   level->score[SC_TIME_BONUS] = level_mm->score[SC_TIME_BONUS];
4379   level->score[SC_ELEM_BONUS] = level_mm->score[SC_ELEM_BONUS];
4380
4381   level->amoeba_speed  = level_mm->amoeba_speed;
4382   level->mm_time_fuse  = level_mm->time_fuse;
4383   level->mm_time_bomb  = level_mm->time_bomb;
4384   level->mm_time_ball  = level_mm->time_ball;
4385   level->mm_time_block = level_mm->time_block;
4386
4387   level->num_mm_ball_contents = level_mm->num_ball_contents;
4388   level->mm_ball_choice_mode = level_mm->ball_choice_mode;
4389   level->rotate_mm_ball_content = level_mm->rotate_ball_content;
4390   level->explode_mm_ball = level_mm->explode_ball;
4391
4392   for (i = 0; i < level->num_mm_ball_contents; i++)
4393     level->mm_ball_content[i] =
4394       map_element_MM_to_RND(level_mm->ball_content[i]);
4395
4396   for (x = 0; x < level->fieldx; x++)
4397     for (y = 0; y < level->fieldy; y++)
4398       level->field[x][y] = map_element_MM_to_RND(level_mm->field[x][y]);
4399 }
4400
4401
4402 // ----------------------------------------------------------------------------
4403 // functions for loading DC level
4404 // ----------------------------------------------------------------------------
4405
4406 #define DC_LEVEL_HEADER_SIZE            344
4407
4408 static unsigned short getDecodedWord_DC(unsigned short data_encoded,
4409                                         boolean init)
4410 {
4411   static int last_data_encoded;
4412   static int offset1;
4413   static int offset2;
4414   int diff;
4415   int diff_hi, diff_lo;
4416   int data_hi, data_lo;
4417   unsigned short data_decoded;
4418
4419   if (init)
4420   {
4421     last_data_encoded = 0;
4422     offset1 = -1;
4423     offset2 = 0;
4424
4425     return 0;
4426   }
4427
4428   diff = data_encoded - last_data_encoded;
4429   diff_hi = diff & ~0xff;
4430   diff_lo = diff &  0xff;
4431
4432   offset2 += diff_lo;
4433
4434   data_hi = diff_hi - (offset1 << 8) + (offset2 & 0xff00);
4435   data_lo = (diff_lo + (data_hi >> 16)) & 0x00ff;
4436   data_hi = data_hi & 0xff00;
4437
4438   data_decoded = data_hi | data_lo;
4439
4440   last_data_encoded = data_encoded;
4441
4442   offset1 = (offset1 + 1) % 31;
4443   offset2 = offset2 & 0xff;
4444
4445   return data_decoded;
4446 }
4447
4448 static int getMappedElement_DC(int element)
4449 {
4450   switch (element)
4451   {
4452     case 0x0000:
4453       element = EL_ROCK;
4454       break;
4455
4456       // 0x0117 - 0x036e: (?)
4457       // EL_DIAMOND
4458
4459       // 0x042d - 0x0684: (?)
4460       // EL_EMERALD
4461
4462     case 0x06f1:
4463       element = EL_NUT;
4464       break;
4465
4466     case 0x074c:
4467       element = EL_BOMB;
4468       break;
4469
4470     case 0x07a4:
4471       element = EL_PEARL;
4472       break;
4473
4474     case 0x0823:
4475       element = EL_CRYSTAL;
4476       break;
4477
4478     case 0x0e77:        // quicksand (boulder)
4479       element = EL_QUICKSAND_FAST_FULL;
4480       break;
4481
4482     case 0x0e99:        // slow quicksand (boulder)
4483       element = EL_QUICKSAND_FULL;
4484       break;
4485
4486     case 0x0ed2:
4487       element = EL_EM_EXIT_OPEN;
4488       break;
4489
4490     case 0x0ee3:
4491       element = EL_EM_EXIT_CLOSED;
4492       break;
4493
4494     case 0x0eeb:
4495       element = EL_EM_STEEL_EXIT_OPEN;
4496       break;
4497
4498     case 0x0efc:
4499       element = EL_EM_STEEL_EXIT_CLOSED;
4500       break;
4501
4502     case 0x0f4f:        // dynamite (lit 1)
4503       element = EL_EM_DYNAMITE_ACTIVE;
4504       break;
4505
4506     case 0x0f57:        // dynamite (lit 2)
4507       element = EL_EM_DYNAMITE_ACTIVE;
4508       break;
4509
4510     case 0x0f5f:        // dynamite (lit 3)
4511       element = EL_EM_DYNAMITE_ACTIVE;
4512       break;
4513
4514     case 0x0f67:        // dynamite (lit 4)
4515       element = EL_EM_DYNAMITE_ACTIVE;
4516       break;
4517
4518     case 0x0f81:
4519     case 0x0f82:
4520     case 0x0f83:
4521     case 0x0f84:
4522       element = EL_AMOEBA_WET;
4523       break;
4524
4525     case 0x0f85:
4526       element = EL_AMOEBA_DROP;
4527       break;
4528
4529     case 0x0fb9:
4530       element = EL_DC_MAGIC_WALL;
4531       break;
4532
4533     case 0x0fd0:
4534       element = EL_SPACESHIP_UP;
4535       break;
4536
4537     case 0x0fd9:
4538       element = EL_SPACESHIP_DOWN;
4539       break;
4540
4541     case 0x0ff1:
4542       element = EL_SPACESHIP_LEFT;
4543       break;
4544
4545     case 0x0ff9:
4546       element = EL_SPACESHIP_RIGHT;
4547       break;
4548
4549     case 0x1057:
4550       element = EL_BUG_UP;
4551       break;
4552
4553     case 0x1060:
4554       element = EL_BUG_DOWN;
4555       break;
4556
4557     case 0x1078:
4558       element = EL_BUG_LEFT;
4559       break;
4560
4561     case 0x1080:
4562       element = EL_BUG_RIGHT;
4563       break;
4564
4565     case 0x10de:
4566       element = EL_MOLE_UP;
4567       break;
4568
4569     case 0x10e7:
4570       element = EL_MOLE_DOWN;
4571       break;
4572
4573     case 0x10ff:
4574       element = EL_MOLE_LEFT;
4575       break;
4576
4577     case 0x1107:
4578       element = EL_MOLE_RIGHT;
4579       break;
4580
4581     case 0x11c0:
4582       element = EL_ROBOT;
4583       break;
4584
4585     case 0x13f5:
4586       element = EL_YAMYAM_UP;
4587       break;
4588
4589     case 0x1425:
4590       element = EL_SWITCHGATE_OPEN;
4591       break;
4592
4593     case 0x1426:
4594       element = EL_SWITCHGATE_CLOSED;
4595       break;
4596
4597     case 0x1437:
4598       element = EL_DC_SWITCHGATE_SWITCH_UP;
4599       break;
4600
4601     case 0x143a:
4602       element = EL_TIMEGATE_CLOSED;
4603       break;
4604
4605     case 0x144c:        // conveyor belt switch (green)
4606       element = EL_CONVEYOR_BELT_3_SWITCH_MIDDLE;
4607       break;
4608
4609     case 0x144f:        // conveyor belt switch (red)
4610       element = EL_CONVEYOR_BELT_1_SWITCH_MIDDLE;
4611       break;
4612
4613     case 0x1452:        // conveyor belt switch (blue)
4614       element = EL_CONVEYOR_BELT_4_SWITCH_MIDDLE;
4615       break;
4616
4617     case 0x145b:
4618       element = EL_CONVEYOR_BELT_3_MIDDLE;
4619       break;
4620
4621     case 0x1463:
4622       element = EL_CONVEYOR_BELT_3_LEFT;
4623       break;
4624
4625     case 0x146b:
4626       element = EL_CONVEYOR_BELT_3_RIGHT;
4627       break;
4628
4629     case 0x1473:
4630       element = EL_CONVEYOR_BELT_1_MIDDLE;
4631       break;
4632
4633     case 0x147b:
4634       element = EL_CONVEYOR_BELT_1_LEFT;
4635       break;
4636
4637     case 0x1483:
4638       element = EL_CONVEYOR_BELT_1_RIGHT;
4639       break;
4640
4641     case 0x148b:
4642       element = EL_CONVEYOR_BELT_4_MIDDLE;
4643       break;
4644
4645     case 0x1493:
4646       element = EL_CONVEYOR_BELT_4_LEFT;
4647       break;
4648
4649     case 0x149b:
4650       element = EL_CONVEYOR_BELT_4_RIGHT;
4651       break;
4652
4653     case 0x14ac:
4654       element = EL_EXPANDABLE_WALL_HORIZONTAL;
4655       break;
4656
4657     case 0x14bd:
4658       element = EL_EXPANDABLE_WALL_VERTICAL;
4659       break;
4660
4661     case 0x14c6:
4662       element = EL_EXPANDABLE_WALL_ANY;
4663       break;
4664
4665     case 0x14ce:        // growing steel wall (left/right)
4666       element = EL_EXPANDABLE_STEELWALL_HORIZONTAL;
4667       break;
4668
4669     case 0x14df:        // growing steel wall (up/down)
4670       element = EL_EXPANDABLE_STEELWALL_VERTICAL;
4671       break;
4672
4673     case 0x14e8:        // growing steel wall (up/down/left/right)
4674       element = EL_EXPANDABLE_STEELWALL_ANY;
4675       break;
4676
4677     case 0x14e9:
4678       element = EL_SHIELD_DEADLY;
4679       break;
4680
4681     case 0x1501:
4682       element = EL_EXTRA_TIME;
4683       break;
4684
4685     case 0x154f:
4686       element = EL_ACID;
4687       break;
4688
4689     case 0x1577:
4690       element = EL_EMPTY_SPACE;
4691       break;
4692
4693     case 0x1578:        // quicksand (empty)
4694       element = EL_QUICKSAND_FAST_EMPTY;
4695       break;
4696
4697     case 0x1579:        // slow quicksand (empty)
4698       element = EL_QUICKSAND_EMPTY;
4699       break;
4700
4701       // 0x157c - 0x158b:
4702       // EL_SAND
4703
4704       // 0x1590 - 0x159f:
4705       // EL_DC_LANDMINE
4706
4707     case 0x15a0:
4708       element = EL_EM_DYNAMITE;
4709       break;
4710
4711     case 0x15a1:        // key (red)
4712       element = EL_EM_KEY_1;
4713       break;
4714
4715     case 0x15a2:        // key (yellow)
4716       element = EL_EM_KEY_2;
4717       break;
4718
4719     case 0x15a3:        // key (blue)
4720       element = EL_EM_KEY_4;
4721       break;
4722
4723     case 0x15a4:        // key (green)
4724       element = EL_EM_KEY_3;
4725       break;
4726
4727     case 0x15a5:        // key (white)
4728       element = EL_DC_KEY_WHITE;
4729       break;
4730
4731     case 0x15a6:
4732       element = EL_WALL_SLIPPERY;
4733       break;
4734
4735     case 0x15a7:
4736       element = EL_WALL;
4737       break;
4738
4739     case 0x15a8:        // wall (not round)
4740       element = EL_WALL;
4741       break;
4742
4743     case 0x15a9:        // (blue)
4744       element = EL_CHAR_A;
4745       break;
4746
4747     case 0x15aa:        // (blue)
4748       element = EL_CHAR_B;
4749       break;
4750
4751     case 0x15ab:        // (blue)
4752       element = EL_CHAR_C;
4753       break;
4754
4755     case 0x15ac:        // (blue)
4756       element = EL_CHAR_D;
4757       break;
4758
4759     case 0x15ad:        // (blue)
4760       element = EL_CHAR_E;
4761       break;
4762
4763     case 0x15ae:        // (blue)
4764       element = EL_CHAR_F;
4765       break;
4766
4767     case 0x15af:        // (blue)
4768       element = EL_CHAR_G;
4769       break;
4770
4771     case 0x15b0:        // (blue)
4772       element = EL_CHAR_H;
4773       break;
4774
4775     case 0x15b1:        // (blue)
4776       element = EL_CHAR_I;
4777       break;
4778
4779     case 0x15b2:        // (blue)
4780       element = EL_CHAR_J;
4781       break;
4782
4783     case 0x15b3:        // (blue)
4784       element = EL_CHAR_K;
4785       break;
4786
4787     case 0x15b4:        // (blue)
4788       element = EL_CHAR_L;
4789       break;
4790
4791     case 0x15b5:        // (blue)
4792       element = EL_CHAR_M;
4793       break;
4794
4795     case 0x15b6:        // (blue)
4796       element = EL_CHAR_N;
4797       break;
4798
4799     case 0x15b7:        // (blue)
4800       element = EL_CHAR_O;
4801       break;
4802
4803     case 0x15b8:        // (blue)
4804       element = EL_CHAR_P;
4805       break;
4806
4807     case 0x15b9:        // (blue)
4808       element = EL_CHAR_Q;
4809       break;
4810
4811     case 0x15ba:        // (blue)
4812       element = EL_CHAR_R;
4813       break;
4814
4815     case 0x15bb:        // (blue)
4816       element = EL_CHAR_S;
4817       break;
4818
4819     case 0x15bc:        // (blue)
4820       element = EL_CHAR_T;
4821       break;
4822
4823     case 0x15bd:        // (blue)
4824       element = EL_CHAR_U;
4825       break;
4826
4827     case 0x15be:        // (blue)
4828       element = EL_CHAR_V;
4829       break;
4830
4831     case 0x15bf:        // (blue)
4832       element = EL_CHAR_W;
4833       break;
4834
4835     case 0x15c0:        // (blue)
4836       element = EL_CHAR_X;
4837       break;
4838
4839     case 0x15c1:        // (blue)
4840       element = EL_CHAR_Y;
4841       break;
4842
4843     case 0x15c2:        // (blue)
4844       element = EL_CHAR_Z;
4845       break;
4846
4847     case 0x15c3:        // (blue)
4848       element = EL_CHAR_AUMLAUT;
4849       break;
4850
4851     case 0x15c4:        // (blue)
4852       element = EL_CHAR_OUMLAUT;
4853       break;
4854
4855     case 0x15c5:        // (blue)
4856       element = EL_CHAR_UUMLAUT;
4857       break;
4858
4859     case 0x15c6:        // (blue)
4860       element = EL_CHAR_0;
4861       break;
4862
4863     case 0x15c7:        // (blue)
4864       element = EL_CHAR_1;
4865       break;
4866
4867     case 0x15c8:        // (blue)
4868       element = EL_CHAR_2;
4869       break;
4870
4871     case 0x15c9:        // (blue)
4872       element = EL_CHAR_3;
4873       break;
4874
4875     case 0x15ca:        // (blue)
4876       element = EL_CHAR_4;
4877       break;
4878
4879     case 0x15cb:        // (blue)
4880       element = EL_CHAR_5;
4881       break;
4882
4883     case 0x15cc:        // (blue)
4884       element = EL_CHAR_6;
4885       break;
4886
4887     case 0x15cd:        // (blue)
4888       element = EL_CHAR_7;
4889       break;
4890
4891     case 0x15ce:        // (blue)
4892       element = EL_CHAR_8;
4893       break;
4894
4895     case 0x15cf:        // (blue)
4896       element = EL_CHAR_9;
4897       break;
4898
4899     case 0x15d0:        // (blue)
4900       element = EL_CHAR_PERIOD;
4901       break;
4902
4903     case 0x15d1:        // (blue)
4904       element = EL_CHAR_EXCLAM;
4905       break;
4906
4907     case 0x15d2:        // (blue)
4908       element = EL_CHAR_COLON;
4909       break;
4910
4911     case 0x15d3:        // (blue)
4912       element = EL_CHAR_LESS;
4913       break;
4914
4915     case 0x15d4:        // (blue)
4916       element = EL_CHAR_GREATER;
4917       break;
4918
4919     case 0x15d5:        // (blue)
4920       element = EL_CHAR_QUESTION;
4921       break;
4922
4923     case 0x15d6:        // (blue)
4924       element = EL_CHAR_COPYRIGHT;
4925       break;
4926
4927     case 0x15d7:        // (blue)
4928       element = EL_CHAR_UP;
4929       break;
4930
4931     case 0x15d8:        // (blue)
4932       element = EL_CHAR_DOWN;
4933       break;
4934
4935     case 0x15d9:        // (blue)
4936       element = EL_CHAR_BUTTON;
4937       break;
4938
4939     case 0x15da:        // (blue)
4940       element = EL_CHAR_PLUS;
4941       break;
4942
4943     case 0x15db:        // (blue)
4944       element = EL_CHAR_MINUS;
4945       break;
4946
4947     case 0x15dc:        // (blue)
4948       element = EL_CHAR_APOSTROPHE;
4949       break;
4950
4951     case 0x15dd:        // (blue)
4952       element = EL_CHAR_PARENLEFT;
4953       break;
4954
4955     case 0x15de:        // (blue)
4956       element = EL_CHAR_PARENRIGHT;
4957       break;
4958
4959     case 0x15df:        // (green)
4960       element = EL_CHAR_A;
4961       break;
4962
4963     case 0x15e0:        // (green)
4964       element = EL_CHAR_B;
4965       break;
4966
4967     case 0x15e1:        // (green)
4968       element = EL_CHAR_C;
4969       break;
4970
4971     case 0x15e2:        // (green)
4972       element = EL_CHAR_D;
4973       break;
4974
4975     case 0x15e3:        // (green)
4976       element = EL_CHAR_E;
4977       break;
4978
4979     case 0x15e4:        // (green)
4980       element = EL_CHAR_F;
4981       break;
4982
4983     case 0x15e5:        // (green)
4984       element = EL_CHAR_G;
4985       break;
4986
4987     case 0x15e6:        // (green)
4988       element = EL_CHAR_H;
4989       break;
4990
4991     case 0x15e7:        // (green)
4992       element = EL_CHAR_I;
4993       break;
4994
4995     case 0x15e8:        // (green)
4996       element = EL_CHAR_J;
4997       break;
4998
4999     case 0x15e9:        // (green)
5000       element = EL_CHAR_K;
5001       break;
5002
5003     case 0x15ea:        // (green)
5004       element = EL_CHAR_L;
5005       break;
5006
5007     case 0x15eb:        // (green)
5008       element = EL_CHAR_M;
5009       break;
5010
5011     case 0x15ec:        // (green)
5012       element = EL_CHAR_N;
5013       break;
5014
5015     case 0x15ed:        // (green)
5016       element = EL_CHAR_O;
5017       break;
5018
5019     case 0x15ee:        // (green)
5020       element = EL_CHAR_P;
5021       break;
5022
5023     case 0x15ef:        // (green)
5024       element = EL_CHAR_Q;
5025       break;
5026
5027     case 0x15f0:        // (green)
5028       element = EL_CHAR_R;
5029       break;
5030
5031     case 0x15f1:        // (green)
5032       element = EL_CHAR_S;
5033       break;
5034
5035     case 0x15f2:        // (green)
5036       element = EL_CHAR_T;
5037       break;
5038
5039     case 0x15f3:        // (green)
5040       element = EL_CHAR_U;
5041       break;
5042
5043     case 0x15f4:        // (green)
5044       element = EL_CHAR_V;
5045       break;
5046
5047     case 0x15f5:        // (green)
5048       element = EL_CHAR_W;
5049       break;
5050
5051     case 0x15f6:        // (green)
5052       element = EL_CHAR_X;
5053       break;
5054
5055     case 0x15f7:        // (green)
5056       element = EL_CHAR_Y;
5057       break;
5058
5059     case 0x15f8:        // (green)
5060       element = EL_CHAR_Z;
5061       break;
5062
5063     case 0x15f9:        // (green)
5064       element = EL_CHAR_AUMLAUT;
5065       break;
5066
5067     case 0x15fa:        // (green)
5068       element = EL_CHAR_OUMLAUT;
5069       break;
5070
5071     case 0x15fb:        // (green)
5072       element = EL_CHAR_UUMLAUT;
5073       break;
5074
5075     case 0x15fc:        // (green)
5076       element = EL_CHAR_0;
5077       break;
5078
5079     case 0x15fd:        // (green)
5080       element = EL_CHAR_1;
5081       break;
5082
5083     case 0x15fe:        // (green)
5084       element = EL_CHAR_2;
5085       break;
5086
5087     case 0x15ff:        // (green)
5088       element = EL_CHAR_3;
5089       break;
5090
5091     case 0x1600:        // (green)
5092       element = EL_CHAR_4;
5093       break;
5094
5095     case 0x1601:        // (green)
5096       element = EL_CHAR_5;
5097       break;
5098
5099     case 0x1602:        // (green)
5100       element = EL_CHAR_6;
5101       break;
5102
5103     case 0x1603:        // (green)
5104       element = EL_CHAR_7;
5105       break;
5106
5107     case 0x1604:        // (green)
5108       element = EL_CHAR_8;
5109       break;
5110
5111     case 0x1605:        // (green)
5112       element = EL_CHAR_9;
5113       break;
5114
5115     case 0x1606:        // (green)
5116       element = EL_CHAR_PERIOD;
5117       break;
5118
5119     case 0x1607:        // (green)
5120       element = EL_CHAR_EXCLAM;
5121       break;
5122
5123     case 0x1608:        // (green)
5124       element = EL_CHAR_COLON;
5125       break;
5126
5127     case 0x1609:        // (green)
5128       element = EL_CHAR_LESS;
5129       break;
5130
5131     case 0x160a:        // (green)
5132       element = EL_CHAR_GREATER;
5133       break;
5134
5135     case 0x160b:        // (green)
5136       element = EL_CHAR_QUESTION;
5137       break;
5138
5139     case 0x160c:        // (green)
5140       element = EL_CHAR_COPYRIGHT;
5141       break;
5142
5143     case 0x160d:        // (green)
5144       element = EL_CHAR_UP;
5145       break;
5146
5147     case 0x160e:        // (green)
5148       element = EL_CHAR_DOWN;
5149       break;
5150
5151     case 0x160f:        // (green)
5152       element = EL_CHAR_BUTTON;
5153       break;
5154
5155     case 0x1610:        // (green)
5156       element = EL_CHAR_PLUS;
5157       break;
5158
5159     case 0x1611:        // (green)
5160       element = EL_CHAR_MINUS;
5161       break;
5162
5163     case 0x1612:        // (green)
5164       element = EL_CHAR_APOSTROPHE;
5165       break;
5166
5167     case 0x1613:        // (green)
5168       element = EL_CHAR_PARENLEFT;
5169       break;
5170
5171     case 0x1614:        // (green)
5172       element = EL_CHAR_PARENRIGHT;
5173       break;
5174
5175     case 0x1615:        // (blue steel)
5176       element = EL_STEEL_CHAR_A;
5177       break;
5178
5179     case 0x1616:        // (blue steel)
5180       element = EL_STEEL_CHAR_B;
5181       break;
5182
5183     case 0x1617:        // (blue steel)
5184       element = EL_STEEL_CHAR_C;
5185       break;
5186
5187     case 0x1618:        // (blue steel)
5188       element = EL_STEEL_CHAR_D;
5189       break;
5190
5191     case 0x1619:        // (blue steel)
5192       element = EL_STEEL_CHAR_E;
5193       break;
5194
5195     case 0x161a:        // (blue steel)
5196       element = EL_STEEL_CHAR_F;
5197       break;
5198
5199     case 0x161b:        // (blue steel)
5200       element = EL_STEEL_CHAR_G;
5201       break;
5202
5203     case 0x161c:        // (blue steel)
5204       element = EL_STEEL_CHAR_H;
5205       break;
5206
5207     case 0x161d:        // (blue steel)
5208       element = EL_STEEL_CHAR_I;
5209       break;
5210
5211     case 0x161e:        // (blue steel)
5212       element = EL_STEEL_CHAR_J;
5213       break;
5214
5215     case 0x161f:        // (blue steel)
5216       element = EL_STEEL_CHAR_K;
5217       break;
5218
5219     case 0x1620:        // (blue steel)
5220       element = EL_STEEL_CHAR_L;
5221       break;
5222
5223     case 0x1621:        // (blue steel)
5224       element = EL_STEEL_CHAR_M;
5225       break;
5226
5227     case 0x1622:        // (blue steel)
5228       element = EL_STEEL_CHAR_N;
5229       break;
5230
5231     case 0x1623:        // (blue steel)
5232       element = EL_STEEL_CHAR_O;
5233       break;
5234
5235     case 0x1624:        // (blue steel)
5236       element = EL_STEEL_CHAR_P;
5237       break;
5238
5239     case 0x1625:        // (blue steel)
5240       element = EL_STEEL_CHAR_Q;
5241       break;
5242
5243     case 0x1626:        // (blue steel)
5244       element = EL_STEEL_CHAR_R;
5245       break;
5246
5247     case 0x1627:        // (blue steel)
5248       element = EL_STEEL_CHAR_S;
5249       break;
5250
5251     case 0x1628:        // (blue steel)
5252       element = EL_STEEL_CHAR_T;
5253       break;
5254
5255     case 0x1629:        // (blue steel)
5256       element = EL_STEEL_CHAR_U;
5257       break;
5258
5259     case 0x162a:        // (blue steel)
5260       element = EL_STEEL_CHAR_V;
5261       break;
5262
5263     case 0x162b:        // (blue steel)
5264       element = EL_STEEL_CHAR_W;
5265       break;
5266
5267     case 0x162c:        // (blue steel)
5268       element = EL_STEEL_CHAR_X;
5269       break;
5270
5271     case 0x162d:        // (blue steel)
5272       element = EL_STEEL_CHAR_Y;
5273       break;
5274
5275     case 0x162e:        // (blue steel)
5276       element = EL_STEEL_CHAR_Z;
5277       break;
5278
5279     case 0x162f:        // (blue steel)
5280       element = EL_STEEL_CHAR_AUMLAUT;
5281       break;
5282
5283     case 0x1630:        // (blue steel)
5284       element = EL_STEEL_CHAR_OUMLAUT;
5285       break;
5286
5287     case 0x1631:        // (blue steel)
5288       element = EL_STEEL_CHAR_UUMLAUT;
5289       break;
5290
5291     case 0x1632:        // (blue steel)
5292       element = EL_STEEL_CHAR_0;
5293       break;
5294
5295     case 0x1633:        // (blue steel)
5296       element = EL_STEEL_CHAR_1;
5297       break;
5298
5299     case 0x1634:        // (blue steel)
5300       element = EL_STEEL_CHAR_2;
5301       break;
5302
5303     case 0x1635:        // (blue steel)
5304       element = EL_STEEL_CHAR_3;
5305       break;
5306
5307     case 0x1636:        // (blue steel)
5308       element = EL_STEEL_CHAR_4;
5309       break;
5310
5311     case 0x1637:        // (blue steel)
5312       element = EL_STEEL_CHAR_5;
5313       break;
5314
5315     case 0x1638:        // (blue steel)
5316       element = EL_STEEL_CHAR_6;
5317       break;
5318
5319     case 0x1639:        // (blue steel)
5320       element = EL_STEEL_CHAR_7;
5321       break;
5322
5323     case 0x163a:        // (blue steel)
5324       element = EL_STEEL_CHAR_8;
5325       break;
5326
5327     case 0x163b:        // (blue steel)
5328       element = EL_STEEL_CHAR_9;
5329       break;
5330
5331     case 0x163c:        // (blue steel)
5332       element = EL_STEEL_CHAR_PERIOD;
5333       break;
5334
5335     case 0x163d:        // (blue steel)
5336       element = EL_STEEL_CHAR_EXCLAM;
5337       break;
5338
5339     case 0x163e:        // (blue steel)
5340       element = EL_STEEL_CHAR_COLON;
5341       break;
5342
5343     case 0x163f:        // (blue steel)
5344       element = EL_STEEL_CHAR_LESS;
5345       break;
5346
5347     case 0x1640:        // (blue steel)
5348       element = EL_STEEL_CHAR_GREATER;
5349       break;
5350
5351     case 0x1641:        // (blue steel)
5352       element = EL_STEEL_CHAR_QUESTION;
5353       break;
5354
5355     case 0x1642:        // (blue steel)
5356       element = EL_STEEL_CHAR_COPYRIGHT;
5357       break;
5358
5359     case 0x1643:        // (blue steel)
5360       element = EL_STEEL_CHAR_UP;
5361       break;
5362
5363     case 0x1644:        // (blue steel)
5364       element = EL_STEEL_CHAR_DOWN;
5365       break;
5366
5367     case 0x1645:        // (blue steel)
5368       element = EL_STEEL_CHAR_BUTTON;
5369       break;
5370
5371     case 0x1646:        // (blue steel)
5372       element = EL_STEEL_CHAR_PLUS;
5373       break;
5374
5375     case 0x1647:        // (blue steel)
5376       element = EL_STEEL_CHAR_MINUS;
5377       break;
5378
5379     case 0x1648:        // (blue steel)
5380       element = EL_STEEL_CHAR_APOSTROPHE;
5381       break;
5382
5383     case 0x1649:        // (blue steel)
5384       element = EL_STEEL_CHAR_PARENLEFT;
5385       break;
5386
5387     case 0x164a:        // (blue steel)
5388       element = EL_STEEL_CHAR_PARENRIGHT;
5389       break;
5390
5391     case 0x164b:        // (green steel)
5392       element = EL_STEEL_CHAR_A;
5393       break;
5394
5395     case 0x164c:        // (green steel)
5396       element = EL_STEEL_CHAR_B;
5397       break;
5398
5399     case 0x164d:        // (green steel)
5400       element = EL_STEEL_CHAR_C;
5401       break;
5402
5403     case 0x164e:        // (green steel)
5404       element = EL_STEEL_CHAR_D;
5405       break;
5406
5407     case 0x164f:        // (green steel)
5408       element = EL_STEEL_CHAR_E;
5409       break;
5410
5411     case 0x1650:        // (green steel)
5412       element = EL_STEEL_CHAR_F;
5413       break;
5414
5415     case 0x1651:        // (green steel)
5416       element = EL_STEEL_CHAR_G;
5417       break;
5418
5419     case 0x1652:        // (green steel)
5420       element = EL_STEEL_CHAR_H;
5421       break;
5422
5423     case 0x1653:        // (green steel)
5424       element = EL_STEEL_CHAR_I;
5425       break;
5426
5427     case 0x1654:        // (green steel)
5428       element = EL_STEEL_CHAR_J;
5429       break;
5430
5431     case 0x1655:        // (green steel)
5432       element = EL_STEEL_CHAR_K;
5433       break;
5434
5435     case 0x1656:        // (green steel)
5436       element = EL_STEEL_CHAR_L;
5437       break;
5438
5439     case 0x1657:        // (green steel)
5440       element = EL_STEEL_CHAR_M;
5441       break;
5442
5443     case 0x1658:        // (green steel)
5444       element = EL_STEEL_CHAR_N;
5445       break;
5446
5447     case 0x1659:        // (green steel)
5448       element = EL_STEEL_CHAR_O;
5449       break;
5450
5451     case 0x165a:        // (green steel)
5452       element = EL_STEEL_CHAR_P;
5453       break;
5454
5455     case 0x165b:        // (green steel)
5456       element = EL_STEEL_CHAR_Q;
5457       break;
5458
5459     case 0x165c:        // (green steel)
5460       element = EL_STEEL_CHAR_R;
5461       break;
5462
5463     case 0x165d:        // (green steel)
5464       element = EL_STEEL_CHAR_S;
5465       break;
5466
5467     case 0x165e:        // (green steel)
5468       element = EL_STEEL_CHAR_T;
5469       break;
5470
5471     case 0x165f:        // (green steel)
5472       element = EL_STEEL_CHAR_U;
5473       break;
5474
5475     case 0x1660:        // (green steel)
5476       element = EL_STEEL_CHAR_V;
5477       break;
5478
5479     case 0x1661:        // (green steel)
5480       element = EL_STEEL_CHAR_W;
5481       break;
5482
5483     case 0x1662:        // (green steel)
5484       element = EL_STEEL_CHAR_X;
5485       break;
5486
5487     case 0x1663:        // (green steel)
5488       element = EL_STEEL_CHAR_Y;
5489       break;
5490
5491     case 0x1664:        // (green steel)
5492       element = EL_STEEL_CHAR_Z;
5493       break;
5494
5495     case 0x1665:        // (green steel)
5496       element = EL_STEEL_CHAR_AUMLAUT;
5497       break;
5498
5499     case 0x1666:        // (green steel)
5500       element = EL_STEEL_CHAR_OUMLAUT;
5501       break;
5502
5503     case 0x1667:        // (green steel)
5504       element = EL_STEEL_CHAR_UUMLAUT;
5505       break;
5506
5507     case 0x1668:        // (green steel)
5508       element = EL_STEEL_CHAR_0;
5509       break;
5510
5511     case 0x1669:        // (green steel)
5512       element = EL_STEEL_CHAR_1;
5513       break;
5514
5515     case 0x166a:        // (green steel)
5516       element = EL_STEEL_CHAR_2;
5517       break;
5518
5519     case 0x166b:        // (green steel)
5520       element = EL_STEEL_CHAR_3;
5521       break;
5522
5523     case 0x166c:        // (green steel)
5524       element = EL_STEEL_CHAR_4;
5525       break;
5526
5527     case 0x166d:        // (green steel)
5528       element = EL_STEEL_CHAR_5;
5529       break;
5530
5531     case 0x166e:        // (green steel)
5532       element = EL_STEEL_CHAR_6;
5533       break;
5534
5535     case 0x166f:        // (green steel)
5536       element = EL_STEEL_CHAR_7;
5537       break;
5538
5539     case 0x1670:        // (green steel)
5540       element = EL_STEEL_CHAR_8;
5541       break;
5542
5543     case 0x1671:        // (green steel)
5544       element = EL_STEEL_CHAR_9;
5545       break;
5546
5547     case 0x1672:        // (green steel)
5548       element = EL_STEEL_CHAR_PERIOD;
5549       break;
5550
5551     case 0x1673:        // (green steel)
5552       element = EL_STEEL_CHAR_EXCLAM;
5553       break;
5554
5555     case 0x1674:        // (green steel)
5556       element = EL_STEEL_CHAR_COLON;
5557       break;
5558
5559     case 0x1675:        // (green steel)
5560       element = EL_STEEL_CHAR_LESS;
5561       break;
5562
5563     case 0x1676:        // (green steel)
5564       element = EL_STEEL_CHAR_GREATER;
5565       break;
5566
5567     case 0x1677:        // (green steel)
5568       element = EL_STEEL_CHAR_QUESTION;
5569       break;
5570
5571     case 0x1678:        // (green steel)
5572       element = EL_STEEL_CHAR_COPYRIGHT;
5573       break;
5574
5575     case 0x1679:        // (green steel)
5576       element = EL_STEEL_CHAR_UP;
5577       break;
5578
5579     case 0x167a:        // (green steel)
5580       element = EL_STEEL_CHAR_DOWN;
5581       break;
5582
5583     case 0x167b:        // (green steel)
5584       element = EL_STEEL_CHAR_BUTTON;
5585       break;
5586
5587     case 0x167c:        // (green steel)
5588       element = EL_STEEL_CHAR_PLUS;
5589       break;
5590
5591     case 0x167d:        // (green steel)
5592       element = EL_STEEL_CHAR_MINUS;
5593       break;
5594
5595     case 0x167e:        // (green steel)
5596       element = EL_STEEL_CHAR_APOSTROPHE;
5597       break;
5598
5599     case 0x167f:        // (green steel)
5600       element = EL_STEEL_CHAR_PARENLEFT;
5601       break;
5602
5603     case 0x1680:        // (green steel)
5604       element = EL_STEEL_CHAR_PARENRIGHT;
5605       break;
5606
5607     case 0x1681:        // gate (red)
5608       element = EL_EM_GATE_1;
5609       break;
5610
5611     case 0x1682:        // secret gate (red)
5612       element = EL_EM_GATE_1_GRAY;
5613       break;
5614
5615     case 0x1683:        // gate (yellow)
5616       element = EL_EM_GATE_2;
5617       break;
5618
5619     case 0x1684:        // secret gate (yellow)
5620       element = EL_EM_GATE_2_GRAY;
5621       break;
5622
5623     case 0x1685:        // gate (blue)
5624       element = EL_EM_GATE_4;
5625       break;
5626
5627     case 0x1686:        // secret gate (blue)
5628       element = EL_EM_GATE_4_GRAY;
5629       break;
5630
5631     case 0x1687:        // gate (green)
5632       element = EL_EM_GATE_3;
5633       break;
5634
5635     case 0x1688:        // secret gate (green)
5636       element = EL_EM_GATE_3_GRAY;
5637       break;
5638
5639     case 0x1689:        // gate (white)
5640       element = EL_DC_GATE_WHITE;
5641       break;
5642
5643     case 0x168a:        // secret gate (white)
5644       element = EL_DC_GATE_WHITE_GRAY;
5645       break;
5646
5647     case 0x168b:        // secret gate (no key)
5648       element = EL_DC_GATE_FAKE_GRAY;
5649       break;
5650
5651     case 0x168c:
5652       element = EL_ROBOT_WHEEL;
5653       break;
5654
5655     case 0x168d:
5656       element = EL_DC_TIMEGATE_SWITCH;
5657       break;
5658
5659     case 0x168e:
5660       element = EL_ACID_POOL_BOTTOM;
5661       break;
5662
5663     case 0x168f:
5664       element = EL_ACID_POOL_TOPLEFT;
5665       break;
5666
5667     case 0x1690:
5668       element = EL_ACID_POOL_TOPRIGHT;
5669       break;
5670
5671     case 0x1691:
5672       element = EL_ACID_POOL_BOTTOMLEFT;
5673       break;
5674
5675     case 0x1692:
5676       element = EL_ACID_POOL_BOTTOMRIGHT;
5677       break;
5678
5679     case 0x1693:
5680       element = EL_STEELWALL;
5681       break;
5682
5683     case 0x1694:
5684       element = EL_STEELWALL_SLIPPERY;
5685       break;
5686
5687     case 0x1695:        // steel wall (not round)
5688       element = EL_STEELWALL;
5689       break;
5690
5691     case 0x1696:        // steel wall (left)
5692       element = EL_DC_STEELWALL_1_LEFT;
5693       break;
5694
5695     case 0x1697:        // steel wall (bottom)
5696       element = EL_DC_STEELWALL_1_BOTTOM;
5697       break;
5698
5699     case 0x1698:        // steel wall (right)
5700       element = EL_DC_STEELWALL_1_RIGHT;
5701       break;
5702
5703     case 0x1699:        // steel wall (top)
5704       element = EL_DC_STEELWALL_1_TOP;
5705       break;
5706
5707     case 0x169a:        // steel wall (left/bottom)
5708       element = EL_DC_STEELWALL_1_BOTTOMLEFT;
5709       break;
5710
5711     case 0x169b:        // steel wall (right/bottom)
5712       element = EL_DC_STEELWALL_1_BOTTOMRIGHT;
5713       break;
5714
5715     case 0x169c:        // steel wall (right/top)
5716       element = EL_DC_STEELWALL_1_TOPRIGHT;
5717       break;
5718
5719     case 0x169d:        // steel wall (left/top)
5720       element = EL_DC_STEELWALL_1_TOPLEFT;
5721       break;
5722
5723     case 0x169e:        // steel wall (right/bottom small)
5724       element = EL_DC_STEELWALL_1_BOTTOMRIGHT_2;
5725       break;
5726
5727     case 0x169f:        // steel wall (left/bottom small)
5728       element = EL_DC_STEELWALL_1_BOTTOMLEFT_2;
5729       break;
5730
5731     case 0x16a0:        // steel wall (right/top small)
5732       element = EL_DC_STEELWALL_1_TOPRIGHT_2;
5733       break;
5734
5735     case 0x16a1:        // steel wall (left/top small)
5736       element = EL_DC_STEELWALL_1_TOPLEFT_2;
5737       break;
5738
5739     case 0x16a2:        // steel wall (left/right)
5740       element = EL_DC_STEELWALL_1_VERTICAL;
5741       break;
5742
5743     case 0x16a3:        // steel wall (top/bottom)
5744       element = EL_DC_STEELWALL_1_HORIZONTAL;
5745       break;
5746
5747     case 0x16a4:        // steel wall 2 (left end)
5748       element = EL_DC_STEELWALL_2_LEFT;
5749       break;
5750
5751     case 0x16a5:        // steel wall 2 (right end)
5752       element = EL_DC_STEELWALL_2_RIGHT;
5753       break;
5754
5755     case 0x16a6:        // steel wall 2 (top end)
5756       element = EL_DC_STEELWALL_2_TOP;
5757       break;
5758
5759     case 0x16a7:        // steel wall 2 (bottom end)
5760       element = EL_DC_STEELWALL_2_BOTTOM;
5761       break;
5762
5763     case 0x16a8:        // steel wall 2 (left/right)
5764       element = EL_DC_STEELWALL_2_HORIZONTAL;
5765       break;
5766
5767     case 0x16a9:        // steel wall 2 (up/down)
5768       element = EL_DC_STEELWALL_2_VERTICAL;
5769       break;
5770
5771     case 0x16aa:        // steel wall 2 (mid)
5772       element = EL_DC_STEELWALL_2_MIDDLE;
5773       break;
5774
5775     case 0x16ab:
5776       element = EL_SIGN_EXCLAMATION;
5777       break;
5778
5779     case 0x16ac:
5780       element = EL_SIGN_RADIOACTIVITY;
5781       break;
5782
5783     case 0x16ad:
5784       element = EL_SIGN_STOP;
5785       break;
5786
5787     case 0x16ae:
5788       element = EL_SIGN_WHEELCHAIR;
5789       break;
5790
5791     case 0x16af:
5792       element = EL_SIGN_PARKING;
5793       break;
5794
5795     case 0x16b0:
5796       element = EL_SIGN_NO_ENTRY;
5797       break;
5798
5799     case 0x16b1:
5800       element = EL_SIGN_HEART;
5801       break;
5802
5803     case 0x16b2:
5804       element = EL_SIGN_GIVE_WAY;
5805       break;
5806
5807     case 0x16b3:
5808       element = EL_SIGN_ENTRY_FORBIDDEN;
5809       break;
5810
5811     case 0x16b4:
5812       element = EL_SIGN_EMERGENCY_EXIT;
5813       break;
5814
5815     case 0x16b5:
5816       element = EL_SIGN_YIN_YANG;
5817       break;
5818
5819     case 0x16b6:
5820       element = EL_WALL_EMERALD;
5821       break;
5822
5823     case 0x16b7:
5824       element = EL_WALL_DIAMOND;
5825       break;
5826
5827     case 0x16b8:
5828       element = EL_WALL_PEARL;
5829       break;
5830
5831     case 0x16b9:
5832       element = EL_WALL_CRYSTAL;
5833       break;
5834
5835     case 0x16ba:
5836       element = EL_INVISIBLE_WALL;
5837       break;
5838
5839     case 0x16bb:
5840       element = EL_INVISIBLE_STEELWALL;
5841       break;
5842
5843       // 0x16bc - 0x16cb:
5844       // EL_INVISIBLE_SAND
5845
5846     case 0x16cc:
5847       element = EL_LIGHT_SWITCH;
5848       break;
5849
5850     case 0x16cd:
5851       element = EL_ENVELOPE_1;
5852       break;
5853
5854     default:
5855       if (element >= 0x0117 && element <= 0x036e)       // (?)
5856         element = EL_DIAMOND;
5857       else if (element >= 0x042d && element <= 0x0684)  // (?)
5858         element = EL_EMERALD;
5859       else if (element >= 0x157c && element <= 0x158b)
5860         element = EL_SAND;
5861       else if (element >= 0x1590 && element <= 0x159f)
5862         element = EL_DC_LANDMINE;
5863       else if (element >= 0x16bc && element <= 0x16cb)
5864         element = EL_INVISIBLE_SAND;
5865       else
5866       {
5867         Warn("unknown Diamond Caves element 0x%04x", element);
5868
5869         element = EL_UNKNOWN;
5870       }
5871       break;
5872   }
5873
5874   return getMappedElement(element);
5875 }
5876
5877 static void LoadLevelFromFileStream_DC(File *file, struct LevelInfo *level)
5878 {
5879   byte header[DC_LEVEL_HEADER_SIZE];
5880   int envelope_size;
5881   int envelope_header_pos = 62;
5882   int envelope_content_pos = 94;
5883   int level_name_pos = 251;
5884   int level_author_pos = 292;
5885   int envelope_header_len;
5886   int envelope_content_len;
5887   int level_name_len;
5888   int level_author_len;
5889   int fieldx, fieldy;
5890   int num_yamyam_contents;
5891   int i, x, y;
5892
5893   getDecodedWord_DC(0, TRUE);           // initialize DC2 decoding engine
5894
5895   for (i = 0; i < DC_LEVEL_HEADER_SIZE / 2; i++)
5896   {
5897     unsigned short header_word = getDecodedWord_DC(getFile16BitBE(file), FALSE);
5898
5899     header[i * 2 + 0] = header_word >> 8;
5900     header[i * 2 + 1] = header_word & 0xff;
5901   }
5902
5903   // read some values from level header to check level decoding integrity
5904   fieldx = header[6] | (header[7] << 8);
5905   fieldy = header[8] | (header[9] << 8);
5906   num_yamyam_contents = header[60] | (header[61] << 8);
5907
5908   // do some simple sanity checks to ensure that level was correctly decoded
5909   if (fieldx < 1 || fieldx > 256 ||
5910       fieldy < 1 || fieldy > 256 ||
5911       num_yamyam_contents < 1 || num_yamyam_contents > 8)
5912   {
5913     level->no_valid_file = TRUE;
5914
5915     Warn("cannot decode level from stream -- using empty level");
5916
5917     return;
5918   }
5919
5920   // maximum envelope header size is 31 bytes
5921   envelope_header_len   = header[envelope_header_pos];
5922   // maximum envelope content size is 110 (156?) bytes
5923   envelope_content_len  = header[envelope_content_pos];
5924
5925   // maximum level title size is 40 bytes
5926   level_name_len        = MIN(header[level_name_pos],   MAX_LEVEL_NAME_LEN);
5927   // maximum level author size is 30 (51?) bytes
5928   level_author_len      = MIN(header[level_author_pos], MAX_LEVEL_AUTHOR_LEN);
5929
5930   envelope_size = 0;
5931
5932   for (i = 0; i < envelope_header_len; i++)
5933     if (envelope_size < MAX_ENVELOPE_TEXT_LEN)
5934       level->envelope[0].text[envelope_size++] =
5935         header[envelope_header_pos + 1 + i];
5936
5937   if (envelope_header_len > 0 && envelope_content_len > 0)
5938   {
5939     if (envelope_size < MAX_ENVELOPE_TEXT_LEN)
5940       level->envelope[0].text[envelope_size++] = '\n';
5941     if (envelope_size < MAX_ENVELOPE_TEXT_LEN)
5942       level->envelope[0].text[envelope_size++] = '\n';
5943   }
5944
5945   for (i = 0; i < envelope_content_len; i++)
5946     if (envelope_size < MAX_ENVELOPE_TEXT_LEN)
5947       level->envelope[0].text[envelope_size++] =
5948         header[envelope_content_pos + 1 + i];
5949
5950   level->envelope[0].text[envelope_size] = '\0';
5951
5952   level->envelope[0].xsize = MAX_ENVELOPE_XSIZE;
5953   level->envelope[0].ysize = 10;
5954   level->envelope[0].autowrap = TRUE;
5955   level->envelope[0].centered = TRUE;
5956
5957   for (i = 0; i < level_name_len; i++)
5958     level->name[i] = header[level_name_pos + 1 + i];
5959   level->name[level_name_len] = '\0';
5960
5961   for (i = 0; i < level_author_len; i++)
5962     level->author[i] = header[level_author_pos + 1 + i];
5963   level->author[level_author_len] = '\0';
5964
5965   num_yamyam_contents = header[60] | (header[61] << 8);
5966   level->num_yamyam_contents =
5967     MIN(MAX(MIN_ELEMENT_CONTENTS, num_yamyam_contents), MAX_ELEMENT_CONTENTS);
5968
5969   for (i = 0; i < num_yamyam_contents; i++)
5970   {
5971     for (y = 0; y < 3; y++) for (x = 0; x < 3; x++)
5972     {
5973       unsigned short word = getDecodedWord_DC(getFile16BitBE(file), FALSE);
5974       int element_dc = ((word & 0xff) << 8) | ((word >> 8) & 0xff);
5975
5976       if (i < MAX_ELEMENT_CONTENTS)
5977         level->yamyam_content[i].e[x][y] = getMappedElement_DC(element_dc);
5978     }
5979   }
5980
5981   fieldx = header[6] | (header[7] << 8);
5982   fieldy = header[8] | (header[9] << 8);
5983   level->fieldx = MIN(MAX(MIN_LEV_FIELDX, fieldx), MAX_LEV_FIELDX);
5984   level->fieldy = MIN(MAX(MIN_LEV_FIELDY, fieldy), MAX_LEV_FIELDY);
5985
5986   for (y = 0; y < fieldy; y++) for (x = 0; x < fieldx; x++)
5987   {
5988     unsigned short word = getDecodedWord_DC(getFile16BitBE(file), FALSE);
5989     int element_dc = ((word & 0xff) << 8) | ((word >> 8) & 0xff);
5990
5991     if (x < MAX_LEV_FIELDX && y < MAX_LEV_FIELDY)
5992       level->field[x][y] = getMappedElement_DC(element_dc);
5993   }
5994
5995   x = MIN(MAX(0, (header[10] | (header[11] << 8)) - 1), MAX_LEV_FIELDX - 1);
5996   y = MIN(MAX(0, (header[12] | (header[13] << 8)) - 1), MAX_LEV_FIELDY - 1);
5997   level->field[x][y] = EL_PLAYER_1;
5998
5999   x = MIN(MAX(0, (header[14] | (header[15] << 8)) - 1), MAX_LEV_FIELDX - 1);
6000   y = MIN(MAX(0, (header[16] | (header[17] << 8)) - 1), MAX_LEV_FIELDY - 1);
6001   level->field[x][y] = EL_PLAYER_2;
6002
6003   level->gems_needed            = header[18] | (header[19] << 8);
6004
6005   level->score[SC_EMERALD]      = header[20] | (header[21] << 8);
6006   level->score[SC_DIAMOND]      = header[22] | (header[23] << 8);
6007   level->score[SC_PEARL]        = header[24] | (header[25] << 8);
6008   level->score[SC_CRYSTAL]      = header[26] | (header[27] << 8);
6009   level->score[SC_NUT]          = header[28] | (header[29] << 8);
6010   level->score[SC_ROBOT]        = header[30] | (header[31] << 8);
6011   level->score[SC_SPACESHIP]    = header[32] | (header[33] << 8);
6012   level->score[SC_BUG]          = header[34] | (header[35] << 8);
6013   level->score[SC_YAMYAM]       = header[36] | (header[37] << 8);
6014   level->score[SC_DYNAMITE]     = header[38] | (header[39] << 8);
6015   level->score[SC_KEY]          = header[40] | (header[41] << 8);
6016   level->score[SC_TIME_BONUS]   = header[42] | (header[43] << 8);
6017
6018   level->time                   = header[44] | (header[45] << 8);
6019
6020   level->amoeba_speed           = header[46] | (header[47] << 8);
6021   level->time_light             = header[48] | (header[49] << 8);
6022   level->time_timegate          = header[50] | (header[51] << 8);
6023   level->time_wheel             = header[52] | (header[53] << 8);
6024   level->time_magic_wall        = header[54] | (header[55] << 8);
6025   level->extra_time             = header[56] | (header[57] << 8);
6026   level->shield_normal_time     = header[58] | (header[59] << 8);
6027
6028   // shield and extra time elements do not have a score
6029   level->score[SC_SHIELD]       = 0;
6030   level->extra_time_score       = 0;
6031
6032   // set time for normal and deadly shields to the same value
6033   level->shield_deadly_time     = level->shield_normal_time;
6034
6035   // Diamond Caves has the same (strange) behaviour as Emerald Mine that gems
6036   // can slip down from flat walls, like normal walls and steel walls
6037   level->em_slippery_gems = TRUE;
6038
6039   // time score is counted for each 10 seconds left in Diamond Caves levels
6040   level->time_score_base = 10;
6041 }
6042
6043 static void LoadLevelFromFileInfo_DC(struct LevelInfo *level,
6044                                      struct LevelFileInfo *level_file_info,
6045                                      boolean level_info_only)
6046 {
6047   char *filename = level_file_info->filename;
6048   File *file;
6049   int num_magic_bytes = 8;
6050   char magic_bytes[num_magic_bytes + 1];
6051   int num_levels_to_skip = level_file_info->nr - leveldir_current->first_level;
6052
6053   if (!(file = openFile(filename, MODE_READ)))
6054   {
6055     level->no_valid_file = TRUE;
6056
6057     if (!level_info_only)
6058       Warn("cannot read level '%s' -- using empty level", filename);
6059
6060     return;
6061   }
6062
6063   // fseek(file, 0x0000, SEEK_SET);
6064
6065   if (level_file_info->packed)
6066   {
6067     // read "magic bytes" from start of file
6068     if (getStringFromFile(file, magic_bytes, num_magic_bytes + 1) == NULL)
6069       magic_bytes[0] = '\0';
6070
6071     // check "magic bytes" for correct file format
6072     if (!strPrefix(magic_bytes, "DC2"))
6073     {
6074       level->no_valid_file = TRUE;
6075
6076       Warn("unknown DC level file '%s' -- using empty level", filename);
6077
6078       return;
6079     }
6080
6081     if (strPrefix(magic_bytes, "DC2Win95") ||
6082         strPrefix(magic_bytes, "DC2Win98"))
6083     {
6084       int position_first_level = 0x00fa;
6085       int extra_bytes = 4;
6086       int skip_bytes;
6087
6088       // advance file stream to first level inside the level package
6089       skip_bytes = position_first_level - num_magic_bytes - extra_bytes;
6090
6091       // each block of level data is followed by block of non-level data
6092       num_levels_to_skip *= 2;
6093
6094       // at least skip header bytes, therefore use ">= 0" instead of "> 0"
6095       while (num_levels_to_skip >= 0)
6096       {
6097         // advance file stream to next level inside the level package
6098         if (seekFile(file, skip_bytes, SEEK_CUR) != 0)
6099         {
6100           level->no_valid_file = TRUE;
6101
6102           Warn("cannot fseek in file '%s' -- using empty level", filename);
6103
6104           return;
6105         }
6106
6107         // skip apparently unused extra bytes following each level
6108         ReadUnusedBytesFromFile(file, extra_bytes);
6109
6110         // read size of next level in level package
6111         skip_bytes = getFile32BitLE(file);
6112
6113         num_levels_to_skip--;
6114       }
6115     }
6116     else
6117     {
6118       level->no_valid_file = TRUE;
6119
6120       Warn("unknown DC2 level file '%s' -- using empty level", filename);
6121
6122       return;
6123     }
6124   }
6125
6126   LoadLevelFromFileStream_DC(file, level);
6127
6128   closeFile(file);
6129 }
6130
6131
6132 // ----------------------------------------------------------------------------
6133 // functions for loading SB level
6134 // ----------------------------------------------------------------------------
6135
6136 int getMappedElement_SB(int element_ascii, boolean use_ces)
6137 {
6138   static struct
6139   {
6140     int ascii;
6141     int sb;
6142     int ce;
6143   }
6144   sb_element_mapping[] =
6145   {
6146     { ' ', EL_EMPTY,                EL_CUSTOM_1 },  // floor (space)
6147     { '#', EL_STEELWALL,            EL_CUSTOM_2 },  // wall
6148     { '@', EL_PLAYER_1,             EL_CUSTOM_3 },  // player
6149     { '$', EL_SOKOBAN_OBJECT,       EL_CUSTOM_4 },  // box
6150     { '.', EL_SOKOBAN_FIELD_EMPTY,  EL_CUSTOM_5 },  // goal square
6151     { '*', EL_SOKOBAN_FIELD_FULL,   EL_CUSTOM_6 },  // box on goal square
6152     { '+', EL_SOKOBAN_FIELD_PLAYER, EL_CUSTOM_7 },  // player on goal square
6153     { '_', EL_INVISIBLE_STEELWALL,  EL_FROM_LEVEL_TEMPLATE },  // floor beyond border
6154
6155     { 0,   -1,                      -1          },
6156   };
6157
6158   int i;
6159
6160   for (i = 0; sb_element_mapping[i].ascii != 0; i++)
6161     if (element_ascii == sb_element_mapping[i].ascii)
6162       return (use_ces ? sb_element_mapping[i].ce : sb_element_mapping[i].sb);
6163
6164   return EL_UNDEFINED;
6165 }
6166
6167 static void SetLevelSettings_SB(struct LevelInfo *level)
6168 {
6169   // time settings
6170   level->time = 0;
6171   level->use_step_counter = TRUE;
6172
6173   // score settings
6174   level->score[SC_TIME_BONUS] = 0;
6175   level->time_score_base = 1;
6176   level->rate_time_over_score = TRUE;
6177
6178   // game settings
6179   level->auto_exit_sokoban = TRUE;
6180 }
6181
6182 static void LoadLevelFromFileInfo_SB(struct LevelInfo *level,
6183                                      struct LevelFileInfo *level_file_info,
6184                                      boolean level_info_only)
6185 {
6186   char *filename = level_file_info->filename;
6187   char line[MAX_LINE_LEN], line_raw[MAX_LINE_LEN], previous_line[MAX_LINE_LEN];
6188   char last_comment[MAX_LINE_LEN];
6189   char level_name[MAX_LINE_LEN];
6190   char *line_ptr;
6191   File *file;
6192   int num_levels_to_skip = level_file_info->nr - leveldir_current->first_level;
6193   boolean read_continued_line = FALSE;
6194   boolean reading_playfield = FALSE;
6195   boolean got_valid_playfield_line = FALSE;
6196   boolean invalid_playfield_char = FALSE;
6197   boolean load_xsb_to_ces = check_special_flags("load_xsb_to_ces");
6198   int file_level_nr = 0;
6199   int x = 0, y = 0;             // initialized to make compilers happy
6200
6201   last_comment[0] = '\0';
6202   level_name[0] = '\0';
6203
6204   if (!(file = openFile(filename, MODE_READ)))
6205   {
6206     level->no_valid_file = TRUE;
6207
6208     if (!level_info_only)
6209       Warn("cannot read level '%s' -- using empty level", filename);
6210
6211     return;
6212   }
6213
6214   while (!checkEndOfFile(file))
6215   {
6216     // level successfully read, but next level may follow here
6217     if (!got_valid_playfield_line && reading_playfield)
6218     {
6219       // read playfield from single level file -- skip remaining file
6220       if (!level_file_info->packed)
6221         break;
6222
6223       if (file_level_nr >= num_levels_to_skip)
6224         break;
6225
6226       file_level_nr++;
6227
6228       last_comment[0] = '\0';
6229       level_name[0] = '\0';
6230
6231       reading_playfield = FALSE;
6232     }
6233
6234     got_valid_playfield_line = FALSE;
6235
6236     // read next line of input file
6237     if (!getStringFromFile(file, line, MAX_LINE_LEN))
6238       break;
6239
6240     // cut trailing line break (this can be newline and/or carriage return)
6241     for (line_ptr = &line[strlen(line)]; line_ptr >= line; line_ptr--)
6242       if ((*line_ptr == '\n' || *line_ptr == '\r') && *(line_ptr + 1) == '\0')
6243         *line_ptr = '\0';
6244
6245     // copy raw input line for later use (mainly debugging output)
6246     strcpy(line_raw, line);
6247
6248     if (read_continued_line)
6249     {
6250       // append new line to existing line, if there is enough space
6251       if (strlen(previous_line) + strlen(line_ptr) < MAX_LINE_LEN)
6252         strcat(previous_line, line_ptr);
6253
6254       strcpy(line, previous_line);      // copy storage buffer to line
6255
6256       read_continued_line = FALSE;
6257     }
6258
6259     // if the last character is '\', continue at next line
6260     if (strlen(line) > 0 && line[strlen(line) - 1] == '\\')
6261     {
6262       line[strlen(line) - 1] = '\0';    // cut off trailing backslash
6263       strcpy(previous_line, line);      // copy line to storage buffer
6264
6265       read_continued_line = TRUE;
6266
6267       continue;
6268     }
6269
6270     // skip empty lines
6271     if (line[0] == '\0')
6272       continue;
6273
6274     // extract comment text from comment line
6275     if (line[0] == ';')
6276     {
6277       for (line_ptr = line; *line_ptr; line_ptr++)
6278         if (*line_ptr != ' ' && *line_ptr != '\t' && *line_ptr != ';')
6279           break;
6280
6281       strcpy(last_comment, line_ptr);
6282
6283       continue;
6284     }
6285
6286     // extract level title text from line containing level title
6287     if (line[0] == '\'')
6288     {
6289       strcpy(level_name, &line[1]);
6290
6291       if (strlen(level_name) > 0 && level_name[strlen(level_name) - 1] == '\'')
6292         level_name[strlen(level_name) - 1] = '\0';
6293
6294       continue;
6295     }
6296
6297     // skip lines containing only spaces (or empty lines)
6298     for (line_ptr = line; *line_ptr; line_ptr++)
6299       if (*line_ptr != ' ')
6300         break;
6301     if (*line_ptr == '\0')
6302       continue;
6303
6304     // at this point, we have found a line containing part of a playfield
6305
6306     got_valid_playfield_line = TRUE;
6307
6308     if (!reading_playfield)
6309     {
6310       reading_playfield = TRUE;
6311       invalid_playfield_char = FALSE;
6312
6313       for (x = 0; x < MAX_LEV_FIELDX; x++)
6314         for (y = 0; y < MAX_LEV_FIELDY; y++)
6315           level->field[x][y] = getMappedElement_SB(' ', load_xsb_to_ces);
6316
6317       level->fieldx = 0;
6318       level->fieldy = 0;
6319
6320       // start with topmost tile row
6321       y = 0;
6322     }
6323
6324     // skip playfield line if larger row than allowed
6325     if (y >= MAX_LEV_FIELDY)
6326       continue;
6327
6328     // start with leftmost tile column
6329     x = 0;
6330
6331     // read playfield elements from line
6332     for (line_ptr = line; *line_ptr; line_ptr++)
6333     {
6334       int mapped_sb_element = getMappedElement_SB(*line_ptr, load_xsb_to_ces);
6335
6336       // stop parsing playfield line if larger column than allowed
6337       if (x >= MAX_LEV_FIELDX)
6338         break;
6339
6340       if (mapped_sb_element == EL_UNDEFINED)
6341       {
6342         invalid_playfield_char = TRUE;
6343
6344         break;
6345       }
6346
6347       level->field[x][y] = mapped_sb_element;
6348
6349       // continue with next tile column
6350       x++;
6351
6352       level->fieldx = MAX(x, level->fieldx);
6353     }
6354
6355     if (invalid_playfield_char)
6356     {
6357       // if first playfield line, treat invalid lines as comment lines
6358       if (y == 0)
6359         reading_playfield = FALSE;
6360
6361       continue;
6362     }
6363
6364     // continue with next tile row
6365     y++;
6366   }
6367
6368   closeFile(file);
6369
6370   level->fieldy = y;
6371
6372   level->fieldx = MIN(MAX(MIN_LEV_FIELDX, level->fieldx), MAX_LEV_FIELDX);
6373   level->fieldy = MIN(MAX(MIN_LEV_FIELDY, level->fieldy), MAX_LEV_FIELDY);
6374
6375   if (!reading_playfield)
6376   {
6377     level->no_valid_file = TRUE;
6378
6379     Warn("cannot read level '%s' -- using empty level", filename);
6380
6381     return;
6382   }
6383
6384   if (*level_name != '\0')
6385   {
6386     strncpy(level->name, level_name, MAX_LEVEL_NAME_LEN);
6387     level->name[MAX_LEVEL_NAME_LEN] = '\0';
6388   }
6389   else if (*last_comment != '\0')
6390   {
6391     strncpy(level->name, last_comment, MAX_LEVEL_NAME_LEN);
6392     level->name[MAX_LEVEL_NAME_LEN] = '\0';
6393   }
6394   else
6395   {
6396     sprintf(level->name, "--> Level %d <--", level_file_info->nr);
6397   }
6398
6399   // set all empty fields beyond the border walls to invisible steel wall
6400   for (y = 0; y < level->fieldy; y++) for (x = 0; x < level->fieldx; x++)
6401   {
6402     if ((x == 0 || x == level->fieldx - 1 ||
6403          y == 0 || y == level->fieldy - 1) &&
6404         level->field[x][y] == getMappedElement_SB(' ', load_xsb_to_ces))
6405       FloodFillLevel(x, y, getMappedElement_SB('_', load_xsb_to_ces),
6406                      level->field, level->fieldx, level->fieldy);
6407   }
6408
6409   // set special level settings for Sokoban levels
6410   SetLevelSettings_SB(level);
6411
6412   if (load_xsb_to_ces)
6413   {
6414     // special global settings can now be set in level template
6415     level->use_custom_template = TRUE;
6416   }
6417 }
6418
6419
6420 // -------------------------------------------------------------------------
6421 // functions for handling native levels
6422 // -------------------------------------------------------------------------
6423
6424 static void LoadLevelFromFileInfo_BD(struct LevelInfo *level,
6425                                      struct LevelFileInfo *level_file_info,
6426                                      boolean level_info_only)
6427 {
6428   int pos = 0;
6429
6430   // determine position of requested level inside level package
6431   if (level_file_info->packed)
6432     pos = level_file_info->nr - leveldir_current->first_level;
6433
6434   if (!LoadNativeLevel_BD(level_file_info->filename, pos, level_info_only))
6435     level->no_valid_file = TRUE;
6436 }
6437
6438 static void LoadLevelFromFileInfo_EM(struct LevelInfo *level,
6439                                      struct LevelFileInfo *level_file_info,
6440                                      boolean level_info_only)
6441 {
6442   if (!LoadNativeLevel_EM(level_file_info->filename, level_info_only))
6443     level->no_valid_file = TRUE;
6444 }
6445
6446 static void LoadLevelFromFileInfo_SP(struct LevelInfo *level,
6447                                      struct LevelFileInfo *level_file_info,
6448                                      boolean level_info_only)
6449 {
6450   int pos = 0;
6451
6452   // determine position of requested level inside level package
6453   if (level_file_info->packed)
6454     pos = level_file_info->nr - leveldir_current->first_level;
6455
6456   if (!LoadNativeLevel_SP(level_file_info->filename, pos, level_info_only))
6457     level->no_valid_file = TRUE;
6458 }
6459
6460 static void LoadLevelFromFileInfo_MM(struct LevelInfo *level,
6461                                      struct LevelFileInfo *level_file_info,
6462                                      boolean level_info_only)
6463 {
6464   if (!LoadNativeLevel_MM(level_file_info->filename, level_info_only))
6465     level->no_valid_file = TRUE;
6466 }
6467
6468 void CopyNativeLevel_RND_to_Native(struct LevelInfo *level)
6469 {
6470   if (level->game_engine_type == GAME_ENGINE_TYPE_BD)
6471     CopyNativeLevel_RND_to_BD(level);
6472   else if (level->game_engine_type == GAME_ENGINE_TYPE_EM)
6473     CopyNativeLevel_RND_to_EM(level);
6474   else if (level->game_engine_type == GAME_ENGINE_TYPE_SP)
6475     CopyNativeLevel_RND_to_SP(level);
6476   else if (level->game_engine_type == GAME_ENGINE_TYPE_MM)
6477     CopyNativeLevel_RND_to_MM(level);
6478 }
6479
6480 void CopyNativeLevel_Native_to_RND(struct LevelInfo *level)
6481 {
6482   if (level->game_engine_type == GAME_ENGINE_TYPE_BD)
6483     CopyNativeLevel_BD_to_RND(level);
6484   else if (level->game_engine_type == GAME_ENGINE_TYPE_EM)
6485     CopyNativeLevel_EM_to_RND(level);
6486   else if (level->game_engine_type == GAME_ENGINE_TYPE_SP)
6487     CopyNativeLevel_SP_to_RND(level);
6488   else if (level->game_engine_type == GAME_ENGINE_TYPE_MM)
6489     CopyNativeLevel_MM_to_RND(level);
6490 }
6491
6492 void SaveNativeLevel(struct LevelInfo *level)
6493 {
6494   if (level->game_engine_type == GAME_ENGINE_TYPE_SP)
6495   {
6496     char *basename = getSingleLevelBasenameExt(level->file_info.nr, "sp");
6497     char *filename = getLevelFilenameFromBasename(basename);
6498
6499     CopyNativeLevel_RND_to_SP(level);
6500     CopyNativeTape_RND_to_SP(level);
6501
6502     SaveNativeLevel_SP(filename);
6503   }
6504 }
6505
6506
6507 // ----------------------------------------------------------------------------
6508 // functions for loading generic level
6509 // ----------------------------------------------------------------------------
6510
6511 static void LoadLevelFromFileInfo(struct LevelInfo *level,
6512                                   struct LevelFileInfo *level_file_info,
6513                                   boolean level_info_only)
6514 {
6515   // always start with reliable default values
6516   setLevelInfoToDefaults(level, level_info_only, TRUE);
6517
6518   switch (level_file_info->type)
6519   {
6520     case LEVEL_FILE_TYPE_RND:
6521       LoadLevelFromFileInfo_RND(level, level_file_info, level_info_only);
6522       break;
6523
6524     case LEVEL_FILE_TYPE_BD:
6525       LoadLevelFromFileInfo_BD(level, level_file_info, level_info_only);
6526       level->game_engine_type = GAME_ENGINE_TYPE_BD;
6527       break;
6528
6529     case LEVEL_FILE_TYPE_EM:
6530       LoadLevelFromFileInfo_EM(level, level_file_info, level_info_only);
6531       level->game_engine_type = GAME_ENGINE_TYPE_EM;
6532       break;
6533
6534     case LEVEL_FILE_TYPE_SP:
6535       LoadLevelFromFileInfo_SP(level, level_file_info, level_info_only);
6536       level->game_engine_type = GAME_ENGINE_TYPE_SP;
6537       break;
6538
6539     case LEVEL_FILE_TYPE_MM:
6540       LoadLevelFromFileInfo_MM(level, level_file_info, level_info_only);
6541       level->game_engine_type = GAME_ENGINE_TYPE_MM;
6542       break;
6543
6544     case LEVEL_FILE_TYPE_DC:
6545       LoadLevelFromFileInfo_DC(level, level_file_info, level_info_only);
6546       break;
6547
6548     case LEVEL_FILE_TYPE_SB:
6549       LoadLevelFromFileInfo_SB(level, level_file_info, level_info_only);
6550       break;
6551
6552     default:
6553       LoadLevelFromFileInfo_RND(level, level_file_info, level_info_only);
6554       break;
6555   }
6556
6557   // if level file is invalid, restore level structure to default values
6558   if (level->no_valid_file)
6559     setLevelInfoToDefaults(level, level_info_only, FALSE);
6560
6561   if (check_special_flags("use_native_bd_game_engine"))
6562     level->game_engine_type = GAME_ENGINE_TYPE_BD;
6563
6564   if (level->game_engine_type == GAME_ENGINE_TYPE_UNKNOWN)
6565     level->game_engine_type = GAME_ENGINE_TYPE_RND;
6566
6567   if (level_file_info->type != LEVEL_FILE_TYPE_RND)
6568     CopyNativeLevel_Native_to_RND(level);
6569 }
6570
6571 void LoadLevelFromFilename(struct LevelInfo *level, char *filename)
6572 {
6573   static struct LevelFileInfo level_file_info;
6574
6575   // always start with reliable default values
6576   setFileInfoToDefaults(&level_file_info);
6577
6578   level_file_info.nr = 0;                       // unknown level number
6579   level_file_info.type = LEVEL_FILE_TYPE_RND;   // no others supported yet
6580
6581   setString(&level_file_info.filename, filename);
6582
6583   LoadLevelFromFileInfo(level, &level_file_info, FALSE);
6584 }
6585
6586 static void LoadLevel_InitVersion(struct LevelInfo *level)
6587 {
6588   int i, j;
6589
6590   if (leveldir_current == NULL)         // only when dumping level
6591     return;
6592
6593   // all engine modifications also valid for levels which use latest engine
6594   if (level->game_version < VERSION_IDENT(3,2,0,5))
6595   {
6596     // time bonus score was given for 10 s instead of 1 s before 3.2.0-5
6597     level->time_score_base = 10;
6598   }
6599
6600   if (leveldir_current->latest_engine)
6601   {
6602     // ---------- use latest game engine --------------------------------------
6603
6604     /* For all levels which are forced to use the latest game engine version
6605        (normally all but user contributed, private and undefined levels), set
6606        the game engine version to the actual version; this allows for actual
6607        corrections in the game engine to take effect for existing, converted
6608        levels (from "classic" or other existing games) to make the emulation
6609        of the corresponding game more accurate, while (hopefully) not breaking
6610        existing levels created from other players. */
6611
6612     level->game_version = GAME_VERSION_ACTUAL;
6613
6614     /* Set special EM style gems behaviour: EM style gems slip down from
6615        normal, steel and growing wall. As this is a more fundamental change,
6616        it seems better to set the default behaviour to "off" (as it is more
6617        natural) and make it configurable in the level editor (as a property
6618        of gem style elements). Already existing converted levels (neither
6619        private nor contributed levels) are changed to the new behaviour. */
6620
6621     if (level->file_version < FILE_VERSION_2_0)
6622       level->em_slippery_gems = TRUE;
6623
6624     return;
6625   }
6626
6627   // ---------- use game engine the level was created with --------------------
6628
6629   /* For all levels which are not forced to use the latest game engine
6630      version (normally user contributed, private and undefined levels),
6631      use the version of the game engine the levels were created for.
6632
6633      Since 2.0.1, the game engine version is now directly stored
6634      in the level file (chunk "VERS"), so there is no need anymore
6635      to set the game version from the file version (except for old,
6636      pre-2.0 levels, where the game version is still taken from the
6637      file format version used to store the level -- see above). */
6638
6639   // player was faster than enemies in 1.0.0 and before
6640   if (level->file_version == FILE_VERSION_1_0)
6641     for (i = 0; i < MAX_PLAYERS; i++)
6642       level->initial_player_stepsize[i] = STEPSIZE_FAST;
6643
6644   // default behaviour for EM style gems was "slippery" only in 2.0.1
6645   if (level->game_version == VERSION_IDENT(2,0,1,0))
6646     level->em_slippery_gems = TRUE;
6647
6648   // springs could be pushed over pits before (pre-release version) 2.2.0
6649   if (level->game_version < VERSION_IDENT(2,2,0,0))
6650     level->use_spring_bug = TRUE;
6651
6652   if (level->game_version < VERSION_IDENT(3,2,0,5))
6653   {
6654     // time orb caused limited time in endless time levels before 3.2.0-5
6655     level->use_time_orb_bug = TRUE;
6656
6657     // default behaviour for snapping was "no snap delay" before 3.2.0-5
6658     level->block_snap_field = FALSE;
6659
6660     // extra time score was same value as time left score before 3.2.0-5
6661     level->extra_time_score = level->score[SC_TIME_BONUS];
6662   }
6663
6664   if (level->game_version < VERSION_IDENT(3,2,0,7))
6665   {
6666     // default behaviour for snapping was "not continuous" before 3.2.0-7
6667     level->continuous_snapping = FALSE;
6668   }
6669
6670   // only few elements were able to actively move into acid before 3.1.0
6671   // trigger settings did not exist before 3.1.0; set to default "any"
6672   if (level->game_version < VERSION_IDENT(3,1,0,0))
6673   {
6674     // correct "can move into acid" settings (all zero in old levels)
6675
6676     level->can_move_into_acid_bits = 0; // nothing can move into acid
6677     level->dont_collide_with_bits = 0; // nothing is deadly when colliding
6678
6679     setMoveIntoAcidProperty(level, EL_ROBOT,     TRUE);
6680     setMoveIntoAcidProperty(level, EL_SATELLITE, TRUE);
6681     setMoveIntoAcidProperty(level, EL_PENGUIN,   TRUE);
6682     setMoveIntoAcidProperty(level, EL_BALLOON,   TRUE);
6683
6684     for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
6685       SET_PROPERTY(EL_CUSTOM_START + i, EP_CAN_MOVE_INTO_ACID, TRUE);
6686
6687     // correct trigger settings (stored as zero == "none" in old levels)
6688
6689     for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
6690     {
6691       int element = EL_CUSTOM_START + i;
6692       struct ElementInfo *ei = &element_info[element];
6693
6694       for (j = 0; j < ei->num_change_pages; j++)
6695       {
6696         struct ElementChangeInfo *change = &ei->change_page[j];
6697
6698         change->trigger_player = CH_PLAYER_ANY;
6699         change->trigger_page = CH_PAGE_ANY;
6700       }
6701     }
6702   }
6703
6704   // try to detect and fix "Snake Bite" levels, which are broken with 3.2.0
6705   {
6706     int element = EL_CUSTOM_256;
6707     struct ElementInfo *ei = &element_info[element];
6708     struct ElementChangeInfo *change = &ei->change_page[0];
6709
6710     /* This is needed to fix a problem that was caused by a bugfix in function
6711        game.c/CreateFieldExt() introduced with 3.2.0 that corrects the behaviour
6712        when a custom element changes to EL_SOKOBAN_FIELD_PLAYER (before, it did
6713        not replace walkable elements, but instead just placed the player on it,
6714        without placing the Sokoban field under the player). Unfortunately, this
6715        breaks "Snake Bite" style levels when the snake is halfway through a door
6716        that just closes (the snake head is still alive and can be moved in this
6717        case). This can be fixed by replacing the EL_SOKOBAN_FIELD_PLAYER by the
6718        player (without Sokoban element) which then gets killed as designed). */
6719
6720     if ((strncmp(leveldir_current->identifier, "snake_bite", 10) == 0 ||
6721          strncmp(ei->description, "pause b4 death", 14) == 0) &&
6722         change->target_element == EL_SOKOBAN_FIELD_PLAYER)
6723       change->target_element = EL_PLAYER_1;
6724   }
6725
6726   // try to detect and fix "Zelda" style levels, which are broken with 3.2.5
6727   if (level->game_version < VERSION_IDENT(3,2,5,0))
6728   {
6729     /* This is needed to fix a problem that was caused by a bugfix in function
6730        game.c/CheckTriggeredElementChangeExt() introduced with 3.2.5 that
6731        corrects the behaviour when a custom element changes to another custom
6732        element with a higher element number that has change actions defined.
6733        Normally, only one change per frame is allowed for custom elements.
6734        Therefore, it is checked if a custom element already changed in the
6735        current frame; if it did, subsequent changes are suppressed.
6736        Unfortunately, this is only checked for element changes, but not for
6737        change actions, which are still executed. As the function above loops
6738        through all custom elements from lower to higher, an element change
6739        resulting in a lower CE number won't be checked again, while a target
6740        element with a higher number will also be checked, and potential change
6741        actions will get executed for this CE, too (which is wrong), while
6742        further changes are ignored (which is correct). As this bugfix breaks
6743        Zelda II (and introduces graphical bugs to Zelda I, and also breaks a
6744        few other levels like Alan Bond's "FMV"), allow the previous, incorrect
6745        behaviour for existing levels and tapes that make use of this bug */
6746
6747     level->use_action_after_change_bug = TRUE;
6748   }
6749
6750   // not centering level after relocating player was default only in 3.2.3
6751   if (level->game_version == VERSION_IDENT(3,2,3,0))    // (no pre-releases)
6752     level->shifted_relocation = TRUE;
6753
6754   // EM style elements always chain-exploded in R'n'D engine before 3.2.6
6755   if (level->game_version < VERSION_IDENT(3,2,6,0))
6756     level->em_explodes_by_fire = TRUE;
6757
6758   // levels were solved by the first player entering an exit up to 4.1.0.0
6759   if (level->game_version <= VERSION_IDENT(4,1,0,0))
6760     level->solved_by_one_player = TRUE;
6761
6762   // game logic of "game of life" and "biomaze" was buggy before 4.1.1.1
6763   if (level->game_version < VERSION_IDENT(4,1,1,1))
6764     level->use_life_bugs = TRUE;
6765
6766   // only Sokoban fields (but not objects) had to be solved before 4.1.1.1
6767   if (level->game_version < VERSION_IDENT(4,1,1,1))
6768     level->sb_objects_needed = FALSE;
6769
6770   // CE actions were triggered by unfinished digging/collecting up to 4.2.2.0
6771   if (level->game_version <= VERSION_IDENT(4,2,2,0))
6772     level->finish_dig_collect = FALSE;
6773
6774   // CE changing to player was kept under the player if walkable up to 4.2.3.1
6775   if (level->game_version <= VERSION_IDENT(4,2,3,1))
6776     level->keep_walkable_ce = TRUE;
6777 }
6778
6779 static void LoadLevel_InitSettings_SB(struct LevelInfo *level)
6780 {
6781   boolean is_sokoban_level = TRUE;    // unless non-Sokoban elements found
6782   int x, y;
6783
6784   // check if this level is (not) a Sokoban level
6785   for (y = 0; y < level->fieldy; y++)
6786     for (x = 0; x < level->fieldx; x++)
6787       if (!IS_SB_ELEMENT(Tile[x][y]))
6788         is_sokoban_level = FALSE;
6789
6790   if (is_sokoban_level)
6791   {
6792     // set special level settings for Sokoban levels
6793     SetLevelSettings_SB(level);
6794   }
6795 }
6796
6797 static void LoadLevel_InitSettings(struct LevelInfo *level)
6798 {
6799   // adjust level settings for (non-native) Sokoban-style levels
6800   LoadLevel_InitSettings_SB(level);
6801
6802   // rename levels with title "nameless level" or if renaming is forced
6803   if (leveldir_current->empty_level_name != NULL &&
6804       (strEqual(level->name, NAMELESS_LEVEL_NAME) ||
6805        leveldir_current->force_level_name))
6806     snprintf(level->name, MAX_LEVEL_NAME_LEN + 1,
6807              leveldir_current->empty_level_name, level_nr);
6808 }
6809
6810 static void LoadLevel_InitStandardElements(struct LevelInfo *level)
6811 {
6812   int i, x, y;
6813
6814   // map elements that have changed in newer versions
6815   level->amoeba_content = getMappedElementByVersion(level->amoeba_content,
6816                                                     level->game_version);
6817   for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
6818     for (x = 0; x < 3; x++)
6819       for (y = 0; y < 3; y++)
6820         level->yamyam_content[i].e[x][y] =
6821           getMappedElementByVersion(level->yamyam_content[i].e[x][y],
6822                                     level->game_version);
6823
6824 }
6825
6826 static void LoadLevel_InitCustomElements(struct LevelInfo *level)
6827 {
6828   int i, j;
6829
6830   // map custom element change events that have changed in newer versions
6831   // (these following values were accidentally changed in version 3.0.1)
6832   // (this seems to be needed only for 'ab_levelset3' and 'ab_levelset4')
6833   if (level->game_version <= VERSION_IDENT(3,0,0,0))
6834   {
6835     for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
6836     {
6837       int element = EL_CUSTOM_START + i;
6838
6839       // order of checking and copying events to be mapped is important
6840       // (do not change the start and end value -- they are constant)
6841       for (j = CE_BY_OTHER_ACTION; j >= CE_VALUE_GETS_ZERO; j--)
6842       {
6843         if (HAS_CHANGE_EVENT(element, j - 2))
6844         {
6845           SET_CHANGE_EVENT(element, j - 2, FALSE);
6846           SET_CHANGE_EVENT(element, j, TRUE);
6847         }
6848       }
6849
6850       // order of checking and copying events to be mapped is important
6851       // (do not change the start and end value -- they are constant)
6852       for (j = CE_PLAYER_COLLECTS_X; j >= CE_HITTING_SOMETHING; j--)
6853       {
6854         if (HAS_CHANGE_EVENT(element, j - 1))
6855         {
6856           SET_CHANGE_EVENT(element, j - 1, FALSE);
6857           SET_CHANGE_EVENT(element, j, TRUE);
6858         }
6859       }
6860     }
6861   }
6862
6863   // initialize "can_change" field for old levels with only one change page
6864   if (level->game_version <= VERSION_IDENT(3,0,2,0))
6865   {
6866     for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
6867     {
6868       int element = EL_CUSTOM_START + i;
6869
6870       if (CAN_CHANGE(element))
6871         element_info[element].change->can_change = TRUE;
6872     }
6873   }
6874
6875   // correct custom element values (for old levels without these options)
6876   if (level->game_version < VERSION_IDENT(3,1,1,0))
6877   {
6878     for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
6879     {
6880       int element = EL_CUSTOM_START + i;
6881       struct ElementInfo *ei = &element_info[element];
6882
6883       if (ei->access_direction == MV_NO_DIRECTION)
6884         ei->access_direction = MV_ALL_DIRECTIONS;
6885     }
6886   }
6887
6888   // correct custom element values (fix invalid values for all versions)
6889   if (1)
6890   {
6891     for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
6892     {
6893       int element = EL_CUSTOM_START + i;
6894       struct ElementInfo *ei = &element_info[element];
6895
6896       for (j = 0; j < ei->num_change_pages; j++)
6897       {
6898         struct ElementChangeInfo *change = &ei->change_page[j];
6899
6900         if (change->trigger_player == CH_PLAYER_NONE)
6901           change->trigger_player = CH_PLAYER_ANY;
6902
6903         if (change->trigger_side == CH_SIDE_NONE)
6904           change->trigger_side = CH_SIDE_ANY;
6905       }
6906     }
6907   }
6908
6909   // initialize "can_explode" field for old levels which did not store this
6910   // !!! CHECK THIS -- "<= 3,1,0,0" IS PROBABLY WRONG !!!
6911   if (level->game_version <= VERSION_IDENT(3,1,0,0))
6912   {
6913     for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
6914     {
6915       int element = EL_CUSTOM_START + i;
6916
6917       if (EXPLODES_1X1_OLD(element))
6918         element_info[element].explosion_type = EXPLODES_1X1;
6919
6920       SET_PROPERTY(element, EP_CAN_EXPLODE, (EXPLODES_BY_FIRE(element) ||
6921                                              EXPLODES_SMASHED(element) ||
6922                                              EXPLODES_IMPACT(element)));
6923     }
6924   }
6925
6926   // correct previously hard-coded move delay values for maze runner style
6927   if (level->game_version < VERSION_IDENT(3,1,1,0))
6928   {
6929     for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
6930     {
6931       int element = EL_CUSTOM_START + i;
6932
6933       if (element_info[element].move_pattern & MV_MAZE_RUNNER_STYLE)
6934       {
6935         // previously hard-coded and therefore ignored
6936         element_info[element].move_delay_fixed = 9;
6937         element_info[element].move_delay_random = 0;
6938       }
6939     }
6940   }
6941
6942   // set some other uninitialized values of custom elements in older levels
6943   if (level->game_version < VERSION_IDENT(3,1,0,0))
6944   {
6945     for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
6946     {
6947       int element = EL_CUSTOM_START + i;
6948
6949       element_info[element].access_direction = MV_ALL_DIRECTIONS;
6950
6951       element_info[element].explosion_delay = 17;
6952       element_info[element].ignition_delay = 8;
6953     }
6954   }
6955
6956   // set mouse click change events to work for left/middle/right mouse button
6957   if (level->game_version < VERSION_IDENT(4,2,3,0))
6958   {
6959     for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
6960     {
6961       int element = EL_CUSTOM_START + i;
6962       struct ElementInfo *ei = &element_info[element];
6963
6964       for (j = 0; j < ei->num_change_pages; j++)
6965       {
6966         struct ElementChangeInfo *change = &ei->change_page[j];
6967
6968         if (change->has_event[CE_CLICKED_BY_MOUSE] ||
6969             change->has_event[CE_PRESSED_BY_MOUSE] ||
6970             change->has_event[CE_MOUSE_CLICKED_ON_X] ||
6971             change->has_event[CE_MOUSE_PRESSED_ON_X])
6972           change->trigger_side = CH_SIDE_ANY;
6973       }
6974     }
6975   }
6976 }
6977
6978 static void LoadLevel_InitElements(struct LevelInfo *level)
6979 {
6980   LoadLevel_InitStandardElements(level);
6981
6982   if (level->file_has_custom_elements)
6983     LoadLevel_InitCustomElements(level);
6984
6985   // initialize element properties for level editor etc.
6986   InitElementPropertiesEngine(level->game_version);
6987   InitElementPropertiesGfxElement();
6988 }
6989
6990 static void LoadLevel_InitPlayfield(struct LevelInfo *level)
6991 {
6992   int x, y;
6993
6994   // map elements that have changed in newer versions
6995   for (y = 0; y < level->fieldy; y++)
6996     for (x = 0; x < level->fieldx; x++)
6997       level->field[x][y] = getMappedElementByVersion(level->field[x][y],
6998                                                      level->game_version);
6999
7000   // clear unused playfield data (nicer if level gets resized in editor)
7001   for (x = 0; x < MAX_LEV_FIELDX; x++)
7002     for (y = 0; y < MAX_LEV_FIELDY; y++)
7003       if (x >= level->fieldx || y >= level->fieldy)
7004         level->field[x][y] = EL_EMPTY;
7005
7006   // copy elements to runtime playfield array
7007   for (x = 0; x < MAX_LEV_FIELDX; x++)
7008     for (y = 0; y < MAX_LEV_FIELDY; y++)
7009       Tile[x][y] = level->field[x][y];
7010
7011   // initialize level size variables for faster access
7012   lev_fieldx = level->fieldx;
7013   lev_fieldy = level->fieldy;
7014
7015   // determine border element for this level
7016   if (level->file_info.type == LEVEL_FILE_TYPE_DC)
7017     BorderElement = EL_EMPTY;   // (in editor, SetBorderElement() is used)
7018   else
7019     SetBorderElement();
7020 }
7021
7022 static void LoadLevel_InitNativeEngines(struct LevelInfo *level)
7023 {
7024   struct LevelFileInfo *level_file_info = &level->file_info;
7025
7026   if (level_file_info->type == LEVEL_FILE_TYPE_RND)
7027     CopyNativeLevel_RND_to_Native(level);
7028 }
7029
7030 static void LoadLevelTemplate_LoadAndInit(void)
7031 {
7032   LoadLevelFromFileInfo(&level_template, &level_template.file_info, FALSE);
7033
7034   LoadLevel_InitVersion(&level_template);
7035   LoadLevel_InitElements(&level_template);
7036   LoadLevel_InitSettings(&level_template);
7037
7038   ActivateLevelTemplate();
7039 }
7040
7041 void LoadLevelTemplate(int nr)
7042 {
7043   if (!fileExists(getGlobalLevelTemplateFilename()))
7044   {
7045     Warn("no level template found for this level");
7046
7047     return;
7048   }
7049
7050   setLevelFileInfo(&level_template.file_info, nr);
7051
7052   LoadLevelTemplate_LoadAndInit();
7053 }
7054
7055 static void LoadNetworkLevelTemplate(struct NetworkLevelInfo *network_level)
7056 {
7057   copyLevelFileInfo(&network_level->tmpl_info, &level_template.file_info);
7058
7059   LoadLevelTemplate_LoadAndInit();
7060 }
7061
7062 static void LoadLevel_LoadAndInit(struct NetworkLevelInfo *network_level)
7063 {
7064   LoadLevelFromFileInfo(&level, &level.file_info, FALSE);
7065
7066   if (level.use_custom_template)
7067   {
7068     if (network_level != NULL)
7069       LoadNetworkLevelTemplate(network_level);
7070     else
7071       LoadLevelTemplate(-1);
7072   }
7073
7074   LoadLevel_InitVersion(&level);
7075   LoadLevel_InitElements(&level);
7076   LoadLevel_InitPlayfield(&level);
7077   LoadLevel_InitSettings(&level);
7078
7079   LoadLevel_InitNativeEngines(&level);
7080 }
7081
7082 void LoadLevel(int nr)
7083 {
7084   SetLevelSetInfo(leveldir_current->identifier, nr);
7085
7086   setLevelFileInfo(&level.file_info, nr);
7087
7088   LoadLevel_LoadAndInit(NULL);
7089 }
7090
7091 void LoadLevelInfoOnly(int nr)
7092 {
7093   setLevelFileInfo(&level.file_info, nr);
7094
7095   LoadLevelFromFileInfo(&level, &level.file_info, TRUE);
7096 }
7097
7098 void LoadNetworkLevel(struct NetworkLevelInfo *network_level)
7099 {
7100   SetLevelSetInfo(network_level->leveldir_identifier,
7101                   network_level->file_info.nr);
7102
7103   copyLevelFileInfo(&network_level->file_info, &level.file_info);
7104
7105   LoadLevel_LoadAndInit(network_level);
7106 }
7107
7108 static int SaveLevel_VERS(FILE *file, struct LevelInfo *level)
7109 {
7110   int chunk_size = 0;
7111
7112   chunk_size += putFileVersion(file, level->file_version);
7113   chunk_size += putFileVersion(file, level->game_version);
7114
7115   return chunk_size;
7116 }
7117
7118 static int SaveLevel_DATE(FILE *file, struct LevelInfo *level)
7119 {
7120   int chunk_size = 0;
7121
7122   chunk_size += putFile16BitBE(file, level->creation_date.year);
7123   chunk_size += putFile8Bit(file,    level->creation_date.month);
7124   chunk_size += putFile8Bit(file,    level->creation_date.day);
7125
7126   return chunk_size;
7127 }
7128
7129 #if ENABLE_HISTORIC_CHUNKS
7130 static void SaveLevel_HEAD(FILE *file, struct LevelInfo *level)
7131 {
7132   int i, x, y;
7133
7134   putFile8Bit(file, level->fieldx);
7135   putFile8Bit(file, level->fieldy);
7136
7137   putFile16BitBE(file, level->time);
7138   putFile16BitBE(file, level->gems_needed);
7139
7140   for (i = 0; i < MAX_LEVEL_NAME_LEN; i++)
7141     putFile8Bit(file, level->name[i]);
7142
7143   for (i = 0; i < LEVEL_SCORE_ELEMENTS; i++)
7144     putFile8Bit(file, level->score[i]);
7145
7146   for (i = 0; i < STD_ELEMENT_CONTENTS; i++)
7147     for (y = 0; y < 3; y++)
7148       for (x = 0; x < 3; x++)
7149         putFile8Bit(file, (level->encoding_16bit_yamyam ? EL_EMPTY :
7150                            level->yamyam_content[i].e[x][y]));
7151   putFile8Bit(file, level->amoeba_speed);
7152   putFile8Bit(file, level->time_magic_wall);
7153   putFile8Bit(file, level->time_wheel);
7154   putFile8Bit(file, (level->encoding_16bit_amoeba ? EL_EMPTY :
7155                      level->amoeba_content));
7156   putFile8Bit(file, (level->initial_player_stepsize == STEPSIZE_FAST ? 1 : 0));
7157   putFile8Bit(file, (level->initial_gravity ? 1 : 0));
7158   putFile8Bit(file, (level->encoding_16bit_field ? 1 : 0));
7159   putFile8Bit(file, (level->em_slippery_gems ? 1 : 0));
7160
7161   putFile8Bit(file, (level->use_custom_template ? 1 : 0));
7162
7163   putFile8Bit(file, (level->block_last_field ? 1 : 0));
7164   putFile8Bit(file, (level->sp_block_last_field ? 1 : 0));
7165   putFile32BitBE(file, level->can_move_into_acid_bits);
7166   putFile8Bit(file, level->dont_collide_with_bits);
7167
7168   putFile8Bit(file, (level->use_spring_bug ? 1 : 0));
7169   putFile8Bit(file, (level->use_step_counter ? 1 : 0));
7170
7171   putFile8Bit(file, (level->instant_relocation ? 1 : 0));
7172   putFile8Bit(file, (level->can_pass_to_walkable ? 1 : 0));
7173   putFile8Bit(file, (level->grow_into_diggable ? 1 : 0));
7174
7175   putFile8Bit(file, level->game_engine_type);
7176
7177   WriteUnusedBytesToFile(file, LEVEL_CHUNK_HEAD_UNUSED);
7178 }
7179 #endif
7180
7181 static int SaveLevel_NAME(FILE *file, struct LevelInfo *level)
7182 {
7183   int chunk_size = 0;
7184   int i;
7185
7186   for (i = 0; i < MAX_LEVEL_NAME_LEN; i++)
7187     chunk_size += putFile8Bit(file, level->name[i]);
7188
7189   return chunk_size;
7190 }
7191
7192 static int SaveLevel_AUTH(FILE *file, struct LevelInfo *level)
7193 {
7194   int chunk_size = 0;
7195   int i;
7196
7197   for (i = 0; i < MAX_LEVEL_AUTHOR_LEN; i++)
7198     chunk_size += putFile8Bit(file, level->author[i]);
7199
7200   return chunk_size;
7201 }
7202
7203 #if ENABLE_HISTORIC_CHUNKS
7204 static int SaveLevel_BODY(FILE *file, struct LevelInfo *level)
7205 {
7206   int chunk_size = 0;
7207   int x, y;
7208
7209   for (y = 0; y < level->fieldy; y++)
7210     for (x = 0; x < level->fieldx; x++)
7211       if (level->encoding_16bit_field)
7212         chunk_size += putFile16BitBE(file, level->field[x][y]);
7213       else
7214         chunk_size += putFile8Bit(file, level->field[x][y]);
7215
7216   return chunk_size;
7217 }
7218 #endif
7219
7220 static int SaveLevel_BODY(FILE *file, struct LevelInfo *level)
7221 {
7222   int chunk_size = 0;
7223   int x, y;
7224
7225   for (y = 0; y < level->fieldy; y++)
7226     for (x = 0; x < level->fieldx; x++)
7227       chunk_size += putFile16BitBE(file, level->field[x][y]);
7228
7229   return chunk_size;
7230 }
7231
7232 #if ENABLE_HISTORIC_CHUNKS
7233 static void SaveLevel_CONT(FILE *file, struct LevelInfo *level)
7234 {
7235   int i, x, y;
7236
7237   putFile8Bit(file, EL_YAMYAM);
7238   putFile8Bit(file, level->num_yamyam_contents);
7239   putFile8Bit(file, 0);
7240   putFile8Bit(file, 0);
7241
7242   for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
7243     for (y = 0; y < 3; y++)
7244       for (x = 0; x < 3; x++)
7245         if (level->encoding_16bit_field)
7246           putFile16BitBE(file, level->yamyam_content[i].e[x][y]);
7247         else
7248           putFile8Bit(file, level->yamyam_content[i].e[x][y]);
7249 }
7250 #endif
7251
7252 #if ENABLE_HISTORIC_CHUNKS
7253 static void SaveLevel_CNT2(FILE *file, struct LevelInfo *level, int element)
7254 {
7255   int i, x, y;
7256   int num_contents, content_xsize, content_ysize;
7257   int content_array[MAX_ELEMENT_CONTENTS][3][3];
7258
7259   if (element == EL_YAMYAM)
7260   {
7261     num_contents = level->num_yamyam_contents;
7262     content_xsize = 3;
7263     content_ysize = 3;
7264
7265     for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
7266       for (y = 0; y < 3; y++)
7267         for (x = 0; x < 3; x++)
7268           content_array[i][x][y] = level->yamyam_content[i].e[x][y];
7269   }
7270   else if (element == EL_BD_AMOEBA)
7271   {
7272     num_contents = 1;
7273     content_xsize = 1;
7274     content_ysize = 1;
7275
7276     for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
7277       for (y = 0; y < 3; y++)
7278         for (x = 0; x < 3; x++)
7279           content_array[i][x][y] = EL_EMPTY;
7280     content_array[0][0][0] = level->amoeba_content;
7281   }
7282   else
7283   {
7284     // chunk header already written -- write empty chunk data
7285     WriteUnusedBytesToFile(file, LEVEL_CHUNK_CNT2_SIZE);
7286
7287     Warn("cannot save content for element '%d'", element);
7288
7289     return;
7290   }
7291
7292   putFile16BitBE(file, element);
7293   putFile8Bit(file, num_contents);
7294   putFile8Bit(file, content_xsize);
7295   putFile8Bit(file, content_ysize);
7296
7297   WriteUnusedBytesToFile(file, LEVEL_CHUNK_CNT2_UNUSED);
7298
7299   for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
7300     for (y = 0; y < 3; y++)
7301       for (x = 0; x < 3; x++)
7302         putFile16BitBE(file, content_array[i][x][y]);
7303 }
7304 #endif
7305
7306 #if ENABLE_HISTORIC_CHUNKS
7307 static int SaveLevel_CNT3(FILE *file, struct LevelInfo *level, int element)
7308 {
7309   int envelope_nr = element - EL_ENVELOPE_1;
7310   int envelope_len = strlen(level->envelope_text[envelope_nr]) + 1;
7311   int chunk_size = 0;
7312   int i;
7313
7314   chunk_size += putFile16BitBE(file, element);
7315   chunk_size += putFile16BitBE(file, envelope_len);
7316   chunk_size += putFile8Bit(file, level->envelope_xsize[envelope_nr]);
7317   chunk_size += putFile8Bit(file, level->envelope_ysize[envelope_nr]);
7318
7319   WriteUnusedBytesToFile(file, LEVEL_CHUNK_CNT3_UNUSED);
7320   chunk_size += LEVEL_CHUNK_CNT3_UNUSED;
7321
7322   for (i = 0; i < envelope_len; i++)
7323     chunk_size += putFile8Bit(file, level->envelope_text[envelope_nr][i]);
7324
7325   return chunk_size;
7326 }
7327 #endif
7328
7329 #if ENABLE_HISTORIC_CHUNKS
7330 static void SaveLevel_CUS1(FILE *file, struct LevelInfo *level,
7331                            int num_changed_custom_elements)
7332 {
7333   int i, check = 0;
7334
7335   putFile16BitBE(file, num_changed_custom_elements);
7336
7337   for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
7338   {
7339     int element = EL_CUSTOM_START + i;
7340
7341     struct ElementInfo *ei = &element_info[element];
7342
7343     if (ei->properties[EP_BITFIELD_BASE_NR] != EP_BITMASK_DEFAULT)
7344     {
7345       if (check < num_changed_custom_elements)
7346       {
7347         putFile16BitBE(file, element);
7348         putFile32BitBE(file, ei->properties[EP_BITFIELD_BASE_NR]);
7349       }
7350
7351       check++;
7352     }
7353   }
7354
7355   if (check != num_changed_custom_elements)     // should not happen
7356     Warn("inconsistent number of custom element properties");
7357 }
7358 #endif
7359
7360 #if ENABLE_HISTORIC_CHUNKS
7361 static void SaveLevel_CUS2(FILE *file, struct LevelInfo *level,
7362                            int num_changed_custom_elements)
7363 {
7364   int i, check = 0;
7365
7366   putFile16BitBE(file, num_changed_custom_elements);
7367
7368   for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
7369   {
7370     int element = EL_CUSTOM_START + i;
7371
7372     if (element_info[element].change->target_element != EL_EMPTY_SPACE)
7373     {
7374       if (check < num_changed_custom_elements)
7375       {
7376         putFile16BitBE(file, element);
7377         putFile16BitBE(file, element_info[element].change->target_element);
7378       }
7379
7380       check++;
7381     }
7382   }
7383
7384   if (check != num_changed_custom_elements)     // should not happen
7385     Warn("inconsistent number of custom target elements");
7386 }
7387 #endif
7388
7389 #if ENABLE_HISTORIC_CHUNKS
7390 static void SaveLevel_CUS3(FILE *file, struct LevelInfo *level,
7391                            int num_changed_custom_elements)
7392 {
7393   int i, j, x, y, check = 0;
7394
7395   putFile16BitBE(file, num_changed_custom_elements);
7396
7397   for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
7398   {
7399     int element = EL_CUSTOM_START + i;
7400     struct ElementInfo *ei = &element_info[element];
7401
7402     if (ei->modified_settings)
7403     {
7404       if (check < num_changed_custom_elements)
7405       {
7406         putFile16BitBE(file, element);
7407
7408         for (j = 0; j < MAX_ELEMENT_NAME_LEN; j++)
7409           putFile8Bit(file, ei->description[j]);
7410
7411         putFile32BitBE(file, ei->properties[EP_BITFIELD_BASE_NR]);
7412
7413         // some free bytes for future properties and padding
7414         WriteUnusedBytesToFile(file, 7);
7415
7416         putFile8Bit(file, ei->use_gfx_element);
7417         putFile16BitBE(file, ei->gfx_element_initial);
7418
7419         putFile8Bit(file, ei->collect_score_initial);
7420         putFile8Bit(file, ei->collect_count_initial);
7421
7422         putFile16BitBE(file, ei->push_delay_fixed);
7423         putFile16BitBE(file, ei->push_delay_random);
7424         putFile16BitBE(file, ei->move_delay_fixed);
7425         putFile16BitBE(file, ei->move_delay_random);
7426
7427         putFile16BitBE(file, ei->move_pattern);
7428         putFile8Bit(file, ei->move_direction_initial);
7429         putFile8Bit(file, ei->move_stepsize);
7430
7431         for (y = 0; y < 3; y++)
7432           for (x = 0; x < 3; x++)
7433             putFile16BitBE(file, ei->content.e[x][y]);
7434
7435         putFile32BitBE(file, ei->change->events);
7436
7437         putFile16BitBE(file, ei->change->target_element);
7438
7439         putFile16BitBE(file, ei->change->delay_fixed);
7440         putFile16BitBE(file, ei->change->delay_random);
7441         putFile16BitBE(file, ei->change->delay_frames);
7442
7443         putFile16BitBE(file, ei->change->initial_trigger_element);
7444
7445         putFile8Bit(file, ei->change->explode);
7446         putFile8Bit(file, ei->change->use_target_content);
7447         putFile8Bit(file, ei->change->only_if_complete);
7448         putFile8Bit(file, ei->change->use_random_replace);
7449
7450         putFile8Bit(file, ei->change->random_percentage);
7451         putFile8Bit(file, ei->change->replace_when);
7452
7453         for (y = 0; y < 3; y++)
7454           for (x = 0; x < 3; x++)
7455             putFile16BitBE(file, ei->change->content.e[x][y]);
7456
7457         putFile8Bit(file, ei->slippery_type);
7458
7459         // some free bytes for future properties and padding
7460         WriteUnusedBytesToFile(file, LEVEL_CPART_CUS3_UNUSED);
7461       }
7462
7463       check++;
7464     }
7465   }
7466
7467   if (check != num_changed_custom_elements)     // should not happen
7468     Warn("inconsistent number of custom element properties");
7469 }
7470 #endif
7471
7472 #if ENABLE_HISTORIC_CHUNKS
7473 static void SaveLevel_CUS4(FILE *file, struct LevelInfo *level, int element)
7474 {
7475   struct ElementInfo *ei = &element_info[element];
7476   int i, j, x, y;
7477
7478   // ---------- custom element base property values (96 bytes) ----------------
7479
7480   putFile16BitBE(file, element);
7481
7482   for (i = 0; i < MAX_ELEMENT_NAME_LEN; i++)
7483     putFile8Bit(file, ei->description[i]);
7484
7485   putFile32BitBE(file, ei->properties[EP_BITFIELD_BASE_NR]);
7486
7487   WriteUnusedBytesToFile(file, 4);      // reserved for more base properties
7488
7489   putFile8Bit(file, ei->num_change_pages);
7490
7491   putFile16BitBE(file, ei->ce_value_fixed_initial);
7492   putFile16BitBE(file, ei->ce_value_random_initial);
7493   putFile8Bit(file, ei->use_last_ce_value);
7494
7495   putFile8Bit(file, ei->use_gfx_element);
7496   putFile16BitBE(file, ei->gfx_element_initial);
7497
7498   putFile8Bit(file, ei->collect_score_initial);
7499   putFile8Bit(file, ei->collect_count_initial);
7500
7501   putFile8Bit(file, ei->drop_delay_fixed);
7502   putFile8Bit(file, ei->push_delay_fixed);
7503   putFile8Bit(file, ei->drop_delay_random);
7504   putFile8Bit(file, ei->push_delay_random);
7505   putFile16BitBE(file, ei->move_delay_fixed);
7506   putFile16BitBE(file, ei->move_delay_random);
7507
7508   // bits 0 - 15 of "move_pattern" ...
7509   putFile16BitBE(file, ei->move_pattern & 0xffff);
7510   putFile8Bit(file, ei->move_direction_initial);
7511   putFile8Bit(file, ei->move_stepsize);
7512
7513   putFile8Bit(file, ei->slippery_type);
7514
7515   for (y = 0; y < 3; y++)
7516     for (x = 0; x < 3; x++)
7517       putFile16BitBE(file, ei->content.e[x][y]);
7518
7519   putFile16BitBE(file, ei->move_enter_element);
7520   putFile16BitBE(file, ei->move_leave_element);
7521   putFile8Bit(file, ei->move_leave_type);
7522
7523   // ... bits 16 - 31 of "move_pattern" (not nice, but downward compatible)
7524   putFile16BitBE(file, (ei->move_pattern >> 16) & 0xffff);
7525
7526   putFile8Bit(file, ei->access_direction);
7527
7528   putFile8Bit(file, ei->explosion_delay);
7529   putFile8Bit(file, ei->ignition_delay);
7530   putFile8Bit(file, ei->explosion_type);
7531
7532   // some free bytes for future custom property values and padding
7533   WriteUnusedBytesToFile(file, 1);
7534
7535   // ---------- change page property values (48 bytes) ------------------------
7536
7537   for (i = 0; i < ei->num_change_pages; i++)
7538   {
7539     struct ElementChangeInfo *change = &ei->change_page[i];
7540     unsigned int event_bits;
7541
7542     // bits 0 - 31 of "has_event[]" ...
7543     event_bits = 0;
7544     for (j = 0; j < MIN(NUM_CHANGE_EVENTS, 32); j++)
7545       if (change->has_event[j])
7546         event_bits |= (1u << j);
7547     putFile32BitBE(file, event_bits);
7548
7549     putFile16BitBE(file, change->target_element);
7550
7551     putFile16BitBE(file, change->delay_fixed);
7552     putFile16BitBE(file, change->delay_random);
7553     putFile16BitBE(file, change->delay_frames);
7554
7555     putFile16BitBE(file, change->initial_trigger_element);
7556
7557     putFile8Bit(file, change->explode);
7558     putFile8Bit(file, change->use_target_content);
7559     putFile8Bit(file, change->only_if_complete);
7560     putFile8Bit(file, change->use_random_replace);
7561
7562     putFile8Bit(file, change->random_percentage);
7563     putFile8Bit(file, change->replace_when);
7564
7565     for (y = 0; y < 3; y++)
7566       for (x = 0; x < 3; x++)
7567         putFile16BitBE(file, change->target_content.e[x][y]);
7568
7569     putFile8Bit(file, change->can_change);
7570
7571     putFile8Bit(file, change->trigger_side);
7572
7573     putFile8Bit(file, change->trigger_player);
7574     putFile8Bit(file, (change->trigger_page == CH_PAGE_ANY ? CH_PAGE_ANY_FILE :
7575                        log_2(change->trigger_page)));
7576
7577     putFile8Bit(file, change->has_action);
7578     putFile8Bit(file, change->action_type);
7579     putFile8Bit(file, change->action_mode);
7580     putFile16BitBE(file, change->action_arg);
7581
7582     // ... bits 32 - 39 of "has_event[]" (not nice, but downward compatible)
7583     event_bits = 0;
7584     for (j = 32; j < NUM_CHANGE_EVENTS; j++)
7585       if (change->has_event[j])
7586         event_bits |= (1u << (j - 32));
7587     putFile8Bit(file, event_bits);
7588   }
7589 }
7590 #endif
7591
7592 #if ENABLE_HISTORIC_CHUNKS
7593 static void SaveLevel_GRP1(FILE *file, struct LevelInfo *level, int element)
7594 {
7595   struct ElementInfo *ei = &element_info[element];
7596   struct ElementGroupInfo *group = ei->group;
7597   int i;
7598
7599   putFile16BitBE(file, element);
7600
7601   for (i = 0; i < MAX_ELEMENT_NAME_LEN; i++)
7602     putFile8Bit(file, ei->description[i]);
7603
7604   putFile8Bit(file, group->num_elements);
7605
7606   putFile8Bit(file, ei->use_gfx_element);
7607   putFile16BitBE(file, ei->gfx_element_initial);
7608
7609   putFile8Bit(file, group->choice_mode);
7610
7611   // some free bytes for future values and padding
7612   WriteUnusedBytesToFile(file, 3);
7613
7614   for (i = 0; i < MAX_ELEMENTS_IN_GROUP; i++)
7615     putFile16BitBE(file, group->element[i]);
7616 }
7617 #endif
7618
7619 static int SaveLevel_MicroChunk(FILE *file, struct LevelFileConfigInfo *entry,
7620                                 boolean write_element)
7621 {
7622   int save_type = entry->save_type;
7623   int data_type = entry->data_type;
7624   int conf_type = entry->conf_type;
7625   int byte_mask = conf_type & CONF_MASK_BYTES;
7626   int element = entry->element;
7627   int default_value = entry->default_value;
7628   int num_bytes = 0;
7629   boolean modified = FALSE;
7630
7631   if (byte_mask != CONF_MASK_MULTI_BYTES)
7632   {
7633     void *value_ptr = entry->value;
7634     int value = (data_type == TYPE_BOOLEAN ? *(boolean *)value_ptr :
7635                  *(int *)value_ptr);
7636
7637     // check if any settings have been modified before saving them
7638     if (value != default_value)
7639       modified = TRUE;
7640
7641     // do not save if explicitly told or if unmodified default settings
7642     if ((save_type == SAVE_CONF_NEVER) ||
7643         (save_type == SAVE_CONF_WHEN_CHANGED && !modified))
7644       return 0;
7645
7646     if (write_element)
7647       num_bytes += putFile16BitBE(file, element);
7648
7649     num_bytes += putFile8Bit(file, conf_type);
7650     num_bytes += (byte_mask == CONF_MASK_1_BYTE ? putFile8Bit   (file, value) :
7651                   byte_mask == CONF_MASK_2_BYTE ? putFile16BitBE(file, value) :
7652                   byte_mask == CONF_MASK_4_BYTE ? putFile32BitBE(file, value) :
7653                   0);
7654   }
7655   else if (data_type == TYPE_STRING)
7656   {
7657     char *default_string = entry->default_string;
7658     char *string = (char *)(entry->value);
7659     int string_length = strlen(string);
7660     int i;
7661
7662     // check if any settings have been modified before saving them
7663     if (!strEqual(string, default_string))
7664       modified = TRUE;
7665
7666     // do not save if explicitly told or if unmodified default settings
7667     if ((save_type == SAVE_CONF_NEVER) ||
7668         (save_type == SAVE_CONF_WHEN_CHANGED && !modified))
7669       return 0;
7670
7671     if (write_element)
7672       num_bytes += putFile16BitBE(file, element);
7673
7674     num_bytes += putFile8Bit(file, conf_type);
7675     num_bytes += putFile16BitBE(file, string_length);
7676
7677     for (i = 0; i < string_length; i++)
7678       num_bytes += putFile8Bit(file, string[i]);
7679   }
7680   else if (data_type == TYPE_ELEMENT_LIST)
7681   {
7682     int *element_array = (int *)(entry->value);
7683     int num_elements = *(int *)(entry->num_entities);
7684     int i;
7685
7686     // check if any settings have been modified before saving them
7687     for (i = 0; i < num_elements; i++)
7688       if (element_array[i] != default_value)
7689         modified = TRUE;
7690
7691     // do not save if explicitly told or if unmodified default settings
7692     if ((save_type == SAVE_CONF_NEVER) ||
7693         (save_type == SAVE_CONF_WHEN_CHANGED && !modified))
7694       return 0;
7695
7696     if (write_element)
7697       num_bytes += putFile16BitBE(file, element);
7698
7699     num_bytes += putFile8Bit(file, conf_type);
7700     num_bytes += putFile16BitBE(file, num_elements * CONF_ELEMENT_NUM_BYTES);
7701
7702     for (i = 0; i < num_elements; i++)
7703       num_bytes += putFile16BitBE(file, element_array[i]);
7704   }
7705   else if (data_type == TYPE_CONTENT_LIST)
7706   {
7707     struct Content *content = (struct Content *)(entry->value);
7708     int num_contents = *(int *)(entry->num_entities);
7709     int i, x, y;
7710
7711     // check if any settings have been modified before saving them
7712     for (i = 0; i < num_contents; i++)
7713       for (y = 0; y < 3; y++)
7714         for (x = 0; x < 3; x++)
7715           if (content[i].e[x][y] != default_value)
7716             modified = TRUE;
7717
7718     // do not save if explicitly told or if unmodified default settings
7719     if ((save_type == SAVE_CONF_NEVER) ||
7720         (save_type == SAVE_CONF_WHEN_CHANGED && !modified))
7721       return 0;
7722
7723     if (write_element)
7724       num_bytes += putFile16BitBE(file, element);
7725
7726     num_bytes += putFile8Bit(file, conf_type);
7727     num_bytes += putFile16BitBE(file, num_contents * CONF_CONTENT_NUM_BYTES);
7728
7729     for (i = 0; i < num_contents; i++)
7730       for (y = 0; y < 3; y++)
7731         for (x = 0; x < 3; x++)
7732           num_bytes += putFile16BitBE(file, content[i].e[x][y]);
7733   }
7734
7735   return num_bytes;
7736 }
7737
7738 static int SaveLevel_INFO(FILE *file, struct LevelInfo *level)
7739 {
7740   int chunk_size = 0;
7741   int i;
7742
7743   li = *level;          // copy level data into temporary buffer
7744
7745   for (i = 0; chunk_config_INFO[i].data_type != -1; i++)
7746     chunk_size += SaveLevel_MicroChunk(file, &chunk_config_INFO[i], FALSE);
7747
7748   return chunk_size;
7749 }
7750
7751 static int SaveLevel_ELEM(FILE *file, struct LevelInfo *level)
7752 {
7753   int chunk_size = 0;
7754   int i;
7755
7756   li = *level;          // copy level data into temporary buffer
7757
7758   for (i = 0; chunk_config_ELEM[i].data_type != -1; i++)
7759     chunk_size += SaveLevel_MicroChunk(file, &chunk_config_ELEM[i], TRUE);
7760
7761   return chunk_size;
7762 }
7763
7764 static int SaveLevel_NOTE(FILE *file, struct LevelInfo *level, int element)
7765 {
7766   int envelope_nr = element - EL_ENVELOPE_1;
7767   int chunk_size = 0;
7768   int i;
7769
7770   chunk_size += putFile16BitBE(file, element);
7771
7772   // copy envelope data into temporary buffer
7773   xx_envelope = level->envelope[envelope_nr];
7774
7775   for (i = 0; chunk_config_NOTE[i].data_type != -1; i++)
7776     chunk_size += SaveLevel_MicroChunk(file, &chunk_config_NOTE[i], FALSE);
7777
7778   return chunk_size;
7779 }
7780
7781 static int SaveLevel_CUSX(FILE *file, struct LevelInfo *level, int element)
7782 {
7783   struct ElementInfo *ei = &element_info[element];
7784   int chunk_size = 0;
7785   int i, j;
7786
7787   chunk_size += putFile16BitBE(file, element);
7788
7789   xx_ei = *ei;          // copy element data into temporary buffer
7790
7791   // set default description string for this specific element
7792   strcpy(xx_default_description, getDefaultElementDescription(ei));
7793
7794   for (i = 0; chunk_config_CUSX_base[i].data_type != -1; i++)
7795     chunk_size += SaveLevel_MicroChunk(file, &chunk_config_CUSX_base[i], FALSE);
7796
7797   for (i = 0; i < ei->num_change_pages; i++)
7798   {
7799     struct ElementChangeInfo *change = &ei->change_page[i];
7800
7801     xx_current_change_page = i;
7802
7803     xx_change = *change;        // copy change data into temporary buffer
7804
7805     resetEventBits();
7806     setEventBitsFromEventFlags(change);
7807
7808     for (j = 0; chunk_config_CUSX_change[j].data_type != -1; j++)
7809       chunk_size += SaveLevel_MicroChunk(file, &chunk_config_CUSX_change[j],
7810                                          FALSE);
7811   }
7812
7813   return chunk_size;
7814 }
7815
7816 static int SaveLevel_GRPX(FILE *file, struct LevelInfo *level, int element)
7817 {
7818   struct ElementInfo *ei = &element_info[element];
7819   struct ElementGroupInfo *group = ei->group;
7820   int chunk_size = 0;
7821   int i;
7822
7823   chunk_size += putFile16BitBE(file, element);
7824
7825   xx_ei = *ei;          // copy element data into temporary buffer
7826   xx_group = *group;    // copy group data into temporary buffer
7827
7828   // set default description string for this specific element
7829   strcpy(xx_default_description, getDefaultElementDescription(ei));
7830
7831   for (i = 0; chunk_config_GRPX[i].data_type != -1; i++)
7832     chunk_size += SaveLevel_MicroChunk(file, &chunk_config_GRPX[i], FALSE);
7833
7834   return chunk_size;
7835 }
7836
7837 static int SaveLevel_EMPX(FILE *file, struct LevelInfo *level, int element)
7838 {
7839   struct ElementInfo *ei = &element_info[element];
7840   int chunk_size = 0;
7841   int i;
7842
7843   chunk_size += putFile16BitBE(file, element);
7844
7845   xx_ei = *ei;          // copy element data into temporary buffer
7846
7847   for (i = 0; chunk_config_EMPX[i].data_type != -1; i++)
7848     chunk_size += SaveLevel_MicroChunk(file, &chunk_config_EMPX[i], FALSE);
7849
7850   return chunk_size;
7851 }
7852
7853 static void SaveLevelFromFilename(struct LevelInfo *level, char *filename,
7854                                   boolean save_as_template)
7855 {
7856   int chunk_size;
7857   int i;
7858   FILE *file;
7859
7860   if (!(file = fopen(filename, MODE_WRITE)))
7861   {
7862     Warn("cannot save level file '%s'", filename);
7863
7864     return;
7865   }
7866
7867   level->file_version = FILE_VERSION_ACTUAL;
7868   level->game_version = GAME_VERSION_ACTUAL;
7869
7870   level->creation_date = getCurrentDate();
7871
7872   putFileChunkBE(file, "RND1", CHUNK_SIZE_UNDEFINED);
7873   putFileChunkBE(file, "CAVE", CHUNK_SIZE_NONE);
7874
7875   chunk_size = SaveLevel_VERS(NULL, level);
7876   putFileChunkBE(file, "VERS", chunk_size);
7877   SaveLevel_VERS(file, level);
7878
7879   chunk_size = SaveLevel_DATE(NULL, level);
7880   putFileChunkBE(file, "DATE", chunk_size);
7881   SaveLevel_DATE(file, level);
7882
7883   chunk_size = SaveLevel_NAME(NULL, level);
7884   putFileChunkBE(file, "NAME", chunk_size);
7885   SaveLevel_NAME(file, level);
7886
7887   chunk_size = SaveLevel_AUTH(NULL, level);
7888   putFileChunkBE(file, "AUTH", chunk_size);
7889   SaveLevel_AUTH(file, level);
7890
7891   chunk_size = SaveLevel_INFO(NULL, level);
7892   putFileChunkBE(file, "INFO", chunk_size);
7893   SaveLevel_INFO(file, level);
7894
7895   chunk_size = SaveLevel_BODY(NULL, level);
7896   putFileChunkBE(file, "BODY", chunk_size);
7897   SaveLevel_BODY(file, level);
7898
7899   chunk_size = SaveLevel_ELEM(NULL, level);
7900   if (chunk_size > LEVEL_CHUNK_ELEM_UNCHANGED)          // save if changed
7901   {
7902     putFileChunkBE(file, "ELEM", chunk_size);
7903     SaveLevel_ELEM(file, level);
7904   }
7905
7906   for (i = 0; i < NUM_ENVELOPES; i++)
7907   {
7908     int element = EL_ENVELOPE_1 + i;
7909
7910     chunk_size = SaveLevel_NOTE(NULL, level, element);
7911     if (chunk_size > LEVEL_CHUNK_NOTE_UNCHANGED)        // save if changed
7912     {
7913       putFileChunkBE(file, "NOTE", chunk_size);
7914       SaveLevel_NOTE(file, level, element);
7915     }
7916   }
7917
7918   // if not using template level, check for non-default custom/group elements
7919   if (!level->use_custom_template || save_as_template)
7920   {
7921     for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
7922     {
7923       int element = EL_CUSTOM_START + i;
7924
7925       chunk_size = SaveLevel_CUSX(NULL, level, element);
7926       if (chunk_size > LEVEL_CHUNK_CUSX_UNCHANGED)      // save if changed
7927       {
7928         putFileChunkBE(file, "CUSX", chunk_size);
7929         SaveLevel_CUSX(file, level, element);
7930       }
7931     }
7932
7933     for (i = 0; i < NUM_GROUP_ELEMENTS; i++)
7934     {
7935       int element = EL_GROUP_START + i;
7936
7937       chunk_size = SaveLevel_GRPX(NULL, level, element);
7938       if (chunk_size > LEVEL_CHUNK_GRPX_UNCHANGED)      // save if changed
7939       {
7940         putFileChunkBE(file, "GRPX", chunk_size);
7941         SaveLevel_GRPX(file, level, element);
7942       }
7943     }
7944
7945     for (i = 0; i < NUM_EMPTY_ELEMENTS_ALL; i++)
7946     {
7947       int element = GET_EMPTY_ELEMENT(i);
7948
7949       chunk_size = SaveLevel_EMPX(NULL, level, element);
7950       if (chunk_size > LEVEL_CHUNK_EMPX_UNCHANGED)      // save if changed
7951       {
7952         putFileChunkBE(file, "EMPX", chunk_size);
7953         SaveLevel_EMPX(file, level, element);
7954       }
7955     }
7956   }
7957
7958   fclose(file);
7959
7960   SetFilePermissions(filename, PERMS_PRIVATE);
7961 }
7962
7963 void SaveLevel(int nr)
7964 {
7965   char *filename = getDefaultLevelFilename(nr);
7966
7967   SaveLevelFromFilename(&level, filename, FALSE);
7968 }
7969
7970 void SaveLevelTemplate(void)
7971 {
7972   char *filename = getLocalLevelTemplateFilename();
7973
7974   SaveLevelFromFilename(&level, filename, TRUE);
7975 }
7976
7977 boolean SaveLevelChecked(int nr)
7978 {
7979   char *filename = getDefaultLevelFilename(nr);
7980   boolean new_level = !fileExists(filename);
7981   boolean level_saved = FALSE;
7982
7983   if (new_level || Request("Save this level and kill the old?", REQ_ASK))
7984   {
7985     SaveLevel(nr);
7986
7987     if (new_level)
7988       Request("Level saved!", REQ_CONFIRM);
7989
7990     level_saved = TRUE;
7991   }
7992
7993   return level_saved;
7994 }
7995
7996 void DumpLevel(struct LevelInfo *level)
7997 {
7998   if (level->no_level_file || level->no_valid_file)
7999   {
8000     Warn("cannot dump -- no valid level file found");
8001
8002     return;
8003   }
8004
8005   PrintLine("-", 79);
8006   Print("Level xxx (file version %08d, game version %08d)\n",
8007         level->file_version, level->game_version);
8008   PrintLine("-", 79);
8009
8010   Print("Level author: '%s'\n", level->author);
8011   Print("Level title:  '%s'\n", level->name);
8012   Print("\n");
8013   Print("Playfield size: %d x %d\n", level->fieldx, level->fieldy);
8014   Print("\n");
8015   Print("Level time:  %d seconds\n", level->time);
8016   Print("Gems needed: %d\n", level->gems_needed);
8017   Print("\n");
8018   Print("Time for magic wall: %d seconds\n", level->time_magic_wall);
8019   Print("Time for wheel:      %d seconds\n", level->time_wheel);
8020   Print("Time for light:      %d seconds\n", level->time_light);
8021   Print("Time for timegate:   %d seconds\n", level->time_timegate);
8022   Print("\n");
8023   Print("Amoeba speed: %d\n", level->amoeba_speed);
8024   Print("\n");
8025
8026   Print("EM style slippery gems:      %s\n", (level->em_slippery_gems ? "yes" : "no"));
8027   Print("Player blocks last field:    %s\n", (level->block_last_field ? "yes" : "no"));
8028   Print("SP player blocks last field: %s\n", (level->sp_block_last_field ? "yes" : "no"));
8029   Print("use spring bug: %s\n", (level->use_spring_bug ? "yes" : "no"));
8030   Print("use step counter: %s\n", (level->use_step_counter ? "yes" : "no"));
8031   Print("rate time over score: %s\n", (level->rate_time_over_score ? "yes" : "no"));
8032
8033   if (options.debug)
8034   {
8035     int i, j;
8036
8037     for (i = 0; i < NUM_ENVELOPES; i++)
8038     {
8039       char *text = level->envelope[i].text;
8040       int text_len = strlen(text);
8041       boolean has_text = FALSE;
8042
8043       for (j = 0; j < text_len; j++)
8044         if (text[j] != ' ' && text[j] != '\n')
8045           has_text = TRUE;
8046
8047       if (has_text)
8048       {
8049         Print("\n");
8050         Print("Envelope %d:\n'%s'\n", i + 1, text);
8051       }
8052     }
8053   }
8054
8055   PrintLine("-", 79);
8056 }
8057
8058 void DumpLevels(void)
8059 {
8060   static LevelDirTree *dumplevel_leveldir = NULL;
8061
8062   dumplevel_leveldir = getTreeInfoFromIdentifier(leveldir_first,
8063                                                  global.dumplevel_leveldir);
8064
8065   if (dumplevel_leveldir == NULL)
8066     Fail("no such level identifier: '%s'", global.dumplevel_leveldir);
8067
8068   if (global.dumplevel_level_nr < dumplevel_leveldir->first_level ||
8069       global.dumplevel_level_nr > dumplevel_leveldir->last_level)
8070     Fail("no such level number: %d", global.dumplevel_level_nr);
8071
8072   leveldir_current = dumplevel_leveldir;
8073
8074   LoadLevel(global.dumplevel_level_nr);
8075   DumpLevel(&level);
8076
8077   CloseAllAndExit(0);
8078 }
8079
8080
8081 // ============================================================================
8082 // tape file functions
8083 // ============================================================================
8084
8085 static void setTapeInfoToDefaults(void)
8086 {
8087   int i;
8088
8089   // always start with reliable default values (empty tape)
8090   TapeErase();
8091
8092   // default values (also for pre-1.2 tapes) with only the first player
8093   tape.player_participates[0] = TRUE;
8094   for (i = 1; i < MAX_PLAYERS; i++)
8095     tape.player_participates[i] = FALSE;
8096
8097   // at least one (default: the first) player participates in every tape
8098   tape.num_participating_players = 1;
8099
8100   tape.property_bits = TAPE_PROPERTY_NONE;
8101
8102   tape.level_nr = level_nr;
8103   tape.counter = 0;
8104   tape.changed = FALSE;
8105   tape.solved = FALSE;
8106
8107   tape.recording = FALSE;
8108   tape.playing = FALSE;
8109   tape.pausing = FALSE;
8110
8111   tape.scr_fieldx = SCR_FIELDX_DEFAULT;
8112   tape.scr_fieldy = SCR_FIELDY_DEFAULT;
8113
8114   tape.no_info_chunk = TRUE;
8115   tape.no_valid_file = FALSE;
8116 }
8117
8118 static int getTapePosSize(struct TapeInfo *tape)
8119 {
8120   int tape_pos_size = 0;
8121
8122   if (tape->use_key_actions)
8123     tape_pos_size += tape->num_participating_players;
8124
8125   if (tape->use_mouse_actions)
8126     tape_pos_size += 3;         // x and y position and mouse button mask
8127
8128   tape_pos_size += 1;           // tape action delay value
8129
8130   return tape_pos_size;
8131 }
8132
8133 static void setTapeActionFlags(struct TapeInfo *tape, int value)
8134 {
8135   tape->use_key_actions = FALSE;
8136   tape->use_mouse_actions = FALSE;
8137
8138   if (value != TAPE_USE_MOUSE_ACTIONS_ONLY)
8139     tape->use_key_actions = TRUE;
8140
8141   if (value != TAPE_USE_KEY_ACTIONS_ONLY)
8142     tape->use_mouse_actions = TRUE;
8143 }
8144
8145 static int getTapeActionValue(struct TapeInfo *tape)
8146 {
8147   return (tape->use_key_actions &&
8148           tape->use_mouse_actions ? TAPE_USE_KEY_AND_MOUSE_ACTIONS :
8149           tape->use_key_actions   ? TAPE_USE_KEY_ACTIONS_ONLY :
8150           tape->use_mouse_actions ? TAPE_USE_MOUSE_ACTIONS_ONLY :
8151           TAPE_ACTIONS_DEFAULT);
8152 }
8153
8154 static int LoadTape_VERS(File *file, int chunk_size, struct TapeInfo *tape)
8155 {
8156   tape->file_version = getFileVersion(file);
8157   tape->game_version = getFileVersion(file);
8158
8159   return chunk_size;
8160 }
8161
8162 static int LoadTape_HEAD(File *file, int chunk_size, struct TapeInfo *tape)
8163 {
8164   int i;
8165
8166   tape->random_seed = getFile32BitBE(file);
8167   tape->date        = getFile32BitBE(file);
8168   tape->length      = getFile32BitBE(file);
8169
8170   // read header fields that are new since version 1.2
8171   if (tape->file_version >= FILE_VERSION_1_2)
8172   {
8173     byte store_participating_players = getFile8Bit(file);
8174     int engine_version;
8175
8176     // since version 1.2, tapes store which players participate in the tape
8177     tape->num_participating_players = 0;
8178     for (i = 0; i < MAX_PLAYERS; i++)
8179     {
8180       tape->player_participates[i] = FALSE;
8181
8182       if (store_participating_players & (1 << i))
8183       {
8184         tape->player_participates[i] = TRUE;
8185         tape->num_participating_players++;
8186       }
8187     }
8188
8189     setTapeActionFlags(tape, getFile8Bit(file));
8190
8191     tape->property_bits = getFile8Bit(file);
8192     tape->solved = getFile8Bit(file);
8193
8194     engine_version = getFileVersion(file);
8195     if (engine_version > 0)
8196       tape->engine_version = engine_version;
8197     else
8198       tape->engine_version = tape->game_version;
8199   }
8200
8201   return chunk_size;
8202 }
8203
8204 static int LoadTape_SCRN(File *file, int chunk_size, struct TapeInfo *tape)
8205 {
8206   tape->scr_fieldx = getFile8Bit(file);
8207   tape->scr_fieldy = getFile8Bit(file);
8208
8209   return chunk_size;
8210 }
8211
8212 static int LoadTape_INFO(File *file, int chunk_size, struct TapeInfo *tape)
8213 {
8214   char *level_identifier = NULL;
8215   int level_identifier_size;
8216   int i;
8217
8218   tape->no_info_chunk = FALSE;
8219
8220   level_identifier_size = getFile16BitBE(file);
8221
8222   level_identifier = checked_malloc(level_identifier_size);
8223
8224   for (i = 0; i < level_identifier_size; i++)
8225     level_identifier[i] = getFile8Bit(file);
8226
8227   strncpy(tape->level_identifier, level_identifier, MAX_FILENAME_LEN);
8228   tape->level_identifier[MAX_FILENAME_LEN] = '\0';
8229
8230   checked_free(level_identifier);
8231
8232   tape->level_nr = getFile16BitBE(file);
8233
8234   chunk_size = 2 + level_identifier_size + 2;
8235
8236   return chunk_size;
8237 }
8238
8239 static int LoadTape_BODY(File *file, int chunk_size, struct TapeInfo *tape)
8240 {
8241   int i, j;
8242   int tape_pos_size = getTapePosSize(tape);
8243   int chunk_size_expected = tape_pos_size * tape->length;
8244
8245   if (chunk_size_expected != chunk_size)
8246   {
8247     ReadUnusedBytesFromFile(file, chunk_size);
8248     return chunk_size_expected;
8249   }
8250
8251   for (i = 0; i < tape->length; i++)
8252   {
8253     if (i >= MAX_TAPE_LEN)
8254     {
8255       Warn("tape truncated -- size exceeds maximum tape size %d",
8256             MAX_TAPE_LEN);
8257
8258       // tape too large; read and ignore remaining tape data from this chunk
8259       for (;i < tape->length; i++)
8260         ReadUnusedBytesFromFile(file, tape_pos_size);
8261
8262       break;
8263     }
8264
8265     if (tape->use_key_actions)
8266     {
8267       for (j = 0; j < MAX_PLAYERS; j++)
8268       {
8269         tape->pos[i].action[j] = MV_NONE;
8270
8271         if (tape->player_participates[j])
8272           tape->pos[i].action[j] = getFile8Bit(file);
8273       }
8274     }
8275
8276     if (tape->use_mouse_actions)
8277     {
8278       tape->pos[i].action[TAPE_ACTION_LX]     = getFile8Bit(file);
8279       tape->pos[i].action[TAPE_ACTION_LY]     = getFile8Bit(file);
8280       tape->pos[i].action[TAPE_ACTION_BUTTON] = getFile8Bit(file);
8281     }
8282
8283     tape->pos[i].delay = getFile8Bit(file);
8284
8285     if (tape->file_version == FILE_VERSION_1_0)
8286     {
8287       // eliminate possible diagonal moves in old tapes
8288       // this is only for backward compatibility
8289
8290       byte joy_dir[4] = { JOY_LEFT, JOY_RIGHT, JOY_UP, JOY_DOWN };
8291       byte action = tape->pos[i].action[0];
8292       int k, num_moves = 0;
8293
8294       for (k = 0; k < 4; k++)
8295       {
8296         if (action & joy_dir[k])
8297         {
8298           tape->pos[i + num_moves].action[0] = joy_dir[k];
8299           if (num_moves > 0)
8300             tape->pos[i + num_moves].delay = 0;
8301           num_moves++;
8302         }
8303       }
8304
8305       if (num_moves > 1)
8306       {
8307         num_moves--;
8308         i += num_moves;
8309         tape->length += num_moves;
8310       }
8311     }
8312     else if (tape->file_version < FILE_VERSION_2_0)
8313     {
8314       // convert pre-2.0 tapes to new tape format
8315
8316       if (tape->pos[i].delay > 1)
8317       {
8318         // action part
8319         tape->pos[i + 1] = tape->pos[i];
8320         tape->pos[i + 1].delay = 1;
8321
8322         // delay part
8323         for (j = 0; j < MAX_PLAYERS; j++)
8324           tape->pos[i].action[j] = MV_NONE;
8325         tape->pos[i].delay--;
8326
8327         i++;
8328         tape->length++;
8329       }
8330     }
8331
8332     if (checkEndOfFile(file))
8333       break;
8334   }
8335
8336   if (i != tape->length)
8337     chunk_size = tape_pos_size * i;
8338
8339   return chunk_size;
8340 }
8341
8342 static void LoadTape_SokobanSolution(char *filename)
8343 {
8344   File *file;
8345   int move_delay = TILESIZE / level.initial_player_stepsize[0];
8346
8347   if (!(file = openFile(filename, MODE_READ)))
8348   {
8349     tape.no_valid_file = TRUE;
8350
8351     return;
8352   }
8353
8354   while (!checkEndOfFile(file))
8355   {
8356     unsigned char c = getByteFromFile(file);
8357
8358     if (checkEndOfFile(file))
8359       break;
8360
8361     switch (c)
8362     {
8363       case 'u':
8364       case 'U':
8365         tape.pos[tape.length].action[0] = MV_UP;
8366         tape.pos[tape.length].delay = move_delay + (c < 'a' ? 2 : 0);
8367         tape.length++;
8368         break;
8369
8370       case 'd':
8371       case 'D':
8372         tape.pos[tape.length].action[0] = MV_DOWN;
8373         tape.pos[tape.length].delay = move_delay + (c < 'a' ? 2 : 0);
8374         tape.length++;
8375         break;
8376
8377       case 'l':
8378       case 'L':
8379         tape.pos[tape.length].action[0] = MV_LEFT;
8380         tape.pos[tape.length].delay = move_delay + (c < 'a' ? 2 : 0);
8381         tape.length++;
8382         break;
8383
8384       case 'r':
8385       case 'R':
8386         tape.pos[tape.length].action[0] = MV_RIGHT;
8387         tape.pos[tape.length].delay = move_delay + (c < 'a' ? 2 : 0);
8388         tape.length++;
8389         break;
8390
8391       case '\n':
8392       case '\r':
8393       case '\t':
8394       case ' ':
8395         // ignore white-space characters
8396         break;
8397
8398       default:
8399         tape.no_valid_file = TRUE;
8400
8401         Warn("unsupported Sokoban solution file '%s' ['%d']", filename, c);
8402
8403         break;
8404     }
8405   }
8406
8407   closeFile(file);
8408
8409   if (tape.no_valid_file)
8410     return;
8411
8412   tape.length_frames  = GetTapeLengthFrames();
8413   tape.length_seconds = GetTapeLengthSeconds();
8414 }
8415
8416 void LoadTapeFromFilename(char *filename)
8417 {
8418   char cookie[MAX_LINE_LEN];
8419   char chunk_name[CHUNK_ID_LEN + 1];
8420   File *file;
8421   int chunk_size;
8422
8423   // always start with reliable default values
8424   setTapeInfoToDefaults();
8425
8426   if (strSuffix(filename, ".sln"))
8427   {
8428     LoadTape_SokobanSolution(filename);
8429
8430     return;
8431   }
8432
8433   if (!(file = openFile(filename, MODE_READ)))
8434   {
8435     tape.no_valid_file = TRUE;
8436
8437     return;
8438   }
8439
8440   getFileChunkBE(file, chunk_name, NULL);
8441   if (strEqual(chunk_name, "RND1"))
8442   {
8443     getFile32BitBE(file);               // not used
8444
8445     getFileChunkBE(file, chunk_name, NULL);
8446     if (!strEqual(chunk_name, "TAPE"))
8447     {
8448       tape.no_valid_file = TRUE;
8449
8450       Warn("unknown format of tape file '%s'", filename);
8451
8452       closeFile(file);
8453
8454       return;
8455     }
8456   }
8457   else  // check for pre-2.0 file format with cookie string
8458   {
8459     strcpy(cookie, chunk_name);
8460     if (getStringFromFile(file, &cookie[4], MAX_LINE_LEN - 4) == NULL)
8461       cookie[4] = '\0';
8462     if (strlen(cookie) > 0 && cookie[strlen(cookie) - 1] == '\n')
8463       cookie[strlen(cookie) - 1] = '\0';
8464
8465     if (!checkCookieString(cookie, TAPE_COOKIE_TMPL))
8466     {
8467       tape.no_valid_file = TRUE;
8468
8469       Warn("unknown format of tape file '%s'", filename);
8470
8471       closeFile(file);
8472
8473       return;
8474     }
8475
8476     if ((tape.file_version = getFileVersionFromCookieString(cookie)) == -1)
8477     {
8478       tape.no_valid_file = TRUE;
8479
8480       Warn("unsupported version of tape file '%s'", filename);
8481
8482       closeFile(file);
8483
8484       return;
8485     }
8486
8487     // pre-2.0 tape files have no game version, so use file version here
8488     tape.game_version = tape.file_version;
8489   }
8490
8491   if (tape.file_version < FILE_VERSION_1_2)
8492   {
8493     // tape files from versions before 1.2.0 without chunk structure
8494     LoadTape_HEAD(file, TAPE_CHUNK_HEAD_SIZE, &tape);
8495     LoadTape_BODY(file, 2 * tape.length,      &tape);
8496   }
8497   else
8498   {
8499     static struct
8500     {
8501       char *name;
8502       int size;
8503       int (*loader)(File *, int, struct TapeInfo *);
8504     }
8505     chunk_info[] =
8506     {
8507       { "VERS", TAPE_CHUNK_VERS_SIZE,   LoadTape_VERS },
8508       { "HEAD", TAPE_CHUNK_HEAD_SIZE,   LoadTape_HEAD },
8509       { "SCRN", TAPE_CHUNK_SCRN_SIZE,   LoadTape_SCRN },
8510       { "INFO", -1,                     LoadTape_INFO },
8511       { "BODY", -1,                     LoadTape_BODY },
8512       {  NULL,  0,                      NULL }
8513     };
8514
8515     while (getFileChunkBE(file, chunk_name, &chunk_size))
8516     {
8517       int i = 0;
8518
8519       while (chunk_info[i].name != NULL &&
8520              !strEqual(chunk_name, chunk_info[i].name))
8521         i++;
8522
8523       if (chunk_info[i].name == NULL)
8524       {
8525         Warn("unknown chunk '%s' in tape file '%s'",
8526               chunk_name, filename);
8527
8528         ReadUnusedBytesFromFile(file, chunk_size);
8529       }
8530       else if (chunk_info[i].size != -1 &&
8531                chunk_info[i].size != chunk_size)
8532       {
8533         Warn("wrong size (%d) of chunk '%s' in tape file '%s'",
8534               chunk_size, chunk_name, filename);
8535
8536         ReadUnusedBytesFromFile(file, chunk_size);
8537       }
8538       else
8539       {
8540         // call function to load this tape chunk
8541         int chunk_size_expected =
8542           (chunk_info[i].loader)(file, chunk_size, &tape);
8543
8544         // the size of some chunks cannot be checked before reading other
8545         // chunks first (like "HEAD" and "BODY") that contain some header
8546         // information, so check them here
8547         if (chunk_size_expected != chunk_size)
8548         {
8549           Warn("wrong size (%d) of chunk '%s' in tape file '%s'",
8550                 chunk_size, chunk_name, filename);
8551         }
8552       }
8553     }
8554   }
8555
8556   closeFile(file);
8557
8558   tape.length_frames  = GetTapeLengthFrames();
8559   tape.length_seconds = GetTapeLengthSeconds();
8560
8561 #if 0
8562   Debug("files:LoadTapeFromFilename", "tape file version: %d",
8563         tape.file_version);
8564   Debug("files:LoadTapeFromFilename", "tape game version: %d",
8565         tape.game_version);
8566   Debug("files:LoadTapeFromFilename", "tape engine version: %d",
8567         tape.engine_version);
8568 #endif
8569 }
8570
8571 void LoadTape(int nr)
8572 {
8573   char *filename = getTapeFilename(nr);
8574
8575   LoadTapeFromFilename(filename);
8576 }
8577
8578 void LoadSolutionTape(int nr)
8579 {
8580   char *filename = getSolutionTapeFilename(nr);
8581
8582   LoadTapeFromFilename(filename);
8583
8584   if (TAPE_IS_EMPTY(tape))
8585   {
8586     if (level.game_engine_type == GAME_ENGINE_TYPE_BD &&
8587         level.native_bd_level->replay != NULL)
8588       CopyNativeTape_BD_to_RND(&level);
8589     else if (level.game_engine_type == GAME_ENGINE_TYPE_SP &&
8590         level.native_sp_level->demo.is_available)
8591       CopyNativeTape_SP_to_RND(&level);
8592   }
8593 }
8594
8595 void LoadScoreTape(char *score_tape_basename, int nr)
8596 {
8597   char *filename = getScoreTapeFilename(score_tape_basename, nr);
8598
8599   LoadTapeFromFilename(filename);
8600 }
8601
8602 void LoadScoreCacheTape(char *score_tape_basename, int nr)
8603 {
8604   char *filename = getScoreCacheTapeFilename(score_tape_basename, nr);
8605
8606   LoadTapeFromFilename(filename);
8607 }
8608
8609 static boolean checkSaveTape_SCRN(struct TapeInfo *tape)
8610 {
8611   // chunk required for team mode tapes with non-default screen size
8612   return (tape->num_participating_players > 1 &&
8613           (tape->scr_fieldx != SCR_FIELDX_DEFAULT ||
8614            tape->scr_fieldy != SCR_FIELDY_DEFAULT));
8615 }
8616
8617 static void SaveTape_VERS(FILE *file, struct TapeInfo *tape)
8618 {
8619   putFileVersion(file, tape->file_version);
8620   putFileVersion(file, tape->game_version);
8621 }
8622
8623 static void SaveTape_HEAD(FILE *file, struct TapeInfo *tape)
8624 {
8625   int i;
8626   byte store_participating_players = 0;
8627
8628   // set bits for participating players for compact storage
8629   for (i = 0; i < MAX_PLAYERS; i++)
8630     if (tape->player_participates[i])
8631       store_participating_players |= (1 << i);
8632
8633   putFile32BitBE(file, tape->random_seed);
8634   putFile32BitBE(file, tape->date);
8635   putFile32BitBE(file, tape->length);
8636
8637   putFile8Bit(file, store_participating_players);
8638
8639   putFile8Bit(file, getTapeActionValue(tape));
8640
8641   putFile8Bit(file, tape->property_bits);
8642   putFile8Bit(file, tape->solved);
8643
8644   putFileVersion(file, tape->engine_version);
8645 }
8646
8647 static void SaveTape_SCRN(FILE *file, struct TapeInfo *tape)
8648 {
8649   putFile8Bit(file, tape->scr_fieldx);
8650   putFile8Bit(file, tape->scr_fieldy);
8651 }
8652
8653 static void SaveTape_INFO(FILE *file, struct TapeInfo *tape)
8654 {
8655   int level_identifier_size = strlen(tape->level_identifier) + 1;
8656   int i;
8657
8658   putFile16BitBE(file, level_identifier_size);
8659
8660   for (i = 0; i < level_identifier_size; i++)
8661     putFile8Bit(file, tape->level_identifier[i]);
8662
8663   putFile16BitBE(file, tape->level_nr);
8664 }
8665
8666 static void SaveTape_BODY(FILE *file, struct TapeInfo *tape)
8667 {
8668   int i, j;
8669
8670   for (i = 0; i < tape->length; i++)
8671   {
8672     if (tape->use_key_actions)
8673     {
8674       for (j = 0; j < MAX_PLAYERS; j++)
8675         if (tape->player_participates[j])
8676           putFile8Bit(file, tape->pos[i].action[j]);
8677     }
8678
8679     if (tape->use_mouse_actions)
8680     {
8681       putFile8Bit(file, tape->pos[i].action[TAPE_ACTION_LX]);
8682       putFile8Bit(file, tape->pos[i].action[TAPE_ACTION_LY]);
8683       putFile8Bit(file, tape->pos[i].action[TAPE_ACTION_BUTTON]);
8684     }
8685
8686     putFile8Bit(file, tape->pos[i].delay);
8687   }
8688 }
8689
8690 void SaveTapeToFilename(char *filename)
8691 {
8692   FILE *file;
8693   int tape_pos_size;
8694   int info_chunk_size;
8695   int body_chunk_size;
8696
8697   if (!(file = fopen(filename, MODE_WRITE)))
8698   {
8699     Warn("cannot save level recording file '%s'", filename);
8700
8701     return;
8702   }
8703
8704   tape_pos_size = getTapePosSize(&tape);
8705
8706   info_chunk_size = 2 + (strlen(tape.level_identifier) + 1) + 2;
8707   body_chunk_size = tape_pos_size * tape.length;
8708
8709   putFileChunkBE(file, "RND1", CHUNK_SIZE_UNDEFINED);
8710   putFileChunkBE(file, "TAPE", CHUNK_SIZE_NONE);
8711
8712   putFileChunkBE(file, "VERS", TAPE_CHUNK_VERS_SIZE);
8713   SaveTape_VERS(file, &tape);
8714
8715   putFileChunkBE(file, "HEAD", TAPE_CHUNK_HEAD_SIZE);
8716   SaveTape_HEAD(file, &tape);
8717
8718   if (checkSaveTape_SCRN(&tape))
8719   {
8720     putFileChunkBE(file, "SCRN", TAPE_CHUNK_SCRN_SIZE);
8721     SaveTape_SCRN(file, &tape);
8722   }
8723
8724   putFileChunkBE(file, "INFO", info_chunk_size);
8725   SaveTape_INFO(file, &tape);
8726
8727   putFileChunkBE(file, "BODY", body_chunk_size);
8728   SaveTape_BODY(file, &tape);
8729
8730   fclose(file);
8731
8732   SetFilePermissions(filename, PERMS_PRIVATE);
8733 }
8734
8735 static void SaveTapeExt(char *filename)
8736 {
8737   int i;
8738
8739   tape.file_version = FILE_VERSION_ACTUAL;
8740   tape.game_version = GAME_VERSION_ACTUAL;
8741
8742   tape.num_participating_players = 0;
8743
8744   // count number of participating players
8745   for (i = 0; i < MAX_PLAYERS; i++)
8746     if (tape.player_participates[i])
8747       tape.num_participating_players++;
8748
8749   SaveTapeToFilename(filename);
8750
8751   tape.changed = FALSE;
8752 }
8753
8754 void SaveTape(int nr)
8755 {
8756   char *filename = getTapeFilename(nr);
8757
8758   InitTapeDirectory(leveldir_current->subdir);
8759
8760   SaveTapeExt(filename);
8761 }
8762
8763 void SaveScoreTape(int nr)
8764 {
8765   char *filename = getScoreTapeFilename(tape.score_tape_basename, nr);
8766
8767   // used instead of "leveldir_current->subdir" (for network games)
8768   InitScoreTapeDirectory(levelset.identifier, nr);
8769
8770   SaveTapeExt(filename);
8771 }
8772
8773 static boolean SaveTapeCheckedExt(int nr, char *msg_replace, char *msg_saved,
8774                                   unsigned int req_state_added)
8775 {
8776   char *filename = getTapeFilename(nr);
8777   boolean new_tape = !fileExists(filename);
8778   boolean tape_saved = FALSE;
8779
8780   if (new_tape || Request(msg_replace, REQ_ASK | req_state_added))
8781   {
8782     SaveTape(nr);
8783
8784     if (new_tape)
8785       Request(msg_saved, REQ_CONFIRM | req_state_added);
8786
8787     tape_saved = TRUE;
8788   }
8789
8790   return tape_saved;
8791 }
8792
8793 boolean SaveTapeChecked(int nr)
8794 {
8795   return SaveTapeCheckedExt(nr, "Replace old tape?", "Tape saved!", 0);
8796 }
8797
8798 boolean SaveTapeChecked_LevelSolved(int nr)
8799 {
8800   return SaveTapeCheckedExt(nr, "Level solved! Replace old tape?",
8801                                 "Level solved! Tape saved!", REQ_STAY_OPEN);
8802 }
8803
8804 void DumpTape(struct TapeInfo *tape)
8805 {
8806   int tape_frame_counter;
8807   int i, j;
8808
8809   if (tape->no_valid_file)
8810   {
8811     Warn("cannot dump -- no valid tape file found");
8812
8813     return;
8814   }
8815
8816   PrintLine("-", 79);
8817
8818   Print("Tape of Level %03d (file version %08d, game version %08d)\n",
8819         tape->level_nr, tape->file_version, tape->game_version);
8820   Print("                  (effective engine version %08d)\n",
8821         tape->engine_version);
8822   Print("Level series identifier: '%s'\n", tape->level_identifier);
8823
8824   Print("Solution tape: %s\n",
8825         tape->solved ? "yes" :
8826         tape->game_version < VERSION_IDENT(4,3,2,3) ? "unknown" : "no");
8827
8828   Print("Special tape properties: ");
8829   if (tape->property_bits == TAPE_PROPERTY_NONE)
8830     Print("[none]");
8831   if (tape->property_bits & TAPE_PROPERTY_EM_RANDOM_BUG)
8832     Print("[em_random_bug]");
8833   if (tape->property_bits & TAPE_PROPERTY_GAME_SPEED)
8834     Print("[game_speed]");
8835   if (tape->property_bits & TAPE_PROPERTY_PAUSE_MODE)
8836     Print("[pause]");
8837   if (tape->property_bits & TAPE_PROPERTY_SINGLE_STEP)
8838     Print("[single_step]");
8839   if (tape->property_bits & TAPE_PROPERTY_SNAPSHOT)
8840     Print("[snapshot]");
8841   if (tape->property_bits & TAPE_PROPERTY_REPLAYED)
8842     Print("[replayed]");
8843   if (tape->property_bits & TAPE_PROPERTY_TAS_KEYS)
8844     Print("[tas_keys]");
8845   if (tape->property_bits & TAPE_PROPERTY_SMALL_GRAPHICS)
8846     Print("[small_graphics]");
8847   Print("\n");
8848
8849   int year2 = tape->date / 10000;
8850   int year4 = (year2 < 70 ? 2000 + year2 : 1900 + year2);
8851   int month_index_raw = (tape->date / 100) % 100;
8852   int month_index = month_index_raw % 12;       // prevent invalid index
8853   int month = month_index + 1;
8854   int day = tape->date % 100;
8855
8856   Print("Tape date: %04d-%02d-%02d\n", year4, month, day);
8857
8858   PrintLine("-", 79);
8859
8860   tape_frame_counter = 0;
8861
8862   for (i = 0; i < tape->length; i++)
8863   {
8864     if (i >= MAX_TAPE_LEN)
8865       break;
8866
8867     Print("%04d: ", i);
8868
8869     for (j = 0; j < MAX_PLAYERS; j++)
8870     {
8871       if (tape->player_participates[j])
8872       {
8873         int action = tape->pos[i].action[j];
8874
8875         Print("%d:%02x ", j, action);
8876         Print("[%c%c%c%c|%c%c] - ",
8877               (action & JOY_LEFT ? '<' : ' '),
8878               (action & JOY_RIGHT ? '>' : ' '),
8879               (action & JOY_UP ? '^' : ' '),
8880               (action & JOY_DOWN ? 'v' : ' '),
8881               (action & JOY_BUTTON_1 ? '1' : ' '),
8882               (action & JOY_BUTTON_2 ? '2' : ' '));
8883       }
8884     }
8885
8886     Print("(%03d) ", tape->pos[i].delay);
8887     Print("[%05d]\n", tape_frame_counter);
8888
8889     tape_frame_counter += tape->pos[i].delay;
8890   }
8891
8892   PrintLine("-", 79);
8893 }
8894
8895 void DumpTapes(void)
8896 {
8897   static LevelDirTree *dumptape_leveldir = NULL;
8898
8899   dumptape_leveldir = getTreeInfoFromIdentifier(leveldir_first,
8900                                                 global.dumptape_leveldir);
8901
8902   if (dumptape_leveldir == NULL)
8903     Fail("no such level identifier: '%s'", global.dumptape_leveldir);
8904
8905   if (global.dumptape_level_nr < dumptape_leveldir->first_level ||
8906       global.dumptape_level_nr > dumptape_leveldir->last_level)
8907     Fail("no such level number: %d", global.dumptape_level_nr);
8908
8909   leveldir_current = dumptape_leveldir;
8910
8911   if (options.mytapes)
8912     LoadTape(global.dumptape_level_nr);
8913   else
8914     LoadSolutionTape(global.dumptape_level_nr);
8915
8916   DumpTape(&tape);
8917
8918   CloseAllAndExit(0);
8919 }
8920
8921
8922 // ============================================================================
8923 // score file functions
8924 // ============================================================================
8925
8926 static void setScoreInfoToDefaultsExt(struct ScoreInfo *scores)
8927 {
8928   int i;
8929
8930   for (i = 0; i < MAX_SCORE_ENTRIES; i++)
8931   {
8932     strcpy(scores->entry[i].tape_basename, UNDEFINED_FILENAME);
8933     strcpy(scores->entry[i].name, EMPTY_PLAYER_NAME);
8934     scores->entry[i].score = 0;
8935     scores->entry[i].time = 0;
8936
8937     scores->entry[i].id = -1;
8938     strcpy(scores->entry[i].tape_date,    UNKNOWN_NAME);
8939     strcpy(scores->entry[i].platform,     UNKNOWN_NAME);
8940     strcpy(scores->entry[i].version,      UNKNOWN_NAME);
8941     strcpy(scores->entry[i].country_name, UNKNOWN_NAME);
8942     strcpy(scores->entry[i].country_code, "??");
8943   }
8944
8945   scores->num_entries = 0;
8946   scores->last_added = -1;
8947   scores->last_added_local = -1;
8948
8949   scores->updated = FALSE;
8950   scores->uploaded = FALSE;
8951   scores->tape_downloaded = FALSE;
8952   scores->force_last_added = FALSE;
8953
8954   // The following values are intentionally not reset here:
8955   // - last_level_nr
8956   // - last_entry_nr
8957   // - next_level_nr
8958   // - continue_playing
8959   // - continue_on_return
8960 }
8961
8962 static void setScoreInfoToDefaults(void)
8963 {
8964   setScoreInfoToDefaultsExt(&scores);
8965 }
8966
8967 static void setServerScoreInfoToDefaults(void)
8968 {
8969   setScoreInfoToDefaultsExt(&server_scores);
8970 }
8971
8972 static void LoadScore_OLD(int nr)
8973 {
8974   int i;
8975   char *filename = getScoreFilename(nr);
8976   char cookie[MAX_LINE_LEN];
8977   char line[MAX_LINE_LEN];
8978   char *line_ptr;
8979   FILE *file;
8980
8981   if (!(file = fopen(filename, MODE_READ)))
8982     return;
8983
8984   // check file identifier
8985   if (fgets(cookie, MAX_LINE_LEN, file) == NULL)
8986     cookie[0] = '\0';
8987   if (strlen(cookie) > 0 && cookie[strlen(cookie) - 1] == '\n')
8988     cookie[strlen(cookie) - 1] = '\0';
8989
8990   if (!checkCookieString(cookie, SCORE_COOKIE_TMPL))
8991   {
8992     Warn("unknown format of score file '%s'", filename);
8993
8994     fclose(file);
8995
8996     return;
8997   }
8998
8999   for (i = 0; i < MAX_SCORE_ENTRIES; i++)
9000   {
9001     if (fscanf(file, "%d", &scores.entry[i].score) == EOF)
9002       Warn("fscanf() failed; %s", strerror(errno));
9003
9004     if (fgets(line, MAX_LINE_LEN, file) == NULL)
9005       line[0] = '\0';
9006
9007     if (strlen(line) > 0 && line[strlen(line) - 1] == '\n')
9008       line[strlen(line) - 1] = '\0';
9009
9010     for (line_ptr = line; *line_ptr; line_ptr++)
9011     {
9012       if (*line_ptr != ' ' && *line_ptr != '\t' && *line_ptr != '\0')
9013       {
9014         strncpy(scores.entry[i].name, line_ptr, MAX_PLAYER_NAME_LEN);
9015         scores.entry[i].name[MAX_PLAYER_NAME_LEN] = '\0';
9016         break;
9017       }
9018     }
9019   }
9020
9021   fclose(file);
9022 }
9023
9024 static void ConvertScore_OLD(void)
9025 {
9026   // only convert score to time for levels that rate playing time over score
9027   if (!level.rate_time_over_score)
9028     return;
9029
9030   // convert old score to playing time for score-less levels (like Supaplex)
9031   int time_final_max = 999;
9032   int i;
9033
9034   for (i = 0; i < MAX_SCORE_ENTRIES; i++)
9035   {
9036     int score = scores.entry[i].score;
9037
9038     if (score > 0 && score < time_final_max)
9039       scores.entry[i].time = (time_final_max - score - 1) * FRAMES_PER_SECOND;
9040   }
9041 }
9042
9043 static int LoadScore_VERS(File *file, int chunk_size, struct ScoreInfo *scores)
9044 {
9045   scores->file_version = getFileVersion(file);
9046   scores->game_version = getFileVersion(file);
9047
9048   return chunk_size;
9049 }
9050
9051 static int LoadScore_INFO(File *file, int chunk_size, struct ScoreInfo *scores)
9052 {
9053   char *level_identifier = NULL;
9054   int level_identifier_size;
9055   int i;
9056
9057   level_identifier_size = getFile16BitBE(file);
9058
9059   level_identifier = checked_malloc(level_identifier_size);
9060
9061   for (i = 0; i < level_identifier_size; i++)
9062     level_identifier[i] = getFile8Bit(file);
9063
9064   strncpy(scores->level_identifier, level_identifier, MAX_FILENAME_LEN);
9065   scores->level_identifier[MAX_FILENAME_LEN] = '\0';
9066
9067   checked_free(level_identifier);
9068
9069   scores->level_nr = getFile16BitBE(file);
9070   scores->num_entries = getFile16BitBE(file);
9071
9072   chunk_size = 2 + level_identifier_size + 2 + 2;
9073
9074   return chunk_size;
9075 }
9076
9077 static int LoadScore_NAME(File *file, int chunk_size, struct ScoreInfo *scores)
9078 {
9079   int i, j;
9080
9081   for (i = 0; i < scores->num_entries; i++)
9082   {
9083     for (j = 0; j < MAX_PLAYER_NAME_LEN; j++)
9084       scores->entry[i].name[j] = getFile8Bit(file);
9085
9086     scores->entry[i].name[MAX_PLAYER_NAME_LEN] = '\0';
9087   }
9088
9089   chunk_size = scores->num_entries * MAX_PLAYER_NAME_LEN;
9090
9091   return chunk_size;
9092 }
9093
9094 static int LoadScore_SCOR(File *file, int chunk_size, struct ScoreInfo *scores)
9095 {
9096   int i;
9097
9098   for (i = 0; i < scores->num_entries; i++)
9099     scores->entry[i].score = getFile16BitBE(file);
9100
9101   chunk_size = scores->num_entries * 2;
9102
9103   return chunk_size;
9104 }
9105
9106 static int LoadScore_SC4R(File *file, int chunk_size, struct ScoreInfo *scores)
9107 {
9108   int i;
9109
9110   for (i = 0; i < scores->num_entries; i++)
9111     scores->entry[i].score = getFile32BitBE(file);
9112
9113   chunk_size = scores->num_entries * 4;
9114
9115   return chunk_size;
9116 }
9117
9118 static int LoadScore_TIME(File *file, int chunk_size, struct ScoreInfo *scores)
9119 {
9120   int i;
9121
9122   for (i = 0; i < scores->num_entries; i++)
9123     scores->entry[i].time = getFile32BitBE(file);
9124
9125   chunk_size = scores->num_entries * 4;
9126
9127   return chunk_size;
9128 }
9129
9130 static int LoadScore_TAPE(File *file, int chunk_size, struct ScoreInfo *scores)
9131 {
9132   int i, j;
9133
9134   for (i = 0; i < scores->num_entries; i++)
9135   {
9136     for (j = 0; j < MAX_SCORE_TAPE_BASENAME_LEN; j++)
9137       scores->entry[i].tape_basename[j] = getFile8Bit(file);
9138
9139     scores->entry[i].tape_basename[MAX_SCORE_TAPE_BASENAME_LEN] = '\0';
9140   }
9141
9142   chunk_size = scores->num_entries * MAX_SCORE_TAPE_BASENAME_LEN;
9143
9144   return chunk_size;
9145 }
9146
9147 void LoadScore(int nr)
9148 {
9149   char *filename = getScoreFilename(nr);
9150   char cookie[MAX_LINE_LEN];
9151   char chunk_name[CHUNK_ID_LEN + 1];
9152   int chunk_size;
9153   boolean old_score_file_format = FALSE;
9154   File *file;
9155
9156   // always start with reliable default values
9157   setScoreInfoToDefaults();
9158
9159   if (!(file = openFile(filename, MODE_READ)))
9160     return;
9161
9162   getFileChunkBE(file, chunk_name, NULL);
9163   if (strEqual(chunk_name, "RND1"))
9164   {
9165     getFile32BitBE(file);               // not used
9166
9167     getFileChunkBE(file, chunk_name, NULL);
9168     if (!strEqual(chunk_name, "SCOR"))
9169     {
9170       Warn("unknown format of score file '%s'", filename);
9171
9172       closeFile(file);
9173
9174       return;
9175     }
9176   }
9177   else  // check for old file format with cookie string
9178   {
9179     strcpy(cookie, chunk_name);
9180     if (getStringFromFile(file, &cookie[4], MAX_LINE_LEN - 4) == NULL)
9181       cookie[4] = '\0';
9182     if (strlen(cookie) > 0 && cookie[strlen(cookie) - 1] == '\n')
9183       cookie[strlen(cookie) - 1] = '\0';
9184
9185     if (!checkCookieString(cookie, SCORE_COOKIE_TMPL))
9186     {
9187       Warn("unknown format of score file '%s'", filename);
9188
9189       closeFile(file);
9190
9191       return;
9192     }
9193
9194     old_score_file_format = TRUE;
9195   }
9196
9197   if (old_score_file_format)
9198   {
9199     // score files from versions before 4.2.4.0 without chunk structure
9200     LoadScore_OLD(nr);
9201
9202     // convert score to time, if possible (mainly for Supaplex levels)
9203     ConvertScore_OLD();
9204   }
9205   else
9206   {
9207     static struct
9208     {
9209       char *name;
9210       int size;
9211       int (*loader)(File *, int, struct ScoreInfo *);
9212     }
9213     chunk_info[] =
9214     {
9215       { "VERS", SCORE_CHUNK_VERS_SIZE,  LoadScore_VERS },
9216       { "INFO", -1,                     LoadScore_INFO },
9217       { "NAME", -1,                     LoadScore_NAME },
9218       { "SCOR", -1,                     LoadScore_SCOR },
9219       { "SC4R", -1,                     LoadScore_SC4R },
9220       { "TIME", -1,                     LoadScore_TIME },
9221       { "TAPE", -1,                     LoadScore_TAPE },
9222
9223       {  NULL,  0,                      NULL }
9224     };
9225
9226     while (getFileChunkBE(file, chunk_name, &chunk_size))
9227     {
9228       int i = 0;
9229
9230       while (chunk_info[i].name != NULL &&
9231              !strEqual(chunk_name, chunk_info[i].name))
9232         i++;
9233
9234       if (chunk_info[i].name == NULL)
9235       {
9236         Warn("unknown chunk '%s' in score file '%s'",
9237               chunk_name, filename);
9238
9239         ReadUnusedBytesFromFile(file, chunk_size);
9240       }
9241       else if (chunk_info[i].size != -1 &&
9242                chunk_info[i].size != chunk_size)
9243       {
9244         Warn("wrong size (%d) of chunk '%s' in score file '%s'",
9245               chunk_size, chunk_name, filename);
9246
9247         ReadUnusedBytesFromFile(file, chunk_size);
9248       }
9249       else
9250       {
9251         // call function to load this score chunk
9252         int chunk_size_expected =
9253           (chunk_info[i].loader)(file, chunk_size, &scores);
9254
9255         // the size of some chunks cannot be checked before reading other
9256         // chunks first (like "HEAD" and "BODY") that contain some header
9257         // information, so check them here
9258         if (chunk_size_expected != chunk_size)
9259         {
9260           Warn("wrong size (%d) of chunk '%s' in score file '%s'",
9261                 chunk_size, chunk_name, filename);
9262         }
9263       }
9264     }
9265   }
9266
9267   closeFile(file);
9268 }
9269
9270 #if ENABLE_HISTORIC_CHUNKS
9271 void SaveScore_OLD(int nr)
9272 {
9273   int i;
9274   char *filename = getScoreFilename(nr);
9275   FILE *file;
9276
9277   // used instead of "leveldir_current->subdir" (for network games)
9278   InitScoreDirectory(levelset.identifier);
9279
9280   if (!(file = fopen(filename, MODE_WRITE)))
9281   {
9282     Warn("cannot save score for level %d", nr);
9283
9284     return;
9285   }
9286
9287   fprintf(file, "%s\n\n", SCORE_COOKIE);
9288
9289   for (i = 0; i < MAX_SCORE_ENTRIES; i++)
9290     fprintf(file, "%d %s\n", scores.entry[i].score, scores.entry[i].name);
9291
9292   fclose(file);
9293
9294   SetFilePermissions(filename, PERMS_PRIVATE);
9295 }
9296 #endif
9297
9298 static void SaveScore_VERS(FILE *file, struct ScoreInfo *scores)
9299 {
9300   putFileVersion(file, scores->file_version);
9301   putFileVersion(file, scores->game_version);
9302 }
9303
9304 static void SaveScore_INFO(FILE *file, struct ScoreInfo *scores)
9305 {
9306   int level_identifier_size = strlen(scores->level_identifier) + 1;
9307   int i;
9308
9309   putFile16BitBE(file, level_identifier_size);
9310
9311   for (i = 0; i < level_identifier_size; i++)
9312     putFile8Bit(file, scores->level_identifier[i]);
9313
9314   putFile16BitBE(file, scores->level_nr);
9315   putFile16BitBE(file, scores->num_entries);
9316 }
9317
9318 static void SaveScore_NAME(FILE *file, struct ScoreInfo *scores)
9319 {
9320   int i, j;
9321
9322   for (i = 0; i < scores->num_entries; i++)
9323   {
9324     int name_size = strlen(scores->entry[i].name);
9325
9326     for (j = 0; j < MAX_PLAYER_NAME_LEN; j++)
9327       putFile8Bit(file, (j < name_size ? scores->entry[i].name[j] : 0));
9328   }
9329 }
9330
9331 static void SaveScore_SCOR(FILE *file, struct ScoreInfo *scores)
9332 {
9333   int i;
9334
9335   for (i = 0; i < scores->num_entries; i++)
9336     putFile16BitBE(file, scores->entry[i].score);
9337 }
9338
9339 static void SaveScore_SC4R(FILE *file, struct ScoreInfo *scores)
9340 {
9341   int i;
9342
9343   for (i = 0; i < scores->num_entries; i++)
9344     putFile32BitBE(file, scores->entry[i].score);
9345 }
9346
9347 static void SaveScore_TIME(FILE *file, struct ScoreInfo *scores)
9348 {
9349   int i;
9350
9351   for (i = 0; i < scores->num_entries; i++)
9352     putFile32BitBE(file, scores->entry[i].time);
9353 }
9354
9355 static void SaveScore_TAPE(FILE *file, struct ScoreInfo *scores)
9356 {
9357   int i, j;
9358
9359   for (i = 0; i < scores->num_entries; i++)
9360   {
9361     int size = strlen(scores->entry[i].tape_basename);
9362
9363     for (j = 0; j < MAX_SCORE_TAPE_BASENAME_LEN; j++)
9364       putFile8Bit(file, (j < size ? scores->entry[i].tape_basename[j] : 0));
9365   }
9366 }
9367
9368 static void SaveScoreToFilename(char *filename)
9369 {
9370   FILE *file;
9371   int info_chunk_size;
9372   int name_chunk_size;
9373   int scor_chunk_size;
9374   int sc4r_chunk_size;
9375   int time_chunk_size;
9376   int tape_chunk_size;
9377   boolean has_large_score_values;
9378   int i;
9379
9380   if (!(file = fopen(filename, MODE_WRITE)))
9381   {
9382     Warn("cannot save score file '%s'", filename);
9383
9384     return;
9385   }
9386
9387   info_chunk_size = 2 + (strlen(scores.level_identifier) + 1) + 2 + 2;
9388   name_chunk_size = scores.num_entries * MAX_PLAYER_NAME_LEN;
9389   scor_chunk_size = scores.num_entries * 2;
9390   sc4r_chunk_size = scores.num_entries * 4;
9391   time_chunk_size = scores.num_entries * 4;
9392   tape_chunk_size = scores.num_entries * MAX_SCORE_TAPE_BASENAME_LEN;
9393
9394   has_large_score_values = FALSE;
9395   for (i = 0; i < scores.num_entries; i++)
9396     if (scores.entry[i].score > 0xffff)
9397       has_large_score_values = TRUE;
9398
9399   putFileChunkBE(file, "RND1", CHUNK_SIZE_UNDEFINED);
9400   putFileChunkBE(file, "SCOR", CHUNK_SIZE_NONE);
9401
9402   putFileChunkBE(file, "VERS", SCORE_CHUNK_VERS_SIZE);
9403   SaveScore_VERS(file, &scores);
9404
9405   putFileChunkBE(file, "INFO", info_chunk_size);
9406   SaveScore_INFO(file, &scores);
9407
9408   putFileChunkBE(file, "NAME", name_chunk_size);
9409   SaveScore_NAME(file, &scores);
9410
9411   if (has_large_score_values)
9412   {
9413     putFileChunkBE(file, "SC4R", sc4r_chunk_size);
9414     SaveScore_SC4R(file, &scores);
9415   }
9416   else
9417   {
9418     putFileChunkBE(file, "SCOR", scor_chunk_size);
9419     SaveScore_SCOR(file, &scores);
9420   }
9421
9422   putFileChunkBE(file, "TIME", time_chunk_size);
9423   SaveScore_TIME(file, &scores);
9424
9425   putFileChunkBE(file, "TAPE", tape_chunk_size);
9426   SaveScore_TAPE(file, &scores);
9427
9428   fclose(file);
9429
9430   SetFilePermissions(filename, PERMS_PRIVATE);
9431 }
9432
9433 void SaveScore(int nr)
9434 {
9435   char *filename = getScoreFilename(nr);
9436   int i;
9437
9438   // used instead of "leveldir_current->subdir" (for network games)
9439   InitScoreDirectory(levelset.identifier);
9440
9441   scores.file_version = FILE_VERSION_ACTUAL;
9442   scores.game_version = GAME_VERSION_ACTUAL;
9443
9444   strncpy(scores.level_identifier, levelset.identifier, MAX_FILENAME_LEN);
9445   scores.level_identifier[MAX_FILENAME_LEN] = '\0';
9446   scores.level_nr = level_nr;
9447
9448   for (i = 0; i < MAX_SCORE_ENTRIES; i++)
9449     if (scores.entry[i].score == 0 &&
9450         scores.entry[i].time == 0 &&
9451         strEqual(scores.entry[i].name, EMPTY_PLAYER_NAME))
9452       break;
9453
9454   scores.num_entries = i;
9455
9456   if (scores.num_entries == 0)
9457     return;
9458
9459   SaveScoreToFilename(filename);
9460 }
9461
9462 static void LoadServerScoreFromCache(int nr)
9463 {
9464   struct ScoreEntry score_entry;
9465   struct
9466   {
9467     void *value;
9468     boolean is_string;
9469     int string_size;
9470   }
9471   score_mapping[] =
9472   {
9473     { &score_entry.score,               FALSE,  0                       },
9474     { &score_entry.time,                FALSE,  0                       },
9475     { score_entry.name,                 TRUE,   MAX_PLAYER_NAME_LEN     },
9476     { score_entry.tape_basename,        TRUE,   MAX_FILENAME_LEN        },
9477     { score_entry.tape_date,            TRUE,   MAX_ISO_DATE_LEN        },
9478     { &score_entry.id,                  FALSE,  0                       },
9479     { score_entry.platform,             TRUE,   MAX_PLATFORM_TEXT_LEN   },
9480     { score_entry.version,              TRUE,   MAX_VERSION_TEXT_LEN    },
9481     { score_entry.country_code,         TRUE,   MAX_COUNTRY_CODE_LEN    },
9482     { score_entry.country_name,         TRUE,   MAX_COUNTRY_NAME_LEN    },
9483
9484     { NULL,                             FALSE,  0                       }
9485   };
9486   char *filename = getScoreCacheFilename(nr);
9487   SetupFileHash *score_hash = loadSetupFileHash(filename);
9488   int i, j;
9489
9490   server_scores.num_entries = 0;
9491
9492   if (score_hash == NULL)
9493     return;
9494
9495   for (i = 0; i < MAX_SCORE_ENTRIES; i++)
9496   {
9497     score_entry = server_scores.entry[i];
9498
9499     for (j = 0; score_mapping[j].value != NULL; j++)
9500     {
9501       char token[10];
9502
9503       sprintf(token, "%02d.%d", i, j);
9504
9505       char *value = getHashEntry(score_hash, token);
9506
9507       if (value == NULL)
9508         continue;
9509
9510       if (score_mapping[j].is_string)
9511       {
9512         char *score_value = (char *)score_mapping[j].value;
9513         int value_size = score_mapping[j].string_size;
9514
9515         strncpy(score_value, value, value_size);
9516         score_value[value_size] = '\0';
9517       }
9518       else
9519       {
9520         int *score_value = (int *)score_mapping[j].value;
9521
9522         *score_value = atoi(value);
9523       }
9524
9525       server_scores.num_entries = i + 1;
9526     }
9527
9528     server_scores.entry[i] = score_entry;
9529   }
9530
9531   freeSetupFileHash(score_hash);
9532 }
9533
9534 void LoadServerScore(int nr, boolean download_score)
9535 {
9536   if (!setup.use_api_server)
9537     return;
9538
9539   // always start with reliable default values
9540   setServerScoreInfoToDefaults();
9541
9542   // 1st step: load server scores from cache file (which may not exist)
9543   // (this should prevent reading it while the thread is writing to it)
9544   LoadServerScoreFromCache(nr);
9545
9546   if (download_score && runtime.use_api_server)
9547   {
9548     // 2nd step: download server scores from score server to cache file
9549     // (as thread, as it might time out if the server is not reachable)
9550     ApiGetScoreAsThread(nr);
9551   }
9552 }
9553
9554 void PrepareScoreTapesForUpload(char *leveldir_subdir)
9555 {
9556   MarkTapeDirectoryUploadsAsIncomplete(leveldir_subdir);
9557
9558   // if score tape not uploaded, ask for uploading missing tapes later
9559   if (!setup.has_remaining_tapes)
9560     setup.ask_for_remaining_tapes = TRUE;
9561
9562   setup.provide_uploading_tapes = TRUE;
9563   setup.has_remaining_tapes = TRUE;
9564
9565   SaveSetup_ServerSetup();
9566 }
9567
9568 void SaveServerScore(int nr, boolean tape_saved)
9569 {
9570   if (!runtime.use_api_server)
9571   {
9572     PrepareScoreTapesForUpload(leveldir_current->subdir);
9573
9574     return;
9575   }
9576
9577   ApiAddScoreAsThread(nr, tape_saved, NULL);
9578 }
9579
9580 void SaveServerScoreFromFile(int nr, boolean tape_saved,
9581                              char *score_tape_filename)
9582 {
9583   if (!runtime.use_api_server)
9584     return;
9585
9586   ApiAddScoreAsThread(nr, tape_saved, score_tape_filename);
9587 }
9588
9589 void LoadLocalAndServerScore(int nr, boolean download_score)
9590 {
9591   int last_added_local = scores.last_added_local;
9592   boolean force_last_added = scores.force_last_added;
9593
9594   // needed if only showing server scores
9595   setScoreInfoToDefaults();
9596
9597   if (!strEqual(setup.scores_in_highscore_list, STR_SCORES_TYPE_SERVER_ONLY))
9598     LoadScore(nr);
9599
9600   // restore last added local score entry (before merging server scores)
9601   scores.last_added = scores.last_added_local = last_added_local;
9602
9603   if (setup.use_api_server &&
9604       !strEqual(setup.scores_in_highscore_list, STR_SCORES_TYPE_LOCAL_ONLY))
9605   {
9606     // load server scores from cache file and trigger update from server
9607     LoadServerScore(nr, download_score);
9608
9609     // merge local scores with scores from server
9610     MergeServerScore();
9611   }
9612
9613   if (force_last_added)
9614     scores.force_last_added = force_last_added;
9615 }
9616
9617
9618 // ============================================================================
9619 // setup file functions
9620 // ============================================================================
9621
9622 #define TOKEN_STR_PLAYER_PREFIX                 "player_"
9623
9624
9625 static struct TokenInfo global_setup_tokens[] =
9626 {
9627   {
9628     TYPE_STRING,
9629     &setup.player_name,                         "player_name"
9630   },
9631   {
9632     TYPE_SWITCH,
9633     &setup.multiple_users,                      "multiple_users"
9634   },
9635   {
9636     TYPE_SWITCH,
9637     &setup.sound,                               "sound"
9638   },
9639   {
9640     TYPE_SWITCH,
9641     &setup.sound_loops,                         "repeating_sound_loops"
9642   },
9643   {
9644     TYPE_SWITCH,
9645     &setup.sound_music,                         "background_music"
9646   },
9647   {
9648     TYPE_SWITCH,
9649     &setup.sound_simple,                        "simple_sound_effects"
9650   },
9651   {
9652     TYPE_SWITCH,
9653     &setup.toons,                               "toons"
9654   },
9655   {
9656     TYPE_SWITCH,
9657     &setup.global_animations,                   "global_animations"
9658   },
9659   {
9660     TYPE_SWITCH,
9661     &setup.scroll_delay,                        "scroll_delay"
9662   },
9663   {
9664     TYPE_SWITCH,
9665     &setup.forced_scroll_delay,                 "forced_scroll_delay"
9666   },
9667   {
9668     TYPE_INTEGER,
9669     &setup.scroll_delay_value,                  "scroll_delay_value"
9670   },
9671   {
9672     TYPE_STRING,
9673     &setup.engine_snapshot_mode,                "engine_snapshot_mode"
9674   },
9675   {
9676     TYPE_INTEGER,
9677     &setup.engine_snapshot_memory,              "engine_snapshot_memory"
9678   },
9679   {
9680     TYPE_SWITCH,
9681     &setup.fade_screens,                        "fade_screens"
9682   },
9683   {
9684     TYPE_SWITCH,
9685     &setup.autorecord,                          "automatic_tape_recording"
9686   },
9687   {
9688     TYPE_SWITCH,
9689     &setup.autorecord_after_replay,             "autorecord_after_replay"
9690   },
9691   {
9692     TYPE_SWITCH,
9693     &setup.auto_pause_on_start,                 "auto_pause_on_start"
9694   },
9695   {
9696     TYPE_SWITCH,
9697     &setup.show_titlescreen,                    "show_titlescreen"
9698   },
9699   {
9700     TYPE_SWITCH,
9701     &setup.quick_doors,                         "quick_doors"
9702   },
9703   {
9704     TYPE_SWITCH,
9705     &setup.team_mode,                           "team_mode"
9706   },
9707   {
9708     TYPE_SWITCH,
9709     &setup.handicap,                            "handicap"
9710   },
9711   {
9712     TYPE_SWITCH,
9713     &setup.skip_levels,                         "skip_levels"
9714   },
9715   {
9716     TYPE_SWITCH,
9717     &setup.increment_levels,                    "increment_levels"
9718   },
9719   {
9720     TYPE_SWITCH,
9721     &setup.auto_play_next_level,                "auto_play_next_level"
9722   },
9723   {
9724     TYPE_SWITCH,
9725     &setup.count_score_after_game,              "count_score_after_game"
9726   },
9727   {
9728     TYPE_SWITCH,
9729     &setup.show_scores_after_game,              "show_scores_after_game"
9730   },
9731   {
9732     TYPE_SWITCH,
9733     &setup.time_limit,                          "time_limit"
9734   },
9735   {
9736     TYPE_SWITCH,
9737     &setup.fullscreen,                          "fullscreen"
9738   },
9739   {
9740     TYPE_INTEGER,
9741     &setup.window_scaling_percent,              "window_scaling_percent"
9742   },
9743   {
9744     TYPE_STRING,
9745     &setup.window_scaling_quality,              "window_scaling_quality"
9746   },
9747   {
9748     TYPE_STRING,
9749     &setup.screen_rendering_mode,               "screen_rendering_mode"
9750   },
9751   {
9752     TYPE_STRING,
9753     &setup.vsync_mode,                          "vsync_mode"
9754   },
9755   {
9756     TYPE_SWITCH,
9757     &setup.ask_on_escape,                       "ask_on_escape"
9758   },
9759   {
9760     TYPE_SWITCH,
9761     &setup.ask_on_escape_editor,                "ask_on_escape_editor"
9762   },
9763   {
9764     TYPE_SWITCH,
9765     &setup.ask_on_game_over,                    "ask_on_game_over"
9766   },
9767   {
9768     TYPE_SWITCH,
9769     &setup.ask_on_quit_game,                    "ask_on_quit_game"
9770   },
9771   {
9772     TYPE_SWITCH,
9773     &setup.ask_on_quit_program,                 "ask_on_quit_program"
9774   },
9775   {
9776     TYPE_SWITCH,
9777     &setup.quick_switch,                        "quick_player_switch"
9778   },
9779   {
9780     TYPE_SWITCH,
9781     &setup.input_on_focus,                      "input_on_focus"
9782   },
9783   {
9784     TYPE_SWITCH,
9785     &setup.prefer_aga_graphics,                 "prefer_aga_graphics"
9786   },
9787   {
9788     TYPE_SWITCH,
9789     &setup.prefer_lowpass_sounds,               "prefer_lowpass_sounds"
9790   },
9791   {
9792     TYPE_SWITCH,
9793     &setup.prefer_extra_panel_items,            "prefer_extra_panel_items"
9794   },
9795   {
9796     TYPE_SWITCH,
9797     &setup.game_speed_extended,                 "game_speed_extended"
9798   },
9799   {
9800     TYPE_INTEGER,
9801     &setup.game_frame_delay,                    "game_frame_delay"
9802   },
9803   {
9804     TYPE_SWITCH,
9805     &setup.bd_skip_uncovering,                  "bd_skip_uncovering"
9806   },
9807   {
9808     TYPE_SWITCH,
9809     &setup.bd_skip_hatching,                    "bd_skip_hatching"
9810   },
9811   {
9812     TYPE_SWITCH,
9813     &setup.bd_scroll_delay,                     "bd_scroll_delay"
9814   },
9815   {
9816     TYPE_SWITCH3,
9817     &setup.bd_smooth_movements,                 "bd_smooth_movements"
9818   },
9819   {
9820     TYPE_SWITCH,
9821     &setup.sp_show_border_elements,             "sp_show_border_elements"
9822   },
9823   {
9824     TYPE_SWITCH,
9825     &setup.small_game_graphics,                 "small_game_graphics"
9826   },
9827   {
9828     TYPE_SWITCH,
9829     &setup.show_load_save_buttons,              "show_load_save_buttons"
9830   },
9831   {
9832     TYPE_SWITCH,
9833     &setup.show_undo_redo_buttons,              "show_undo_redo_buttons"
9834   },
9835   {
9836     TYPE_STRING,
9837     &setup.scores_in_highscore_list,            "scores_in_highscore_list"
9838   },
9839   {
9840     TYPE_STRING,
9841     &setup.graphics_set,                        "graphics_set"
9842   },
9843   {
9844     TYPE_STRING,
9845     &setup.sounds_set,                          "sounds_set"
9846   },
9847   {
9848     TYPE_STRING,
9849     &setup.music_set,                           "music_set"
9850   },
9851   {
9852     TYPE_SWITCH3,
9853     &setup.override_level_graphics,             "override_level_graphics"
9854   },
9855   {
9856     TYPE_SWITCH3,
9857     &setup.override_level_sounds,               "override_level_sounds"
9858   },
9859   {
9860     TYPE_SWITCH3,
9861     &setup.override_level_music,                "override_level_music"
9862   },
9863   {
9864     TYPE_INTEGER,
9865     &setup.volume_simple,                       "volume_simple"
9866   },
9867   {
9868     TYPE_INTEGER,
9869     &setup.volume_loops,                        "volume_loops"
9870   },
9871   {
9872     TYPE_INTEGER,
9873     &setup.volume_music,                        "volume_music"
9874   },
9875   {
9876     TYPE_SWITCH,
9877     &setup.network_mode,                        "network_mode"
9878   },
9879   {
9880     TYPE_PLAYER,
9881     &setup.network_player_nr,                   "network_player"
9882   },
9883   {
9884     TYPE_STRING,
9885     &setup.network_server_hostname,             "network_server_hostname"
9886   },
9887   {
9888     TYPE_STRING,
9889     &setup.touch.control_type,                  "touch.control_type"
9890   },
9891   {
9892     TYPE_INTEGER,
9893     &setup.touch.move_distance,                 "touch.move_distance"
9894   },
9895   {
9896     TYPE_INTEGER,
9897     &setup.touch.drop_distance,                 "touch.drop_distance"
9898   },
9899   {
9900     TYPE_INTEGER,
9901     &setup.touch.transparency,                  "touch.transparency"
9902   },
9903   {
9904     TYPE_INTEGER,
9905     &setup.touch.draw_outlined,                 "touch.draw_outlined"
9906   },
9907   {
9908     TYPE_INTEGER,
9909     &setup.touch.draw_pressed,                  "touch.draw_pressed"
9910   },
9911   {
9912     TYPE_INTEGER,
9913     &setup.touch.grid_xsize[0],                 "touch.virtual_buttons.0.xsize"
9914   },
9915   {
9916     TYPE_INTEGER,
9917     &setup.touch.grid_ysize[0],                 "touch.virtual_buttons.0.ysize"
9918   },
9919   {
9920     TYPE_INTEGER,
9921     &setup.touch.grid_xsize[1],                 "touch.virtual_buttons.1.xsize"
9922   },
9923   {
9924     TYPE_INTEGER,
9925     &setup.touch.grid_ysize[1],                 "touch.virtual_buttons.1.ysize"
9926   },
9927   {
9928     TYPE_SWITCH,
9929     &setup.touch.overlay_buttons,               "touch.overlay_buttons"
9930   },
9931 };
9932
9933 static struct TokenInfo auto_setup_tokens[] =
9934 {
9935   {
9936     TYPE_INTEGER,
9937     &setup.auto_setup.editor_zoom_tilesize,     "editor.zoom_tilesize"
9938   },
9939 };
9940
9941 static struct TokenInfo server_setup_tokens[] =
9942 {
9943   {
9944     TYPE_STRING,
9945     &setup.player_uuid,                         "player_uuid"
9946   },
9947   {
9948     TYPE_INTEGER,
9949     &setup.player_version,                      "player_version"
9950   },
9951   {
9952     TYPE_SWITCH,
9953     &setup.use_api_server,          TEST_PREFIX "use_api_server"
9954   },
9955   {
9956     TYPE_STRING,
9957     &setup.api_server_hostname,     TEST_PREFIX "api_server_hostname"
9958   },
9959   {
9960     TYPE_STRING,
9961     &setup.api_server_password,     TEST_PREFIX "api_server_password"
9962   },
9963   {
9964     TYPE_SWITCH,
9965     &setup.ask_for_uploading_tapes, TEST_PREFIX "ask_for_uploading_tapes"
9966   },
9967   {
9968     TYPE_SWITCH,
9969     &setup.ask_for_remaining_tapes, TEST_PREFIX "ask_for_remaining_tapes"
9970   },
9971   {
9972     TYPE_SWITCH,
9973     &setup.provide_uploading_tapes, TEST_PREFIX "provide_uploading_tapes"
9974   },
9975   {
9976     TYPE_SWITCH,
9977     &setup.ask_for_using_api_server,TEST_PREFIX "ask_for_using_api_server"
9978   },
9979   {
9980     TYPE_SWITCH,
9981     &setup.has_remaining_tapes,     TEST_PREFIX "has_remaining_tapes"
9982   },
9983 };
9984
9985 static struct TokenInfo editor_setup_tokens[] =
9986 {
9987   {
9988     TYPE_SWITCH,
9989     &setup.editor.el_classic,                   "editor.el_classic"
9990   },
9991   {
9992     TYPE_SWITCH,
9993     &setup.editor.el_custom,                    "editor.el_custom"
9994   },
9995   {
9996     TYPE_SWITCH,
9997     &setup.editor.el_user_defined,              "editor.el_user_defined"
9998   },
9999   {
10000     TYPE_SWITCH,
10001     &setup.editor.el_dynamic,                   "editor.el_dynamic"
10002   },
10003   {
10004     TYPE_SWITCH,
10005     &setup.editor.el_headlines,                 "editor.el_headlines"
10006   },
10007   {
10008     TYPE_SWITCH,
10009     &setup.editor.show_element_token,           "editor.show_element_token"
10010   },
10011   {
10012     TYPE_SWITCH,
10013     &setup.editor.show_read_only_warning,       "editor.show_read_only_warning"
10014   },
10015 };
10016
10017 static struct TokenInfo editor_cascade_setup_tokens[] =
10018 {
10019   {
10020     TYPE_SWITCH,
10021     &setup.editor_cascade.el_bd,                "editor.cascade.el_bd"
10022   },
10023   {
10024     TYPE_SWITCH,
10025     &setup.editor_cascade.el_bd_native,         "editor.cascade.el_bd_native"
10026   },
10027   {
10028     TYPE_SWITCH,
10029     &setup.editor_cascade.el_em,                "editor.cascade.el_em"
10030   },
10031   {
10032     TYPE_SWITCH,
10033     &setup.editor_cascade.el_emc,               "editor.cascade.el_emc"
10034   },
10035   {
10036     TYPE_SWITCH,
10037     &setup.editor_cascade.el_rnd,               "editor.cascade.el_rnd"
10038   },
10039   {
10040     TYPE_SWITCH,
10041     &setup.editor_cascade.el_sb,                "editor.cascade.el_sb"
10042   },
10043   {
10044     TYPE_SWITCH,
10045     &setup.editor_cascade.el_sp,                "editor.cascade.el_sp"
10046   },
10047   {
10048     TYPE_SWITCH,
10049     &setup.editor_cascade.el_dc,                "editor.cascade.el_dc"
10050   },
10051   {
10052     TYPE_SWITCH,
10053     &setup.editor_cascade.el_dx,                "editor.cascade.el_dx"
10054   },
10055   {
10056     TYPE_SWITCH,
10057     &setup.editor_cascade.el_mm,                "editor.cascade.el_mm"
10058   },
10059   {
10060     TYPE_SWITCH,
10061     &setup.editor_cascade.el_df,                "editor.cascade.el_df"
10062   },
10063   {
10064     TYPE_SWITCH,
10065     &setup.editor_cascade.el_chars,             "editor.cascade.el_chars"
10066   },
10067   {
10068     TYPE_SWITCH,
10069     &setup.editor_cascade.el_steel_chars,       "editor.cascade.el_steel_chars"
10070   },
10071   {
10072     TYPE_SWITCH,
10073     &setup.editor_cascade.el_ce,                "editor.cascade.el_ce"
10074   },
10075   {
10076     TYPE_SWITCH,
10077     &setup.editor_cascade.el_ge,                "editor.cascade.el_ge"
10078   },
10079   {
10080     TYPE_SWITCH,
10081     &setup.editor_cascade.el_es,                "editor.cascade.el_es"
10082   },
10083   {
10084     TYPE_SWITCH,
10085     &setup.editor_cascade.el_ref,               "editor.cascade.el_ref"
10086   },
10087   {
10088     TYPE_SWITCH,
10089     &setup.editor_cascade.el_user,              "editor.cascade.el_user"
10090   },
10091   {
10092     TYPE_SWITCH,
10093     &setup.editor_cascade.el_dynamic,           "editor.cascade.el_dynamic"
10094   },
10095 };
10096
10097 static struct TokenInfo shortcut_setup_tokens[] =
10098 {
10099   {
10100     TYPE_KEY_X11,
10101     &setup.shortcut.save_game,                  "shortcut.save_game"
10102   },
10103   {
10104     TYPE_KEY_X11,
10105     &setup.shortcut.load_game,                  "shortcut.load_game"
10106   },
10107   {
10108     TYPE_KEY_X11,
10109     &setup.shortcut.restart_game,               "shortcut.restart_game"
10110   },
10111   {
10112     TYPE_KEY_X11,
10113     &setup.shortcut.pause_before_end,           "shortcut.pause_before_end"
10114   },
10115   {
10116     TYPE_KEY_X11,
10117     &setup.shortcut.toggle_pause,               "shortcut.toggle_pause"
10118   },
10119   {
10120     TYPE_KEY_X11,
10121     &setup.shortcut.focus_player[0],            "shortcut.focus_player_1"
10122   },
10123   {
10124     TYPE_KEY_X11,
10125     &setup.shortcut.focus_player[1],            "shortcut.focus_player_2"
10126   },
10127   {
10128     TYPE_KEY_X11,
10129     &setup.shortcut.focus_player[2],            "shortcut.focus_player_3"
10130   },
10131   {
10132     TYPE_KEY_X11,
10133     &setup.shortcut.focus_player[3],            "shortcut.focus_player_4"
10134   },
10135   {
10136     TYPE_KEY_X11,
10137     &setup.shortcut.focus_player_all,           "shortcut.focus_player_all"
10138   },
10139   {
10140     TYPE_KEY_X11,
10141     &setup.shortcut.tape_eject,                 "shortcut.tape_eject"
10142   },
10143   {
10144     TYPE_KEY_X11,
10145     &setup.shortcut.tape_extra,                 "shortcut.tape_extra"
10146   },
10147   {
10148     TYPE_KEY_X11,
10149     &setup.shortcut.tape_stop,                  "shortcut.tape_stop"
10150   },
10151   {
10152     TYPE_KEY_X11,
10153     &setup.shortcut.tape_pause,                 "shortcut.tape_pause"
10154   },
10155   {
10156     TYPE_KEY_X11,
10157     &setup.shortcut.tape_record,                "shortcut.tape_record"
10158   },
10159   {
10160     TYPE_KEY_X11,
10161     &setup.shortcut.tape_play,                  "shortcut.tape_play"
10162   },
10163   {
10164     TYPE_KEY_X11,
10165     &setup.shortcut.sound_simple,               "shortcut.sound_simple"
10166   },
10167   {
10168     TYPE_KEY_X11,
10169     &setup.shortcut.sound_loops,                "shortcut.sound_loops"
10170   },
10171   {
10172     TYPE_KEY_X11,
10173     &setup.shortcut.sound_music,                "shortcut.sound_music"
10174   },
10175   {
10176     TYPE_KEY_X11,
10177     &setup.shortcut.snap_left,                  "shortcut.snap_left"
10178   },
10179   {
10180     TYPE_KEY_X11,
10181     &setup.shortcut.snap_right,                 "shortcut.snap_right"
10182   },
10183   {
10184     TYPE_KEY_X11,
10185     &setup.shortcut.snap_up,                    "shortcut.snap_up"
10186   },
10187   {
10188     TYPE_KEY_X11,
10189     &setup.shortcut.snap_down,                  "shortcut.snap_down"
10190   },
10191 };
10192
10193 static struct SetupInputInfo setup_input;
10194 static struct TokenInfo player_setup_tokens[] =
10195 {
10196   {
10197     TYPE_BOOLEAN,
10198     &setup_input.use_joystick,                  ".use_joystick"
10199   },
10200   {
10201     TYPE_STRING,
10202     &setup_input.joy.device_name,               ".joy.device_name"
10203   },
10204   {
10205     TYPE_INTEGER,
10206     &setup_input.joy.xleft,                     ".joy.xleft"
10207   },
10208   {
10209     TYPE_INTEGER,
10210     &setup_input.joy.xmiddle,                   ".joy.xmiddle"
10211   },
10212   {
10213     TYPE_INTEGER,
10214     &setup_input.joy.xright,                    ".joy.xright"
10215   },
10216   {
10217     TYPE_INTEGER,
10218     &setup_input.joy.yupper,                    ".joy.yupper"
10219   },
10220   {
10221     TYPE_INTEGER,
10222     &setup_input.joy.ymiddle,                   ".joy.ymiddle"
10223   },
10224   {
10225     TYPE_INTEGER,
10226     &setup_input.joy.ylower,                    ".joy.ylower"
10227   },
10228   {
10229     TYPE_INTEGER,
10230     &setup_input.joy.snap,                      ".joy.snap_field"
10231   },
10232   {
10233     TYPE_INTEGER,
10234     &setup_input.joy.drop,                      ".joy.place_bomb"
10235   },
10236   {
10237     TYPE_KEY_X11,
10238     &setup_input.key.left,                      ".key.move_left"
10239   },
10240   {
10241     TYPE_KEY_X11,
10242     &setup_input.key.right,                     ".key.move_right"
10243   },
10244   {
10245     TYPE_KEY_X11,
10246     &setup_input.key.up,                        ".key.move_up"
10247   },
10248   {
10249     TYPE_KEY_X11,
10250     &setup_input.key.down,                      ".key.move_down"
10251   },
10252   {
10253     TYPE_KEY_X11,
10254     &setup_input.key.snap,                      ".key.snap_field"
10255   },
10256   {
10257     TYPE_KEY_X11,
10258     &setup_input.key.drop,                      ".key.place_bomb"
10259   },
10260 };
10261
10262 static struct TokenInfo system_setup_tokens[] =
10263 {
10264   {
10265     TYPE_STRING,
10266     &setup.system.sdl_renderdriver,             "system.sdl_renderdriver"
10267   },
10268   {
10269     TYPE_STRING,
10270     &setup.system.sdl_videodriver,              "system.sdl_videodriver"
10271   },
10272   {
10273     TYPE_STRING,
10274     &setup.system.sdl_audiodriver,              "system.sdl_audiodriver"
10275   },
10276   {
10277     TYPE_INTEGER,
10278     &setup.system.audio_fragment_size,          "system.audio_fragment_size"
10279   },
10280 };
10281
10282 static struct TokenInfo internal_setup_tokens[] =
10283 {
10284   {
10285     TYPE_STRING,
10286     &setup.internal.program_title,              "program_title"
10287   },
10288   {
10289     TYPE_STRING,
10290     &setup.internal.program_version,            "program_version"
10291   },
10292   {
10293     TYPE_STRING,
10294     &setup.internal.program_author,             "program_author"
10295   },
10296   {
10297     TYPE_STRING,
10298     &setup.internal.program_email,              "program_email"
10299   },
10300   {
10301     TYPE_STRING,
10302     &setup.internal.program_website,            "program_website"
10303   },
10304   {
10305     TYPE_STRING,
10306     &setup.internal.program_copyright,          "program_copyright"
10307   },
10308   {
10309     TYPE_STRING,
10310     &setup.internal.program_company,            "program_company"
10311   },
10312   {
10313     TYPE_STRING,
10314     &setup.internal.program_icon_file,          "program_icon_file"
10315   },
10316   {
10317     TYPE_STRING,
10318     &setup.internal.default_graphics_set,       "default_graphics_set"
10319   },
10320   {
10321     TYPE_STRING,
10322     &setup.internal.default_sounds_set,         "default_sounds_set"
10323   },
10324   {
10325     TYPE_STRING,
10326     &setup.internal.default_music_set,          "default_music_set"
10327   },
10328   {
10329     TYPE_STRING,
10330     &setup.internal.fallback_graphics_file,     "fallback_graphics_file"
10331   },
10332   {
10333     TYPE_STRING,
10334     &setup.internal.fallback_sounds_file,       "fallback_sounds_file"
10335   },
10336   {
10337     TYPE_STRING,
10338     &setup.internal.fallback_music_file,        "fallback_music_file"
10339   },
10340   {
10341     TYPE_STRING,
10342     &setup.internal.default_level_series,       "default_level_series"
10343   },
10344   {
10345     TYPE_INTEGER,
10346     &setup.internal.default_window_width,       "default_window_width"
10347   },
10348   {
10349     TYPE_INTEGER,
10350     &setup.internal.default_window_height,      "default_window_height"
10351   },
10352   {
10353     TYPE_BOOLEAN,
10354     &setup.internal.choose_from_top_leveldir,   "choose_from_top_leveldir"
10355   },
10356   {
10357     TYPE_BOOLEAN,
10358     &setup.internal.show_scaling_in_title,      "show_scaling_in_title"
10359   },
10360   {
10361     TYPE_BOOLEAN,
10362     &setup.internal.create_user_levelset,       "create_user_levelset"
10363   },
10364   {
10365     TYPE_BOOLEAN,
10366     &setup.internal.info_screens_from_main,     "info_screens_from_main"
10367   },
10368   {
10369     TYPE_BOOLEAN,
10370     &setup.internal.menu_game,                  "menu_game"
10371   },
10372   {
10373     TYPE_BOOLEAN,
10374     &setup.internal.menu_engines,               "menu_engines"
10375   },
10376   {
10377     TYPE_BOOLEAN,
10378     &setup.internal.menu_editor,                "menu_editor"
10379   },
10380   {
10381     TYPE_BOOLEAN,
10382     &setup.internal.menu_graphics,              "menu_graphics"
10383   },
10384   {
10385     TYPE_BOOLEAN,
10386     &setup.internal.menu_sound,                 "menu_sound"
10387   },
10388   {
10389     TYPE_BOOLEAN,
10390     &setup.internal.menu_artwork,               "menu_artwork"
10391   },
10392   {
10393     TYPE_BOOLEAN,
10394     &setup.internal.menu_input,                 "menu_input"
10395   },
10396   {
10397     TYPE_BOOLEAN,
10398     &setup.internal.menu_touch,                 "menu_touch"
10399   },
10400   {
10401     TYPE_BOOLEAN,
10402     &setup.internal.menu_shortcuts,             "menu_shortcuts"
10403   },
10404   {
10405     TYPE_BOOLEAN,
10406     &setup.internal.menu_exit,                  "menu_exit"
10407   },
10408   {
10409     TYPE_BOOLEAN,
10410     &setup.internal.menu_save_and_exit,         "menu_save_and_exit"
10411   },
10412   {
10413     TYPE_BOOLEAN,
10414     &setup.internal.menu_shortcuts_various,     "menu_shortcuts_various"
10415   },
10416   {
10417     TYPE_BOOLEAN,
10418     &setup.internal.menu_shortcuts_focus,       "menu_shortcuts_focus"
10419   },
10420   {
10421     TYPE_BOOLEAN,
10422     &setup.internal.menu_shortcuts_tape,        "menu_shortcuts_tape"
10423   },
10424   {
10425     TYPE_BOOLEAN,
10426     &setup.internal.menu_shortcuts_sound,       "menu_shortcuts_sound"
10427   },
10428   {
10429     TYPE_BOOLEAN,
10430     &setup.internal.menu_shortcuts_snap,        "menu_shortcuts_snap"
10431   },
10432   {
10433     TYPE_BOOLEAN,
10434     &setup.internal.info_title,                 "info_title"
10435   },
10436   {
10437     TYPE_BOOLEAN,
10438     &setup.internal.info_elements,              "info_elements"
10439   },
10440   {
10441     TYPE_BOOLEAN,
10442     &setup.internal.info_music,                 "info_music"
10443   },
10444   {
10445     TYPE_BOOLEAN,
10446     &setup.internal.info_credits,               "info_credits"
10447   },
10448   {
10449     TYPE_BOOLEAN,
10450     &setup.internal.info_program,               "info_program"
10451   },
10452   {
10453     TYPE_BOOLEAN,
10454     &setup.internal.info_version,               "info_version"
10455   },
10456   {
10457     TYPE_BOOLEAN,
10458     &setup.internal.info_levelset,              "info_levelset"
10459   },
10460   {
10461     TYPE_BOOLEAN,
10462     &setup.internal.info_exit,                  "info_exit"
10463   },
10464 };
10465
10466 static struct TokenInfo debug_setup_tokens[] =
10467 {
10468   {
10469     TYPE_INTEGER,
10470     &setup.debug.frame_delay[0],                "debug.frame_delay_0"
10471   },
10472   {
10473     TYPE_INTEGER,
10474     &setup.debug.frame_delay[1],                "debug.frame_delay_1"
10475   },
10476   {
10477     TYPE_INTEGER,
10478     &setup.debug.frame_delay[2],                "debug.frame_delay_2"
10479   },
10480   {
10481     TYPE_INTEGER,
10482     &setup.debug.frame_delay[3],                "debug.frame_delay_3"
10483   },
10484   {
10485     TYPE_INTEGER,
10486     &setup.debug.frame_delay[4],                "debug.frame_delay_4"
10487   },
10488   {
10489     TYPE_INTEGER,
10490     &setup.debug.frame_delay[5],                "debug.frame_delay_5"
10491   },
10492   {
10493     TYPE_INTEGER,
10494     &setup.debug.frame_delay[6],                "debug.frame_delay_6"
10495   },
10496   {
10497     TYPE_INTEGER,
10498     &setup.debug.frame_delay[7],                "debug.frame_delay_7"
10499   },
10500   {
10501     TYPE_INTEGER,
10502     &setup.debug.frame_delay[8],                "debug.frame_delay_8"
10503   },
10504   {
10505     TYPE_INTEGER,
10506     &setup.debug.frame_delay[9],                "debug.frame_delay_9"
10507   },
10508   {
10509     TYPE_KEY_X11,
10510     &setup.debug.frame_delay_key[0],            "debug.key.frame_delay_0"
10511   },
10512   {
10513     TYPE_KEY_X11,
10514     &setup.debug.frame_delay_key[1],            "debug.key.frame_delay_1"
10515   },
10516   {
10517     TYPE_KEY_X11,
10518     &setup.debug.frame_delay_key[2],            "debug.key.frame_delay_2"
10519   },
10520   {
10521     TYPE_KEY_X11,
10522     &setup.debug.frame_delay_key[3],            "debug.key.frame_delay_3"
10523   },
10524   {
10525     TYPE_KEY_X11,
10526     &setup.debug.frame_delay_key[4],            "debug.key.frame_delay_4"
10527   },
10528   {
10529     TYPE_KEY_X11,
10530     &setup.debug.frame_delay_key[5],            "debug.key.frame_delay_5"
10531   },
10532   {
10533     TYPE_KEY_X11,
10534     &setup.debug.frame_delay_key[6],            "debug.key.frame_delay_6"
10535   },
10536   {
10537     TYPE_KEY_X11,
10538     &setup.debug.frame_delay_key[7],            "debug.key.frame_delay_7"
10539   },
10540   {
10541     TYPE_KEY_X11,
10542     &setup.debug.frame_delay_key[8],            "debug.key.frame_delay_8"
10543   },
10544   {
10545     TYPE_KEY_X11,
10546     &setup.debug.frame_delay_key[9],            "debug.key.frame_delay_9"
10547   },
10548   {
10549     TYPE_BOOLEAN,
10550     &setup.debug.frame_delay_use_mod_key,       "debug.frame_delay.use_mod_key"},
10551   {
10552     TYPE_BOOLEAN,
10553     &setup.debug.frame_delay_game_only,         "debug.frame_delay.game_only"
10554   },
10555   {
10556     TYPE_BOOLEAN,
10557     &setup.debug.show_frames_per_second,        "debug.show_frames_per_second"
10558   },
10559   {
10560     TYPE_SWITCH3,
10561     &setup.debug.xsn_mode,                      "debug.xsn_mode"
10562   },
10563   {
10564     TYPE_INTEGER,
10565     &setup.debug.xsn_percent,                   "debug.xsn_percent"
10566   },
10567 };
10568
10569 static struct TokenInfo options_setup_tokens[] =
10570 {
10571   {
10572     TYPE_BOOLEAN,
10573     &setup.options.verbose,                     "options.verbose"
10574   },
10575   {
10576     TYPE_BOOLEAN,
10577     &setup.options.debug,                       "options.debug"
10578   },
10579   {
10580     TYPE_STRING,
10581     &setup.options.debug_mode,                  "options.debug_mode"
10582   },
10583 };
10584
10585 static void setSetupInfoToDefaults(struct SetupInfo *si)
10586 {
10587   int i;
10588
10589   si->player_name = getStringCopy(getDefaultUserName(user.nr));
10590
10591   si->multiple_users = TRUE;
10592
10593   si->sound = TRUE;
10594   si->sound_loops = TRUE;
10595   si->sound_music = TRUE;
10596   si->sound_simple = TRUE;
10597   si->toons = TRUE;
10598   si->global_animations = TRUE;
10599   si->scroll_delay = TRUE;
10600   si->forced_scroll_delay = FALSE;
10601   si->scroll_delay_value = STD_SCROLL_DELAY;
10602   si->engine_snapshot_mode = getStringCopy(STR_SNAPSHOT_MODE_DEFAULT);
10603   si->engine_snapshot_memory = SNAPSHOT_MEMORY_DEFAULT;
10604   si->fade_screens = TRUE;
10605   si->autorecord = TRUE;
10606   si->autorecord_after_replay = TRUE;
10607   si->auto_pause_on_start = FALSE;
10608   si->show_titlescreen = TRUE;
10609   si->quick_doors = FALSE;
10610   si->team_mode = FALSE;
10611   si->handicap = TRUE;
10612   si->skip_levels = TRUE;
10613   si->increment_levels = TRUE;
10614   si->auto_play_next_level = TRUE;
10615   si->count_score_after_game = TRUE;
10616   si->show_scores_after_game = TRUE;
10617   si->time_limit = TRUE;
10618   si->fullscreen = FALSE;
10619   si->window_scaling_percent = STD_WINDOW_SCALING_PERCENT;
10620   si->window_scaling_quality = getStringCopy(SCALING_QUALITY_DEFAULT);
10621   si->screen_rendering_mode = getStringCopy(STR_SPECIAL_RENDERING_DEFAULT);
10622   si->vsync_mode = getStringCopy(STR_VSYNC_MODE_DEFAULT);
10623   si->ask_on_escape = TRUE;
10624   si->ask_on_escape_editor = TRUE;
10625   si->ask_on_game_over = TRUE;
10626   si->ask_on_quit_game = TRUE;
10627   si->ask_on_quit_program = TRUE;
10628   si->quick_switch = FALSE;
10629   si->input_on_focus = FALSE;
10630   si->prefer_aga_graphics = TRUE;
10631   si->prefer_lowpass_sounds = FALSE;
10632   si->prefer_extra_panel_items = TRUE;
10633   si->game_speed_extended = FALSE;
10634   si->game_frame_delay = GAME_FRAME_DELAY;
10635   si->bd_skip_uncovering = FALSE;
10636   si->bd_skip_hatching = FALSE;
10637   si->bd_scroll_delay = TRUE;
10638   si->bd_smooth_movements = AUTO;
10639   si->sp_show_border_elements = FALSE;
10640   si->small_game_graphics = FALSE;
10641   si->show_load_save_buttons = FALSE;
10642   si->show_undo_redo_buttons = FALSE;
10643   si->scores_in_highscore_list = getStringCopy(STR_SCORES_TYPE_DEFAULT);
10644
10645   si->graphics_set = getStringCopy(GFX_CLASSIC_SUBDIR);
10646   si->sounds_set   = getStringCopy(SND_CLASSIC_SUBDIR);
10647   si->music_set    = getStringCopy(MUS_CLASSIC_SUBDIR);
10648
10649   si->override_level_graphics = FALSE;
10650   si->override_level_sounds = FALSE;
10651   si->override_level_music = FALSE;
10652
10653   si->volume_simple = 100;              // percent
10654   si->volume_loops = 100;               // percent
10655   si->volume_music = 100;               // percent
10656
10657   si->network_mode = FALSE;
10658   si->network_player_nr = 0;            // first player
10659   si->network_server_hostname = getStringCopy(STR_NETWORK_AUTO_DETECT);
10660
10661   si->touch.control_type = getStringCopy(TOUCH_CONTROL_DEFAULT);
10662   si->touch.move_distance = TOUCH_MOVE_DISTANCE_DEFAULT;        // percent
10663   si->touch.drop_distance = TOUCH_DROP_DISTANCE_DEFAULT;        // percent
10664   si->touch.transparency = TOUCH_TRANSPARENCY_DEFAULT;          // percent
10665   si->touch.draw_outlined = TRUE;
10666   si->touch.draw_pressed = TRUE;
10667
10668   for (i = 0; i < 2; i++)
10669   {
10670     char *default_grid_button[6][2] =
10671     {
10672       { "      ", "  ^^  " },
10673       { "      ", "  ^^  " },
10674       { "      ", "<<  >>" },
10675       { "      ", "<<  >>" },
10676       { "111222", "  vv  " },
10677       { "111222", "  vv  " }
10678     };
10679     int grid_xsize = DEFAULT_GRID_XSIZE(i);
10680     int grid_ysize = DEFAULT_GRID_YSIZE(i);
10681     int min_xsize = MIN(6, grid_xsize);
10682     int min_ysize = MIN(6, grid_ysize);
10683     int startx = grid_xsize - min_xsize;
10684     int starty = grid_ysize - min_ysize;
10685     int x, y;
10686
10687     // virtual buttons grid can only be set to defaults if video is initialized
10688     // (this will be repeated if virtual buttons are not loaded from setup file)
10689     if (video.initialized)
10690     {
10691       si->touch.grid_xsize[i] = grid_xsize;
10692       si->touch.grid_ysize[i] = grid_ysize;
10693     }
10694     else
10695     {
10696       si->touch.grid_xsize[i] = -1;
10697       si->touch.grid_ysize[i] = -1;
10698     }
10699
10700     for (x = 0; x < MAX_GRID_XSIZE; x++)
10701       for (y = 0; y < MAX_GRID_YSIZE; y++)
10702         si->touch.grid_button[i][x][y] = CHAR_GRID_BUTTON_NONE;
10703
10704     for (x = 0; x < min_xsize; x++)
10705       for (y = 0; y < min_ysize; y++)
10706         si->touch.grid_button[i][x][starty + y] =
10707           default_grid_button[y][0][x];
10708
10709     for (x = 0; x < min_xsize; x++)
10710       for (y = 0; y < min_ysize; y++)
10711         si->touch.grid_button[i][startx + x][starty + y] =
10712           default_grid_button[y][1][x];
10713   }
10714
10715   si->touch.grid_initialized            = video.initialized;
10716
10717   si->touch.overlay_buttons             = FALSE;
10718
10719   si->editor.el_boulderdash             = TRUE;
10720   si->editor.el_boulderdash_native      = TRUE;
10721   si->editor.el_emerald_mine            = TRUE;
10722   si->editor.el_emerald_mine_club       = TRUE;
10723   si->editor.el_more                    = TRUE;
10724   si->editor.el_sokoban                 = TRUE;
10725   si->editor.el_supaplex                = TRUE;
10726   si->editor.el_diamond_caves           = TRUE;
10727   si->editor.el_dx_boulderdash          = TRUE;
10728
10729   si->editor.el_mirror_magic            = TRUE;
10730   si->editor.el_deflektor               = TRUE;
10731
10732   si->editor.el_chars                   = TRUE;
10733   si->editor.el_steel_chars             = TRUE;
10734
10735   si->editor.el_classic                 = TRUE;
10736   si->editor.el_custom                  = TRUE;
10737
10738   si->editor.el_user_defined            = FALSE;
10739   si->editor.el_dynamic                 = TRUE;
10740
10741   si->editor.el_headlines               = TRUE;
10742
10743   si->editor.show_element_token         = FALSE;
10744
10745   si->editor.show_read_only_warning     = TRUE;
10746
10747   si->editor.use_template_for_new_levels = TRUE;
10748
10749   si->shortcut.save_game        = DEFAULT_KEY_SAVE_GAME;
10750   si->shortcut.load_game        = DEFAULT_KEY_LOAD_GAME;
10751   si->shortcut.restart_game     = DEFAULT_KEY_RESTART_GAME;
10752   si->shortcut.pause_before_end = DEFAULT_KEY_PAUSE_BEFORE_END;
10753   si->shortcut.toggle_pause     = DEFAULT_KEY_TOGGLE_PAUSE;
10754
10755   si->shortcut.focus_player[0]  = DEFAULT_KEY_FOCUS_PLAYER_1;
10756   si->shortcut.focus_player[1]  = DEFAULT_KEY_FOCUS_PLAYER_2;
10757   si->shortcut.focus_player[2]  = DEFAULT_KEY_FOCUS_PLAYER_3;
10758   si->shortcut.focus_player[3]  = DEFAULT_KEY_FOCUS_PLAYER_4;
10759   si->shortcut.focus_player_all = DEFAULT_KEY_FOCUS_PLAYER_ALL;
10760
10761   si->shortcut.tape_eject       = DEFAULT_KEY_TAPE_EJECT;
10762   si->shortcut.tape_extra       = DEFAULT_KEY_TAPE_EXTRA;
10763   si->shortcut.tape_stop        = DEFAULT_KEY_TAPE_STOP;
10764   si->shortcut.tape_pause       = DEFAULT_KEY_TAPE_PAUSE;
10765   si->shortcut.tape_record      = DEFAULT_KEY_TAPE_RECORD;
10766   si->shortcut.tape_play        = DEFAULT_KEY_TAPE_PLAY;
10767
10768   si->shortcut.sound_simple     = DEFAULT_KEY_SOUND_SIMPLE;
10769   si->shortcut.sound_loops      = DEFAULT_KEY_SOUND_LOOPS;
10770   si->shortcut.sound_music      = DEFAULT_KEY_SOUND_MUSIC;
10771
10772   si->shortcut.snap_left        = DEFAULT_KEY_SNAP_LEFT;
10773   si->shortcut.snap_right       = DEFAULT_KEY_SNAP_RIGHT;
10774   si->shortcut.snap_up          = DEFAULT_KEY_SNAP_UP;
10775   si->shortcut.snap_down        = DEFAULT_KEY_SNAP_DOWN;
10776
10777   for (i = 0; i < MAX_PLAYERS; i++)
10778   {
10779     si->input[i].use_joystick = FALSE;
10780     si->input[i].joy.device_name = getStringCopy(getDeviceNameFromJoystickNr(i));
10781     si->input[i].joy.xleft   = JOYSTICK_XLEFT;
10782     si->input[i].joy.xmiddle = JOYSTICK_XMIDDLE;
10783     si->input[i].joy.xright  = JOYSTICK_XRIGHT;
10784     si->input[i].joy.yupper  = JOYSTICK_YUPPER;
10785     si->input[i].joy.ymiddle = JOYSTICK_YMIDDLE;
10786     si->input[i].joy.ylower  = JOYSTICK_YLOWER;
10787     si->input[i].joy.snap  = (i == 0 ? JOY_BUTTON_1 : 0);
10788     si->input[i].joy.drop  = (i == 0 ? JOY_BUTTON_2 : 0);
10789     si->input[i].key.left  = (i == 0 ? DEFAULT_KEY_LEFT  : KSYM_UNDEFINED);
10790     si->input[i].key.right = (i == 0 ? DEFAULT_KEY_RIGHT : KSYM_UNDEFINED);
10791     si->input[i].key.up    = (i == 0 ? DEFAULT_KEY_UP    : KSYM_UNDEFINED);
10792     si->input[i].key.down  = (i == 0 ? DEFAULT_KEY_DOWN  : KSYM_UNDEFINED);
10793     si->input[i].key.snap  = (i == 0 ? DEFAULT_KEY_SNAP  : KSYM_UNDEFINED);
10794     si->input[i].key.drop  = (i == 0 ? DEFAULT_KEY_DROP  : KSYM_UNDEFINED);
10795   }
10796
10797   si->system.sdl_renderdriver = getStringCopy(ARG_DEFAULT);
10798   si->system.sdl_videodriver = getStringCopy(ARG_DEFAULT);
10799   si->system.sdl_audiodriver = getStringCopy(ARG_DEFAULT);
10800   si->system.audio_fragment_size = DEFAULT_AUDIO_FRAGMENT_SIZE;
10801
10802   si->internal.program_title     = getStringCopy(PROGRAM_TITLE_STRING);
10803   si->internal.program_version   = getStringCopy(getProgramRealVersionString());
10804   si->internal.program_author    = getStringCopy(PROGRAM_AUTHOR_STRING);
10805   si->internal.program_email     = getStringCopy(PROGRAM_EMAIL_STRING);
10806   si->internal.program_website   = getStringCopy(PROGRAM_WEBSITE_STRING);
10807   si->internal.program_copyright = getStringCopy(PROGRAM_COPYRIGHT_STRING);
10808   si->internal.program_company   = getStringCopy(PROGRAM_COMPANY_STRING);
10809
10810   si->internal.program_icon_file = getStringCopy(PROGRAM_ICON_FILENAME);
10811
10812   si->internal.default_graphics_set = getStringCopy(GFX_CLASSIC_SUBDIR);
10813   si->internal.default_sounds_set   = getStringCopy(SND_CLASSIC_SUBDIR);
10814   si->internal.default_music_set    = getStringCopy(MUS_CLASSIC_SUBDIR);
10815
10816   si->internal.fallback_graphics_file = getStringCopy(UNDEFINED_FILENAME);
10817   si->internal.fallback_sounds_file   = getStringCopy(UNDEFINED_FILENAME);
10818   si->internal.fallback_music_file    = getStringCopy(UNDEFINED_FILENAME);
10819
10820   si->internal.default_level_series = getStringCopy(UNDEFINED_LEVELSET);
10821   si->internal.choose_from_top_leveldir = FALSE;
10822   si->internal.show_scaling_in_title = TRUE;
10823   si->internal.create_user_levelset = TRUE;
10824   si->internal.info_screens_from_main = FALSE;
10825
10826   si->internal.default_window_width  = WIN_XSIZE_DEFAULT;
10827   si->internal.default_window_height = WIN_YSIZE_DEFAULT;
10828
10829   si->debug.frame_delay[0] = DEFAULT_FRAME_DELAY_0;
10830   si->debug.frame_delay[1] = DEFAULT_FRAME_DELAY_1;
10831   si->debug.frame_delay[2] = DEFAULT_FRAME_DELAY_2;
10832   si->debug.frame_delay[3] = DEFAULT_FRAME_DELAY_3;
10833   si->debug.frame_delay[4] = DEFAULT_FRAME_DELAY_4;
10834   si->debug.frame_delay[5] = DEFAULT_FRAME_DELAY_5;
10835   si->debug.frame_delay[6] = DEFAULT_FRAME_DELAY_6;
10836   si->debug.frame_delay[7] = DEFAULT_FRAME_DELAY_7;
10837   si->debug.frame_delay[8] = DEFAULT_FRAME_DELAY_8;
10838   si->debug.frame_delay[9] = DEFAULT_FRAME_DELAY_9;
10839
10840   si->debug.frame_delay_key[0] = DEFAULT_KEY_FRAME_DELAY_0;
10841   si->debug.frame_delay_key[1] = DEFAULT_KEY_FRAME_DELAY_1;
10842   si->debug.frame_delay_key[2] = DEFAULT_KEY_FRAME_DELAY_2;
10843   si->debug.frame_delay_key[3] = DEFAULT_KEY_FRAME_DELAY_3;
10844   si->debug.frame_delay_key[4] = DEFAULT_KEY_FRAME_DELAY_4;
10845   si->debug.frame_delay_key[5] = DEFAULT_KEY_FRAME_DELAY_5;
10846   si->debug.frame_delay_key[6] = DEFAULT_KEY_FRAME_DELAY_6;
10847   si->debug.frame_delay_key[7] = DEFAULT_KEY_FRAME_DELAY_7;
10848   si->debug.frame_delay_key[8] = DEFAULT_KEY_FRAME_DELAY_8;
10849   si->debug.frame_delay_key[9] = DEFAULT_KEY_FRAME_DELAY_9;
10850
10851   si->debug.frame_delay_use_mod_key = DEFAULT_FRAME_DELAY_USE_MOD_KEY;
10852   si->debug.frame_delay_game_only   = DEFAULT_FRAME_DELAY_GAME_ONLY;
10853
10854   si->debug.show_frames_per_second = FALSE;
10855
10856   si->debug.xsn_mode = AUTO;
10857   si->debug.xsn_percent = 0;
10858
10859   si->options.verbose = FALSE;
10860   si->options.debug = FALSE;
10861   si->options.debug_mode = getStringCopy(ARG_UNDEFINED_STRING);
10862
10863 #if defined(PLATFORM_ANDROID)
10864   si->fullscreen = TRUE;
10865   si->touch.overlay_buttons = TRUE;
10866 #endif
10867
10868   setHideSetupEntry(&setup.debug.xsn_mode);
10869 }
10870
10871 static void setSetupInfoToDefaults_AutoSetup(struct SetupInfo *si)
10872 {
10873   si->auto_setup.editor_zoom_tilesize = MINI_TILESIZE;
10874 }
10875
10876 static void setSetupInfoToDefaults_ServerSetup(struct SetupInfo *si)
10877 {
10878   si->player_uuid = NULL;       // (will be set later)
10879   si->player_version = 1;       // (will be set later)
10880
10881   si->use_api_server = TRUE;
10882   si->api_server_hostname = getStringCopy(API_SERVER_HOSTNAME);
10883   si->api_server_password = getStringCopy(UNDEFINED_PASSWORD);
10884   si->ask_for_uploading_tapes = TRUE;
10885   si->ask_for_remaining_tapes = FALSE;
10886   si->provide_uploading_tapes = TRUE;
10887   si->ask_for_using_api_server = TRUE;
10888   si->has_remaining_tapes = FALSE;
10889 }
10890
10891 static void setSetupInfoToDefaults_EditorCascade(struct SetupInfo *si)
10892 {
10893   si->editor_cascade.el_bd              = TRUE;
10894   si->editor_cascade.el_bd_native       = TRUE;
10895   si->editor_cascade.el_em              = TRUE;
10896   si->editor_cascade.el_emc             = TRUE;
10897   si->editor_cascade.el_rnd             = TRUE;
10898   si->editor_cascade.el_sb              = TRUE;
10899   si->editor_cascade.el_sp              = TRUE;
10900   si->editor_cascade.el_dc              = TRUE;
10901   si->editor_cascade.el_dx              = TRUE;
10902
10903   si->editor_cascade.el_mm              = TRUE;
10904   si->editor_cascade.el_df              = TRUE;
10905
10906   si->editor_cascade.el_chars           = FALSE;
10907   si->editor_cascade.el_steel_chars     = FALSE;
10908   si->editor_cascade.el_ce              = FALSE;
10909   si->editor_cascade.el_ge              = FALSE;
10910   si->editor_cascade.el_es              = FALSE;
10911   si->editor_cascade.el_ref             = FALSE;
10912   si->editor_cascade.el_user            = FALSE;
10913   si->editor_cascade.el_dynamic         = FALSE;
10914 }
10915
10916 #define MAX_HIDE_SETUP_TOKEN_SIZE               20
10917
10918 static char *getHideSetupToken(void *setup_value)
10919 {
10920   static char hide_setup_token[MAX_HIDE_SETUP_TOKEN_SIZE];
10921
10922   if (setup_value != NULL)
10923     snprintf(hide_setup_token, MAX_HIDE_SETUP_TOKEN_SIZE, "%p", setup_value);
10924
10925   return hide_setup_token;
10926 }
10927
10928 void setHideSetupEntry(void *setup_value)
10929 {
10930   char *hide_setup_token = getHideSetupToken(setup_value);
10931
10932   if (hide_setup_hash == NULL)
10933     hide_setup_hash = newSetupFileHash();
10934
10935   if (setup_value != NULL)
10936     setHashEntry(hide_setup_hash, hide_setup_token, "");
10937 }
10938
10939 void removeHideSetupEntry(void *setup_value)
10940 {
10941   char *hide_setup_token = getHideSetupToken(setup_value);
10942
10943   if (setup_value != NULL)
10944     removeHashEntry(hide_setup_hash, hide_setup_token);
10945 }
10946
10947 boolean hideSetupEntry(void *setup_value)
10948 {
10949   char *hide_setup_token = getHideSetupToken(setup_value);
10950
10951   return (setup_value != NULL &&
10952           getHashEntry(hide_setup_hash, hide_setup_token) != NULL);
10953 }
10954
10955 static void setSetupInfoFromTokenText(SetupFileHash *setup_file_hash,
10956                                       struct TokenInfo *token_info,
10957                                       int token_nr, char *token_text)
10958 {
10959   char *token_hide_text = getStringCat2(token_text, ".hide");
10960   char *token_hide_value = getHashEntry(setup_file_hash, token_hide_text);
10961
10962   // set the value of this setup option in the setup option structure
10963   setSetupInfo(token_info, token_nr, getHashEntry(setup_file_hash, token_text));
10964
10965   // check if this setup option should be hidden in the setup menu
10966   if (token_hide_value != NULL && get_boolean_from_string(token_hide_value))
10967     setHideSetupEntry(token_info[token_nr].value);
10968
10969   free(token_hide_text);
10970 }
10971
10972 static void setSetupInfoFromTokenInfo(SetupFileHash *setup_file_hash,
10973                                       struct TokenInfo *token_info,
10974                                       int token_nr)
10975 {
10976   setSetupInfoFromTokenText(setup_file_hash, token_info, token_nr,
10977                             token_info[token_nr].text);
10978 }
10979
10980 static void decodeSetupFileHash_Default(SetupFileHash *setup_file_hash)
10981 {
10982   int i, pnr;
10983
10984   if (!setup_file_hash)
10985     return;
10986
10987   for (i = 0; i < ARRAY_SIZE(global_setup_tokens); i++)
10988     setSetupInfoFromTokenInfo(setup_file_hash, global_setup_tokens, i);
10989
10990   setup.touch.grid_initialized = TRUE;
10991   for (i = 0; i < 2; i++)
10992   {
10993     int grid_xsize = setup.touch.grid_xsize[i];
10994     int grid_ysize = setup.touch.grid_ysize[i];
10995     int x, y;
10996
10997     // if virtual buttons are not loaded from setup file, repeat initializing
10998     // virtual buttons grid with default values later when video is initialized
10999     if (grid_xsize == -1 ||
11000         grid_ysize == -1)
11001     {
11002       setup.touch.grid_initialized = FALSE;
11003
11004       continue;
11005     }
11006
11007     for (y = 0; y < grid_ysize; y++)
11008     {
11009       char token_string[MAX_LINE_LEN];
11010
11011       sprintf(token_string, "touch.virtual_buttons.%d.%02d", i, y);
11012
11013       char *value_string = getHashEntry(setup_file_hash, token_string);
11014
11015       if (value_string == NULL)
11016         continue;
11017
11018       for (x = 0; x < grid_xsize; x++)
11019       {
11020         char c = value_string[x];
11021
11022         setup.touch.grid_button[i][x][y] =
11023           (c == '.' ? CHAR_GRID_BUTTON_NONE : c);
11024       }
11025     }
11026   }
11027
11028   for (i = 0; i < ARRAY_SIZE(editor_setup_tokens); i++)
11029     setSetupInfoFromTokenInfo(setup_file_hash, editor_setup_tokens, i);
11030
11031   for (i = 0; i < ARRAY_SIZE(shortcut_setup_tokens); i++)
11032     setSetupInfoFromTokenInfo(setup_file_hash, shortcut_setup_tokens, i);
11033
11034   for (pnr = 0; pnr < MAX_PLAYERS; pnr++)
11035   {
11036     char prefix[30];
11037
11038     sprintf(prefix, "%s%d", TOKEN_STR_PLAYER_PREFIX, pnr + 1);
11039
11040     setup_input = setup.input[pnr];
11041     for (i = 0; i < ARRAY_SIZE(player_setup_tokens); i++)
11042     {
11043       char full_token[100];
11044
11045       sprintf(full_token, "%s%s", prefix, player_setup_tokens[i].text);
11046       setSetupInfoFromTokenText(setup_file_hash, player_setup_tokens, i,
11047                                 full_token);
11048     }
11049     setup.input[pnr] = setup_input;
11050   }
11051
11052   for (i = 0; i < ARRAY_SIZE(system_setup_tokens); i++)
11053     setSetupInfoFromTokenInfo(setup_file_hash, system_setup_tokens, i);
11054
11055   for (i = 0; i < ARRAY_SIZE(internal_setup_tokens); i++)
11056     setSetupInfoFromTokenInfo(setup_file_hash, internal_setup_tokens, i);
11057
11058   for (i = 0; i < ARRAY_SIZE(debug_setup_tokens); i++)
11059     setSetupInfoFromTokenInfo(setup_file_hash, debug_setup_tokens, i);
11060
11061   for (i = 0; i < ARRAY_SIZE(options_setup_tokens); i++)
11062     setSetupInfoFromTokenInfo(setup_file_hash, options_setup_tokens, i);
11063
11064   setHideRelatedSetupEntries();
11065 }
11066
11067 static void decodeSetupFileHash_AutoSetup(SetupFileHash *setup_file_hash)
11068 {
11069   int i;
11070
11071   if (!setup_file_hash)
11072     return;
11073
11074   for (i = 0; i < ARRAY_SIZE(auto_setup_tokens); i++)
11075     setSetupInfo(auto_setup_tokens, i,
11076                  getHashEntry(setup_file_hash,
11077                               auto_setup_tokens[i].text));
11078 }
11079
11080 static void decodeSetupFileHash_ServerSetup(SetupFileHash *setup_file_hash)
11081 {
11082   int i;
11083
11084   if (!setup_file_hash)
11085     return;
11086
11087   for (i = 0; i < ARRAY_SIZE(server_setup_tokens); i++)
11088     setSetupInfo(server_setup_tokens, i,
11089                  getHashEntry(setup_file_hash,
11090                               server_setup_tokens[i].text));
11091 }
11092
11093 static void decodeSetupFileHash_EditorCascade(SetupFileHash *setup_file_hash)
11094 {
11095   int i;
11096
11097   if (!setup_file_hash)
11098     return;
11099
11100   for (i = 0; i < ARRAY_SIZE(editor_cascade_setup_tokens); i++)
11101     setSetupInfo(editor_cascade_setup_tokens, i,
11102                  getHashEntry(setup_file_hash,
11103                               editor_cascade_setup_tokens[i].text));
11104 }
11105
11106 void LoadUserNames(void)
11107 {
11108   int last_user_nr = user.nr;
11109   int i;
11110
11111   if (global.user_names != NULL)
11112   {
11113     for (i = 0; i < MAX_PLAYER_NAMES; i++)
11114       checked_free(global.user_names[i]);
11115
11116     checked_free(global.user_names);
11117   }
11118
11119   global.user_names = checked_calloc(MAX_PLAYER_NAMES * sizeof(char *));
11120
11121   for (i = 0; i < MAX_PLAYER_NAMES; i++)
11122   {
11123     user.nr = i;
11124
11125     SetupFileHash *setup_file_hash = loadSetupFileHash(getSetupFilename());
11126
11127     if (setup_file_hash)
11128     {
11129       char *player_name = getHashEntry(setup_file_hash, "player_name");
11130
11131       global.user_names[i] = getFixedUserName(player_name);
11132
11133       freeSetupFileHash(setup_file_hash);
11134     }
11135
11136     if (global.user_names[i] == NULL)
11137       global.user_names[i] = getStringCopy(getDefaultUserName(i));
11138   }
11139
11140   user.nr = last_user_nr;
11141 }
11142
11143 void LoadSetupFromFilename(char *filename)
11144 {
11145   SetupFileHash *setup_file_hash = loadSetupFileHash(filename);
11146
11147   if (setup_file_hash)
11148   {
11149     decodeSetupFileHash_Default(setup_file_hash);
11150
11151     freeSetupFileHash(setup_file_hash);
11152   }
11153   else
11154   {
11155     Debug("setup", "using default setup values");
11156   }
11157 }
11158
11159 static void LoadSetup_SpecialPostProcessing(void)
11160 {
11161   char *player_name_new;
11162
11163   // needed to work around problems with fixed length strings
11164   player_name_new = getFixedUserName(setup.player_name);
11165   free(setup.player_name);
11166   setup.player_name = player_name_new;
11167
11168   // "scroll_delay: on(3) / off(0)" was replaced by scroll delay value
11169   if (setup.scroll_delay == FALSE)
11170   {
11171     setup.scroll_delay_value = MIN_SCROLL_DELAY;
11172     setup.scroll_delay = TRUE;                  // now always "on"
11173   }
11174
11175   // make sure that scroll delay value stays inside valid range
11176   setup.scroll_delay_value =
11177     MIN(MAX(MIN_SCROLL_DELAY, setup.scroll_delay_value), MAX_SCROLL_DELAY);
11178 }
11179
11180 void LoadSetup_Default(void)
11181 {
11182   char *filename;
11183
11184   // always start with reliable default values
11185   setSetupInfoToDefaults(&setup);
11186
11187   // try to load setup values from default setup file
11188   filename = getDefaultSetupFilename();
11189
11190   if (fileExists(filename))
11191     LoadSetupFromFilename(filename);
11192
11193   // try to load setup values from platform setup file
11194   filename = getPlatformSetupFilename();
11195
11196   if (fileExists(filename))
11197     LoadSetupFromFilename(filename);
11198
11199   // try to load setup values from user setup file
11200   filename = getSetupFilename();
11201
11202   LoadSetupFromFilename(filename);
11203
11204   LoadSetup_SpecialPostProcessing();
11205 }
11206
11207 void LoadSetup_AutoSetup(void)
11208 {
11209   char *filename = getPath2(getSetupDir(), AUTOSETUP_FILENAME);
11210   SetupFileHash *setup_file_hash = NULL;
11211
11212   // always start with reliable default values
11213   setSetupInfoToDefaults_AutoSetup(&setup);
11214
11215   setup_file_hash = loadSetupFileHash(filename);
11216
11217   if (setup_file_hash)
11218   {
11219     decodeSetupFileHash_AutoSetup(setup_file_hash);
11220
11221     freeSetupFileHash(setup_file_hash);
11222   }
11223
11224   free(filename);
11225 }
11226
11227 void LoadSetup_ServerSetup(void)
11228 {
11229   char *filename = getPath2(getSetupDir(), SERVERSETUP_FILENAME);
11230   SetupFileHash *setup_file_hash = NULL;
11231
11232   // always start with reliable default values
11233   setSetupInfoToDefaults_ServerSetup(&setup);
11234
11235   setup_file_hash = loadSetupFileHash(filename);
11236
11237   if (setup_file_hash)
11238   {
11239     decodeSetupFileHash_ServerSetup(setup_file_hash);
11240
11241     freeSetupFileHash(setup_file_hash);
11242   }
11243
11244   free(filename);
11245
11246   if (setup.player_uuid == NULL)
11247   {
11248     // player UUID does not yet exist in setup file
11249     setup.player_uuid = getStringCopy(getUUID());
11250     setup.player_version = 2;
11251
11252     SaveSetup_ServerSetup();
11253   }
11254 }
11255
11256 void LoadSetup_EditorCascade(void)
11257 {
11258   char *filename = getPath2(getSetupDir(), EDITORCASCADE_FILENAME);
11259   SetupFileHash *setup_file_hash = NULL;
11260
11261   // always start with reliable default values
11262   setSetupInfoToDefaults_EditorCascade(&setup);
11263
11264   setup_file_hash = loadSetupFileHash(filename);
11265
11266   if (setup_file_hash)
11267   {
11268     decodeSetupFileHash_EditorCascade(setup_file_hash);
11269
11270     freeSetupFileHash(setup_file_hash);
11271   }
11272
11273   free(filename);
11274 }
11275
11276 void LoadSetup(void)
11277 {
11278   LoadSetup_Default();
11279   LoadSetup_AutoSetup();
11280   LoadSetup_ServerSetup();
11281   LoadSetup_EditorCascade();
11282 }
11283
11284 static void addGameControllerMappingToHash(SetupFileHash *mappings_hash,
11285                                            char *mapping_line)
11286 {
11287   char mapping_guid[MAX_LINE_LEN];
11288   char *mapping_start, *mapping_end;
11289
11290   // get GUID from game controller mapping line: copy complete line
11291   strncpy(mapping_guid, mapping_line, MAX_LINE_LEN - 1);
11292   mapping_guid[MAX_LINE_LEN - 1] = '\0';
11293
11294   // get GUID from game controller mapping line: cut after GUID part
11295   mapping_start = strchr(mapping_guid, ',');
11296   if (mapping_start != NULL)
11297     *mapping_start = '\0';
11298
11299   // cut newline from game controller mapping line
11300   mapping_end = strchr(mapping_line, '\n');
11301   if (mapping_end != NULL)
11302     *mapping_end = '\0';
11303
11304   // add mapping entry to game controller mappings hash
11305   setHashEntry(mappings_hash, mapping_guid, mapping_line);
11306 }
11307
11308 static void LoadSetup_ReadGameControllerMappings(SetupFileHash *mappings_hash,
11309                                                  char *filename)
11310 {
11311   FILE *file;
11312
11313   if (!(file = fopen(filename, MODE_READ)))
11314   {
11315     Warn("cannot read game controller mappings file '%s'", filename);
11316
11317     return;
11318   }
11319
11320   while (!feof(file))
11321   {
11322     char line[MAX_LINE_LEN];
11323
11324     if (!fgets(line, MAX_LINE_LEN, file))
11325       break;
11326
11327     addGameControllerMappingToHash(mappings_hash, line);
11328   }
11329
11330   fclose(file);
11331 }
11332
11333 void SaveSetup_Default(void)
11334 {
11335   char *filename = getSetupFilename();
11336   FILE *file;
11337   int i, pnr;
11338
11339   InitUserDataDirectory();
11340
11341   if (!(file = fopen(filename, MODE_WRITE)))
11342   {
11343     Warn("cannot write setup file '%s'", filename);
11344
11345     return;
11346   }
11347
11348   fprintFileHeader(file, SETUP_FILENAME);
11349
11350   for (i = 0; i < ARRAY_SIZE(global_setup_tokens); i++)
11351   {
11352     // just to make things nicer :)
11353     if (global_setup_tokens[i].value == &setup.multiple_users           ||
11354         global_setup_tokens[i].value == &setup.sound                    ||
11355         global_setup_tokens[i].value == &setup.graphics_set             ||
11356         global_setup_tokens[i].value == &setup.volume_simple            ||
11357         global_setup_tokens[i].value == &setup.network_mode             ||
11358         global_setup_tokens[i].value == &setup.touch.control_type       ||
11359         global_setup_tokens[i].value == &setup.touch.grid_xsize[0]      ||
11360         global_setup_tokens[i].value == &setup.touch.grid_xsize[1])
11361       fprintf(file, "\n");
11362
11363     fprintf(file, "%s\n", getSetupLine(global_setup_tokens, "", i));
11364   }
11365
11366   for (i = 0; i < 2; i++)
11367   {
11368     int grid_xsize = setup.touch.grid_xsize[i];
11369     int grid_ysize = setup.touch.grid_ysize[i];
11370     int x, y;
11371
11372     fprintf(file, "\n");
11373
11374     for (y = 0; y < grid_ysize; y++)
11375     {
11376       char token_string[MAX_LINE_LEN];
11377       char value_string[MAX_LINE_LEN];
11378
11379       sprintf(token_string, "touch.virtual_buttons.%d.%02d", i, y);
11380
11381       for (x = 0; x < grid_xsize; x++)
11382       {
11383         char c = setup.touch.grid_button[i][x][y];
11384
11385         value_string[x] = (c == CHAR_GRID_BUTTON_NONE ? '.' : c);
11386       }
11387
11388       value_string[grid_xsize] = '\0';
11389
11390       fprintf(file, "%s\n", getFormattedSetupEntry(token_string, value_string));
11391     }
11392   }
11393
11394   fprintf(file, "\n");
11395   for (i = 0; i < ARRAY_SIZE(editor_setup_tokens); i++)
11396     fprintf(file, "%s\n", getSetupLine(editor_setup_tokens, "", i));
11397
11398   fprintf(file, "\n");
11399   for (i = 0; i < ARRAY_SIZE(shortcut_setup_tokens); i++)
11400     fprintf(file, "%s\n", getSetupLine(shortcut_setup_tokens, "", i));
11401
11402   for (pnr = 0; pnr < MAX_PLAYERS; pnr++)
11403   {
11404     char prefix[30];
11405
11406     sprintf(prefix, "%s%d", TOKEN_STR_PLAYER_PREFIX, pnr + 1);
11407     fprintf(file, "\n");
11408
11409     setup_input = setup.input[pnr];
11410     for (i = 0; i < ARRAY_SIZE(player_setup_tokens); i++)
11411       fprintf(file, "%s\n", getSetupLine(player_setup_tokens, prefix, i));
11412   }
11413
11414   fprintf(file, "\n");
11415   for (i = 0; i < ARRAY_SIZE(system_setup_tokens); i++)
11416     fprintf(file, "%s\n", getSetupLine(system_setup_tokens, "", i));
11417
11418   // (internal setup values not saved to user setup file)
11419
11420   fprintf(file, "\n");
11421   for (i = 0; i < ARRAY_SIZE(debug_setup_tokens); i++)
11422     if (!strPrefix(debug_setup_tokens[i].text, "debug.xsn_") ||
11423         setup.debug.xsn_mode != AUTO)
11424       fprintf(file, "%s\n", getSetupLine(debug_setup_tokens, "", i));
11425
11426   fprintf(file, "\n");
11427   for (i = 0; i < ARRAY_SIZE(options_setup_tokens); i++)
11428     fprintf(file, "%s\n", getSetupLine(options_setup_tokens, "", i));
11429
11430   fclose(file);
11431
11432   SetFilePermissions(filename, PERMS_PRIVATE);
11433 }
11434
11435 void SaveSetup_AutoSetup(void)
11436 {
11437   char *filename = getPath2(getSetupDir(), AUTOSETUP_FILENAME);
11438   FILE *file;
11439   int i;
11440
11441   InitUserDataDirectory();
11442
11443   if (!(file = fopen(filename, MODE_WRITE)))
11444   {
11445     Warn("cannot write auto setup file '%s'", filename);
11446
11447     free(filename);
11448
11449     return;
11450   }
11451
11452   fprintFileHeader(file, AUTOSETUP_FILENAME);
11453
11454   for (i = 0; i < ARRAY_SIZE(auto_setup_tokens); i++)
11455     fprintf(file, "%s\n", getSetupLine(auto_setup_tokens, "", i));
11456
11457   fclose(file);
11458
11459   SetFilePermissions(filename, PERMS_PRIVATE);
11460
11461   free(filename);
11462 }
11463
11464 void SaveSetup_ServerSetup(void)
11465 {
11466   char *filename = getPath2(getSetupDir(), SERVERSETUP_FILENAME);
11467   FILE *file;
11468   int i;
11469
11470   InitUserDataDirectory();
11471
11472   if (!(file = fopen(filename, MODE_WRITE)))
11473   {
11474     Warn("cannot write server setup file '%s'", filename);
11475
11476     free(filename);
11477
11478     return;
11479   }
11480
11481   fprintFileHeader(file, SERVERSETUP_FILENAME);
11482
11483   for (i = 0; i < ARRAY_SIZE(server_setup_tokens); i++)
11484   {
11485     // just to make things nicer :)
11486     if (server_setup_tokens[i].value == &setup.use_api_server)
11487       fprintf(file, "\n");
11488
11489     fprintf(file, "%s\n", getSetupLine(server_setup_tokens, "", i));
11490   }
11491
11492   fclose(file);
11493
11494   SetFilePermissions(filename, PERMS_PRIVATE);
11495
11496   free(filename);
11497 }
11498
11499 void SaveSetup_EditorCascade(void)
11500 {
11501   char *filename = getPath2(getSetupDir(), EDITORCASCADE_FILENAME);
11502   FILE *file;
11503   int i;
11504
11505   InitUserDataDirectory();
11506
11507   if (!(file = fopen(filename, MODE_WRITE)))
11508   {
11509     Warn("cannot write editor cascade state file '%s'", filename);
11510
11511     free(filename);
11512
11513     return;
11514   }
11515
11516   fprintFileHeader(file, EDITORCASCADE_FILENAME);
11517
11518   for (i = 0; i < ARRAY_SIZE(editor_cascade_setup_tokens); i++)
11519     fprintf(file, "%s\n", getSetupLine(editor_cascade_setup_tokens, "", i));
11520
11521   fclose(file);
11522
11523   SetFilePermissions(filename, PERMS_PRIVATE);
11524
11525   free(filename);
11526 }
11527
11528 void SaveSetup(void)
11529 {
11530   SaveSetup_Default();
11531   SaveSetup_AutoSetup();
11532   SaveSetup_ServerSetup();
11533   SaveSetup_EditorCascade();
11534 }
11535
11536 static void SaveSetup_WriteGameControllerMappings(SetupFileHash *mappings_hash,
11537                                                   char *filename)
11538 {
11539   FILE *file;
11540
11541   if (!(file = fopen(filename, MODE_WRITE)))
11542   {
11543     Warn("cannot write game controller mappings file '%s'", filename);
11544
11545     return;
11546   }
11547
11548   BEGIN_HASH_ITERATION(mappings_hash, itr)
11549   {
11550     fprintf(file, "%s\n", HASH_ITERATION_VALUE(itr));
11551   }
11552   END_HASH_ITERATION(mappings_hash, itr)
11553
11554   fclose(file);
11555 }
11556
11557 void SaveSetup_AddGameControllerMapping(char *mapping)
11558 {
11559   char *filename = getPath2(getSetupDir(), GAMECONTROLLER_BASENAME);
11560   SetupFileHash *mappings_hash = newSetupFileHash();
11561
11562   InitUserDataDirectory();
11563
11564   // load existing personal game controller mappings
11565   LoadSetup_ReadGameControllerMappings(mappings_hash, filename);
11566
11567   // add new mapping to personal game controller mappings
11568   addGameControllerMappingToHash(mappings_hash, mapping);
11569
11570   // save updated personal game controller mappings
11571   SaveSetup_WriteGameControllerMappings(mappings_hash, filename);
11572
11573   freeSetupFileHash(mappings_hash);
11574   free(filename);
11575 }
11576
11577 void LoadCustomElementDescriptions(void)
11578 {
11579   char *filename = getCustomArtworkConfigFilename(ARTWORK_TYPE_GRAPHICS);
11580   SetupFileHash *setup_file_hash;
11581   int i;
11582
11583   for (i = 0; i < NUM_FILE_ELEMENTS; i++)
11584   {
11585     if (element_info[i].custom_description != NULL)
11586     {
11587       free(element_info[i].custom_description);
11588       element_info[i].custom_description = NULL;
11589     }
11590   }
11591
11592   if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
11593     return;
11594
11595   for (i = 0; i < NUM_FILE_ELEMENTS; i++)
11596   {
11597     char *token = getStringCat2(element_info[i].token_name, ".name");
11598     char *value = getHashEntry(setup_file_hash, token);
11599
11600     if (value != NULL)
11601       element_info[i].custom_description = getStringCopy(value);
11602
11603     free(token);
11604   }
11605
11606   freeSetupFileHash(setup_file_hash);
11607 }
11608
11609 static int getElementFromToken(char *token)
11610 {
11611   char *value = getHashEntry(element_token_hash, token);
11612
11613   if (value != NULL)
11614     return atoi(value);
11615
11616   Warn("unknown element token '%s'", token);
11617
11618   return EL_UNDEFINED;
11619 }
11620
11621 void FreeGlobalAnimEventInfo(void)
11622 {
11623   struct GlobalAnimEventInfo *gaei = &global_anim_event_info;
11624
11625   if (gaei->event_list == NULL)
11626     return;
11627
11628   int i;
11629
11630   for (i = 0; i < gaei->num_event_lists; i++)
11631   {
11632     checked_free(gaei->event_list[i]->event_value);
11633     checked_free(gaei->event_list[i]);
11634   }
11635
11636   checked_free(gaei->event_list);
11637
11638   gaei->event_list = NULL;
11639   gaei->num_event_lists = 0;
11640 }
11641
11642 static int AddGlobalAnimEventList(void)
11643 {
11644   struct GlobalAnimEventInfo *gaei = &global_anim_event_info;
11645   int list_pos = gaei->num_event_lists++;
11646
11647   gaei->event_list = checked_realloc(gaei->event_list, gaei->num_event_lists *
11648                                      sizeof(struct GlobalAnimEventListInfo *));
11649
11650   gaei->event_list[list_pos] =
11651     checked_calloc(sizeof(struct GlobalAnimEventListInfo));
11652
11653   struct GlobalAnimEventListInfo *gaeli = gaei->event_list[list_pos];
11654
11655   gaeli->event_value = NULL;
11656   gaeli->num_event_values = 0;
11657
11658   return list_pos;
11659 }
11660
11661 static int AddGlobalAnimEventValue(int list_pos, int event_value)
11662 {
11663   // do not add empty global animation events
11664   if (event_value == ANIM_EVENT_NONE)
11665     return list_pos;
11666
11667   // if list position is undefined, create new list
11668   if (list_pos == ANIM_EVENT_UNDEFINED)
11669     list_pos = AddGlobalAnimEventList();
11670
11671   struct GlobalAnimEventInfo *gaei = &global_anim_event_info;
11672   struct GlobalAnimEventListInfo *gaeli = gaei->event_list[list_pos];
11673   int value_pos = gaeli->num_event_values++;
11674
11675   gaeli->event_value = checked_realloc(gaeli->event_value,
11676                                        gaeli->num_event_values * sizeof(int *));
11677
11678   gaeli->event_value[value_pos] = event_value;
11679
11680   return list_pos;
11681 }
11682
11683 int GetGlobalAnimEventValue(int list_pos, int value_pos)
11684 {
11685   if (list_pos == ANIM_EVENT_UNDEFINED)
11686     return ANIM_EVENT_NONE;
11687
11688   struct GlobalAnimEventInfo *gaei = &global_anim_event_info;
11689   struct GlobalAnimEventListInfo *gaeli = gaei->event_list[list_pos];
11690
11691   return gaeli->event_value[value_pos];
11692 }
11693
11694 int GetGlobalAnimEventValueCount(int list_pos)
11695 {
11696   if (list_pos == ANIM_EVENT_UNDEFINED)
11697     return 0;
11698
11699   struct GlobalAnimEventInfo *gaei = &global_anim_event_info;
11700   struct GlobalAnimEventListInfo *gaeli = gaei->event_list[list_pos];
11701
11702   return gaeli->num_event_values;
11703 }
11704
11705 // This function checks if a string <s> of the format "string1, string2, ..."
11706 // exactly contains a string <s_contained>.
11707
11708 static boolean string_has_parameter(char *s, char *s_contained)
11709 {
11710   char *substring;
11711
11712   if (s == NULL || s_contained == NULL)
11713     return FALSE;
11714
11715   if (strlen(s_contained) > strlen(s))
11716     return FALSE;
11717
11718   if (strncmp(s, s_contained, strlen(s_contained)) == 0)
11719   {
11720     char next_char = s[strlen(s_contained)];
11721
11722     // check if next character is delimiter or whitespace
11723     if (next_char == ',' || next_char == '\0' ||
11724         next_char == ' ' || next_char == '\t')
11725       return TRUE;
11726   }
11727
11728   // check if string contains another parameter string after a comma
11729   substring = strchr(s, ',');
11730   if (substring == NULL)        // string does not contain a comma
11731     return FALSE;
11732
11733   // advance string pointer to next character after the comma
11734   substring++;
11735
11736   // skip potential whitespaces after the comma
11737   while (*substring == ' ' || *substring == '\t')
11738     substring++;
11739
11740   return string_has_parameter(substring, s_contained);
11741 }
11742
11743 static int get_anim_parameter_value_ce(char *s)
11744 {
11745   char *s_ptr = s;
11746   char *pattern_1 = "ce_change:custom_";
11747   char *pattern_2 = ".page_";
11748   int pattern_1_len = strlen(pattern_1);
11749   char *matching_char = strstr(s_ptr, pattern_1);
11750   int result = ANIM_EVENT_NONE;
11751
11752   if (matching_char == NULL)
11753     return ANIM_EVENT_NONE;
11754
11755   result = ANIM_EVENT_CE_CHANGE;
11756
11757   s_ptr = matching_char + pattern_1_len;
11758
11759   // check for custom element number ("custom_X", "custom_XX" or "custom_XXX")
11760   if (*s_ptr >= '0' && *s_ptr <= '9')
11761   {
11762     int gic_ce_nr = (*s_ptr++ - '0');
11763
11764     if (*s_ptr >= '0' && *s_ptr <= '9')
11765     {
11766       gic_ce_nr = 10 * gic_ce_nr + (*s_ptr++ - '0');
11767
11768       if (*s_ptr >= '0' && *s_ptr <= '9')
11769         gic_ce_nr = 10 * gic_ce_nr + (*s_ptr++ - '0');
11770     }
11771
11772     if (gic_ce_nr < 1 || gic_ce_nr > NUM_CUSTOM_ELEMENTS)
11773       return ANIM_EVENT_NONE;
11774
11775     // custom element stored as 0 to 255
11776     gic_ce_nr--;
11777
11778     result |= gic_ce_nr << ANIM_EVENT_CE_BIT;
11779   }
11780   else
11781   {
11782     // invalid custom element number specified
11783
11784     return ANIM_EVENT_NONE;
11785   }
11786
11787   // check for change page number ("page_X" or "page_XX") (optional)
11788   if (strPrefix(s_ptr, pattern_2))
11789   {
11790     s_ptr += strlen(pattern_2);
11791
11792     if (*s_ptr >= '0' && *s_ptr <= '9')
11793     {
11794       int gic_page_nr = (*s_ptr++ - '0');
11795
11796       if (*s_ptr >= '0' && *s_ptr <= '9')
11797         gic_page_nr = 10 * gic_page_nr + (*s_ptr++ - '0');
11798
11799       if (gic_page_nr < 1 || gic_page_nr > MAX_CHANGE_PAGES)
11800         return ANIM_EVENT_NONE;
11801
11802       // change page stored as 1 to 32 (0 means "all change pages")
11803
11804       result |= gic_page_nr << ANIM_EVENT_PAGE_BIT;
11805     }
11806     else
11807     {
11808       // invalid animation part number specified
11809
11810       return ANIM_EVENT_NONE;
11811     }
11812   }
11813
11814   // discard result if next character is neither delimiter nor whitespace
11815   if (!(*s_ptr == ',' || *s_ptr == '\0' ||
11816         *s_ptr == ' ' || *s_ptr == '\t'))
11817     return ANIM_EVENT_NONE;
11818
11819   return result;
11820 }
11821
11822 static int get_anim_parameter_value(char *s)
11823 {
11824   int event_value[] =
11825   {
11826     ANIM_EVENT_CLICK,
11827     ANIM_EVENT_INIT,
11828     ANIM_EVENT_START,
11829     ANIM_EVENT_END,
11830     ANIM_EVENT_POST
11831   };
11832   char *pattern_1[] =
11833   {
11834     "click:anim_",
11835     "init:anim_",
11836     "start:anim_",
11837     "end:anim_",
11838     "post:anim_"
11839   };
11840   char *pattern_2 = ".part_";
11841   char *matching_char = NULL;
11842   char *s_ptr = s;
11843   int pattern_1_len = 0;
11844   int result = ANIM_EVENT_NONE;
11845   int i;
11846
11847   result = get_anim_parameter_value_ce(s);
11848
11849   if (result != ANIM_EVENT_NONE)
11850     return result;
11851
11852   for (i = 0; i < ARRAY_SIZE(event_value); i++)
11853   {
11854     matching_char = strstr(s_ptr, pattern_1[i]);
11855     pattern_1_len = strlen(pattern_1[i]);
11856     result = event_value[i];
11857
11858     if (matching_char != NULL)
11859       break;
11860   }
11861
11862   if (matching_char == NULL)
11863     return ANIM_EVENT_NONE;
11864
11865   s_ptr = matching_char + pattern_1_len;
11866
11867   // check for main animation number ("anim_X" or "anim_XX")
11868   if (*s_ptr >= '0' && *s_ptr <= '9')
11869   {
11870     int gic_anim_nr = (*s_ptr++ - '0');
11871
11872     if (*s_ptr >= '0' && *s_ptr <= '9')
11873       gic_anim_nr = 10 * gic_anim_nr + (*s_ptr++ - '0');
11874
11875     if (gic_anim_nr < 1 || gic_anim_nr > MAX_GLOBAL_ANIMS)
11876       return ANIM_EVENT_NONE;
11877
11878     result |= gic_anim_nr << ANIM_EVENT_ANIM_BIT;
11879   }
11880   else
11881   {
11882     // invalid main animation number specified
11883
11884     return ANIM_EVENT_NONE;
11885   }
11886
11887   // check for animation part number ("part_X" or "part_XX") (optional)
11888   if (strPrefix(s_ptr, pattern_2))
11889   {
11890     s_ptr += strlen(pattern_2);
11891
11892     if (*s_ptr >= '0' && *s_ptr <= '9')
11893     {
11894       int gic_part_nr = (*s_ptr++ - '0');
11895
11896       if (*s_ptr >= '0' && *s_ptr <= '9')
11897         gic_part_nr = 10 * gic_part_nr + (*s_ptr++ - '0');
11898
11899       if (gic_part_nr < 1 || gic_part_nr > MAX_GLOBAL_ANIM_PARTS)
11900         return ANIM_EVENT_NONE;
11901
11902       result |= gic_part_nr << ANIM_EVENT_PART_BIT;
11903     }
11904     else
11905     {
11906       // invalid animation part number specified
11907
11908       return ANIM_EVENT_NONE;
11909     }
11910   }
11911
11912   // discard result if next character is neither delimiter nor whitespace
11913   if (!(*s_ptr == ',' || *s_ptr == '\0' ||
11914         *s_ptr == ' ' || *s_ptr == '\t'))
11915     return ANIM_EVENT_NONE;
11916
11917   return result;
11918 }
11919
11920 static int get_anim_parameter_values(char *s)
11921 {
11922   int list_pos = ANIM_EVENT_UNDEFINED;
11923   int event_value = ANIM_EVENT_DEFAULT;
11924
11925   if (string_has_parameter(s, "any"))
11926     event_value |= ANIM_EVENT_ANY;
11927
11928   if (string_has_parameter(s, "click:self") ||
11929       string_has_parameter(s, "click") ||
11930       string_has_parameter(s, "self"))
11931     event_value |= ANIM_EVENT_SELF;
11932
11933   if (string_has_parameter(s, "unclick:any"))
11934     event_value |= ANIM_EVENT_UNCLICK_ANY;
11935
11936   // if animation event found, add it to global animation event list
11937   if (event_value != ANIM_EVENT_NONE)
11938     list_pos = AddGlobalAnimEventValue(list_pos, event_value);
11939
11940   while (s != NULL)
11941   {
11942     // add optional "click:anim_X" or "click:anim_X.part_X" parameter
11943     event_value = get_anim_parameter_value(s);
11944
11945     // if animation event found, add it to global animation event list
11946     if (event_value != ANIM_EVENT_NONE)
11947       list_pos = AddGlobalAnimEventValue(list_pos, event_value);
11948
11949     // continue with next part of the string, starting with next comma
11950     s = strchr(s + 1, ',');
11951   }
11952
11953   return list_pos;
11954 }
11955
11956 static int get_anim_action_parameter_value(char *token)
11957 {
11958   // check most common default case first to massively speed things up
11959   if (strEqual(token, ARG_UNDEFINED))
11960     return ANIM_EVENT_ACTION_NONE;
11961
11962   int result = getImageIDFromToken(token);
11963
11964   if (result == -1)
11965   {
11966     char *gfx_token = getStringCat2("gfx.", token);
11967
11968     result = getImageIDFromToken(gfx_token);
11969
11970     checked_free(gfx_token);
11971   }
11972
11973   if (result == -1)
11974   {
11975     Key key = getKeyFromX11KeyName(token);
11976
11977     if (key != KSYM_UNDEFINED)
11978       result = -(int)key;
11979   }
11980
11981   if (result == -1)
11982   {
11983     if (isURL(token))
11984     {
11985       result = get_hash_from_string(token);     // unsigned int => int
11986       result = ABS(result);                     // may be negative now
11987       result += (result < MAX_IMAGE_FILES ? MAX_IMAGE_FILES : 0);
11988
11989       setHashEntry(anim_url_hash, int2str(result, 0), token);
11990     }
11991   }
11992
11993   if (result == -1)
11994     result = ANIM_EVENT_ACTION_NONE;
11995
11996   return result;
11997 }
11998
11999 int get_parameter_value(char *value_raw, char *suffix, int type)
12000 {
12001   char *value = getStringToLower(value_raw);
12002   int result = 0;       // probably a save default value
12003
12004   if (strEqual(suffix, ".direction"))
12005   {
12006     result = (strEqual(value, "left")  ? MV_LEFT :
12007               strEqual(value, "right") ? MV_RIGHT :
12008               strEqual(value, "up")    ? MV_UP :
12009               strEqual(value, "down")  ? MV_DOWN : MV_NONE);
12010   }
12011   else if (strEqual(suffix, ".position"))
12012   {
12013     result = (strEqual(value, "left")   ? POS_LEFT :
12014               strEqual(value, "right")  ? POS_RIGHT :
12015               strEqual(value, "top")    ? POS_TOP :
12016               strEqual(value, "upper")  ? POS_UPPER :
12017               strEqual(value, "middle") ? POS_MIDDLE :
12018               strEqual(value, "lower")  ? POS_LOWER :
12019               strEqual(value, "bottom") ? POS_BOTTOM :
12020               strEqual(value, "any")    ? POS_ANY :
12021               strEqual(value, "ce")     ? POS_CE :
12022               strEqual(value, "ce_trigger") ? POS_CE_TRIGGER :
12023               strEqual(value, "last")   ? POS_LAST : POS_UNDEFINED);
12024   }
12025   else if (strEqual(suffix, ".align"))
12026   {
12027     result = (strEqual(value, "left")   ? ALIGN_LEFT :
12028               strEqual(value, "right")  ? ALIGN_RIGHT :
12029               strEqual(value, "center") ? ALIGN_CENTER :
12030               strEqual(value, "middle") ? ALIGN_CENTER : ALIGN_DEFAULT);
12031   }
12032   else if (strEqual(suffix, ".valign"))
12033   {
12034     result = (strEqual(value, "top")    ? VALIGN_TOP :
12035               strEqual(value, "bottom") ? VALIGN_BOTTOM :
12036               strEqual(value, "middle") ? VALIGN_MIDDLE :
12037               strEqual(value, "center") ? VALIGN_MIDDLE : VALIGN_DEFAULT);
12038   }
12039   else if (strEqual(suffix, ".anim_mode"))
12040   {
12041     result = (string_has_parameter(value, "none")       ? ANIM_NONE :
12042               string_has_parameter(value, "loop")       ? ANIM_LOOP :
12043               string_has_parameter(value, "linear")     ? ANIM_LINEAR :
12044               string_has_parameter(value, "pingpong")   ? ANIM_PINGPONG :
12045               string_has_parameter(value, "pingpong2")  ? ANIM_PINGPONG2 :
12046               string_has_parameter(value, "random")     ? ANIM_RANDOM :
12047               string_has_parameter(value, "random_static") ? ANIM_RANDOM_STATIC :
12048               string_has_parameter(value, "ce_value")   ? ANIM_CE_VALUE :
12049               string_has_parameter(value, "ce_score")   ? ANIM_CE_SCORE :
12050               string_has_parameter(value, "ce_delay")   ? ANIM_CE_DELAY :
12051               string_has_parameter(value, "horizontal") ? ANIM_HORIZONTAL :
12052               string_has_parameter(value, "vertical")   ? ANIM_VERTICAL :
12053               string_has_parameter(value, "centered")   ? ANIM_CENTERED :
12054               string_has_parameter(value, "all")        ? ANIM_ALL :
12055               string_has_parameter(value, "tiled")      ? ANIM_TILED :
12056               string_has_parameter(value, "level_nr")   ? ANIM_LEVEL_NR :
12057               ANIM_DEFAULT);
12058
12059     if (string_has_parameter(value, "once"))
12060       result |= ANIM_ONCE;
12061
12062     if (string_has_parameter(value, "reverse"))
12063       result |= ANIM_REVERSE;
12064
12065     if (string_has_parameter(value, "opaque_player"))
12066       result |= ANIM_OPAQUE_PLAYER;
12067
12068     if (string_has_parameter(value, "static_panel"))
12069       result |= ANIM_STATIC_PANEL;
12070   }
12071   else if (strEqual(suffix, ".init_event") ||
12072            strEqual(suffix, ".anim_event"))
12073   {
12074     result = get_anim_parameter_values(value);
12075   }
12076   else if (strEqual(suffix, ".init_delay_action") ||
12077            strEqual(suffix, ".anim_delay_action") ||
12078            strEqual(suffix, ".post_delay_action") ||
12079            strEqual(suffix, ".init_event_action") ||
12080            strEqual(suffix, ".anim_event_action"))
12081   {
12082     result = get_anim_action_parameter_value(value_raw);
12083   }
12084   else if (strEqual(suffix, ".class"))
12085   {
12086     result = (strEqual(value, ARG_UNDEFINED) ? ARG_UNDEFINED_VALUE :
12087               get_hash_from_string(value));
12088   }
12089   else if (strEqual(suffix, ".style"))
12090   {
12091     result = STYLE_DEFAULT;
12092
12093     if (string_has_parameter(value, "accurate_borders"))
12094       result |= STYLE_ACCURATE_BORDERS;
12095
12096     if (string_has_parameter(value, "inner_corners"))
12097       result |= STYLE_INNER_CORNERS;
12098
12099     if (string_has_parameter(value, "reverse"))
12100       result |= STYLE_REVERSE;
12101
12102     if (string_has_parameter(value, "leftmost_position"))
12103       result |= STYLE_LEFTMOST_POSITION;
12104
12105     if (string_has_parameter(value, "block_clicks"))
12106       result |= STYLE_BLOCK;
12107
12108     if (string_has_parameter(value, "passthrough_clicks"))
12109       result |= STYLE_PASSTHROUGH;
12110
12111     if (string_has_parameter(value, "multiple_actions"))
12112       result |= STYLE_MULTIPLE_ACTIONS;
12113
12114     if (string_has_parameter(value, "consume_ce_event"))
12115       result |= STYLE_CONSUME_CE_EVENT;
12116   }
12117   else if (strEqual(suffix, ".fade_mode"))
12118   {
12119     result = (string_has_parameter(value, "none")       ? FADE_MODE_NONE :
12120               string_has_parameter(value, "fade")       ? FADE_MODE_FADE :
12121               string_has_parameter(value, "fade_in")    ? FADE_MODE_FADE_IN :
12122               string_has_parameter(value, "fade_out")   ? FADE_MODE_FADE_OUT :
12123               string_has_parameter(value, "crossfade")  ? FADE_MODE_CROSSFADE :
12124               string_has_parameter(value, "melt")       ? FADE_MODE_MELT :
12125               string_has_parameter(value, "curtain")    ? FADE_MODE_CURTAIN :
12126               FADE_MODE_DEFAULT);
12127   }
12128   else if (strEqual(suffix, ".auto_delay_unit"))
12129   {
12130     result = (string_has_parameter(value, "ms")     ? AUTO_DELAY_UNIT_MS :
12131               string_has_parameter(value, "frames") ? AUTO_DELAY_UNIT_FRAMES :
12132               AUTO_DELAY_UNIT_DEFAULT);
12133   }
12134   else if (strPrefix(suffix, ".font"))          // (may also be ".font_xyz")
12135   {
12136     result = gfx.get_font_from_token_function(value);
12137   }
12138   else          // generic parameter of type integer or boolean
12139   {
12140     result = (strEqual(value, ARG_UNDEFINED) ? ARG_UNDEFINED_VALUE :
12141               type == TYPE_INTEGER ? get_integer_from_string(value) :
12142               type == TYPE_BOOLEAN ? get_boolean_from_string(value) :
12143               ARG_UNDEFINED_VALUE);
12144   }
12145
12146   free(value);
12147
12148   return result;
12149 }
12150
12151 static int get_token_parameter_value(char *token, char *value_raw)
12152 {
12153   char *suffix;
12154
12155   if (token == NULL || value_raw == NULL)
12156     return ARG_UNDEFINED_VALUE;
12157
12158   suffix = strrchr(token, '.');
12159   if (suffix == NULL)
12160     suffix = token;
12161
12162   if (strEqual(suffix, ".element"))
12163     return getElementFromToken(value_raw);
12164
12165   // !!! USE CORRECT VALUE TYPE (currently works also for TYPE_BOOLEAN) !!!
12166   return get_parameter_value(value_raw, suffix, TYPE_INTEGER);
12167 }
12168
12169 void InitMenuDesignSettings_FromHash(SetupFileHash *setup_file_hash,
12170                                      boolean ignore_defaults)
12171 {
12172   int i;
12173
12174   for (i = 0; image_config_vars[i].token != NULL; i++)
12175   {
12176     char *value = getHashEntry(setup_file_hash, image_config_vars[i].token);
12177
12178     // (ignore definitions set to "[DEFAULT]" which are already initialized)
12179     if (ignore_defaults && strEqual(value, ARG_DEFAULT))
12180       continue;
12181
12182     if (value != NULL)
12183       *image_config_vars[i].value =
12184         get_token_parameter_value(image_config_vars[i].token, value);
12185   }
12186 }
12187
12188 void InitMenuDesignSettings_Static(void)
12189 {
12190   // always start with reliable default values from static default config
12191   InitMenuDesignSettings_FromHash(image_config_hash, FALSE);
12192 }
12193
12194 static void InitMenuDesignSettings_SpecialPreProcessing(void)
12195 {
12196   int i;
12197
12198   // the following initializes hierarchical values from static configuration
12199
12200   // special case: initialize "ARG_DEFAULT" values in static default config
12201   // (e.g., initialize "[titlemessage].fade_mode" from "[title].fade_mode")
12202   titlescreen_initial_first_default.fade_mode  =
12203     title_initial_first_default.fade_mode;
12204   titlescreen_initial_first_default.fade_delay =
12205     title_initial_first_default.fade_delay;
12206   titlescreen_initial_first_default.post_delay =
12207     title_initial_first_default.post_delay;
12208   titlescreen_initial_first_default.auto_delay =
12209     title_initial_first_default.auto_delay;
12210   titlescreen_initial_first_default.auto_delay_unit =
12211     title_initial_first_default.auto_delay_unit;
12212   titlescreen_first_default.fade_mode  = title_first_default.fade_mode;
12213   titlescreen_first_default.fade_delay = title_first_default.fade_delay;
12214   titlescreen_first_default.post_delay = title_first_default.post_delay;
12215   titlescreen_first_default.auto_delay = title_first_default.auto_delay;
12216   titlescreen_first_default.auto_delay_unit =
12217     title_first_default.auto_delay_unit;
12218   titlemessage_initial_first_default.fade_mode  =
12219     title_initial_first_default.fade_mode;
12220   titlemessage_initial_first_default.fade_delay =
12221     title_initial_first_default.fade_delay;
12222   titlemessage_initial_first_default.post_delay =
12223     title_initial_first_default.post_delay;
12224   titlemessage_initial_first_default.auto_delay =
12225     title_initial_first_default.auto_delay;
12226   titlemessage_initial_first_default.auto_delay_unit =
12227     title_initial_first_default.auto_delay_unit;
12228   titlemessage_first_default.fade_mode  = title_first_default.fade_mode;
12229   titlemessage_first_default.fade_delay = title_first_default.fade_delay;
12230   titlemessage_first_default.post_delay = title_first_default.post_delay;
12231   titlemessage_first_default.auto_delay = title_first_default.auto_delay;
12232   titlemessage_first_default.auto_delay_unit =
12233     title_first_default.auto_delay_unit;
12234
12235   titlescreen_initial_default.fade_mode  = title_initial_default.fade_mode;
12236   titlescreen_initial_default.fade_delay = title_initial_default.fade_delay;
12237   titlescreen_initial_default.post_delay = title_initial_default.post_delay;
12238   titlescreen_initial_default.auto_delay = title_initial_default.auto_delay;
12239   titlescreen_initial_default.auto_delay_unit =
12240     title_initial_default.auto_delay_unit;
12241   titlescreen_default.fade_mode  = title_default.fade_mode;
12242   titlescreen_default.fade_delay = title_default.fade_delay;
12243   titlescreen_default.post_delay = title_default.post_delay;
12244   titlescreen_default.auto_delay = title_default.auto_delay;
12245   titlescreen_default.auto_delay_unit = title_default.auto_delay_unit;
12246   titlemessage_initial_default.fade_mode  = title_initial_default.fade_mode;
12247   titlemessage_initial_default.fade_delay = title_initial_default.fade_delay;
12248   titlemessage_initial_default.post_delay = title_initial_default.post_delay;
12249   titlemessage_initial_default.auto_delay_unit =
12250     title_initial_default.auto_delay_unit;
12251   titlemessage_default.fade_mode  = title_default.fade_mode;
12252   titlemessage_default.fade_delay = title_default.fade_delay;
12253   titlemessage_default.post_delay = title_default.post_delay;
12254   titlemessage_default.auto_delay = title_default.auto_delay;
12255   titlemessage_default.auto_delay_unit = title_default.auto_delay_unit;
12256
12257   // special case: initialize "ARG_DEFAULT" values in static default config
12258   // (e.g., init "titlemessage_1.fade_mode" from "[titlemessage].fade_mode")
12259   for (i = 0; i < MAX_NUM_TITLE_MESSAGES; i++)
12260   {
12261     titlescreen_initial_first[i] = titlescreen_initial_first_default;
12262     titlescreen_first[i] = titlescreen_first_default;
12263     titlemessage_initial_first[i] = titlemessage_initial_first_default;
12264     titlemessage_first[i] = titlemessage_first_default;
12265
12266     titlescreen_initial[i] = titlescreen_initial_default;
12267     titlescreen[i] = titlescreen_default;
12268     titlemessage_initial[i] = titlemessage_initial_default;
12269     titlemessage[i] = titlemessage_default;
12270   }
12271
12272   // special case: initialize "ARG_DEFAULT" values in static default config
12273   // (eg, init "menu.enter_screen.SCORES.xyz" from "menu.enter_screen.xyz")
12274   for (i = 0; i < NUM_SPECIAL_GFX_ARGS; i++)
12275   {
12276     if (i == GFX_SPECIAL_ARG_TITLE)     // title values already initialized
12277       continue;
12278
12279     menu.enter_screen[i] = menu.enter_screen[GFX_SPECIAL_ARG_DEFAULT];
12280     menu.leave_screen[i] = menu.leave_screen[GFX_SPECIAL_ARG_DEFAULT];
12281     menu.next_screen[i]  = menu.next_screen[GFX_SPECIAL_ARG_DEFAULT];
12282   }
12283
12284   // special case: initialize "ARG_DEFAULT" values in static default config
12285   // (eg, init "viewport.door_1.MAIN.xyz" from "viewport.door_1.xyz")
12286   for (i = 0; i < NUM_SPECIAL_GFX_ARGS; i++)
12287   {
12288     viewport.window[i]    = viewport.window[GFX_SPECIAL_ARG_DEFAULT];
12289     viewport.playfield[i] = viewport.playfield[GFX_SPECIAL_ARG_DEFAULT];
12290     viewport.door_1[i]    = viewport.door_1[GFX_SPECIAL_ARG_DEFAULT];
12291
12292     if (i == GFX_SPECIAL_ARG_EDITOR)    // editor values already initialized
12293       continue;
12294
12295     viewport.door_2[i] = viewport.door_2[GFX_SPECIAL_ARG_DEFAULT];
12296   }
12297 }
12298
12299 static void InitMenuDesignSettings_SpecialPostProcessing(void)
12300 {
12301   static struct
12302   {
12303     struct XY *dst, *src;
12304   }
12305   game_buttons_xy[] =
12306   {
12307     { &game.button.save,        &game.button.stop       },
12308     { &game.button.pause2,      &game.button.pause      },
12309     { &game.button.load,        &game.button.play       },
12310     { &game.button.undo,        &game.button.stop       },
12311     { &game.button.redo,        &game.button.play       },
12312
12313     { NULL,                     NULL                    }
12314   };
12315   int i, j;
12316
12317   // special case: initialize later added SETUP list size from LEVELS value
12318   if (menu.list_size[GAME_MODE_SETUP] == -1)
12319     menu.list_size[GAME_MODE_SETUP] = menu.list_size[GAME_MODE_LEVELS];
12320
12321   // set default position for snapshot buttons to stop/pause/play buttons
12322   for (i = 0; game_buttons_xy[i].dst != NULL; i++)
12323     if ((*game_buttons_xy[i].dst).x == -1 &&
12324         (*game_buttons_xy[i].dst).y == -1)
12325       *game_buttons_xy[i].dst = *game_buttons_xy[i].src;
12326
12327   // --------------------------------------------------------------------------
12328   // dynamic viewports (including playfield margins, borders and alignments)
12329   // --------------------------------------------------------------------------
12330
12331   // dynamic viewports currently only supported for landscape mode
12332   int display_width  = MAX(video.display_width, video.display_height);
12333   int display_height = MIN(video.display_width, video.display_height);
12334
12335   for (i = 0; i < NUM_SPECIAL_GFX_ARGS; i++)
12336   {
12337     struct RectWithBorder *vp_window    = &viewport.window[i];
12338     struct RectWithBorder *vp_playfield = &viewport.playfield[i];
12339     struct RectWithBorder *vp_door_1    = &viewport.door_1[i];
12340     struct RectWithBorder *vp_door_2    = &viewport.door_2[i];
12341     boolean dynamic_window_width     = (vp_window->min_width     != -1);
12342     boolean dynamic_window_height    = (vp_window->min_height    != -1);
12343     boolean dynamic_playfield_width  = (vp_playfield->min_width  != -1);
12344     boolean dynamic_playfield_height = (vp_playfield->min_height != -1);
12345
12346     // adjust window size if min/max width/height is specified
12347
12348     if (vp_window->min_width != -1)
12349     {
12350       int window_width = display_width;
12351
12352       // when using static window height, use aspect ratio of display
12353       if (vp_window->min_height == -1)
12354         window_width = vp_window->height * display_width / display_height;
12355
12356       vp_window->width = MAX(vp_window->min_width, window_width);
12357     }
12358
12359     if (vp_window->min_height != -1)
12360     {
12361       int window_height = display_height;
12362
12363       // when using static window width, use aspect ratio of display
12364       if (vp_window->min_width == -1)
12365         window_height = vp_window->width * display_height / display_width;
12366
12367       vp_window->height = MAX(vp_window->min_height, window_height);
12368     }
12369
12370     if (vp_window->max_width != -1)
12371       vp_window->width = MIN(vp_window->width, vp_window->max_width);
12372
12373     if (vp_window->max_height != -1)
12374       vp_window->height = MIN(vp_window->height, vp_window->max_height);
12375
12376     int playfield_width  = vp_window->width;
12377     int playfield_height = vp_window->height;
12378
12379     // adjust playfield size and position according to specified margins
12380
12381     playfield_width  -= vp_playfield->margin_left;
12382     playfield_width  -= vp_playfield->margin_right;
12383
12384     playfield_height -= vp_playfield->margin_top;
12385     playfield_height -= vp_playfield->margin_bottom;
12386
12387     // adjust playfield size if min/max width/height is specified
12388
12389     if (vp_playfield->min_width != -1)
12390       vp_playfield->width = MAX(vp_playfield->min_width, playfield_width);
12391
12392     if (vp_playfield->min_height != -1)
12393       vp_playfield->height = MAX(vp_playfield->min_height, playfield_height);
12394
12395     if (vp_playfield->max_width != -1)
12396       vp_playfield->width = MIN(vp_playfield->width, vp_playfield->max_width);
12397
12398     if (vp_playfield->max_height != -1)
12399       vp_playfield->height = MIN(vp_playfield->height, vp_playfield->max_height);
12400
12401     // adjust playfield position according to specified alignment
12402
12403     if (vp_playfield->align == ALIGN_LEFT || vp_playfield->x > 0)
12404       vp_playfield->x = ALIGNED_VP_XPOS(vp_playfield);
12405     else if (vp_playfield->align == ALIGN_CENTER)
12406       vp_playfield->x = playfield_width / 2 - vp_playfield->width / 2;
12407     else if (vp_playfield->align == ALIGN_RIGHT)
12408       vp_playfield->x += playfield_width - vp_playfield->width;
12409
12410     if (vp_playfield->valign == VALIGN_TOP || vp_playfield->y > 0)
12411       vp_playfield->y = ALIGNED_VP_YPOS(vp_playfield);
12412     else if (vp_playfield->valign == VALIGN_MIDDLE)
12413       vp_playfield->y = playfield_height / 2 - vp_playfield->height / 2;
12414     else if (vp_playfield->valign == VALIGN_BOTTOM)
12415       vp_playfield->y += playfield_height - vp_playfield->height;
12416
12417     vp_playfield->x += vp_playfield->margin_left;
12418     vp_playfield->y += vp_playfield->margin_top;
12419
12420     // adjust individual playfield borders if only default border is specified
12421
12422     if (vp_playfield->border_left == -1)
12423       vp_playfield->border_left = vp_playfield->border_size;
12424     if (vp_playfield->border_right == -1)
12425       vp_playfield->border_right = vp_playfield->border_size;
12426     if (vp_playfield->border_top == -1)
12427       vp_playfield->border_top = vp_playfield->border_size;
12428     if (vp_playfield->border_bottom == -1)
12429       vp_playfield->border_bottom = vp_playfield->border_size;
12430
12431     // set dynamic playfield borders if borders are specified as undefined
12432     // (but only if window size was dynamic and playfield size was static)
12433
12434     if (dynamic_window_width && !dynamic_playfield_width)
12435     {
12436       if (vp_playfield->border_left == -1)
12437       {
12438         vp_playfield->border_left = (vp_playfield->x -
12439                                      vp_playfield->margin_left);
12440         vp_playfield->x     -= vp_playfield->border_left;
12441         vp_playfield->width += vp_playfield->border_left;
12442       }
12443
12444       if (vp_playfield->border_right == -1)
12445       {
12446         vp_playfield->border_right = (vp_window->width -
12447                                       vp_playfield->x -
12448                                       vp_playfield->width -
12449                                       vp_playfield->margin_right);
12450         vp_playfield->width += vp_playfield->border_right;
12451       }
12452     }
12453
12454     if (dynamic_window_height && !dynamic_playfield_height)
12455     {
12456       if (vp_playfield->border_top == -1)
12457       {
12458         vp_playfield->border_top = (vp_playfield->y -
12459                                     vp_playfield->margin_top);
12460         vp_playfield->y      -= vp_playfield->border_top;
12461         vp_playfield->height += vp_playfield->border_top;
12462       }
12463
12464       if (vp_playfield->border_bottom == -1)
12465       {
12466         vp_playfield->border_bottom = (vp_window->height -
12467                                        vp_playfield->y -
12468                                        vp_playfield->height -
12469                                        vp_playfield->margin_bottom);
12470         vp_playfield->height += vp_playfield->border_bottom;
12471       }
12472     }
12473
12474     // adjust playfield size to be a multiple of a defined alignment tile size
12475
12476     int align_size = vp_playfield->align_size;
12477     int playfield_xtiles = vp_playfield->width  / align_size;
12478     int playfield_ytiles = vp_playfield->height / align_size;
12479     int playfield_width_corrected  = playfield_xtiles * align_size;
12480     int playfield_height_corrected = playfield_ytiles * align_size;
12481     boolean is_playfield_mode = (i == GFX_SPECIAL_ARG_PLAYING ||
12482                                  i == GFX_SPECIAL_ARG_EDITOR);
12483
12484     if (is_playfield_mode &&
12485         dynamic_playfield_width &&
12486         vp_playfield->width != playfield_width_corrected)
12487     {
12488       int playfield_xdiff = vp_playfield->width - playfield_width_corrected;
12489
12490       vp_playfield->width = playfield_width_corrected;
12491
12492       if (vp_playfield->align == ALIGN_LEFT)
12493       {
12494         vp_playfield->border_left += playfield_xdiff;
12495       }
12496       else if (vp_playfield->align == ALIGN_RIGHT)
12497       {
12498         vp_playfield->border_right += playfield_xdiff;
12499       }
12500       else if (vp_playfield->align == ALIGN_CENTER)
12501       {
12502         int border_left_diff  = playfield_xdiff / 2;
12503         int border_right_diff = playfield_xdiff - border_left_diff;
12504
12505         vp_playfield->border_left  += border_left_diff;
12506         vp_playfield->border_right += border_right_diff;
12507       }
12508     }
12509
12510     if (is_playfield_mode &&
12511         dynamic_playfield_height &&
12512         vp_playfield->height != playfield_height_corrected)
12513     {
12514       int playfield_ydiff = vp_playfield->height - playfield_height_corrected;
12515
12516       vp_playfield->height = playfield_height_corrected;
12517
12518       if (vp_playfield->valign == VALIGN_TOP)
12519       {
12520         vp_playfield->border_top += playfield_ydiff;
12521       }
12522       else if (vp_playfield->align == VALIGN_BOTTOM)
12523       {
12524         vp_playfield->border_right += playfield_ydiff;
12525       }
12526       else if (vp_playfield->align == VALIGN_MIDDLE)
12527       {
12528         int border_top_diff    = playfield_ydiff / 2;
12529         int border_bottom_diff = playfield_ydiff - border_top_diff;
12530
12531         vp_playfield->border_top    += border_top_diff;
12532         vp_playfield->border_bottom += border_bottom_diff;
12533       }
12534     }
12535
12536     // adjust door positions according to specified alignment
12537
12538     for (j = 0; j < 2; j++)
12539     {
12540       struct RectWithBorder *vp_door = (j == 0 ? vp_door_1 : vp_door_2);
12541
12542       if (vp_door->align == ALIGN_LEFT || vp_door->x > 0)
12543         vp_door->x = ALIGNED_VP_XPOS(vp_door);
12544       else if (vp_door->align == ALIGN_CENTER)
12545         vp_door->x = vp_window->width / 2 - vp_door->width / 2;
12546       else if (vp_door->align == ALIGN_RIGHT)
12547         vp_door->x += vp_window->width - vp_door->width;
12548
12549       if (vp_door->valign == VALIGN_TOP || vp_door->y > 0)
12550         vp_door->y = ALIGNED_VP_YPOS(vp_door);
12551       else if (vp_door->valign == VALIGN_MIDDLE)
12552         vp_door->y = vp_window->height / 2 - vp_door->height / 2;
12553       else if (vp_door->valign == VALIGN_BOTTOM)
12554         vp_door->y += vp_window->height - vp_door->height;
12555     }
12556   }
12557 }
12558
12559 static void InitMenuDesignSettings_SpecialPostProcessing_AfterGraphics(void)
12560 {
12561   static struct
12562   {
12563     struct XYTileSize *dst, *src;
12564     int graphic;
12565   }
12566   editor_buttons_xy[] =
12567   {
12568     {
12569       &editor.button.element_left,      &editor.palette.element_left,
12570       IMG_GFX_EDITOR_BUTTON_ELEMENT_LEFT
12571     },
12572     {
12573       &editor.button.element_middle,    &editor.palette.element_middle,
12574       IMG_GFX_EDITOR_BUTTON_ELEMENT_MIDDLE
12575     },
12576     {
12577       &editor.button.element_right,     &editor.palette.element_right,
12578       IMG_GFX_EDITOR_BUTTON_ELEMENT_RIGHT
12579     },
12580
12581     { NULL,                     NULL                    }
12582   };
12583   int i;
12584
12585   // set default position for element buttons to element graphics
12586   for (i = 0; editor_buttons_xy[i].dst != NULL; i++)
12587   {
12588     if ((*editor_buttons_xy[i].dst).x == -1 &&
12589         (*editor_buttons_xy[i].dst).y == -1)
12590     {
12591       struct GraphicInfo *gd = &graphic_info[editor_buttons_xy[i].graphic];
12592
12593       gd->width = gd->height = editor_buttons_xy[i].src->tile_size;
12594
12595       *editor_buttons_xy[i].dst = *editor_buttons_xy[i].src;
12596     }
12597   }
12598
12599   // adjust editor palette rows and columns if specified to be dynamic
12600
12601   if (editor.palette.cols == -1)
12602   {
12603     int vp_width = viewport.playfield[GFX_SPECIAL_ARG_EDITOR].width;
12604     int bt_width = graphic_info[IMG_EDITOR_PALETTE_BUTTON].width;
12605     int sc_width = graphic_info[IMG_EDITOR_PALETTE_SCROLLBAR].width;
12606
12607     editor.palette.cols = (vp_width - sc_width) / bt_width;
12608
12609     if (editor.palette.x == -1)
12610     {
12611       int palette_width = editor.palette.cols * bt_width + sc_width;
12612
12613       editor.palette.x = (vp_width - palette_width) / 2;
12614     }
12615   }
12616
12617   if (editor.palette.rows == -1)
12618   {
12619     int vp_height = viewport.playfield[GFX_SPECIAL_ARG_EDITOR].height;
12620     int bt_height = graphic_info[IMG_EDITOR_PALETTE_BUTTON].height;
12621     int tx_height = getFontHeight(FONT_TEXT_2);
12622
12623     editor.palette.rows = (vp_height - tx_height) / bt_height;
12624
12625     if (editor.palette.y == -1)
12626     {
12627       int palette_height = editor.palette.rows * bt_height + tx_height;
12628
12629       editor.palette.y = (vp_height - palette_height) / 2;
12630     }
12631   }
12632 }
12633
12634 static void InitMenuDesignSettings_PreviewPlayers_Ext(SetupFileHash *hash,
12635                                                       boolean initialize)
12636 {
12637   // special case: check if network and preview player positions are redefined,
12638   // to compare this later against the main menu level preview being redefined
12639   struct TokenIntPtrInfo menu_config_players[] =
12640   {
12641     { "main.network_players.x", &menu.main.network_players.redefined    },
12642     { "main.network_players.y", &menu.main.network_players.redefined    },
12643     { "main.preview_players.x", &menu.main.preview_players.redefined    },
12644     { "main.preview_players.y", &menu.main.preview_players.redefined    },
12645     { "preview.x",              &preview.redefined                      },
12646     { "preview.y",              &preview.redefined                      }
12647   };
12648   int i;
12649
12650   if (initialize)
12651   {
12652     for (i = 0; i < ARRAY_SIZE(menu_config_players); i++)
12653       *menu_config_players[i].value = FALSE;
12654   }
12655   else
12656   {
12657     for (i = 0; i < ARRAY_SIZE(menu_config_players); i++)
12658       if (getHashEntry(hash, menu_config_players[i].token) != NULL)
12659         *menu_config_players[i].value = TRUE;
12660   }
12661 }
12662
12663 static void InitMenuDesignSettings_PreviewPlayers(void)
12664 {
12665   InitMenuDesignSettings_PreviewPlayers_Ext(NULL, TRUE);
12666 }
12667
12668 static void InitMenuDesignSettings_PreviewPlayers_FromHash(SetupFileHash *hash)
12669 {
12670   InitMenuDesignSettings_PreviewPlayers_Ext(hash, FALSE);
12671 }
12672
12673 static void LoadMenuDesignSettingsFromFilename(char *filename)
12674 {
12675   static struct TitleFadingInfo tfi;
12676   static struct TitleMessageInfo tmi;
12677   static struct TokenInfo title_tokens[] =
12678   {
12679     { TYPE_INTEGER,     &tfi.fade_mode,         ".fade_mode"            },
12680     { TYPE_INTEGER,     &tfi.fade_delay,        ".fade_delay"           },
12681     { TYPE_INTEGER,     &tfi.post_delay,        ".post_delay"           },
12682     { TYPE_INTEGER,     &tfi.auto_delay,        ".auto_delay"           },
12683     { TYPE_INTEGER,     &tfi.auto_delay_unit,   ".auto_delay_unit"      },
12684
12685     { -1,               NULL,                   NULL                    }
12686   };
12687   static struct TokenInfo titlemessage_tokens[] =
12688   {
12689     { TYPE_INTEGER,     &tmi.x,                 ".x"                    },
12690     { TYPE_INTEGER,     &tmi.y,                 ".y"                    },
12691     { TYPE_INTEGER,     &tmi.width,             ".width"                },
12692     { TYPE_INTEGER,     &tmi.height,            ".height"               },
12693     { TYPE_INTEGER,     &tmi.chars,             ".chars"                },
12694     { TYPE_INTEGER,     &tmi.lines,             ".lines"                },
12695     { TYPE_INTEGER,     &tmi.align,             ".align"                },
12696     { TYPE_INTEGER,     &tmi.valign,            ".valign"               },
12697     { TYPE_INTEGER,     &tmi.font,              ".font"                 },
12698     { TYPE_BOOLEAN,     &tmi.autowrap,          ".autowrap"             },
12699     { TYPE_BOOLEAN,     &tmi.centered,          ".centered"             },
12700     { TYPE_BOOLEAN,     &tmi.parse_comments,    ".parse_comments"       },
12701     { TYPE_INTEGER,     &tmi.sort_priority,     ".sort_priority"        },
12702     { TYPE_INTEGER,     &tmi.fade_mode,         ".fade_mode"            },
12703     { TYPE_INTEGER,     &tmi.fade_delay,        ".fade_delay"           },
12704     { TYPE_INTEGER,     &tmi.post_delay,        ".post_delay"           },
12705     { TYPE_INTEGER,     &tmi.auto_delay,        ".auto_delay"           },
12706     { TYPE_INTEGER,     &tmi.auto_delay_unit,   ".auto_delay_unit"      },
12707
12708     { -1,               NULL,                   NULL                    }
12709   };
12710   static struct
12711   {
12712     struct TitleFadingInfo *info;
12713     char *text;
12714   }
12715   title_info[] =
12716   {
12717     // initialize first titles from "enter screen" definitions, if defined
12718     { &title_initial_first_default,     "menu.enter_screen.TITLE"       },
12719     { &title_first_default,             "menu.enter_screen.TITLE"       },
12720
12721     // initialize title screens from "next screen" definitions, if defined
12722     { &title_initial_default,           "menu.next_screen.TITLE"        },
12723     { &title_default,                   "menu.next_screen.TITLE"        },
12724
12725     { NULL,                             NULL                            }
12726   };
12727   static struct
12728   {
12729     struct TitleMessageInfo *array;
12730     char *text;
12731   }
12732   titlemessage_arrays[] =
12733   {
12734     // initialize first titles from "enter screen" definitions, if defined
12735     { titlescreen_initial_first,        "menu.enter_screen.TITLE"       },
12736     { titlescreen_first,                "menu.enter_screen.TITLE"       },
12737     { titlemessage_initial_first,       "menu.enter_screen.TITLE"       },
12738     { titlemessage_first,               "menu.enter_screen.TITLE"       },
12739
12740     // initialize titles from "next screen" definitions, if defined
12741     { titlescreen_initial,              "menu.next_screen.TITLE"        },
12742     { titlescreen,                      "menu.next_screen.TITLE"        },
12743     { titlemessage_initial,             "menu.next_screen.TITLE"        },
12744     { titlemessage,                     "menu.next_screen.TITLE"        },
12745
12746     // overwrite titles with title definitions, if defined
12747     { titlescreen_initial_first,        "[title_initial]"               },
12748     { titlescreen_first,                "[title]"                       },
12749     { titlemessage_initial_first,       "[title_initial]"               },
12750     { titlemessage_first,               "[title]"                       },
12751
12752     { titlescreen_initial,              "[title_initial]"               },
12753     { titlescreen,                      "[title]"                       },
12754     { titlemessage_initial,             "[title_initial]"               },
12755     { titlemessage,                     "[title]"                       },
12756
12757     // overwrite titles with title screen/message definitions, if defined
12758     { titlescreen_initial_first,        "[titlescreen_initial]"         },
12759     { titlescreen_first,                "[titlescreen]"                 },
12760     { titlemessage_initial_first,       "[titlemessage_initial]"        },
12761     { titlemessage_first,               "[titlemessage]"                },
12762
12763     { titlescreen_initial,              "[titlescreen_initial]"         },
12764     { titlescreen,                      "[titlescreen]"                 },
12765     { titlemessage_initial,             "[titlemessage_initial]"        },
12766     { titlemessage,                     "[titlemessage]"                },
12767
12768     { NULL,                             NULL                            }
12769   };
12770   SetupFileHash *setup_file_hash;
12771   int i, j, k;
12772
12773   if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
12774     return;
12775
12776   // the following initializes hierarchical values from dynamic configuration
12777
12778   // special case: initialize with default values that may be overwritten
12779   // (e.g., init "menu.draw_xoffset.INFO" from "menu.draw_xoffset")
12780   for (i = 0; i < NUM_SPECIAL_GFX_ARGS; i++)
12781   {
12782     struct TokenIntPtrInfo menu_config[] =
12783     {
12784       { "menu.draw_xoffset",    &menu.draw_xoffset[i]   },
12785       { "menu.draw_yoffset",    &menu.draw_yoffset[i]   },
12786       { "menu.list_size",       &menu.list_size[i]      }
12787     };
12788
12789     for (j = 0; j < ARRAY_SIZE(menu_config); j++)
12790     {
12791       char *token = menu_config[j].token;
12792       char *value = getHashEntry(setup_file_hash, token);
12793
12794       if (value != NULL)
12795         *menu_config[j].value = get_integer_from_string(value);
12796     }
12797   }
12798
12799   // special case: initialize with default values that may be overwritten
12800   // (eg, init "menu.draw_xoffset.INFO[XXX]" from "menu.draw_xoffset.INFO")
12801   for (i = 0; i < NUM_SPECIAL_GFX_INFO_ARGS; i++)
12802   {
12803     struct TokenIntPtrInfo menu_config[] =
12804     {
12805       { "menu.draw_xoffset.INFO",       &menu.draw_xoffset_info[i]      },
12806       { "menu.draw_yoffset.INFO",       &menu.draw_yoffset_info[i]      },
12807       { "menu.list_size.INFO",          &menu.list_size_info[i]         },
12808       { "menu.list_entry_size.INFO",    &menu.list_entry_size_info[i]   },
12809       { "menu.tile_size.INFO",          &menu.tile_size_info[i]         }
12810     };
12811
12812     for (j = 0; j < ARRAY_SIZE(menu_config); j++)
12813     {
12814       char *token = menu_config[j].token;
12815       char *value = getHashEntry(setup_file_hash, token);
12816
12817       if (value != NULL)
12818         *menu_config[j].value = get_integer_from_string(value);
12819     }
12820   }
12821
12822   // special case: initialize with default values that may be overwritten
12823   // (eg, init "menu.draw_xoffset.SETUP[XXX]" from "menu.draw_xoffset.SETUP")
12824   for (i = 0; i < NUM_SPECIAL_GFX_SETUP_ARGS; i++)
12825   {
12826     struct TokenIntPtrInfo menu_config[] =
12827     {
12828       { "menu.draw_xoffset.SETUP",      &menu.draw_xoffset_setup[i]     },
12829       { "menu.draw_yoffset.SETUP",      &menu.draw_yoffset_setup[i]     }
12830     };
12831
12832     for (j = 0; j < ARRAY_SIZE(menu_config); j++)
12833     {
12834       char *token = menu_config[j].token;
12835       char *value = getHashEntry(setup_file_hash, token);
12836
12837       if (value != NULL)
12838         *menu_config[j].value = get_integer_from_string(value);
12839     }
12840   }
12841
12842   // special case: initialize with default values that may be overwritten
12843   // (eg, init "menu.line_spacing.INFO[XXX]" from "menu.line_spacing.INFO")
12844   for (i = 0; i < NUM_SPECIAL_GFX_INFO_ARGS; i++)
12845   {
12846     struct TokenIntPtrInfo menu_config[] =
12847     {
12848       { "menu.left_spacing.INFO",       &menu.left_spacing_info[i]      },
12849       { "menu.middle_spacing.INFO",     &menu.middle_spacing_info[i]    },
12850       { "menu.right_spacing.INFO",      &menu.right_spacing_info[i]     },
12851       { "menu.top_spacing.INFO",        &menu.top_spacing_info[i]       },
12852       { "menu.bottom_spacing.INFO",     &menu.bottom_spacing_info[i]    },
12853       { "menu.paragraph_spacing.INFO",  &menu.paragraph_spacing_info[i] },
12854       { "menu.headline1_spacing.INFO",  &menu.headline1_spacing_info[i] },
12855       { "menu.headline2_spacing.INFO",  &menu.headline2_spacing_info[i] },
12856       { "menu.line_spacing.INFO",       &menu.line_spacing_info[i]      },
12857       { "menu.extra_spacing.INFO",      &menu.extra_spacing_info[i]     },
12858     };
12859
12860     for (j = 0; j < ARRAY_SIZE(menu_config); j++)
12861     {
12862       char *token = menu_config[j].token;
12863       char *value = getHashEntry(setup_file_hash, token);
12864
12865       if (value != NULL)
12866         *menu_config[j].value = get_integer_from_string(value);
12867     }
12868   }
12869
12870   // special case: initialize with default values that may be overwritten
12871   // (eg, init "menu.enter_screen.SCORES.xyz" from "menu.enter_screen.xyz")
12872   for (i = 0; i < NUM_SPECIAL_GFX_ARGS; i++)
12873   {
12874     struct TokenIntPtrInfo menu_config[] =
12875     {
12876       { "menu.enter_screen.fade_mode",  &menu.enter_screen[i].fade_mode  },
12877       { "menu.enter_screen.fade_delay", &menu.enter_screen[i].fade_delay },
12878       { "menu.enter_screen.post_delay", &menu.enter_screen[i].post_delay },
12879       { "menu.leave_screen.fade_mode",  &menu.leave_screen[i].fade_mode  },
12880       { "menu.leave_screen.fade_delay", &menu.leave_screen[i].fade_delay },
12881       { "menu.leave_screen.post_delay", &menu.leave_screen[i].post_delay },
12882       { "menu.next_screen.fade_mode",   &menu.next_screen[i].fade_mode   },
12883       { "menu.next_screen.fade_delay",  &menu.next_screen[i].fade_delay  },
12884       { "menu.next_screen.post_delay",  &menu.next_screen[i].post_delay  }
12885     };
12886
12887     for (j = 0; j < ARRAY_SIZE(menu_config); j++)
12888     {
12889       char *token = menu_config[j].token;
12890       char *value = getHashEntry(setup_file_hash, token);
12891
12892       if (value != NULL)
12893         *menu_config[j].value = get_token_parameter_value(token, value);
12894     }
12895   }
12896
12897   // special case: initialize with default values that may be overwritten
12898   // (eg, init "viewport.door_1.MAIN.xyz" from "viewport.door_1.xyz")
12899   for (i = 0; i < NUM_SPECIAL_GFX_ARGS; i++)
12900   {
12901     struct
12902     {
12903       char *token_prefix;
12904       struct RectWithBorder *struct_ptr;
12905     }
12906     vp_struct[] =
12907     {
12908       { "viewport.window",      &viewport.window[i]     },
12909       { "viewport.playfield",   &viewport.playfield[i]  },
12910       { "viewport.door_1",      &viewport.door_1[i]     },
12911       { "viewport.door_2",      &viewport.door_2[i]     }
12912     };
12913
12914     for (j = 0; j < ARRAY_SIZE(vp_struct); j++)
12915     {
12916       struct TokenIntPtrInfo vp_config[] =
12917       {
12918         { ".x",                 &vp_struct[j].struct_ptr->x             },
12919         { ".y",                 &vp_struct[j].struct_ptr->y             },
12920         { ".width",             &vp_struct[j].struct_ptr->width         },
12921         { ".height",            &vp_struct[j].struct_ptr->height        },
12922         { ".min_width",         &vp_struct[j].struct_ptr->min_width     },
12923         { ".min_height",        &vp_struct[j].struct_ptr->min_height    },
12924         { ".max_width",         &vp_struct[j].struct_ptr->max_width     },
12925         { ".max_height",        &vp_struct[j].struct_ptr->max_height    },
12926         { ".margin_left",       &vp_struct[j].struct_ptr->margin_left   },
12927         { ".margin_right",      &vp_struct[j].struct_ptr->margin_right  },
12928         { ".margin_top",        &vp_struct[j].struct_ptr->margin_top    },
12929         { ".margin_bottom",     &vp_struct[j].struct_ptr->margin_bottom },
12930         { ".border_left",       &vp_struct[j].struct_ptr->border_left   },
12931         { ".border_right",      &vp_struct[j].struct_ptr->border_right  },
12932         { ".border_top",        &vp_struct[j].struct_ptr->border_top    },
12933         { ".border_bottom",     &vp_struct[j].struct_ptr->border_bottom },
12934         { ".border_size",       &vp_struct[j].struct_ptr->border_size   },
12935         { ".align_size",        &vp_struct[j].struct_ptr->align_size    },
12936         { ".align",             &vp_struct[j].struct_ptr->align         },
12937         { ".valign",            &vp_struct[j].struct_ptr->valign        }
12938       };
12939
12940       for (k = 0; k < ARRAY_SIZE(vp_config); k++)
12941       {
12942         char *token = getStringCat2(vp_struct[j].token_prefix,
12943                                     vp_config[k].token);
12944         char *value = getHashEntry(setup_file_hash, token);
12945
12946         if (value != NULL)
12947           *vp_config[k].value = get_token_parameter_value(token, value);
12948
12949         free(token);
12950       }
12951     }
12952   }
12953
12954   // special case: initialize with default values that may be overwritten
12955   // (e.g., init "[title].fade_mode" from "menu.next_screen.TITLE.fade_mode")
12956   for (i = 0; title_info[i].info != NULL; i++)
12957   {
12958     struct TitleFadingInfo *info = title_info[i].info;
12959     char *base_token = title_info[i].text;
12960
12961     for (j = 0; title_tokens[j].type != -1; j++)
12962     {
12963       char *token = getStringCat2(base_token, title_tokens[j].text);
12964       char *value = getHashEntry(setup_file_hash, token);
12965
12966       if (value != NULL)
12967       {
12968         int parameter_value = get_token_parameter_value(token, value);
12969
12970         tfi = *info;
12971
12972         *(int *)title_tokens[j].value = (int)parameter_value;
12973
12974         *info = tfi;
12975       }
12976
12977       free(token);
12978     }
12979   }
12980
12981   // special case: initialize with default values that may be overwritten
12982   // (e.g., init "titlemessage_1.fade_mode" from "[titlemessage].fade_mode")
12983   for (i = 0; titlemessage_arrays[i].array != NULL; i++)
12984   {
12985     struct TitleMessageInfo *array = titlemessage_arrays[i].array;
12986     char *base_token = titlemessage_arrays[i].text;
12987
12988     for (j = 0; titlemessage_tokens[j].type != -1; j++)
12989     {
12990       char *token = getStringCat2(base_token, titlemessage_tokens[j].text);
12991       char *value = getHashEntry(setup_file_hash, token);
12992
12993       if (value != NULL)
12994       {
12995         int parameter_value = get_token_parameter_value(token, value);
12996
12997         for (k = 0; k < MAX_NUM_TITLE_MESSAGES; k++)
12998         {
12999           tmi = array[k];
13000
13001           if (titlemessage_tokens[j].type == TYPE_INTEGER)
13002             *(int     *)titlemessage_tokens[j].value = (int)parameter_value;
13003           else
13004             *(boolean *)titlemessage_tokens[j].value = (boolean)parameter_value;
13005
13006           array[k] = tmi;
13007         }
13008       }
13009
13010       free(token);
13011     }
13012   }
13013
13014   // read (and overwrite with) values that may be specified in config file
13015   InitMenuDesignSettings_FromHash(setup_file_hash, TRUE);
13016
13017   // special case: check if network and preview player positions are redefined
13018   InitMenuDesignSettings_PreviewPlayers_FromHash(setup_file_hash);
13019
13020   freeSetupFileHash(setup_file_hash);
13021 }
13022
13023 void LoadMenuDesignSettings(void)
13024 {
13025   char *filename_base = UNDEFINED_FILENAME, *filename_local;
13026
13027   InitMenuDesignSettings_Static();
13028   InitMenuDesignSettings_SpecialPreProcessing();
13029   InitMenuDesignSettings_PreviewPlayers();
13030
13031   if (!GFX_OVERRIDE_ARTWORK(ARTWORK_TYPE_GRAPHICS))
13032   {
13033     // first look for special settings configured in level series config
13034     filename_base = getCustomArtworkLevelConfigFilename(ARTWORK_TYPE_GRAPHICS);
13035
13036     if (fileExists(filename_base))
13037       LoadMenuDesignSettingsFromFilename(filename_base);
13038   }
13039
13040   filename_local = getCustomArtworkConfigFilename(ARTWORK_TYPE_GRAPHICS);
13041
13042   if (filename_local != NULL && !strEqual(filename_base, filename_local))
13043     LoadMenuDesignSettingsFromFilename(filename_local);
13044
13045   InitMenuDesignSettings_SpecialPostProcessing();
13046 }
13047
13048 void LoadMenuDesignSettings_AfterGraphics(void)
13049 {
13050   InitMenuDesignSettings_SpecialPostProcessing_AfterGraphics();
13051 }
13052
13053 void InitSoundSettings_FromHash(SetupFileHash *setup_file_hash,
13054                                 boolean ignore_defaults)
13055 {
13056   int i;
13057
13058   for (i = 0; sound_config_vars[i].token != NULL; i++)
13059   {
13060     char *value = getHashEntry(setup_file_hash, sound_config_vars[i].token);
13061
13062     // (ignore definitions set to "[DEFAULT]" which are already initialized)
13063     if (ignore_defaults && strEqual(value, ARG_DEFAULT))
13064       continue;
13065
13066     if (value != NULL)
13067       *sound_config_vars[i].value =
13068         get_token_parameter_value(sound_config_vars[i].token, value);
13069   }
13070 }
13071
13072 void InitSoundSettings_Static(void)
13073 {
13074   // always start with reliable default values from static default config
13075   InitSoundSettings_FromHash(sound_config_hash, FALSE);
13076 }
13077
13078 static void LoadSoundSettingsFromFilename(char *filename)
13079 {
13080   SetupFileHash *setup_file_hash;
13081
13082   if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
13083     return;
13084
13085   // read (and overwrite with) values that may be specified in config file
13086   InitSoundSettings_FromHash(setup_file_hash, TRUE);
13087
13088   freeSetupFileHash(setup_file_hash);
13089 }
13090
13091 void LoadSoundSettings(void)
13092 {
13093   char *filename_base = UNDEFINED_FILENAME, *filename_local;
13094
13095   InitSoundSettings_Static();
13096
13097   if (!GFX_OVERRIDE_ARTWORK(ARTWORK_TYPE_SOUNDS))
13098   {
13099     // first look for special settings configured in level series config
13100     filename_base = getCustomArtworkLevelConfigFilename(ARTWORK_TYPE_SOUNDS);
13101
13102     if (fileExists(filename_base))
13103       LoadSoundSettingsFromFilename(filename_base);
13104   }
13105
13106   filename_local = getCustomArtworkConfigFilename(ARTWORK_TYPE_SOUNDS);
13107
13108   if (filename_local != NULL && !strEqual(filename_base, filename_local))
13109     LoadSoundSettingsFromFilename(filename_local);
13110 }
13111
13112 void LoadUserDefinedEditorElementList(int **elements, int *num_elements)
13113 {
13114   char *filename = getEditorSetupFilename();
13115   SetupFileList *setup_file_list, *list;
13116   SetupFileHash *element_hash;
13117   int num_unknown_tokens = 0;
13118   int i;
13119
13120   if ((setup_file_list = loadSetupFileList(filename)) == NULL)
13121     return;
13122
13123   element_hash = newSetupFileHash();
13124
13125   for (i = 0; i < NUM_FILE_ELEMENTS; i++)
13126     setHashEntry(element_hash, element_info[i].token_name, i_to_a(i));
13127
13128   // determined size may be larger than needed (due to unknown elements)
13129   *num_elements = 0;
13130   for (list = setup_file_list; list != NULL; list = list->next)
13131     (*num_elements)++;
13132
13133   // add space for up to 3 more elements for padding that may be needed
13134   *num_elements += 3;
13135
13136   // free memory for old list of elements, if needed
13137   checked_free(*elements);
13138
13139   // allocate memory for new list of elements
13140   *elements = checked_malloc(*num_elements * sizeof(int));
13141
13142   *num_elements = 0;
13143   for (list = setup_file_list; list != NULL; list = list->next)
13144   {
13145     char *value = getHashEntry(element_hash, list->token);
13146
13147     if (value == NULL)          // try to find obsolete token mapping
13148     {
13149       char *mapped_token = get_mapped_token(list->token);
13150
13151       if (mapped_token != NULL)
13152       {
13153         value = getHashEntry(element_hash, mapped_token);
13154
13155         free(mapped_token);
13156       }
13157     }
13158
13159     if (value != NULL)
13160     {
13161       (*elements)[(*num_elements)++] = atoi(value);
13162     }
13163     else
13164     {
13165       if (num_unknown_tokens == 0)
13166       {
13167         Warn("---");
13168         Warn("unknown token(s) found in config file:");
13169         Warn("- config file: '%s'", filename);
13170
13171         num_unknown_tokens++;
13172       }
13173
13174       Warn("- token: '%s'", list->token);
13175     }
13176   }
13177
13178   if (num_unknown_tokens > 0)
13179     Warn("---");
13180
13181   while (*num_elements % 4)     // pad with empty elements, if needed
13182     (*elements)[(*num_elements)++] = EL_EMPTY;
13183
13184   freeSetupFileList(setup_file_list);
13185   freeSetupFileHash(element_hash);
13186
13187 #if 0
13188   for (i = 0; i < *num_elements; i++)
13189     Debug("editor", "element '%s' [%d]\n",
13190           element_info[(*elements)[i]].token_name, (*elements)[i]);
13191 #endif
13192 }
13193
13194 static struct MusicFileInfo *get_music_file_info_ext(char *basename, int music,
13195                                                      boolean is_sound)
13196 {
13197   SetupFileHash *setup_file_hash = NULL;
13198   struct MusicFileInfo tmp_music_file_info, *new_music_file_info;
13199   char *filename_music, *filename_prefix, *filename_info;
13200   struct
13201   {
13202     char *token;
13203     char **value_ptr;
13204   }
13205   token_to_value_ptr[] =
13206   {
13207     { "title_header",   &tmp_music_file_info.title_header       },
13208     { "artist_header",  &tmp_music_file_info.artist_header      },
13209     { "album_header",   &tmp_music_file_info.album_header       },
13210     { "year_header",    &tmp_music_file_info.year_header        },
13211     { "played_header",  &tmp_music_file_info.played_header      },
13212
13213     { "title",          &tmp_music_file_info.title              },
13214     { "artist",         &tmp_music_file_info.artist             },
13215     { "album",          &tmp_music_file_info.album              },
13216     { "year",           &tmp_music_file_info.year               },
13217     { "played",         &tmp_music_file_info.played             },
13218
13219     { NULL,             NULL                                    },
13220   };
13221   int i;
13222
13223   filename_music = (is_sound ? getCustomSoundFilename(basename) :
13224                     getCustomMusicFilename(basename));
13225
13226   if (filename_music == NULL)
13227     return NULL;
13228
13229   // ---------- try to replace file extension ----------
13230
13231   filename_prefix = getStringCopy(filename_music);
13232   if (strrchr(filename_prefix, '.') != NULL)
13233     *strrchr(filename_prefix, '.') = '\0';
13234   filename_info = getStringCat2(filename_prefix, ".txt");
13235
13236   if (fileExists(filename_info))
13237     setup_file_hash = loadSetupFileHash(filename_info);
13238
13239   free(filename_prefix);
13240   free(filename_info);
13241
13242   if (setup_file_hash == NULL)
13243   {
13244     // ---------- try to add file extension ----------
13245
13246     filename_prefix = getStringCopy(filename_music);
13247     filename_info = getStringCat2(filename_prefix, ".txt");
13248
13249     if (fileExists(filename_info))
13250       setup_file_hash = loadSetupFileHash(filename_info);
13251
13252     free(filename_prefix);
13253     free(filename_info);
13254   }
13255
13256   if (setup_file_hash == NULL)
13257     return NULL;
13258
13259   // ---------- music file info found ----------
13260
13261   clear_mem(&tmp_music_file_info, sizeof(struct MusicFileInfo));
13262
13263   for (i = 0; token_to_value_ptr[i].token != NULL; i++)
13264   {
13265     char *value = getHashEntry(setup_file_hash, token_to_value_ptr[i].token);
13266
13267     *token_to_value_ptr[i].value_ptr =
13268       getStringCopy(value != NULL && *value != '\0' ? value : UNKNOWN_NAME);
13269   }
13270
13271   tmp_music_file_info.basename = getStringCopy(basename);
13272   tmp_music_file_info.music = music;
13273   tmp_music_file_info.is_sound = is_sound;
13274
13275   new_music_file_info = checked_malloc(sizeof(struct MusicFileInfo));
13276   *new_music_file_info = tmp_music_file_info;
13277
13278   return new_music_file_info;
13279 }
13280
13281 static struct MusicFileInfo *get_music_file_info(char *basename, int music)
13282 {
13283   return get_music_file_info_ext(basename, music, FALSE);
13284 }
13285
13286 static struct MusicFileInfo *get_sound_file_info(char *basename, int sound)
13287 {
13288   return get_music_file_info_ext(basename, sound, TRUE);
13289 }
13290
13291 static boolean music_info_listed_ext(struct MusicFileInfo *list,
13292                                      char *basename, boolean is_sound)
13293 {
13294   for (; list != NULL; list = list->next)
13295     if (list->is_sound == is_sound && strEqual(list->basename, basename))
13296       return TRUE;
13297
13298   return FALSE;
13299 }
13300
13301 static boolean music_info_listed(struct MusicFileInfo *list, char *basename)
13302 {
13303   return music_info_listed_ext(list, basename, FALSE);
13304 }
13305
13306 static boolean sound_info_listed(struct MusicFileInfo *list, char *basename)
13307 {
13308   return music_info_listed_ext(list, basename, TRUE);
13309 }
13310
13311 void LoadMusicInfo(void)
13312 {
13313   int num_music_noconf = getMusicListSize_NoConf();
13314   int num_music = getMusicListSize();
13315   int num_sounds = getSoundListSize();
13316   struct FileInfo *music, *sound;
13317   struct MusicFileInfo *next, **new;
13318
13319   int i;
13320
13321   while (music_file_info != NULL)
13322   {
13323     next = music_file_info->next;
13324
13325     checked_free(music_file_info->basename);
13326
13327     checked_free(music_file_info->title_header);
13328     checked_free(music_file_info->artist_header);
13329     checked_free(music_file_info->album_header);
13330     checked_free(music_file_info->year_header);
13331     checked_free(music_file_info->played_header);
13332
13333     checked_free(music_file_info->title);
13334     checked_free(music_file_info->artist);
13335     checked_free(music_file_info->album);
13336     checked_free(music_file_info->year);
13337     checked_free(music_file_info->played);
13338
13339     free(music_file_info);
13340
13341     music_file_info = next;
13342   }
13343
13344   new = &music_file_info;
13345
13346   // get (configured or unconfigured) music file info for all levels
13347   for (i = leveldir_current->first_level;
13348        i <= leveldir_current->last_level; i++)
13349   {
13350     int music_nr;
13351
13352     if (levelset.music[i] != MUS_UNDEFINED)
13353     {
13354       // get music file info for configured level music
13355       music_nr = levelset.music[i];
13356     }
13357     else if (num_music_noconf > 0)
13358     {
13359       // get music file info for unconfigured level music
13360       int level_pos = i - leveldir_current->first_level;
13361
13362       music_nr = MAP_NOCONF_MUSIC(level_pos % num_music_noconf);
13363     }
13364     else
13365     {
13366       continue;
13367     }
13368
13369     char *basename = getMusicInfoEntryFilename(music_nr);
13370
13371     if (basename == NULL)
13372       continue;
13373
13374     if (!music_info_listed(music_file_info, basename))
13375     {
13376       *new = get_music_file_info(basename, music_nr);
13377
13378       if (*new != NULL)
13379         new = &(*new)->next;
13380     }
13381   }
13382
13383   // get music file info for all remaining configured music files
13384   for (i = 0; i < num_music; i++)
13385   {
13386     music = getMusicListEntry(i);
13387
13388     if (music->filename == NULL)
13389       continue;
13390
13391     if (strEqual(music->filename, UNDEFINED_FILENAME))
13392       continue;
13393
13394     // a configured file may be not recognized as music
13395     if (!FileIsMusic(music->filename))
13396       continue;
13397
13398     if (!music_info_listed(music_file_info, music->filename))
13399     {
13400       *new = get_music_file_info(music->filename, i);
13401
13402       if (*new != NULL)
13403         new = &(*new)->next;
13404     }
13405   }
13406
13407   // get sound file info for all configured sound files
13408   for (i = 0; i < num_sounds; i++)
13409   {
13410     sound = getSoundListEntry(i);
13411
13412     if (sound->filename == NULL)
13413       continue;
13414
13415     if (strEqual(sound->filename, UNDEFINED_FILENAME))
13416       continue;
13417
13418     // a configured file may be not recognized as sound
13419     if (!FileIsSound(sound->filename))
13420       continue;
13421
13422     if (!sound_info_listed(music_file_info, sound->filename))
13423     {
13424       *new = get_sound_file_info(sound->filename, i);
13425       if (*new != NULL)
13426         new = &(*new)->next;
13427     }
13428   }
13429
13430   // add pointers to previous list nodes
13431
13432   struct MusicFileInfo *node = music_file_info;
13433
13434   while (node != NULL)
13435   {
13436     if (node->next)
13437       node->next->prev = node;
13438
13439     node = node->next;
13440   }
13441 }
13442
13443 static void add_helpanim_entry(int element, int action, int direction,
13444                                int delay, int *num_list_entries)
13445 {
13446   struct HelpAnimInfo *new_list_entry;
13447   (*num_list_entries)++;
13448
13449   helpanim_info =
13450     checked_realloc(helpanim_info,
13451                     *num_list_entries * sizeof(struct HelpAnimInfo));
13452   new_list_entry = &helpanim_info[*num_list_entries - 1];
13453
13454   new_list_entry->element = element;
13455   new_list_entry->action = action;
13456   new_list_entry->direction = direction;
13457   new_list_entry->delay = delay;
13458 }
13459
13460 static void print_unknown_token(char *filename, char *token, int token_nr)
13461 {
13462   if (token_nr == 0)
13463   {
13464     Warn("---");
13465     Warn("unknown token(s) found in config file:");
13466     Warn("- config file: '%s'", filename);
13467   }
13468
13469   Warn("- token: '%s'", token);
13470 }
13471
13472 static void print_unknown_token_end(int token_nr)
13473 {
13474   if (token_nr > 0)
13475     Warn("---");
13476 }
13477
13478 void LoadHelpAnimInfo(void)
13479 {
13480   char *filename = getHelpAnimFilename();
13481   SetupFileList *setup_file_list = NULL, *list;
13482   SetupFileHash *element_hash, *action_hash, *direction_hash;
13483   int num_list_entries = 0;
13484   int num_unknown_tokens = 0;
13485   int i;
13486
13487   if (fileExists(filename))
13488     setup_file_list = loadSetupFileList(filename);
13489
13490   if (setup_file_list == NULL)
13491   {
13492     // use reliable default values from static configuration
13493     SetupFileList *insert_ptr;
13494
13495     insert_ptr = setup_file_list =
13496       newSetupFileList(helpanim_config[0].token,
13497                        helpanim_config[0].value);
13498
13499     for (i = 1; helpanim_config[i].token; i++)
13500       insert_ptr = addListEntry(insert_ptr,
13501                                 helpanim_config[i].token,
13502                                 helpanim_config[i].value);
13503   }
13504
13505   element_hash   = newSetupFileHash();
13506   action_hash    = newSetupFileHash();
13507   direction_hash = newSetupFileHash();
13508
13509   for (i = 0; i < MAX_NUM_ELEMENTS; i++)
13510     setHashEntry(element_hash, element_info[i].token_name, i_to_a(i));
13511
13512   for (i = 0; i < NUM_ACTIONS; i++)
13513     setHashEntry(action_hash, element_action_info[i].suffix,
13514                  i_to_a(element_action_info[i].value));
13515
13516   // do not store direction index (bit) here, but direction value!
13517   for (i = 0; i < NUM_DIRECTIONS_FULL; i++)
13518     setHashEntry(direction_hash, element_direction_info[i].suffix,
13519                  i_to_a(1 << element_direction_info[i].value));
13520
13521   for (list = setup_file_list; list != NULL; list = list->next)
13522   {
13523     char *element_token, *action_token, *direction_token;
13524     char *element_value, *action_value, *direction_value;
13525     int delay = atoi(list->value);
13526
13527     if (strEqual(list->token, "end"))
13528     {
13529       add_helpanim_entry(HELPANIM_LIST_NEXT, -1, -1, -1, &num_list_entries);
13530
13531       continue;
13532     }
13533
13534     /* first try to break element into element/action/direction parts;
13535        if this does not work, also accept combined "element[.act][.dir]"
13536        elements (like "dynamite.active"), which are unique elements */
13537
13538     if (strchr(list->token, '.') == NULL)       // token contains no '.'
13539     {
13540       element_value = getHashEntry(element_hash, list->token);
13541       if (element_value != NULL)        // element found
13542         add_helpanim_entry(atoi(element_value), -1, -1, delay,
13543                            &num_list_entries);
13544       else
13545       {
13546         // no further suffixes found -- this is not an element
13547         print_unknown_token(filename, list->token, num_unknown_tokens++);
13548       }
13549
13550       continue;
13551     }
13552
13553     // token has format "<prefix>.<something>"
13554
13555     action_token = strchr(list->token, '.');    // suffix may be action ...
13556     direction_token = action_token;             // ... or direction
13557
13558     element_token = getStringCopy(list->token);
13559     *strchr(element_token, '.') = '\0';
13560
13561     element_value = getHashEntry(element_hash, element_token);
13562
13563     if (element_value == NULL)          // this is no element
13564     {
13565       element_value = getHashEntry(element_hash, list->token);
13566       if (element_value != NULL)        // combined element found
13567         add_helpanim_entry(atoi(element_value), -1, -1, delay,
13568                            &num_list_entries);
13569       else
13570         print_unknown_token(filename, list->token, num_unknown_tokens++);
13571
13572       free(element_token);
13573
13574       continue;
13575     }
13576
13577     action_value = getHashEntry(action_hash, action_token);
13578
13579     if (action_value != NULL)           // action found
13580     {
13581       add_helpanim_entry(atoi(element_value), atoi(action_value), -1, delay,
13582                     &num_list_entries);
13583
13584       free(element_token);
13585
13586       continue;
13587     }
13588
13589     direction_value = getHashEntry(direction_hash, direction_token);
13590
13591     if (direction_value != NULL)        // direction found
13592     {
13593       add_helpanim_entry(atoi(element_value), -1, atoi(direction_value), delay,
13594                          &num_list_entries);
13595
13596       free(element_token);
13597
13598       continue;
13599     }
13600
13601     if (strchr(action_token + 1, '.') == NULL)
13602     {
13603       // no further suffixes found -- this is not an action nor direction
13604
13605       element_value = getHashEntry(element_hash, list->token);
13606       if (element_value != NULL)        // combined element found
13607         add_helpanim_entry(atoi(element_value), -1, -1, delay,
13608                            &num_list_entries);
13609       else
13610         print_unknown_token(filename, list->token, num_unknown_tokens++);
13611
13612       free(element_token);
13613
13614       continue;
13615     }
13616
13617     // token has format "<prefix>.<suffix>.<something>"
13618
13619     direction_token = strchr(action_token + 1, '.');
13620
13621     action_token = getStringCopy(action_token);
13622     *strchr(action_token + 1, '.') = '\0';
13623
13624     action_value = getHashEntry(action_hash, action_token);
13625
13626     if (action_value == NULL)           // this is no action
13627     {
13628       element_value = getHashEntry(element_hash, list->token);
13629       if (element_value != NULL)        // combined element found
13630         add_helpanim_entry(atoi(element_value), -1, -1, delay,
13631                            &num_list_entries);
13632       else
13633         print_unknown_token(filename, list->token, num_unknown_tokens++);
13634
13635       free(element_token);
13636       free(action_token);
13637
13638       continue;
13639     }
13640
13641     direction_value = getHashEntry(direction_hash, direction_token);
13642
13643     if (direction_value != NULL)        // direction found
13644     {
13645       add_helpanim_entry(atoi(element_value), atoi(action_value),
13646                          atoi(direction_value), delay, &num_list_entries);
13647
13648       free(element_token);
13649       free(action_token);
13650
13651       continue;
13652     }
13653
13654     // this is no direction
13655
13656     element_value = getHashEntry(element_hash, list->token);
13657     if (element_value != NULL)          // combined element found
13658       add_helpanim_entry(atoi(element_value), -1, -1, delay,
13659                          &num_list_entries);
13660     else
13661       print_unknown_token(filename, list->token, num_unknown_tokens++);
13662
13663     free(element_token);
13664     free(action_token);
13665   }
13666
13667   print_unknown_token_end(num_unknown_tokens);
13668
13669   add_helpanim_entry(HELPANIM_LIST_NEXT, -1, -1, -1, &num_list_entries);
13670   add_helpanim_entry(HELPANIM_LIST_END,  -1, -1, -1, &num_list_entries);
13671
13672   freeSetupFileList(setup_file_list);
13673   freeSetupFileHash(element_hash);
13674   freeSetupFileHash(action_hash);
13675   freeSetupFileHash(direction_hash);
13676
13677 #if 0
13678   for (i = 0; i < num_list_entries; i++)
13679     Debug("files:LoadHelpAnimInfo", "'%s': %d, %d, %d => %d",
13680           EL_NAME(helpanim_info[i].element),
13681           helpanim_info[i].element,
13682           helpanim_info[i].action,
13683           helpanim_info[i].direction,
13684           helpanim_info[i].delay);
13685 #endif
13686 }
13687
13688 void LoadHelpTextInfo(void)
13689 {
13690   char *filename = getHelpTextFilename();
13691   int i;
13692
13693   if (helptext_info != NULL)
13694   {
13695     freeSetupFileHash(helptext_info);
13696     helptext_info = NULL;
13697   }
13698
13699   if (fileExists(filename))
13700     helptext_info = loadSetupFileHash(filename);
13701
13702   if (helptext_info == NULL)
13703   {
13704     // use reliable default values from static configuration
13705     helptext_info = newSetupFileHash();
13706
13707     for (i = 0; helptext_config[i].token; i++)
13708       setHashEntry(helptext_info,
13709                    helptext_config[i].token,
13710                    helptext_config[i].value);
13711   }
13712
13713 #if 0
13714   BEGIN_HASH_ITERATION(helptext_info, itr)
13715   {
13716     Debug("files:LoadHelpTextInfo", "'%s' => '%s'",
13717           HASH_ITERATION_TOKEN(itr), HASH_ITERATION_VALUE(itr));
13718   }
13719   END_HASH_ITERATION(hash, itr)
13720 #endif
13721 }
13722
13723
13724 // ----------------------------------------------------------------------------
13725 // convert levels
13726 // ----------------------------------------------------------------------------
13727
13728 #define MAX_NUM_CONVERT_LEVELS          1000
13729
13730 void ConvertLevels(void)
13731 {
13732   static LevelDirTree *convert_leveldir = NULL;
13733   static int convert_level_nr = -1;
13734   static int num_levels_handled = 0;
13735   static int num_levels_converted = 0;
13736   static boolean levels_failed[MAX_NUM_CONVERT_LEVELS];
13737   int i;
13738
13739   convert_leveldir = getTreeInfoFromIdentifier(leveldir_first,
13740                                                global.convert_leveldir);
13741
13742   if (convert_leveldir == NULL)
13743     Fail("no such level identifier: '%s'", global.convert_leveldir);
13744
13745   leveldir_current = convert_leveldir;
13746
13747   if (global.convert_level_nr != -1)
13748   {
13749     convert_leveldir->first_level = global.convert_level_nr;
13750     convert_leveldir->last_level  = global.convert_level_nr;
13751   }
13752
13753   convert_level_nr = convert_leveldir->first_level;
13754
13755   PrintLine("=", 79);
13756   Print("Converting levels\n");
13757   PrintLine("-", 79);
13758   Print("Level series identifier: '%s'\n", convert_leveldir->identifier);
13759   Print("Level series name:       '%s'\n", convert_leveldir->name);
13760   Print("Level series author:     '%s'\n", convert_leveldir->author);
13761   Print("Number of levels:        %d\n",   convert_leveldir->levels);
13762   PrintLine("=", 79);
13763   Print("\n");
13764
13765   for (i = 0; i < MAX_NUM_CONVERT_LEVELS; i++)
13766     levels_failed[i] = FALSE;
13767
13768   while (convert_level_nr <= convert_leveldir->last_level)
13769   {
13770     char *level_filename;
13771     boolean new_level;
13772
13773     level_nr = convert_level_nr++;
13774
13775     Print("Level %03d: ", level_nr);
13776
13777     LoadLevel(level_nr);
13778     if (level.no_level_file || level.no_valid_file)
13779     {
13780       Print("(no level)\n");
13781       continue;
13782     }
13783
13784     Print("converting level ... ");
13785
13786 #if 0
13787     // special case: conversion of some EMC levels as requested by ACME
13788     level.game_engine_type = GAME_ENGINE_TYPE_RND;
13789 #endif
13790
13791     level_filename = getDefaultLevelFilename(level_nr);
13792     new_level = !fileExists(level_filename);
13793
13794     if (new_level)
13795     {
13796       SaveLevel(level_nr);
13797
13798       num_levels_converted++;
13799
13800       Print("converted.\n");
13801     }
13802     else
13803     {
13804       if (level_nr >= 0 && level_nr < MAX_NUM_CONVERT_LEVELS)
13805         levels_failed[level_nr] = TRUE;
13806
13807       Print("NOT CONVERTED -- LEVEL ALREADY EXISTS.\n");
13808     }
13809
13810     num_levels_handled++;
13811   }
13812
13813   Print("\n");
13814   PrintLine("=", 79);
13815   Print("Number of levels handled: %d\n", num_levels_handled);
13816   Print("Number of levels converted: %d (%d%%)\n", num_levels_converted,
13817          (num_levels_handled ?
13818           num_levels_converted * 100 / num_levels_handled : 0));
13819   PrintLine("-", 79);
13820   Print("Summary (for automatic parsing by scripts):\n");
13821   Print("LEVELDIR '%s', CONVERTED %d/%d (%d%%)",
13822          convert_leveldir->identifier, num_levels_converted,
13823          num_levels_handled,
13824          (num_levels_handled ?
13825           num_levels_converted * 100 / num_levels_handled : 0));
13826
13827   if (num_levels_handled != num_levels_converted)
13828   {
13829     Print(", FAILED:");
13830     for (i = 0; i < MAX_NUM_CONVERT_LEVELS; i++)
13831       if (levels_failed[i])
13832         Print(" %03d", i);
13833   }
13834
13835   Print("\n");
13836   PrintLine("=", 79);
13837
13838   CloseAllAndExit(0);
13839 }
13840
13841
13842 // ----------------------------------------------------------------------------
13843 // create and save images for use in level sketches (raw BMP format)
13844 // ----------------------------------------------------------------------------
13845
13846 void CreateLevelSketchImages(void)
13847 {
13848   Bitmap *bitmap1;
13849   Bitmap *bitmap2;
13850   int i;
13851
13852   InitElementPropertiesGfxElement();
13853
13854   bitmap1 = CreateBitmap(TILEX, TILEY, DEFAULT_DEPTH);
13855   bitmap2 = CreateBitmap(MINI_TILEX, MINI_TILEY, DEFAULT_DEPTH);
13856
13857   for (i = 0; i < NUM_FILE_ELEMENTS; i++)
13858   {
13859     int element = getMappedElement(i);
13860     char basename1[16];
13861     char basename2[16];
13862     char *filename1;
13863     char *filename2;
13864
13865     sprintf(basename1, "%04d.bmp", i);
13866     sprintf(basename2, "%04ds.bmp", i);
13867
13868     filename1 = getPath2(global.create_sketch_images_dir, basename1);
13869     filename2 = getPath2(global.create_sketch_images_dir, basename2);
13870
13871     DrawSizedElement(0, 0, element, TILESIZE);
13872     BlitBitmap(drawto, bitmap1, SX, SY, TILEX, TILEY, 0, 0);
13873
13874     if (SDL_SaveBMP(bitmap1->surface, filename1) != 0)
13875       Fail("cannot save level sketch image file '%s'", filename1);
13876
13877     DrawSizedElement(0, 0, element, MINI_TILESIZE);
13878     BlitBitmap(drawto, bitmap2, SX, SY, MINI_TILEX, MINI_TILEY, 0, 0);
13879
13880     if (SDL_SaveBMP(bitmap2->surface, filename2) != 0)
13881       Fail("cannot save level sketch image file '%s'", filename2);
13882
13883     free(filename1);
13884     free(filename2);
13885
13886     // create corresponding SQL statements (for normal and small images)
13887     if (i < 1000)
13888     {
13889       printf("insert into phpbb_words values (NULL, '`%03d', '<IMG class=\"levelsketch\" src=\"/I/%04d.png\"/>');\n", i, i);
13890       printf("insert into phpbb_words values (NULL, '¸%03d', '<IMG class=\"levelsketch\" src=\"/I/%04ds.png\"/>');\n", i, i);
13891     }
13892
13893     printf("insert into phpbb_words values (NULL, '`%04d', '<IMG class=\"levelsketch\" src=\"/I/%04d.png\"/>');\n", i, i);
13894     printf("insert into phpbb_words values (NULL, '¸%04d', '<IMG class=\"levelsketch\" src=\"/I/%04ds.png\"/>');\n", i, i);
13895
13896     // optional: create content for forum level sketch demonstration post
13897     if (options.debug)
13898       fprintf(stderr, "%03d `%03d%c", i, i, (i % 10 < 9 ? ' ' : '\n'));
13899   }
13900
13901   FreeBitmap(bitmap1);
13902   FreeBitmap(bitmap2);
13903
13904   if (options.debug)
13905     fprintf(stderr, "\n");
13906
13907   Info("%d normal and small images created", NUM_FILE_ELEMENTS);
13908
13909   CloseAllAndExit(0);
13910 }
13911
13912
13913 // ----------------------------------------------------------------------------
13914 // create and save images for element collecting animations (raw BMP format)
13915 // ----------------------------------------------------------------------------
13916
13917 static boolean createCollectImage(int element)
13918 {
13919   return (IS_COLLECTIBLE(element) && !IS_SP_ELEMENT(element));
13920 }
13921
13922 void CreateCollectElementImages(void)
13923 {
13924   int i, j;
13925   int num_steps = 8;
13926   int anim_frames = num_steps - 1;
13927   int tile_size = TILESIZE;
13928   int anim_width  = tile_size * anim_frames;
13929   int anim_height = tile_size;
13930   int num_collect_images = 0;
13931   int pos_collect_images = 0;
13932
13933   for (i = 0; i < MAX_NUM_ELEMENTS; i++)
13934     if (createCollectImage(i))
13935       num_collect_images++;
13936
13937   Info("Creating %d element collecting animation images ...",
13938        num_collect_images);
13939
13940   int dst_width  = anim_width * 2;
13941   int dst_height = anim_height * num_collect_images / 2;
13942   Bitmap *dst_bitmap = CreateBitmap(dst_width, dst_height, DEFAULT_DEPTH);
13943   char *basename_bmp = "RocksCollect.bmp";
13944   char *basename_png = "RocksCollect.png";
13945   char *filename_bmp = getPath2(global.create_collect_images_dir, basename_bmp);
13946   char *filename_png = getPath2(global.create_collect_images_dir, basename_png);
13947   int len_filename_bmp = strlen(filename_bmp);
13948   int len_filename_png = strlen(filename_png);
13949   int max_command_len = MAX_FILENAME_LEN + len_filename_bmp + len_filename_png;
13950   char cmd_convert[max_command_len];
13951
13952   snprintf(cmd_convert, max_command_len, "convert \"%s\" \"%s\"",
13953            filename_bmp,
13954            filename_png);
13955
13956   // force using RGBA surface for destination bitmap
13957   SDL_SetColorKey(dst_bitmap->surface, SET_TRANSPARENT_PIXEL,
13958                   SDL_MapRGB(dst_bitmap->surface->format, 0x00, 0x00, 0x00));
13959
13960   dst_bitmap->surface =
13961     SDL_ConvertSurfaceFormat(dst_bitmap->surface, SDL_PIXELFORMAT_ARGB8888, 0);
13962
13963   for (i = 0; i < MAX_NUM_ELEMENTS; i++)
13964   {
13965     if (!createCollectImage(i))
13966       continue;
13967
13968     int dst_x = (pos_collect_images / (num_collect_images / 2)) * anim_width;
13969     int dst_y = (pos_collect_images % (num_collect_images / 2)) * anim_height;
13970     int graphic = el2img(i);
13971     char *token_name = element_info[i].token_name;
13972     Bitmap *tmp_bitmap = CreateBitmap(tile_size, tile_size, DEFAULT_DEPTH);
13973     Bitmap *src_bitmap;
13974     int src_x, src_y;
13975
13976     Info("- creating collecting image for '%s' ...", token_name);
13977
13978     getGraphicSource(graphic, 0, &src_bitmap, &src_x, &src_y);
13979
13980     BlitBitmap(src_bitmap, tmp_bitmap, src_x, src_y,
13981                tile_size, tile_size, 0, 0);
13982
13983     // force using RGBA surface for temporary bitmap (using transparent black)
13984     SDL_SetColorKey(tmp_bitmap->surface, SET_TRANSPARENT_PIXEL,
13985                     SDL_MapRGB(tmp_bitmap->surface->format, 0x00, 0x00, 0x00));
13986
13987     tmp_bitmap->surface =
13988       SDL_ConvertSurfaceFormat(tmp_bitmap->surface, SDL_PIXELFORMAT_ARGB8888, 0);
13989
13990     tmp_bitmap->surface_masked = tmp_bitmap->surface;
13991
13992     for (j = 0; j < anim_frames; j++)
13993     {
13994       int frame_size_final = tile_size * (anim_frames - j) / num_steps;
13995       int frame_size = frame_size_final * num_steps;
13996       int offset = (tile_size - frame_size_final) / 2;
13997       Bitmap *frame_bitmap = ZoomBitmap(tmp_bitmap, frame_size, frame_size);
13998
13999       while (frame_size > frame_size_final)
14000       {
14001         frame_size /= 2;
14002
14003         Bitmap *half_bitmap = ZoomBitmap(frame_bitmap, frame_size, frame_size);
14004
14005         FreeBitmap(frame_bitmap);
14006
14007         frame_bitmap = half_bitmap;
14008       }
14009
14010       BlitBitmapMasked(frame_bitmap, dst_bitmap, 0, 0,
14011                        frame_size_final, frame_size_final,
14012                        dst_x + j * tile_size + offset, dst_y + offset);
14013
14014       FreeBitmap(frame_bitmap);
14015     }
14016
14017     tmp_bitmap->surface_masked = NULL;
14018
14019     FreeBitmap(tmp_bitmap);
14020
14021     pos_collect_images++;
14022   }
14023
14024   if (SDL_SaveBMP(dst_bitmap->surface, filename_bmp) != 0)
14025     Fail("cannot save element collecting image file '%s'", filename_bmp);
14026
14027   FreeBitmap(dst_bitmap);
14028
14029   Info("Converting image file from BMP to PNG ...");
14030
14031   if (system(cmd_convert) != 0)
14032     Fail("converting image file failed");
14033
14034   unlink(filename_bmp);
14035
14036   Info("Done.");
14037
14038   CloseAllAndExit(0);
14039 }
14040
14041
14042 // ----------------------------------------------------------------------------
14043 // create and save images for custom and group elements (raw BMP format)
14044 // ----------------------------------------------------------------------------
14045
14046 void CreateCustomElementImages(char *directory)
14047 {
14048   char *src_basename = "RocksCE-template.ilbm";
14049   char *dst_basename = "RocksCE.bmp";
14050   char *src_filename = getPath2(directory, src_basename);
14051   char *dst_filename = getPath2(directory, dst_basename);
14052   Bitmap *src_bitmap;
14053   Bitmap *bitmap;
14054   int yoffset_ce = 0;
14055   int yoffset_ge = (TILEY * NUM_CUSTOM_ELEMENTS / 16);
14056   int i;
14057
14058   InitVideoDefaults();
14059
14060   ReCreateBitmap(&backbuffer, video.width, video.height);
14061
14062   src_bitmap = LoadImage(src_filename);
14063
14064   bitmap = CreateBitmap(TILEX * 16 * 2,
14065                         TILEY * (NUM_CUSTOM_ELEMENTS + NUM_GROUP_ELEMENTS) / 16,
14066                         DEFAULT_DEPTH);
14067
14068   for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
14069   {
14070     int x = i % 16;
14071     int y = i / 16;
14072     int ii = i + 1;
14073     int j;
14074
14075     BlitBitmap(src_bitmap, bitmap, 0, 0, TILEX, TILEY,
14076                TILEX * x, TILEY * y + yoffset_ce);
14077
14078     BlitBitmap(src_bitmap, bitmap, 0, TILEY,
14079                TILEX, TILEY,
14080                TILEX * x + TILEX * 16,
14081                TILEY * y + yoffset_ce);
14082
14083     for (j = 2; j >= 0; j--)
14084     {
14085       int c = ii % 10;
14086
14087       BlitBitmap(src_bitmap, bitmap,
14088                  TILEX + c * 7, 0, 6, 10,
14089                  TILEX * x + 6 + j * 7,
14090                  TILEY * y + 11 + yoffset_ce);
14091
14092       BlitBitmap(src_bitmap, bitmap,
14093                  TILEX + c * 8, TILEY, 6, 10,
14094                  TILEX * 16 + TILEX * x + 6 + j * 8,
14095                  TILEY * y + 10 + yoffset_ce);
14096
14097       ii /= 10;
14098     }
14099   }
14100
14101   for (i = 0; i < NUM_GROUP_ELEMENTS; i++)
14102   {
14103     int x = i % 16;
14104     int y = i / 16;
14105     int ii = i + 1;
14106     int j;
14107
14108     BlitBitmap(src_bitmap, bitmap, 0, 0, TILEX, TILEY,
14109                TILEX * x, TILEY * y + yoffset_ge);
14110
14111     BlitBitmap(src_bitmap, bitmap, 0, TILEY,
14112                TILEX, TILEY,
14113                TILEX * x + TILEX * 16,
14114                TILEY * y + yoffset_ge);
14115
14116     for (j = 1; j >= 0; j--)
14117     {
14118       int c = ii % 10;
14119
14120       BlitBitmap(src_bitmap, bitmap, TILEX + c * 10, 11, 10, 10,
14121                  TILEX * x + 6 + j * 10,
14122                  TILEY * y + 11 + yoffset_ge);
14123
14124       BlitBitmap(src_bitmap, bitmap,
14125                  TILEX + c * 8, TILEY + 12, 6, 10,
14126                  TILEX * 16 + TILEX * x + 10 + j * 8,
14127                  TILEY * y + 10 + yoffset_ge);
14128
14129       ii /= 10;
14130     }
14131   }
14132
14133   if (SDL_SaveBMP(bitmap->surface, dst_filename) != 0)
14134     Fail("cannot save CE graphics file '%s'", dst_filename);
14135
14136   FreeBitmap(bitmap);
14137
14138   CloseAllAndExit(0);
14139 }