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