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