1 // ============================================================================
2 // Rocks'n'Diamonds - McDuffin Strikes Back!
3 // ----------------------------------------------------------------------------
4 // (c) 1995-2014 by Artsoft Entertainment
7 // https://www.artsoft.org/
8 // ----------------------------------------------------------------------------
10 // ============================================================================
17 #include "libgame/libgame.h"
26 #define ENABLE_UNUSED_CODE 0 // currently unused functions
27 #define ENABLE_HISTORIC_CHUNKS 0 // only for historic reference
28 #define ENABLE_RESERVED_CODE 0 // reserved for later use
30 #define CHUNK_ID_LEN 4 // IFF style chunk id length
31 #define CHUNK_SIZE_UNDEFINED 0 // undefined chunk size == 0
32 #define CHUNK_SIZE_NONE -1 // do not write chunk size
34 #define LEVEL_CHUNK_NAME_SIZE MAX_LEVEL_NAME_LEN
35 #define LEVEL_CHUNK_AUTH_SIZE MAX_LEVEL_AUTHOR_LEN
37 #define LEVEL_CHUNK_VERS_SIZE 8 // size of file version chunk
38 #define LEVEL_CHUNK_DATE_SIZE 4 // size of file date chunk
39 #define LEVEL_CHUNK_HEAD_SIZE 80 // size of level file header
40 #define LEVEL_CHUNK_HEAD_UNUSED 0 // unused level header bytes
41 #define LEVEL_CHUNK_CNT2_SIZE 160 // size of level CNT2 chunk
42 #define LEVEL_CHUNK_CNT2_UNUSED 11 // unused CNT2 chunk bytes
43 #define LEVEL_CHUNK_CNT3_HEADER 16 // size of level CNT3 header
44 #define LEVEL_CHUNK_CNT3_UNUSED 10 // unused CNT3 chunk bytes
45 #define LEVEL_CPART_CUS3_SIZE 134 // size of CUS3 chunk part
46 #define LEVEL_CPART_CUS3_UNUSED 15 // unused CUS3 bytes / part
47 #define LEVEL_CHUNK_GRP1_SIZE 74 // size of level GRP1 chunk
49 // (element number, number of change pages, change page number)
50 #define LEVEL_CHUNK_CUSX_UNCHANGED (2 + (1 + 1) + (1 + 1))
52 // (element number only)
53 #define LEVEL_CHUNK_GRPX_UNCHANGED 2
54 #define LEVEL_CHUNK_NOTE_UNCHANGED 2
56 // (nothing at all if unchanged)
57 #define LEVEL_CHUNK_ELEM_UNCHANGED 0
59 #define TAPE_CHUNK_VERS_SIZE 8 // size of file version chunk
60 #define TAPE_CHUNK_HEAD_SIZE 20 // size of tape file header
61 #define TAPE_CHUNK_HEAD_UNUSED 1 // unused tape header bytes
62 #define TAPE_CHUNK_SCRN_SIZE 2 // size of screen size chunk
64 #define SCORE_CHUNK_VERS_SIZE 8 // size of file version chunk
66 #define LEVEL_CHUNK_CNT3_SIZE(x) (LEVEL_CHUNK_CNT3_HEADER + (x))
67 #define LEVEL_CHUNK_CUS3_SIZE(x) (2 + (x) * LEVEL_CPART_CUS3_SIZE)
68 #define LEVEL_CHUNK_CUS4_SIZE(x) (96 + (x) * 48)
70 // file identifier strings
71 #define LEVEL_COOKIE_TMPL "ROCKSNDIAMONDS_LEVEL_FILE_VERSION_x.x"
72 #define TAPE_COOKIE_TMPL "ROCKSNDIAMONDS_TAPE_FILE_VERSION_x.x"
73 #define SCORE_COOKIE_TMPL "ROCKSNDIAMONDS_SCORE_FILE_VERSION_x.x"
75 // values for deciding when (not) to save configuration data
76 #define SAVE_CONF_NEVER 0
77 #define SAVE_CONF_ALWAYS 1
78 #define SAVE_CONF_WHEN_CHANGED -1
80 // values for chunks using micro chunks
81 #define CONF_MASK_1_BYTE 0x00
82 #define CONF_MASK_2_BYTE 0x40
83 #define CONF_MASK_4_BYTE 0x80
84 #define CONF_MASK_MULTI_BYTES 0xc0
86 #define CONF_MASK_BYTES 0xc0
87 #define CONF_MASK_TOKEN 0x3f
89 #define CONF_VALUE_1_BYTE(x) (CONF_MASK_1_BYTE | (x))
90 #define CONF_VALUE_2_BYTE(x) (CONF_MASK_2_BYTE | (x))
91 #define CONF_VALUE_4_BYTE(x) (CONF_MASK_4_BYTE | (x))
92 #define CONF_VALUE_MULTI_BYTES(x) (CONF_MASK_MULTI_BYTES | (x))
94 // these definitions are just for convenience of use and readability
95 #define CONF_VALUE_8_BIT(x) CONF_VALUE_1_BYTE(x)
96 #define CONF_VALUE_16_BIT(x) CONF_VALUE_2_BYTE(x)
97 #define CONF_VALUE_32_BIT(x) CONF_VALUE_4_BYTE(x)
98 #define CONF_VALUE_BYTES(x) CONF_VALUE_MULTI_BYTES(x)
100 #define CONF_VALUE_NUM_BYTES(x) ((x) == CONF_MASK_1_BYTE ? 1 : \
101 (x) == CONF_MASK_2_BYTE ? 2 : \
102 (x) == CONF_MASK_4_BYTE ? 4 : 0)
104 #define CONF_CONTENT_NUM_ELEMENTS (3 * 3)
105 #define CONF_CONTENT_NUM_BYTES (CONF_CONTENT_NUM_ELEMENTS * 2)
106 #define CONF_ELEMENT_NUM_BYTES (2)
108 #define CONF_ENTITY_NUM_BYTES(t) ((t) == TYPE_ELEMENT || \
109 (t) == TYPE_ELEMENT_LIST ? \
110 CONF_ELEMENT_NUM_BYTES : \
111 (t) == TYPE_CONTENT || \
112 (t) == TYPE_CONTENT_LIST ? \
113 CONF_CONTENT_NUM_BYTES : 1)
115 #define CONF_ELEMENT_BYTE_POS(i) ((i) * CONF_ELEMENT_NUM_BYTES)
116 #define CONF_ELEMENTS_ELEMENT(b,i) ((b[CONF_ELEMENT_BYTE_POS(i)] << 8) | \
117 (b[CONF_ELEMENT_BYTE_POS(i) + 1]))
119 #define CONF_CONTENT_ELEMENT_POS(c,x,y) ((c) * CONF_CONTENT_NUM_ELEMENTS + \
121 #define CONF_CONTENT_BYTE_POS(c,x,y) (CONF_CONTENT_ELEMENT_POS(c,x,y) * \
122 CONF_ELEMENT_NUM_BYTES)
123 #define CONF_CONTENTS_ELEMENT(b,c,x,y) ((b[CONF_CONTENT_BYTE_POS(c,x,y)]<< 8)|\
124 (b[CONF_CONTENT_BYTE_POS(c,x,y) + 1]))
126 // temporary variables used to store pointers to structure members
127 static struct LevelInfo li;
128 static struct ElementInfo xx_ei, yy_ei;
129 static struct ElementChangeInfo xx_change;
130 static struct ElementGroupInfo xx_group;
131 static struct EnvelopeInfo xx_envelope;
132 static unsigned int xx_event_bits[NUM_CE_BITFIELDS];
133 static char xx_default_description[MAX_ELEMENT_NAME_LEN + 1];
134 static int xx_num_contents;
135 static int xx_current_change_page;
136 static char xx_default_string_empty[1] = "";
137 static int xx_string_length_unused;
139 struct LevelFileConfigInfo
141 int element; // element for which data is to be stored
142 int save_type; // save data always, never or when changed
143 int data_type; // data type (used internally, not stored)
144 int conf_type; // micro chunk identifier (stored in file)
147 void *value; // variable that holds the data to be stored
148 int default_value; // initial default value for this variable
151 void *value_copy; // variable that holds the data to be copied
152 void *num_entities; // number of entities for multi-byte data
153 int default_num_entities; // default number of entities for this data
154 int max_num_entities; // maximal number of entities for this data
155 char *default_string; // optional default string for string data
158 static struct LevelFileConfigInfo chunk_config_INFO[] =
160 // ---------- values not related to single elements -------------------------
163 -1, SAVE_CONF_ALWAYS,
164 TYPE_INTEGER, CONF_VALUE_8_BIT(1),
165 &li.game_engine_type, GAME_ENGINE_TYPE_RND
169 -1, SAVE_CONF_ALWAYS,
170 TYPE_INTEGER, CONF_VALUE_16_BIT(1),
171 &li.fieldx, STD_LEV_FIELDX
174 -1, SAVE_CONF_ALWAYS,
175 TYPE_INTEGER, CONF_VALUE_16_BIT(2),
176 &li.fieldy, STD_LEV_FIELDY
180 -1, SAVE_CONF_ALWAYS,
181 TYPE_INTEGER, CONF_VALUE_16_BIT(3),
186 -1, SAVE_CONF_ALWAYS,
187 TYPE_INTEGER, CONF_VALUE_16_BIT(4),
193 TYPE_INTEGER, CONF_VALUE_32_BIT(2),
199 TYPE_BOOLEAN, CONF_VALUE_8_BIT(2),
200 &li.use_step_counter, FALSE
205 TYPE_BITFIELD, CONF_VALUE_8_BIT(4),
206 &li.wind_direction_initial, MV_NONE
211 TYPE_BOOLEAN, CONF_VALUE_8_BIT(5),
212 &li.em_slippery_gems, FALSE
217 TYPE_BOOLEAN, CONF_VALUE_8_BIT(6),
218 &li.use_custom_template, FALSE
223 TYPE_BITFIELD, CONF_VALUE_32_BIT(1),
224 &li.can_move_into_acid_bits, ~0 // default: everything can
229 TYPE_BITFIELD, CONF_VALUE_8_BIT(7),
230 &li.dont_collide_with_bits, ~0 // default: always deadly
235 TYPE_BOOLEAN, CONF_VALUE_8_BIT(8),
236 &li.em_explodes_by_fire, FALSE
241 TYPE_INTEGER, CONF_VALUE_16_BIT(5),
242 &li.score[SC_TIME_BONUS], 1
247 TYPE_BOOLEAN, CONF_VALUE_8_BIT(9),
248 &li.auto_exit_sokoban, FALSE
253 TYPE_BOOLEAN, CONF_VALUE_8_BIT(10),
254 &li.auto_count_gems, FALSE
259 TYPE_BOOLEAN, CONF_VALUE_8_BIT(11),
260 &li.solved_by_one_player, FALSE
265 TYPE_INTEGER, CONF_VALUE_8_BIT(12),
266 &li.time_score_base, 1
271 TYPE_BOOLEAN, CONF_VALUE_8_BIT(13),
272 &li.rate_time_over_score, FALSE
282 static struct LevelFileConfigInfo chunk_config_ELEM[] =
284 // (these values are the same for each player)
287 TYPE_BOOLEAN, CONF_VALUE_8_BIT(1),
288 &li.block_last_field, FALSE // default case for EM levels
292 TYPE_BOOLEAN, CONF_VALUE_8_BIT(2),
293 &li.sp_block_last_field, TRUE // default case for SP levels
297 TYPE_BOOLEAN, CONF_VALUE_8_BIT(3),
298 &li.instant_relocation, FALSE
302 TYPE_BOOLEAN, CONF_VALUE_8_BIT(4),
303 &li.can_pass_to_walkable, FALSE
307 TYPE_BOOLEAN, CONF_VALUE_8_BIT(5),
308 &li.block_snap_field, TRUE
312 TYPE_BOOLEAN, CONF_VALUE_8_BIT(6),
313 &li.continuous_snapping, TRUE
317 TYPE_BOOLEAN, CONF_VALUE_8_BIT(12),
318 &li.shifted_relocation, FALSE
322 TYPE_BOOLEAN, CONF_VALUE_8_BIT(15),
323 &li.lazy_relocation, FALSE
327 TYPE_BOOLEAN, CONF_VALUE_8_BIT(16),
328 &li.finish_dig_collect, TRUE
331 // (these values are different for each player)
334 TYPE_INTEGER, CONF_VALUE_8_BIT(7),
335 &li.initial_player_stepsize[0], STEPSIZE_NORMAL
339 TYPE_BOOLEAN, CONF_VALUE_8_BIT(8),
340 &li.initial_player_gravity[0], FALSE
344 TYPE_BOOLEAN, CONF_VALUE_8_BIT(9),
345 &li.use_start_element[0], FALSE
349 TYPE_ELEMENT, CONF_VALUE_16_BIT(1),
350 &li.start_element[0], EL_PLAYER_1
354 TYPE_BOOLEAN, CONF_VALUE_8_BIT(10),
355 &li.use_artwork_element[0], FALSE
359 TYPE_ELEMENT, CONF_VALUE_16_BIT(2),
360 &li.artwork_element[0], EL_PLAYER_1
364 TYPE_BOOLEAN, CONF_VALUE_8_BIT(11),
365 &li.use_explosion_element[0], FALSE
369 TYPE_ELEMENT, CONF_VALUE_16_BIT(3),
370 &li.explosion_element[0], EL_PLAYER_1
374 TYPE_BOOLEAN, CONF_VALUE_8_BIT(13),
375 &li.use_initial_inventory[0], FALSE
379 TYPE_BOOLEAN, CONF_VALUE_8_BIT(14),
380 &li.initial_inventory_size[0], 1
384 TYPE_ELEMENT_LIST, CONF_VALUE_BYTES(1),
385 &li.initial_inventory_content[0][0],EL_EMPTY, NULL,
386 &li.initial_inventory_size[0], 1, MAX_INITIAL_INVENTORY_SIZE
391 TYPE_INTEGER, CONF_VALUE_8_BIT(7),
392 &li.initial_player_stepsize[1], STEPSIZE_NORMAL
396 TYPE_BOOLEAN, CONF_VALUE_8_BIT(8),
397 &li.initial_player_gravity[1], FALSE
401 TYPE_BOOLEAN, CONF_VALUE_8_BIT(9),
402 &li.use_start_element[1], FALSE
406 TYPE_ELEMENT, CONF_VALUE_16_BIT(1),
407 &li.start_element[1], EL_PLAYER_2
411 TYPE_BOOLEAN, CONF_VALUE_8_BIT(10),
412 &li.use_artwork_element[1], FALSE
416 TYPE_ELEMENT, CONF_VALUE_16_BIT(2),
417 &li.artwork_element[1], EL_PLAYER_2
421 TYPE_BOOLEAN, CONF_VALUE_8_BIT(11),
422 &li.use_explosion_element[1], FALSE
426 TYPE_ELEMENT, CONF_VALUE_16_BIT(3),
427 &li.explosion_element[1], EL_PLAYER_2
431 TYPE_BOOLEAN, CONF_VALUE_8_BIT(13),
432 &li.use_initial_inventory[1], FALSE
436 TYPE_BOOLEAN, CONF_VALUE_8_BIT(14),
437 &li.initial_inventory_size[1], 1
441 TYPE_ELEMENT_LIST, CONF_VALUE_BYTES(1),
442 &li.initial_inventory_content[1][0],EL_EMPTY, NULL,
443 &li.initial_inventory_size[1], 1, MAX_INITIAL_INVENTORY_SIZE
448 TYPE_INTEGER, CONF_VALUE_8_BIT(7),
449 &li.initial_player_stepsize[2], STEPSIZE_NORMAL
453 TYPE_BOOLEAN, CONF_VALUE_8_BIT(8),
454 &li.initial_player_gravity[2], FALSE
458 TYPE_BOOLEAN, CONF_VALUE_8_BIT(9),
459 &li.use_start_element[2], FALSE
463 TYPE_ELEMENT, CONF_VALUE_16_BIT(1),
464 &li.start_element[2], EL_PLAYER_3
468 TYPE_BOOLEAN, CONF_VALUE_8_BIT(10),
469 &li.use_artwork_element[2], FALSE
473 TYPE_ELEMENT, CONF_VALUE_16_BIT(2),
474 &li.artwork_element[2], EL_PLAYER_3
478 TYPE_BOOLEAN, CONF_VALUE_8_BIT(11),
479 &li.use_explosion_element[2], FALSE
483 TYPE_ELEMENT, CONF_VALUE_16_BIT(3),
484 &li.explosion_element[2], EL_PLAYER_3
488 TYPE_BOOLEAN, CONF_VALUE_8_BIT(13),
489 &li.use_initial_inventory[2], FALSE
493 TYPE_BOOLEAN, CONF_VALUE_8_BIT(14),
494 &li.initial_inventory_size[2], 1
498 TYPE_ELEMENT_LIST, CONF_VALUE_BYTES(1),
499 &li.initial_inventory_content[2][0],EL_EMPTY, NULL,
500 &li.initial_inventory_size[2], 1, MAX_INITIAL_INVENTORY_SIZE
505 TYPE_INTEGER, CONF_VALUE_8_BIT(7),
506 &li.initial_player_stepsize[3], STEPSIZE_NORMAL
510 TYPE_BOOLEAN, CONF_VALUE_8_BIT(8),
511 &li.initial_player_gravity[3], FALSE
515 TYPE_BOOLEAN, CONF_VALUE_8_BIT(9),
516 &li.use_start_element[3], FALSE
520 TYPE_ELEMENT, CONF_VALUE_16_BIT(1),
521 &li.start_element[3], EL_PLAYER_4
525 TYPE_BOOLEAN, CONF_VALUE_8_BIT(10),
526 &li.use_artwork_element[3], FALSE
530 TYPE_ELEMENT, CONF_VALUE_16_BIT(2),
531 &li.artwork_element[3], EL_PLAYER_4
535 TYPE_BOOLEAN, CONF_VALUE_8_BIT(11),
536 &li.use_explosion_element[3], FALSE
540 TYPE_ELEMENT, CONF_VALUE_16_BIT(3),
541 &li.explosion_element[3], EL_PLAYER_4
545 TYPE_BOOLEAN, CONF_VALUE_8_BIT(13),
546 &li.use_initial_inventory[3], FALSE
550 TYPE_BOOLEAN, CONF_VALUE_8_BIT(14),
551 &li.initial_inventory_size[3], 1
555 TYPE_ELEMENT_LIST, CONF_VALUE_BYTES(1),
556 &li.initial_inventory_content[3][0],EL_EMPTY, NULL,
557 &li.initial_inventory_size[3], 1, MAX_INITIAL_INVENTORY_SIZE
562 TYPE_INTEGER, CONF_VALUE_16_BIT(1),
563 &li.score[SC_EMERALD], 10
568 TYPE_INTEGER, CONF_VALUE_16_BIT(1),
569 &li.score[SC_DIAMOND], 10
574 TYPE_INTEGER, CONF_VALUE_16_BIT(1),
575 &li.score[SC_BUG], 10
580 TYPE_INTEGER, CONF_VALUE_16_BIT(1),
581 &li.score[SC_SPACESHIP], 10
586 TYPE_INTEGER, CONF_VALUE_16_BIT(1),
587 &li.score[SC_PACMAN], 10
592 TYPE_INTEGER, CONF_VALUE_16_BIT(1),
593 &li.score[SC_NUT], 10
598 TYPE_INTEGER, CONF_VALUE_16_BIT(1),
599 &li.score[SC_DYNAMITE], 10
604 TYPE_INTEGER, CONF_VALUE_16_BIT(1),
605 &li.score[SC_KEY], 10
610 TYPE_INTEGER, CONF_VALUE_16_BIT(1),
611 &li.score[SC_PEARL], 10
616 TYPE_INTEGER, CONF_VALUE_16_BIT(1),
617 &li.score[SC_CRYSTAL], 10
622 TYPE_ELEMENT, CONF_VALUE_16_BIT(1),
623 &li.amoeba_content, EL_DIAMOND
627 TYPE_INTEGER, CONF_VALUE_16_BIT(2),
632 TYPE_BOOLEAN, CONF_VALUE_8_BIT(1),
633 &li.grow_into_diggable, TRUE
638 TYPE_CONTENT_LIST, CONF_VALUE_BYTES(1),
639 &li.yamyam_content, EL_ROCK, NULL,
640 &li.num_yamyam_contents, 4, MAX_ELEMENT_CONTENTS
644 TYPE_INTEGER, CONF_VALUE_16_BIT(1),
645 &li.score[SC_YAMYAM], 10
650 TYPE_INTEGER, CONF_VALUE_16_BIT(1),
651 &li.score[SC_ROBOT], 10
655 TYPE_INTEGER, CONF_VALUE_16_BIT(2),
661 TYPE_INTEGER, CONF_VALUE_16_BIT(1),
667 TYPE_INTEGER, CONF_VALUE_16_BIT(1),
668 &li.time_magic_wall, 10
673 TYPE_INTEGER, CONF_VALUE_8_BIT(1),
674 &li.game_of_life[0], 2
678 TYPE_INTEGER, CONF_VALUE_8_BIT(2),
679 &li.game_of_life[1], 3
683 TYPE_INTEGER, CONF_VALUE_8_BIT(3),
684 &li.game_of_life[2], 3
688 TYPE_INTEGER, CONF_VALUE_8_BIT(4),
689 &li.game_of_life[3], 3
693 TYPE_BOOLEAN, CONF_VALUE_8_BIT(5),
694 &li.use_life_bugs, FALSE
699 TYPE_INTEGER, CONF_VALUE_8_BIT(1),
704 TYPE_INTEGER, CONF_VALUE_8_BIT(2),
709 TYPE_INTEGER, CONF_VALUE_8_BIT(3),
714 TYPE_INTEGER, CONF_VALUE_8_BIT(4),
719 EL_TIMEGATE_SWITCH, -1,
720 TYPE_INTEGER, CONF_VALUE_16_BIT(1),
721 &li.time_timegate, 10
725 EL_LIGHT_SWITCH_ACTIVE, -1,
726 TYPE_INTEGER, CONF_VALUE_16_BIT(1),
731 EL_SHIELD_NORMAL, -1,
732 TYPE_INTEGER, CONF_VALUE_16_BIT(1),
733 &li.shield_normal_time, 10
736 EL_SHIELD_NORMAL, -1,
737 TYPE_INTEGER, CONF_VALUE_16_BIT(2),
738 &li.score[SC_SHIELD], 10
742 EL_SHIELD_DEADLY, -1,
743 TYPE_INTEGER, CONF_VALUE_16_BIT(1),
744 &li.shield_deadly_time, 10
747 EL_SHIELD_DEADLY, -1,
748 TYPE_INTEGER, CONF_VALUE_16_BIT(2),
749 &li.score[SC_SHIELD], 10
754 TYPE_INTEGER, CONF_VALUE_16_BIT(1),
759 TYPE_INTEGER, CONF_VALUE_16_BIT(2),
760 &li.extra_time_score, 10
764 EL_TIME_ORB_FULL, -1,
765 TYPE_INTEGER, CONF_VALUE_16_BIT(1),
766 &li.time_orb_time, 10
769 EL_TIME_ORB_FULL, -1,
770 TYPE_BOOLEAN, CONF_VALUE_8_BIT(1),
771 &li.use_time_orb_bug, FALSE
776 TYPE_BOOLEAN, CONF_VALUE_8_BIT(1),
777 &li.use_spring_bug, FALSE
782 TYPE_INTEGER, CONF_VALUE_16_BIT(1),
783 &li.android_move_time, 10
787 TYPE_INTEGER, CONF_VALUE_16_BIT(2),
788 &li.android_clone_time, 10
791 EL_EMC_ANDROID, SAVE_CONF_NEVER,
792 TYPE_ELEMENT_LIST, CONF_VALUE_BYTES(1),
793 &li.android_clone_element[0], EL_EMPTY, NULL,
794 &li.num_android_clone_elements, 1, MAX_ANDROID_ELEMENTS_OLD
798 TYPE_ELEMENT_LIST, CONF_VALUE_BYTES(2),
799 &li.android_clone_element[0], EL_EMPTY, NULL,
800 &li.num_android_clone_elements, 1, MAX_ANDROID_ELEMENTS
805 TYPE_INTEGER, CONF_VALUE_16_BIT(1),
810 TYPE_INTEGER, CONF_VALUE_16_BIT(2),
815 EL_EMC_MAGNIFIER, -1,
816 TYPE_INTEGER, CONF_VALUE_16_BIT(1),
817 &li.magnify_score, 10
820 EL_EMC_MAGNIFIER, -1,
821 TYPE_INTEGER, CONF_VALUE_16_BIT(2),
826 EL_EMC_MAGIC_BALL, -1,
827 TYPE_INTEGER, CONF_VALUE_16_BIT(1),
831 EL_EMC_MAGIC_BALL, -1,
832 TYPE_BOOLEAN, CONF_VALUE_8_BIT(1),
833 &li.ball_random, FALSE
836 EL_EMC_MAGIC_BALL, -1,
837 TYPE_BOOLEAN, CONF_VALUE_8_BIT(2),
838 &li.ball_active_initial, FALSE
841 EL_EMC_MAGIC_BALL, -1,
842 TYPE_CONTENT_LIST, CONF_VALUE_BYTES(1),
843 &li.ball_content, EL_EMPTY, NULL,
844 &li.num_ball_contents, 4, MAX_ELEMENT_CONTENTS
848 EL_SOKOBAN_FIELD_EMPTY, -1,
849 TYPE_BOOLEAN, CONF_VALUE_8_BIT(1),
850 &li.sb_fields_needed, TRUE
854 EL_SOKOBAN_OBJECT, -1,
855 TYPE_BOOLEAN, CONF_VALUE_8_BIT(1),
856 &li.sb_objects_needed, TRUE
861 TYPE_BOOLEAN, CONF_VALUE_8_BIT(1),
862 &li.mm_laser_red, FALSE
866 TYPE_BOOLEAN, CONF_VALUE_8_BIT(2),
867 &li.mm_laser_green, FALSE
871 TYPE_BOOLEAN, CONF_VALUE_8_BIT(3),
872 &li.mm_laser_blue, TRUE
877 TYPE_BOOLEAN, CONF_VALUE_8_BIT(1),
878 &li.df_laser_red, TRUE
882 TYPE_BOOLEAN, CONF_VALUE_8_BIT(2),
883 &li.df_laser_green, TRUE
887 TYPE_BOOLEAN, CONF_VALUE_8_BIT(3),
888 &li.df_laser_blue, FALSE
892 EL_MM_FUSE_ACTIVE, -1,
893 TYPE_INTEGER, CONF_VALUE_16_BIT(1),
898 TYPE_INTEGER, CONF_VALUE_16_BIT(1),
903 TYPE_INTEGER, CONF_VALUE_16_BIT(1),
907 EL_MM_STEEL_BLOCK, -1,
908 TYPE_INTEGER, CONF_VALUE_16_BIT(1),
909 &li.mm_time_block, 75
913 TYPE_INTEGER, CONF_VALUE_16_BIT(1),
914 &li.score[SC_ELEM_BONUS], 10
917 // ---------- unused values -------------------------------------------------
920 EL_UNKNOWN, SAVE_CONF_NEVER,
921 TYPE_INTEGER, CONF_VALUE_16_BIT(1),
922 &li.score[SC_UNKNOWN_15], 10
932 static struct LevelFileConfigInfo chunk_config_NOTE[] =
936 TYPE_INTEGER, CONF_VALUE_8_BIT(1),
937 &xx_envelope.xsize, MAX_ENVELOPE_XSIZE,
941 TYPE_INTEGER, CONF_VALUE_8_BIT(2),
942 &xx_envelope.ysize, MAX_ENVELOPE_YSIZE,
947 TYPE_BOOLEAN, CONF_VALUE_8_BIT(3),
948 &xx_envelope.autowrap, FALSE
952 TYPE_BOOLEAN, CONF_VALUE_8_BIT(4),
953 &xx_envelope.centered, FALSE
958 TYPE_STRING, CONF_VALUE_BYTES(1),
959 &xx_envelope.text, -1, NULL,
960 &xx_string_length_unused, -1, MAX_ENVELOPE_TEXT_LEN,
961 &xx_default_string_empty[0]
971 static struct LevelFileConfigInfo chunk_config_CUSX_base[] =
975 TYPE_STRING, CONF_VALUE_BYTES(1),
976 &xx_ei.description[0], -1,
977 &yy_ei.description[0],
978 &xx_string_length_unused, -1, MAX_ELEMENT_NAME_LEN,
979 &xx_default_description[0]
984 TYPE_BITFIELD, CONF_VALUE_32_BIT(1),
985 &xx_ei.properties[EP_BITFIELD_BASE_NR], EP_BITMASK_BASE_DEFAULT,
986 &yy_ei.properties[EP_BITFIELD_BASE_NR]
988 #if ENABLE_RESERVED_CODE
989 // (reserved for later use)
992 TYPE_BITFIELD, CONF_VALUE_32_BIT(2),
993 &xx_ei.properties[EP_BITFIELD_BASE_NR + 1], EP_BITMASK_DEFAULT,
994 &yy_ei.properties[EP_BITFIELD_BASE_NR + 1]
1000 TYPE_BOOLEAN, CONF_VALUE_8_BIT(1),
1001 &xx_ei.use_gfx_element, FALSE,
1002 &yy_ei.use_gfx_element
1006 TYPE_ELEMENT, CONF_VALUE_16_BIT(1),
1007 &xx_ei.gfx_element_initial, EL_EMPTY_SPACE,
1008 &yy_ei.gfx_element_initial
1013 TYPE_BITFIELD, CONF_VALUE_8_BIT(2),
1014 &xx_ei.access_direction, MV_ALL_DIRECTIONS,
1015 &yy_ei.access_direction
1020 TYPE_INTEGER, CONF_VALUE_16_BIT(2),
1021 &xx_ei.collect_score_initial, 10,
1022 &yy_ei.collect_score_initial
1026 TYPE_INTEGER, CONF_VALUE_16_BIT(3),
1027 &xx_ei.collect_count_initial, 1,
1028 &yy_ei.collect_count_initial
1033 TYPE_INTEGER, CONF_VALUE_16_BIT(4),
1034 &xx_ei.ce_value_fixed_initial, 0,
1035 &yy_ei.ce_value_fixed_initial
1039 TYPE_INTEGER, CONF_VALUE_16_BIT(5),
1040 &xx_ei.ce_value_random_initial, 0,
1041 &yy_ei.ce_value_random_initial
1045 TYPE_BOOLEAN, CONF_VALUE_8_BIT(3),
1046 &xx_ei.use_last_ce_value, FALSE,
1047 &yy_ei.use_last_ce_value
1052 TYPE_INTEGER, CONF_VALUE_16_BIT(6),
1053 &xx_ei.push_delay_fixed, 8,
1054 &yy_ei.push_delay_fixed
1058 TYPE_INTEGER, CONF_VALUE_16_BIT(7),
1059 &xx_ei.push_delay_random, 8,
1060 &yy_ei.push_delay_random
1064 TYPE_INTEGER, CONF_VALUE_16_BIT(8),
1065 &xx_ei.drop_delay_fixed, 0,
1066 &yy_ei.drop_delay_fixed
1070 TYPE_INTEGER, CONF_VALUE_16_BIT(9),
1071 &xx_ei.drop_delay_random, 0,
1072 &yy_ei.drop_delay_random
1076 TYPE_INTEGER, CONF_VALUE_16_BIT(10),
1077 &xx_ei.move_delay_fixed, 0,
1078 &yy_ei.move_delay_fixed
1082 TYPE_INTEGER, CONF_VALUE_16_BIT(11),
1083 &xx_ei.move_delay_random, 0,
1084 &yy_ei.move_delay_random
1088 TYPE_INTEGER, CONF_VALUE_16_BIT(16),
1089 &xx_ei.step_delay_fixed, 0,
1090 &yy_ei.step_delay_fixed
1094 TYPE_INTEGER, CONF_VALUE_16_BIT(17),
1095 &xx_ei.step_delay_random, 0,
1096 &yy_ei.step_delay_random
1101 TYPE_BITFIELD, CONF_VALUE_32_BIT(3),
1102 &xx_ei.move_pattern, MV_ALL_DIRECTIONS,
1107 TYPE_BITFIELD, CONF_VALUE_8_BIT(4),
1108 &xx_ei.move_direction_initial, MV_START_AUTOMATIC,
1109 &yy_ei.move_direction_initial
1113 TYPE_INTEGER, CONF_VALUE_8_BIT(5),
1114 &xx_ei.move_stepsize, TILEX / 8,
1115 &yy_ei.move_stepsize
1120 TYPE_ELEMENT, CONF_VALUE_16_BIT(12),
1121 &xx_ei.move_enter_element, EL_EMPTY_SPACE,
1122 &yy_ei.move_enter_element
1126 TYPE_ELEMENT, CONF_VALUE_16_BIT(13),
1127 &xx_ei.move_leave_element, EL_EMPTY_SPACE,
1128 &yy_ei.move_leave_element
1132 TYPE_INTEGER, CONF_VALUE_8_BIT(6),
1133 &xx_ei.move_leave_type, LEAVE_TYPE_UNLIMITED,
1134 &yy_ei.move_leave_type
1139 TYPE_INTEGER, CONF_VALUE_8_BIT(7),
1140 &xx_ei.slippery_type, SLIPPERY_ANY_RANDOM,
1141 &yy_ei.slippery_type
1146 TYPE_INTEGER, CONF_VALUE_8_BIT(8),
1147 &xx_ei.explosion_type, EXPLODES_3X3,
1148 &yy_ei.explosion_type
1152 TYPE_INTEGER, CONF_VALUE_16_BIT(14),
1153 &xx_ei.explosion_delay, 16,
1154 &yy_ei.explosion_delay
1158 TYPE_INTEGER, CONF_VALUE_16_BIT(15),
1159 &xx_ei.ignition_delay, 8,
1160 &yy_ei.ignition_delay
1165 TYPE_CONTENT_LIST, CONF_VALUE_BYTES(2),
1166 &xx_ei.content, EL_EMPTY_SPACE,
1168 &xx_num_contents, 1, 1
1171 // ---------- "num_change_pages" must be the last entry ---------------------
1174 -1, SAVE_CONF_ALWAYS,
1175 TYPE_INTEGER, CONF_VALUE_8_BIT(9),
1176 &xx_ei.num_change_pages, 1,
1177 &yy_ei.num_change_pages
1188 static struct LevelFileConfigInfo chunk_config_CUSX_change[] =
1190 // ---------- "current_change_page" must be the first entry -----------------
1193 -1, SAVE_CONF_ALWAYS,
1194 TYPE_INTEGER, CONF_VALUE_8_BIT(1),
1195 &xx_current_change_page, -1
1198 // ---------- (the remaining entries can be in any order) -------------------
1202 TYPE_BOOLEAN, CONF_VALUE_8_BIT(2),
1203 &xx_change.can_change, FALSE
1208 TYPE_BITFIELD, CONF_VALUE_32_BIT(1),
1209 &xx_event_bits[0], 0
1213 TYPE_BITFIELD, CONF_VALUE_32_BIT(2),
1214 &xx_event_bits[1], 0
1219 TYPE_BITFIELD, CONF_VALUE_8_BIT(3),
1220 &xx_change.trigger_player, CH_PLAYER_ANY
1224 TYPE_BITFIELD, CONF_VALUE_8_BIT(4),
1225 &xx_change.trigger_side, CH_SIDE_ANY
1229 TYPE_BITFIELD, CONF_VALUE_32_BIT(3),
1230 &xx_change.trigger_page, CH_PAGE_ANY
1235 TYPE_ELEMENT, CONF_VALUE_16_BIT(1),
1236 &xx_change.target_element, EL_EMPTY_SPACE
1241 TYPE_INTEGER, CONF_VALUE_16_BIT(2),
1242 &xx_change.delay_fixed, 0
1246 TYPE_INTEGER, CONF_VALUE_16_BIT(3),
1247 &xx_change.delay_random, 0
1251 TYPE_INTEGER, CONF_VALUE_16_BIT(4),
1252 &xx_change.delay_frames, FRAMES_PER_SECOND
1257 TYPE_ELEMENT, CONF_VALUE_16_BIT(5),
1258 &xx_change.initial_trigger_element, EL_EMPTY_SPACE
1263 TYPE_BOOLEAN, CONF_VALUE_8_BIT(6),
1264 &xx_change.explode, FALSE
1268 TYPE_BOOLEAN, CONF_VALUE_8_BIT(7),
1269 &xx_change.use_target_content, FALSE
1273 TYPE_BOOLEAN, CONF_VALUE_8_BIT(8),
1274 &xx_change.only_if_complete, FALSE
1278 TYPE_BOOLEAN, CONF_VALUE_8_BIT(9),
1279 &xx_change.use_random_replace, FALSE
1283 TYPE_INTEGER, CONF_VALUE_8_BIT(10),
1284 &xx_change.random_percentage, 100
1288 TYPE_INTEGER, CONF_VALUE_8_BIT(11),
1289 &xx_change.replace_when, CP_WHEN_EMPTY
1294 TYPE_BOOLEAN, CONF_VALUE_8_BIT(12),
1295 &xx_change.has_action, FALSE
1299 TYPE_INTEGER, CONF_VALUE_8_BIT(13),
1300 &xx_change.action_type, CA_NO_ACTION
1304 TYPE_INTEGER, CONF_VALUE_8_BIT(14),
1305 &xx_change.action_mode, CA_MODE_UNDEFINED
1309 TYPE_INTEGER, CONF_VALUE_16_BIT(6),
1310 &xx_change.action_arg, CA_ARG_UNDEFINED
1315 TYPE_ELEMENT, CONF_VALUE_16_BIT(7),
1316 &xx_change.action_element, EL_EMPTY_SPACE
1321 TYPE_CONTENT_LIST, CONF_VALUE_BYTES(1),
1322 &xx_change.target_content, EL_EMPTY_SPACE, NULL,
1323 &xx_num_contents, 1, 1
1333 static struct LevelFileConfigInfo chunk_config_GRPX[] =
1337 TYPE_STRING, CONF_VALUE_BYTES(1),
1338 &xx_ei.description[0], -1, NULL,
1339 &xx_string_length_unused, -1, MAX_ELEMENT_NAME_LEN,
1340 &xx_default_description[0]
1345 TYPE_BOOLEAN, CONF_VALUE_8_BIT(1),
1346 &xx_ei.use_gfx_element, FALSE
1350 TYPE_ELEMENT, CONF_VALUE_16_BIT(1),
1351 &xx_ei.gfx_element_initial, EL_EMPTY_SPACE
1356 TYPE_INTEGER, CONF_VALUE_8_BIT(2),
1357 &xx_group.choice_mode, ANIM_RANDOM
1362 TYPE_ELEMENT_LIST, CONF_VALUE_BYTES(2),
1363 &xx_group.element[0], EL_EMPTY_SPACE, NULL,
1364 &xx_group.num_elements, 1, MAX_ELEMENTS_IN_GROUP
1374 static struct LevelFileConfigInfo chunk_config_CONF[] = // (OBSOLETE)
1378 TYPE_BOOLEAN, CONF_VALUE_8_BIT(9),
1379 &li.block_snap_field, TRUE
1383 TYPE_BOOLEAN, CONF_VALUE_8_BIT(13),
1384 &li.continuous_snapping, TRUE
1388 TYPE_INTEGER, CONF_VALUE_8_BIT(1),
1389 &li.initial_player_stepsize[0], STEPSIZE_NORMAL
1393 TYPE_BOOLEAN, CONF_VALUE_8_BIT(10),
1394 &li.use_start_element[0], FALSE
1398 TYPE_ELEMENT, CONF_VALUE_16_BIT(1),
1399 &li.start_element[0], EL_PLAYER_1
1403 TYPE_BOOLEAN, CONF_VALUE_8_BIT(11),
1404 &li.use_artwork_element[0], FALSE
1408 TYPE_ELEMENT, CONF_VALUE_16_BIT(2),
1409 &li.artwork_element[0], EL_PLAYER_1
1413 TYPE_BOOLEAN, CONF_VALUE_8_BIT(12),
1414 &li.use_explosion_element[0], FALSE
1418 TYPE_ELEMENT, CONF_VALUE_16_BIT(3),
1419 &li.explosion_element[0], EL_PLAYER_1
1434 filetype_id_list[] =
1436 { LEVEL_FILE_TYPE_RND, "RND" },
1437 { LEVEL_FILE_TYPE_BD, "BD" },
1438 { LEVEL_FILE_TYPE_EM, "EM" },
1439 { LEVEL_FILE_TYPE_SP, "SP" },
1440 { LEVEL_FILE_TYPE_DX, "DX" },
1441 { LEVEL_FILE_TYPE_SB, "SB" },
1442 { LEVEL_FILE_TYPE_DC, "DC" },
1443 { LEVEL_FILE_TYPE_MM, "MM" },
1444 { LEVEL_FILE_TYPE_MM, "DF" },
1449 // ============================================================================
1450 // level file functions
1451 // ============================================================================
1453 static boolean check_special_flags(char *flag)
1455 if (strEqual(options.special_flags, flag) ||
1456 strEqual(leveldir_current->special_flags, flag))
1462 static struct DateInfo getCurrentDate(void)
1464 time_t epoch_seconds = time(NULL);
1465 struct tm *now = localtime(&epoch_seconds);
1466 struct DateInfo date;
1468 date.year = now->tm_year + 1900;
1469 date.month = now->tm_mon + 1;
1470 date.day = now->tm_mday;
1472 date.src = DATE_SRC_CLOCK;
1477 static void resetEventFlags(struct ElementChangeInfo *change)
1481 for (i = 0; i < NUM_CHANGE_EVENTS; i++)
1482 change->has_event[i] = FALSE;
1485 static void resetEventBits(void)
1489 for (i = 0; i < NUM_CE_BITFIELDS; i++)
1490 xx_event_bits[i] = 0;
1493 static void setEventFlagsFromEventBits(struct ElementChangeInfo *change)
1497 /* important: only change event flag if corresponding event bit is set
1498 (this is because all xx_event_bits[] values are loaded separately,
1499 and all xx_event_bits[] values are set back to zero before loading
1500 another value xx_event_bits[x] (each value representing 32 flags)) */
1502 for (i = 0; i < NUM_CHANGE_EVENTS; i++)
1503 if (xx_event_bits[CH_EVENT_BITFIELD_NR(i)] & CH_EVENT_BIT(i))
1504 change->has_event[i] = TRUE;
1507 static void setEventBitsFromEventFlags(struct ElementChangeInfo *change)
1511 /* in contrast to the above function setEventFlagsFromEventBits(), it
1512 would also be possible to set all bits in xx_event_bits[] to 0 or 1
1513 depending on the corresponding change->has_event[i] values here, as
1514 all xx_event_bits[] values are reset in resetEventBits() before */
1516 for (i = 0; i < NUM_CHANGE_EVENTS; i++)
1517 if (change->has_event[i])
1518 xx_event_bits[CH_EVENT_BITFIELD_NR(i)] |= CH_EVENT_BIT(i);
1521 static char *getDefaultElementDescription(struct ElementInfo *ei)
1523 static char description[MAX_ELEMENT_NAME_LEN + 1];
1524 char *default_description = (ei->custom_description != NULL ?
1525 ei->custom_description :
1526 ei->editor_description);
1529 // always start with reliable default values
1530 for (i = 0; i < MAX_ELEMENT_NAME_LEN + 1; i++)
1531 description[i] = '\0';
1533 // truncate element description to MAX_ELEMENT_NAME_LEN bytes
1534 strncpy(description, default_description, MAX_ELEMENT_NAME_LEN);
1536 return &description[0];
1539 static void setElementDescriptionToDefault(struct ElementInfo *ei)
1541 char *default_description = getDefaultElementDescription(ei);
1544 for (i = 0; i < MAX_ELEMENT_NAME_LEN + 1; i++)
1545 ei->description[i] = default_description[i];
1548 static void setConfigToDefaultsFromConfigList(struct LevelFileConfigInfo *conf)
1552 for (i = 0; conf[i].data_type != -1; i++)
1554 int default_value = conf[i].default_value;
1555 int data_type = conf[i].data_type;
1556 int conf_type = conf[i].conf_type;
1557 int byte_mask = conf_type & CONF_MASK_BYTES;
1559 if (byte_mask == CONF_MASK_MULTI_BYTES)
1561 int default_num_entities = conf[i].default_num_entities;
1562 int max_num_entities = conf[i].max_num_entities;
1564 *(int *)(conf[i].num_entities) = default_num_entities;
1566 if (data_type == TYPE_STRING)
1568 char *default_string = conf[i].default_string;
1569 char *string = (char *)(conf[i].value);
1571 strncpy(string, default_string, max_num_entities);
1573 else if (data_type == TYPE_ELEMENT_LIST)
1575 int *element_array = (int *)(conf[i].value);
1578 for (j = 0; j < max_num_entities; j++)
1579 element_array[j] = default_value;
1581 else if (data_type == TYPE_CONTENT_LIST)
1583 struct Content *content = (struct Content *)(conf[i].value);
1586 for (c = 0; c < max_num_entities; c++)
1587 for (y = 0; y < 3; y++)
1588 for (x = 0; x < 3; x++)
1589 content[c].e[x][y] = default_value;
1592 else // constant size configuration data (1, 2 or 4 bytes)
1594 if (data_type == TYPE_BOOLEAN)
1595 *(boolean *)(conf[i].value) = default_value;
1597 *(int *) (conf[i].value) = default_value;
1602 static void copyConfigFromConfigList(struct LevelFileConfigInfo *conf)
1606 for (i = 0; conf[i].data_type != -1; i++)
1608 int data_type = conf[i].data_type;
1609 int conf_type = conf[i].conf_type;
1610 int byte_mask = conf_type & CONF_MASK_BYTES;
1612 if (byte_mask == CONF_MASK_MULTI_BYTES)
1614 int max_num_entities = conf[i].max_num_entities;
1616 if (data_type == TYPE_STRING)
1618 char *string = (char *)(conf[i].value);
1619 char *string_copy = (char *)(conf[i].value_copy);
1621 strncpy(string_copy, string, max_num_entities);
1623 else if (data_type == TYPE_ELEMENT_LIST)
1625 int *element_array = (int *)(conf[i].value);
1626 int *element_array_copy = (int *)(conf[i].value_copy);
1629 for (j = 0; j < max_num_entities; j++)
1630 element_array_copy[j] = element_array[j];
1632 else if (data_type == TYPE_CONTENT_LIST)
1634 struct Content *content = (struct Content *)(conf[i].value);
1635 struct Content *content_copy = (struct Content *)(conf[i].value_copy);
1638 for (c = 0; c < max_num_entities; c++)
1639 for (y = 0; y < 3; y++)
1640 for (x = 0; x < 3; x++)
1641 content_copy[c].e[x][y] = content[c].e[x][y];
1644 else // constant size configuration data (1, 2 or 4 bytes)
1646 if (data_type == TYPE_BOOLEAN)
1647 *(boolean *)(conf[i].value_copy) = *(boolean *)(conf[i].value);
1649 *(int *) (conf[i].value_copy) = *(int *) (conf[i].value);
1654 void copyElementInfo(struct ElementInfo *ei_from, struct ElementInfo *ei_to)
1658 xx_ei = *ei_from; // copy element data into temporary buffer
1659 yy_ei = *ei_to; // copy element data into temporary buffer
1661 copyConfigFromConfigList(chunk_config_CUSX_base);
1666 // ---------- reinitialize and copy change pages ----------
1668 ei_to->num_change_pages = ei_from->num_change_pages;
1669 ei_to->current_change_page = ei_from->current_change_page;
1671 setElementChangePages(ei_to, ei_to->num_change_pages);
1673 for (i = 0; i < ei_to->num_change_pages; i++)
1674 ei_to->change_page[i] = ei_from->change_page[i];
1676 // ---------- copy group element info ----------
1677 if (ei_from->group != NULL && ei_to->group != NULL) // group or internal
1678 *ei_to->group = *ei_from->group;
1680 // mark this custom element as modified
1681 ei_to->modified_settings = TRUE;
1684 void setElementChangePages(struct ElementInfo *ei, int change_pages)
1686 int change_page_size = sizeof(struct ElementChangeInfo);
1688 ei->num_change_pages = MAX(1, change_pages);
1691 checked_realloc(ei->change_page, ei->num_change_pages * change_page_size);
1693 if (ei->current_change_page >= ei->num_change_pages)
1694 ei->current_change_page = ei->num_change_pages - 1;
1696 ei->change = &ei->change_page[ei->current_change_page];
1699 void setElementChangeInfoToDefaults(struct ElementChangeInfo *change)
1701 xx_change = *change; // copy change data into temporary buffer
1703 setConfigToDefaultsFromConfigList(chunk_config_CUSX_change);
1705 *change = xx_change;
1707 resetEventFlags(change);
1709 change->direct_action = 0;
1710 change->other_action = 0;
1712 change->pre_change_function = NULL;
1713 change->change_function = NULL;
1714 change->post_change_function = NULL;
1717 static void setLevelInfoToDefaults_Level(struct LevelInfo *level)
1721 li = *level; // copy level data into temporary buffer
1722 setConfigToDefaultsFromConfigList(chunk_config_INFO);
1723 *level = li; // copy temporary buffer back to level data
1725 setLevelInfoToDefaults_EM();
1726 setLevelInfoToDefaults_SP();
1727 setLevelInfoToDefaults_MM();
1729 level->native_em_level = &native_em_level;
1730 level->native_sp_level = &native_sp_level;
1731 level->native_mm_level = &native_mm_level;
1733 level->file_version = FILE_VERSION_ACTUAL;
1734 level->game_version = GAME_VERSION_ACTUAL;
1736 level->creation_date = getCurrentDate();
1738 level->encoding_16bit_field = TRUE;
1739 level->encoding_16bit_yamyam = TRUE;
1740 level->encoding_16bit_amoeba = TRUE;
1742 // clear level name and level author string buffers
1743 for (i = 0; i < MAX_LEVEL_NAME_LEN; i++)
1744 level->name[i] = '\0';
1745 for (i = 0; i < MAX_LEVEL_AUTHOR_LEN; i++)
1746 level->author[i] = '\0';
1748 // set level name and level author to default values
1749 strcpy(level->name, NAMELESS_LEVEL_NAME);
1750 strcpy(level->author, ANONYMOUS_NAME);
1752 // set level playfield to playable default level with player and exit
1753 for (x = 0; x < MAX_LEV_FIELDX; x++)
1754 for (y = 0; y < MAX_LEV_FIELDY; y++)
1755 level->field[x][y] = EL_SAND;
1757 level->field[0][0] = EL_PLAYER_1;
1758 level->field[STD_LEV_FIELDX - 1][STD_LEV_FIELDY - 1] = EL_EXIT_CLOSED;
1760 BorderElement = EL_STEELWALL;
1762 // detect custom elements when loading them
1763 level->file_has_custom_elements = FALSE;
1765 // set all bug compatibility flags to "false" => do not emulate this bug
1766 level->use_action_after_change_bug = FALSE;
1768 if (leveldir_current)
1770 // try to determine better author name than 'anonymous'
1771 if (!strEqual(leveldir_current->author, ANONYMOUS_NAME))
1773 strncpy(level->author, leveldir_current->author, MAX_LEVEL_AUTHOR_LEN);
1774 level->author[MAX_LEVEL_AUTHOR_LEN] = '\0';
1778 switch (LEVELCLASS(leveldir_current))
1780 case LEVELCLASS_TUTORIAL:
1781 strcpy(level->author, PROGRAM_AUTHOR_STRING);
1784 case LEVELCLASS_CONTRIB:
1785 strncpy(level->author, leveldir_current->name, MAX_LEVEL_AUTHOR_LEN);
1786 level->author[MAX_LEVEL_AUTHOR_LEN] = '\0';
1789 case LEVELCLASS_PRIVATE:
1790 strncpy(level->author, getRealName(), MAX_LEVEL_AUTHOR_LEN);
1791 level->author[MAX_LEVEL_AUTHOR_LEN] = '\0';
1795 // keep default value
1802 static void setLevelInfoToDefaults_Elements(struct LevelInfo *level)
1804 static boolean clipboard_elements_initialized = FALSE;
1807 InitElementPropertiesStatic();
1809 li = *level; // copy level data into temporary buffer
1810 setConfigToDefaultsFromConfigList(chunk_config_ELEM);
1811 *level = li; // copy temporary buffer back to level data
1813 for (i = 0; i < MAX_NUM_ELEMENTS; i++)
1816 struct ElementInfo *ei = &element_info[element];
1818 // never initialize clipboard elements after the very first time
1819 // (to be able to use clipboard elements between several levels)
1820 if (IS_CLIPBOARD_ELEMENT(element) && clipboard_elements_initialized)
1823 if (IS_ENVELOPE(element))
1825 int envelope_nr = element - EL_ENVELOPE_1;
1827 setConfigToDefaultsFromConfigList(chunk_config_NOTE);
1829 level->envelope[envelope_nr] = xx_envelope;
1832 if (IS_CUSTOM_ELEMENT(element) ||
1833 IS_GROUP_ELEMENT(element) ||
1834 IS_INTERNAL_ELEMENT(element))
1836 xx_ei = *ei; // copy element data into temporary buffer
1838 setConfigToDefaultsFromConfigList(chunk_config_CUSX_base);
1843 setElementChangePages(ei, 1);
1844 setElementChangeInfoToDefaults(ei->change);
1846 if (IS_CUSTOM_ELEMENT(element) ||
1847 IS_GROUP_ELEMENT(element) ||
1848 IS_INTERNAL_ELEMENT(element))
1850 setElementDescriptionToDefault(ei);
1852 ei->modified_settings = FALSE;
1855 if (IS_CUSTOM_ELEMENT(element) ||
1856 IS_INTERNAL_ELEMENT(element))
1858 // internal values used in level editor
1860 ei->access_type = 0;
1861 ei->access_layer = 0;
1862 ei->access_protected = 0;
1863 ei->walk_to_action = 0;
1864 ei->smash_targets = 0;
1867 ei->can_explode_by_fire = FALSE;
1868 ei->can_explode_smashed = FALSE;
1869 ei->can_explode_impact = FALSE;
1871 ei->current_change_page = 0;
1874 if (IS_GROUP_ELEMENT(element) ||
1875 IS_INTERNAL_ELEMENT(element))
1877 struct ElementGroupInfo *group;
1879 // initialize memory for list of elements in group
1880 if (ei->group == NULL)
1881 ei->group = checked_malloc(sizeof(struct ElementGroupInfo));
1885 xx_group = *group; // copy group data into temporary buffer
1887 setConfigToDefaultsFromConfigList(chunk_config_GRPX);
1893 clipboard_elements_initialized = TRUE;
1896 static void setLevelInfoToDefaults(struct LevelInfo *level,
1897 boolean level_info_only,
1898 boolean reset_file_status)
1900 setLevelInfoToDefaults_Level(level);
1902 if (!level_info_only)
1903 setLevelInfoToDefaults_Elements(level);
1905 if (reset_file_status)
1907 level->no_valid_file = FALSE;
1908 level->no_level_file = FALSE;
1911 level->changed = FALSE;
1914 static void setFileInfoToDefaults(struct LevelFileInfo *level_file_info)
1916 level_file_info->nr = 0;
1917 level_file_info->type = LEVEL_FILE_TYPE_UNKNOWN;
1918 level_file_info->packed = FALSE;
1920 setString(&level_file_info->basename, NULL);
1921 setString(&level_file_info->filename, NULL);
1924 int getMappedElement_SB(int, boolean);
1926 static void ActivateLevelTemplate(void)
1930 if (check_special_flags("load_xsb_to_ces"))
1932 // fill smaller playfields with padding "beyond border wall" elements
1933 if (level.fieldx < level_template.fieldx ||
1934 level.fieldy < level_template.fieldy)
1936 short field[level.fieldx][level.fieldy];
1937 int new_fieldx = MAX(level.fieldx, level_template.fieldx);
1938 int new_fieldy = MAX(level.fieldy, level_template.fieldy);
1939 int pos_fieldx = (new_fieldx - level.fieldx) / 2;
1940 int pos_fieldy = (new_fieldy - level.fieldy) / 2;
1942 // copy old playfield (which is smaller than the visible area)
1943 for (y = 0; y < level.fieldy; y++) for (x = 0; x < level.fieldx; x++)
1944 field[x][y] = level.field[x][y];
1946 // fill new, larger playfield with "beyond border wall" elements
1947 for (y = 0; y < new_fieldy; y++) for (x = 0; x < new_fieldx; x++)
1948 level.field[x][y] = getMappedElement_SB('_', TRUE);
1950 // copy the old playfield to the middle of the new playfield
1951 for (y = 0; y < level.fieldy; y++) for (x = 0; x < level.fieldx; x++)
1952 level.field[pos_fieldx + x][pos_fieldy + y] = field[x][y];
1954 level.fieldx = new_fieldx;
1955 level.fieldy = new_fieldy;
1959 // Currently there is no special action needed to activate the template
1960 // data, because 'element_info' property settings overwrite the original
1961 // level data, while all other variables do not change.
1963 // Exception: 'from_level_template' elements in the original level playfield
1964 // are overwritten with the corresponding elements at the same position in
1965 // playfield from the level template.
1967 for (x = 0; x < level.fieldx; x++)
1968 for (y = 0; y < level.fieldy; y++)
1969 if (level.field[x][y] == EL_FROM_LEVEL_TEMPLATE)
1970 level.field[x][y] = level_template.field[x][y];
1972 if (check_special_flags("load_xsb_to_ces"))
1974 struct LevelInfo level_backup = level;
1976 // overwrite all individual level settings from template level settings
1977 level = level_template;
1979 // restore level file info
1980 level.file_info = level_backup.file_info;
1982 // restore playfield size
1983 level.fieldx = level_backup.fieldx;
1984 level.fieldy = level_backup.fieldy;
1986 // restore playfield content
1987 for (x = 0; x < level.fieldx; x++)
1988 for (y = 0; y < level.fieldy; y++)
1989 level.field[x][y] = level_backup.field[x][y];
1991 // restore name and author from individual level
1992 strcpy(level.name, level_backup.name);
1993 strcpy(level.author, level_backup.author);
1995 // restore flag "use_custom_template"
1996 level.use_custom_template = level_backup.use_custom_template;
2000 static char *getLevelFilenameFromBasename(char *basename)
2002 static char *filename = NULL;
2004 checked_free(filename);
2006 filename = getPath2(getCurrentLevelDir(), basename);
2011 static int getFileTypeFromBasename(char *basename)
2013 // !!! ALSO SEE COMMENT IN checkForPackageFromBasename() !!!
2015 static char *filename = NULL;
2016 struct stat file_status;
2018 // ---------- try to determine file type from filename ----------
2020 // check for typical filename of a Supaplex level package file
2021 if (strlen(basename) == 10 && strPrefixLower(basename, "levels.d"))
2022 return LEVEL_FILE_TYPE_SP;
2024 // check for typical filename of a Diamond Caves II level package file
2025 if (strSuffixLower(basename, ".dc") ||
2026 strSuffixLower(basename, ".dc2"))
2027 return LEVEL_FILE_TYPE_DC;
2029 // check for typical filename of a Sokoban level package file
2030 if (strSuffixLower(basename, ".xsb") &&
2031 strchr(basename, '%') == NULL)
2032 return LEVEL_FILE_TYPE_SB;
2034 // ---------- try to determine file type from filesize ----------
2036 checked_free(filename);
2037 filename = getPath2(getCurrentLevelDir(), basename);
2039 if (stat(filename, &file_status) == 0)
2041 // check for typical filesize of a Supaplex level package file
2042 if (file_status.st_size == 170496)
2043 return LEVEL_FILE_TYPE_SP;
2046 return LEVEL_FILE_TYPE_UNKNOWN;
2049 static int getFileTypeFromMagicBytes(char *filename, int type)
2053 if ((file = openFile(filename, MODE_READ)))
2055 char chunk_name[CHUNK_ID_LEN + 1];
2057 getFileChunkBE(file, chunk_name, NULL);
2059 if (strEqual(chunk_name, "MMII") ||
2060 strEqual(chunk_name, "MIRR"))
2061 type = LEVEL_FILE_TYPE_MM;
2069 static boolean checkForPackageFromBasename(char *basename)
2071 // !!! WON'T WORK ANYMORE IF getFileTypeFromBasename() ALSO DETECTS !!!
2072 // !!! SINGLE LEVELS (CURRENTLY ONLY DETECTS LEVEL PACKAGES !!!
2074 return (getFileTypeFromBasename(basename) != LEVEL_FILE_TYPE_UNKNOWN);
2077 static char *getSingleLevelBasenameExt(int nr, char *extension)
2079 static char basename[MAX_FILENAME_LEN];
2082 sprintf(basename, "%s", LEVELTEMPLATE_FILENAME);
2084 sprintf(basename, "%03d.%s", nr, extension);
2089 static char *getSingleLevelBasename(int nr)
2091 return getSingleLevelBasenameExt(nr, LEVELFILE_EXTENSION);
2094 static char *getPackedLevelBasename(int type)
2096 static char basename[MAX_FILENAME_LEN];
2097 char *directory = getCurrentLevelDir();
2099 DirectoryEntry *dir_entry;
2101 strcpy(basename, UNDEFINED_FILENAME); // default: undefined file
2103 if ((dir = openDirectory(directory)) == NULL)
2105 Warn("cannot read current level directory '%s'", directory);
2110 while ((dir_entry = readDirectory(dir)) != NULL) // loop all entries
2112 char *entry_basename = dir_entry->basename;
2113 int entry_type = getFileTypeFromBasename(entry_basename);
2115 if (entry_type != LEVEL_FILE_TYPE_UNKNOWN) // found valid level package
2117 if (type == LEVEL_FILE_TYPE_UNKNOWN ||
2120 strcpy(basename, entry_basename);
2127 closeDirectory(dir);
2132 static char *getSingleLevelFilename(int nr)
2134 return getLevelFilenameFromBasename(getSingleLevelBasename(nr));
2137 #if ENABLE_UNUSED_CODE
2138 static char *getPackedLevelFilename(int type)
2140 return getLevelFilenameFromBasename(getPackedLevelBasename(type));
2144 char *getDefaultLevelFilename(int nr)
2146 return getSingleLevelFilename(nr);
2149 #if ENABLE_UNUSED_CODE
2150 static void setLevelFileInfo_SingleLevelFilename(struct LevelFileInfo *lfi,
2154 lfi->packed = FALSE;
2156 setString(&lfi->basename, getSingleLevelBasename(lfi->nr, lfi->type));
2157 setString(&lfi->filename, getLevelFilenameFromBasename(lfi->basename));
2161 static void setLevelFileInfo_FormatLevelFilename(struct LevelFileInfo *lfi,
2162 int type, char *format, ...)
2164 static char basename[MAX_FILENAME_LEN];
2167 va_start(ap, format);
2168 vsprintf(basename, format, ap);
2172 lfi->packed = FALSE;
2174 setString(&lfi->basename, basename);
2175 setString(&lfi->filename, getLevelFilenameFromBasename(lfi->basename));
2178 static void setLevelFileInfo_PackedLevelFilename(struct LevelFileInfo *lfi,
2184 setString(&lfi->basename, getPackedLevelBasename(lfi->type));
2185 setString(&lfi->filename, getLevelFilenameFromBasename(lfi->basename));
2188 static int getFiletypeFromID(char *filetype_id)
2190 char *filetype_id_lower;
2191 int filetype = LEVEL_FILE_TYPE_UNKNOWN;
2194 if (filetype_id == NULL)
2195 return LEVEL_FILE_TYPE_UNKNOWN;
2197 filetype_id_lower = getStringToLower(filetype_id);
2199 for (i = 0; filetype_id_list[i].id != NULL; i++)
2201 char *id_lower = getStringToLower(filetype_id_list[i].id);
2203 if (strEqual(filetype_id_lower, id_lower))
2204 filetype = filetype_id_list[i].filetype;
2208 if (filetype != LEVEL_FILE_TYPE_UNKNOWN)
2212 free(filetype_id_lower);
2217 char *getLocalLevelTemplateFilename(void)
2219 return getDefaultLevelFilename(-1);
2222 char *getGlobalLevelTemplateFilename(void)
2224 // global variable "leveldir_current" must be modified in the loop below
2225 LevelDirTree *leveldir_current_last = leveldir_current;
2226 char *filename = NULL;
2228 // check for template level in path from current to topmost tree node
2230 while (leveldir_current != NULL)
2232 filename = getDefaultLevelFilename(-1);
2234 if (fileExists(filename))
2237 leveldir_current = leveldir_current->node_parent;
2240 // restore global variable "leveldir_current" modified in above loop
2241 leveldir_current = leveldir_current_last;
2246 static void determineLevelFileInfo_Filename(struct LevelFileInfo *lfi)
2250 // special case: level number is negative => check for level template file
2253 setLevelFileInfo_FormatLevelFilename(lfi, LEVEL_FILE_TYPE_RND,
2254 getSingleLevelBasename(-1));
2256 // replace local level template filename with global template filename
2257 setString(&lfi->filename, getGlobalLevelTemplateFilename());
2259 // no fallback if template file not existing
2263 // special case: check for file name/pattern specified in "levelinfo.conf"
2264 if (leveldir_current->level_filename != NULL)
2266 int filetype = getFiletypeFromID(leveldir_current->level_filetype);
2268 setLevelFileInfo_FormatLevelFilename(lfi, filetype,
2269 leveldir_current->level_filename, nr);
2271 lfi->packed = checkForPackageFromBasename(leveldir_current->level_filename);
2273 if (fileExists(lfi->filename))
2276 else if (leveldir_current->level_filetype != NULL)
2278 int filetype = getFiletypeFromID(leveldir_current->level_filetype);
2280 // check for specified native level file with standard file name
2281 setLevelFileInfo_FormatLevelFilename(lfi, filetype,
2282 "%03d.%s", nr, LEVELFILE_EXTENSION);
2283 if (fileExists(lfi->filename))
2287 // check for native Rocks'n'Diamonds level file
2288 setLevelFileInfo_FormatLevelFilename(lfi, LEVEL_FILE_TYPE_RND,
2289 "%03d.%s", nr, LEVELFILE_EXTENSION);
2290 if (fileExists(lfi->filename))
2293 // check for Emerald Mine level file (V1)
2294 setLevelFileInfo_FormatLevelFilename(lfi, LEVEL_FILE_TYPE_EM, "a%c%c",
2295 'a' + (nr / 10) % 26, '0' + nr % 10);
2296 if (fileExists(lfi->filename))
2298 setLevelFileInfo_FormatLevelFilename(lfi, LEVEL_FILE_TYPE_EM, "A%c%c",
2299 'A' + (nr / 10) % 26, '0' + nr % 10);
2300 if (fileExists(lfi->filename))
2303 // check for Emerald Mine level file (V2 to V5)
2304 setLevelFileInfo_FormatLevelFilename(lfi, LEVEL_FILE_TYPE_EM, "%d", nr);
2305 if (fileExists(lfi->filename))
2308 // check for Emerald Mine level file (V6 / single mode)
2309 setLevelFileInfo_FormatLevelFilename(lfi, LEVEL_FILE_TYPE_EM, "%02ds", nr);
2310 if (fileExists(lfi->filename))
2312 setLevelFileInfo_FormatLevelFilename(lfi, LEVEL_FILE_TYPE_EM, "%02dS", nr);
2313 if (fileExists(lfi->filename))
2316 // check for Emerald Mine level file (V6 / teamwork mode)
2317 setLevelFileInfo_FormatLevelFilename(lfi, LEVEL_FILE_TYPE_EM, "%02dt", nr);
2318 if (fileExists(lfi->filename))
2320 setLevelFileInfo_FormatLevelFilename(lfi, LEVEL_FILE_TYPE_EM, "%02dT", nr);
2321 if (fileExists(lfi->filename))
2324 // check for various packed level file formats
2325 setLevelFileInfo_PackedLevelFilename(lfi, LEVEL_FILE_TYPE_UNKNOWN);
2326 if (fileExists(lfi->filename))
2329 // no known level file found -- use default values (and fail later)
2330 setLevelFileInfo_FormatLevelFilename(lfi, LEVEL_FILE_TYPE_RND,
2331 "%03d.%s", nr, LEVELFILE_EXTENSION);
2334 static void determineLevelFileInfo_Filetype(struct LevelFileInfo *lfi)
2336 if (lfi->type == LEVEL_FILE_TYPE_UNKNOWN)
2337 lfi->type = getFileTypeFromBasename(lfi->basename);
2339 if (lfi->type == LEVEL_FILE_TYPE_RND)
2340 lfi->type = getFileTypeFromMagicBytes(lfi->filename, lfi->type);
2343 static void setLevelFileInfo(struct LevelFileInfo *level_file_info, int nr)
2345 // always start with reliable default values
2346 setFileInfoToDefaults(level_file_info);
2348 level_file_info->nr = nr; // set requested level number
2350 determineLevelFileInfo_Filename(level_file_info);
2351 determineLevelFileInfo_Filetype(level_file_info);
2354 static void copyLevelFileInfo(struct LevelFileInfo *lfi_from,
2355 struct LevelFileInfo *lfi_to)
2357 lfi_to->nr = lfi_from->nr;
2358 lfi_to->type = lfi_from->type;
2359 lfi_to->packed = lfi_from->packed;
2361 setString(&lfi_to->basename, lfi_from->basename);
2362 setString(&lfi_to->filename, lfi_from->filename);
2365 // ----------------------------------------------------------------------------
2366 // functions for loading R'n'D level
2367 // ----------------------------------------------------------------------------
2369 int getMappedElement(int element)
2371 // remap some (historic, now obsolete) elements
2375 case EL_PLAYER_OBSOLETE:
2376 element = EL_PLAYER_1;
2379 case EL_KEY_OBSOLETE:
2383 case EL_EM_KEY_1_FILE_OBSOLETE:
2384 element = EL_EM_KEY_1;
2387 case EL_EM_KEY_2_FILE_OBSOLETE:
2388 element = EL_EM_KEY_2;
2391 case EL_EM_KEY_3_FILE_OBSOLETE:
2392 element = EL_EM_KEY_3;
2395 case EL_EM_KEY_4_FILE_OBSOLETE:
2396 element = EL_EM_KEY_4;
2399 case EL_ENVELOPE_OBSOLETE:
2400 element = EL_ENVELOPE_1;
2408 if (element >= NUM_FILE_ELEMENTS)
2410 Warn("invalid level element %d", element);
2412 element = EL_UNKNOWN;
2420 static int getMappedElementByVersion(int element, int game_version)
2422 // remap some elements due to certain game version
2424 if (game_version <= VERSION_IDENT(2,2,0,0))
2426 // map game font elements
2427 element = (element == EL_CHAR('[') ? EL_CHAR_AUMLAUT :
2428 element == EL_CHAR('\\') ? EL_CHAR_OUMLAUT :
2429 element == EL_CHAR(']') ? EL_CHAR_UUMLAUT :
2430 element == EL_CHAR('^') ? EL_CHAR_COPYRIGHT : element);
2433 if (game_version < VERSION_IDENT(3,0,0,0))
2435 // map Supaplex gravity tube elements
2436 element = (element == EL_SP_GRAVITY_PORT_LEFT ? EL_SP_PORT_LEFT :
2437 element == EL_SP_GRAVITY_PORT_RIGHT ? EL_SP_PORT_RIGHT :
2438 element == EL_SP_GRAVITY_PORT_UP ? EL_SP_PORT_UP :
2439 element == EL_SP_GRAVITY_PORT_DOWN ? EL_SP_PORT_DOWN :
2446 static int LoadLevel_VERS(File *file, int chunk_size, struct LevelInfo *level)
2448 level->file_version = getFileVersion(file);
2449 level->game_version = getFileVersion(file);
2454 static int LoadLevel_DATE(File *file, int chunk_size, struct LevelInfo *level)
2456 level->creation_date.year = getFile16BitBE(file);
2457 level->creation_date.month = getFile8Bit(file);
2458 level->creation_date.day = getFile8Bit(file);
2460 level->creation_date.src = DATE_SRC_LEVELFILE;
2465 static int LoadLevel_HEAD(File *file, int chunk_size, struct LevelInfo *level)
2467 int initial_player_stepsize;
2468 int initial_player_gravity;
2471 level->fieldx = getFile8Bit(file);
2472 level->fieldy = getFile8Bit(file);
2474 level->time = getFile16BitBE(file);
2475 level->gems_needed = getFile16BitBE(file);
2477 for (i = 0; i < MAX_LEVEL_NAME_LEN; i++)
2478 level->name[i] = getFile8Bit(file);
2479 level->name[MAX_LEVEL_NAME_LEN] = 0;
2481 for (i = 0; i < LEVEL_SCORE_ELEMENTS; i++)
2482 level->score[i] = getFile8Bit(file);
2484 level->num_yamyam_contents = STD_ELEMENT_CONTENTS;
2485 for (i = 0; i < STD_ELEMENT_CONTENTS; i++)
2486 for (y = 0; y < 3; y++)
2487 for (x = 0; x < 3; x++)
2488 level->yamyam_content[i].e[x][y] = getMappedElement(getFile8Bit(file));
2490 level->amoeba_speed = getFile8Bit(file);
2491 level->time_magic_wall = getFile8Bit(file);
2492 level->time_wheel = getFile8Bit(file);
2493 level->amoeba_content = getMappedElement(getFile8Bit(file));
2495 initial_player_stepsize = (getFile8Bit(file) == 1 ? STEPSIZE_FAST :
2498 for (i = 0; i < MAX_PLAYERS; i++)
2499 level->initial_player_stepsize[i] = initial_player_stepsize;
2501 initial_player_gravity = (getFile8Bit(file) == 1 ? TRUE : FALSE);
2503 for (i = 0; i < MAX_PLAYERS; i++)
2504 level->initial_player_gravity[i] = initial_player_gravity;
2506 level->encoding_16bit_field = (getFile8Bit(file) == 1 ? TRUE : FALSE);
2507 level->em_slippery_gems = (getFile8Bit(file) == 1 ? TRUE : FALSE);
2509 level->use_custom_template = (getFile8Bit(file) == 1 ? TRUE : FALSE);
2511 level->block_last_field = (getFile8Bit(file) == 1 ? TRUE : FALSE);
2512 level->sp_block_last_field = (getFile8Bit(file) == 1 ? TRUE : FALSE);
2513 level->can_move_into_acid_bits = getFile32BitBE(file);
2514 level->dont_collide_with_bits = getFile8Bit(file);
2516 level->use_spring_bug = (getFile8Bit(file) == 1 ? TRUE : FALSE);
2517 level->use_step_counter = (getFile8Bit(file) == 1 ? TRUE : FALSE);
2519 level->instant_relocation = (getFile8Bit(file) == 1 ? TRUE : FALSE);
2520 level->can_pass_to_walkable = (getFile8Bit(file) == 1 ? TRUE : FALSE);
2521 level->grow_into_diggable = (getFile8Bit(file) == 1 ? TRUE : FALSE);
2523 level->game_engine_type = getFile8Bit(file);
2525 ReadUnusedBytesFromFile(file, LEVEL_CHUNK_HEAD_UNUSED);
2530 static int LoadLevel_NAME(File *file, int chunk_size, struct LevelInfo *level)
2534 for (i = 0; i < MAX_LEVEL_NAME_LEN; i++)
2535 level->name[i] = getFile8Bit(file);
2536 level->name[MAX_LEVEL_NAME_LEN] = 0;
2541 static int LoadLevel_AUTH(File *file, int chunk_size, struct LevelInfo *level)
2545 for (i = 0; i < MAX_LEVEL_AUTHOR_LEN; i++)
2546 level->author[i] = getFile8Bit(file);
2547 level->author[MAX_LEVEL_AUTHOR_LEN] = 0;
2552 static int LoadLevel_BODY(File *file, int chunk_size, struct LevelInfo *level)
2555 int chunk_size_expected = level->fieldx * level->fieldy;
2557 /* Note: "chunk_size" was wrong before version 2.0 when elements are
2558 stored with 16-bit encoding (and should be twice as big then).
2559 Even worse, playfield data was stored 16-bit when only yamyam content
2560 contained 16-bit elements and vice versa. */
2562 if (level->encoding_16bit_field && level->file_version >= FILE_VERSION_2_0)
2563 chunk_size_expected *= 2;
2565 if (chunk_size_expected != chunk_size)
2567 ReadUnusedBytesFromFile(file, chunk_size);
2568 return chunk_size_expected;
2571 for (y = 0; y < level->fieldy; y++)
2572 for (x = 0; x < level->fieldx; x++)
2573 level->field[x][y] =
2574 getMappedElement(level->encoding_16bit_field ? getFile16BitBE(file) :
2579 static int LoadLevel_CONT(File *file, int chunk_size, struct LevelInfo *level)
2582 int header_size = 4;
2583 int content_size = MAX_ELEMENT_CONTENTS * 3 * 3;
2584 int chunk_size_expected = header_size + content_size;
2586 /* Note: "chunk_size" was wrong before version 2.0 when elements are
2587 stored with 16-bit encoding (and should be twice as big then).
2588 Even worse, playfield data was stored 16-bit when only yamyam content
2589 contained 16-bit elements and vice versa. */
2591 if (level->encoding_16bit_field && level->file_version >= FILE_VERSION_2_0)
2592 chunk_size_expected += content_size;
2594 if (chunk_size_expected != chunk_size)
2596 ReadUnusedBytesFromFile(file, chunk_size);
2597 return chunk_size_expected;
2601 level->num_yamyam_contents = getFile8Bit(file);
2605 // correct invalid number of content fields -- should never happen
2606 if (level->num_yamyam_contents < 1 ||
2607 level->num_yamyam_contents > MAX_ELEMENT_CONTENTS)
2608 level->num_yamyam_contents = STD_ELEMENT_CONTENTS;
2610 for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
2611 for (y = 0; y < 3; y++)
2612 for (x = 0; x < 3; x++)
2613 level->yamyam_content[i].e[x][y] =
2614 getMappedElement(level->encoding_16bit_field ?
2615 getFile16BitBE(file) : getFile8Bit(file));
2619 static int LoadLevel_CNT2(File *file, int chunk_size, struct LevelInfo *level)
2624 int content_array[MAX_ELEMENT_CONTENTS][3][3];
2626 element = getMappedElement(getFile16BitBE(file));
2627 num_contents = getFile8Bit(file);
2629 getFile8Bit(file); // content x size (unused)
2630 getFile8Bit(file); // content y size (unused)
2632 ReadUnusedBytesFromFile(file, LEVEL_CHUNK_CNT2_UNUSED);
2634 for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
2635 for (y = 0; y < 3; y++)
2636 for (x = 0; x < 3; x++)
2637 content_array[i][x][y] = getMappedElement(getFile16BitBE(file));
2639 // correct invalid number of content fields -- should never happen
2640 if (num_contents < 1 || num_contents > MAX_ELEMENT_CONTENTS)
2641 num_contents = STD_ELEMENT_CONTENTS;
2643 if (element == EL_YAMYAM)
2645 level->num_yamyam_contents = num_contents;
2647 for (i = 0; i < num_contents; i++)
2648 for (y = 0; y < 3; y++)
2649 for (x = 0; x < 3; x++)
2650 level->yamyam_content[i].e[x][y] = content_array[i][x][y];
2652 else if (element == EL_BD_AMOEBA)
2654 level->amoeba_content = content_array[0][0][0];
2658 Warn("cannot load content for element '%d'", element);
2664 static int LoadLevel_CNT3(File *file, int chunk_size, struct LevelInfo *level)
2670 int chunk_size_expected;
2672 element = getMappedElement(getFile16BitBE(file));
2673 if (!IS_ENVELOPE(element))
2674 element = EL_ENVELOPE_1;
2676 envelope_nr = element - EL_ENVELOPE_1;
2678 envelope_len = getFile16BitBE(file);
2680 level->envelope[envelope_nr].xsize = getFile8Bit(file);
2681 level->envelope[envelope_nr].ysize = getFile8Bit(file);
2683 ReadUnusedBytesFromFile(file, LEVEL_CHUNK_CNT3_UNUSED);
2685 chunk_size_expected = LEVEL_CHUNK_CNT3_SIZE(envelope_len);
2686 if (chunk_size_expected != chunk_size)
2688 ReadUnusedBytesFromFile(file, chunk_size - LEVEL_CHUNK_CNT3_HEADER);
2689 return chunk_size_expected;
2692 for (i = 0; i < envelope_len; i++)
2693 level->envelope[envelope_nr].text[i] = getFile8Bit(file);
2698 static int LoadLevel_CUS1(File *file, int chunk_size, struct LevelInfo *level)
2700 int num_changed_custom_elements = getFile16BitBE(file);
2701 int chunk_size_expected = 2 + num_changed_custom_elements * 6;
2704 if (chunk_size_expected != chunk_size)
2706 ReadUnusedBytesFromFile(file, chunk_size - 2);
2707 return chunk_size_expected;
2710 for (i = 0; i < num_changed_custom_elements; i++)
2712 int element = getMappedElement(getFile16BitBE(file));
2713 int properties = getFile32BitBE(file);
2715 if (IS_CUSTOM_ELEMENT(element))
2716 element_info[element].properties[EP_BITFIELD_BASE_NR] = properties;
2718 Warn("invalid custom element number %d", element);
2720 // older game versions that wrote level files with CUS1 chunks used
2721 // different default push delay values (not yet stored in level file)
2722 element_info[element].push_delay_fixed = 2;
2723 element_info[element].push_delay_random = 8;
2726 level->file_has_custom_elements = TRUE;
2731 static int LoadLevel_CUS2(File *file, int chunk_size, struct LevelInfo *level)
2733 int num_changed_custom_elements = getFile16BitBE(file);
2734 int chunk_size_expected = 2 + num_changed_custom_elements * 4;
2737 if (chunk_size_expected != chunk_size)
2739 ReadUnusedBytesFromFile(file, chunk_size - 2);
2740 return chunk_size_expected;
2743 for (i = 0; i < num_changed_custom_elements; i++)
2745 int element = getMappedElement(getFile16BitBE(file));
2746 int custom_target_element = getMappedElement(getFile16BitBE(file));
2748 if (IS_CUSTOM_ELEMENT(element))
2749 element_info[element].change->target_element = custom_target_element;
2751 Warn("invalid custom element number %d", element);
2754 level->file_has_custom_elements = TRUE;
2759 static int LoadLevel_CUS3(File *file, int chunk_size, struct LevelInfo *level)
2761 int num_changed_custom_elements = getFile16BitBE(file);
2762 int chunk_size_expected = LEVEL_CHUNK_CUS3_SIZE(num_changed_custom_elements);
2765 if (chunk_size_expected != chunk_size)
2767 ReadUnusedBytesFromFile(file, chunk_size - 2);
2768 return chunk_size_expected;
2771 for (i = 0; i < num_changed_custom_elements; i++)
2773 int element = getMappedElement(getFile16BitBE(file));
2774 struct ElementInfo *ei = &element_info[element];
2775 unsigned int event_bits;
2777 if (!IS_CUSTOM_ELEMENT(element))
2779 Warn("invalid custom element number %d", element);
2781 element = EL_INTERNAL_DUMMY;
2784 for (j = 0; j < MAX_ELEMENT_NAME_LEN; j++)
2785 ei->description[j] = getFile8Bit(file);
2786 ei->description[MAX_ELEMENT_NAME_LEN] = 0;
2788 ei->properties[EP_BITFIELD_BASE_NR] = getFile32BitBE(file);
2790 // some free bytes for future properties and padding
2791 ReadUnusedBytesFromFile(file, 7);
2793 ei->use_gfx_element = getFile8Bit(file);
2794 ei->gfx_element_initial = getMappedElement(getFile16BitBE(file));
2796 ei->collect_score_initial = getFile8Bit(file);
2797 ei->collect_count_initial = getFile8Bit(file);
2799 ei->push_delay_fixed = getFile16BitBE(file);
2800 ei->push_delay_random = getFile16BitBE(file);
2801 ei->move_delay_fixed = getFile16BitBE(file);
2802 ei->move_delay_random = getFile16BitBE(file);
2804 ei->move_pattern = getFile16BitBE(file);
2805 ei->move_direction_initial = getFile8Bit(file);
2806 ei->move_stepsize = getFile8Bit(file);
2808 for (y = 0; y < 3; y++)
2809 for (x = 0; x < 3; x++)
2810 ei->content.e[x][y] = getMappedElement(getFile16BitBE(file));
2812 event_bits = getFile32BitBE(file);
2813 for (j = 0; j < NUM_CHANGE_EVENTS; j++)
2814 if (event_bits & (1 << j))
2815 ei->change->has_event[j] = TRUE;
2817 ei->change->target_element = getMappedElement(getFile16BitBE(file));
2819 ei->change->delay_fixed = getFile16BitBE(file);
2820 ei->change->delay_random = getFile16BitBE(file);
2821 ei->change->delay_frames = getFile16BitBE(file);
2823 ei->change->initial_trigger_element= getMappedElement(getFile16BitBE(file));
2825 ei->change->explode = getFile8Bit(file);
2826 ei->change->use_target_content = getFile8Bit(file);
2827 ei->change->only_if_complete = getFile8Bit(file);
2828 ei->change->use_random_replace = getFile8Bit(file);
2830 ei->change->random_percentage = getFile8Bit(file);
2831 ei->change->replace_when = getFile8Bit(file);
2833 for (y = 0; y < 3; y++)
2834 for (x = 0; x < 3; x++)
2835 ei->change->target_content.e[x][y] =
2836 getMappedElement(getFile16BitBE(file));
2838 ei->slippery_type = getFile8Bit(file);
2840 // some free bytes for future properties and padding
2841 ReadUnusedBytesFromFile(file, LEVEL_CPART_CUS3_UNUSED);
2843 // mark that this custom element has been modified
2844 ei->modified_settings = TRUE;
2847 level->file_has_custom_elements = TRUE;
2852 static int LoadLevel_CUS4(File *file, int chunk_size, struct LevelInfo *level)
2854 struct ElementInfo *ei;
2855 int chunk_size_expected;
2859 // ---------- custom element base property values (96 bytes) ----------------
2861 element = getMappedElement(getFile16BitBE(file));
2863 if (!IS_CUSTOM_ELEMENT(element))
2865 Warn("invalid custom element number %d", element);
2867 ReadUnusedBytesFromFile(file, chunk_size - 2);
2872 ei = &element_info[element];
2874 for (i = 0; i < MAX_ELEMENT_NAME_LEN; i++)
2875 ei->description[i] = getFile8Bit(file);
2876 ei->description[MAX_ELEMENT_NAME_LEN] = 0;
2878 ei->properties[EP_BITFIELD_BASE_NR] = getFile32BitBE(file);
2880 ReadUnusedBytesFromFile(file, 4); // reserved for more base properties
2882 ei->num_change_pages = getFile8Bit(file);
2884 chunk_size_expected = LEVEL_CHUNK_CUS4_SIZE(ei->num_change_pages);
2885 if (chunk_size_expected != chunk_size)
2887 ReadUnusedBytesFromFile(file, chunk_size - 43);
2888 return chunk_size_expected;
2891 ei->ce_value_fixed_initial = getFile16BitBE(file);
2892 ei->ce_value_random_initial = getFile16BitBE(file);
2893 ei->use_last_ce_value = getFile8Bit(file);
2895 ei->use_gfx_element = getFile8Bit(file);
2896 ei->gfx_element_initial = getMappedElement(getFile16BitBE(file));
2898 ei->collect_score_initial = getFile8Bit(file);
2899 ei->collect_count_initial = getFile8Bit(file);
2901 ei->drop_delay_fixed = getFile8Bit(file);
2902 ei->push_delay_fixed = getFile8Bit(file);
2903 ei->drop_delay_random = getFile8Bit(file);
2904 ei->push_delay_random = getFile8Bit(file);
2905 ei->move_delay_fixed = getFile16BitBE(file);
2906 ei->move_delay_random = getFile16BitBE(file);
2908 // bits 0 - 15 of "move_pattern" ...
2909 ei->move_pattern = getFile16BitBE(file);
2910 ei->move_direction_initial = getFile8Bit(file);
2911 ei->move_stepsize = getFile8Bit(file);
2913 ei->slippery_type = getFile8Bit(file);
2915 for (y = 0; y < 3; y++)
2916 for (x = 0; x < 3; x++)
2917 ei->content.e[x][y] = getMappedElement(getFile16BitBE(file));
2919 ei->move_enter_element = getMappedElement(getFile16BitBE(file));
2920 ei->move_leave_element = getMappedElement(getFile16BitBE(file));
2921 ei->move_leave_type = getFile8Bit(file);
2923 // ... bits 16 - 31 of "move_pattern" (not nice, but downward compatible)
2924 ei->move_pattern |= (getFile16BitBE(file) << 16);
2926 ei->access_direction = getFile8Bit(file);
2928 ei->explosion_delay = getFile8Bit(file);
2929 ei->ignition_delay = getFile8Bit(file);
2930 ei->explosion_type = getFile8Bit(file);
2932 // some free bytes for future custom property values and padding
2933 ReadUnusedBytesFromFile(file, 1);
2935 // ---------- change page property values (48 bytes) ------------------------
2937 setElementChangePages(ei, ei->num_change_pages);
2939 for (i = 0; i < ei->num_change_pages; i++)
2941 struct ElementChangeInfo *change = &ei->change_page[i];
2942 unsigned int event_bits;
2944 // always start with reliable default values
2945 setElementChangeInfoToDefaults(change);
2947 // bits 0 - 31 of "has_event[]" ...
2948 event_bits = getFile32BitBE(file);
2949 for (j = 0; j < MIN(NUM_CHANGE_EVENTS, 32); j++)
2950 if (event_bits & (1 << j))
2951 change->has_event[j] = TRUE;
2953 change->target_element = getMappedElement(getFile16BitBE(file));
2955 change->delay_fixed = getFile16BitBE(file);
2956 change->delay_random = getFile16BitBE(file);
2957 change->delay_frames = getFile16BitBE(file);
2959 change->initial_trigger_element = getMappedElement(getFile16BitBE(file));
2961 change->explode = getFile8Bit(file);
2962 change->use_target_content = getFile8Bit(file);
2963 change->only_if_complete = getFile8Bit(file);
2964 change->use_random_replace = getFile8Bit(file);
2966 change->random_percentage = getFile8Bit(file);
2967 change->replace_when = getFile8Bit(file);
2969 for (y = 0; y < 3; y++)
2970 for (x = 0; x < 3; x++)
2971 change->target_content.e[x][y]= getMappedElement(getFile16BitBE(file));
2973 change->can_change = getFile8Bit(file);
2975 change->trigger_side = getFile8Bit(file);
2977 change->trigger_player = getFile8Bit(file);
2978 change->trigger_page = getFile8Bit(file);
2980 change->trigger_page = (change->trigger_page == CH_PAGE_ANY_FILE ?
2981 CH_PAGE_ANY : (1 << change->trigger_page));
2983 change->has_action = getFile8Bit(file);
2984 change->action_type = getFile8Bit(file);
2985 change->action_mode = getFile8Bit(file);
2986 change->action_arg = getFile16BitBE(file);
2988 // ... bits 32 - 39 of "has_event[]" (not nice, but downward compatible)
2989 event_bits = getFile8Bit(file);
2990 for (j = 32; j < NUM_CHANGE_EVENTS; j++)
2991 if (event_bits & (1 << (j - 32)))
2992 change->has_event[j] = TRUE;
2995 // mark this custom element as modified
2996 ei->modified_settings = TRUE;
2998 level->file_has_custom_elements = TRUE;
3003 static int LoadLevel_GRP1(File *file, int chunk_size, struct LevelInfo *level)
3005 struct ElementInfo *ei;
3006 struct ElementGroupInfo *group;
3010 element = getMappedElement(getFile16BitBE(file));
3012 if (!IS_GROUP_ELEMENT(element))
3014 Warn("invalid group element number %d", element);
3016 ReadUnusedBytesFromFile(file, chunk_size - 2);
3021 ei = &element_info[element];
3023 for (i = 0; i < MAX_ELEMENT_NAME_LEN; i++)
3024 ei->description[i] = getFile8Bit(file);
3025 ei->description[MAX_ELEMENT_NAME_LEN] = 0;
3027 group = element_info[element].group;
3029 group->num_elements = getFile8Bit(file);
3031 ei->use_gfx_element = getFile8Bit(file);
3032 ei->gfx_element_initial = getMappedElement(getFile16BitBE(file));
3034 group->choice_mode = getFile8Bit(file);
3036 // some free bytes for future values and padding
3037 ReadUnusedBytesFromFile(file, 3);
3039 for (i = 0; i < MAX_ELEMENTS_IN_GROUP; i++)
3040 group->element[i] = getMappedElement(getFile16BitBE(file));
3042 // mark this group element as modified
3043 element_info[element].modified_settings = TRUE;
3045 level->file_has_custom_elements = TRUE;
3050 static int LoadLevel_MicroChunk(File *file, struct LevelFileConfigInfo *conf,
3051 int element, int real_element)
3053 int micro_chunk_size = 0;
3054 int conf_type = getFile8Bit(file);
3055 int byte_mask = conf_type & CONF_MASK_BYTES;
3056 boolean element_found = FALSE;
3059 micro_chunk_size += 1;
3061 if (byte_mask == CONF_MASK_MULTI_BYTES)
3063 int num_bytes = getFile16BitBE(file);
3064 byte *buffer = checked_malloc(num_bytes);
3066 ReadBytesFromFile(file, buffer, num_bytes);
3068 for (i = 0; conf[i].data_type != -1; i++)
3070 if (conf[i].element == element &&
3071 conf[i].conf_type == conf_type)
3073 int data_type = conf[i].data_type;
3074 int num_entities = num_bytes / CONF_ENTITY_NUM_BYTES(data_type);
3075 int max_num_entities = conf[i].max_num_entities;
3077 if (num_entities > max_num_entities)
3079 Warn("truncating number of entities for element %d from %d to %d",
3080 element, num_entities, max_num_entities);
3082 num_entities = max_num_entities;
3085 if (num_entities == 0 && (data_type == TYPE_ELEMENT_LIST ||
3086 data_type == TYPE_CONTENT_LIST))
3088 // for element and content lists, zero entities are not allowed
3089 Warn("found empty list of entities for element %d", element);
3091 // do not set "num_entities" here to prevent reading behind buffer
3093 *(int *)(conf[i].num_entities) = 1; // at least one is required
3097 *(int *)(conf[i].num_entities) = num_entities;
3100 element_found = TRUE;
3102 if (data_type == TYPE_STRING)
3104 char *string = (char *)(conf[i].value);
3107 for (j = 0; j < max_num_entities; j++)
3108 string[j] = (j < num_entities ? buffer[j] : '\0');
3110 else if (data_type == TYPE_ELEMENT_LIST)
3112 int *element_array = (int *)(conf[i].value);
3115 for (j = 0; j < num_entities; j++)
3117 getMappedElement(CONF_ELEMENTS_ELEMENT(buffer, j));
3119 else if (data_type == TYPE_CONTENT_LIST)
3121 struct Content *content= (struct Content *)(conf[i].value);
3124 for (c = 0; c < num_entities; c++)
3125 for (y = 0; y < 3; y++)
3126 for (x = 0; x < 3; x++)
3127 content[c].e[x][y] =
3128 getMappedElement(CONF_CONTENTS_ELEMENT(buffer, c, x, y));
3131 element_found = FALSE;
3137 checked_free(buffer);
3139 micro_chunk_size += 2 + num_bytes;
3141 else // constant size configuration data (1, 2 or 4 bytes)
3143 int value = (byte_mask == CONF_MASK_1_BYTE ? getFile8Bit (file) :
3144 byte_mask == CONF_MASK_2_BYTE ? getFile16BitBE(file) :
3145 byte_mask == CONF_MASK_4_BYTE ? getFile32BitBE(file) : 0);
3147 for (i = 0; conf[i].data_type != -1; i++)
3149 if (conf[i].element == element &&
3150 conf[i].conf_type == conf_type)
3152 int data_type = conf[i].data_type;
3154 if (data_type == TYPE_ELEMENT)
3155 value = getMappedElement(value);
3157 if (data_type == TYPE_BOOLEAN)
3158 *(boolean *)(conf[i].value) = value;
3160 *(int *) (conf[i].value) = value;
3162 element_found = TRUE;
3168 micro_chunk_size += CONF_VALUE_NUM_BYTES(byte_mask);
3173 char *error_conf_chunk_bytes =
3174 (byte_mask == CONF_MASK_1_BYTE ? "CONF_VALUE_8_BIT" :
3175 byte_mask == CONF_MASK_2_BYTE ? "CONF_VALUE_16_BIT" :
3176 byte_mask == CONF_MASK_4_BYTE ? "CONF_VALUE_32_BIT" :"CONF_VALUE_BYTES");
3177 int error_conf_chunk_token = conf_type & CONF_MASK_TOKEN;
3178 int error_element = real_element;
3180 Warn("cannot load micro chunk '%s(%d)' value for element %d ['%s']",
3181 error_conf_chunk_bytes, error_conf_chunk_token,
3182 error_element, EL_NAME(error_element));
3185 return micro_chunk_size;
3188 static int LoadLevel_INFO(File *file, int chunk_size, struct LevelInfo *level)
3190 int real_chunk_size = 0;
3192 li = *level; // copy level data into temporary buffer
3194 while (!checkEndOfFile(file))
3196 real_chunk_size += LoadLevel_MicroChunk(file, chunk_config_INFO, -1, -1);
3198 if (real_chunk_size >= chunk_size)
3202 *level = li; // copy temporary buffer back to level data
3204 return real_chunk_size;
3207 static int LoadLevel_CONF(File *file, int chunk_size, struct LevelInfo *level)
3209 int real_chunk_size = 0;
3211 li = *level; // copy level data into temporary buffer
3213 while (!checkEndOfFile(file))
3215 int element = getMappedElement(getFile16BitBE(file));
3217 real_chunk_size += 2;
3218 real_chunk_size += LoadLevel_MicroChunk(file, chunk_config_CONF,
3220 if (real_chunk_size >= chunk_size)
3224 *level = li; // copy temporary buffer back to level data
3226 return real_chunk_size;
3229 static int LoadLevel_ELEM(File *file, int chunk_size, struct LevelInfo *level)
3231 int real_chunk_size = 0;
3233 li = *level; // copy level data into temporary buffer
3235 while (!checkEndOfFile(file))
3237 int element = getMappedElement(getFile16BitBE(file));
3239 real_chunk_size += 2;
3240 real_chunk_size += LoadLevel_MicroChunk(file, chunk_config_ELEM,
3242 if (real_chunk_size >= chunk_size)
3246 *level = li; // copy temporary buffer back to level data
3248 return real_chunk_size;
3251 static int LoadLevel_NOTE(File *file, int chunk_size, struct LevelInfo *level)
3253 int element = getMappedElement(getFile16BitBE(file));
3254 int envelope_nr = element - EL_ENVELOPE_1;
3255 int real_chunk_size = 2;
3257 xx_envelope = level->envelope[envelope_nr]; // copy into temporary buffer
3259 while (!checkEndOfFile(file))
3261 real_chunk_size += LoadLevel_MicroChunk(file, chunk_config_NOTE,
3264 if (real_chunk_size >= chunk_size)
3268 level->envelope[envelope_nr] = xx_envelope; // copy from temporary buffer
3270 return real_chunk_size;
3273 static int LoadLevel_CUSX(File *file, int chunk_size, struct LevelInfo *level)
3275 int element = getMappedElement(getFile16BitBE(file));
3276 int real_chunk_size = 2;
3277 struct ElementInfo *ei = &element_info[element];
3280 xx_ei = *ei; // copy element data into temporary buffer
3282 xx_ei.num_change_pages = -1;
3284 while (!checkEndOfFile(file))
3286 real_chunk_size += LoadLevel_MicroChunk(file, chunk_config_CUSX_base,
3288 if (xx_ei.num_change_pages != -1)
3291 if (real_chunk_size >= chunk_size)
3297 if (ei->num_change_pages == -1)
3299 Warn("LoadLevel_CUSX(): missing 'num_change_pages' for '%s'",
3302 ei->num_change_pages = 1;
3304 setElementChangePages(ei, 1);
3305 setElementChangeInfoToDefaults(ei->change);
3307 return real_chunk_size;
3310 // initialize number of change pages stored for this custom element
3311 setElementChangePages(ei, ei->num_change_pages);
3312 for (i = 0; i < ei->num_change_pages; i++)
3313 setElementChangeInfoToDefaults(&ei->change_page[i]);
3315 // start with reading properties for the first change page
3316 xx_current_change_page = 0;
3318 while (!checkEndOfFile(file))
3320 struct ElementChangeInfo *change = &ei->change_page[xx_current_change_page];
3322 xx_change = *change; // copy change data into temporary buffer
3324 resetEventBits(); // reset bits; change page might have changed
3326 real_chunk_size += LoadLevel_MicroChunk(file, chunk_config_CUSX_change,
3329 *change = xx_change;
3331 setEventFlagsFromEventBits(change);
3333 if (real_chunk_size >= chunk_size)
3337 level->file_has_custom_elements = TRUE;
3339 return real_chunk_size;
3342 static int LoadLevel_GRPX(File *file, int chunk_size, struct LevelInfo *level)
3344 int element = getMappedElement(getFile16BitBE(file));
3345 int real_chunk_size = 2;
3346 struct ElementInfo *ei = &element_info[element];
3347 struct ElementGroupInfo *group = ei->group;
3349 xx_ei = *ei; // copy element data into temporary buffer
3350 xx_group = *group; // copy group data into temporary buffer
3352 while (!checkEndOfFile(file))
3354 real_chunk_size += LoadLevel_MicroChunk(file, chunk_config_GRPX,
3357 if (real_chunk_size >= chunk_size)
3364 level->file_has_custom_elements = TRUE;
3366 return real_chunk_size;
3369 static void LoadLevelFromFileInfo_RND(struct LevelInfo *level,
3370 struct LevelFileInfo *level_file_info,
3371 boolean level_info_only)
3373 char *filename = level_file_info->filename;
3374 char cookie[MAX_LINE_LEN];
3375 char chunk_name[CHUNK_ID_LEN + 1];
3379 if (!(file = openFile(filename, MODE_READ)))
3381 level->no_valid_file = TRUE;
3382 level->no_level_file = TRUE;
3384 if (level_info_only)
3387 Warn("cannot read level '%s' -- using empty level", filename);
3389 if (!setup.editor.use_template_for_new_levels)
3392 // if level file not found, try to initialize level data from template
3393 filename = getGlobalLevelTemplateFilename();
3395 if (!(file = openFile(filename, MODE_READ)))
3398 // default: for empty levels, use level template for custom elements
3399 level->use_custom_template = TRUE;
3401 level->no_valid_file = FALSE;
3404 getFileChunkBE(file, chunk_name, NULL);
3405 if (strEqual(chunk_name, "RND1"))
3407 getFile32BitBE(file); // not used
3409 getFileChunkBE(file, chunk_name, NULL);
3410 if (!strEqual(chunk_name, "CAVE"))
3412 level->no_valid_file = TRUE;
3414 Warn("unknown format of level file '%s'", filename);
3421 else // check for pre-2.0 file format with cookie string
3423 strcpy(cookie, chunk_name);
3424 if (getStringFromFile(file, &cookie[4], MAX_LINE_LEN - 4) == NULL)
3426 if (strlen(cookie) > 0 && cookie[strlen(cookie) - 1] == '\n')
3427 cookie[strlen(cookie) - 1] = '\0';
3429 if (!checkCookieString(cookie, LEVEL_COOKIE_TMPL))
3431 level->no_valid_file = TRUE;
3433 Warn("unknown format of level file '%s'", filename);
3440 if ((level->file_version = getFileVersionFromCookieString(cookie)) == -1)
3442 level->no_valid_file = TRUE;
3444 Warn("unsupported version of level file '%s'", filename);
3451 // pre-2.0 level files have no game version, so use file version here
3452 level->game_version = level->file_version;
3455 if (level->file_version < FILE_VERSION_1_2)
3457 // level files from versions before 1.2.0 without chunk structure
3458 LoadLevel_HEAD(file, LEVEL_CHUNK_HEAD_SIZE, level);
3459 LoadLevel_BODY(file, level->fieldx * level->fieldy, level);
3467 int (*loader)(File *, int, struct LevelInfo *);
3471 { "VERS", LEVEL_CHUNK_VERS_SIZE, LoadLevel_VERS },
3472 { "DATE", LEVEL_CHUNK_DATE_SIZE, LoadLevel_DATE },
3473 { "HEAD", LEVEL_CHUNK_HEAD_SIZE, LoadLevel_HEAD },
3474 { "NAME", LEVEL_CHUNK_NAME_SIZE, LoadLevel_NAME },
3475 { "AUTH", LEVEL_CHUNK_AUTH_SIZE, LoadLevel_AUTH },
3476 { "INFO", -1, LoadLevel_INFO },
3477 { "BODY", -1, LoadLevel_BODY },
3478 { "CONT", -1, LoadLevel_CONT },
3479 { "CNT2", LEVEL_CHUNK_CNT2_SIZE, LoadLevel_CNT2 },
3480 { "CNT3", -1, LoadLevel_CNT3 },
3481 { "CUS1", -1, LoadLevel_CUS1 },
3482 { "CUS2", -1, LoadLevel_CUS2 },
3483 { "CUS3", -1, LoadLevel_CUS3 },
3484 { "CUS4", -1, LoadLevel_CUS4 },
3485 { "GRP1", -1, LoadLevel_GRP1 },
3486 { "CONF", -1, LoadLevel_CONF },
3487 { "ELEM", -1, LoadLevel_ELEM },
3488 { "NOTE", -1, LoadLevel_NOTE },
3489 { "CUSX", -1, LoadLevel_CUSX },
3490 { "GRPX", -1, LoadLevel_GRPX },
3495 while (getFileChunkBE(file, chunk_name, &chunk_size))
3499 while (chunk_info[i].name != NULL &&
3500 !strEqual(chunk_name, chunk_info[i].name))
3503 if (chunk_info[i].name == NULL)
3505 Warn("unknown chunk '%s' in level file '%s'",
3506 chunk_name, filename);
3508 ReadUnusedBytesFromFile(file, chunk_size);
3510 else if (chunk_info[i].size != -1 &&
3511 chunk_info[i].size != chunk_size)
3513 Warn("wrong size (%d) of chunk '%s' in level file '%s'",
3514 chunk_size, chunk_name, filename);
3516 ReadUnusedBytesFromFile(file, chunk_size);
3520 // call function to load this level chunk
3521 int chunk_size_expected =
3522 (chunk_info[i].loader)(file, chunk_size, level);
3524 // the size of some chunks cannot be checked before reading other
3525 // chunks first (like "HEAD" and "BODY") that contain some header
3526 // information, so check them here
3527 if (chunk_size_expected != chunk_size)
3529 Warn("wrong size (%d) of chunk '%s' in level file '%s'",
3530 chunk_size, chunk_name, filename);
3540 // ----------------------------------------------------------------------------
3541 // functions for loading EM level
3542 // ----------------------------------------------------------------------------
3544 static void CopyNativeLevel_RND_to_EM(struct LevelInfo *level)
3546 static int ball_xy[8][2] =
3557 struct LevelInfo_EM *level_em = level->native_em_level;
3558 struct CAVE *cav = level_em->cav;
3561 cav->width = MIN(level->fieldx, MAX_PLAYFIELD_WIDTH);
3562 cav->height = MIN(level->fieldy, MAX_PLAYFIELD_HEIGHT);
3564 cav->time_seconds = level->time;
3565 cav->gems_needed = level->gems_needed;
3567 cav->emerald_score = level->score[SC_EMERALD];
3568 cav->diamond_score = level->score[SC_DIAMOND];
3569 cav->alien_score = level->score[SC_ROBOT];
3570 cav->tank_score = level->score[SC_SPACESHIP];
3571 cav->bug_score = level->score[SC_BUG];
3572 cav->eater_score = level->score[SC_YAMYAM];
3573 cav->nut_score = level->score[SC_NUT];
3574 cav->dynamite_score = level->score[SC_DYNAMITE];
3575 cav->key_score = level->score[SC_KEY];
3576 cav->exit_score = level->score[SC_TIME_BONUS];
3578 cav->num_eater_arrays = level->num_yamyam_contents;
3580 for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
3581 for (y = 0; y < 3; y++)
3582 for (x = 0; x < 3; x++)
3583 cav->eater_array[i][y * 3 + x] =
3584 map_element_RND_to_EM_cave(level->yamyam_content[i].e[x][y]);
3586 cav->amoeba_time = level->amoeba_speed;
3587 cav->wonderwall_time = level->time_magic_wall;
3588 cav->wheel_time = level->time_wheel;
3590 cav->android_move_time = level->android_move_time;
3591 cav->android_clone_time = level->android_clone_time;
3592 cav->ball_random = level->ball_random;
3593 cav->ball_active = level->ball_active_initial;
3594 cav->ball_time = level->ball_time;
3595 cav->num_ball_arrays = level->num_ball_contents;
3597 cav->lenses_score = level->lenses_score;
3598 cav->magnify_score = level->magnify_score;
3599 cav->slurp_score = level->slurp_score;
3601 cav->lenses_time = level->lenses_time;
3602 cav->magnify_time = level->magnify_time;
3604 cav->wind_direction =
3605 map_direction_RND_to_EM(level->wind_direction_initial);
3607 for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
3608 for (j = 0; j < 8; j++)
3609 cav->ball_array[i][j] =
3610 map_element_RND_to_EM_cave(level->ball_content[i].
3611 e[ball_xy[j][0]][ball_xy[j][1]]);
3613 map_android_clone_elements_RND_to_EM(level);
3615 // first fill the complete playfield with the empty space element
3616 for (y = 0; y < EM_MAX_CAVE_HEIGHT; y++)
3617 for (x = 0; x < EM_MAX_CAVE_WIDTH; x++)
3618 cav->cave[x][y] = Cblank;
3620 // then copy the real level contents from level file into the playfield
3621 for (y = 0; y < cav->height; y++) for (x = 0; x < cav->width; x++)
3623 int new_element = map_element_RND_to_EM_cave(level->field[x][y]);
3625 if (level->field[x][y] == EL_AMOEBA_DEAD)
3626 new_element = map_element_RND_to_EM_cave(EL_AMOEBA_WET);
3628 cav->cave[x][y] = new_element;
3631 for (i = 0; i < MAX_PLAYERS; i++)
3633 cav->player_x[i] = -1;
3634 cav->player_y[i] = -1;
3637 // initialize player positions and delete players from the playfield
3638 for (y = 0; y < cav->height; y++) for (x = 0; x < cav->width; x++)
3640 if (ELEM_IS_PLAYER(level->field[x][y]))
3642 int player_nr = GET_PLAYER_NR(level->field[x][y]);
3644 cav->player_x[player_nr] = x;
3645 cav->player_y[player_nr] = y;
3647 cav->cave[x][y] = map_element_RND_to_EM_cave(EL_EMPTY);
3652 static void CopyNativeLevel_EM_to_RND(struct LevelInfo *level)
3654 static int ball_xy[8][2] =
3665 struct LevelInfo_EM *level_em = level->native_em_level;
3666 struct CAVE *cav = level_em->cav;
3669 level->fieldx = MIN(cav->width, MAX_LEV_FIELDX);
3670 level->fieldy = MIN(cav->height, MAX_LEV_FIELDY);
3672 level->time = cav->time_seconds;
3673 level->gems_needed = cav->gems_needed;
3675 sprintf(level->name, "Level %d", level->file_info.nr);
3677 level->score[SC_EMERALD] = cav->emerald_score;
3678 level->score[SC_DIAMOND] = cav->diamond_score;
3679 level->score[SC_ROBOT] = cav->alien_score;
3680 level->score[SC_SPACESHIP] = cav->tank_score;
3681 level->score[SC_BUG] = cav->bug_score;
3682 level->score[SC_YAMYAM] = cav->eater_score;
3683 level->score[SC_NUT] = cav->nut_score;
3684 level->score[SC_DYNAMITE] = cav->dynamite_score;
3685 level->score[SC_KEY] = cav->key_score;
3686 level->score[SC_TIME_BONUS] = cav->exit_score;
3688 level->num_yamyam_contents = cav->num_eater_arrays;
3690 for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
3691 for (y = 0; y < 3; y++)
3692 for (x = 0; x < 3; x++)
3693 level->yamyam_content[i].e[x][y] =
3694 map_element_EM_to_RND_cave(cav->eater_array[i][y * 3 + x]);
3696 level->amoeba_speed = cav->amoeba_time;
3697 level->time_magic_wall = cav->wonderwall_time;
3698 level->time_wheel = cav->wheel_time;
3700 level->android_move_time = cav->android_move_time;
3701 level->android_clone_time = cav->android_clone_time;
3702 level->ball_random = cav->ball_random;
3703 level->ball_active_initial = cav->ball_active;
3704 level->ball_time = cav->ball_time;
3705 level->num_ball_contents = cav->num_ball_arrays;
3707 level->lenses_score = cav->lenses_score;
3708 level->magnify_score = cav->magnify_score;
3709 level->slurp_score = cav->slurp_score;
3711 level->lenses_time = cav->lenses_time;
3712 level->magnify_time = cav->magnify_time;
3714 level->wind_direction_initial =
3715 map_direction_EM_to_RND(cav->wind_direction);
3717 for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
3718 for (j = 0; j < 8; j++)
3719 level->ball_content[i].e[ball_xy[j][0]][ball_xy[j][1]] =
3720 map_element_EM_to_RND_cave(cav->ball_array[i][j]);
3722 map_android_clone_elements_EM_to_RND(level);
3724 // convert the playfield (some elements need special treatment)
3725 for (y = 0; y < level->fieldy; y++) for (x = 0; x < level->fieldx; x++)
3727 int new_element = map_element_EM_to_RND_cave(cav->cave[x][y]);
3729 if (new_element == EL_AMOEBA_WET && level->amoeba_speed == 0)
3730 new_element = EL_AMOEBA_DEAD;
3732 level->field[x][y] = new_element;
3735 for (i = 0; i < MAX_PLAYERS; i++)
3737 // in case of all players set to the same field, use the first player
3738 int nr = MAX_PLAYERS - i - 1;
3739 int jx = cav->player_x[nr];
3740 int jy = cav->player_y[nr];
3742 if (jx != -1 && jy != -1)
3743 level->field[jx][jy] = EL_PLAYER_1 + nr;
3746 // time score is counted for each 10 seconds left in Emerald Mine levels
3747 level->time_score_base = 10;
3751 // ----------------------------------------------------------------------------
3752 // functions for loading SP level
3753 // ----------------------------------------------------------------------------
3755 static void CopyNativeLevel_RND_to_SP(struct LevelInfo *level)
3757 struct LevelInfo_SP *level_sp = level->native_sp_level;
3758 LevelInfoType *header = &level_sp->header;
3761 level_sp->width = level->fieldx;
3762 level_sp->height = level->fieldy;
3764 for (x = 0; x < level->fieldx; x++)
3765 for (y = 0; y < level->fieldy; y++)
3766 level_sp->playfield[x][y] = map_element_RND_to_SP(level->field[x][y]);
3768 header->InitialGravity = (level->initial_player_gravity[0] ? 1 : 0);
3770 for (i = 0; i < SP_LEVEL_NAME_LEN; i++)
3771 header->LevelTitle[i] = level->name[i];
3772 // !!! NO STRING TERMINATION IN SUPAPLEX VB CODE YET -- FIX THIS !!!
3774 header->InfotronsNeeded = level->gems_needed;
3776 header->SpecialPortCount = 0;
3778 for (x = 0; x < level->fieldx; x++) for (y = 0; y < level->fieldy; y++)
3780 boolean gravity_port_found = FALSE;
3781 boolean gravity_port_valid = FALSE;
3782 int gravity_port_flag;
3783 int gravity_port_base_element;
3784 int element = level->field[x][y];
3786 if (element >= EL_SP_GRAVITY_ON_PORT_RIGHT &&
3787 element <= EL_SP_GRAVITY_ON_PORT_UP)
3789 gravity_port_found = TRUE;
3790 gravity_port_valid = TRUE;
3791 gravity_port_flag = 1;
3792 gravity_port_base_element = EL_SP_GRAVITY_ON_PORT_RIGHT;
3794 else if (element >= EL_SP_GRAVITY_OFF_PORT_RIGHT &&
3795 element <= EL_SP_GRAVITY_OFF_PORT_UP)
3797 gravity_port_found = TRUE;
3798 gravity_port_valid = TRUE;
3799 gravity_port_flag = 0;
3800 gravity_port_base_element = EL_SP_GRAVITY_OFF_PORT_RIGHT;
3802 else if (element >= EL_SP_GRAVITY_PORT_RIGHT &&
3803 element <= EL_SP_GRAVITY_PORT_UP)
3805 // change R'n'D style gravity inverting special port to normal port
3806 // (there are no gravity inverting ports in native Supaplex engine)
3808 gravity_port_found = TRUE;
3809 gravity_port_valid = FALSE;
3810 gravity_port_base_element = EL_SP_GRAVITY_PORT_RIGHT;
3813 if (gravity_port_found)
3815 if (gravity_port_valid &&
3816 header->SpecialPortCount < SP_MAX_SPECIAL_PORTS)
3818 SpecialPortType *port = &header->SpecialPort[header->SpecialPortCount];
3820 port->PortLocation = (y * level->fieldx + x) * 2;
3821 port->Gravity = gravity_port_flag;
3823 element += EL_SP_GRAVITY_PORT_RIGHT - gravity_port_base_element;
3825 header->SpecialPortCount++;
3829 // change special gravity port to normal port
3831 element += EL_SP_PORT_RIGHT - gravity_port_base_element;
3834 level_sp->playfield[x][y] = element - EL_SP_START;
3839 static void CopyNativeLevel_SP_to_RND(struct LevelInfo *level)
3841 struct LevelInfo_SP *level_sp = level->native_sp_level;
3842 LevelInfoType *header = &level_sp->header;
3843 boolean num_invalid_elements = 0;
3846 level->fieldx = level_sp->width;
3847 level->fieldy = level_sp->height;
3849 for (x = 0; x < level->fieldx; x++)
3851 for (y = 0; y < level->fieldy; y++)
3853 int element_old = level_sp->playfield[x][y];
3854 int element_new = getMappedElement(map_element_SP_to_RND(element_old));
3856 if (element_new == EL_UNKNOWN)
3858 num_invalid_elements++;
3860 Debug("level:native:SP", "invalid element %d at position %d, %d",
3864 level->field[x][y] = element_new;
3868 if (num_invalid_elements > 0)
3869 Warn("found %d invalid elements%s", num_invalid_elements,
3870 (!options.debug ? " (use '--debug' for more details)" : ""));
3872 for (i = 0; i < MAX_PLAYERS; i++)
3873 level->initial_player_gravity[i] =
3874 (header->InitialGravity == 1 ? TRUE : FALSE);
3876 // skip leading spaces
3877 for (i = 0; i < SP_LEVEL_NAME_LEN; i++)
3878 if (header->LevelTitle[i] != ' ')
3882 for (j = 0; i < SP_LEVEL_NAME_LEN; i++, j++)
3883 level->name[j] = header->LevelTitle[i];
3884 level->name[j] = '\0';
3886 // cut trailing spaces
3888 if (level->name[j - 1] == ' ' && level->name[j] == '\0')
3889 level->name[j - 1] = '\0';
3891 level->gems_needed = header->InfotronsNeeded;
3893 for (i = 0; i < header->SpecialPortCount; i++)
3895 SpecialPortType *port = &header->SpecialPort[i];
3896 int port_location = port->PortLocation;
3897 int gravity = port->Gravity;
3898 int port_x, port_y, port_element;
3900 port_x = (port_location / 2) % level->fieldx;
3901 port_y = (port_location / 2) / level->fieldx;
3903 if (port_x < 0 || port_x >= level->fieldx ||
3904 port_y < 0 || port_y >= level->fieldy)
3906 Warn("special port position (%d, %d) out of bounds", port_x, port_y);
3911 port_element = level->field[port_x][port_y];
3913 if (port_element < EL_SP_GRAVITY_PORT_RIGHT ||
3914 port_element > EL_SP_GRAVITY_PORT_UP)
3916 Warn("no special port at position (%d, %d)", port_x, port_y);
3921 // change previous (wrong) gravity inverting special port to either
3922 // gravity enabling special port or gravity disabling special port
3923 level->field[port_x][port_y] +=
3924 (gravity == 1 ? EL_SP_GRAVITY_ON_PORT_RIGHT :
3925 EL_SP_GRAVITY_OFF_PORT_RIGHT) - EL_SP_GRAVITY_PORT_RIGHT;
3928 // change special gravity ports without database entries to normal ports
3929 for (x = 0; x < level->fieldx; x++)
3930 for (y = 0; y < level->fieldy; y++)
3931 if (level->field[x][y] >= EL_SP_GRAVITY_PORT_RIGHT &&
3932 level->field[x][y] <= EL_SP_GRAVITY_PORT_UP)
3933 level->field[x][y] += EL_SP_PORT_RIGHT - EL_SP_GRAVITY_PORT_RIGHT;
3935 level->time = 0; // no time limit
3936 level->amoeba_speed = 0;
3937 level->time_magic_wall = 0;
3938 level->time_wheel = 0;
3939 level->amoeba_content = EL_EMPTY;
3941 // original Supaplex does not use score values -- rate by playing time
3942 for (i = 0; i < LEVEL_SCORE_ELEMENTS; i++)
3943 level->score[i] = 0;
3945 level->rate_time_over_score = TRUE;
3947 // there are no yamyams in supaplex levels
3948 for (i = 0; i < level->num_yamyam_contents; i++)
3949 for (x = 0; x < 3; x++)
3950 for (y = 0; y < 3; y++)
3951 level->yamyam_content[i].e[x][y] = EL_EMPTY;
3954 static void CopyNativeTape_RND_to_SP(struct LevelInfo *level)
3956 struct LevelInfo_SP *level_sp = level->native_sp_level;
3957 struct DemoInfo_SP *demo = &level_sp->demo;
3960 // always start with reliable default values
3961 demo->is_available = FALSE;
3964 if (TAPE_IS_EMPTY(tape))
3967 demo->level_nr = tape.level_nr; // (currently not used)
3969 level_sp->header.DemoRandomSeed = tape.random_seed;
3973 for (i = 0; i < tape.length; i++)
3975 int demo_action = map_key_RND_to_SP(tape.pos[i].action[0]);
3976 int demo_repeat = tape.pos[i].delay;
3977 int demo_entries = (demo_repeat + 15) / 16;
3979 if (demo->length + demo_entries >= SP_MAX_TAPE_LEN)
3981 Warn("tape truncated: size exceeds maximum SP demo size %d",
3987 for (j = 0; j < demo_repeat / 16; j++)
3988 demo->data[demo->length++] = 0xf0 | demo_action;
3990 if (demo_repeat % 16)
3991 demo->data[demo->length++] = ((demo_repeat % 16 - 1) << 4) | demo_action;
3994 demo->is_available = TRUE;
3997 static void setTapeInfoToDefaults(void);
3999 static void CopyNativeTape_SP_to_RND(struct LevelInfo *level)
4001 struct LevelInfo_SP *level_sp = level->native_sp_level;
4002 struct DemoInfo_SP *demo = &level_sp->demo;
4003 char *filename = level->file_info.filename;
4006 // always start with reliable default values
4007 setTapeInfoToDefaults();
4009 if (!demo->is_available)
4012 tape.level_nr = demo->level_nr; // (currently not used)
4013 tape.random_seed = level_sp->header.DemoRandomSeed;
4015 TapeSetDateFromEpochSeconds(getFileTimestampEpochSeconds(filename));
4018 tape.pos[tape.counter].delay = 0;
4020 for (i = 0; i < demo->length; i++)
4022 int demo_action = demo->data[i] & 0x0f;
4023 int demo_repeat = (demo->data[i] & 0xf0) >> 4;
4024 int tape_action = map_key_SP_to_RND(demo_action);
4025 int tape_repeat = demo_repeat + 1;
4026 byte action[MAX_TAPE_ACTIONS] = { tape_action };
4027 boolean success = 0;
4030 for (j = 0; j < tape_repeat; j++)
4031 success = TapeAddAction(action);
4035 Warn("SP demo truncated: size exceeds maximum tape size %d",
4042 TapeHaltRecording();
4046 // ----------------------------------------------------------------------------
4047 // functions for loading MM level
4048 // ----------------------------------------------------------------------------
4050 static void CopyNativeLevel_RND_to_MM(struct LevelInfo *level)
4052 struct LevelInfo_MM *level_mm = level->native_mm_level;
4055 level_mm->fieldx = MIN(level->fieldx, MM_MAX_PLAYFIELD_WIDTH);
4056 level_mm->fieldy = MIN(level->fieldy, MM_MAX_PLAYFIELD_HEIGHT);
4058 level_mm->time = level->time;
4059 level_mm->kettles_needed = level->gems_needed;
4060 level_mm->auto_count_kettles = level->auto_count_gems;
4062 level_mm->laser_red = level->mm_laser_red;
4063 level_mm->laser_green = level->mm_laser_green;
4064 level_mm->laser_blue = level->mm_laser_blue;
4066 strcpy(level_mm->name, level->name);
4067 strcpy(level_mm->author, level->author);
4069 level_mm->score[SC_EMERALD] = level->score[SC_EMERALD];
4070 level_mm->score[SC_PACMAN] = level->score[SC_PACMAN];
4071 level_mm->score[SC_KEY] = level->score[SC_KEY];
4072 level_mm->score[SC_TIME_BONUS] = level->score[SC_TIME_BONUS];
4073 level_mm->score[SC_ELEM_BONUS] = level->score[SC_ELEM_BONUS];
4075 level_mm->amoeba_speed = level->amoeba_speed;
4076 level_mm->time_fuse = level->mm_time_fuse;
4077 level_mm->time_bomb = level->mm_time_bomb;
4078 level_mm->time_ball = level->mm_time_ball;
4079 level_mm->time_block = level->mm_time_block;
4081 for (x = 0; x < level->fieldx; x++)
4082 for (y = 0; y < level->fieldy; y++)
4084 level_mm->field[x][y] = map_element_RND_to_MM(level->field[x][y]);
4087 static void CopyNativeLevel_MM_to_RND(struct LevelInfo *level)
4089 struct LevelInfo_MM *level_mm = level->native_mm_level;
4092 level->fieldx = MIN(level_mm->fieldx, MAX_LEV_FIELDX);
4093 level->fieldy = MIN(level_mm->fieldy, MAX_LEV_FIELDY);
4095 level->time = level_mm->time;
4096 level->gems_needed = level_mm->kettles_needed;
4097 level->auto_count_gems = level_mm->auto_count_kettles;
4099 level->mm_laser_red = level_mm->laser_red;
4100 level->mm_laser_green = level_mm->laser_green;
4101 level->mm_laser_blue = level_mm->laser_blue;
4103 strcpy(level->name, level_mm->name);
4105 // only overwrite author from 'levelinfo.conf' if author defined in level
4106 if (!strEqual(level_mm->author, ANONYMOUS_NAME))
4107 strcpy(level->author, level_mm->author);
4109 level->score[SC_EMERALD] = level_mm->score[SC_EMERALD];
4110 level->score[SC_PACMAN] = level_mm->score[SC_PACMAN];
4111 level->score[SC_KEY] = level_mm->score[SC_KEY];
4112 level->score[SC_TIME_BONUS] = level_mm->score[SC_TIME_BONUS];
4113 level->score[SC_ELEM_BONUS] = level_mm->score[SC_ELEM_BONUS];
4115 level->amoeba_speed = level_mm->amoeba_speed;
4116 level->mm_time_fuse = level_mm->time_fuse;
4117 level->mm_time_bomb = level_mm->time_bomb;
4118 level->mm_time_ball = level_mm->time_ball;
4119 level->mm_time_block = level_mm->time_block;
4121 for (x = 0; x < level->fieldx; x++)
4122 for (y = 0; y < level->fieldy; y++)
4123 level->field[x][y] = map_element_MM_to_RND(level_mm->field[x][y]);
4127 // ----------------------------------------------------------------------------
4128 // functions for loading DC level
4129 // ----------------------------------------------------------------------------
4131 #define DC_LEVEL_HEADER_SIZE 344
4133 static unsigned short getDecodedWord_DC(unsigned short data_encoded,
4136 static int last_data_encoded;
4140 int diff_hi, diff_lo;
4141 int data_hi, data_lo;
4142 unsigned short data_decoded;
4146 last_data_encoded = 0;
4153 diff = data_encoded - last_data_encoded;
4154 diff_hi = diff & ~0xff;
4155 diff_lo = diff & 0xff;
4159 data_hi = diff_hi - (offset1 << 8) + (offset2 & 0xff00);
4160 data_lo = (diff_lo + (data_hi >> 16)) & 0x00ff;
4161 data_hi = data_hi & 0xff00;
4163 data_decoded = data_hi | data_lo;
4165 last_data_encoded = data_encoded;
4167 offset1 = (offset1 + 1) % 31;
4168 offset2 = offset2 & 0xff;
4170 return data_decoded;
4173 static int getMappedElement_DC(int element)
4181 // 0x0117 - 0x036e: (?)
4184 // 0x042d - 0x0684: (?)
4200 element = EL_CRYSTAL;
4203 case 0x0e77: // quicksand (boulder)
4204 element = EL_QUICKSAND_FAST_FULL;
4207 case 0x0e99: // slow quicksand (boulder)
4208 element = EL_QUICKSAND_FULL;
4212 element = EL_EM_EXIT_OPEN;
4216 element = EL_EM_EXIT_CLOSED;
4220 element = EL_EM_STEEL_EXIT_OPEN;
4224 element = EL_EM_STEEL_EXIT_CLOSED;
4227 case 0x0f4f: // dynamite (lit 1)
4228 element = EL_EM_DYNAMITE_ACTIVE;
4231 case 0x0f57: // dynamite (lit 2)
4232 element = EL_EM_DYNAMITE_ACTIVE;
4235 case 0x0f5f: // dynamite (lit 3)
4236 element = EL_EM_DYNAMITE_ACTIVE;
4239 case 0x0f67: // dynamite (lit 4)
4240 element = EL_EM_DYNAMITE_ACTIVE;
4247 element = EL_AMOEBA_WET;
4251 element = EL_AMOEBA_DROP;
4255 element = EL_DC_MAGIC_WALL;
4259 element = EL_SPACESHIP_UP;
4263 element = EL_SPACESHIP_DOWN;
4267 element = EL_SPACESHIP_LEFT;
4271 element = EL_SPACESHIP_RIGHT;
4275 element = EL_BUG_UP;
4279 element = EL_BUG_DOWN;
4283 element = EL_BUG_LEFT;
4287 element = EL_BUG_RIGHT;
4291 element = EL_MOLE_UP;
4295 element = EL_MOLE_DOWN;
4299 element = EL_MOLE_LEFT;
4303 element = EL_MOLE_RIGHT;
4311 element = EL_YAMYAM_UP;
4315 element = EL_SWITCHGATE_OPEN;
4319 element = EL_SWITCHGATE_CLOSED;
4323 element = EL_DC_SWITCHGATE_SWITCH_UP;
4327 element = EL_TIMEGATE_CLOSED;
4330 case 0x144c: // conveyor belt switch (green)
4331 element = EL_CONVEYOR_BELT_3_SWITCH_MIDDLE;
4334 case 0x144f: // conveyor belt switch (red)
4335 element = EL_CONVEYOR_BELT_1_SWITCH_MIDDLE;
4338 case 0x1452: // conveyor belt switch (blue)
4339 element = EL_CONVEYOR_BELT_4_SWITCH_MIDDLE;
4343 element = EL_CONVEYOR_BELT_3_MIDDLE;
4347 element = EL_CONVEYOR_BELT_3_LEFT;
4351 element = EL_CONVEYOR_BELT_3_RIGHT;
4355 element = EL_CONVEYOR_BELT_1_MIDDLE;
4359 element = EL_CONVEYOR_BELT_1_LEFT;
4363 element = EL_CONVEYOR_BELT_1_RIGHT;
4367 element = EL_CONVEYOR_BELT_4_MIDDLE;
4371 element = EL_CONVEYOR_BELT_4_LEFT;
4375 element = EL_CONVEYOR_BELT_4_RIGHT;
4379 element = EL_EXPANDABLE_WALL_HORIZONTAL;
4383 element = EL_EXPANDABLE_WALL_VERTICAL;
4387 element = EL_EXPANDABLE_WALL_ANY;
4390 case 0x14ce: // growing steel wall (left/right)
4391 element = EL_EXPANDABLE_STEELWALL_HORIZONTAL;
4394 case 0x14df: // growing steel wall (up/down)
4395 element = EL_EXPANDABLE_STEELWALL_VERTICAL;
4398 case 0x14e8: // growing steel wall (up/down/left/right)
4399 element = EL_EXPANDABLE_STEELWALL_ANY;
4403 element = EL_SHIELD_DEADLY;
4407 element = EL_EXTRA_TIME;
4415 element = EL_EMPTY_SPACE;
4418 case 0x1578: // quicksand (empty)
4419 element = EL_QUICKSAND_FAST_EMPTY;
4422 case 0x1579: // slow quicksand (empty)
4423 element = EL_QUICKSAND_EMPTY;
4433 element = EL_EM_DYNAMITE;
4436 case 0x15a1: // key (red)
4437 element = EL_EM_KEY_1;
4440 case 0x15a2: // key (yellow)
4441 element = EL_EM_KEY_2;
4444 case 0x15a3: // key (blue)
4445 element = EL_EM_KEY_4;
4448 case 0x15a4: // key (green)
4449 element = EL_EM_KEY_3;
4452 case 0x15a5: // key (white)
4453 element = EL_DC_KEY_WHITE;
4457 element = EL_WALL_SLIPPERY;
4464 case 0x15a8: // wall (not round)
4468 case 0x15a9: // (blue)
4469 element = EL_CHAR_A;
4472 case 0x15aa: // (blue)
4473 element = EL_CHAR_B;
4476 case 0x15ab: // (blue)
4477 element = EL_CHAR_C;
4480 case 0x15ac: // (blue)
4481 element = EL_CHAR_D;
4484 case 0x15ad: // (blue)
4485 element = EL_CHAR_E;
4488 case 0x15ae: // (blue)
4489 element = EL_CHAR_F;
4492 case 0x15af: // (blue)
4493 element = EL_CHAR_G;
4496 case 0x15b0: // (blue)
4497 element = EL_CHAR_H;
4500 case 0x15b1: // (blue)
4501 element = EL_CHAR_I;
4504 case 0x15b2: // (blue)
4505 element = EL_CHAR_J;
4508 case 0x15b3: // (blue)
4509 element = EL_CHAR_K;
4512 case 0x15b4: // (blue)
4513 element = EL_CHAR_L;
4516 case 0x15b5: // (blue)
4517 element = EL_CHAR_M;
4520 case 0x15b6: // (blue)
4521 element = EL_CHAR_N;
4524 case 0x15b7: // (blue)
4525 element = EL_CHAR_O;
4528 case 0x15b8: // (blue)
4529 element = EL_CHAR_P;
4532 case 0x15b9: // (blue)
4533 element = EL_CHAR_Q;
4536 case 0x15ba: // (blue)
4537 element = EL_CHAR_R;
4540 case 0x15bb: // (blue)
4541 element = EL_CHAR_S;
4544 case 0x15bc: // (blue)
4545 element = EL_CHAR_T;
4548 case 0x15bd: // (blue)
4549 element = EL_CHAR_U;
4552 case 0x15be: // (blue)
4553 element = EL_CHAR_V;
4556 case 0x15bf: // (blue)
4557 element = EL_CHAR_W;
4560 case 0x15c0: // (blue)
4561 element = EL_CHAR_X;
4564 case 0x15c1: // (blue)
4565 element = EL_CHAR_Y;
4568 case 0x15c2: // (blue)
4569 element = EL_CHAR_Z;
4572 case 0x15c3: // (blue)
4573 element = EL_CHAR_AUMLAUT;
4576 case 0x15c4: // (blue)
4577 element = EL_CHAR_OUMLAUT;
4580 case 0x15c5: // (blue)
4581 element = EL_CHAR_UUMLAUT;
4584 case 0x15c6: // (blue)
4585 element = EL_CHAR_0;
4588 case 0x15c7: // (blue)
4589 element = EL_CHAR_1;
4592 case 0x15c8: // (blue)
4593 element = EL_CHAR_2;
4596 case 0x15c9: // (blue)
4597 element = EL_CHAR_3;
4600 case 0x15ca: // (blue)
4601 element = EL_CHAR_4;
4604 case 0x15cb: // (blue)
4605 element = EL_CHAR_5;
4608 case 0x15cc: // (blue)
4609 element = EL_CHAR_6;
4612 case 0x15cd: // (blue)
4613 element = EL_CHAR_7;
4616 case 0x15ce: // (blue)
4617 element = EL_CHAR_8;
4620 case 0x15cf: // (blue)
4621 element = EL_CHAR_9;
4624 case 0x15d0: // (blue)
4625 element = EL_CHAR_PERIOD;
4628 case 0x15d1: // (blue)
4629 element = EL_CHAR_EXCLAM;
4632 case 0x15d2: // (blue)
4633 element = EL_CHAR_COLON;
4636 case 0x15d3: // (blue)
4637 element = EL_CHAR_LESS;
4640 case 0x15d4: // (blue)
4641 element = EL_CHAR_GREATER;
4644 case 0x15d5: // (blue)
4645 element = EL_CHAR_QUESTION;
4648 case 0x15d6: // (blue)
4649 element = EL_CHAR_COPYRIGHT;
4652 case 0x15d7: // (blue)
4653 element = EL_CHAR_UP;
4656 case 0x15d8: // (blue)
4657 element = EL_CHAR_DOWN;
4660 case 0x15d9: // (blue)
4661 element = EL_CHAR_BUTTON;
4664 case 0x15da: // (blue)
4665 element = EL_CHAR_PLUS;
4668 case 0x15db: // (blue)
4669 element = EL_CHAR_MINUS;
4672 case 0x15dc: // (blue)
4673 element = EL_CHAR_APOSTROPHE;
4676 case 0x15dd: // (blue)
4677 element = EL_CHAR_PARENLEFT;
4680 case 0x15de: // (blue)
4681 element = EL_CHAR_PARENRIGHT;
4684 case 0x15df: // (green)
4685 element = EL_CHAR_A;
4688 case 0x15e0: // (green)
4689 element = EL_CHAR_B;
4692 case 0x15e1: // (green)
4693 element = EL_CHAR_C;
4696 case 0x15e2: // (green)
4697 element = EL_CHAR_D;
4700 case 0x15e3: // (green)
4701 element = EL_CHAR_E;
4704 case 0x15e4: // (green)
4705 element = EL_CHAR_F;
4708 case 0x15e5: // (green)
4709 element = EL_CHAR_G;
4712 case 0x15e6: // (green)
4713 element = EL_CHAR_H;
4716 case 0x15e7: // (green)
4717 element = EL_CHAR_I;
4720 case 0x15e8: // (green)
4721 element = EL_CHAR_J;
4724 case 0x15e9: // (green)
4725 element = EL_CHAR_K;
4728 case 0x15ea: // (green)
4729 element = EL_CHAR_L;
4732 case 0x15eb: // (green)
4733 element = EL_CHAR_M;
4736 case 0x15ec: // (green)
4737 element = EL_CHAR_N;
4740 case 0x15ed: // (green)
4741 element = EL_CHAR_O;
4744 case 0x15ee: // (green)
4745 element = EL_CHAR_P;
4748 case 0x15ef: // (green)
4749 element = EL_CHAR_Q;
4752 case 0x15f0: // (green)
4753 element = EL_CHAR_R;
4756 case 0x15f1: // (green)
4757 element = EL_CHAR_S;
4760 case 0x15f2: // (green)
4761 element = EL_CHAR_T;
4764 case 0x15f3: // (green)
4765 element = EL_CHAR_U;
4768 case 0x15f4: // (green)
4769 element = EL_CHAR_V;
4772 case 0x15f5: // (green)
4773 element = EL_CHAR_W;
4776 case 0x15f6: // (green)
4777 element = EL_CHAR_X;
4780 case 0x15f7: // (green)
4781 element = EL_CHAR_Y;
4784 case 0x15f8: // (green)
4785 element = EL_CHAR_Z;
4788 case 0x15f9: // (green)
4789 element = EL_CHAR_AUMLAUT;
4792 case 0x15fa: // (green)
4793 element = EL_CHAR_OUMLAUT;
4796 case 0x15fb: // (green)
4797 element = EL_CHAR_UUMLAUT;
4800 case 0x15fc: // (green)
4801 element = EL_CHAR_0;
4804 case 0x15fd: // (green)
4805 element = EL_CHAR_1;
4808 case 0x15fe: // (green)
4809 element = EL_CHAR_2;
4812 case 0x15ff: // (green)
4813 element = EL_CHAR_3;
4816 case 0x1600: // (green)
4817 element = EL_CHAR_4;
4820 case 0x1601: // (green)
4821 element = EL_CHAR_5;
4824 case 0x1602: // (green)
4825 element = EL_CHAR_6;
4828 case 0x1603: // (green)
4829 element = EL_CHAR_7;
4832 case 0x1604: // (green)
4833 element = EL_CHAR_8;
4836 case 0x1605: // (green)
4837 element = EL_CHAR_9;
4840 case 0x1606: // (green)
4841 element = EL_CHAR_PERIOD;
4844 case 0x1607: // (green)
4845 element = EL_CHAR_EXCLAM;
4848 case 0x1608: // (green)
4849 element = EL_CHAR_COLON;
4852 case 0x1609: // (green)
4853 element = EL_CHAR_LESS;
4856 case 0x160a: // (green)
4857 element = EL_CHAR_GREATER;
4860 case 0x160b: // (green)
4861 element = EL_CHAR_QUESTION;
4864 case 0x160c: // (green)
4865 element = EL_CHAR_COPYRIGHT;
4868 case 0x160d: // (green)
4869 element = EL_CHAR_UP;
4872 case 0x160e: // (green)
4873 element = EL_CHAR_DOWN;
4876 case 0x160f: // (green)
4877 element = EL_CHAR_BUTTON;
4880 case 0x1610: // (green)
4881 element = EL_CHAR_PLUS;
4884 case 0x1611: // (green)
4885 element = EL_CHAR_MINUS;
4888 case 0x1612: // (green)
4889 element = EL_CHAR_APOSTROPHE;
4892 case 0x1613: // (green)
4893 element = EL_CHAR_PARENLEFT;
4896 case 0x1614: // (green)
4897 element = EL_CHAR_PARENRIGHT;
4900 case 0x1615: // (blue steel)
4901 element = EL_STEEL_CHAR_A;
4904 case 0x1616: // (blue steel)
4905 element = EL_STEEL_CHAR_B;
4908 case 0x1617: // (blue steel)
4909 element = EL_STEEL_CHAR_C;
4912 case 0x1618: // (blue steel)
4913 element = EL_STEEL_CHAR_D;
4916 case 0x1619: // (blue steel)
4917 element = EL_STEEL_CHAR_E;
4920 case 0x161a: // (blue steel)
4921 element = EL_STEEL_CHAR_F;
4924 case 0x161b: // (blue steel)
4925 element = EL_STEEL_CHAR_G;
4928 case 0x161c: // (blue steel)
4929 element = EL_STEEL_CHAR_H;
4932 case 0x161d: // (blue steel)
4933 element = EL_STEEL_CHAR_I;
4936 case 0x161e: // (blue steel)
4937 element = EL_STEEL_CHAR_J;
4940 case 0x161f: // (blue steel)
4941 element = EL_STEEL_CHAR_K;
4944 case 0x1620: // (blue steel)
4945 element = EL_STEEL_CHAR_L;
4948 case 0x1621: // (blue steel)
4949 element = EL_STEEL_CHAR_M;
4952 case 0x1622: // (blue steel)
4953 element = EL_STEEL_CHAR_N;
4956 case 0x1623: // (blue steel)
4957 element = EL_STEEL_CHAR_O;
4960 case 0x1624: // (blue steel)
4961 element = EL_STEEL_CHAR_P;
4964 case 0x1625: // (blue steel)
4965 element = EL_STEEL_CHAR_Q;
4968 case 0x1626: // (blue steel)
4969 element = EL_STEEL_CHAR_R;
4972 case 0x1627: // (blue steel)
4973 element = EL_STEEL_CHAR_S;
4976 case 0x1628: // (blue steel)
4977 element = EL_STEEL_CHAR_T;
4980 case 0x1629: // (blue steel)
4981 element = EL_STEEL_CHAR_U;
4984 case 0x162a: // (blue steel)
4985 element = EL_STEEL_CHAR_V;
4988 case 0x162b: // (blue steel)
4989 element = EL_STEEL_CHAR_W;
4992 case 0x162c: // (blue steel)
4993 element = EL_STEEL_CHAR_X;
4996 case 0x162d: // (blue steel)
4997 element = EL_STEEL_CHAR_Y;
5000 case 0x162e: // (blue steel)
5001 element = EL_STEEL_CHAR_Z;
5004 case 0x162f: // (blue steel)
5005 element = EL_STEEL_CHAR_AUMLAUT;
5008 case 0x1630: // (blue steel)
5009 element = EL_STEEL_CHAR_OUMLAUT;
5012 case 0x1631: // (blue steel)
5013 element = EL_STEEL_CHAR_UUMLAUT;
5016 case 0x1632: // (blue steel)
5017 element = EL_STEEL_CHAR_0;
5020 case 0x1633: // (blue steel)
5021 element = EL_STEEL_CHAR_1;
5024 case 0x1634: // (blue steel)
5025 element = EL_STEEL_CHAR_2;
5028 case 0x1635: // (blue steel)
5029 element = EL_STEEL_CHAR_3;
5032 case 0x1636: // (blue steel)
5033 element = EL_STEEL_CHAR_4;
5036 case 0x1637: // (blue steel)
5037 element = EL_STEEL_CHAR_5;
5040 case 0x1638: // (blue steel)
5041 element = EL_STEEL_CHAR_6;
5044 case 0x1639: // (blue steel)
5045 element = EL_STEEL_CHAR_7;
5048 case 0x163a: // (blue steel)
5049 element = EL_STEEL_CHAR_8;
5052 case 0x163b: // (blue steel)
5053 element = EL_STEEL_CHAR_9;
5056 case 0x163c: // (blue steel)
5057 element = EL_STEEL_CHAR_PERIOD;
5060 case 0x163d: // (blue steel)
5061 element = EL_STEEL_CHAR_EXCLAM;
5064 case 0x163e: // (blue steel)
5065 element = EL_STEEL_CHAR_COLON;
5068 case 0x163f: // (blue steel)
5069 element = EL_STEEL_CHAR_LESS;
5072 case 0x1640: // (blue steel)
5073 element = EL_STEEL_CHAR_GREATER;
5076 case 0x1641: // (blue steel)
5077 element = EL_STEEL_CHAR_QUESTION;
5080 case 0x1642: // (blue steel)
5081 element = EL_STEEL_CHAR_COPYRIGHT;
5084 case 0x1643: // (blue steel)
5085 element = EL_STEEL_CHAR_UP;
5088 case 0x1644: // (blue steel)
5089 element = EL_STEEL_CHAR_DOWN;
5092 case 0x1645: // (blue steel)
5093 element = EL_STEEL_CHAR_BUTTON;
5096 case 0x1646: // (blue steel)
5097 element = EL_STEEL_CHAR_PLUS;
5100 case 0x1647: // (blue steel)
5101 element = EL_STEEL_CHAR_MINUS;
5104 case 0x1648: // (blue steel)
5105 element = EL_STEEL_CHAR_APOSTROPHE;
5108 case 0x1649: // (blue steel)
5109 element = EL_STEEL_CHAR_PARENLEFT;
5112 case 0x164a: // (blue steel)
5113 element = EL_STEEL_CHAR_PARENRIGHT;
5116 case 0x164b: // (green steel)
5117 element = EL_STEEL_CHAR_A;
5120 case 0x164c: // (green steel)
5121 element = EL_STEEL_CHAR_B;
5124 case 0x164d: // (green steel)
5125 element = EL_STEEL_CHAR_C;
5128 case 0x164e: // (green steel)
5129 element = EL_STEEL_CHAR_D;
5132 case 0x164f: // (green steel)
5133 element = EL_STEEL_CHAR_E;
5136 case 0x1650: // (green steel)
5137 element = EL_STEEL_CHAR_F;
5140 case 0x1651: // (green steel)
5141 element = EL_STEEL_CHAR_G;
5144 case 0x1652: // (green steel)
5145 element = EL_STEEL_CHAR_H;
5148 case 0x1653: // (green steel)
5149 element = EL_STEEL_CHAR_I;
5152 case 0x1654: // (green steel)
5153 element = EL_STEEL_CHAR_J;
5156 case 0x1655: // (green steel)
5157 element = EL_STEEL_CHAR_K;
5160 case 0x1656: // (green steel)
5161 element = EL_STEEL_CHAR_L;
5164 case 0x1657: // (green steel)
5165 element = EL_STEEL_CHAR_M;
5168 case 0x1658: // (green steel)
5169 element = EL_STEEL_CHAR_N;
5172 case 0x1659: // (green steel)
5173 element = EL_STEEL_CHAR_O;
5176 case 0x165a: // (green steel)
5177 element = EL_STEEL_CHAR_P;
5180 case 0x165b: // (green steel)
5181 element = EL_STEEL_CHAR_Q;
5184 case 0x165c: // (green steel)
5185 element = EL_STEEL_CHAR_R;
5188 case 0x165d: // (green steel)
5189 element = EL_STEEL_CHAR_S;
5192 case 0x165e: // (green steel)
5193 element = EL_STEEL_CHAR_T;
5196 case 0x165f: // (green steel)
5197 element = EL_STEEL_CHAR_U;
5200 case 0x1660: // (green steel)
5201 element = EL_STEEL_CHAR_V;
5204 case 0x1661: // (green steel)
5205 element = EL_STEEL_CHAR_W;
5208 case 0x1662: // (green steel)
5209 element = EL_STEEL_CHAR_X;
5212 case 0x1663: // (green steel)
5213 element = EL_STEEL_CHAR_Y;
5216 case 0x1664: // (green steel)
5217 element = EL_STEEL_CHAR_Z;
5220 case 0x1665: // (green steel)
5221 element = EL_STEEL_CHAR_AUMLAUT;
5224 case 0x1666: // (green steel)
5225 element = EL_STEEL_CHAR_OUMLAUT;
5228 case 0x1667: // (green steel)
5229 element = EL_STEEL_CHAR_UUMLAUT;
5232 case 0x1668: // (green steel)
5233 element = EL_STEEL_CHAR_0;
5236 case 0x1669: // (green steel)
5237 element = EL_STEEL_CHAR_1;
5240 case 0x166a: // (green steel)
5241 element = EL_STEEL_CHAR_2;
5244 case 0x166b: // (green steel)
5245 element = EL_STEEL_CHAR_3;
5248 case 0x166c: // (green steel)
5249 element = EL_STEEL_CHAR_4;
5252 case 0x166d: // (green steel)
5253 element = EL_STEEL_CHAR_5;
5256 case 0x166e: // (green steel)
5257 element = EL_STEEL_CHAR_6;
5260 case 0x166f: // (green steel)
5261 element = EL_STEEL_CHAR_7;
5264 case 0x1670: // (green steel)
5265 element = EL_STEEL_CHAR_8;
5268 case 0x1671: // (green steel)
5269 element = EL_STEEL_CHAR_9;
5272 case 0x1672: // (green steel)
5273 element = EL_STEEL_CHAR_PERIOD;
5276 case 0x1673: // (green steel)
5277 element = EL_STEEL_CHAR_EXCLAM;
5280 case 0x1674: // (green steel)
5281 element = EL_STEEL_CHAR_COLON;
5284 case 0x1675: // (green steel)
5285 element = EL_STEEL_CHAR_LESS;
5288 case 0x1676: // (green steel)
5289 element = EL_STEEL_CHAR_GREATER;
5292 case 0x1677: // (green steel)
5293 element = EL_STEEL_CHAR_QUESTION;
5296 case 0x1678: // (green steel)
5297 element = EL_STEEL_CHAR_COPYRIGHT;
5300 case 0x1679: // (green steel)
5301 element = EL_STEEL_CHAR_UP;
5304 case 0x167a: // (green steel)
5305 element = EL_STEEL_CHAR_DOWN;
5308 case 0x167b: // (green steel)
5309 element = EL_STEEL_CHAR_BUTTON;
5312 case 0x167c: // (green steel)
5313 element = EL_STEEL_CHAR_PLUS;
5316 case 0x167d: // (green steel)
5317 element = EL_STEEL_CHAR_MINUS;
5320 case 0x167e: // (green steel)
5321 element = EL_STEEL_CHAR_APOSTROPHE;
5324 case 0x167f: // (green steel)
5325 element = EL_STEEL_CHAR_PARENLEFT;
5328 case 0x1680: // (green steel)
5329 element = EL_STEEL_CHAR_PARENRIGHT;
5332 case 0x1681: // gate (red)
5333 element = EL_EM_GATE_1;
5336 case 0x1682: // secret gate (red)
5337 element = EL_EM_GATE_1_GRAY;
5340 case 0x1683: // gate (yellow)
5341 element = EL_EM_GATE_2;
5344 case 0x1684: // secret gate (yellow)
5345 element = EL_EM_GATE_2_GRAY;
5348 case 0x1685: // gate (blue)
5349 element = EL_EM_GATE_4;
5352 case 0x1686: // secret gate (blue)
5353 element = EL_EM_GATE_4_GRAY;
5356 case 0x1687: // gate (green)
5357 element = EL_EM_GATE_3;
5360 case 0x1688: // secret gate (green)
5361 element = EL_EM_GATE_3_GRAY;
5364 case 0x1689: // gate (white)
5365 element = EL_DC_GATE_WHITE;
5368 case 0x168a: // secret gate (white)
5369 element = EL_DC_GATE_WHITE_GRAY;
5372 case 0x168b: // secret gate (no key)
5373 element = EL_DC_GATE_FAKE_GRAY;
5377 element = EL_ROBOT_WHEEL;
5381 element = EL_DC_TIMEGATE_SWITCH;
5385 element = EL_ACID_POOL_BOTTOM;
5389 element = EL_ACID_POOL_TOPLEFT;
5393 element = EL_ACID_POOL_TOPRIGHT;
5397 element = EL_ACID_POOL_BOTTOMLEFT;
5401 element = EL_ACID_POOL_BOTTOMRIGHT;
5405 element = EL_STEELWALL;
5409 element = EL_STEELWALL_SLIPPERY;
5412 case 0x1695: // steel wall (not round)
5413 element = EL_STEELWALL;
5416 case 0x1696: // steel wall (left)
5417 element = EL_DC_STEELWALL_1_LEFT;
5420 case 0x1697: // steel wall (bottom)
5421 element = EL_DC_STEELWALL_1_BOTTOM;
5424 case 0x1698: // steel wall (right)
5425 element = EL_DC_STEELWALL_1_RIGHT;
5428 case 0x1699: // steel wall (top)
5429 element = EL_DC_STEELWALL_1_TOP;
5432 case 0x169a: // steel wall (left/bottom)
5433 element = EL_DC_STEELWALL_1_BOTTOMLEFT;
5436 case 0x169b: // steel wall (right/bottom)
5437 element = EL_DC_STEELWALL_1_BOTTOMRIGHT;
5440 case 0x169c: // steel wall (right/top)
5441 element = EL_DC_STEELWALL_1_TOPRIGHT;
5444 case 0x169d: // steel wall (left/top)
5445 element = EL_DC_STEELWALL_1_TOPLEFT;
5448 case 0x169e: // steel wall (right/bottom small)
5449 element = EL_DC_STEELWALL_1_BOTTOMRIGHT_2;
5452 case 0x169f: // steel wall (left/bottom small)
5453 element = EL_DC_STEELWALL_1_BOTTOMLEFT_2;
5456 case 0x16a0: // steel wall (right/top small)
5457 element = EL_DC_STEELWALL_1_TOPRIGHT_2;
5460 case 0x16a1: // steel wall (left/top small)
5461 element = EL_DC_STEELWALL_1_TOPLEFT_2;
5464 case 0x16a2: // steel wall (left/right)
5465 element = EL_DC_STEELWALL_1_VERTICAL;
5468 case 0x16a3: // steel wall (top/bottom)
5469 element = EL_DC_STEELWALL_1_HORIZONTAL;
5472 case 0x16a4: // steel wall 2 (left end)
5473 element = EL_DC_STEELWALL_2_LEFT;
5476 case 0x16a5: // steel wall 2 (right end)
5477 element = EL_DC_STEELWALL_2_RIGHT;
5480 case 0x16a6: // steel wall 2 (top end)
5481 element = EL_DC_STEELWALL_2_TOP;
5484 case 0x16a7: // steel wall 2 (bottom end)
5485 element = EL_DC_STEELWALL_2_BOTTOM;
5488 case 0x16a8: // steel wall 2 (left/right)
5489 element = EL_DC_STEELWALL_2_HORIZONTAL;
5492 case 0x16a9: // steel wall 2 (up/down)
5493 element = EL_DC_STEELWALL_2_VERTICAL;
5496 case 0x16aa: // steel wall 2 (mid)
5497 element = EL_DC_STEELWALL_2_MIDDLE;
5501 element = EL_SIGN_EXCLAMATION;
5505 element = EL_SIGN_RADIOACTIVITY;
5509 element = EL_SIGN_STOP;
5513 element = EL_SIGN_WHEELCHAIR;
5517 element = EL_SIGN_PARKING;
5521 element = EL_SIGN_NO_ENTRY;
5525 element = EL_SIGN_HEART;
5529 element = EL_SIGN_GIVE_WAY;
5533 element = EL_SIGN_ENTRY_FORBIDDEN;
5537 element = EL_SIGN_EMERGENCY_EXIT;
5541 element = EL_SIGN_YIN_YANG;
5545 element = EL_WALL_EMERALD;
5549 element = EL_WALL_DIAMOND;
5553 element = EL_WALL_PEARL;
5557 element = EL_WALL_CRYSTAL;
5561 element = EL_INVISIBLE_WALL;
5565 element = EL_INVISIBLE_STEELWALL;
5569 // EL_INVISIBLE_SAND
5572 element = EL_LIGHT_SWITCH;
5576 element = EL_ENVELOPE_1;
5580 if (element >= 0x0117 && element <= 0x036e) // (?)
5581 element = EL_DIAMOND;
5582 else if (element >= 0x042d && element <= 0x0684) // (?)
5583 element = EL_EMERALD;
5584 else if (element >= 0x157c && element <= 0x158b)
5586 else if (element >= 0x1590 && element <= 0x159f)
5587 element = EL_DC_LANDMINE;
5588 else if (element >= 0x16bc && element <= 0x16cb)
5589 element = EL_INVISIBLE_SAND;
5592 Warn("unknown Diamond Caves element 0x%04x", element);
5594 element = EL_UNKNOWN;
5599 return getMappedElement(element);
5602 static void LoadLevelFromFileStream_DC(File *file, struct LevelInfo *level,
5605 byte header[DC_LEVEL_HEADER_SIZE];
5607 int envelope_header_pos = 62;
5608 int envelope_content_pos = 94;
5609 int level_name_pos = 251;
5610 int level_author_pos = 292;
5611 int envelope_header_len;
5612 int envelope_content_len;
5614 int level_author_len;
5616 int num_yamyam_contents;
5619 getDecodedWord_DC(0, TRUE); // initialize DC2 decoding engine
5621 for (i = 0; i < DC_LEVEL_HEADER_SIZE / 2; i++)
5623 unsigned short header_word = getDecodedWord_DC(getFile16BitBE(file), FALSE);
5625 header[i * 2 + 0] = header_word >> 8;
5626 header[i * 2 + 1] = header_word & 0xff;
5629 // read some values from level header to check level decoding integrity
5630 fieldx = header[6] | (header[7] << 8);
5631 fieldy = header[8] | (header[9] << 8);
5632 num_yamyam_contents = header[60] | (header[61] << 8);
5634 // do some simple sanity checks to ensure that level was correctly decoded
5635 if (fieldx < 1 || fieldx > 256 ||
5636 fieldy < 1 || fieldy > 256 ||
5637 num_yamyam_contents < 1 || num_yamyam_contents > 8)
5639 level->no_valid_file = TRUE;
5641 Warn("cannot decode level from stream -- using empty level");
5646 // maximum envelope header size is 31 bytes
5647 envelope_header_len = header[envelope_header_pos];
5648 // maximum envelope content size is 110 (156?) bytes
5649 envelope_content_len = header[envelope_content_pos];
5651 // maximum level title size is 40 bytes
5652 level_name_len = MIN(header[level_name_pos], MAX_LEVEL_NAME_LEN);
5653 // maximum level author size is 30 (51?) bytes
5654 level_author_len = MIN(header[level_author_pos], MAX_LEVEL_AUTHOR_LEN);
5658 for (i = 0; i < envelope_header_len; i++)
5659 if (envelope_size < MAX_ENVELOPE_TEXT_LEN)
5660 level->envelope[0].text[envelope_size++] =
5661 header[envelope_header_pos + 1 + i];
5663 if (envelope_header_len > 0 && envelope_content_len > 0)
5665 if (envelope_size < MAX_ENVELOPE_TEXT_LEN)
5666 level->envelope[0].text[envelope_size++] = '\n';
5667 if (envelope_size < MAX_ENVELOPE_TEXT_LEN)
5668 level->envelope[0].text[envelope_size++] = '\n';
5671 for (i = 0; i < envelope_content_len; i++)
5672 if (envelope_size < MAX_ENVELOPE_TEXT_LEN)
5673 level->envelope[0].text[envelope_size++] =
5674 header[envelope_content_pos + 1 + i];
5676 level->envelope[0].text[envelope_size] = '\0';
5678 level->envelope[0].xsize = MAX_ENVELOPE_XSIZE;
5679 level->envelope[0].ysize = 10;
5680 level->envelope[0].autowrap = TRUE;
5681 level->envelope[0].centered = TRUE;
5683 for (i = 0; i < level_name_len; i++)
5684 level->name[i] = header[level_name_pos + 1 + i];
5685 level->name[level_name_len] = '\0';
5687 for (i = 0; i < level_author_len; i++)
5688 level->author[i] = header[level_author_pos + 1 + i];
5689 level->author[level_author_len] = '\0';
5691 num_yamyam_contents = header[60] | (header[61] << 8);
5692 level->num_yamyam_contents =
5693 MIN(MAX(MIN_ELEMENT_CONTENTS, num_yamyam_contents), MAX_ELEMENT_CONTENTS);
5695 for (i = 0; i < num_yamyam_contents; i++)
5697 for (y = 0; y < 3; y++) for (x = 0; x < 3; x++)
5699 unsigned short word = getDecodedWord_DC(getFile16BitBE(file), FALSE);
5700 int element_dc = ((word & 0xff) << 8) | ((word >> 8) & 0xff);
5702 if (i < MAX_ELEMENT_CONTENTS)
5703 level->yamyam_content[i].e[x][y] = getMappedElement_DC(element_dc);
5707 fieldx = header[6] | (header[7] << 8);
5708 fieldy = header[8] | (header[9] << 8);
5709 level->fieldx = MIN(MAX(MIN_LEV_FIELDX, fieldx), MAX_LEV_FIELDX);
5710 level->fieldy = MIN(MAX(MIN_LEV_FIELDY, fieldy), MAX_LEV_FIELDY);
5712 for (y = 0; y < fieldy; y++) for (x = 0; x < fieldx; x++)
5714 unsigned short word = getDecodedWord_DC(getFile16BitBE(file), FALSE);
5715 int element_dc = ((word & 0xff) << 8) | ((word >> 8) & 0xff);
5717 if (x < MAX_LEV_FIELDX && y < MAX_LEV_FIELDY)
5718 level->field[x][y] = getMappedElement_DC(element_dc);
5721 x = MIN(MAX(0, (header[10] | (header[11] << 8)) - 1), MAX_LEV_FIELDX - 1);
5722 y = MIN(MAX(0, (header[12] | (header[13] << 8)) - 1), MAX_LEV_FIELDY - 1);
5723 level->field[x][y] = EL_PLAYER_1;
5725 x = MIN(MAX(0, (header[14] | (header[15] << 8)) - 1), MAX_LEV_FIELDX - 1);
5726 y = MIN(MAX(0, (header[16] | (header[17] << 8)) - 1), MAX_LEV_FIELDY - 1);
5727 level->field[x][y] = EL_PLAYER_2;
5729 level->gems_needed = header[18] | (header[19] << 8);
5731 level->score[SC_EMERALD] = header[20] | (header[21] << 8);
5732 level->score[SC_DIAMOND] = header[22] | (header[23] << 8);
5733 level->score[SC_PEARL] = header[24] | (header[25] << 8);
5734 level->score[SC_CRYSTAL] = header[26] | (header[27] << 8);
5735 level->score[SC_NUT] = header[28] | (header[29] << 8);
5736 level->score[SC_ROBOT] = header[30] | (header[31] << 8);
5737 level->score[SC_SPACESHIP] = header[32] | (header[33] << 8);
5738 level->score[SC_BUG] = header[34] | (header[35] << 8);
5739 level->score[SC_YAMYAM] = header[36] | (header[37] << 8);
5740 level->score[SC_DYNAMITE] = header[38] | (header[39] << 8);
5741 level->score[SC_KEY] = header[40] | (header[41] << 8);
5742 level->score[SC_TIME_BONUS] = header[42] | (header[43] << 8);
5744 level->time = header[44] | (header[45] << 8);
5746 level->amoeba_speed = header[46] | (header[47] << 8);
5747 level->time_light = header[48] | (header[49] << 8);
5748 level->time_timegate = header[50] | (header[51] << 8);
5749 level->time_wheel = header[52] | (header[53] << 8);
5750 level->time_magic_wall = header[54] | (header[55] << 8);
5751 level->extra_time = header[56] | (header[57] << 8);
5752 level->shield_normal_time = header[58] | (header[59] << 8);
5754 // shield and extra time elements do not have a score
5755 level->score[SC_SHIELD] = 0;
5756 level->extra_time_score = 0;
5758 // set time for normal and deadly shields to the same value
5759 level->shield_deadly_time = level->shield_normal_time;
5761 // Diamond Caves has the same (strange) behaviour as Emerald Mine that gems
5762 // can slip down from flat walls, like normal walls and steel walls
5763 level->em_slippery_gems = TRUE;
5765 // time score is counted for each 10 seconds left in Diamond Caves levels
5766 level->time_score_base = 10;
5769 static void LoadLevelFromFileInfo_DC(struct LevelInfo *level,
5770 struct LevelFileInfo *level_file_info,
5771 boolean level_info_only)
5773 char *filename = level_file_info->filename;
5775 int num_magic_bytes = 8;
5776 char magic_bytes[num_magic_bytes + 1];
5777 int num_levels_to_skip = level_file_info->nr - leveldir_current->first_level;
5779 if (!(file = openFile(filename, MODE_READ)))
5781 level->no_valid_file = TRUE;
5783 if (!level_info_only)
5784 Warn("cannot read level '%s' -- using empty level", filename);
5789 // fseek(file, 0x0000, SEEK_SET);
5791 if (level_file_info->packed)
5793 // read "magic bytes" from start of file
5794 if (getStringFromFile(file, magic_bytes, num_magic_bytes + 1) == NULL)
5795 magic_bytes[0] = '\0';
5797 // check "magic bytes" for correct file format
5798 if (!strPrefix(magic_bytes, "DC2"))
5800 level->no_valid_file = TRUE;
5802 Warn("unknown DC level file '%s' -- using empty level", filename);
5807 if (strPrefix(magic_bytes, "DC2Win95") ||
5808 strPrefix(magic_bytes, "DC2Win98"))
5810 int position_first_level = 0x00fa;
5811 int extra_bytes = 4;
5814 // advance file stream to first level inside the level package
5815 skip_bytes = position_first_level - num_magic_bytes - extra_bytes;
5817 // each block of level data is followed by block of non-level data
5818 num_levels_to_skip *= 2;
5820 // at least skip header bytes, therefore use ">= 0" instead of "> 0"
5821 while (num_levels_to_skip >= 0)
5823 // advance file stream to next level inside the level package
5824 if (seekFile(file, skip_bytes, SEEK_CUR) != 0)
5826 level->no_valid_file = TRUE;
5828 Warn("cannot fseek in file '%s' -- using empty level", filename);
5833 // skip apparently unused extra bytes following each level
5834 ReadUnusedBytesFromFile(file, extra_bytes);
5836 // read size of next level in level package
5837 skip_bytes = getFile32BitLE(file);
5839 num_levels_to_skip--;
5844 level->no_valid_file = TRUE;
5846 Warn("unknown DC2 level file '%s' -- using empty level", filename);
5852 LoadLevelFromFileStream_DC(file, level, level_file_info->nr);
5858 // ----------------------------------------------------------------------------
5859 // functions for loading SB level
5860 // ----------------------------------------------------------------------------
5862 int getMappedElement_SB(int element_ascii, boolean use_ces)
5870 sb_element_mapping[] =
5872 { ' ', EL_EMPTY, EL_CUSTOM_1 }, // floor (space)
5873 { '#', EL_STEELWALL, EL_CUSTOM_2 }, // wall
5874 { '@', EL_PLAYER_1, EL_CUSTOM_3 }, // player
5875 { '$', EL_SOKOBAN_OBJECT, EL_CUSTOM_4 }, // box
5876 { '.', EL_SOKOBAN_FIELD_EMPTY, EL_CUSTOM_5 }, // goal square
5877 { '*', EL_SOKOBAN_FIELD_FULL, EL_CUSTOM_6 }, // box on goal square
5878 { '+', EL_SOKOBAN_FIELD_PLAYER, EL_CUSTOM_7 }, // player on goal square
5879 { '_', EL_INVISIBLE_STEELWALL, EL_FROM_LEVEL_TEMPLATE }, // floor beyond border
5886 for (i = 0; sb_element_mapping[i].ascii != 0; i++)
5887 if (element_ascii == sb_element_mapping[i].ascii)
5888 return (use_ces ? sb_element_mapping[i].ce : sb_element_mapping[i].sb);
5890 return EL_UNDEFINED;
5893 static void LoadLevelFromFileInfo_SB(struct LevelInfo *level,
5894 struct LevelFileInfo *level_file_info,
5895 boolean level_info_only)
5897 char *filename = level_file_info->filename;
5898 char line[MAX_LINE_LEN], line_raw[MAX_LINE_LEN], previous_line[MAX_LINE_LEN];
5899 char last_comment[MAX_LINE_LEN];
5900 char level_name[MAX_LINE_LEN];
5903 int num_levels_to_skip = level_file_info->nr - leveldir_current->first_level;
5904 boolean read_continued_line = FALSE;
5905 boolean reading_playfield = FALSE;
5906 boolean got_valid_playfield_line = FALSE;
5907 boolean invalid_playfield_char = FALSE;
5908 boolean load_xsb_to_ces = check_special_flags("load_xsb_to_ces");
5909 int file_level_nr = 0;
5911 int x = 0, y = 0; // initialized to make compilers happy
5913 last_comment[0] = '\0';
5914 level_name[0] = '\0';
5916 if (!(file = openFile(filename, MODE_READ)))
5918 level->no_valid_file = TRUE;
5920 if (!level_info_only)
5921 Warn("cannot read level '%s' -- using empty level", filename);
5926 while (!checkEndOfFile(file))
5928 // level successfully read, but next level may follow here
5929 if (!got_valid_playfield_line && reading_playfield)
5931 // read playfield from single level file -- skip remaining file
5932 if (!level_file_info->packed)
5935 if (file_level_nr >= num_levels_to_skip)
5940 last_comment[0] = '\0';
5941 level_name[0] = '\0';
5943 reading_playfield = FALSE;
5946 got_valid_playfield_line = FALSE;
5948 // read next line of input file
5949 if (!getStringFromFile(file, line, MAX_LINE_LEN))
5952 // check if line was completely read and is terminated by line break
5953 if (strlen(line) > 0 && line[strlen(line) - 1] == '\n')
5956 // cut trailing line break (this can be newline and/or carriage return)
5957 for (line_ptr = &line[strlen(line)]; line_ptr >= line; line_ptr--)
5958 if ((*line_ptr == '\n' || *line_ptr == '\r') && *(line_ptr + 1) == '\0')
5961 // copy raw input line for later use (mainly debugging output)
5962 strcpy(line_raw, line);
5964 if (read_continued_line)
5966 // append new line to existing line, if there is enough space
5967 if (strlen(previous_line) + strlen(line_ptr) < MAX_LINE_LEN)
5968 strcat(previous_line, line_ptr);
5970 strcpy(line, previous_line); // copy storage buffer to line
5972 read_continued_line = FALSE;
5975 // if the last character is '\', continue at next line
5976 if (strlen(line) > 0 && line[strlen(line) - 1] == '\\')
5978 line[strlen(line) - 1] = '\0'; // cut off trailing backslash
5979 strcpy(previous_line, line); // copy line to storage buffer
5981 read_continued_line = TRUE;
5987 if (line[0] == '\0')
5990 // extract comment text from comment line
5993 for (line_ptr = line; *line_ptr; line_ptr++)
5994 if (*line_ptr != ' ' && *line_ptr != '\t' && *line_ptr != ';')
5997 strcpy(last_comment, line_ptr);
6002 // extract level title text from line containing level title
6003 if (line[0] == '\'')
6005 strcpy(level_name, &line[1]);
6007 if (strlen(level_name) > 0 && level_name[strlen(level_name) - 1] == '\'')
6008 level_name[strlen(level_name) - 1] = '\0';
6013 // skip lines containing only spaces (or empty lines)
6014 for (line_ptr = line; *line_ptr; line_ptr++)
6015 if (*line_ptr != ' ')
6017 if (*line_ptr == '\0')
6020 // at this point, we have found a line containing part of a playfield
6022 got_valid_playfield_line = TRUE;
6024 if (!reading_playfield)
6026 reading_playfield = TRUE;
6027 invalid_playfield_char = FALSE;
6029 for (x = 0; x < MAX_LEV_FIELDX; x++)
6030 for (y = 0; y < MAX_LEV_FIELDY; y++)
6031 level->field[x][y] = getMappedElement_SB(' ', load_xsb_to_ces);
6036 // start with topmost tile row
6040 // skip playfield line if larger row than allowed
6041 if (y >= MAX_LEV_FIELDY)
6044 // start with leftmost tile column
6047 // read playfield elements from line
6048 for (line_ptr = line; *line_ptr; line_ptr++)
6050 int mapped_sb_element = getMappedElement_SB(*line_ptr, load_xsb_to_ces);
6052 // stop parsing playfield line if larger column than allowed
6053 if (x >= MAX_LEV_FIELDX)
6056 if (mapped_sb_element == EL_UNDEFINED)
6058 invalid_playfield_char = TRUE;
6063 level->field[x][y] = mapped_sb_element;
6065 // continue with next tile column
6068 level->fieldx = MAX(x, level->fieldx);
6071 if (invalid_playfield_char)
6073 // if first playfield line, treat invalid lines as comment lines
6075 reading_playfield = FALSE;
6080 // continue with next tile row
6088 level->fieldx = MIN(MAX(MIN_LEV_FIELDX, level->fieldx), MAX_LEV_FIELDX);
6089 level->fieldy = MIN(MAX(MIN_LEV_FIELDY, level->fieldy), MAX_LEV_FIELDY);
6091 if (!reading_playfield)
6093 level->no_valid_file = TRUE;
6095 Warn("cannot read level '%s' -- using empty level", filename);
6100 if (*level_name != '\0')
6102 strncpy(level->name, level_name, MAX_LEVEL_NAME_LEN);
6103 level->name[MAX_LEVEL_NAME_LEN] = '\0';
6105 else if (*last_comment != '\0')
6107 strncpy(level->name, last_comment, MAX_LEVEL_NAME_LEN);
6108 level->name[MAX_LEVEL_NAME_LEN] = '\0';
6112 sprintf(level->name, "--> Level %d <--", level_file_info->nr);
6115 // set all empty fields beyond the border walls to invisible steel wall
6116 for (y = 0; y < level->fieldy; y++) for (x = 0; x < level->fieldx; x++)
6118 if ((x == 0 || x == level->fieldx - 1 ||
6119 y == 0 || y == level->fieldy - 1) &&
6120 level->field[x][y] == getMappedElement_SB(' ', load_xsb_to_ces))
6121 FloodFillLevel(x, y, getMappedElement_SB('_', load_xsb_to_ces),
6122 level->field, level->fieldx, level->fieldy);
6125 // set special level settings for Sokoban levels
6128 level->use_step_counter = TRUE;
6130 if (load_xsb_to_ces)
6132 // special global settings can now be set in level template
6134 level->use_custom_template = TRUE;
6139 // -------------------------------------------------------------------------
6140 // functions for handling native levels
6141 // -------------------------------------------------------------------------
6143 static void LoadLevelFromFileInfo_EM(struct LevelInfo *level,
6144 struct LevelFileInfo *level_file_info,
6145 boolean level_info_only)
6147 if (!LoadNativeLevel_EM(level_file_info->filename, level_info_only))
6148 level->no_valid_file = TRUE;
6151 static void LoadLevelFromFileInfo_SP(struct LevelInfo *level,
6152 struct LevelFileInfo *level_file_info,
6153 boolean level_info_only)
6157 // determine position of requested level inside level package
6158 if (level_file_info->packed)
6159 pos = level_file_info->nr - leveldir_current->first_level;
6161 if (!LoadNativeLevel_SP(level_file_info->filename, pos, level_info_only))
6162 level->no_valid_file = TRUE;
6165 static void LoadLevelFromFileInfo_MM(struct LevelInfo *level,
6166 struct LevelFileInfo *level_file_info,
6167 boolean level_info_only)
6169 if (!LoadNativeLevel_MM(level_file_info->filename, level_info_only))
6170 level->no_valid_file = TRUE;
6173 void CopyNativeLevel_RND_to_Native(struct LevelInfo *level)
6175 if (level->game_engine_type == GAME_ENGINE_TYPE_EM)
6176 CopyNativeLevel_RND_to_EM(level);
6177 else if (level->game_engine_type == GAME_ENGINE_TYPE_SP)
6178 CopyNativeLevel_RND_to_SP(level);
6179 else if (level->game_engine_type == GAME_ENGINE_TYPE_MM)
6180 CopyNativeLevel_RND_to_MM(level);
6183 void CopyNativeLevel_Native_to_RND(struct LevelInfo *level)
6185 if (level->game_engine_type == GAME_ENGINE_TYPE_EM)
6186 CopyNativeLevel_EM_to_RND(level);
6187 else if (level->game_engine_type == GAME_ENGINE_TYPE_SP)
6188 CopyNativeLevel_SP_to_RND(level);
6189 else if (level->game_engine_type == GAME_ENGINE_TYPE_MM)
6190 CopyNativeLevel_MM_to_RND(level);
6193 void SaveNativeLevel(struct LevelInfo *level)
6195 if (level->game_engine_type == GAME_ENGINE_TYPE_SP)
6197 char *basename = getSingleLevelBasenameExt(level->file_info.nr, "sp");
6198 char *filename = getLevelFilenameFromBasename(basename);
6200 CopyNativeLevel_RND_to_SP(level);
6201 CopyNativeTape_RND_to_SP(level);
6203 SaveNativeLevel_SP(filename);
6208 // ----------------------------------------------------------------------------
6209 // functions for loading generic level
6210 // ----------------------------------------------------------------------------
6212 static void LoadLevelFromFileInfo(struct LevelInfo *level,
6213 struct LevelFileInfo *level_file_info,
6214 boolean level_info_only)
6216 // always start with reliable default values
6217 setLevelInfoToDefaults(level, level_info_only, TRUE);
6219 switch (level_file_info->type)
6221 case LEVEL_FILE_TYPE_RND:
6222 LoadLevelFromFileInfo_RND(level, level_file_info, level_info_only);
6225 case LEVEL_FILE_TYPE_EM:
6226 LoadLevelFromFileInfo_EM(level, level_file_info, level_info_only);
6227 level->game_engine_type = GAME_ENGINE_TYPE_EM;
6230 case LEVEL_FILE_TYPE_SP:
6231 LoadLevelFromFileInfo_SP(level, level_file_info, level_info_only);
6232 level->game_engine_type = GAME_ENGINE_TYPE_SP;
6235 case LEVEL_FILE_TYPE_MM:
6236 LoadLevelFromFileInfo_MM(level, level_file_info, level_info_only);
6237 level->game_engine_type = GAME_ENGINE_TYPE_MM;
6240 case LEVEL_FILE_TYPE_DC:
6241 LoadLevelFromFileInfo_DC(level, level_file_info, level_info_only);
6244 case LEVEL_FILE_TYPE_SB:
6245 LoadLevelFromFileInfo_SB(level, level_file_info, level_info_only);
6249 LoadLevelFromFileInfo_RND(level, level_file_info, level_info_only);
6253 // if level file is invalid, restore level structure to default values
6254 if (level->no_valid_file)
6255 setLevelInfoToDefaults(level, level_info_only, FALSE);
6257 if (level->game_engine_type == GAME_ENGINE_TYPE_UNKNOWN)
6258 level->game_engine_type = GAME_ENGINE_TYPE_RND;
6260 if (level_file_info->type != LEVEL_FILE_TYPE_RND)
6261 CopyNativeLevel_Native_to_RND(level);
6264 void LoadLevelFromFilename(struct LevelInfo *level, char *filename)
6266 static struct LevelFileInfo level_file_info;
6268 // always start with reliable default values
6269 setFileInfoToDefaults(&level_file_info);
6271 level_file_info.nr = 0; // unknown level number
6272 level_file_info.type = LEVEL_FILE_TYPE_RND; // no others supported yet
6274 setString(&level_file_info.filename, filename);
6276 LoadLevelFromFileInfo(level, &level_file_info, FALSE);
6279 static void LoadLevel_InitVersion(struct LevelInfo *level)
6283 if (leveldir_current == NULL) // only when dumping level
6286 // all engine modifications also valid for levels which use latest engine
6287 if (level->game_version < VERSION_IDENT(3,2,0,5))
6289 // time bonus score was given for 10 s instead of 1 s before 3.2.0-5
6290 level->time_score_base = 10;
6293 if (leveldir_current->latest_engine)
6295 // ---------- use latest game engine --------------------------------------
6297 /* For all levels which are forced to use the latest game engine version
6298 (normally all but user contributed, private and undefined levels), set
6299 the game engine version to the actual version; this allows for actual
6300 corrections in the game engine to take effect for existing, converted
6301 levels (from "classic" or other existing games) to make the emulation
6302 of the corresponding game more accurate, while (hopefully) not breaking
6303 existing levels created from other players. */
6305 level->game_version = GAME_VERSION_ACTUAL;
6307 /* Set special EM style gems behaviour: EM style gems slip down from
6308 normal, steel and growing wall. As this is a more fundamental change,
6309 it seems better to set the default behaviour to "off" (as it is more
6310 natural) and make it configurable in the level editor (as a property
6311 of gem style elements). Already existing converted levels (neither
6312 private nor contributed levels) are changed to the new behaviour. */
6314 if (level->file_version < FILE_VERSION_2_0)
6315 level->em_slippery_gems = TRUE;
6320 // ---------- use game engine the level was created with --------------------
6322 /* For all levels which are not forced to use the latest game engine
6323 version (normally user contributed, private and undefined levels),
6324 use the version of the game engine the levels were created for.
6326 Since 2.0.1, the game engine version is now directly stored
6327 in the level file (chunk "VERS"), so there is no need anymore
6328 to set the game version from the file version (except for old,
6329 pre-2.0 levels, where the game version is still taken from the
6330 file format version used to store the level -- see above). */
6332 // player was faster than enemies in 1.0.0 and before
6333 if (level->file_version == FILE_VERSION_1_0)
6334 for (i = 0; i < MAX_PLAYERS; i++)
6335 level->initial_player_stepsize[i] = STEPSIZE_FAST;
6337 // default behaviour for EM style gems was "slippery" only in 2.0.1
6338 if (level->game_version == VERSION_IDENT(2,0,1,0))
6339 level->em_slippery_gems = TRUE;
6341 // springs could be pushed over pits before (pre-release version) 2.2.0
6342 if (level->game_version < VERSION_IDENT(2,2,0,0))
6343 level->use_spring_bug = TRUE;
6345 if (level->game_version < VERSION_IDENT(3,2,0,5))
6347 // time orb caused limited time in endless time levels before 3.2.0-5
6348 level->use_time_orb_bug = TRUE;
6350 // default behaviour for snapping was "no snap delay" before 3.2.0-5
6351 level->block_snap_field = FALSE;
6353 // extra time score was same value as time left score before 3.2.0-5
6354 level->extra_time_score = level->score[SC_TIME_BONUS];
6357 if (level->game_version < VERSION_IDENT(3,2,0,7))
6359 // default behaviour for snapping was "not continuous" before 3.2.0-7
6360 level->continuous_snapping = FALSE;
6363 // only few elements were able to actively move into acid before 3.1.0
6364 // trigger settings did not exist before 3.1.0; set to default "any"
6365 if (level->game_version < VERSION_IDENT(3,1,0,0))
6367 // correct "can move into acid" settings (all zero in old levels)
6369 level->can_move_into_acid_bits = 0; // nothing can move into acid
6370 level->dont_collide_with_bits = 0; // nothing is deadly when colliding
6372 setMoveIntoAcidProperty(level, EL_ROBOT, TRUE);
6373 setMoveIntoAcidProperty(level, EL_SATELLITE, TRUE);
6374 setMoveIntoAcidProperty(level, EL_PENGUIN, TRUE);
6375 setMoveIntoAcidProperty(level, EL_BALLOON, TRUE);
6377 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
6378 SET_PROPERTY(EL_CUSTOM_START + i, EP_CAN_MOVE_INTO_ACID, TRUE);
6380 // correct trigger settings (stored as zero == "none" in old levels)
6382 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
6384 int element = EL_CUSTOM_START + i;
6385 struct ElementInfo *ei = &element_info[element];
6387 for (j = 0; j < ei->num_change_pages; j++)
6389 struct ElementChangeInfo *change = &ei->change_page[j];
6391 change->trigger_player = CH_PLAYER_ANY;
6392 change->trigger_page = CH_PAGE_ANY;
6397 // try to detect and fix "Snake Bite" levels, which are broken with 3.2.0
6399 int element = EL_CUSTOM_256;
6400 struct ElementInfo *ei = &element_info[element];
6401 struct ElementChangeInfo *change = &ei->change_page[0];
6403 /* This is needed to fix a problem that was caused by a bugfix in function
6404 game.c/CreateFieldExt() introduced with 3.2.0 that corrects the behaviour
6405 when a custom element changes to EL_SOKOBAN_FIELD_PLAYER (before, it did
6406 not replace walkable elements, but instead just placed the player on it,
6407 without placing the Sokoban field under the player). Unfortunately, this
6408 breaks "Snake Bite" style levels when the snake is halfway through a door
6409 that just closes (the snake head is still alive and can be moved in this
6410 case). This can be fixed by replacing the EL_SOKOBAN_FIELD_PLAYER by the
6411 player (without Sokoban element) which then gets killed as designed). */
6413 if ((strncmp(leveldir_current->identifier, "snake_bite", 10) == 0 ||
6414 strncmp(ei->description, "pause b4 death", 14) == 0) &&
6415 change->target_element == EL_SOKOBAN_FIELD_PLAYER)
6416 change->target_element = EL_PLAYER_1;
6419 // try to detect and fix "Zelda" style levels, which are broken with 3.2.5
6420 if (level->game_version < VERSION_IDENT(3,2,5,0))
6422 /* This is needed to fix a problem that was caused by a bugfix in function
6423 game.c/CheckTriggeredElementChangeExt() introduced with 3.2.5 that
6424 corrects the behaviour when a custom element changes to another custom
6425 element with a higher element number that has change actions defined.
6426 Normally, only one change per frame is allowed for custom elements.
6427 Therefore, it is checked if a custom element already changed in the
6428 current frame; if it did, subsequent changes are suppressed.
6429 Unfortunately, this is only checked for element changes, but not for
6430 change actions, which are still executed. As the function above loops
6431 through all custom elements from lower to higher, an element change
6432 resulting in a lower CE number won't be checked again, while a target
6433 element with a higher number will also be checked, and potential change
6434 actions will get executed for this CE, too (which is wrong), while
6435 further changes are ignored (which is correct). As this bugfix breaks
6436 Zelda II (and introduces graphical bugs to Zelda I, and also breaks a
6437 few other levels like Alan Bond's "FMV"), allow the previous, incorrect
6438 behaviour for existing levels and tapes that make use of this bug */
6440 level->use_action_after_change_bug = TRUE;
6443 // not centering level after relocating player was default only in 3.2.3
6444 if (level->game_version == VERSION_IDENT(3,2,3,0)) // (no pre-releases)
6445 level->shifted_relocation = TRUE;
6447 // EM style elements always chain-exploded in R'n'D engine before 3.2.6
6448 if (level->game_version < VERSION_IDENT(3,2,6,0))
6449 level->em_explodes_by_fire = TRUE;
6451 // levels were solved by the first player entering an exit up to 4.1.0.0
6452 if (level->game_version <= VERSION_IDENT(4,1,0,0))
6453 level->solved_by_one_player = TRUE;
6455 // game logic of "game of life" and "biomaze" was buggy before 4.1.1.1
6456 if (level->game_version < VERSION_IDENT(4,1,1,1))
6457 level->use_life_bugs = TRUE;
6459 // only Sokoban fields (but not objects) had to be solved before 4.1.1.1
6460 if (level->game_version < VERSION_IDENT(4,1,1,1))
6461 level->sb_objects_needed = FALSE;
6463 // CE actions were triggered by unfinished digging/collecting up to 4.2.2.0
6464 if (level->game_version <= VERSION_IDENT(4,2,2,0))
6465 level->finish_dig_collect = FALSE;
6468 static void LoadLevel_InitStandardElements(struct LevelInfo *level)
6472 // map elements that have changed in newer versions
6473 level->amoeba_content = getMappedElementByVersion(level->amoeba_content,
6474 level->game_version);
6475 for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
6476 for (x = 0; x < 3; x++)
6477 for (y = 0; y < 3; y++)
6478 level->yamyam_content[i].e[x][y] =
6479 getMappedElementByVersion(level->yamyam_content[i].e[x][y],
6480 level->game_version);
6484 static void LoadLevel_InitCustomElements(struct LevelInfo *level)
6488 // map custom element change events that have changed in newer versions
6489 // (these following values were accidentally changed in version 3.0.1)
6490 // (this seems to be needed only for 'ab_levelset3' and 'ab_levelset4')
6491 if (level->game_version <= VERSION_IDENT(3,0,0,0))
6493 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
6495 int element = EL_CUSTOM_START + i;
6497 // order of checking and copying events to be mapped is important
6498 // (do not change the start and end value -- they are constant)
6499 for (j = CE_BY_OTHER_ACTION; j >= CE_VALUE_GETS_ZERO; j--)
6501 if (HAS_CHANGE_EVENT(element, j - 2))
6503 SET_CHANGE_EVENT(element, j - 2, FALSE);
6504 SET_CHANGE_EVENT(element, j, TRUE);
6508 // order of checking and copying events to be mapped is important
6509 // (do not change the start and end value -- they are constant)
6510 for (j = CE_PLAYER_COLLECTS_X; j >= CE_HITTING_SOMETHING; j--)
6512 if (HAS_CHANGE_EVENT(element, j - 1))
6514 SET_CHANGE_EVENT(element, j - 1, FALSE);
6515 SET_CHANGE_EVENT(element, j, TRUE);
6521 // initialize "can_change" field for old levels with only one change page
6522 if (level->game_version <= VERSION_IDENT(3,0,2,0))
6524 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
6526 int element = EL_CUSTOM_START + i;
6528 if (CAN_CHANGE(element))
6529 element_info[element].change->can_change = TRUE;
6533 // correct custom element values (for old levels without these options)
6534 if (level->game_version < VERSION_IDENT(3,1,1,0))
6536 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
6538 int element = EL_CUSTOM_START + i;
6539 struct ElementInfo *ei = &element_info[element];
6541 if (ei->access_direction == MV_NO_DIRECTION)
6542 ei->access_direction = MV_ALL_DIRECTIONS;
6546 // correct custom element values (fix invalid values for all versions)
6549 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
6551 int element = EL_CUSTOM_START + i;
6552 struct ElementInfo *ei = &element_info[element];
6554 for (j = 0; j < ei->num_change_pages; j++)
6556 struct ElementChangeInfo *change = &ei->change_page[j];
6558 if (change->trigger_player == CH_PLAYER_NONE)
6559 change->trigger_player = CH_PLAYER_ANY;
6561 if (change->trigger_side == CH_SIDE_NONE)
6562 change->trigger_side = CH_SIDE_ANY;
6567 // initialize "can_explode" field for old levels which did not store this
6568 // !!! CHECK THIS -- "<= 3,1,0,0" IS PROBABLY WRONG !!!
6569 if (level->game_version <= VERSION_IDENT(3,1,0,0))
6571 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
6573 int element = EL_CUSTOM_START + i;
6575 if (EXPLODES_1X1_OLD(element))
6576 element_info[element].explosion_type = EXPLODES_1X1;
6578 SET_PROPERTY(element, EP_CAN_EXPLODE, (EXPLODES_BY_FIRE(element) ||
6579 EXPLODES_SMASHED(element) ||
6580 EXPLODES_IMPACT(element)));
6584 // correct previously hard-coded move delay values for maze runner style
6585 if (level->game_version < VERSION_IDENT(3,1,1,0))
6587 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
6589 int element = EL_CUSTOM_START + i;
6591 if (element_info[element].move_pattern & MV_MAZE_RUNNER_STYLE)
6593 // previously hard-coded and therefore ignored
6594 element_info[element].move_delay_fixed = 9;
6595 element_info[element].move_delay_random = 0;
6600 // set some other uninitialized values of custom elements in older levels
6601 if (level->game_version < VERSION_IDENT(3,1,0,0))
6603 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
6605 int element = EL_CUSTOM_START + i;
6607 element_info[element].access_direction = MV_ALL_DIRECTIONS;
6609 element_info[element].explosion_delay = 17;
6610 element_info[element].ignition_delay = 8;
6614 // set mouse click change events to work for left/middle/right mouse button
6615 if (level->game_version < VERSION_IDENT(4,2,3,0))
6617 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
6619 int element = EL_CUSTOM_START + i;
6620 struct ElementInfo *ei = &element_info[element];
6622 for (j = 0; j < ei->num_change_pages; j++)
6624 struct ElementChangeInfo *change = &ei->change_page[j];
6626 if (change->has_event[CE_CLICKED_BY_MOUSE] ||
6627 change->has_event[CE_PRESSED_BY_MOUSE] ||
6628 change->has_event[CE_MOUSE_CLICKED_ON_X] ||
6629 change->has_event[CE_MOUSE_PRESSED_ON_X])
6630 change->trigger_side = CH_SIDE_ANY;
6636 static void LoadLevel_InitElements(struct LevelInfo *level)
6638 LoadLevel_InitStandardElements(level);
6640 if (level->file_has_custom_elements)
6641 LoadLevel_InitCustomElements(level);
6643 // initialize element properties for level editor etc.
6644 InitElementPropertiesEngine(level->game_version);
6645 InitElementPropertiesGfxElement();
6648 static void LoadLevel_InitPlayfield(struct LevelInfo *level)
6652 // map elements that have changed in newer versions
6653 for (y = 0; y < level->fieldy; y++)
6654 for (x = 0; x < level->fieldx; x++)
6655 level->field[x][y] = getMappedElementByVersion(level->field[x][y],
6656 level->game_version);
6658 // clear unused playfield data (nicer if level gets resized in editor)
6659 for (x = 0; x < MAX_LEV_FIELDX; x++)
6660 for (y = 0; y < MAX_LEV_FIELDY; y++)
6661 if (x >= level->fieldx || y >= level->fieldy)
6662 level->field[x][y] = EL_EMPTY;
6664 // copy elements to runtime playfield array
6665 for (x = 0; x < MAX_LEV_FIELDX; x++)
6666 for (y = 0; y < MAX_LEV_FIELDY; y++)
6667 Tile[x][y] = level->field[x][y];
6669 // initialize level size variables for faster access
6670 lev_fieldx = level->fieldx;
6671 lev_fieldy = level->fieldy;
6673 // determine border element for this level
6674 if (level->file_info.type == LEVEL_FILE_TYPE_DC)
6675 BorderElement = EL_EMPTY; // (in editor, SetBorderElement() is used)
6680 static void LoadLevel_InitNativeEngines(struct LevelInfo *level)
6682 struct LevelFileInfo *level_file_info = &level->file_info;
6684 if (level_file_info->type == LEVEL_FILE_TYPE_RND)
6685 CopyNativeLevel_RND_to_Native(level);
6688 static void LoadLevelTemplate_LoadAndInit(void)
6690 LoadLevelFromFileInfo(&level_template, &level_template.file_info, FALSE);
6692 LoadLevel_InitVersion(&level_template);
6693 LoadLevel_InitElements(&level_template);
6695 ActivateLevelTemplate();
6698 void LoadLevelTemplate(int nr)
6700 if (!fileExists(getGlobalLevelTemplateFilename()))
6702 Warn("no level template found for this level");
6707 setLevelFileInfo(&level_template.file_info, nr);
6709 LoadLevelTemplate_LoadAndInit();
6712 static void LoadNetworkLevelTemplate(struct NetworkLevelInfo *network_level)
6714 copyLevelFileInfo(&network_level->tmpl_info, &level_template.file_info);
6716 LoadLevelTemplate_LoadAndInit();
6719 static void LoadLevel_LoadAndInit(struct NetworkLevelInfo *network_level)
6721 LoadLevelFromFileInfo(&level, &level.file_info, FALSE);
6723 if (level.use_custom_template)
6725 if (network_level != NULL)
6726 LoadNetworkLevelTemplate(network_level);
6728 LoadLevelTemplate(-1);
6731 LoadLevel_InitVersion(&level);
6732 LoadLevel_InitElements(&level);
6733 LoadLevel_InitPlayfield(&level);
6735 LoadLevel_InitNativeEngines(&level);
6738 void LoadLevel(int nr)
6740 SetLevelSetInfo(leveldir_current->identifier, nr);
6742 setLevelFileInfo(&level.file_info, nr);
6744 LoadLevel_LoadAndInit(NULL);
6747 void LoadLevelInfoOnly(int nr)
6749 setLevelFileInfo(&level.file_info, nr);
6751 LoadLevelFromFileInfo(&level, &level.file_info, TRUE);
6754 void LoadNetworkLevel(struct NetworkLevelInfo *network_level)
6756 SetLevelSetInfo(network_level->leveldir_identifier,
6757 network_level->file_info.nr);
6759 copyLevelFileInfo(&network_level->file_info, &level.file_info);
6761 LoadLevel_LoadAndInit(network_level);
6764 static int SaveLevel_VERS(FILE *file, struct LevelInfo *level)
6768 chunk_size += putFileVersion(file, level->file_version);
6769 chunk_size += putFileVersion(file, level->game_version);
6774 static int SaveLevel_DATE(FILE *file, struct LevelInfo *level)
6778 chunk_size += putFile16BitBE(file, level->creation_date.year);
6779 chunk_size += putFile8Bit(file, level->creation_date.month);
6780 chunk_size += putFile8Bit(file, level->creation_date.day);
6785 #if ENABLE_HISTORIC_CHUNKS
6786 static void SaveLevel_HEAD(FILE *file, struct LevelInfo *level)
6790 putFile8Bit(file, level->fieldx);
6791 putFile8Bit(file, level->fieldy);
6793 putFile16BitBE(file, level->time);
6794 putFile16BitBE(file, level->gems_needed);
6796 for (i = 0; i < MAX_LEVEL_NAME_LEN; i++)
6797 putFile8Bit(file, level->name[i]);
6799 for (i = 0; i < LEVEL_SCORE_ELEMENTS; i++)
6800 putFile8Bit(file, level->score[i]);
6802 for (i = 0; i < STD_ELEMENT_CONTENTS; i++)
6803 for (y = 0; y < 3; y++)
6804 for (x = 0; x < 3; x++)
6805 putFile8Bit(file, (level->encoding_16bit_yamyam ? EL_EMPTY :
6806 level->yamyam_content[i].e[x][y]));
6807 putFile8Bit(file, level->amoeba_speed);
6808 putFile8Bit(file, level->time_magic_wall);
6809 putFile8Bit(file, level->time_wheel);
6810 putFile8Bit(file, (level->encoding_16bit_amoeba ? EL_EMPTY :
6811 level->amoeba_content));
6812 putFile8Bit(file, (level->initial_player_stepsize == STEPSIZE_FAST ? 1 : 0));
6813 putFile8Bit(file, (level->initial_gravity ? 1 : 0));
6814 putFile8Bit(file, (level->encoding_16bit_field ? 1 : 0));
6815 putFile8Bit(file, (level->em_slippery_gems ? 1 : 0));
6817 putFile8Bit(file, (level->use_custom_template ? 1 : 0));
6819 putFile8Bit(file, (level->block_last_field ? 1 : 0));
6820 putFile8Bit(file, (level->sp_block_last_field ? 1 : 0));
6821 putFile32BitBE(file, level->can_move_into_acid_bits);
6822 putFile8Bit(file, level->dont_collide_with_bits);
6824 putFile8Bit(file, (level->use_spring_bug ? 1 : 0));
6825 putFile8Bit(file, (level->use_step_counter ? 1 : 0));
6827 putFile8Bit(file, (level->instant_relocation ? 1 : 0));
6828 putFile8Bit(file, (level->can_pass_to_walkable ? 1 : 0));
6829 putFile8Bit(file, (level->grow_into_diggable ? 1 : 0));
6831 putFile8Bit(file, level->game_engine_type);
6833 WriteUnusedBytesToFile(file, LEVEL_CHUNK_HEAD_UNUSED);
6837 static int SaveLevel_NAME(FILE *file, struct LevelInfo *level)
6842 for (i = 0; i < MAX_LEVEL_NAME_LEN; i++)
6843 chunk_size += putFile8Bit(file, level->name[i]);
6848 static int SaveLevel_AUTH(FILE *file, struct LevelInfo *level)
6853 for (i = 0; i < MAX_LEVEL_AUTHOR_LEN; i++)
6854 chunk_size += putFile8Bit(file, level->author[i]);
6859 #if ENABLE_HISTORIC_CHUNKS
6860 static int SaveLevel_BODY(FILE *file, struct LevelInfo *level)
6865 for (y = 0; y < level->fieldy; y++)
6866 for (x = 0; x < level->fieldx; x++)
6867 if (level->encoding_16bit_field)
6868 chunk_size += putFile16BitBE(file, level->field[x][y]);
6870 chunk_size += putFile8Bit(file, level->field[x][y]);
6876 static int SaveLevel_BODY(FILE *file, struct LevelInfo *level)
6881 for (y = 0; y < level->fieldy; y++)
6882 for (x = 0; x < level->fieldx; x++)
6883 chunk_size += putFile16BitBE(file, level->field[x][y]);
6888 #if ENABLE_HISTORIC_CHUNKS
6889 static void SaveLevel_CONT(FILE *file, struct LevelInfo *level)
6893 putFile8Bit(file, EL_YAMYAM);
6894 putFile8Bit(file, level->num_yamyam_contents);
6895 putFile8Bit(file, 0);
6896 putFile8Bit(file, 0);
6898 for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
6899 for (y = 0; y < 3; y++)
6900 for (x = 0; x < 3; x++)
6901 if (level->encoding_16bit_field)
6902 putFile16BitBE(file, level->yamyam_content[i].e[x][y]);
6904 putFile8Bit(file, level->yamyam_content[i].e[x][y]);
6908 #if ENABLE_HISTORIC_CHUNKS
6909 static void SaveLevel_CNT2(FILE *file, struct LevelInfo *level, int element)
6912 int num_contents, content_xsize, content_ysize;
6913 int content_array[MAX_ELEMENT_CONTENTS][3][3];
6915 if (element == EL_YAMYAM)
6917 num_contents = level->num_yamyam_contents;
6921 for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
6922 for (y = 0; y < 3; y++)
6923 for (x = 0; x < 3; x++)
6924 content_array[i][x][y] = level->yamyam_content[i].e[x][y];
6926 else if (element == EL_BD_AMOEBA)
6932 for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
6933 for (y = 0; y < 3; y++)
6934 for (x = 0; x < 3; x++)
6935 content_array[i][x][y] = EL_EMPTY;
6936 content_array[0][0][0] = level->amoeba_content;
6940 // chunk header already written -- write empty chunk data
6941 WriteUnusedBytesToFile(file, LEVEL_CHUNK_CNT2_SIZE);
6943 Warn("cannot save content for element '%d'", element);
6948 putFile16BitBE(file, element);
6949 putFile8Bit(file, num_contents);
6950 putFile8Bit(file, content_xsize);
6951 putFile8Bit(file, content_ysize);
6953 WriteUnusedBytesToFile(file, LEVEL_CHUNK_CNT2_UNUSED);
6955 for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
6956 for (y = 0; y < 3; y++)
6957 for (x = 0; x < 3; x++)
6958 putFile16BitBE(file, content_array[i][x][y]);
6962 #if ENABLE_HISTORIC_CHUNKS
6963 static int SaveLevel_CNT3(FILE *file, struct LevelInfo *level, int element)
6965 int envelope_nr = element - EL_ENVELOPE_1;
6966 int envelope_len = strlen(level->envelope_text[envelope_nr]) + 1;
6970 chunk_size += putFile16BitBE(file, element);
6971 chunk_size += putFile16BitBE(file, envelope_len);
6972 chunk_size += putFile8Bit(file, level->envelope_xsize[envelope_nr]);
6973 chunk_size += putFile8Bit(file, level->envelope_ysize[envelope_nr]);
6975 WriteUnusedBytesToFile(file, LEVEL_CHUNK_CNT3_UNUSED);
6976 chunk_size += LEVEL_CHUNK_CNT3_UNUSED;
6978 for (i = 0; i < envelope_len; i++)
6979 chunk_size += putFile8Bit(file, level->envelope_text[envelope_nr][i]);
6985 #if ENABLE_HISTORIC_CHUNKS
6986 static void SaveLevel_CUS1(FILE *file, struct LevelInfo *level,
6987 int num_changed_custom_elements)
6991 putFile16BitBE(file, num_changed_custom_elements);
6993 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
6995 int element = EL_CUSTOM_START + i;
6997 struct ElementInfo *ei = &element_info[element];
6999 if (ei->properties[EP_BITFIELD_BASE_NR] != EP_BITMASK_DEFAULT)
7001 if (check < num_changed_custom_elements)
7003 putFile16BitBE(file, element);
7004 putFile32BitBE(file, ei->properties[EP_BITFIELD_BASE_NR]);
7011 if (check != num_changed_custom_elements) // should not happen
7012 Warn("inconsistent number of custom element properties");
7016 #if ENABLE_HISTORIC_CHUNKS
7017 static void SaveLevel_CUS2(FILE *file, struct LevelInfo *level,
7018 int num_changed_custom_elements)
7022 putFile16BitBE(file, num_changed_custom_elements);
7024 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
7026 int element = EL_CUSTOM_START + i;
7028 if (element_info[element].change->target_element != EL_EMPTY_SPACE)
7030 if (check < num_changed_custom_elements)
7032 putFile16BitBE(file, element);
7033 putFile16BitBE(file, element_info[element].change->target_element);
7040 if (check != num_changed_custom_elements) // should not happen
7041 Warn("inconsistent number of custom target elements");
7045 #if ENABLE_HISTORIC_CHUNKS
7046 static void SaveLevel_CUS3(FILE *file, struct LevelInfo *level,
7047 int num_changed_custom_elements)
7049 int i, j, x, y, check = 0;
7051 putFile16BitBE(file, num_changed_custom_elements);
7053 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
7055 int element = EL_CUSTOM_START + i;
7056 struct ElementInfo *ei = &element_info[element];
7058 if (ei->modified_settings)
7060 if (check < num_changed_custom_elements)
7062 putFile16BitBE(file, element);
7064 for (j = 0; j < MAX_ELEMENT_NAME_LEN; j++)
7065 putFile8Bit(file, ei->description[j]);
7067 putFile32BitBE(file, ei->properties[EP_BITFIELD_BASE_NR]);
7069 // some free bytes for future properties and padding
7070 WriteUnusedBytesToFile(file, 7);
7072 putFile8Bit(file, ei->use_gfx_element);
7073 putFile16BitBE(file, ei->gfx_element_initial);
7075 putFile8Bit(file, ei->collect_score_initial);
7076 putFile8Bit(file, ei->collect_count_initial);
7078 putFile16BitBE(file, ei->push_delay_fixed);
7079 putFile16BitBE(file, ei->push_delay_random);
7080 putFile16BitBE(file, ei->move_delay_fixed);
7081 putFile16BitBE(file, ei->move_delay_random);
7083 putFile16BitBE(file, ei->move_pattern);
7084 putFile8Bit(file, ei->move_direction_initial);
7085 putFile8Bit(file, ei->move_stepsize);
7087 for (y = 0; y < 3; y++)
7088 for (x = 0; x < 3; x++)
7089 putFile16BitBE(file, ei->content.e[x][y]);
7091 putFile32BitBE(file, ei->change->events);
7093 putFile16BitBE(file, ei->change->target_element);
7095 putFile16BitBE(file, ei->change->delay_fixed);
7096 putFile16BitBE(file, ei->change->delay_random);
7097 putFile16BitBE(file, ei->change->delay_frames);
7099 putFile16BitBE(file, ei->change->initial_trigger_element);
7101 putFile8Bit(file, ei->change->explode);
7102 putFile8Bit(file, ei->change->use_target_content);
7103 putFile8Bit(file, ei->change->only_if_complete);
7104 putFile8Bit(file, ei->change->use_random_replace);
7106 putFile8Bit(file, ei->change->random_percentage);
7107 putFile8Bit(file, ei->change->replace_when);
7109 for (y = 0; y < 3; y++)
7110 for (x = 0; x < 3; x++)
7111 putFile16BitBE(file, ei->change->content.e[x][y]);
7113 putFile8Bit(file, ei->slippery_type);
7115 // some free bytes for future properties and padding
7116 WriteUnusedBytesToFile(file, LEVEL_CPART_CUS3_UNUSED);
7123 if (check != num_changed_custom_elements) // should not happen
7124 Warn("inconsistent number of custom element properties");
7128 #if ENABLE_HISTORIC_CHUNKS
7129 static void SaveLevel_CUS4(FILE *file, struct LevelInfo *level, int element)
7131 struct ElementInfo *ei = &element_info[element];
7134 // ---------- custom element base property values (96 bytes) ----------------
7136 putFile16BitBE(file, element);
7138 for (i = 0; i < MAX_ELEMENT_NAME_LEN; i++)
7139 putFile8Bit(file, ei->description[i]);
7141 putFile32BitBE(file, ei->properties[EP_BITFIELD_BASE_NR]);
7143 WriteUnusedBytesToFile(file, 4); // reserved for more base properties
7145 putFile8Bit(file, ei->num_change_pages);
7147 putFile16BitBE(file, ei->ce_value_fixed_initial);
7148 putFile16BitBE(file, ei->ce_value_random_initial);
7149 putFile8Bit(file, ei->use_last_ce_value);
7151 putFile8Bit(file, ei->use_gfx_element);
7152 putFile16BitBE(file, ei->gfx_element_initial);
7154 putFile8Bit(file, ei->collect_score_initial);
7155 putFile8Bit(file, ei->collect_count_initial);
7157 putFile8Bit(file, ei->drop_delay_fixed);
7158 putFile8Bit(file, ei->push_delay_fixed);
7159 putFile8Bit(file, ei->drop_delay_random);
7160 putFile8Bit(file, ei->push_delay_random);
7161 putFile16BitBE(file, ei->move_delay_fixed);
7162 putFile16BitBE(file, ei->move_delay_random);
7164 // bits 0 - 15 of "move_pattern" ...
7165 putFile16BitBE(file, ei->move_pattern & 0xffff);
7166 putFile8Bit(file, ei->move_direction_initial);
7167 putFile8Bit(file, ei->move_stepsize);
7169 putFile8Bit(file, ei->slippery_type);
7171 for (y = 0; y < 3; y++)
7172 for (x = 0; x < 3; x++)
7173 putFile16BitBE(file, ei->content.e[x][y]);
7175 putFile16BitBE(file, ei->move_enter_element);
7176 putFile16BitBE(file, ei->move_leave_element);
7177 putFile8Bit(file, ei->move_leave_type);
7179 // ... bits 16 - 31 of "move_pattern" (not nice, but downward compatible)
7180 putFile16BitBE(file, (ei->move_pattern >> 16) & 0xffff);
7182 putFile8Bit(file, ei->access_direction);
7184 putFile8Bit(file, ei->explosion_delay);
7185 putFile8Bit(file, ei->ignition_delay);
7186 putFile8Bit(file, ei->explosion_type);
7188 // some free bytes for future custom property values and padding
7189 WriteUnusedBytesToFile(file, 1);
7191 // ---------- change page property values (48 bytes) ------------------------
7193 for (i = 0; i < ei->num_change_pages; i++)
7195 struct ElementChangeInfo *change = &ei->change_page[i];
7196 unsigned int event_bits;
7198 // bits 0 - 31 of "has_event[]" ...
7200 for (j = 0; j < MIN(NUM_CHANGE_EVENTS, 32); j++)
7201 if (change->has_event[j])
7202 event_bits |= (1 << j);
7203 putFile32BitBE(file, event_bits);
7205 putFile16BitBE(file, change->target_element);
7207 putFile16BitBE(file, change->delay_fixed);
7208 putFile16BitBE(file, change->delay_random);
7209 putFile16BitBE(file, change->delay_frames);
7211 putFile16BitBE(file, change->initial_trigger_element);
7213 putFile8Bit(file, change->explode);
7214 putFile8Bit(file, change->use_target_content);
7215 putFile8Bit(file, change->only_if_complete);
7216 putFile8Bit(file, change->use_random_replace);
7218 putFile8Bit(file, change->random_percentage);
7219 putFile8Bit(file, change->replace_when);
7221 for (y = 0; y < 3; y++)
7222 for (x = 0; x < 3; x++)
7223 putFile16BitBE(file, change->target_content.e[x][y]);
7225 putFile8Bit(file, change->can_change);
7227 putFile8Bit(file, change->trigger_side);
7229 putFile8Bit(file, change->trigger_player);
7230 putFile8Bit(file, (change->trigger_page == CH_PAGE_ANY ? CH_PAGE_ANY_FILE :
7231 log_2(change->trigger_page)));
7233 putFile8Bit(file, change->has_action);
7234 putFile8Bit(file, change->action_type);
7235 putFile8Bit(file, change->action_mode);
7236 putFile16BitBE(file, change->action_arg);
7238 // ... bits 32 - 39 of "has_event[]" (not nice, but downward compatible)
7240 for (j = 32; j < NUM_CHANGE_EVENTS; j++)
7241 if (change->has_event[j])
7242 event_bits |= (1 << (j - 32));
7243 putFile8Bit(file, event_bits);
7248 #if ENABLE_HISTORIC_CHUNKS
7249 static void SaveLevel_GRP1(FILE *file, struct LevelInfo *level, int element)
7251 struct ElementInfo *ei = &element_info[element];
7252 struct ElementGroupInfo *group = ei->group;
7255 putFile16BitBE(file, element);
7257 for (i = 0; i < MAX_ELEMENT_NAME_LEN; i++)
7258 putFile8Bit(file, ei->description[i]);
7260 putFile8Bit(file, group->num_elements);
7262 putFile8Bit(file, ei->use_gfx_element);
7263 putFile16BitBE(file, ei->gfx_element_initial);
7265 putFile8Bit(file, group->choice_mode);
7267 // some free bytes for future values and padding
7268 WriteUnusedBytesToFile(file, 3);
7270 for (i = 0; i < MAX_ELEMENTS_IN_GROUP; i++)
7271 putFile16BitBE(file, group->element[i]);
7275 static int SaveLevel_MicroChunk(FILE *file, struct LevelFileConfigInfo *entry,
7276 boolean write_element)
7278 int save_type = entry->save_type;
7279 int data_type = entry->data_type;
7280 int conf_type = entry->conf_type;
7281 int byte_mask = conf_type & CONF_MASK_BYTES;
7282 int element = entry->element;
7283 int default_value = entry->default_value;
7285 boolean modified = FALSE;
7287 if (byte_mask != CONF_MASK_MULTI_BYTES)
7289 void *value_ptr = entry->value;
7290 int value = (data_type == TYPE_BOOLEAN ? *(boolean *)value_ptr :
7293 // check if any settings have been modified before saving them
7294 if (value != default_value)
7297 // do not save if explicitly told or if unmodified default settings
7298 if ((save_type == SAVE_CONF_NEVER) ||
7299 (save_type == SAVE_CONF_WHEN_CHANGED && !modified))
7303 num_bytes += putFile16BitBE(file, element);
7305 num_bytes += putFile8Bit(file, conf_type);
7306 num_bytes += (byte_mask == CONF_MASK_1_BYTE ? putFile8Bit (file, value) :
7307 byte_mask == CONF_MASK_2_BYTE ? putFile16BitBE(file, value) :
7308 byte_mask == CONF_MASK_4_BYTE ? putFile32BitBE(file, value) :
7311 else if (data_type == TYPE_STRING)
7313 char *default_string = entry->default_string;
7314 char *string = (char *)(entry->value);
7315 int string_length = strlen(string);
7318 // check if any settings have been modified before saving them
7319 if (!strEqual(string, default_string))
7322 // do not save if explicitly told or if unmodified default settings
7323 if ((save_type == SAVE_CONF_NEVER) ||
7324 (save_type == SAVE_CONF_WHEN_CHANGED && !modified))
7328 num_bytes += putFile16BitBE(file, element);
7330 num_bytes += putFile8Bit(file, conf_type);
7331 num_bytes += putFile16BitBE(file, string_length);
7333 for (i = 0; i < string_length; i++)
7334 num_bytes += putFile8Bit(file, string[i]);
7336 else if (data_type == TYPE_ELEMENT_LIST)
7338 int *element_array = (int *)(entry->value);
7339 int num_elements = *(int *)(entry->num_entities);
7342 // check if any settings have been modified before saving them
7343 for (i = 0; i < num_elements; i++)
7344 if (element_array[i] != default_value)
7347 // do not save if explicitly told or if unmodified default settings
7348 if ((save_type == SAVE_CONF_NEVER) ||
7349 (save_type == SAVE_CONF_WHEN_CHANGED && !modified))
7353 num_bytes += putFile16BitBE(file, element);
7355 num_bytes += putFile8Bit(file, conf_type);
7356 num_bytes += putFile16BitBE(file, num_elements * CONF_ELEMENT_NUM_BYTES);
7358 for (i = 0; i < num_elements; i++)
7359 num_bytes += putFile16BitBE(file, element_array[i]);
7361 else if (data_type == TYPE_CONTENT_LIST)
7363 struct Content *content = (struct Content *)(entry->value);
7364 int num_contents = *(int *)(entry->num_entities);
7367 // check if any settings have been modified before saving them
7368 for (i = 0; i < num_contents; i++)
7369 for (y = 0; y < 3; y++)
7370 for (x = 0; x < 3; x++)
7371 if (content[i].e[x][y] != default_value)
7374 // do not save if explicitly told or if unmodified default settings
7375 if ((save_type == SAVE_CONF_NEVER) ||
7376 (save_type == SAVE_CONF_WHEN_CHANGED && !modified))
7380 num_bytes += putFile16BitBE(file, element);
7382 num_bytes += putFile8Bit(file, conf_type);
7383 num_bytes += putFile16BitBE(file, num_contents * CONF_CONTENT_NUM_BYTES);
7385 for (i = 0; i < num_contents; i++)
7386 for (y = 0; y < 3; y++)
7387 for (x = 0; x < 3; x++)
7388 num_bytes += putFile16BitBE(file, content[i].e[x][y]);
7394 static int SaveLevel_INFO(FILE *file, struct LevelInfo *level)
7399 li = *level; // copy level data into temporary buffer
7401 for (i = 0; chunk_config_INFO[i].data_type != -1; i++)
7402 chunk_size += SaveLevel_MicroChunk(file, &chunk_config_INFO[i], FALSE);
7407 static int SaveLevel_ELEM(FILE *file, struct LevelInfo *level)
7412 li = *level; // copy level data into temporary buffer
7414 for (i = 0; chunk_config_ELEM[i].data_type != -1; i++)
7415 chunk_size += SaveLevel_MicroChunk(file, &chunk_config_ELEM[i], TRUE);
7420 static int SaveLevel_NOTE(FILE *file, struct LevelInfo *level, int element)
7422 int envelope_nr = element - EL_ENVELOPE_1;
7426 chunk_size += putFile16BitBE(file, element);
7428 // copy envelope data into temporary buffer
7429 xx_envelope = level->envelope[envelope_nr];
7431 for (i = 0; chunk_config_NOTE[i].data_type != -1; i++)
7432 chunk_size += SaveLevel_MicroChunk(file, &chunk_config_NOTE[i], FALSE);
7437 static int SaveLevel_CUSX(FILE *file, struct LevelInfo *level, int element)
7439 struct ElementInfo *ei = &element_info[element];
7443 chunk_size += putFile16BitBE(file, element);
7445 xx_ei = *ei; // copy element data into temporary buffer
7447 // set default description string for this specific element
7448 strcpy(xx_default_description, getDefaultElementDescription(ei));
7450 for (i = 0; chunk_config_CUSX_base[i].data_type != -1; i++)
7451 chunk_size += SaveLevel_MicroChunk(file, &chunk_config_CUSX_base[i], FALSE);
7453 for (i = 0; i < ei->num_change_pages; i++)
7455 struct ElementChangeInfo *change = &ei->change_page[i];
7457 xx_current_change_page = i;
7459 xx_change = *change; // copy change data into temporary buffer
7462 setEventBitsFromEventFlags(change);
7464 for (j = 0; chunk_config_CUSX_change[j].data_type != -1; j++)
7465 chunk_size += SaveLevel_MicroChunk(file, &chunk_config_CUSX_change[j],
7472 static int SaveLevel_GRPX(FILE *file, struct LevelInfo *level, int element)
7474 struct ElementInfo *ei = &element_info[element];
7475 struct ElementGroupInfo *group = ei->group;
7479 chunk_size += putFile16BitBE(file, element);
7481 xx_ei = *ei; // copy element data into temporary buffer
7482 xx_group = *group; // copy group data into temporary buffer
7484 // set default description string for this specific element
7485 strcpy(xx_default_description, getDefaultElementDescription(ei));
7487 for (i = 0; chunk_config_GRPX[i].data_type != -1; i++)
7488 chunk_size += SaveLevel_MicroChunk(file, &chunk_config_GRPX[i], FALSE);
7493 static void SaveLevelFromFilename(struct LevelInfo *level, char *filename,
7494 boolean save_as_template)
7500 if (!(file = fopen(filename, MODE_WRITE)))
7502 Warn("cannot save level file '%s'", filename);
7507 level->file_version = FILE_VERSION_ACTUAL;
7508 level->game_version = GAME_VERSION_ACTUAL;
7510 level->creation_date = getCurrentDate();
7512 putFileChunkBE(file, "RND1", CHUNK_SIZE_UNDEFINED);
7513 putFileChunkBE(file, "CAVE", CHUNK_SIZE_NONE);
7515 chunk_size = SaveLevel_VERS(NULL, level);
7516 putFileChunkBE(file, "VERS", chunk_size);
7517 SaveLevel_VERS(file, level);
7519 chunk_size = SaveLevel_DATE(NULL, level);
7520 putFileChunkBE(file, "DATE", chunk_size);
7521 SaveLevel_DATE(file, level);
7523 chunk_size = SaveLevel_NAME(NULL, level);
7524 putFileChunkBE(file, "NAME", chunk_size);
7525 SaveLevel_NAME(file, level);
7527 chunk_size = SaveLevel_AUTH(NULL, level);
7528 putFileChunkBE(file, "AUTH", chunk_size);
7529 SaveLevel_AUTH(file, level);
7531 chunk_size = SaveLevel_INFO(NULL, level);
7532 putFileChunkBE(file, "INFO", chunk_size);
7533 SaveLevel_INFO(file, level);
7535 chunk_size = SaveLevel_BODY(NULL, level);
7536 putFileChunkBE(file, "BODY", chunk_size);
7537 SaveLevel_BODY(file, level);
7539 chunk_size = SaveLevel_ELEM(NULL, level);
7540 if (chunk_size > LEVEL_CHUNK_ELEM_UNCHANGED) // save if changed
7542 putFileChunkBE(file, "ELEM", chunk_size);
7543 SaveLevel_ELEM(file, level);
7546 for (i = 0; i < NUM_ENVELOPES; i++)
7548 int element = EL_ENVELOPE_1 + i;
7550 chunk_size = SaveLevel_NOTE(NULL, level, element);
7551 if (chunk_size > LEVEL_CHUNK_NOTE_UNCHANGED) // save if changed
7553 putFileChunkBE(file, "NOTE", chunk_size);
7554 SaveLevel_NOTE(file, level, element);
7558 // if not using template level, check for non-default custom/group elements
7559 if (!level->use_custom_template || save_as_template)
7561 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
7563 int element = EL_CUSTOM_START + i;
7565 chunk_size = SaveLevel_CUSX(NULL, level, element);
7566 if (chunk_size > LEVEL_CHUNK_CUSX_UNCHANGED) // save if changed
7568 putFileChunkBE(file, "CUSX", chunk_size);
7569 SaveLevel_CUSX(file, level, element);
7573 for (i = 0; i < NUM_GROUP_ELEMENTS; i++)
7575 int element = EL_GROUP_START + i;
7577 chunk_size = SaveLevel_GRPX(NULL, level, element);
7578 if (chunk_size > LEVEL_CHUNK_GRPX_UNCHANGED) // save if changed
7580 putFileChunkBE(file, "GRPX", chunk_size);
7581 SaveLevel_GRPX(file, level, element);
7588 SetFilePermissions(filename, PERMS_PRIVATE);
7591 void SaveLevel(int nr)
7593 char *filename = getDefaultLevelFilename(nr);
7595 SaveLevelFromFilename(&level, filename, FALSE);
7598 void SaveLevelTemplate(void)
7600 char *filename = getLocalLevelTemplateFilename();
7602 SaveLevelFromFilename(&level, filename, TRUE);
7605 boolean SaveLevelChecked(int nr)
7607 char *filename = getDefaultLevelFilename(nr);
7608 boolean new_level = !fileExists(filename);
7609 boolean level_saved = FALSE;
7611 if (new_level || Request("Save this level and kill the old?", REQ_ASK))
7616 Request("Level saved!", REQ_CONFIRM);
7624 void DumpLevel(struct LevelInfo *level)
7626 if (level->no_level_file || level->no_valid_file)
7628 Warn("cannot dump -- no valid level file found");
7634 Print("Level xxx (file version %08d, game version %08d)\n",
7635 level->file_version, level->game_version);
7638 Print("Level author: '%s'\n", level->author);
7639 Print("Level title: '%s'\n", level->name);
7641 Print("Playfield size: %d x %d\n", level->fieldx, level->fieldy);
7643 Print("Level time: %d seconds\n", level->time);
7644 Print("Gems needed: %d\n", level->gems_needed);
7646 Print("Time for magic wall: %d seconds\n", level->time_magic_wall);
7647 Print("Time for wheel: %d seconds\n", level->time_wheel);
7648 Print("Time for light: %d seconds\n", level->time_light);
7649 Print("Time for timegate: %d seconds\n", level->time_timegate);
7651 Print("Amoeba speed: %d\n", level->amoeba_speed);
7654 Print("EM style slippery gems: %s\n", (level->em_slippery_gems ? "yes" : "no"));
7655 Print("Player blocks last field: %s\n", (level->block_last_field ? "yes" : "no"));
7656 Print("SP player blocks last field: %s\n", (level->sp_block_last_field ? "yes" : "no"));
7657 Print("use spring bug: %s\n", (level->use_spring_bug ? "yes" : "no"));
7658 Print("use step counter: %s\n", (level->use_step_counter ? "yes" : "no"));
7664 // ============================================================================
7665 // tape file functions
7666 // ============================================================================
7668 static void setTapeInfoToDefaults(void)
7672 // always start with reliable default values (empty tape)
7675 // default values (also for pre-1.2 tapes) with only the first player
7676 tape.player_participates[0] = TRUE;
7677 for (i = 1; i < MAX_PLAYERS; i++)
7678 tape.player_participates[i] = FALSE;
7680 // at least one (default: the first) player participates in every tape
7681 tape.num_participating_players = 1;
7683 tape.property_bits = TAPE_PROPERTY_NONE;
7685 tape.level_nr = level_nr;
7687 tape.changed = FALSE;
7689 tape.recording = FALSE;
7690 tape.playing = FALSE;
7691 tape.pausing = FALSE;
7693 tape.scr_fieldx = SCR_FIELDX_DEFAULT;
7694 tape.scr_fieldy = SCR_FIELDY_DEFAULT;
7696 tape.no_valid_file = FALSE;
7699 static int getTapePosSize(struct TapeInfo *tape)
7701 int tape_pos_size = 0;
7703 if (tape->use_key_actions)
7704 tape_pos_size += tape->num_participating_players;
7706 if (tape->use_mouse_actions)
7707 tape_pos_size += 3; // x and y position and mouse button mask
7709 tape_pos_size += 1; // tape action delay value
7711 return tape_pos_size;
7714 static void setTapeActionFlags(struct TapeInfo *tape, int value)
7716 tape->use_key_actions = FALSE;
7717 tape->use_mouse_actions = FALSE;
7719 if (value != TAPE_USE_MOUSE_ACTIONS_ONLY)
7720 tape->use_key_actions = TRUE;
7722 if (value != TAPE_USE_KEY_ACTIONS_ONLY)
7723 tape->use_mouse_actions = TRUE;
7726 static int getTapeActionValue(struct TapeInfo *tape)
7728 return (tape->use_key_actions &&
7729 tape->use_mouse_actions ? TAPE_USE_KEY_AND_MOUSE_ACTIONS :
7730 tape->use_key_actions ? TAPE_USE_KEY_ACTIONS_ONLY :
7731 tape->use_mouse_actions ? TAPE_USE_MOUSE_ACTIONS_ONLY :
7732 TAPE_ACTIONS_DEFAULT);
7735 static int LoadTape_VERS(File *file, int chunk_size, struct TapeInfo *tape)
7737 tape->file_version = getFileVersion(file);
7738 tape->game_version = getFileVersion(file);
7743 static int LoadTape_HEAD(File *file, int chunk_size, struct TapeInfo *tape)
7747 tape->random_seed = getFile32BitBE(file);
7748 tape->date = getFile32BitBE(file);
7749 tape->length = getFile32BitBE(file);
7751 // read header fields that are new since version 1.2
7752 if (tape->file_version >= FILE_VERSION_1_2)
7754 byte store_participating_players = getFile8Bit(file);
7757 // since version 1.2, tapes store which players participate in the tape
7758 tape->num_participating_players = 0;
7759 for (i = 0; i < MAX_PLAYERS; i++)
7761 tape->player_participates[i] = FALSE;
7763 if (store_participating_players & (1 << i))
7765 tape->player_participates[i] = TRUE;
7766 tape->num_participating_players++;
7770 setTapeActionFlags(tape, getFile8Bit(file));
7772 tape->property_bits = getFile8Bit(file);
7774 ReadUnusedBytesFromFile(file, TAPE_CHUNK_HEAD_UNUSED);
7776 engine_version = getFileVersion(file);
7777 if (engine_version > 0)
7778 tape->engine_version = engine_version;
7780 tape->engine_version = tape->game_version;
7786 static int LoadTape_SCRN(File *file, int chunk_size, struct TapeInfo *tape)
7788 tape->scr_fieldx = getFile8Bit(file);
7789 tape->scr_fieldy = getFile8Bit(file);
7794 static int LoadTape_INFO(File *file, int chunk_size, struct TapeInfo *tape)
7796 char *level_identifier = NULL;
7797 int level_identifier_size;
7800 level_identifier_size = getFile16BitBE(file);
7802 level_identifier = checked_malloc(level_identifier_size);
7804 for (i = 0; i < level_identifier_size; i++)
7805 level_identifier[i] = getFile8Bit(file);
7807 strncpy(tape->level_identifier, level_identifier, MAX_FILENAME_LEN);
7808 tape->level_identifier[MAX_FILENAME_LEN] = '\0';
7810 checked_free(level_identifier);
7812 tape->level_nr = getFile16BitBE(file);
7814 chunk_size = 2 + level_identifier_size + 2;
7819 static int LoadTape_BODY(File *file, int chunk_size, struct TapeInfo *tape)
7822 int tape_pos_size = getTapePosSize(tape);
7823 int chunk_size_expected = tape_pos_size * tape->length;
7825 if (chunk_size_expected != chunk_size)
7827 ReadUnusedBytesFromFile(file, chunk_size);
7828 return chunk_size_expected;
7831 for (i = 0; i < tape->length; i++)
7833 if (i >= MAX_TAPE_LEN)
7835 Warn("tape truncated -- size exceeds maximum tape size %d",
7838 // tape too large; read and ignore remaining tape data from this chunk
7839 for (;i < tape->length; i++)
7840 ReadUnusedBytesFromFile(file, tape_pos_size);
7845 if (tape->use_key_actions)
7847 for (j = 0; j < MAX_PLAYERS; j++)
7849 tape->pos[i].action[j] = MV_NONE;
7851 if (tape->player_participates[j])
7852 tape->pos[i].action[j] = getFile8Bit(file);
7856 if (tape->use_mouse_actions)
7858 tape->pos[i].action[TAPE_ACTION_LX] = getFile8Bit(file);
7859 tape->pos[i].action[TAPE_ACTION_LY] = getFile8Bit(file);
7860 tape->pos[i].action[TAPE_ACTION_BUTTON] = getFile8Bit(file);
7863 tape->pos[i].delay = getFile8Bit(file);
7865 if (tape->file_version == FILE_VERSION_1_0)
7867 // eliminate possible diagonal moves in old tapes
7868 // this is only for backward compatibility
7870 byte joy_dir[4] = { JOY_LEFT, JOY_RIGHT, JOY_UP, JOY_DOWN };
7871 byte action = tape->pos[i].action[0];
7872 int k, num_moves = 0;
7874 for (k = 0; k<4; k++)
7876 if (action & joy_dir[k])
7878 tape->pos[i + num_moves].action[0] = joy_dir[k];
7880 tape->pos[i + num_moves].delay = 0;
7889 tape->length += num_moves;
7892 else if (tape->file_version < FILE_VERSION_2_0)
7894 // convert pre-2.0 tapes to new tape format
7896 if (tape->pos[i].delay > 1)
7899 tape->pos[i + 1] = tape->pos[i];
7900 tape->pos[i + 1].delay = 1;
7903 for (j = 0; j < MAX_PLAYERS; j++)
7904 tape->pos[i].action[j] = MV_NONE;
7905 tape->pos[i].delay--;
7912 if (checkEndOfFile(file))
7916 if (i != tape->length)
7917 chunk_size = tape_pos_size * i;
7922 static void LoadTape_SokobanSolution(char *filename)
7925 int move_delay = TILESIZE / level.initial_player_stepsize[0];
7927 if (!(file = openFile(filename, MODE_READ)))
7929 tape.no_valid_file = TRUE;
7934 while (!checkEndOfFile(file))
7936 unsigned char c = getByteFromFile(file);
7938 if (checkEndOfFile(file))
7945 tape.pos[tape.length].action[0] = MV_UP;
7946 tape.pos[tape.length].delay = move_delay + (c < 'a' ? 2 : 0);
7952 tape.pos[tape.length].action[0] = MV_DOWN;
7953 tape.pos[tape.length].delay = move_delay + (c < 'a' ? 2 : 0);
7959 tape.pos[tape.length].action[0] = MV_LEFT;
7960 tape.pos[tape.length].delay = move_delay + (c < 'a' ? 2 : 0);
7966 tape.pos[tape.length].action[0] = MV_RIGHT;
7967 tape.pos[tape.length].delay = move_delay + (c < 'a' ? 2 : 0);
7975 // ignore white-space characters
7979 tape.no_valid_file = TRUE;
7981 Warn("unsupported Sokoban solution file '%s' ['%d']", filename, c);
7989 if (tape.no_valid_file)
7992 tape.length_frames = GetTapeLengthFrames();
7993 tape.length_seconds = GetTapeLengthSeconds();
7996 void LoadTapeFromFilename(char *filename)
7998 char cookie[MAX_LINE_LEN];
7999 char chunk_name[CHUNK_ID_LEN + 1];
8003 // always start with reliable default values
8004 setTapeInfoToDefaults();
8006 if (strSuffix(filename, ".sln"))
8008 LoadTape_SokobanSolution(filename);
8013 if (!(file = openFile(filename, MODE_READ)))
8015 tape.no_valid_file = TRUE;
8020 getFileChunkBE(file, chunk_name, NULL);
8021 if (strEqual(chunk_name, "RND1"))
8023 getFile32BitBE(file); // not used
8025 getFileChunkBE(file, chunk_name, NULL);
8026 if (!strEqual(chunk_name, "TAPE"))
8028 tape.no_valid_file = TRUE;
8030 Warn("unknown format of tape file '%s'", filename);
8037 else // check for pre-2.0 file format with cookie string
8039 strcpy(cookie, chunk_name);
8040 if (getStringFromFile(file, &cookie[4], MAX_LINE_LEN - 4) == NULL)
8042 if (strlen(cookie) > 0 && cookie[strlen(cookie) - 1] == '\n')
8043 cookie[strlen(cookie) - 1] = '\0';
8045 if (!checkCookieString(cookie, TAPE_COOKIE_TMPL))
8047 tape.no_valid_file = TRUE;
8049 Warn("unknown format of tape file '%s'", filename);
8056 if ((tape.file_version = getFileVersionFromCookieString(cookie)) == -1)
8058 tape.no_valid_file = TRUE;
8060 Warn("unsupported version of tape file '%s'", filename);
8067 // pre-2.0 tape files have no game version, so use file version here
8068 tape.game_version = tape.file_version;
8071 if (tape.file_version < FILE_VERSION_1_2)
8073 // tape files from versions before 1.2.0 without chunk structure
8074 LoadTape_HEAD(file, TAPE_CHUNK_HEAD_SIZE, &tape);
8075 LoadTape_BODY(file, 2 * tape.length, &tape);
8083 int (*loader)(File *, int, struct TapeInfo *);
8087 { "VERS", TAPE_CHUNK_VERS_SIZE, LoadTape_VERS },
8088 { "HEAD", TAPE_CHUNK_HEAD_SIZE, LoadTape_HEAD },
8089 { "SCRN", TAPE_CHUNK_SCRN_SIZE, LoadTape_SCRN },
8090 { "INFO", -1, LoadTape_INFO },
8091 { "BODY", -1, LoadTape_BODY },
8095 while (getFileChunkBE(file, chunk_name, &chunk_size))
8099 while (chunk_info[i].name != NULL &&
8100 !strEqual(chunk_name, chunk_info[i].name))
8103 if (chunk_info[i].name == NULL)
8105 Warn("unknown chunk '%s' in tape file '%s'",
8106 chunk_name, filename);
8108 ReadUnusedBytesFromFile(file, chunk_size);
8110 else if (chunk_info[i].size != -1 &&
8111 chunk_info[i].size != chunk_size)
8113 Warn("wrong size (%d) of chunk '%s' in tape file '%s'",
8114 chunk_size, chunk_name, filename);
8116 ReadUnusedBytesFromFile(file, chunk_size);
8120 // call function to load this tape chunk
8121 int chunk_size_expected =
8122 (chunk_info[i].loader)(file, chunk_size, &tape);
8124 // the size of some chunks cannot be checked before reading other
8125 // chunks first (like "HEAD" and "BODY") that contain some header
8126 // information, so check them here
8127 if (chunk_size_expected != chunk_size)
8129 Warn("wrong size (%d) of chunk '%s' in tape file '%s'",
8130 chunk_size, chunk_name, filename);
8138 tape.length_frames = GetTapeLengthFrames();
8139 tape.length_seconds = GetTapeLengthSeconds();
8142 Debug("files:LoadTapeFromFilename", "tape file version: %d",
8144 Debug("files:LoadTapeFromFilename", "tape game version: %d",
8146 Debug("files:LoadTapeFromFilename", "tape engine version: %d",
8147 tape.engine_version);
8151 void LoadTape(int nr)
8153 char *filename = getTapeFilename(nr);
8155 LoadTapeFromFilename(filename);
8158 void LoadSolutionTape(int nr)
8160 char *filename = getSolutionTapeFilename(nr);
8162 LoadTapeFromFilename(filename);
8164 if (TAPE_IS_EMPTY(tape) &&
8165 level.game_engine_type == GAME_ENGINE_TYPE_SP &&
8166 level.native_sp_level->demo.is_available)
8167 CopyNativeTape_SP_to_RND(&level);
8170 static boolean checkSaveTape_SCRN(struct TapeInfo *tape)
8172 // chunk required for team mode tapes with non-default screen size
8173 return (tape->num_participating_players > 1 &&
8174 (tape->scr_fieldx != SCR_FIELDX_DEFAULT ||
8175 tape->scr_fieldy != SCR_FIELDY_DEFAULT));
8178 static void SaveTape_VERS(FILE *file, struct TapeInfo *tape)
8180 putFileVersion(file, tape->file_version);
8181 putFileVersion(file, tape->game_version);
8184 static void SaveTape_HEAD(FILE *file, struct TapeInfo *tape)
8187 byte store_participating_players = 0;
8189 // set bits for participating players for compact storage
8190 for (i = 0; i < MAX_PLAYERS; i++)
8191 if (tape->player_participates[i])
8192 store_participating_players |= (1 << i);
8194 putFile32BitBE(file, tape->random_seed);
8195 putFile32BitBE(file, tape->date);
8196 putFile32BitBE(file, tape->length);
8198 putFile8Bit(file, store_participating_players);
8200 putFile8Bit(file, getTapeActionValue(tape));
8202 putFile8Bit(file, tape->property_bits);
8204 // unused bytes not at the end here for 4-byte alignment of engine_version
8205 WriteUnusedBytesToFile(file, TAPE_CHUNK_HEAD_UNUSED);
8207 putFileVersion(file, tape->engine_version);
8210 static void SaveTape_SCRN(FILE *file, struct TapeInfo *tape)
8212 putFile8Bit(file, tape->scr_fieldx);
8213 putFile8Bit(file, tape->scr_fieldy);
8216 static void SaveTape_INFO(FILE *file, struct TapeInfo *tape)
8218 int level_identifier_size = strlen(tape->level_identifier) + 1;
8221 putFile16BitBE(file, level_identifier_size);
8223 for (i = 0; i < level_identifier_size; i++)
8224 putFile8Bit(file, tape->level_identifier[i]);
8226 putFile16BitBE(file, tape->level_nr);
8229 static void SaveTape_BODY(FILE *file, struct TapeInfo *tape)
8233 for (i = 0; i < tape->length; i++)
8235 if (tape->use_key_actions)
8237 for (j = 0; j < MAX_PLAYERS; j++)
8238 if (tape->player_participates[j])
8239 putFile8Bit(file, tape->pos[i].action[j]);
8242 if (tape->use_mouse_actions)
8244 putFile8Bit(file, tape->pos[i].action[TAPE_ACTION_LX]);
8245 putFile8Bit(file, tape->pos[i].action[TAPE_ACTION_LY]);
8246 putFile8Bit(file, tape->pos[i].action[TAPE_ACTION_BUTTON]);
8249 putFile8Bit(file, tape->pos[i].delay);
8253 void SaveTapeToFilename(char *filename)
8257 int info_chunk_size;
8258 int body_chunk_size;
8260 if (!(file = fopen(filename, MODE_WRITE)))
8262 Warn("cannot save level recording file '%s'", filename);
8267 tape_pos_size = getTapePosSize(&tape);
8269 info_chunk_size = 2 + (strlen(tape.level_identifier) + 1) + 2;
8270 body_chunk_size = tape_pos_size * tape.length;
8272 putFileChunkBE(file, "RND1", CHUNK_SIZE_UNDEFINED);
8273 putFileChunkBE(file, "TAPE", CHUNK_SIZE_NONE);
8275 putFileChunkBE(file, "VERS", TAPE_CHUNK_VERS_SIZE);
8276 SaveTape_VERS(file, &tape);
8278 putFileChunkBE(file, "HEAD", TAPE_CHUNK_HEAD_SIZE);
8279 SaveTape_HEAD(file, &tape);
8281 if (checkSaveTape_SCRN(&tape))
8283 putFileChunkBE(file, "SCRN", TAPE_CHUNK_SCRN_SIZE);
8284 SaveTape_SCRN(file, &tape);
8287 putFileChunkBE(file, "INFO", info_chunk_size);
8288 SaveTape_INFO(file, &tape);
8290 putFileChunkBE(file, "BODY", body_chunk_size);
8291 SaveTape_BODY(file, &tape);
8295 SetFilePermissions(filename, PERMS_PRIVATE);
8298 static void SaveTapeExt(char *filename)
8302 tape.file_version = FILE_VERSION_ACTUAL;
8303 tape.game_version = GAME_VERSION_ACTUAL;
8305 tape.num_participating_players = 0;
8307 // count number of participating players
8308 for (i = 0; i < MAX_PLAYERS; i++)
8309 if (tape.player_participates[i])
8310 tape.num_participating_players++;
8312 SaveTapeToFilename(filename);
8314 tape.changed = FALSE;
8317 void SaveTape(int nr)
8319 char *filename = getTapeFilename(nr);
8321 InitTapeDirectory(leveldir_current->subdir);
8323 SaveTapeExt(filename);
8326 void SaveScoreTape(int nr)
8328 char *filename = getScoreTapeFilename(tape.score_tape_basename, nr);
8330 // used instead of "leveldir_current->subdir" (for network games)
8331 InitScoreTapeDirectory(levelset.identifier, nr);
8333 SaveTapeExt(filename);
8336 static boolean SaveTapeCheckedExt(int nr, char *msg_replace, char *msg_saved,
8337 unsigned int req_state_added)
8339 char *filename = getTapeFilename(nr);
8340 boolean new_tape = !fileExists(filename);
8341 boolean tape_saved = FALSE;
8343 if (new_tape || Request(msg_replace, REQ_ASK | req_state_added))
8348 Request(msg_saved, REQ_CONFIRM | req_state_added);
8356 boolean SaveTapeChecked(int nr)
8358 return SaveTapeCheckedExt(nr, "Replace old tape?", "Tape saved!", 0);
8361 boolean SaveTapeChecked_LevelSolved(int nr)
8363 return SaveTapeCheckedExt(nr, "Level solved! Replace old tape?",
8364 "Level solved! Tape saved!", REQ_STAY_OPEN);
8367 void DumpTape(struct TapeInfo *tape)
8369 int tape_frame_counter;
8372 if (tape->no_valid_file)
8374 Warn("cannot dump -- no valid tape file found");
8380 Print("Tape of Level %03d (file version %08d, game version %08d)\n",
8381 tape->level_nr, tape->file_version, tape->game_version);
8382 Print(" (effective engine version %08d)\n",
8383 tape->engine_version);
8384 Print("Level series identifier: '%s'\n", tape->level_identifier);
8387 tape_frame_counter = 0;
8389 for (i = 0; i < tape->length; i++)
8391 if (i >= MAX_TAPE_LEN)
8396 for (j = 0; j < MAX_PLAYERS; j++)
8398 if (tape->player_participates[j])
8400 int action = tape->pos[i].action[j];
8402 Print("%d:%02x ", j, action);
8403 Print("[%c%c%c%c|%c%c] - ",
8404 (action & JOY_LEFT ? '<' : ' '),
8405 (action & JOY_RIGHT ? '>' : ' '),
8406 (action & JOY_UP ? '^' : ' '),
8407 (action & JOY_DOWN ? 'v' : ' '),
8408 (action & JOY_BUTTON_1 ? '1' : ' '),
8409 (action & JOY_BUTTON_2 ? '2' : ' '));
8413 Print("(%03d) ", tape->pos[i].delay);
8414 Print("[%05d]\n", tape_frame_counter);
8416 tape_frame_counter += tape->pos[i].delay;
8423 // ============================================================================
8424 // score file functions
8425 // ============================================================================
8427 static void setScoreInfoToDefaultsExt(struct ScoreInfo *scores)
8431 for (i = 0; i < MAX_SCORE_ENTRIES; i++)
8433 strcpy(scores->entry[i].tape_basename, UNDEFINED_FILENAME);
8434 strcpy(scores->entry[i].name, EMPTY_PLAYER_NAME);
8435 scores->entry[i].score = 0;
8436 scores->entry[i].time = 0;
8439 scores->num_entries = 0;
8440 scores->last_added = -1;
8441 scores->last_added_local = -1;
8443 scores->updated = FALSE;
8446 static void setScoreInfoToDefaults(void)
8448 setScoreInfoToDefaultsExt(&scores);
8451 static void setServerScoreInfoToDefaults(void)
8453 setScoreInfoToDefaultsExt(&server_scores);
8456 static void LoadScore_OLD(int nr)
8459 char *filename = getScoreFilename(nr);
8460 char cookie[MAX_LINE_LEN];
8461 char line[MAX_LINE_LEN];
8465 if (!(file = fopen(filename, MODE_READ)))
8468 // check file identifier
8469 if (fgets(cookie, MAX_LINE_LEN, file) == NULL)
8471 if (strlen(cookie) > 0 && cookie[strlen(cookie) - 1] == '\n')
8472 cookie[strlen(cookie) - 1] = '\0';
8474 if (!checkCookieString(cookie, SCORE_COOKIE_TMPL))
8476 Warn("unknown format of score file '%s'", filename);
8483 for (i = 0; i < MAX_SCORE_ENTRIES; i++)
8485 if (fscanf(file, "%d", &scores.entry[i].score) == EOF)
8486 Warn("fscanf() failed; %s", strerror(errno));
8488 if (fgets(line, MAX_LINE_LEN, file) == NULL)
8491 if (strlen(line) > 0 && line[strlen(line) - 1] == '\n')
8492 line[strlen(line) - 1] = '\0';
8494 for (line_ptr = line; *line_ptr; line_ptr++)
8496 if (*line_ptr != ' ' && *line_ptr != '\t' && *line_ptr != '\0')
8498 strncpy(scores.entry[i].name, line_ptr, MAX_PLAYER_NAME_LEN);
8499 scores.entry[i].name[MAX_PLAYER_NAME_LEN] = '\0';
8508 static void ConvertScore_OLD(void)
8510 // only convert score to time for levels that rate playing time over score
8511 if (!level.rate_time_over_score)
8514 // convert old score to playing time for score-less levels (like Supaplex)
8515 int time_final_max = 999;
8518 for (i = 0; i < MAX_SCORE_ENTRIES; i++)
8520 int score = scores.entry[i].score;
8522 if (score > 0 && score < time_final_max)
8523 scores.entry[i].time = (time_final_max - score - 1) * FRAMES_PER_SECOND;
8527 static int LoadScore_VERS(File *file, int chunk_size, struct ScoreInfo *scores)
8529 scores->file_version = getFileVersion(file);
8530 scores->game_version = getFileVersion(file);
8535 static int LoadScore_INFO(File *file, int chunk_size, struct ScoreInfo *scores)
8537 char *level_identifier = NULL;
8538 int level_identifier_size;
8541 level_identifier_size = getFile16BitBE(file);
8543 level_identifier = checked_malloc(level_identifier_size);
8545 for (i = 0; i < level_identifier_size; i++)
8546 level_identifier[i] = getFile8Bit(file);
8548 strncpy(scores->level_identifier, level_identifier, MAX_FILENAME_LEN);
8549 scores->level_identifier[MAX_FILENAME_LEN] = '\0';
8551 checked_free(level_identifier);
8553 scores->level_nr = getFile16BitBE(file);
8554 scores->num_entries = getFile16BitBE(file);
8556 chunk_size = 2 + level_identifier_size + 2 + 2;
8561 static int LoadScore_NAME(File *file, int chunk_size, struct ScoreInfo *scores)
8565 for (i = 0; i < scores->num_entries; i++)
8567 for (j = 0; j < MAX_PLAYER_NAME_LEN; j++)
8568 scores->entry[i].name[j] = getFile8Bit(file);
8570 scores->entry[i].name[MAX_PLAYER_NAME_LEN] = '\0';
8573 chunk_size = scores->num_entries * MAX_PLAYER_NAME_LEN;
8578 static int LoadScore_SCOR(File *file, int chunk_size, struct ScoreInfo *scores)
8582 for (i = 0; i < scores->num_entries; i++)
8583 scores->entry[i].score = getFile16BitBE(file);
8585 chunk_size = scores->num_entries * 2;
8590 static int LoadScore_TIME(File *file, int chunk_size, struct ScoreInfo *scores)
8594 for (i = 0; i < scores->num_entries; i++)
8595 scores->entry[i].time = getFile32BitBE(file);
8597 chunk_size = scores->num_entries * 4;
8602 static int LoadScore_TAPE(File *file, int chunk_size, struct ScoreInfo *scores)
8606 for (i = 0; i < scores->num_entries; i++)
8608 for (j = 0; j < MAX_SCORE_TAPE_BASENAME_LEN; j++)
8609 scores->entry[i].tape_basename[j] = getFile8Bit(file);
8611 scores->entry[i].tape_basename[MAX_SCORE_TAPE_BASENAME_LEN] = '\0';
8614 chunk_size = scores->num_entries * MAX_SCORE_TAPE_BASENAME_LEN;
8619 void LoadScore(int nr)
8621 char *filename = getScoreFilename(nr);
8622 char cookie[MAX_LINE_LEN];
8623 char chunk_name[CHUNK_ID_LEN + 1];
8625 boolean old_score_file_format = FALSE;
8628 // always start with reliable default values
8629 setScoreInfoToDefaults();
8631 if (!(file = openFile(filename, MODE_READ)))
8634 getFileChunkBE(file, chunk_name, NULL);
8635 if (strEqual(chunk_name, "RND1"))
8637 getFile32BitBE(file); // not used
8639 getFileChunkBE(file, chunk_name, NULL);
8640 if (!strEqual(chunk_name, "SCOR"))
8642 Warn("unknown format of score file '%s'", filename);
8649 else // check for old file format with cookie string
8651 strcpy(cookie, chunk_name);
8652 if (getStringFromFile(file, &cookie[4], MAX_LINE_LEN - 4) == NULL)
8654 if (strlen(cookie) > 0 && cookie[strlen(cookie) - 1] == '\n')
8655 cookie[strlen(cookie) - 1] = '\0';
8657 if (!checkCookieString(cookie, SCORE_COOKIE_TMPL))
8659 Warn("unknown format of score file '%s'", filename);
8666 old_score_file_format = TRUE;
8669 if (old_score_file_format)
8671 // score files from versions before 4.2.4.0 without chunk structure
8674 // convert score to time, if possible (mainly for Supaplex levels)
8683 int (*loader)(File *, int, struct ScoreInfo *);
8687 { "VERS", SCORE_CHUNK_VERS_SIZE, LoadScore_VERS },
8688 { "INFO", -1, LoadScore_INFO },
8689 { "NAME", -1, LoadScore_NAME },
8690 { "SCOR", -1, LoadScore_SCOR },
8691 { "TIME", -1, LoadScore_TIME },
8692 { "TAPE", -1, LoadScore_TAPE },
8697 while (getFileChunkBE(file, chunk_name, &chunk_size))
8701 while (chunk_info[i].name != NULL &&
8702 !strEqual(chunk_name, chunk_info[i].name))
8705 if (chunk_info[i].name == NULL)
8707 Warn("unknown chunk '%s' in score file '%s'",
8708 chunk_name, filename);
8710 ReadUnusedBytesFromFile(file, chunk_size);
8712 else if (chunk_info[i].size != -1 &&
8713 chunk_info[i].size != chunk_size)
8715 Warn("wrong size (%d) of chunk '%s' in score file '%s'",
8716 chunk_size, chunk_name, filename);
8718 ReadUnusedBytesFromFile(file, chunk_size);
8722 // call function to load this score chunk
8723 int chunk_size_expected =
8724 (chunk_info[i].loader)(file, chunk_size, &scores);
8726 // the size of some chunks cannot be checked before reading other
8727 // chunks first (like "HEAD" and "BODY") that contain some header
8728 // information, so check them here
8729 if (chunk_size_expected != chunk_size)
8731 Warn("wrong size (%d) of chunk '%s' in score file '%s'",
8732 chunk_size, chunk_name, filename);
8741 #if ENABLE_HISTORIC_CHUNKS
8742 void SaveScore_OLD(int nr)
8745 int permissions = (program.global_scores ? PERMS_PUBLIC : PERMS_PRIVATE);
8746 char *filename = getScoreFilename(nr);
8749 // used instead of "leveldir_current->subdir" (for network games)
8750 InitScoreDirectory(levelset.identifier);
8752 if (!(file = fopen(filename, MODE_WRITE)))
8754 Warn("cannot save score for level %d", nr);
8759 fprintf(file, "%s\n\n", SCORE_COOKIE);
8761 for (i = 0; i < MAX_SCORE_ENTRIES; i++)
8762 fprintf(file, "%d %s\n", scores.entry[i].score, scores.entry[i].name);
8766 SetFilePermissions(filename, permissions);
8770 static void SaveScore_VERS(FILE *file, struct ScoreInfo *scores)
8772 putFileVersion(file, scores->file_version);
8773 putFileVersion(file, scores->game_version);
8776 static void SaveScore_INFO(FILE *file, struct ScoreInfo *scores)
8778 int level_identifier_size = strlen(scores->level_identifier) + 1;
8781 putFile16BitBE(file, level_identifier_size);
8783 for (i = 0; i < level_identifier_size; i++)
8784 putFile8Bit(file, scores->level_identifier[i]);
8786 putFile16BitBE(file, scores->level_nr);
8787 putFile16BitBE(file, scores->num_entries);
8790 static void SaveScore_NAME(FILE *file, struct ScoreInfo *scores)
8794 for (i = 0; i < scores->num_entries; i++)
8796 int name_size = strlen(scores->entry[i].name);
8798 for (j = 0; j < MAX_PLAYER_NAME_LEN; j++)
8799 putFile8Bit(file, (j < name_size ? scores->entry[i].name[j] : 0));
8803 static void SaveScore_SCOR(FILE *file, struct ScoreInfo *scores)
8807 for (i = 0; i < scores->num_entries; i++)
8808 putFile16BitBE(file, scores->entry[i].score);
8811 static void SaveScore_TIME(FILE *file, struct ScoreInfo *scores)
8815 for (i = 0; i < scores->num_entries; i++)
8816 putFile32BitBE(file, scores->entry[i].time);
8819 static void SaveScore_TAPE(FILE *file, struct ScoreInfo *scores)
8823 for (i = 0; i < scores->num_entries; i++)
8825 int size = strlen(scores->entry[i].tape_basename);
8827 for (j = 0; j < MAX_SCORE_TAPE_BASENAME_LEN; j++)
8828 putFile8Bit(file, (j < size ? scores->entry[i].tape_basename[j] : 0));
8832 static void SaveScoreToFilename(char *filename)
8835 int permissions = (program.global_scores ? PERMS_PUBLIC : PERMS_PRIVATE);
8836 int info_chunk_size;
8837 int name_chunk_size;
8838 int scor_chunk_size;
8839 int time_chunk_size;
8840 int tape_chunk_size;
8842 if (!(file = fopen(filename, MODE_WRITE)))
8844 Warn("cannot save score file '%s'", filename);
8849 info_chunk_size = 2 + (strlen(scores.level_identifier) + 1) + 2 + 2;
8850 name_chunk_size = scores.num_entries * MAX_PLAYER_NAME_LEN;
8851 scor_chunk_size = scores.num_entries * 2;
8852 time_chunk_size = scores.num_entries * 4;
8853 tape_chunk_size = scores.num_entries * MAX_SCORE_TAPE_BASENAME_LEN;
8855 putFileChunkBE(file, "RND1", CHUNK_SIZE_UNDEFINED);
8856 putFileChunkBE(file, "SCOR", CHUNK_SIZE_NONE);
8858 putFileChunkBE(file, "VERS", SCORE_CHUNK_VERS_SIZE);
8859 SaveScore_VERS(file, &scores);
8861 putFileChunkBE(file, "INFO", info_chunk_size);
8862 SaveScore_INFO(file, &scores);
8864 putFileChunkBE(file, "NAME", name_chunk_size);
8865 SaveScore_NAME(file, &scores);
8867 putFileChunkBE(file, "SCOR", scor_chunk_size);
8868 SaveScore_SCOR(file, &scores);
8870 putFileChunkBE(file, "TIME", time_chunk_size);
8871 SaveScore_TIME(file, &scores);
8873 putFileChunkBE(file, "TAPE", tape_chunk_size);
8874 SaveScore_TAPE(file, &scores);
8878 SetFilePermissions(filename, permissions);
8881 void SaveScore(int nr)
8883 char *filename = getScoreFilename(nr);
8886 // used instead of "leveldir_current->subdir" (for network games)
8887 InitScoreDirectory(levelset.identifier);
8889 scores.file_version = FILE_VERSION_ACTUAL;
8890 scores.game_version = GAME_VERSION_ACTUAL;
8892 strncpy(scores.level_identifier, levelset.identifier, MAX_FILENAME_LEN);
8893 scores.level_identifier[MAX_FILENAME_LEN] = '\0';
8894 scores.level_nr = level_nr;
8896 for (i = 0; i < MAX_SCORE_ENTRIES; i++)
8897 if (scores.entry[i].score == 0 &&
8898 scores.entry[i].time == 0 &&
8899 strEqual(scores.entry[i].name, EMPTY_PLAYER_NAME))
8902 scores.num_entries = i;
8904 if (scores.num_entries == 0)
8907 SaveScoreToFilename(filename);
8910 static void ExecuteAsThread(SDL_ThreadFunction function, char *name, int data,
8913 static int data_static;
8917 SDL_Thread *thread = SDL_CreateThread(function, name, &data_static);
8920 SDL_DetachThread(thread);
8922 Error("Cannot create thread to %s!", error);
8924 // nasty kludge to lower probability of intermingled thread error messages
8928 static void DownloadServerScoreToCacheExt(struct HttpRequest *request,
8929 struct HttpResponse *response,
8932 request->hostname = setup.api_server_hostname;
8933 request->port = API_SERVER_PORT;
8934 request->method = API_SERVER_METHOD;
8935 request->uri = API_SERVER_URI_GET;
8937 snprintf(request->body, MAX_HTTP_BODY_SIZE,
8939 " \"levelset_identifier\": \"%s\",\n"
8940 " \"level_nr\": \"%d\",\n"
8941 " \"rate_time_over_score\": \"%d\"\n"
8943 levelset.identifier, nr, level.rate_time_over_score);
8945 if (!DoHttpRequest(request, response))
8947 Error("HTTP request failed: %s", GetHttpError());
8952 if (!HTTP_SUCCESS(response->status_code))
8954 Error("server failed to handle request: %d %s",
8955 response->status_code,
8956 response->status_text);
8961 if (response->body_size == 0)
8963 // no scores available for this level
8968 ConvertHttpResponseBodyToClientEncoding(response);
8970 char *filename = getScoreCacheFilename(nr);
8974 // used instead of "leveldir_current->subdir" (for network games)
8975 InitScoreCacheDirectory(levelset.identifier);
8977 if (!(file = fopen(filename, MODE_WRITE)))
8979 Warn("cannot save score cache file '%s'", filename);
8984 for (i = 0; i < response->body_size; i++)
8985 fputc(response->body[i], file);
8989 SetFilePermissions(filename, PERMS_PRIVATE);
8991 server_scores.updated = TRUE;
8994 static void DownloadServerScoreToCache(int nr)
8996 struct HttpRequest *request = checked_calloc(sizeof(struct HttpRequest));
8997 struct HttpResponse *response = checked_calloc(sizeof(struct HttpResponse));
8999 DownloadServerScoreToCacheExt(request, response, nr);
9001 checked_free(request);
9002 checked_free(response);
9005 static int DownloadServerScoreToCacheThread(void *data)
9007 DownloadServerScoreToCache(*(int *)data);
9012 static void DownloadServerScoreToCacheAsThread(int nr)
9014 ExecuteAsThread(DownloadServerScoreToCacheThread,
9015 "DownloadServerScoreToCache", nr,
9016 "download scores from server");
9019 static void LoadServerScoreFromCache(int nr)
9021 struct ScoreEntry score_entry;
9030 { &score_entry.score, FALSE, 0 },
9031 { &score_entry.time, FALSE, 0 },
9032 { score_entry.name, TRUE, MAX_PLAYER_NAME_LEN },
9033 { score_entry.tape_basename, TRUE, MAX_FILENAME_LEN },
9037 char *filename = getScoreCacheFilename(nr);
9038 SetupFileHash *score_hash = loadSetupFileHash(filename);
9041 server_scores.num_entries = 0;
9043 if (score_hash == NULL)
9046 for (i = 0; i < MAX_SCORE_ENTRIES; i++)
9048 score_entry = server_scores.entry[i];
9050 for (j = 0; score_mapping[j].value != NULL; j++)
9054 sprintf(token, "%02d.%d", i, j);
9056 char *value = getHashEntry(score_hash, token);
9061 if (score_mapping[j].is_string)
9063 char *score_value = (char *)score_mapping[j].value;
9064 int value_size = score_mapping[j].string_size;
9066 strncpy(score_value, value, value_size);
9067 score_value[value_size] = '\0';
9071 int *score_value = (int *)score_mapping[j].value;
9073 *score_value = atoi(value);
9076 server_scores.num_entries = i + 1;
9079 server_scores.entry[i] = score_entry;
9082 freeSetupFileHash(score_hash);
9085 void LoadServerScore(int nr, boolean download_score)
9087 if (!setup.api_server)
9090 // always start with reliable default values
9091 setServerScoreInfoToDefaults();
9093 // 1st step: load server scores from cache file (which may not exist)
9094 // (this should prevent reading it while the thread is writing to it)
9095 LoadServerScoreFromCache(nr);
9097 if (download_score && runtime.api_server)
9099 // 2nd step: download server scores from score server to cache file
9100 // (as thread, as it might time out if the server is not reachable)
9101 DownloadServerScoreToCacheAsThread(nr);
9105 static char *get_file_base64(char *filename)
9107 struct stat file_status;
9109 if (stat(filename, &file_status) != 0)
9111 Error("cannot stat file '%s'\n", filename);
9116 int buffer_size = file_status.st_size;
9117 byte *buffer = checked_malloc(buffer_size);
9121 if (!(file = fopen(filename, MODE_READ)))
9123 Error("cannot open file '%s'\n", filename);
9125 checked_free(buffer);
9130 for (i = 0; i < buffer_size; i++)
9132 int c = fgetc(file);
9136 Error("cannot read from input file '%s'\n", filename);
9139 checked_free(buffer);
9144 buffer[i] = (byte)c;
9149 int buffer_encoded_size = base64_encoded_size(buffer_size);
9150 char *buffer_encoded = checked_malloc(buffer_encoded_size);
9152 base64_encode(buffer_encoded, buffer, buffer_size);
9154 checked_free(buffer);
9156 return buffer_encoded;
9159 static void UploadScoreToServerExt(struct HttpRequest *request,
9160 struct HttpResponse *response,
9163 struct ScoreEntry *score_entry = &scores.entry[scores.last_added];
9165 request->hostname = setup.api_server_hostname;
9166 request->port = API_SERVER_PORT;
9167 request->method = API_SERVER_METHOD;
9168 request->uri = API_SERVER_URI_ADD;
9170 char *tape_filename = getScoreTapeFilename(score_entry->tape_basename, nr);
9171 char *tape_base64 = get_file_base64(tape_filename);
9173 if (tape_base64 == NULL)
9175 Error("loading and base64 encoding score tape file failed");
9180 snprintf(request->body, MAX_HTTP_BODY_SIZE,
9182 " \"game_version\": \"%s\",\n"
9183 " \"levelset_identifier\": \"%s\",\n"
9184 " \"levelset_name\": \"%s\",\n"
9185 " \"levelset_author\": \"%s\",\n"
9186 " \"levelset_num_levels\": \"%d\",\n"
9187 " \"levelset_first_level\": \"%d\",\n"
9188 " \"level_nr\": \"%d\",\n"
9189 " \"player_name\": \"%s\",\n"
9190 " \"score\": \"%d\",\n"
9191 " \"time\": \"%d\",\n"
9192 " \"tape_basename\": \"%s\",\n"
9193 " \"tape\": \"%s\"\n"
9195 getProgramRealVersionString(),
9196 leveldir_current->identifier,
9197 leveldir_current->name,
9198 leveldir_current->author,
9199 leveldir_current->levels,
9200 leveldir_current->first_level,
9205 score_entry->tape_basename,
9208 checked_free(tape_base64);
9210 ConvertHttpRequestBodyToServerEncoding(request);
9212 if (!DoHttpRequest(request, response))
9214 Error("HTTP request failed: %s", GetHttpError());
9219 if (!HTTP_SUCCESS(response->status_code))
9221 Error("server failed to handle request: %d %s",
9222 response->status_code,
9223 response->status_text);
9229 static void UploadScoreToServer(int nr)
9231 struct HttpRequest *request = checked_calloc(sizeof(struct HttpRequest));
9232 struct HttpResponse *response = checked_calloc(sizeof(struct HttpResponse));
9234 UploadScoreToServerExt(request, response, nr);
9236 checked_free(request);
9237 checked_free(response);
9240 static int UploadScoreToServerThread(void *data)
9242 UploadScoreToServer(*(int *)data);
9247 static void UploadScoreToServerAsThread(int nr)
9249 ExecuteAsThread(UploadScoreToServerThread,
9250 "UploadScoreToServer", nr,
9251 "upload score to server");
9254 void SaveServerScore(int nr)
9256 if (!runtime.api_server)
9259 UploadScoreToServerAsThread(nr);
9262 void LoadLocalAndServerScore(int nr, boolean download_score)
9264 int last_added_local = scores.last_added_local;
9268 // restore last added local score entry (before merging server scores)
9269 scores.last_added = scores.last_added_local = last_added_local;
9271 if (setup.api_server)
9273 // load server scores from cache file and trigger update from server
9274 LoadServerScore(nr, download_score);
9276 // merge local scores with scores from server
9282 // ============================================================================
9283 // setup file functions
9284 // ============================================================================
9286 #define TOKEN_STR_PLAYER_PREFIX "player_"
9289 static struct TokenInfo global_setup_tokens[] =
9293 &setup.player_name, "player_name"
9297 &setup.multiple_users, "multiple_users"
9301 &setup.sound, "sound"
9305 &setup.sound_loops, "repeating_sound_loops"
9309 &setup.sound_music, "background_music"
9313 &setup.sound_simple, "simple_sound_effects"
9317 &setup.toons, "toons"
9321 &setup.scroll_delay, "scroll_delay"
9325 &setup.forced_scroll_delay, "forced_scroll_delay"
9329 &setup.scroll_delay_value, "scroll_delay_value"
9333 &setup.engine_snapshot_mode, "engine_snapshot_mode"
9337 &setup.engine_snapshot_memory, "engine_snapshot_memory"
9341 &setup.fade_screens, "fade_screens"
9345 &setup.autorecord, "automatic_tape_recording"
9349 &setup.show_titlescreen, "show_titlescreen"
9353 &setup.quick_doors, "quick_doors"
9357 &setup.team_mode, "team_mode"
9361 &setup.handicap, "handicap"
9365 &setup.skip_levels, "skip_levels"
9369 &setup.increment_levels, "increment_levels"
9373 &setup.auto_play_next_level, "auto_play_next_level"
9377 &setup.count_score_after_game, "count_score_after_game"
9381 &setup.show_scores_after_game, "show_scores_after_game"
9385 &setup.time_limit, "time_limit"
9389 &setup.fullscreen, "fullscreen"
9393 &setup.window_scaling_percent, "window_scaling_percent"
9397 &setup.window_scaling_quality, "window_scaling_quality"
9401 &setup.screen_rendering_mode, "screen_rendering_mode"
9405 &setup.vsync_mode, "vsync_mode"
9409 &setup.ask_on_escape, "ask_on_escape"
9413 &setup.ask_on_escape_editor, "ask_on_escape_editor"
9417 &setup.ask_on_game_over, "ask_on_game_over"
9421 &setup.ask_on_quit_game, "ask_on_quit_game"
9425 &setup.ask_on_quit_program, "ask_on_quit_program"
9429 &setup.quick_switch, "quick_player_switch"
9433 &setup.input_on_focus, "input_on_focus"
9437 &setup.prefer_aga_graphics, "prefer_aga_graphics"
9441 &setup.prefer_lowpass_sounds, "prefer_lowpass_sounds"
9445 &setup.prefer_extra_panel_items, "prefer_extra_panel_items"
9449 &setup.game_speed_extended, "game_speed_extended"
9453 &setup.game_frame_delay, "game_frame_delay"
9457 &setup.sp_show_border_elements, "sp_show_border_elements"
9461 &setup.small_game_graphics, "small_game_graphics"
9465 &setup.show_snapshot_buttons, "show_snapshot_buttons"
9469 &setup.graphics_set, "graphics_set"
9473 &setup.sounds_set, "sounds_set"
9477 &setup.music_set, "music_set"
9481 &setup.override_level_graphics, "override_level_graphics"
9485 &setup.override_level_sounds, "override_level_sounds"
9489 &setup.override_level_music, "override_level_music"
9493 &setup.volume_simple, "volume_simple"
9497 &setup.volume_loops, "volume_loops"
9501 &setup.volume_music, "volume_music"
9505 &setup.network_mode, "network_mode"
9509 &setup.network_player_nr, "network_player"
9513 &setup.network_server_hostname, "network_server_hostname"
9517 &setup.api_server, "api_server"
9521 &setup.api_server_hostname, "api_server_hostname"
9525 &setup.touch.control_type, "touch.control_type"
9529 &setup.touch.move_distance, "touch.move_distance"
9533 &setup.touch.drop_distance, "touch.drop_distance"
9537 &setup.touch.transparency, "touch.transparency"
9541 &setup.touch.draw_outlined, "touch.draw_outlined"
9545 &setup.touch.draw_pressed, "touch.draw_pressed"
9549 &setup.touch.grid_xsize[0], "touch.virtual_buttons.0.xsize"
9553 &setup.touch.grid_ysize[0], "touch.virtual_buttons.0.ysize"
9557 &setup.touch.grid_xsize[1], "touch.virtual_buttons.1.xsize"
9561 &setup.touch.grid_ysize[1], "touch.virtual_buttons.1.ysize"
9565 static struct TokenInfo auto_setup_tokens[] =
9569 &setup.auto_setup.editor_zoom_tilesize, "editor.zoom_tilesize"
9573 static struct TokenInfo editor_setup_tokens[] =
9577 &setup.editor.el_classic, "editor.el_classic"
9581 &setup.editor.el_custom, "editor.el_custom"
9585 &setup.editor.el_user_defined, "editor.el_user_defined"
9589 &setup.editor.el_dynamic, "editor.el_dynamic"
9593 &setup.editor.el_headlines, "editor.el_headlines"
9597 &setup.editor.show_element_token, "editor.show_element_token"
9601 &setup.editor.show_read_only_warning, "editor.show_read_only_warning"
9605 static struct TokenInfo editor_cascade_setup_tokens[] =
9609 &setup.editor_cascade.el_bd, "editor.cascade.el_bd"
9613 &setup.editor_cascade.el_em, "editor.cascade.el_em"
9617 &setup.editor_cascade.el_emc, "editor.cascade.el_emc"
9621 &setup.editor_cascade.el_rnd, "editor.cascade.el_rnd"
9625 &setup.editor_cascade.el_sb, "editor.cascade.el_sb"
9629 &setup.editor_cascade.el_sp, "editor.cascade.el_sp"
9633 &setup.editor_cascade.el_dc, "editor.cascade.el_dc"
9637 &setup.editor_cascade.el_dx, "editor.cascade.el_dx"
9641 &setup.editor_cascade.el_mm, "editor.cascade.el_mm"
9645 &setup.editor_cascade.el_df, "editor.cascade.el_df"
9649 &setup.editor_cascade.el_chars, "editor.cascade.el_chars"
9653 &setup.editor_cascade.el_steel_chars, "editor.cascade.el_steel_chars"
9657 &setup.editor_cascade.el_ce, "editor.cascade.el_ce"
9661 &setup.editor_cascade.el_ge, "editor.cascade.el_ge"
9665 &setup.editor_cascade.el_ref, "editor.cascade.el_ref"
9669 &setup.editor_cascade.el_user, "editor.cascade.el_user"
9673 &setup.editor_cascade.el_dynamic, "editor.cascade.el_dynamic"
9677 static struct TokenInfo shortcut_setup_tokens[] =
9681 &setup.shortcut.save_game, "shortcut.save_game"
9685 &setup.shortcut.load_game, "shortcut.load_game"
9689 &setup.shortcut.toggle_pause, "shortcut.toggle_pause"
9693 &setup.shortcut.focus_player[0], "shortcut.focus_player_1"
9697 &setup.shortcut.focus_player[1], "shortcut.focus_player_2"
9701 &setup.shortcut.focus_player[2], "shortcut.focus_player_3"
9705 &setup.shortcut.focus_player[3], "shortcut.focus_player_4"
9709 &setup.shortcut.focus_player_all, "shortcut.focus_player_all"
9713 &setup.shortcut.tape_eject, "shortcut.tape_eject"
9717 &setup.shortcut.tape_extra, "shortcut.tape_extra"
9721 &setup.shortcut.tape_stop, "shortcut.tape_stop"
9725 &setup.shortcut.tape_pause, "shortcut.tape_pause"
9729 &setup.shortcut.tape_record, "shortcut.tape_record"
9733 &setup.shortcut.tape_play, "shortcut.tape_play"
9737 &setup.shortcut.sound_simple, "shortcut.sound_simple"
9741 &setup.shortcut.sound_loops, "shortcut.sound_loops"
9745 &setup.shortcut.sound_music, "shortcut.sound_music"
9749 &setup.shortcut.snap_left, "shortcut.snap_left"
9753 &setup.shortcut.snap_right, "shortcut.snap_right"
9757 &setup.shortcut.snap_up, "shortcut.snap_up"
9761 &setup.shortcut.snap_down, "shortcut.snap_down"
9765 static struct SetupInputInfo setup_input;
9766 static struct TokenInfo player_setup_tokens[] =
9770 &setup_input.use_joystick, ".use_joystick"
9774 &setup_input.joy.device_name, ".joy.device_name"
9778 &setup_input.joy.xleft, ".joy.xleft"
9782 &setup_input.joy.xmiddle, ".joy.xmiddle"
9786 &setup_input.joy.xright, ".joy.xright"
9790 &setup_input.joy.yupper, ".joy.yupper"
9794 &setup_input.joy.ymiddle, ".joy.ymiddle"
9798 &setup_input.joy.ylower, ".joy.ylower"
9802 &setup_input.joy.snap, ".joy.snap_field"
9806 &setup_input.joy.drop, ".joy.place_bomb"
9810 &setup_input.key.left, ".key.move_left"
9814 &setup_input.key.right, ".key.move_right"
9818 &setup_input.key.up, ".key.move_up"
9822 &setup_input.key.down, ".key.move_down"
9826 &setup_input.key.snap, ".key.snap_field"
9830 &setup_input.key.drop, ".key.place_bomb"
9834 static struct TokenInfo system_setup_tokens[] =
9838 &setup.system.sdl_renderdriver, "system.sdl_renderdriver"
9842 &setup.system.sdl_videodriver, "system.sdl_videodriver"
9846 &setup.system.sdl_audiodriver, "system.sdl_audiodriver"
9850 &setup.system.audio_fragment_size, "system.audio_fragment_size"
9854 static struct TokenInfo internal_setup_tokens[] =
9858 &setup.internal.program_title, "program_title"
9862 &setup.internal.program_version, "program_version"
9866 &setup.internal.program_author, "program_author"
9870 &setup.internal.program_email, "program_email"
9874 &setup.internal.program_website, "program_website"
9878 &setup.internal.program_copyright, "program_copyright"
9882 &setup.internal.program_company, "program_company"
9886 &setup.internal.program_icon_file, "program_icon_file"
9890 &setup.internal.default_graphics_set, "default_graphics_set"
9894 &setup.internal.default_sounds_set, "default_sounds_set"
9898 &setup.internal.default_music_set, "default_music_set"
9902 &setup.internal.fallback_graphics_file, "fallback_graphics_file"
9906 &setup.internal.fallback_sounds_file, "fallback_sounds_file"
9910 &setup.internal.fallback_music_file, "fallback_music_file"
9914 &setup.internal.default_level_series, "default_level_series"
9918 &setup.internal.default_window_width, "default_window_width"
9922 &setup.internal.default_window_height, "default_window_height"
9926 &setup.internal.choose_from_top_leveldir, "choose_from_top_leveldir"
9930 &setup.internal.show_scaling_in_title, "show_scaling_in_title"
9934 &setup.internal.create_user_levelset, "create_user_levelset"
9938 &setup.internal.menu_game, "menu_game"
9942 &setup.internal.menu_editor, "menu_editor"
9946 &setup.internal.menu_graphics, "menu_graphics"
9950 &setup.internal.menu_sound, "menu_sound"
9954 &setup.internal.menu_artwork, "menu_artwork"
9958 &setup.internal.menu_input, "menu_input"
9962 &setup.internal.menu_touch, "menu_touch"
9966 &setup.internal.menu_shortcuts, "menu_shortcuts"
9970 &setup.internal.menu_exit, "menu_exit"
9974 &setup.internal.menu_save_and_exit, "menu_save_and_exit"
9978 static struct TokenInfo debug_setup_tokens[] =
9982 &setup.debug.frame_delay[0], "debug.frame_delay_0"
9986 &setup.debug.frame_delay[1], "debug.frame_delay_1"
9990 &setup.debug.frame_delay[2], "debug.frame_delay_2"
9994 &setup.debug.frame_delay[3], "debug.frame_delay_3"
9998 &setup.debug.frame_delay[4], "debug.frame_delay_4"
10002 &setup.debug.frame_delay[5], "debug.frame_delay_5"
10006 &setup.debug.frame_delay[6], "debug.frame_delay_6"
10010 &setup.debug.frame_delay[7], "debug.frame_delay_7"
10014 &setup.debug.frame_delay[8], "debug.frame_delay_8"
10018 &setup.debug.frame_delay[9], "debug.frame_delay_9"
10022 &setup.debug.frame_delay_key[0], "debug.key.frame_delay_0"
10026 &setup.debug.frame_delay_key[1], "debug.key.frame_delay_1"
10030 &setup.debug.frame_delay_key[2], "debug.key.frame_delay_2"
10034 &setup.debug.frame_delay_key[3], "debug.key.frame_delay_3"
10038 &setup.debug.frame_delay_key[4], "debug.key.frame_delay_4"
10042 &setup.debug.frame_delay_key[5], "debug.key.frame_delay_5"
10046 &setup.debug.frame_delay_key[6], "debug.key.frame_delay_6"
10050 &setup.debug.frame_delay_key[7], "debug.key.frame_delay_7"
10054 &setup.debug.frame_delay_key[8], "debug.key.frame_delay_8"
10058 &setup.debug.frame_delay_key[9], "debug.key.frame_delay_9"
10062 &setup.debug.frame_delay_use_mod_key, "debug.frame_delay.use_mod_key"},
10065 &setup.debug.frame_delay_game_only, "debug.frame_delay.game_only"
10069 &setup.debug.show_frames_per_second, "debug.show_frames_per_second"
10073 &setup.debug.xsn_mode, "debug.xsn_mode"
10077 &setup.debug.xsn_percent, "debug.xsn_percent"
10081 static struct TokenInfo options_setup_tokens[] =
10085 &setup.options.verbose, "options.verbose"
10089 static void setSetupInfoToDefaults(struct SetupInfo *si)
10093 si->player_name = getStringCopy(getDefaultUserName(user.nr));
10095 si->multiple_users = TRUE;
10098 si->sound_loops = TRUE;
10099 si->sound_music = TRUE;
10100 si->sound_simple = TRUE;
10102 si->scroll_delay = TRUE;
10103 si->forced_scroll_delay = FALSE;
10104 si->scroll_delay_value = STD_SCROLL_DELAY;
10105 si->engine_snapshot_mode = getStringCopy(STR_SNAPSHOT_MODE_DEFAULT);
10106 si->engine_snapshot_memory = SNAPSHOT_MEMORY_DEFAULT;
10107 si->fade_screens = TRUE;
10108 si->autorecord = TRUE;
10109 si->show_titlescreen = TRUE;
10110 si->quick_doors = FALSE;
10111 si->team_mode = FALSE;
10112 si->handicap = TRUE;
10113 si->skip_levels = TRUE;
10114 si->increment_levels = TRUE;
10115 si->auto_play_next_level = TRUE;
10116 si->count_score_after_game = TRUE;
10117 si->show_scores_after_game = TRUE;
10118 si->time_limit = TRUE;
10119 si->fullscreen = FALSE;
10120 si->window_scaling_percent = STD_WINDOW_SCALING_PERCENT;
10121 si->window_scaling_quality = getStringCopy(SCALING_QUALITY_DEFAULT);
10122 si->screen_rendering_mode = getStringCopy(STR_SPECIAL_RENDERING_DEFAULT);
10123 si->vsync_mode = getStringCopy(STR_VSYNC_MODE_DEFAULT);
10124 si->ask_on_escape = TRUE;
10125 si->ask_on_escape_editor = TRUE;
10126 si->ask_on_game_over = TRUE;
10127 si->ask_on_quit_game = TRUE;
10128 si->ask_on_quit_program = TRUE;
10129 si->quick_switch = FALSE;
10130 si->input_on_focus = FALSE;
10131 si->prefer_aga_graphics = TRUE;
10132 si->prefer_lowpass_sounds = FALSE;
10133 si->prefer_extra_panel_items = TRUE;
10134 si->game_speed_extended = FALSE;
10135 si->game_frame_delay = GAME_FRAME_DELAY;
10136 si->sp_show_border_elements = FALSE;
10137 si->small_game_graphics = FALSE;
10138 si->show_snapshot_buttons = FALSE;
10140 si->graphics_set = getStringCopy(GFX_CLASSIC_SUBDIR);
10141 si->sounds_set = getStringCopy(SND_CLASSIC_SUBDIR);
10142 si->music_set = getStringCopy(MUS_CLASSIC_SUBDIR);
10144 si->override_level_graphics = FALSE;
10145 si->override_level_sounds = FALSE;
10146 si->override_level_music = FALSE;
10148 si->volume_simple = 100; // percent
10149 si->volume_loops = 100; // percent
10150 si->volume_music = 100; // percent
10152 si->network_mode = FALSE;
10153 si->network_player_nr = 0; // first player
10154 si->network_server_hostname = getStringCopy(STR_NETWORK_AUTO_DETECT);
10156 si->api_server = TRUE;
10157 si->api_server_hostname = getStringCopy(API_SERVER_HOSTNAME);
10159 si->touch.control_type = getStringCopy(TOUCH_CONTROL_DEFAULT);
10160 si->touch.move_distance = TOUCH_MOVE_DISTANCE_DEFAULT; // percent
10161 si->touch.drop_distance = TOUCH_DROP_DISTANCE_DEFAULT; // percent
10162 si->touch.transparency = TOUCH_TRANSPARENCY_DEFAULT; // percent
10163 si->touch.draw_outlined = TRUE;
10164 si->touch.draw_pressed = TRUE;
10166 for (i = 0; i < 2; i++)
10168 char *default_grid_button[6][2] =
10174 { "111222", " vv " },
10175 { "111222", " vv " }
10177 int grid_xsize = DEFAULT_GRID_XSIZE(i);
10178 int grid_ysize = DEFAULT_GRID_YSIZE(i);
10179 int min_xsize = MIN(6, grid_xsize);
10180 int min_ysize = MIN(6, grid_ysize);
10181 int startx = grid_xsize - min_xsize;
10182 int starty = grid_ysize - min_ysize;
10185 // virtual buttons grid can only be set to defaults if video is initialized
10186 // (this will be repeated if virtual buttons are not loaded from setup file)
10187 if (video.initialized)
10189 si->touch.grid_xsize[i] = grid_xsize;
10190 si->touch.grid_ysize[i] = grid_ysize;
10194 si->touch.grid_xsize[i] = -1;
10195 si->touch.grid_ysize[i] = -1;
10198 for (x = 0; x < MAX_GRID_XSIZE; x++)
10199 for (y = 0; y < MAX_GRID_YSIZE; y++)
10200 si->touch.grid_button[i][x][y] = CHAR_GRID_BUTTON_NONE;
10202 for (x = 0; x < min_xsize; x++)
10203 for (y = 0; y < min_ysize; y++)
10204 si->touch.grid_button[i][x][starty + y] =
10205 default_grid_button[y][0][x];
10207 for (x = 0; x < min_xsize; x++)
10208 for (y = 0; y < min_ysize; y++)
10209 si->touch.grid_button[i][startx + x][starty + y] =
10210 default_grid_button[y][1][x];
10213 si->touch.grid_initialized = video.initialized;
10215 si->editor.el_boulderdash = TRUE;
10216 si->editor.el_emerald_mine = TRUE;
10217 si->editor.el_emerald_mine_club = TRUE;
10218 si->editor.el_more = TRUE;
10219 si->editor.el_sokoban = TRUE;
10220 si->editor.el_supaplex = TRUE;
10221 si->editor.el_diamond_caves = TRUE;
10222 si->editor.el_dx_boulderdash = TRUE;
10224 si->editor.el_mirror_magic = TRUE;
10225 si->editor.el_deflektor = TRUE;
10227 si->editor.el_chars = TRUE;
10228 si->editor.el_steel_chars = TRUE;
10230 si->editor.el_classic = TRUE;
10231 si->editor.el_custom = TRUE;
10233 si->editor.el_user_defined = FALSE;
10234 si->editor.el_dynamic = TRUE;
10236 si->editor.el_headlines = TRUE;
10238 si->editor.show_element_token = FALSE;
10240 si->editor.show_read_only_warning = TRUE;
10242 si->editor.use_template_for_new_levels = TRUE;
10244 si->shortcut.save_game = DEFAULT_KEY_SAVE_GAME;
10245 si->shortcut.load_game = DEFAULT_KEY_LOAD_GAME;
10246 si->shortcut.toggle_pause = DEFAULT_KEY_TOGGLE_PAUSE;
10248 si->shortcut.focus_player[0] = DEFAULT_KEY_FOCUS_PLAYER_1;
10249 si->shortcut.focus_player[1] = DEFAULT_KEY_FOCUS_PLAYER_2;
10250 si->shortcut.focus_player[2] = DEFAULT_KEY_FOCUS_PLAYER_3;
10251 si->shortcut.focus_player[3] = DEFAULT_KEY_FOCUS_PLAYER_4;
10252 si->shortcut.focus_player_all = DEFAULT_KEY_FOCUS_PLAYER_ALL;
10254 si->shortcut.tape_eject = DEFAULT_KEY_TAPE_EJECT;
10255 si->shortcut.tape_extra = DEFAULT_KEY_TAPE_EXTRA;
10256 si->shortcut.tape_stop = DEFAULT_KEY_TAPE_STOP;
10257 si->shortcut.tape_pause = DEFAULT_KEY_TAPE_PAUSE;
10258 si->shortcut.tape_record = DEFAULT_KEY_TAPE_RECORD;
10259 si->shortcut.tape_play = DEFAULT_KEY_TAPE_PLAY;
10261 si->shortcut.sound_simple = DEFAULT_KEY_SOUND_SIMPLE;
10262 si->shortcut.sound_loops = DEFAULT_KEY_SOUND_LOOPS;
10263 si->shortcut.sound_music = DEFAULT_KEY_SOUND_MUSIC;
10265 si->shortcut.snap_left = DEFAULT_KEY_SNAP_LEFT;
10266 si->shortcut.snap_right = DEFAULT_KEY_SNAP_RIGHT;
10267 si->shortcut.snap_up = DEFAULT_KEY_SNAP_UP;
10268 si->shortcut.snap_down = DEFAULT_KEY_SNAP_DOWN;
10270 for (i = 0; i < MAX_PLAYERS; i++)
10272 si->input[i].use_joystick = FALSE;
10273 si->input[i].joy.device_name=getStringCopy(getDeviceNameFromJoystickNr(i));
10274 si->input[i].joy.xleft = JOYSTICK_XLEFT;
10275 si->input[i].joy.xmiddle = JOYSTICK_XMIDDLE;
10276 si->input[i].joy.xright = JOYSTICK_XRIGHT;
10277 si->input[i].joy.yupper = JOYSTICK_YUPPER;
10278 si->input[i].joy.ymiddle = JOYSTICK_YMIDDLE;
10279 si->input[i].joy.ylower = JOYSTICK_YLOWER;
10280 si->input[i].joy.snap = (i == 0 ? JOY_BUTTON_1 : 0);
10281 si->input[i].joy.drop = (i == 0 ? JOY_BUTTON_2 : 0);
10282 si->input[i].key.left = (i == 0 ? DEFAULT_KEY_LEFT : KSYM_UNDEFINED);
10283 si->input[i].key.right = (i == 0 ? DEFAULT_KEY_RIGHT : KSYM_UNDEFINED);
10284 si->input[i].key.up = (i == 0 ? DEFAULT_KEY_UP : KSYM_UNDEFINED);
10285 si->input[i].key.down = (i == 0 ? DEFAULT_KEY_DOWN : KSYM_UNDEFINED);
10286 si->input[i].key.snap = (i == 0 ? DEFAULT_KEY_SNAP : KSYM_UNDEFINED);
10287 si->input[i].key.drop = (i == 0 ? DEFAULT_KEY_DROP : KSYM_UNDEFINED);
10290 si->system.sdl_renderdriver = getStringCopy(ARG_DEFAULT);
10291 si->system.sdl_videodriver = getStringCopy(ARG_DEFAULT);
10292 si->system.sdl_audiodriver = getStringCopy(ARG_DEFAULT);
10293 si->system.audio_fragment_size = DEFAULT_AUDIO_FRAGMENT_SIZE;
10295 si->internal.program_title = getStringCopy(PROGRAM_TITLE_STRING);
10296 si->internal.program_version = getStringCopy(getProgramRealVersionString());
10297 si->internal.program_author = getStringCopy(PROGRAM_AUTHOR_STRING);
10298 si->internal.program_email = getStringCopy(PROGRAM_EMAIL_STRING);
10299 si->internal.program_website = getStringCopy(PROGRAM_WEBSITE_STRING);
10300 si->internal.program_copyright = getStringCopy(PROGRAM_COPYRIGHT_STRING);
10301 si->internal.program_company = getStringCopy(PROGRAM_COMPANY_STRING);
10303 si->internal.program_icon_file = getStringCopy(PROGRAM_ICON_FILENAME);
10305 si->internal.default_graphics_set = getStringCopy(GFX_CLASSIC_SUBDIR);
10306 si->internal.default_sounds_set = getStringCopy(SND_CLASSIC_SUBDIR);
10307 si->internal.default_music_set = getStringCopy(MUS_CLASSIC_SUBDIR);
10309 si->internal.fallback_graphics_file = getStringCopy(UNDEFINED_FILENAME);
10310 si->internal.fallback_sounds_file = getStringCopy(UNDEFINED_FILENAME);
10311 si->internal.fallback_music_file = getStringCopy(UNDEFINED_FILENAME);
10313 si->internal.default_level_series = getStringCopy(UNDEFINED_LEVELSET);
10314 si->internal.choose_from_top_leveldir = FALSE;
10315 si->internal.show_scaling_in_title = TRUE;
10316 si->internal.create_user_levelset = TRUE;
10318 si->internal.default_window_width = WIN_XSIZE_DEFAULT;
10319 si->internal.default_window_height = WIN_YSIZE_DEFAULT;
10321 si->debug.frame_delay[0] = DEFAULT_FRAME_DELAY_0;
10322 si->debug.frame_delay[1] = DEFAULT_FRAME_DELAY_1;
10323 si->debug.frame_delay[2] = DEFAULT_FRAME_DELAY_2;
10324 si->debug.frame_delay[3] = DEFAULT_FRAME_DELAY_3;
10325 si->debug.frame_delay[4] = DEFAULT_FRAME_DELAY_4;
10326 si->debug.frame_delay[5] = DEFAULT_FRAME_DELAY_5;
10327 si->debug.frame_delay[6] = DEFAULT_FRAME_DELAY_6;
10328 si->debug.frame_delay[7] = DEFAULT_FRAME_DELAY_7;
10329 si->debug.frame_delay[8] = DEFAULT_FRAME_DELAY_8;
10330 si->debug.frame_delay[9] = DEFAULT_FRAME_DELAY_9;
10332 si->debug.frame_delay_key[0] = DEFAULT_KEY_FRAME_DELAY_0;
10333 si->debug.frame_delay_key[1] = DEFAULT_KEY_FRAME_DELAY_1;
10334 si->debug.frame_delay_key[2] = DEFAULT_KEY_FRAME_DELAY_2;
10335 si->debug.frame_delay_key[3] = DEFAULT_KEY_FRAME_DELAY_3;
10336 si->debug.frame_delay_key[4] = DEFAULT_KEY_FRAME_DELAY_4;
10337 si->debug.frame_delay_key[5] = DEFAULT_KEY_FRAME_DELAY_5;
10338 si->debug.frame_delay_key[6] = DEFAULT_KEY_FRAME_DELAY_6;
10339 si->debug.frame_delay_key[7] = DEFAULT_KEY_FRAME_DELAY_7;
10340 si->debug.frame_delay_key[8] = DEFAULT_KEY_FRAME_DELAY_8;
10341 si->debug.frame_delay_key[9] = DEFAULT_KEY_FRAME_DELAY_9;
10343 si->debug.frame_delay_use_mod_key = DEFAULT_FRAME_DELAY_USE_MOD_KEY;
10344 si->debug.frame_delay_game_only = DEFAULT_FRAME_DELAY_GAME_ONLY;
10346 si->debug.show_frames_per_second = FALSE;
10348 si->debug.xsn_mode = AUTO;
10349 si->debug.xsn_percent = 0;
10351 si->options.verbose = FALSE;
10353 #if defined(PLATFORM_ANDROID)
10354 si->fullscreen = TRUE;
10357 setHideSetupEntry(&setup.debug.xsn_mode);
10360 static void setSetupInfoToDefaults_AutoSetup(struct SetupInfo *si)
10362 si->auto_setup.editor_zoom_tilesize = MINI_TILESIZE;
10365 static void setSetupInfoToDefaults_EditorCascade(struct SetupInfo *si)
10367 si->editor_cascade.el_bd = TRUE;
10368 si->editor_cascade.el_em = TRUE;
10369 si->editor_cascade.el_emc = TRUE;
10370 si->editor_cascade.el_rnd = TRUE;
10371 si->editor_cascade.el_sb = TRUE;
10372 si->editor_cascade.el_sp = TRUE;
10373 si->editor_cascade.el_dc = TRUE;
10374 si->editor_cascade.el_dx = TRUE;
10376 si->editor_cascade.el_mm = TRUE;
10377 si->editor_cascade.el_df = TRUE;
10379 si->editor_cascade.el_chars = FALSE;
10380 si->editor_cascade.el_steel_chars = FALSE;
10381 si->editor_cascade.el_ce = FALSE;
10382 si->editor_cascade.el_ge = FALSE;
10383 si->editor_cascade.el_ref = FALSE;
10384 si->editor_cascade.el_user = FALSE;
10385 si->editor_cascade.el_dynamic = FALSE;
10388 #define MAX_HIDE_SETUP_TOKEN_SIZE 20
10390 static char *getHideSetupToken(void *setup_value)
10392 static char hide_setup_token[MAX_HIDE_SETUP_TOKEN_SIZE];
10394 if (setup_value != NULL)
10395 snprintf(hide_setup_token, MAX_HIDE_SETUP_TOKEN_SIZE, "%p", setup_value);
10397 return hide_setup_token;
10400 void setHideSetupEntry(void *setup_value)
10402 char *hide_setup_token = getHideSetupToken(setup_value);
10404 if (hide_setup_hash == NULL)
10405 hide_setup_hash = newSetupFileHash();
10407 if (setup_value != NULL)
10408 setHashEntry(hide_setup_hash, hide_setup_token, "");
10411 void removeHideSetupEntry(void *setup_value)
10413 char *hide_setup_token = getHideSetupToken(setup_value);
10415 if (setup_value != NULL)
10416 removeHashEntry(hide_setup_hash, hide_setup_token);
10419 boolean hideSetupEntry(void *setup_value)
10421 char *hide_setup_token = getHideSetupToken(setup_value);
10423 return (setup_value != NULL &&
10424 getHashEntry(hide_setup_hash, hide_setup_token) != NULL);
10427 static void setSetupInfoFromTokenText(SetupFileHash *setup_file_hash,
10428 struct TokenInfo *token_info,
10429 int token_nr, char *token_text)
10431 char *token_hide_text = getStringCat2(token_text, ".hide");
10432 char *token_hide_value = getHashEntry(setup_file_hash, token_hide_text);
10434 // set the value of this setup option in the setup option structure
10435 setSetupInfo(token_info, token_nr, getHashEntry(setup_file_hash, token_text));
10437 // check if this setup option should be hidden in the setup menu
10438 if (token_hide_value != NULL && get_boolean_from_string(token_hide_value))
10439 setHideSetupEntry(token_info[token_nr].value);
10441 free(token_hide_text);
10444 static void setSetupInfoFromTokenInfo(SetupFileHash *setup_file_hash,
10445 struct TokenInfo *token_info,
10448 setSetupInfoFromTokenText(setup_file_hash, token_info, token_nr,
10449 token_info[token_nr].text);
10452 static void decodeSetupFileHash(SetupFileHash *setup_file_hash)
10456 if (!setup_file_hash)
10459 for (i = 0; i < ARRAY_SIZE(global_setup_tokens); i++)
10460 setSetupInfoFromTokenInfo(setup_file_hash, global_setup_tokens, i);
10462 setup.touch.grid_initialized = TRUE;
10463 for (i = 0; i < 2; i++)
10465 int grid_xsize = setup.touch.grid_xsize[i];
10466 int grid_ysize = setup.touch.grid_ysize[i];
10469 // if virtual buttons are not loaded from setup file, repeat initializing
10470 // virtual buttons grid with default values later when video is initialized
10471 if (grid_xsize == -1 ||
10474 setup.touch.grid_initialized = FALSE;
10479 for (y = 0; y < grid_ysize; y++)
10481 char token_string[MAX_LINE_LEN];
10483 sprintf(token_string, "touch.virtual_buttons.%d.%02d", i, y);
10485 char *value_string = getHashEntry(setup_file_hash, token_string);
10487 if (value_string == NULL)
10490 for (x = 0; x < grid_xsize; x++)
10492 char c = value_string[x];
10494 setup.touch.grid_button[i][x][y] =
10495 (c == '.' ? CHAR_GRID_BUTTON_NONE : c);
10500 for (i = 0; i < ARRAY_SIZE(editor_setup_tokens); i++)
10501 setSetupInfoFromTokenInfo(setup_file_hash, editor_setup_tokens, i);
10503 for (i = 0; i < ARRAY_SIZE(shortcut_setup_tokens); i++)
10504 setSetupInfoFromTokenInfo(setup_file_hash, shortcut_setup_tokens, i);
10506 for (pnr = 0; pnr < MAX_PLAYERS; pnr++)
10510 sprintf(prefix, "%s%d", TOKEN_STR_PLAYER_PREFIX, pnr + 1);
10512 setup_input = setup.input[pnr];
10513 for (i = 0; i < ARRAY_SIZE(player_setup_tokens); i++)
10515 char full_token[100];
10517 sprintf(full_token, "%s%s", prefix, player_setup_tokens[i].text);
10518 setSetupInfoFromTokenText(setup_file_hash, player_setup_tokens, i,
10521 setup.input[pnr] = setup_input;
10524 for (i = 0; i < ARRAY_SIZE(system_setup_tokens); i++)
10525 setSetupInfoFromTokenInfo(setup_file_hash, system_setup_tokens, i);
10527 for (i = 0; i < ARRAY_SIZE(internal_setup_tokens); i++)
10528 setSetupInfoFromTokenInfo(setup_file_hash, internal_setup_tokens, i);
10530 for (i = 0; i < ARRAY_SIZE(debug_setup_tokens); i++)
10531 setSetupInfoFromTokenInfo(setup_file_hash, debug_setup_tokens, i);
10533 for (i = 0; i < ARRAY_SIZE(options_setup_tokens); i++)
10534 setSetupInfoFromTokenInfo(setup_file_hash, options_setup_tokens, i);
10536 setHideRelatedSetupEntries();
10539 static void decodeSetupFileHash_AutoSetup(SetupFileHash *setup_file_hash)
10543 if (!setup_file_hash)
10546 for (i = 0; i < ARRAY_SIZE(auto_setup_tokens); i++)
10547 setSetupInfo(auto_setup_tokens, i,
10548 getHashEntry(setup_file_hash,
10549 auto_setup_tokens[i].text));
10552 static void decodeSetupFileHash_EditorCascade(SetupFileHash *setup_file_hash)
10556 if (!setup_file_hash)
10559 for (i = 0; i < ARRAY_SIZE(editor_cascade_setup_tokens); i++)
10560 setSetupInfo(editor_cascade_setup_tokens, i,
10561 getHashEntry(setup_file_hash,
10562 editor_cascade_setup_tokens[i].text));
10565 void LoadUserNames(void)
10567 int last_user_nr = user.nr;
10570 if (global.user_names != NULL)
10572 for (i = 0; i < MAX_PLAYER_NAMES; i++)
10573 checked_free(global.user_names[i]);
10575 checked_free(global.user_names);
10578 global.user_names = checked_calloc(MAX_PLAYER_NAMES * sizeof(char *));
10580 for (i = 0; i < MAX_PLAYER_NAMES; i++)
10584 SetupFileHash *setup_file_hash = loadSetupFileHash(getSetupFilename());
10586 if (setup_file_hash)
10588 char *player_name = getHashEntry(setup_file_hash, "player_name");
10590 global.user_names[i] = getFixedUserName(player_name);
10592 freeSetupFileHash(setup_file_hash);
10595 if (global.user_names[i] == NULL)
10596 global.user_names[i] = getStringCopy(getDefaultUserName(i));
10599 user.nr = last_user_nr;
10602 void LoadSetupFromFilename(char *filename)
10604 SetupFileHash *setup_file_hash = loadSetupFileHash(filename);
10606 if (setup_file_hash)
10608 decodeSetupFileHash(setup_file_hash);
10610 freeSetupFileHash(setup_file_hash);
10614 Debug("setup", "using default setup values");
10618 static void LoadSetup_SpecialPostProcessing(void)
10620 char *player_name_new;
10622 // needed to work around problems with fixed length strings
10623 player_name_new = getFixedUserName(setup.player_name);
10624 free(setup.player_name);
10625 setup.player_name = player_name_new;
10627 // "scroll_delay: on(3) / off(0)" was replaced by scroll delay value
10628 if (setup.scroll_delay == FALSE)
10630 setup.scroll_delay_value = MIN_SCROLL_DELAY;
10631 setup.scroll_delay = TRUE; // now always "on"
10634 // make sure that scroll delay value stays inside valid range
10635 setup.scroll_delay_value =
10636 MIN(MAX(MIN_SCROLL_DELAY, setup.scroll_delay_value), MAX_SCROLL_DELAY);
10639 void LoadSetup(void)
10643 // always start with reliable default values
10644 setSetupInfoToDefaults(&setup);
10646 // try to load setup values from default setup file
10647 filename = getDefaultSetupFilename();
10649 if (fileExists(filename))
10650 LoadSetupFromFilename(filename);
10652 // try to load setup values from user setup file
10653 filename = getSetupFilename();
10655 LoadSetupFromFilename(filename);
10657 LoadSetup_SpecialPostProcessing();
10660 void LoadSetup_AutoSetup(void)
10662 char *filename = getPath2(getSetupDir(), AUTOSETUP_FILENAME);
10663 SetupFileHash *setup_file_hash = NULL;
10665 // always start with reliable default values
10666 setSetupInfoToDefaults_AutoSetup(&setup);
10668 setup_file_hash = loadSetupFileHash(filename);
10670 if (setup_file_hash)
10672 decodeSetupFileHash_AutoSetup(setup_file_hash);
10674 freeSetupFileHash(setup_file_hash);
10680 void LoadSetup_EditorCascade(void)
10682 char *filename = getPath2(getSetupDir(), EDITORCASCADE_FILENAME);
10683 SetupFileHash *setup_file_hash = NULL;
10685 // always start with reliable default values
10686 setSetupInfoToDefaults_EditorCascade(&setup);
10688 setup_file_hash = loadSetupFileHash(filename);
10690 if (setup_file_hash)
10692 decodeSetupFileHash_EditorCascade(setup_file_hash);
10694 freeSetupFileHash(setup_file_hash);
10700 static void addGameControllerMappingToHash(SetupFileHash *mappings_hash,
10701 char *mapping_line)
10703 char mapping_guid[MAX_LINE_LEN];
10704 char *mapping_start, *mapping_end;
10706 // get GUID from game controller mapping line: copy complete line
10707 strncpy(mapping_guid, mapping_line, MAX_LINE_LEN - 1);
10708 mapping_guid[MAX_LINE_LEN - 1] = '\0';
10710 // get GUID from game controller mapping line: cut after GUID part
10711 mapping_start = strchr(mapping_guid, ',');
10712 if (mapping_start != NULL)
10713 *mapping_start = '\0';
10715 // cut newline from game controller mapping line
10716 mapping_end = strchr(mapping_line, '\n');
10717 if (mapping_end != NULL)
10718 *mapping_end = '\0';
10720 // add mapping entry to game controller mappings hash
10721 setHashEntry(mappings_hash, mapping_guid, mapping_line);
10724 static void LoadSetup_ReadGameControllerMappings(SetupFileHash *mappings_hash,
10729 if (!(file = fopen(filename, MODE_READ)))
10731 Warn("cannot read game controller mappings file '%s'", filename);
10736 while (!feof(file))
10738 char line[MAX_LINE_LEN];
10740 if (!fgets(line, MAX_LINE_LEN, file))
10743 addGameControllerMappingToHash(mappings_hash, line);
10749 void SaveSetup(void)
10751 char *filename = getSetupFilename();
10755 InitUserDataDirectory();
10757 if (!(file = fopen(filename, MODE_WRITE)))
10759 Warn("cannot write setup file '%s'", filename);
10764 fprintFileHeader(file, SETUP_FILENAME);
10766 for (i = 0; i < ARRAY_SIZE(global_setup_tokens); i++)
10768 // just to make things nicer :)
10769 if (global_setup_tokens[i].value == &setup.multiple_users ||
10770 global_setup_tokens[i].value == &setup.sound ||
10771 global_setup_tokens[i].value == &setup.graphics_set ||
10772 global_setup_tokens[i].value == &setup.volume_simple ||
10773 global_setup_tokens[i].value == &setup.network_mode ||
10774 global_setup_tokens[i].value == &setup.api_server ||
10775 global_setup_tokens[i].value == &setup.touch.control_type ||
10776 global_setup_tokens[i].value == &setup.touch.grid_xsize[0] ||
10777 global_setup_tokens[i].value == &setup.touch.grid_xsize[1])
10778 fprintf(file, "\n");
10780 fprintf(file, "%s\n", getSetupLine(global_setup_tokens, "", i));
10783 for (i = 0; i < 2; i++)
10785 int grid_xsize = setup.touch.grid_xsize[i];
10786 int grid_ysize = setup.touch.grid_ysize[i];
10789 fprintf(file, "\n");
10791 for (y = 0; y < grid_ysize; y++)
10793 char token_string[MAX_LINE_LEN];
10794 char value_string[MAX_LINE_LEN];
10796 sprintf(token_string, "touch.virtual_buttons.%d.%02d", i, y);
10798 for (x = 0; x < grid_xsize; x++)
10800 char c = setup.touch.grid_button[i][x][y];
10802 value_string[x] = (c == CHAR_GRID_BUTTON_NONE ? '.' : c);
10805 value_string[grid_xsize] = '\0';
10807 fprintf(file, "%s\n", getFormattedSetupEntry(token_string, value_string));
10811 fprintf(file, "\n");
10812 for (i = 0; i < ARRAY_SIZE(editor_setup_tokens); i++)
10813 fprintf(file, "%s\n", getSetupLine(editor_setup_tokens, "", i));
10815 fprintf(file, "\n");
10816 for (i = 0; i < ARRAY_SIZE(shortcut_setup_tokens); i++)
10817 fprintf(file, "%s\n", getSetupLine(shortcut_setup_tokens, "", i));
10819 for (pnr = 0; pnr < MAX_PLAYERS; pnr++)
10823 sprintf(prefix, "%s%d", TOKEN_STR_PLAYER_PREFIX, pnr + 1);
10824 fprintf(file, "\n");
10826 setup_input = setup.input[pnr];
10827 for (i = 0; i < ARRAY_SIZE(player_setup_tokens); i++)
10828 fprintf(file, "%s\n", getSetupLine(player_setup_tokens, prefix, i));
10831 fprintf(file, "\n");
10832 for (i = 0; i < ARRAY_SIZE(system_setup_tokens); i++)
10833 fprintf(file, "%s\n", getSetupLine(system_setup_tokens, "", i));
10835 // (internal setup values not saved to user setup file)
10837 fprintf(file, "\n");
10838 for (i = 0; i < ARRAY_SIZE(debug_setup_tokens); i++)
10839 if (!strPrefix(debug_setup_tokens[i].text, "debug.xsn_") ||
10840 setup.debug.xsn_mode != AUTO)
10841 fprintf(file, "%s\n", getSetupLine(debug_setup_tokens, "", i));
10843 fprintf(file, "\n");
10844 for (i = 0; i < ARRAY_SIZE(options_setup_tokens); i++)
10845 fprintf(file, "%s\n", getSetupLine(options_setup_tokens, "", i));
10849 SetFilePermissions(filename, PERMS_PRIVATE);
10852 void SaveSetup_AutoSetup(void)
10854 char *filename = getPath2(getSetupDir(), AUTOSETUP_FILENAME);
10858 InitUserDataDirectory();
10860 if (!(file = fopen(filename, MODE_WRITE)))
10862 Warn("cannot write auto setup file '%s'", filename);
10869 fprintFileHeader(file, AUTOSETUP_FILENAME);
10871 for (i = 0; i < ARRAY_SIZE(auto_setup_tokens); i++)
10872 fprintf(file, "%s\n", getSetupLine(auto_setup_tokens, "", i));
10876 SetFilePermissions(filename, PERMS_PRIVATE);
10881 void SaveSetup_EditorCascade(void)
10883 char *filename = getPath2(getSetupDir(), EDITORCASCADE_FILENAME);
10887 InitUserDataDirectory();
10889 if (!(file = fopen(filename, MODE_WRITE)))
10891 Warn("cannot write editor cascade state file '%s'", filename);
10898 fprintFileHeader(file, EDITORCASCADE_FILENAME);
10900 for (i = 0; i < ARRAY_SIZE(editor_cascade_setup_tokens); i++)
10901 fprintf(file, "%s\n", getSetupLine(editor_cascade_setup_tokens, "", i));
10905 SetFilePermissions(filename, PERMS_PRIVATE);
10910 static void SaveSetup_WriteGameControllerMappings(SetupFileHash *mappings_hash,
10915 if (!(file = fopen(filename, MODE_WRITE)))
10917 Warn("cannot write game controller mappings file '%s'", filename);
10922 BEGIN_HASH_ITERATION(mappings_hash, itr)
10924 fprintf(file, "%s\n", HASH_ITERATION_VALUE(itr));
10926 END_HASH_ITERATION(mappings_hash, itr)
10931 void SaveSetup_AddGameControllerMapping(char *mapping)
10933 char *filename = getPath2(getSetupDir(), GAMECONTROLLER_BASENAME);
10934 SetupFileHash *mappings_hash = newSetupFileHash();
10936 InitUserDataDirectory();
10938 // load existing personal game controller mappings
10939 LoadSetup_ReadGameControllerMappings(mappings_hash, filename);
10941 // add new mapping to personal game controller mappings
10942 addGameControllerMappingToHash(mappings_hash, mapping);
10944 // save updated personal game controller mappings
10945 SaveSetup_WriteGameControllerMappings(mappings_hash, filename);
10947 freeSetupFileHash(mappings_hash);
10951 void LoadCustomElementDescriptions(void)
10953 char *filename = getCustomArtworkConfigFilename(ARTWORK_TYPE_GRAPHICS);
10954 SetupFileHash *setup_file_hash;
10957 for (i = 0; i < NUM_FILE_ELEMENTS; i++)
10959 if (element_info[i].custom_description != NULL)
10961 free(element_info[i].custom_description);
10962 element_info[i].custom_description = NULL;
10966 if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
10969 for (i = 0; i < NUM_FILE_ELEMENTS; i++)
10971 char *token = getStringCat2(element_info[i].token_name, ".name");
10972 char *value = getHashEntry(setup_file_hash, token);
10975 element_info[i].custom_description = getStringCopy(value);
10980 freeSetupFileHash(setup_file_hash);
10983 static int getElementFromToken(char *token)
10985 char *value = getHashEntry(element_token_hash, token);
10988 return atoi(value);
10990 Warn("unknown element token '%s'", token);
10992 return EL_UNDEFINED;
10995 void FreeGlobalAnimEventInfo(void)
10997 struct GlobalAnimEventInfo *gaei = &global_anim_event_info;
10999 if (gaei->event_list == NULL)
11004 for (i = 0; i < gaei->num_event_lists; i++)
11006 checked_free(gaei->event_list[i]->event_value);
11007 checked_free(gaei->event_list[i]);
11010 checked_free(gaei->event_list);
11012 gaei->event_list = NULL;
11013 gaei->num_event_lists = 0;
11016 static int AddGlobalAnimEventList(void)
11018 struct GlobalAnimEventInfo *gaei = &global_anim_event_info;
11019 int list_pos = gaei->num_event_lists++;
11021 gaei->event_list = checked_realloc(gaei->event_list, gaei->num_event_lists *
11022 sizeof(struct GlobalAnimEventListInfo *));
11024 gaei->event_list[list_pos] =
11025 checked_calloc(sizeof(struct GlobalAnimEventListInfo));
11027 struct GlobalAnimEventListInfo *gaeli = gaei->event_list[list_pos];
11029 gaeli->event_value = NULL;
11030 gaeli->num_event_values = 0;
11035 static int AddGlobalAnimEventValue(int list_pos, int event_value)
11037 // do not add empty global animation events
11038 if (event_value == ANIM_EVENT_NONE)
11041 // if list position is undefined, create new list
11042 if (list_pos == ANIM_EVENT_UNDEFINED)
11043 list_pos = AddGlobalAnimEventList();
11045 struct GlobalAnimEventInfo *gaei = &global_anim_event_info;
11046 struct GlobalAnimEventListInfo *gaeli = gaei->event_list[list_pos];
11047 int value_pos = gaeli->num_event_values++;
11049 gaeli->event_value = checked_realloc(gaeli->event_value,
11050 gaeli->num_event_values * sizeof(int *));
11052 gaeli->event_value[value_pos] = event_value;
11057 int GetGlobalAnimEventValue(int list_pos, int value_pos)
11059 if (list_pos == ANIM_EVENT_UNDEFINED)
11060 return ANIM_EVENT_NONE;
11062 struct GlobalAnimEventInfo *gaei = &global_anim_event_info;
11063 struct GlobalAnimEventListInfo *gaeli = gaei->event_list[list_pos];
11065 return gaeli->event_value[value_pos];
11068 int GetGlobalAnimEventValueCount(int list_pos)
11070 if (list_pos == ANIM_EVENT_UNDEFINED)
11073 struct GlobalAnimEventInfo *gaei = &global_anim_event_info;
11074 struct GlobalAnimEventListInfo *gaeli = gaei->event_list[list_pos];
11076 return gaeli->num_event_values;
11079 // This function checks if a string <s> of the format "string1, string2, ..."
11080 // exactly contains a string <s_contained>.
11082 static boolean string_has_parameter(char *s, char *s_contained)
11086 if (s == NULL || s_contained == NULL)
11089 if (strlen(s_contained) > strlen(s))
11092 if (strncmp(s, s_contained, strlen(s_contained)) == 0)
11094 char next_char = s[strlen(s_contained)];
11096 // check if next character is delimiter or whitespace
11097 return (next_char == ',' || next_char == '\0' ||
11098 next_char == ' ' || next_char == '\t' ? TRUE : FALSE);
11101 // check if string contains another parameter string after a comma
11102 substring = strchr(s, ',');
11103 if (substring == NULL) // string does not contain a comma
11106 // advance string pointer to next character after the comma
11109 // skip potential whitespaces after the comma
11110 while (*substring == ' ' || *substring == '\t')
11113 return string_has_parameter(substring, s_contained);
11116 static int get_anim_parameter_value(char *s)
11118 int event_value[] =
11126 char *pattern_1[] =
11134 char *pattern_2 = ".part_";
11135 char *matching_char = NULL;
11137 int pattern_1_len = 0;
11138 int result = ANIM_EVENT_NONE;
11141 for (i = 0; i < ARRAY_SIZE(event_value); i++)
11143 matching_char = strstr(s_ptr, pattern_1[i]);
11144 pattern_1_len = strlen(pattern_1[i]);
11145 result = event_value[i];
11147 if (matching_char != NULL)
11151 if (matching_char == NULL)
11152 return ANIM_EVENT_NONE;
11154 s_ptr = matching_char + pattern_1_len;
11156 // check for main animation number ("anim_X" or "anim_XX")
11157 if (*s_ptr >= '0' && *s_ptr <= '9')
11159 int gic_anim_nr = (*s_ptr++ - '0');
11161 if (*s_ptr >= '0' && *s_ptr <= '9')
11162 gic_anim_nr = 10 * gic_anim_nr + (*s_ptr++ - '0');
11164 if (gic_anim_nr < 1 || gic_anim_nr > MAX_GLOBAL_ANIMS)
11165 return ANIM_EVENT_NONE;
11167 result |= gic_anim_nr << ANIM_EVENT_ANIM_BIT;
11171 // invalid main animation number specified
11173 return ANIM_EVENT_NONE;
11176 // check for animation part number ("part_X" or "part_XX") (optional)
11177 if (strPrefix(s_ptr, pattern_2))
11179 s_ptr += strlen(pattern_2);
11181 if (*s_ptr >= '0' && *s_ptr <= '9')
11183 int gic_part_nr = (*s_ptr++ - '0');
11185 if (*s_ptr >= '0' && *s_ptr <= '9')
11186 gic_part_nr = 10 * gic_part_nr + (*s_ptr++ - '0');
11188 if (gic_part_nr < 1 || gic_part_nr > MAX_GLOBAL_ANIM_PARTS)
11189 return ANIM_EVENT_NONE;
11191 result |= gic_part_nr << ANIM_EVENT_PART_BIT;
11195 // invalid animation part number specified
11197 return ANIM_EVENT_NONE;
11201 // discard result if next character is neither delimiter nor whitespace
11202 if (!(*s_ptr == ',' || *s_ptr == '\0' ||
11203 *s_ptr == ' ' || *s_ptr == '\t'))
11204 return ANIM_EVENT_NONE;
11209 static int get_anim_parameter_values(char *s)
11211 int list_pos = ANIM_EVENT_UNDEFINED;
11212 int event_value = ANIM_EVENT_DEFAULT;
11214 if (string_has_parameter(s, "any"))
11215 event_value |= ANIM_EVENT_ANY;
11217 if (string_has_parameter(s, "click:self") ||
11218 string_has_parameter(s, "click") ||
11219 string_has_parameter(s, "self"))
11220 event_value |= ANIM_EVENT_SELF;
11222 if (string_has_parameter(s, "unclick:any"))
11223 event_value |= ANIM_EVENT_UNCLICK_ANY;
11225 // if animation event found, add it to global animation event list
11226 if (event_value != ANIM_EVENT_NONE)
11227 list_pos = AddGlobalAnimEventValue(list_pos, event_value);
11231 // add optional "click:anim_X" or "click:anim_X.part_X" parameter
11232 event_value = get_anim_parameter_value(s);
11234 // if animation event found, add it to global animation event list
11235 if (event_value != ANIM_EVENT_NONE)
11236 list_pos = AddGlobalAnimEventValue(list_pos, event_value);
11238 // continue with next part of the string, starting with next comma
11239 s = strchr(s + 1, ',');
11245 static int get_anim_action_parameter_value(char *token)
11247 // check most common default case first to massively speed things up
11248 if (strEqual(token, ARG_UNDEFINED))
11249 return ANIM_EVENT_ACTION_NONE;
11251 int result = getImageIDFromToken(token);
11255 char *gfx_token = getStringCat2("gfx.", token);
11257 result = getImageIDFromToken(gfx_token);
11259 checked_free(gfx_token);
11264 Key key = getKeyFromX11KeyName(token);
11266 if (key != KSYM_UNDEFINED)
11267 result = -(int)key;
11271 result = ANIM_EVENT_ACTION_NONE;
11276 int get_parameter_value(char *value_raw, char *suffix, int type)
11278 char *value = getStringToLower(value_raw);
11279 int result = 0; // probably a save default value
11281 if (strEqual(suffix, ".direction"))
11283 result = (strEqual(value, "left") ? MV_LEFT :
11284 strEqual(value, "right") ? MV_RIGHT :
11285 strEqual(value, "up") ? MV_UP :
11286 strEqual(value, "down") ? MV_DOWN : MV_NONE);
11288 else if (strEqual(suffix, ".position"))
11290 result = (strEqual(value, "left") ? POS_LEFT :
11291 strEqual(value, "right") ? POS_RIGHT :
11292 strEqual(value, "top") ? POS_TOP :
11293 strEqual(value, "upper") ? POS_UPPER :
11294 strEqual(value, "middle") ? POS_MIDDLE :
11295 strEqual(value, "lower") ? POS_LOWER :
11296 strEqual(value, "bottom") ? POS_BOTTOM :
11297 strEqual(value, "any") ? POS_ANY :
11298 strEqual(value, "last") ? POS_LAST : POS_UNDEFINED);
11300 else if (strEqual(suffix, ".align"))
11302 result = (strEqual(value, "left") ? ALIGN_LEFT :
11303 strEqual(value, "right") ? ALIGN_RIGHT :
11304 strEqual(value, "center") ? ALIGN_CENTER :
11305 strEqual(value, "middle") ? ALIGN_CENTER : ALIGN_DEFAULT);
11307 else if (strEqual(suffix, ".valign"))
11309 result = (strEqual(value, "top") ? VALIGN_TOP :
11310 strEqual(value, "bottom") ? VALIGN_BOTTOM :
11311 strEqual(value, "middle") ? VALIGN_MIDDLE :
11312 strEqual(value, "center") ? VALIGN_MIDDLE : VALIGN_DEFAULT);
11314 else if (strEqual(suffix, ".anim_mode"))
11316 result = (string_has_parameter(value, "none") ? ANIM_NONE :
11317 string_has_parameter(value, "loop") ? ANIM_LOOP :
11318 string_has_parameter(value, "linear") ? ANIM_LINEAR :
11319 string_has_parameter(value, "pingpong") ? ANIM_PINGPONG :
11320 string_has_parameter(value, "pingpong2") ? ANIM_PINGPONG2 :
11321 string_has_parameter(value, "random") ? ANIM_RANDOM :
11322 string_has_parameter(value, "ce_value") ? ANIM_CE_VALUE :
11323 string_has_parameter(value, "ce_score") ? ANIM_CE_SCORE :
11324 string_has_parameter(value, "ce_delay") ? ANIM_CE_DELAY :
11325 string_has_parameter(value, "horizontal") ? ANIM_HORIZONTAL :
11326 string_has_parameter(value, "vertical") ? ANIM_VERTICAL :
11327 string_has_parameter(value, "centered") ? ANIM_CENTERED :
11328 string_has_parameter(value, "all") ? ANIM_ALL :
11331 if (string_has_parameter(value, "once"))
11332 result |= ANIM_ONCE;
11334 if (string_has_parameter(value, "reverse"))
11335 result |= ANIM_REVERSE;
11337 if (string_has_parameter(value, "opaque_player"))
11338 result |= ANIM_OPAQUE_PLAYER;
11340 if (string_has_parameter(value, "static_panel"))
11341 result |= ANIM_STATIC_PANEL;
11343 else if (strEqual(suffix, ".init_event") ||
11344 strEqual(suffix, ".anim_event"))
11346 result = get_anim_parameter_values(value);
11348 else if (strEqual(suffix, ".init_delay_action") ||
11349 strEqual(suffix, ".anim_delay_action") ||
11350 strEqual(suffix, ".post_delay_action") ||
11351 strEqual(suffix, ".init_event_action") ||
11352 strEqual(suffix, ".anim_event_action"))
11354 result = get_anim_action_parameter_value(value_raw);
11356 else if (strEqual(suffix, ".class"))
11358 result = (strEqual(value, ARG_UNDEFINED) ? ARG_UNDEFINED_VALUE :
11359 get_hash_from_key(value));
11361 else if (strEqual(suffix, ".style"))
11363 result = STYLE_DEFAULT;
11365 if (string_has_parameter(value, "accurate_borders"))
11366 result |= STYLE_ACCURATE_BORDERS;
11368 if (string_has_parameter(value, "inner_corners"))
11369 result |= STYLE_INNER_CORNERS;
11371 if (string_has_parameter(value, "reverse"))
11372 result |= STYLE_REVERSE;
11374 if (string_has_parameter(value, "leftmost_position"))
11375 result |= STYLE_LEFTMOST_POSITION;
11377 if (string_has_parameter(value, "block_clicks"))
11378 result |= STYLE_BLOCK;
11380 if (string_has_parameter(value, "passthrough_clicks"))
11381 result |= STYLE_PASSTHROUGH;
11383 if (string_has_parameter(value, "multiple_actions"))
11384 result |= STYLE_MULTIPLE_ACTIONS;
11386 else if (strEqual(suffix, ".fade_mode"))
11388 result = (string_has_parameter(value, "none") ? FADE_MODE_NONE :
11389 string_has_parameter(value, "fade") ? FADE_MODE_FADE :
11390 string_has_parameter(value, "crossfade") ? FADE_MODE_CROSSFADE :
11391 string_has_parameter(value, "melt") ? FADE_MODE_MELT :
11392 string_has_parameter(value, "curtain") ? FADE_MODE_CURTAIN :
11393 FADE_MODE_DEFAULT);
11395 else if (strEqual(suffix, ".auto_delay_unit"))
11397 result = (string_has_parameter(value, "ms") ? AUTO_DELAY_UNIT_MS :
11398 string_has_parameter(value, "frames") ? AUTO_DELAY_UNIT_FRAMES :
11399 AUTO_DELAY_UNIT_DEFAULT);
11401 else if (strPrefix(suffix, ".font")) // (may also be ".font_xyz")
11403 result = gfx.get_font_from_token_function(value);
11405 else // generic parameter of type integer or boolean
11407 result = (strEqual(value, ARG_UNDEFINED) ? ARG_UNDEFINED_VALUE :
11408 type == TYPE_INTEGER ? get_integer_from_string(value) :
11409 type == TYPE_BOOLEAN ? get_boolean_from_string(value) :
11410 ARG_UNDEFINED_VALUE);
11418 static int get_token_parameter_value(char *token, char *value_raw)
11422 if (token == NULL || value_raw == NULL)
11423 return ARG_UNDEFINED_VALUE;
11425 suffix = strrchr(token, '.');
11426 if (suffix == NULL)
11429 if (strEqual(suffix, ".element"))
11430 return getElementFromToken(value_raw);
11432 // !!! USE CORRECT VALUE TYPE (currently works also for TYPE_BOOLEAN) !!!
11433 return get_parameter_value(value_raw, suffix, TYPE_INTEGER);
11436 void InitMenuDesignSettings_Static(void)
11440 // always start with reliable default values from static default config
11441 for (i = 0; image_config_vars[i].token != NULL; i++)
11443 char *value = getHashEntry(image_config_hash, image_config_vars[i].token);
11446 *image_config_vars[i].value =
11447 get_token_parameter_value(image_config_vars[i].token, value);
11451 static void InitMenuDesignSettings_SpecialPreProcessing(void)
11455 // the following initializes hierarchical values from static configuration
11457 // special case: initialize "ARG_DEFAULT" values in static default config
11458 // (e.g., initialize "[titlemessage].fade_mode" from "[title].fade_mode")
11459 titlescreen_initial_first_default.fade_mode =
11460 title_initial_first_default.fade_mode;
11461 titlescreen_initial_first_default.fade_delay =
11462 title_initial_first_default.fade_delay;
11463 titlescreen_initial_first_default.post_delay =
11464 title_initial_first_default.post_delay;
11465 titlescreen_initial_first_default.auto_delay =
11466 title_initial_first_default.auto_delay;
11467 titlescreen_initial_first_default.auto_delay_unit =
11468 title_initial_first_default.auto_delay_unit;
11469 titlescreen_first_default.fade_mode = title_first_default.fade_mode;
11470 titlescreen_first_default.fade_delay = title_first_default.fade_delay;
11471 titlescreen_first_default.post_delay = title_first_default.post_delay;
11472 titlescreen_first_default.auto_delay = title_first_default.auto_delay;
11473 titlescreen_first_default.auto_delay_unit =
11474 title_first_default.auto_delay_unit;
11475 titlemessage_initial_first_default.fade_mode =
11476 title_initial_first_default.fade_mode;
11477 titlemessage_initial_first_default.fade_delay =
11478 title_initial_first_default.fade_delay;
11479 titlemessage_initial_first_default.post_delay =
11480 title_initial_first_default.post_delay;
11481 titlemessage_initial_first_default.auto_delay =
11482 title_initial_first_default.auto_delay;
11483 titlemessage_initial_first_default.auto_delay_unit =
11484 title_initial_first_default.auto_delay_unit;
11485 titlemessage_first_default.fade_mode = title_first_default.fade_mode;
11486 titlemessage_first_default.fade_delay = title_first_default.fade_delay;
11487 titlemessage_first_default.post_delay = title_first_default.post_delay;
11488 titlemessage_first_default.auto_delay = title_first_default.auto_delay;
11489 titlemessage_first_default.auto_delay_unit =
11490 title_first_default.auto_delay_unit;
11492 titlescreen_initial_default.fade_mode = title_initial_default.fade_mode;
11493 titlescreen_initial_default.fade_delay = title_initial_default.fade_delay;
11494 titlescreen_initial_default.post_delay = title_initial_default.post_delay;
11495 titlescreen_initial_default.auto_delay = title_initial_default.auto_delay;
11496 titlescreen_initial_default.auto_delay_unit =
11497 title_initial_default.auto_delay_unit;
11498 titlescreen_default.fade_mode = title_default.fade_mode;
11499 titlescreen_default.fade_delay = title_default.fade_delay;
11500 titlescreen_default.post_delay = title_default.post_delay;
11501 titlescreen_default.auto_delay = title_default.auto_delay;
11502 titlescreen_default.auto_delay_unit = title_default.auto_delay_unit;
11503 titlemessage_initial_default.fade_mode = title_initial_default.fade_mode;
11504 titlemessage_initial_default.fade_delay = title_initial_default.fade_delay;
11505 titlemessage_initial_default.post_delay = title_initial_default.post_delay;
11506 titlemessage_initial_default.auto_delay_unit =
11507 title_initial_default.auto_delay_unit;
11508 titlemessage_default.fade_mode = title_default.fade_mode;
11509 titlemessage_default.fade_delay = title_default.fade_delay;
11510 titlemessage_default.post_delay = title_default.post_delay;
11511 titlemessage_default.auto_delay = title_default.auto_delay;
11512 titlemessage_default.auto_delay_unit = title_default.auto_delay_unit;
11514 // special case: initialize "ARG_DEFAULT" values in static default config
11515 // (e.g., init "titlemessage_1.fade_mode" from "[titlemessage].fade_mode")
11516 for (i = 0; i < MAX_NUM_TITLE_MESSAGES; i++)
11518 titlescreen_initial_first[i] = titlescreen_initial_first_default;
11519 titlescreen_first[i] = titlescreen_first_default;
11520 titlemessage_initial_first[i] = titlemessage_initial_first_default;
11521 titlemessage_first[i] = titlemessage_first_default;
11523 titlescreen_initial[i] = titlescreen_initial_default;
11524 titlescreen[i] = titlescreen_default;
11525 titlemessage_initial[i] = titlemessage_initial_default;
11526 titlemessage[i] = titlemessage_default;
11529 // special case: initialize "ARG_DEFAULT" values in static default config
11530 // (eg, init "menu.enter_screen.SCORES.xyz" from "menu.enter_screen.xyz")
11531 for (i = 0; i < NUM_SPECIAL_GFX_ARGS; i++)
11533 if (i == GFX_SPECIAL_ARG_TITLE) // title values already initialized
11536 menu.enter_screen[i] = menu.enter_screen[GFX_SPECIAL_ARG_DEFAULT];
11537 menu.leave_screen[i] = menu.leave_screen[GFX_SPECIAL_ARG_DEFAULT];
11538 menu.next_screen[i] = menu.next_screen[GFX_SPECIAL_ARG_DEFAULT];
11541 // special case: initialize "ARG_DEFAULT" values in static default config
11542 // (eg, init "viewport.door_1.MAIN.xyz" from "viewport.door_1.xyz")
11543 for (i = 0; i < NUM_SPECIAL_GFX_ARGS; i++)
11545 viewport.window[i] = viewport.window[GFX_SPECIAL_ARG_DEFAULT];
11546 viewport.playfield[i] = viewport.playfield[GFX_SPECIAL_ARG_DEFAULT];
11547 viewport.door_1[i] = viewport.door_1[GFX_SPECIAL_ARG_DEFAULT];
11549 if (i == GFX_SPECIAL_ARG_EDITOR) // editor values already initialized
11552 viewport.door_2[i] = viewport.door_2[GFX_SPECIAL_ARG_DEFAULT];
11556 static void InitMenuDesignSettings_SpecialPostProcessing(void)
11560 struct XY *dst, *src;
11562 game_buttons_xy[] =
11564 { &game.button.save, &game.button.stop },
11565 { &game.button.pause2, &game.button.pause },
11566 { &game.button.load, &game.button.play },
11567 { &game.button.undo, &game.button.stop },
11568 { &game.button.redo, &game.button.play },
11574 // special case: initialize later added SETUP list size from LEVELS value
11575 if (menu.list_size[GAME_MODE_SETUP] == -1)
11576 menu.list_size[GAME_MODE_SETUP] = menu.list_size[GAME_MODE_LEVELS];
11578 // set default position for snapshot buttons to stop/pause/play buttons
11579 for (i = 0; game_buttons_xy[i].dst != NULL; i++)
11580 if ((*game_buttons_xy[i].dst).x == -1 &&
11581 (*game_buttons_xy[i].dst).y == -1)
11582 *game_buttons_xy[i].dst = *game_buttons_xy[i].src;
11584 // --------------------------------------------------------------------------
11585 // dynamic viewports (including playfield margins, borders and alignments)
11586 // --------------------------------------------------------------------------
11588 // dynamic viewports currently only supported for landscape mode
11589 int display_width = MAX(video.display_width, video.display_height);
11590 int display_height = MIN(video.display_width, video.display_height);
11592 for (i = 0; i < NUM_SPECIAL_GFX_ARGS; i++)
11594 struct RectWithBorder *vp_window = &viewport.window[i];
11595 struct RectWithBorder *vp_playfield = &viewport.playfield[i];
11596 struct RectWithBorder *vp_door_1 = &viewport.door_1[i];
11597 struct RectWithBorder *vp_door_2 = &viewport.door_2[i];
11598 boolean dynamic_window_width = (vp_window->min_width != -1);
11599 boolean dynamic_window_height = (vp_window->min_height != -1);
11600 boolean dynamic_playfield_width = (vp_playfield->min_width != -1);
11601 boolean dynamic_playfield_height = (vp_playfield->min_height != -1);
11603 // adjust window size if min/max width/height is specified
11605 if (vp_window->min_width != -1)
11607 int window_width = display_width;
11609 // when using static window height, use aspect ratio of display
11610 if (vp_window->min_height == -1)
11611 window_width = vp_window->height * display_width / display_height;
11613 vp_window->width = MAX(vp_window->min_width, window_width);
11616 if (vp_window->min_height != -1)
11618 int window_height = display_height;
11620 // when using static window width, use aspect ratio of display
11621 if (vp_window->min_width == -1)
11622 window_height = vp_window->width * display_height / display_width;
11624 vp_window->height = MAX(vp_window->min_height, window_height);
11627 if (vp_window->max_width != -1)
11628 vp_window->width = MIN(vp_window->width, vp_window->max_width);
11630 if (vp_window->max_height != -1)
11631 vp_window->height = MIN(vp_window->height, vp_window->max_height);
11633 int playfield_width = vp_window->width;
11634 int playfield_height = vp_window->height;
11636 // adjust playfield size and position according to specified margins
11638 playfield_width -= vp_playfield->margin_left;
11639 playfield_width -= vp_playfield->margin_right;
11641 playfield_height -= vp_playfield->margin_top;
11642 playfield_height -= vp_playfield->margin_bottom;
11644 // adjust playfield size if min/max width/height is specified
11646 if (vp_playfield->min_width != -1)
11647 vp_playfield->width = MAX(vp_playfield->min_width, playfield_width);
11649 if (vp_playfield->min_height != -1)
11650 vp_playfield->height = MAX(vp_playfield->min_height, playfield_height);
11652 if (vp_playfield->max_width != -1)
11653 vp_playfield->width = MIN(vp_playfield->width, vp_playfield->max_width);
11655 if (vp_playfield->max_height != -1)
11656 vp_playfield->height = MIN(vp_playfield->height,vp_playfield->max_height);
11658 // adjust playfield position according to specified alignment
11660 if (vp_playfield->align == ALIGN_LEFT || vp_playfield->x > 0)
11661 vp_playfield->x = ALIGNED_VP_XPOS(vp_playfield);
11662 else if (vp_playfield->align == ALIGN_CENTER)
11663 vp_playfield->x = playfield_width / 2 - vp_playfield->width / 2;
11664 else if (vp_playfield->align == ALIGN_RIGHT)
11665 vp_playfield->x += playfield_width - vp_playfield->width;
11667 if (vp_playfield->valign == VALIGN_TOP || vp_playfield->y > 0)
11668 vp_playfield->y = ALIGNED_VP_YPOS(vp_playfield);
11669 else if (vp_playfield->valign == VALIGN_MIDDLE)
11670 vp_playfield->y = playfield_height / 2 - vp_playfield->height / 2;
11671 else if (vp_playfield->valign == VALIGN_BOTTOM)
11672 vp_playfield->y += playfield_height - vp_playfield->height;
11674 vp_playfield->x += vp_playfield->margin_left;
11675 vp_playfield->y += vp_playfield->margin_top;
11677 // adjust individual playfield borders if only default border is specified
11679 if (vp_playfield->border_left == -1)
11680 vp_playfield->border_left = vp_playfield->border_size;
11681 if (vp_playfield->border_right == -1)
11682 vp_playfield->border_right = vp_playfield->border_size;
11683 if (vp_playfield->border_top == -1)
11684 vp_playfield->border_top = vp_playfield->border_size;
11685 if (vp_playfield->border_bottom == -1)
11686 vp_playfield->border_bottom = vp_playfield->border_size;
11688 // set dynamic playfield borders if borders are specified as undefined
11689 // (but only if window size was dynamic and playfield size was static)
11691 if (dynamic_window_width && !dynamic_playfield_width)
11693 if (vp_playfield->border_left == -1)
11695 vp_playfield->border_left = (vp_playfield->x -
11696 vp_playfield->margin_left);
11697 vp_playfield->x -= vp_playfield->border_left;
11698 vp_playfield->width += vp_playfield->border_left;
11701 if (vp_playfield->border_right == -1)
11703 vp_playfield->border_right = (vp_window->width -
11705 vp_playfield->width -
11706 vp_playfield->margin_right);
11707 vp_playfield->width += vp_playfield->border_right;
11711 if (dynamic_window_height && !dynamic_playfield_height)
11713 if (vp_playfield->border_top == -1)
11715 vp_playfield->border_top = (vp_playfield->y -
11716 vp_playfield->margin_top);
11717 vp_playfield->y -= vp_playfield->border_top;
11718 vp_playfield->height += vp_playfield->border_top;
11721 if (vp_playfield->border_bottom == -1)
11723 vp_playfield->border_bottom = (vp_window->height -
11725 vp_playfield->height -
11726 vp_playfield->margin_bottom);
11727 vp_playfield->height += vp_playfield->border_bottom;
11731 // adjust playfield size to be a multiple of a defined alignment tile size
11733 int align_size = vp_playfield->align_size;
11734 int playfield_xtiles = vp_playfield->width / align_size;
11735 int playfield_ytiles = vp_playfield->height / align_size;
11736 int playfield_width_corrected = playfield_xtiles * align_size;
11737 int playfield_height_corrected = playfield_ytiles * align_size;
11738 boolean is_playfield_mode = (i == GFX_SPECIAL_ARG_PLAYING ||
11739 i == GFX_SPECIAL_ARG_EDITOR);
11741 if (is_playfield_mode &&
11742 dynamic_playfield_width &&
11743 vp_playfield->width != playfield_width_corrected)
11745 int playfield_xdiff = vp_playfield->width - playfield_width_corrected;
11747 vp_playfield->width = playfield_width_corrected;
11749 if (vp_playfield->align == ALIGN_LEFT)
11751 vp_playfield->border_left += playfield_xdiff;
11753 else if (vp_playfield->align == ALIGN_RIGHT)
11755 vp_playfield->border_right += playfield_xdiff;
11757 else if (vp_playfield->align == ALIGN_CENTER)
11759 int border_left_diff = playfield_xdiff / 2;
11760 int border_right_diff = playfield_xdiff - border_left_diff;
11762 vp_playfield->border_left += border_left_diff;
11763 vp_playfield->border_right += border_right_diff;
11767 if (is_playfield_mode &&
11768 dynamic_playfield_height &&
11769 vp_playfield->height != playfield_height_corrected)
11771 int playfield_ydiff = vp_playfield->height - playfield_height_corrected;
11773 vp_playfield->height = playfield_height_corrected;
11775 if (vp_playfield->valign == VALIGN_TOP)
11777 vp_playfield->border_top += playfield_ydiff;
11779 else if (vp_playfield->align == VALIGN_BOTTOM)
11781 vp_playfield->border_right += playfield_ydiff;
11783 else if (vp_playfield->align == VALIGN_MIDDLE)
11785 int border_top_diff = playfield_ydiff / 2;
11786 int border_bottom_diff = playfield_ydiff - border_top_diff;
11788 vp_playfield->border_top += border_top_diff;
11789 vp_playfield->border_bottom += border_bottom_diff;
11793 // adjust door positions according to specified alignment
11795 for (j = 0; j < 2; j++)
11797 struct RectWithBorder *vp_door = (j == 0 ? vp_door_1 : vp_door_2);
11799 if (vp_door->align == ALIGN_LEFT || vp_door->x > 0)
11800 vp_door->x = ALIGNED_VP_XPOS(vp_door);
11801 else if (vp_door->align == ALIGN_CENTER)
11802 vp_door->x = vp_window->width / 2 - vp_door->width / 2;
11803 else if (vp_door->align == ALIGN_RIGHT)
11804 vp_door->x += vp_window->width - vp_door->width;
11806 if (vp_door->valign == VALIGN_TOP || vp_door->y > 0)
11807 vp_door->y = ALIGNED_VP_YPOS(vp_door);
11808 else if (vp_door->valign == VALIGN_MIDDLE)
11809 vp_door->y = vp_window->height / 2 - vp_door->height / 2;
11810 else if (vp_door->valign == VALIGN_BOTTOM)
11811 vp_door->y += vp_window->height - vp_door->height;
11816 static void InitMenuDesignSettings_SpecialPostProcessing_AfterGraphics(void)
11820 struct XYTileSize *dst, *src;
11823 editor_buttons_xy[] =
11826 &editor.button.element_left, &editor.palette.element_left,
11827 IMG_GFX_EDITOR_BUTTON_ELEMENT_LEFT
11830 &editor.button.element_middle, &editor.palette.element_middle,
11831 IMG_GFX_EDITOR_BUTTON_ELEMENT_MIDDLE
11834 &editor.button.element_right, &editor.palette.element_right,
11835 IMG_GFX_EDITOR_BUTTON_ELEMENT_RIGHT
11842 // set default position for element buttons to element graphics
11843 for (i = 0; editor_buttons_xy[i].dst != NULL; i++)
11845 if ((*editor_buttons_xy[i].dst).x == -1 &&
11846 (*editor_buttons_xy[i].dst).y == -1)
11848 struct GraphicInfo *gd = &graphic_info[editor_buttons_xy[i].graphic];
11850 gd->width = gd->height = editor_buttons_xy[i].src->tile_size;
11852 *editor_buttons_xy[i].dst = *editor_buttons_xy[i].src;
11856 // adjust editor palette rows and columns if specified to be dynamic
11858 if (editor.palette.cols == -1)
11860 int vp_width = viewport.playfield[GFX_SPECIAL_ARG_EDITOR].width;
11861 int bt_width = graphic_info[IMG_EDITOR_PALETTE_BUTTON].width;
11862 int sc_width = graphic_info[IMG_EDITOR_PALETTE_SCROLLBAR].width;
11864 editor.palette.cols = (vp_width - sc_width) / bt_width;
11866 if (editor.palette.x == -1)
11868 int palette_width = editor.palette.cols * bt_width + sc_width;
11870 editor.palette.x = (vp_width - palette_width) / 2;
11874 if (editor.palette.rows == -1)
11876 int vp_height = viewport.playfield[GFX_SPECIAL_ARG_EDITOR].height;
11877 int bt_height = graphic_info[IMG_EDITOR_PALETTE_BUTTON].height;
11878 int tx_height = getFontHeight(FONT_TEXT_2);
11880 editor.palette.rows = (vp_height - tx_height) / bt_height;
11882 if (editor.palette.y == -1)
11884 int palette_height = editor.palette.rows * bt_height + tx_height;
11886 editor.palette.y = (vp_height - palette_height) / 2;
11891 static void LoadMenuDesignSettingsFromFilename(char *filename)
11893 static struct TitleFadingInfo tfi;
11894 static struct TitleMessageInfo tmi;
11895 static struct TokenInfo title_tokens[] =
11897 { TYPE_INTEGER, &tfi.fade_mode, ".fade_mode" },
11898 { TYPE_INTEGER, &tfi.fade_delay, ".fade_delay" },
11899 { TYPE_INTEGER, &tfi.post_delay, ".post_delay" },
11900 { TYPE_INTEGER, &tfi.auto_delay, ".auto_delay" },
11901 { TYPE_INTEGER, &tfi.auto_delay_unit, ".auto_delay_unit" },
11905 static struct TokenInfo titlemessage_tokens[] =
11907 { TYPE_INTEGER, &tmi.x, ".x" },
11908 { TYPE_INTEGER, &tmi.y, ".y" },
11909 { TYPE_INTEGER, &tmi.width, ".width" },
11910 { TYPE_INTEGER, &tmi.height, ".height" },
11911 { TYPE_INTEGER, &tmi.chars, ".chars" },
11912 { TYPE_INTEGER, &tmi.lines, ".lines" },
11913 { TYPE_INTEGER, &tmi.align, ".align" },
11914 { TYPE_INTEGER, &tmi.valign, ".valign" },
11915 { TYPE_INTEGER, &tmi.font, ".font" },
11916 { TYPE_BOOLEAN, &tmi.autowrap, ".autowrap" },
11917 { TYPE_BOOLEAN, &tmi.centered, ".centered" },
11918 { TYPE_BOOLEAN, &tmi.parse_comments, ".parse_comments" },
11919 { TYPE_INTEGER, &tmi.sort_priority, ".sort_priority" },
11920 { TYPE_INTEGER, &tmi.fade_mode, ".fade_mode" },
11921 { TYPE_INTEGER, &tmi.fade_delay, ".fade_delay" },
11922 { TYPE_INTEGER, &tmi.post_delay, ".post_delay" },
11923 { TYPE_INTEGER, &tmi.auto_delay, ".auto_delay" },
11924 { TYPE_INTEGER, &tmi.auto_delay_unit, ".auto_delay_unit" },
11930 struct TitleFadingInfo *info;
11935 // initialize first titles from "enter screen" definitions, if defined
11936 { &title_initial_first_default, "menu.enter_screen.TITLE" },
11937 { &title_first_default, "menu.enter_screen.TITLE" },
11939 // initialize title screens from "next screen" definitions, if defined
11940 { &title_initial_default, "menu.next_screen.TITLE" },
11941 { &title_default, "menu.next_screen.TITLE" },
11947 struct TitleMessageInfo *array;
11950 titlemessage_arrays[] =
11952 // initialize first titles from "enter screen" definitions, if defined
11953 { titlescreen_initial_first, "menu.enter_screen.TITLE" },
11954 { titlescreen_first, "menu.enter_screen.TITLE" },
11955 { titlemessage_initial_first, "menu.enter_screen.TITLE" },
11956 { titlemessage_first, "menu.enter_screen.TITLE" },
11958 // initialize titles from "next screen" definitions, if defined
11959 { titlescreen_initial, "menu.next_screen.TITLE" },
11960 { titlescreen, "menu.next_screen.TITLE" },
11961 { titlemessage_initial, "menu.next_screen.TITLE" },
11962 { titlemessage, "menu.next_screen.TITLE" },
11964 // overwrite titles with title definitions, if defined
11965 { titlescreen_initial_first, "[title_initial]" },
11966 { titlescreen_first, "[title]" },
11967 { titlemessage_initial_first, "[title_initial]" },
11968 { titlemessage_first, "[title]" },
11970 { titlescreen_initial, "[title_initial]" },
11971 { titlescreen, "[title]" },
11972 { titlemessage_initial, "[title_initial]" },
11973 { titlemessage, "[title]" },
11975 // overwrite titles with title screen/message definitions, if defined
11976 { titlescreen_initial_first, "[titlescreen_initial]" },
11977 { titlescreen_first, "[titlescreen]" },
11978 { titlemessage_initial_first, "[titlemessage_initial]" },
11979 { titlemessage_first, "[titlemessage]" },
11981 { titlescreen_initial, "[titlescreen_initial]" },
11982 { titlescreen, "[titlescreen]" },
11983 { titlemessage_initial, "[titlemessage_initial]" },
11984 { titlemessage, "[titlemessage]" },
11988 SetupFileHash *setup_file_hash;
11991 if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
11994 // the following initializes hierarchical values from dynamic configuration
11996 // special case: initialize with default values that may be overwritten
11997 // (e.g., init "menu.draw_xoffset.INFO" from "menu.draw_xoffset")
11998 for (i = 0; i < NUM_SPECIAL_GFX_ARGS; i++)
12000 struct TokenIntPtrInfo menu_config[] =
12002 { "menu.draw_xoffset", &menu.draw_xoffset[i] },
12003 { "menu.draw_yoffset", &menu.draw_yoffset[i] },
12004 { "menu.list_size", &menu.list_size[i] }
12007 for (j = 0; j < ARRAY_SIZE(menu_config); j++)
12009 char *token = menu_config[j].token;
12010 char *value = getHashEntry(setup_file_hash, token);
12013 *menu_config[j].value = get_integer_from_string(value);
12017 // special case: initialize with default values that may be overwritten
12018 // (eg, init "menu.draw_xoffset.INFO[XXX]" from "menu.draw_xoffset.INFO")
12019 for (i = 0; i < NUM_SPECIAL_GFX_INFO_ARGS; i++)
12021 struct TokenIntPtrInfo menu_config[] =
12023 { "menu.draw_xoffset.INFO", &menu.draw_xoffset_info[i] },
12024 { "menu.draw_yoffset.INFO", &menu.draw_yoffset_info[i] },
12025 { "menu.list_size.INFO", &menu.list_size_info[i] }
12028 for (j = 0; j < ARRAY_SIZE(menu_config); j++)
12030 char *token = menu_config[j].token;
12031 char *value = getHashEntry(setup_file_hash, token);
12034 *menu_config[j].value = get_integer_from_string(value);
12038 // special case: initialize with default values that may be overwritten
12039 // (eg, init "menu.draw_xoffset.SETUP[XXX]" from "menu.draw_xoffset.SETUP")
12040 for (i = 0; i < NUM_SPECIAL_GFX_SETUP_ARGS; i++)
12042 struct TokenIntPtrInfo menu_config[] =
12044 { "menu.draw_xoffset.SETUP", &menu.draw_xoffset_setup[i] },
12045 { "menu.draw_yoffset.SETUP", &menu.draw_yoffset_setup[i] }
12048 for (j = 0; j < ARRAY_SIZE(menu_config); j++)
12050 char *token = menu_config[j].token;
12051 char *value = getHashEntry(setup_file_hash, token);
12054 *menu_config[j].value = get_integer_from_string(value);
12058 // special case: initialize with default values that may be overwritten
12059 // (eg, init "menu.line_spacing.INFO[XXX]" from "menu.line_spacing.INFO")
12060 for (i = 0; i < NUM_SPECIAL_GFX_INFO_ARGS; i++)
12062 struct TokenIntPtrInfo menu_config[] =
12064 { "menu.left_spacing.INFO", &menu.left_spacing_info[i] },
12065 { "menu.right_spacing.INFO", &menu.right_spacing_info[i] },
12066 { "menu.top_spacing.INFO", &menu.top_spacing_info[i] },
12067 { "menu.bottom_spacing.INFO", &menu.bottom_spacing_info[i] },
12068 { "menu.paragraph_spacing.INFO", &menu.paragraph_spacing_info[i] },
12069 { "menu.headline1_spacing.INFO", &menu.headline1_spacing_info[i] },
12070 { "menu.headline2_spacing.INFO", &menu.headline2_spacing_info[i] },
12071 { "menu.line_spacing.INFO", &menu.line_spacing_info[i] },
12072 { "menu.extra_spacing.INFO", &menu.extra_spacing_info[i] },
12075 for (j = 0; j < ARRAY_SIZE(menu_config); j++)
12077 char *token = menu_config[j].token;
12078 char *value = getHashEntry(setup_file_hash, token);
12081 *menu_config[j].value = get_integer_from_string(value);
12085 // special case: initialize with default values that may be overwritten
12086 // (eg, init "menu.enter_screen.SCORES.xyz" from "menu.enter_screen.xyz")
12087 for (i = 0; i < NUM_SPECIAL_GFX_ARGS; i++)
12089 struct TokenIntPtrInfo menu_config[] =
12091 { "menu.enter_screen.fade_mode", &menu.enter_screen[i].fade_mode },
12092 { "menu.enter_screen.fade_delay", &menu.enter_screen[i].fade_delay },
12093 { "menu.enter_screen.post_delay", &menu.enter_screen[i].post_delay },
12094 { "menu.leave_screen.fade_mode", &menu.leave_screen[i].fade_mode },
12095 { "menu.leave_screen.fade_delay", &menu.leave_screen[i].fade_delay },
12096 { "menu.leave_screen.post_delay", &menu.leave_screen[i].post_delay },
12097 { "menu.next_screen.fade_mode", &menu.next_screen[i].fade_mode },
12098 { "menu.next_screen.fade_delay", &menu.next_screen[i].fade_delay },
12099 { "menu.next_screen.post_delay", &menu.next_screen[i].post_delay }
12102 for (j = 0; j < ARRAY_SIZE(menu_config); j++)
12104 char *token = menu_config[j].token;
12105 char *value = getHashEntry(setup_file_hash, token);
12108 *menu_config[j].value = get_token_parameter_value(token, value);
12112 // special case: initialize with default values that may be overwritten
12113 // (eg, init "viewport.door_1.MAIN.xyz" from "viewport.door_1.xyz")
12114 for (i = 0; i < NUM_SPECIAL_GFX_ARGS; i++)
12118 char *token_prefix;
12119 struct RectWithBorder *struct_ptr;
12123 { "viewport.window", &viewport.window[i] },
12124 { "viewport.playfield", &viewport.playfield[i] },
12125 { "viewport.door_1", &viewport.door_1[i] },
12126 { "viewport.door_2", &viewport.door_2[i] }
12129 for (j = 0; j < ARRAY_SIZE(vp_struct); j++)
12131 struct TokenIntPtrInfo vp_config[] =
12133 { ".x", &vp_struct[j].struct_ptr->x },
12134 { ".y", &vp_struct[j].struct_ptr->y },
12135 { ".width", &vp_struct[j].struct_ptr->width },
12136 { ".height", &vp_struct[j].struct_ptr->height },
12137 { ".min_width", &vp_struct[j].struct_ptr->min_width },
12138 { ".min_height", &vp_struct[j].struct_ptr->min_height },
12139 { ".max_width", &vp_struct[j].struct_ptr->max_width },
12140 { ".max_height", &vp_struct[j].struct_ptr->max_height },
12141 { ".margin_left", &vp_struct[j].struct_ptr->margin_left },
12142 { ".margin_right", &vp_struct[j].struct_ptr->margin_right },
12143 { ".margin_top", &vp_struct[j].struct_ptr->margin_top },
12144 { ".margin_bottom", &vp_struct[j].struct_ptr->margin_bottom },
12145 { ".border_left", &vp_struct[j].struct_ptr->border_left },
12146 { ".border_right", &vp_struct[j].struct_ptr->border_right },
12147 { ".border_top", &vp_struct[j].struct_ptr->border_top },
12148 { ".border_bottom", &vp_struct[j].struct_ptr->border_bottom },
12149 { ".border_size", &vp_struct[j].struct_ptr->border_size },
12150 { ".align_size", &vp_struct[j].struct_ptr->align_size },
12151 { ".align", &vp_struct[j].struct_ptr->align },
12152 { ".valign", &vp_struct[j].struct_ptr->valign }
12155 for (k = 0; k < ARRAY_SIZE(vp_config); k++)
12157 char *token = getStringCat2(vp_struct[j].token_prefix,
12158 vp_config[k].token);
12159 char *value = getHashEntry(setup_file_hash, token);
12162 *vp_config[k].value = get_token_parameter_value(token, value);
12169 // special case: initialize with default values that may be overwritten
12170 // (e.g., init "[title].fade_mode" from "menu.next_screen.TITLE.fade_mode")
12171 for (i = 0; title_info[i].info != NULL; i++)
12173 struct TitleFadingInfo *info = title_info[i].info;
12174 char *base_token = title_info[i].text;
12176 for (j = 0; title_tokens[j].type != -1; j++)
12178 char *token = getStringCat2(base_token, title_tokens[j].text);
12179 char *value = getHashEntry(setup_file_hash, token);
12183 int parameter_value = get_token_parameter_value(token, value);
12187 *(int *)title_tokens[j].value = (int)parameter_value;
12196 // special case: initialize with default values that may be overwritten
12197 // (e.g., init "titlemessage_1.fade_mode" from "[titlemessage].fade_mode")
12198 for (i = 0; titlemessage_arrays[i].array != NULL; i++)
12200 struct TitleMessageInfo *array = titlemessage_arrays[i].array;
12201 char *base_token = titlemessage_arrays[i].text;
12203 for (j = 0; titlemessage_tokens[j].type != -1; j++)
12205 char *token = getStringCat2(base_token, titlemessage_tokens[j].text);
12206 char *value = getHashEntry(setup_file_hash, token);
12210 int parameter_value = get_token_parameter_value(token, value);
12212 for (k = 0; k < MAX_NUM_TITLE_MESSAGES; k++)
12216 if (titlemessage_tokens[j].type == TYPE_INTEGER)
12217 *(int *)titlemessage_tokens[j].value = (int)parameter_value;
12219 *(boolean *)titlemessage_tokens[j].value = (boolean)parameter_value;
12229 // special case: check if network and preview player positions are redefined,
12230 // to compare this later against the main menu level preview being redefined
12231 struct TokenIntPtrInfo menu_config_players[] =
12233 { "main.network_players.x", &menu.main.network_players.redefined },
12234 { "main.network_players.y", &menu.main.network_players.redefined },
12235 { "main.preview_players.x", &menu.main.preview_players.redefined },
12236 { "main.preview_players.y", &menu.main.preview_players.redefined },
12237 { "preview.x", &preview.redefined },
12238 { "preview.y", &preview.redefined }
12241 for (i = 0; i < ARRAY_SIZE(menu_config_players); i++)
12242 *menu_config_players[i].value = FALSE;
12244 for (i = 0; i < ARRAY_SIZE(menu_config_players); i++)
12245 if (getHashEntry(setup_file_hash, menu_config_players[i].token) != NULL)
12246 *menu_config_players[i].value = TRUE;
12248 // read (and overwrite with) values that may be specified in config file
12249 for (i = 0; image_config_vars[i].token != NULL; i++)
12251 char *value = getHashEntry(setup_file_hash, image_config_vars[i].token);
12253 // (ignore definitions set to "[DEFAULT]" which are already initialized)
12254 if (value != NULL && !strEqual(value, ARG_DEFAULT))
12255 *image_config_vars[i].value =
12256 get_token_parameter_value(image_config_vars[i].token, value);
12259 freeSetupFileHash(setup_file_hash);
12262 void LoadMenuDesignSettings(void)
12264 char *filename_base = UNDEFINED_FILENAME, *filename_local;
12266 InitMenuDesignSettings_Static();
12267 InitMenuDesignSettings_SpecialPreProcessing();
12269 if (!GFX_OVERRIDE_ARTWORK(ARTWORK_TYPE_GRAPHICS))
12271 // first look for special settings configured in level series config
12272 filename_base = getCustomArtworkLevelConfigFilename(ARTWORK_TYPE_GRAPHICS);
12274 if (fileExists(filename_base))
12275 LoadMenuDesignSettingsFromFilename(filename_base);
12278 filename_local = getCustomArtworkConfigFilename(ARTWORK_TYPE_GRAPHICS);
12280 if (filename_local != NULL && !strEqual(filename_base, filename_local))
12281 LoadMenuDesignSettingsFromFilename(filename_local);
12283 InitMenuDesignSettings_SpecialPostProcessing();
12286 void LoadMenuDesignSettings_AfterGraphics(void)
12288 InitMenuDesignSettings_SpecialPostProcessing_AfterGraphics();
12291 void LoadUserDefinedEditorElementList(int **elements, int *num_elements)
12293 char *filename = getEditorSetupFilename();
12294 SetupFileList *setup_file_list, *list;
12295 SetupFileHash *element_hash;
12296 int num_unknown_tokens = 0;
12299 if ((setup_file_list = loadSetupFileList(filename)) == NULL)
12302 element_hash = newSetupFileHash();
12304 for (i = 0; i < NUM_FILE_ELEMENTS; i++)
12305 setHashEntry(element_hash, element_info[i].token_name, i_to_a(i));
12307 // determined size may be larger than needed (due to unknown elements)
12309 for (list = setup_file_list; list != NULL; list = list->next)
12312 // add space for up to 3 more elements for padding that may be needed
12313 *num_elements += 3;
12315 // free memory for old list of elements, if needed
12316 checked_free(*elements);
12318 // allocate memory for new list of elements
12319 *elements = checked_malloc(*num_elements * sizeof(int));
12322 for (list = setup_file_list; list != NULL; list = list->next)
12324 char *value = getHashEntry(element_hash, list->token);
12326 if (value == NULL) // try to find obsolete token mapping
12328 char *mapped_token = get_mapped_token(list->token);
12330 if (mapped_token != NULL)
12332 value = getHashEntry(element_hash, mapped_token);
12334 free(mapped_token);
12340 (*elements)[(*num_elements)++] = atoi(value);
12344 if (num_unknown_tokens == 0)
12347 Warn("unknown token(s) found in config file:");
12348 Warn("- config file: '%s'", filename);
12350 num_unknown_tokens++;
12353 Warn("- token: '%s'", list->token);
12357 if (num_unknown_tokens > 0)
12360 while (*num_elements % 4) // pad with empty elements, if needed
12361 (*elements)[(*num_elements)++] = EL_EMPTY;
12363 freeSetupFileList(setup_file_list);
12364 freeSetupFileHash(element_hash);
12367 for (i = 0; i < *num_elements; i++)
12368 Debug("editor", "element '%s' [%d]\n",
12369 element_info[(*elements)[i]].token_name, (*elements)[i]);
12373 static struct MusicFileInfo *get_music_file_info_ext(char *basename, int music,
12376 SetupFileHash *setup_file_hash = NULL;
12377 struct MusicFileInfo tmp_music_file_info, *new_music_file_info;
12378 char *filename_music, *filename_prefix, *filename_info;
12384 token_to_value_ptr[] =
12386 { "title_header", &tmp_music_file_info.title_header },
12387 { "artist_header", &tmp_music_file_info.artist_header },
12388 { "album_header", &tmp_music_file_info.album_header },
12389 { "year_header", &tmp_music_file_info.year_header },
12391 { "title", &tmp_music_file_info.title },
12392 { "artist", &tmp_music_file_info.artist },
12393 { "album", &tmp_music_file_info.album },
12394 { "year", &tmp_music_file_info.year },
12400 filename_music = (is_sound ? getCustomSoundFilename(basename) :
12401 getCustomMusicFilename(basename));
12403 if (filename_music == NULL)
12406 // ---------- try to replace file extension ----------
12408 filename_prefix = getStringCopy(filename_music);
12409 if (strrchr(filename_prefix, '.') != NULL)
12410 *strrchr(filename_prefix, '.') = '\0';
12411 filename_info = getStringCat2(filename_prefix, ".txt");
12413 if (fileExists(filename_info))
12414 setup_file_hash = loadSetupFileHash(filename_info);
12416 free(filename_prefix);
12417 free(filename_info);
12419 if (setup_file_hash == NULL)
12421 // ---------- try to add file extension ----------
12423 filename_prefix = getStringCopy(filename_music);
12424 filename_info = getStringCat2(filename_prefix, ".txt");
12426 if (fileExists(filename_info))
12427 setup_file_hash = loadSetupFileHash(filename_info);
12429 free(filename_prefix);
12430 free(filename_info);
12433 if (setup_file_hash == NULL)
12436 // ---------- music file info found ----------
12438 clear_mem(&tmp_music_file_info, sizeof(struct MusicFileInfo));
12440 for (i = 0; token_to_value_ptr[i].token != NULL; i++)
12442 char *value = getHashEntry(setup_file_hash, token_to_value_ptr[i].token);
12444 *token_to_value_ptr[i].value_ptr =
12445 getStringCopy(value != NULL && *value != '\0' ? value : UNKNOWN_NAME);
12448 tmp_music_file_info.basename = getStringCopy(basename);
12449 tmp_music_file_info.music = music;
12450 tmp_music_file_info.is_sound = is_sound;
12452 new_music_file_info = checked_malloc(sizeof(struct MusicFileInfo));
12453 *new_music_file_info = tmp_music_file_info;
12455 return new_music_file_info;
12458 static struct MusicFileInfo *get_music_file_info(char *basename, int music)
12460 return get_music_file_info_ext(basename, music, FALSE);
12463 static struct MusicFileInfo *get_sound_file_info(char *basename, int sound)
12465 return get_music_file_info_ext(basename, sound, TRUE);
12468 static boolean music_info_listed_ext(struct MusicFileInfo *list,
12469 char *basename, boolean is_sound)
12471 for (; list != NULL; list = list->next)
12472 if (list->is_sound == is_sound && strEqual(list->basename, basename))
12478 static boolean music_info_listed(struct MusicFileInfo *list, char *basename)
12480 return music_info_listed_ext(list, basename, FALSE);
12483 static boolean sound_info_listed(struct MusicFileInfo *list, char *basename)
12485 return music_info_listed_ext(list, basename, TRUE);
12488 void LoadMusicInfo(void)
12490 char *music_directory = getCustomMusicDirectory();
12491 int num_music = getMusicListSize();
12492 int num_music_noconf = 0;
12493 int num_sounds = getSoundListSize();
12495 DirectoryEntry *dir_entry;
12496 struct FileInfo *music, *sound;
12497 struct MusicFileInfo *next, **new;
12500 while (music_file_info != NULL)
12502 next = music_file_info->next;
12504 checked_free(music_file_info->basename);
12506 checked_free(music_file_info->title_header);
12507 checked_free(music_file_info->artist_header);
12508 checked_free(music_file_info->album_header);
12509 checked_free(music_file_info->year_header);
12511 checked_free(music_file_info->title);
12512 checked_free(music_file_info->artist);
12513 checked_free(music_file_info->album);
12514 checked_free(music_file_info->year);
12516 free(music_file_info);
12518 music_file_info = next;
12521 new = &music_file_info;
12523 for (i = 0; i < num_music; i++)
12525 music = getMusicListEntry(i);
12527 if (music->filename == NULL)
12530 if (strEqual(music->filename, UNDEFINED_FILENAME))
12533 // a configured file may be not recognized as music
12534 if (!FileIsMusic(music->filename))
12537 if (!music_info_listed(music_file_info, music->filename))
12539 *new = get_music_file_info(music->filename, i);
12542 new = &(*new)->next;
12546 if ((dir = openDirectory(music_directory)) == NULL)
12548 Warn("cannot read music directory '%s'", music_directory);
12553 while ((dir_entry = readDirectory(dir)) != NULL) // loop all entries
12555 char *basename = dir_entry->basename;
12556 boolean music_already_used = FALSE;
12559 // skip all music files that are configured in music config file
12560 for (i = 0; i < num_music; i++)
12562 music = getMusicListEntry(i);
12564 if (music->filename == NULL)
12567 if (strEqual(basename, music->filename))
12569 music_already_used = TRUE;
12574 if (music_already_used)
12577 if (!FileIsMusic(dir_entry->filename))
12580 if (!music_info_listed(music_file_info, basename))
12582 *new = get_music_file_info(basename, MAP_NOCONF_MUSIC(num_music_noconf));
12585 new = &(*new)->next;
12588 num_music_noconf++;
12591 closeDirectory(dir);
12593 for (i = 0; i < num_sounds; i++)
12595 sound = getSoundListEntry(i);
12597 if (sound->filename == NULL)
12600 if (strEqual(sound->filename, UNDEFINED_FILENAME))
12603 // a configured file may be not recognized as sound
12604 if (!FileIsSound(sound->filename))
12607 if (!sound_info_listed(music_file_info, sound->filename))
12609 *new = get_sound_file_info(sound->filename, i);
12611 new = &(*new)->next;
12616 static void add_helpanim_entry(int element, int action, int direction,
12617 int delay, int *num_list_entries)
12619 struct HelpAnimInfo *new_list_entry;
12620 (*num_list_entries)++;
12623 checked_realloc(helpanim_info,
12624 *num_list_entries * sizeof(struct HelpAnimInfo));
12625 new_list_entry = &helpanim_info[*num_list_entries - 1];
12627 new_list_entry->element = element;
12628 new_list_entry->action = action;
12629 new_list_entry->direction = direction;
12630 new_list_entry->delay = delay;
12633 static void print_unknown_token(char *filename, char *token, int token_nr)
12638 Warn("unknown token(s) found in config file:");
12639 Warn("- config file: '%s'", filename);
12642 Warn("- token: '%s'", token);
12645 static void print_unknown_token_end(int token_nr)
12651 void LoadHelpAnimInfo(void)
12653 char *filename = getHelpAnimFilename();
12654 SetupFileList *setup_file_list = NULL, *list;
12655 SetupFileHash *element_hash, *action_hash, *direction_hash;
12656 int num_list_entries = 0;
12657 int num_unknown_tokens = 0;
12660 if (fileExists(filename))
12661 setup_file_list = loadSetupFileList(filename);
12663 if (setup_file_list == NULL)
12665 // use reliable default values from static configuration
12666 SetupFileList *insert_ptr;
12668 insert_ptr = setup_file_list =
12669 newSetupFileList(helpanim_config[0].token,
12670 helpanim_config[0].value);
12672 for (i = 1; helpanim_config[i].token; i++)
12673 insert_ptr = addListEntry(insert_ptr,
12674 helpanim_config[i].token,
12675 helpanim_config[i].value);
12678 element_hash = newSetupFileHash();
12679 action_hash = newSetupFileHash();
12680 direction_hash = newSetupFileHash();
12682 for (i = 0; i < MAX_NUM_ELEMENTS; i++)
12683 setHashEntry(element_hash, element_info[i].token_name, i_to_a(i));
12685 for (i = 0; i < NUM_ACTIONS; i++)
12686 setHashEntry(action_hash, element_action_info[i].suffix,
12687 i_to_a(element_action_info[i].value));
12689 // do not store direction index (bit) here, but direction value!
12690 for (i = 0; i < NUM_DIRECTIONS_FULL; i++)
12691 setHashEntry(direction_hash, element_direction_info[i].suffix,
12692 i_to_a(1 << element_direction_info[i].value));
12694 for (list = setup_file_list; list != NULL; list = list->next)
12696 char *element_token, *action_token, *direction_token;
12697 char *element_value, *action_value, *direction_value;
12698 int delay = atoi(list->value);
12700 if (strEqual(list->token, "end"))
12702 add_helpanim_entry(HELPANIM_LIST_NEXT, -1, -1, -1, &num_list_entries);
12707 /* first try to break element into element/action/direction parts;
12708 if this does not work, also accept combined "element[.act][.dir]"
12709 elements (like "dynamite.active"), which are unique elements */
12711 if (strchr(list->token, '.') == NULL) // token contains no '.'
12713 element_value = getHashEntry(element_hash, list->token);
12714 if (element_value != NULL) // element found
12715 add_helpanim_entry(atoi(element_value), -1, -1, delay,
12716 &num_list_entries);
12719 // no further suffixes found -- this is not an element
12720 print_unknown_token(filename, list->token, num_unknown_tokens++);
12726 // token has format "<prefix>.<something>"
12728 action_token = strchr(list->token, '.'); // suffix may be action ...
12729 direction_token = action_token; // ... or direction
12731 element_token = getStringCopy(list->token);
12732 *strchr(element_token, '.') = '\0';
12734 element_value = getHashEntry(element_hash, element_token);
12736 if (element_value == NULL) // this is no element
12738 element_value = getHashEntry(element_hash, list->token);
12739 if (element_value != NULL) // combined element found
12740 add_helpanim_entry(atoi(element_value), -1, -1, delay,
12741 &num_list_entries);
12743 print_unknown_token(filename, list->token, num_unknown_tokens++);
12745 free(element_token);
12750 action_value = getHashEntry(action_hash, action_token);
12752 if (action_value != NULL) // action found
12754 add_helpanim_entry(atoi(element_value), atoi(action_value), -1, delay,
12755 &num_list_entries);
12757 free(element_token);
12762 direction_value = getHashEntry(direction_hash, direction_token);
12764 if (direction_value != NULL) // direction found
12766 add_helpanim_entry(atoi(element_value), -1, atoi(direction_value), delay,
12767 &num_list_entries);
12769 free(element_token);
12774 if (strchr(action_token + 1, '.') == NULL)
12776 // no further suffixes found -- this is not an action nor direction
12778 element_value = getHashEntry(element_hash, list->token);
12779 if (element_value != NULL) // combined element found
12780 add_helpanim_entry(atoi(element_value), -1, -1, delay,
12781 &num_list_entries);
12783 print_unknown_token(filename, list->token, num_unknown_tokens++);
12785 free(element_token);
12790 // token has format "<prefix>.<suffix>.<something>"
12792 direction_token = strchr(action_token + 1, '.');
12794 action_token = getStringCopy(action_token);
12795 *strchr(action_token + 1, '.') = '\0';
12797 action_value = getHashEntry(action_hash, action_token);
12799 if (action_value == NULL) // this is no action
12801 element_value = getHashEntry(element_hash, list->token);
12802 if (element_value != NULL) // combined element found
12803 add_helpanim_entry(atoi(element_value), -1, -1, delay,
12804 &num_list_entries);
12806 print_unknown_token(filename, list->token, num_unknown_tokens++);
12808 free(element_token);
12809 free(action_token);
12814 direction_value = getHashEntry(direction_hash, direction_token);
12816 if (direction_value != NULL) // direction found
12818 add_helpanim_entry(atoi(element_value), atoi(action_value),
12819 atoi(direction_value), delay, &num_list_entries);
12821 free(element_token);
12822 free(action_token);
12827 // this is no direction
12829 element_value = getHashEntry(element_hash, list->token);
12830 if (element_value != NULL) // combined element found
12831 add_helpanim_entry(atoi(element_value), -1, -1, delay,
12832 &num_list_entries);
12834 print_unknown_token(filename, list->token, num_unknown_tokens++);
12836 free(element_token);
12837 free(action_token);
12840 print_unknown_token_end(num_unknown_tokens);
12842 add_helpanim_entry(HELPANIM_LIST_NEXT, -1, -1, -1, &num_list_entries);
12843 add_helpanim_entry(HELPANIM_LIST_END, -1, -1, -1, &num_list_entries);
12845 freeSetupFileList(setup_file_list);
12846 freeSetupFileHash(element_hash);
12847 freeSetupFileHash(action_hash);
12848 freeSetupFileHash(direction_hash);
12851 for (i = 0; i < num_list_entries; i++)
12852 Debug("files:LoadHelpAnimInfo", "'%s': %d, %d, %d => %d",
12853 EL_NAME(helpanim_info[i].element),
12854 helpanim_info[i].element,
12855 helpanim_info[i].action,
12856 helpanim_info[i].direction,
12857 helpanim_info[i].delay);
12861 void LoadHelpTextInfo(void)
12863 char *filename = getHelpTextFilename();
12866 if (helptext_info != NULL)
12868 freeSetupFileHash(helptext_info);
12869 helptext_info = NULL;
12872 if (fileExists(filename))
12873 helptext_info = loadSetupFileHash(filename);
12875 if (helptext_info == NULL)
12877 // use reliable default values from static configuration
12878 helptext_info = newSetupFileHash();
12880 for (i = 0; helptext_config[i].token; i++)
12881 setHashEntry(helptext_info,
12882 helptext_config[i].token,
12883 helptext_config[i].value);
12887 BEGIN_HASH_ITERATION(helptext_info, itr)
12889 Debug("files:LoadHelpTextInfo", "'%s' => '%s'",
12890 HASH_ITERATION_TOKEN(itr), HASH_ITERATION_VALUE(itr));
12892 END_HASH_ITERATION(hash, itr)
12897 // ----------------------------------------------------------------------------
12899 // ----------------------------------------------------------------------------
12901 #define MAX_NUM_CONVERT_LEVELS 1000
12903 void ConvertLevels(void)
12905 static LevelDirTree *convert_leveldir = NULL;
12906 static int convert_level_nr = -1;
12907 static int num_levels_handled = 0;
12908 static int num_levels_converted = 0;
12909 static boolean levels_failed[MAX_NUM_CONVERT_LEVELS];
12912 convert_leveldir = getTreeInfoFromIdentifier(leveldir_first,
12913 global.convert_leveldir);
12915 if (convert_leveldir == NULL)
12916 Fail("no such level identifier: '%s'", global.convert_leveldir);
12918 leveldir_current = convert_leveldir;
12920 if (global.convert_level_nr != -1)
12922 convert_leveldir->first_level = global.convert_level_nr;
12923 convert_leveldir->last_level = global.convert_level_nr;
12926 convert_level_nr = convert_leveldir->first_level;
12928 PrintLine("=", 79);
12929 Print("Converting levels\n");
12930 PrintLine("-", 79);
12931 Print("Level series identifier: '%s'\n", convert_leveldir->identifier);
12932 Print("Level series name: '%s'\n", convert_leveldir->name);
12933 Print("Level series author: '%s'\n", convert_leveldir->author);
12934 Print("Number of levels: %d\n", convert_leveldir->levels);
12935 PrintLine("=", 79);
12938 for (i = 0; i < MAX_NUM_CONVERT_LEVELS; i++)
12939 levels_failed[i] = FALSE;
12941 while (convert_level_nr <= convert_leveldir->last_level)
12943 char *level_filename;
12946 level_nr = convert_level_nr++;
12948 Print("Level %03d: ", level_nr);
12950 LoadLevel(level_nr);
12951 if (level.no_level_file || level.no_valid_file)
12953 Print("(no level)\n");
12957 Print("converting level ... ");
12959 level_filename = getDefaultLevelFilename(level_nr);
12960 new_level = !fileExists(level_filename);
12964 SaveLevel(level_nr);
12966 num_levels_converted++;
12968 Print("converted.\n");
12972 if (level_nr >= 0 && level_nr < MAX_NUM_CONVERT_LEVELS)
12973 levels_failed[level_nr] = TRUE;
12975 Print("NOT CONVERTED -- LEVEL ALREADY EXISTS.\n");
12978 num_levels_handled++;
12982 PrintLine("=", 79);
12983 Print("Number of levels handled: %d\n", num_levels_handled);
12984 Print("Number of levels converted: %d (%d%%)\n", num_levels_converted,
12985 (num_levels_handled ?
12986 num_levels_converted * 100 / num_levels_handled : 0));
12987 PrintLine("-", 79);
12988 Print("Summary (for automatic parsing by scripts):\n");
12989 Print("LEVELDIR '%s', CONVERTED %d/%d (%d%%)",
12990 convert_leveldir->identifier, num_levels_converted,
12991 num_levels_handled,
12992 (num_levels_handled ?
12993 num_levels_converted * 100 / num_levels_handled : 0));
12995 if (num_levels_handled != num_levels_converted)
12997 Print(", FAILED:");
12998 for (i = 0; i < MAX_NUM_CONVERT_LEVELS; i++)
12999 if (levels_failed[i])
13004 PrintLine("=", 79);
13006 CloseAllAndExit(0);
13010 // ----------------------------------------------------------------------------
13011 // create and save images for use in level sketches (raw BMP format)
13012 // ----------------------------------------------------------------------------
13014 void CreateLevelSketchImages(void)
13020 InitElementPropertiesGfxElement();
13022 bitmap1 = CreateBitmap(TILEX, TILEY, DEFAULT_DEPTH);
13023 bitmap2 = CreateBitmap(MINI_TILEX, MINI_TILEY, DEFAULT_DEPTH);
13025 for (i = 0; i < NUM_FILE_ELEMENTS; i++)
13027 int element = getMappedElement(i);
13028 char basename1[16];
13029 char basename2[16];
13033 sprintf(basename1, "%04d.bmp", i);
13034 sprintf(basename2, "%04ds.bmp", i);
13036 filename1 = getPath2(global.create_images_dir, basename1);
13037 filename2 = getPath2(global.create_images_dir, basename2);
13039 DrawSizedElement(0, 0, element, TILESIZE);
13040 BlitBitmap(drawto, bitmap1, SX, SY, TILEX, TILEY, 0, 0);
13042 if (SDL_SaveBMP(bitmap1->surface, filename1) != 0)
13043 Fail("cannot save level sketch image file '%s'", filename1);
13045 DrawSizedElement(0, 0, element, MINI_TILESIZE);
13046 BlitBitmap(drawto, bitmap2, SX, SY, MINI_TILEX, MINI_TILEY, 0, 0);
13048 if (SDL_SaveBMP(bitmap2->surface, filename2) != 0)
13049 Fail("cannot save level sketch image file '%s'", filename2);
13054 // create corresponding SQL statements (for normal and small images)
13057 printf("insert into phpbb_words values (NULL, '`%03d', '<IMG class=\"levelsketch\" src=\"/I/%04d.png\"/>');\n", i, i);
13058 printf("insert into phpbb_words values (NULL, '¸%03d', '<IMG class=\"levelsketch\" src=\"/I/%04ds.png\"/>');\n", i, i);
13061 printf("insert into phpbb_words values (NULL, '`%04d', '<IMG class=\"levelsketch\" src=\"/I/%04d.png\"/>');\n", i, i);
13062 printf("insert into phpbb_words values (NULL, '¸%04d', '<IMG class=\"levelsketch\" src=\"/I/%04ds.png\"/>');\n", i, i);
13064 // optional: create content for forum level sketch demonstration post
13066 fprintf(stderr, "%03d `%03d%c", i, i, (i % 10 < 9 ? ' ' : '\n'));
13069 FreeBitmap(bitmap1);
13070 FreeBitmap(bitmap2);
13073 fprintf(stderr, "\n");
13075 Info("%d normal and small images created", NUM_FILE_ELEMENTS);
13077 CloseAllAndExit(0);
13081 // ----------------------------------------------------------------------------
13082 // create and save images for custom and group elements (raw BMP format)
13083 // ----------------------------------------------------------------------------
13085 void CreateCustomElementImages(char *directory)
13087 char *src_basename = "RocksCE-template.ilbm";
13088 char *dst_basename = "RocksCE.bmp";
13089 char *src_filename = getPath2(directory, src_basename);
13090 char *dst_filename = getPath2(directory, dst_basename);
13091 Bitmap *src_bitmap;
13093 int yoffset_ce = 0;
13094 int yoffset_ge = (TILEY * NUM_CUSTOM_ELEMENTS / 16);
13097 InitVideoDefaults();
13099 ReCreateBitmap(&backbuffer, video.width, video.height);
13101 src_bitmap = LoadImage(src_filename);
13103 bitmap = CreateBitmap(TILEX * 16 * 2,
13104 TILEY * (NUM_CUSTOM_ELEMENTS + NUM_GROUP_ELEMENTS) / 16,
13107 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
13114 BlitBitmap(src_bitmap, bitmap, 0, 0, TILEX, TILEY,
13115 TILEX * x, TILEY * y + yoffset_ce);
13117 BlitBitmap(src_bitmap, bitmap, 0, TILEY,
13119 TILEX * x + TILEX * 16,
13120 TILEY * y + yoffset_ce);
13122 for (j = 2; j >= 0; j--)
13126 BlitBitmap(src_bitmap, bitmap,
13127 TILEX + c * 7, 0, 6, 10,
13128 TILEX * x + 6 + j * 7,
13129 TILEY * y + 11 + yoffset_ce);
13131 BlitBitmap(src_bitmap, bitmap,
13132 TILEX + c * 8, TILEY, 6, 10,
13133 TILEX * 16 + TILEX * x + 6 + j * 8,
13134 TILEY * y + 10 + yoffset_ce);
13140 for (i = 0; i < NUM_GROUP_ELEMENTS; i++)
13147 BlitBitmap(src_bitmap, bitmap, 0, 0, TILEX, TILEY,
13148 TILEX * x, TILEY * y + yoffset_ge);
13150 BlitBitmap(src_bitmap, bitmap, 0, TILEY,
13152 TILEX * x + TILEX * 16,
13153 TILEY * y + yoffset_ge);
13155 for (j = 1; j >= 0; j--)
13159 BlitBitmap(src_bitmap, bitmap, TILEX + c * 10, 11, 10, 10,
13160 TILEX * x + 6 + j * 10,
13161 TILEY * y + 11 + yoffset_ge);
13163 BlitBitmap(src_bitmap, bitmap,
13164 TILEX + c * 8, TILEY + 12, 6, 10,
13165 TILEX * 16 + TILEX * x + 10 + j * 8,
13166 TILEY * y + 10 + yoffset_ge);
13172 if (SDL_SaveBMP(bitmap->surface, dst_filename) != 0)
13173 Fail("cannot save CE graphics file '%s'", dst_filename);
13175 FreeBitmap(bitmap);
13177 CloseAllAndExit(0);