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
332 TYPE_BOOLEAN, CONF_VALUE_8_BIT(17),
333 &li.keep_walkable_ce, FALSE
336 // (these values are different for each player)
339 TYPE_INTEGER, CONF_VALUE_8_BIT(7),
340 &li.initial_player_stepsize[0], STEPSIZE_NORMAL
344 TYPE_BOOLEAN, CONF_VALUE_8_BIT(8),
345 &li.initial_player_gravity[0], FALSE
349 TYPE_BOOLEAN, CONF_VALUE_8_BIT(9),
350 &li.use_start_element[0], FALSE
354 TYPE_ELEMENT, CONF_VALUE_16_BIT(1),
355 &li.start_element[0], EL_PLAYER_1
359 TYPE_BOOLEAN, CONF_VALUE_8_BIT(10),
360 &li.use_artwork_element[0], FALSE
364 TYPE_ELEMENT, CONF_VALUE_16_BIT(2),
365 &li.artwork_element[0], EL_PLAYER_1
369 TYPE_BOOLEAN, CONF_VALUE_8_BIT(11),
370 &li.use_explosion_element[0], FALSE
374 TYPE_ELEMENT, CONF_VALUE_16_BIT(3),
375 &li.explosion_element[0], EL_PLAYER_1
379 TYPE_BOOLEAN, CONF_VALUE_8_BIT(13),
380 &li.use_initial_inventory[0], FALSE
384 TYPE_BOOLEAN, CONF_VALUE_8_BIT(14),
385 &li.initial_inventory_size[0], 1
389 TYPE_ELEMENT_LIST, CONF_VALUE_BYTES(1),
390 &li.initial_inventory_content[0][0],EL_EMPTY, NULL,
391 &li.initial_inventory_size[0], 1, MAX_INITIAL_INVENTORY_SIZE
396 TYPE_INTEGER, CONF_VALUE_8_BIT(7),
397 &li.initial_player_stepsize[1], STEPSIZE_NORMAL
401 TYPE_BOOLEAN, CONF_VALUE_8_BIT(8),
402 &li.initial_player_gravity[1], FALSE
406 TYPE_BOOLEAN, CONF_VALUE_8_BIT(9),
407 &li.use_start_element[1], FALSE
411 TYPE_ELEMENT, CONF_VALUE_16_BIT(1),
412 &li.start_element[1], EL_PLAYER_2
416 TYPE_BOOLEAN, CONF_VALUE_8_BIT(10),
417 &li.use_artwork_element[1], FALSE
421 TYPE_ELEMENT, CONF_VALUE_16_BIT(2),
422 &li.artwork_element[1], EL_PLAYER_2
426 TYPE_BOOLEAN, CONF_VALUE_8_BIT(11),
427 &li.use_explosion_element[1], FALSE
431 TYPE_ELEMENT, CONF_VALUE_16_BIT(3),
432 &li.explosion_element[1], EL_PLAYER_2
436 TYPE_BOOLEAN, CONF_VALUE_8_BIT(13),
437 &li.use_initial_inventory[1], FALSE
441 TYPE_BOOLEAN, CONF_VALUE_8_BIT(14),
442 &li.initial_inventory_size[1], 1
446 TYPE_ELEMENT_LIST, CONF_VALUE_BYTES(1),
447 &li.initial_inventory_content[1][0],EL_EMPTY, NULL,
448 &li.initial_inventory_size[1], 1, MAX_INITIAL_INVENTORY_SIZE
453 TYPE_INTEGER, CONF_VALUE_8_BIT(7),
454 &li.initial_player_stepsize[2], STEPSIZE_NORMAL
458 TYPE_BOOLEAN, CONF_VALUE_8_BIT(8),
459 &li.initial_player_gravity[2], FALSE
463 TYPE_BOOLEAN, CONF_VALUE_8_BIT(9),
464 &li.use_start_element[2], FALSE
468 TYPE_ELEMENT, CONF_VALUE_16_BIT(1),
469 &li.start_element[2], EL_PLAYER_3
473 TYPE_BOOLEAN, CONF_VALUE_8_BIT(10),
474 &li.use_artwork_element[2], FALSE
478 TYPE_ELEMENT, CONF_VALUE_16_BIT(2),
479 &li.artwork_element[2], EL_PLAYER_3
483 TYPE_BOOLEAN, CONF_VALUE_8_BIT(11),
484 &li.use_explosion_element[2], FALSE
488 TYPE_ELEMENT, CONF_VALUE_16_BIT(3),
489 &li.explosion_element[2], EL_PLAYER_3
493 TYPE_BOOLEAN, CONF_VALUE_8_BIT(13),
494 &li.use_initial_inventory[2], FALSE
498 TYPE_BOOLEAN, CONF_VALUE_8_BIT(14),
499 &li.initial_inventory_size[2], 1
503 TYPE_ELEMENT_LIST, CONF_VALUE_BYTES(1),
504 &li.initial_inventory_content[2][0],EL_EMPTY, NULL,
505 &li.initial_inventory_size[2], 1, MAX_INITIAL_INVENTORY_SIZE
510 TYPE_INTEGER, CONF_VALUE_8_BIT(7),
511 &li.initial_player_stepsize[3], STEPSIZE_NORMAL
515 TYPE_BOOLEAN, CONF_VALUE_8_BIT(8),
516 &li.initial_player_gravity[3], FALSE
520 TYPE_BOOLEAN, CONF_VALUE_8_BIT(9),
521 &li.use_start_element[3], FALSE
525 TYPE_ELEMENT, CONF_VALUE_16_BIT(1),
526 &li.start_element[3], EL_PLAYER_4
530 TYPE_BOOLEAN, CONF_VALUE_8_BIT(10),
531 &li.use_artwork_element[3], FALSE
535 TYPE_ELEMENT, CONF_VALUE_16_BIT(2),
536 &li.artwork_element[3], EL_PLAYER_4
540 TYPE_BOOLEAN, CONF_VALUE_8_BIT(11),
541 &li.use_explosion_element[3], FALSE
545 TYPE_ELEMENT, CONF_VALUE_16_BIT(3),
546 &li.explosion_element[3], EL_PLAYER_4
550 TYPE_BOOLEAN, CONF_VALUE_8_BIT(13),
551 &li.use_initial_inventory[3], FALSE
555 TYPE_BOOLEAN, CONF_VALUE_8_BIT(14),
556 &li.initial_inventory_size[3], 1
560 TYPE_ELEMENT_LIST, CONF_VALUE_BYTES(1),
561 &li.initial_inventory_content[3][0],EL_EMPTY, NULL,
562 &li.initial_inventory_size[3], 1, MAX_INITIAL_INVENTORY_SIZE
567 TYPE_INTEGER, CONF_VALUE_16_BIT(1),
568 &li.score[SC_EMERALD], 10
573 TYPE_INTEGER, CONF_VALUE_16_BIT(1),
574 &li.score[SC_DIAMOND], 10
579 TYPE_INTEGER, CONF_VALUE_16_BIT(1),
580 &li.score[SC_BUG], 10
585 TYPE_INTEGER, CONF_VALUE_16_BIT(1),
586 &li.score[SC_SPACESHIP], 10
591 TYPE_INTEGER, CONF_VALUE_16_BIT(1),
592 &li.score[SC_PACMAN], 10
597 TYPE_INTEGER, CONF_VALUE_16_BIT(1),
598 &li.score[SC_NUT], 10
603 TYPE_INTEGER, CONF_VALUE_16_BIT(1),
604 &li.score[SC_DYNAMITE], 10
609 TYPE_INTEGER, CONF_VALUE_16_BIT(1),
610 &li.score[SC_KEY], 10
615 TYPE_INTEGER, CONF_VALUE_16_BIT(1),
616 &li.score[SC_PEARL], 10
621 TYPE_INTEGER, CONF_VALUE_16_BIT(1),
622 &li.score[SC_CRYSTAL], 10
627 TYPE_ELEMENT, CONF_VALUE_16_BIT(1),
628 &li.amoeba_content, EL_DIAMOND
632 TYPE_INTEGER, CONF_VALUE_16_BIT(2),
637 TYPE_BOOLEAN, CONF_VALUE_8_BIT(1),
638 &li.grow_into_diggable, TRUE
643 TYPE_CONTENT_LIST, CONF_VALUE_BYTES(1),
644 &li.yamyam_content, EL_ROCK, NULL,
645 &li.num_yamyam_contents, 4, MAX_ELEMENT_CONTENTS
649 TYPE_INTEGER, CONF_VALUE_16_BIT(1),
650 &li.score[SC_YAMYAM], 10
655 TYPE_INTEGER, CONF_VALUE_16_BIT(1),
656 &li.score[SC_ROBOT], 10
660 TYPE_INTEGER, CONF_VALUE_16_BIT(2),
666 TYPE_INTEGER, CONF_VALUE_16_BIT(1),
672 TYPE_INTEGER, CONF_VALUE_16_BIT(1),
673 &li.time_magic_wall, 10
678 TYPE_INTEGER, CONF_VALUE_8_BIT(1),
679 &li.game_of_life[0], 2
683 TYPE_INTEGER, CONF_VALUE_8_BIT(2),
684 &li.game_of_life[1], 3
688 TYPE_INTEGER, CONF_VALUE_8_BIT(3),
689 &li.game_of_life[2], 3
693 TYPE_INTEGER, CONF_VALUE_8_BIT(4),
694 &li.game_of_life[3], 3
698 TYPE_BOOLEAN, CONF_VALUE_8_BIT(5),
699 &li.use_life_bugs, FALSE
704 TYPE_INTEGER, CONF_VALUE_8_BIT(1),
709 TYPE_INTEGER, CONF_VALUE_8_BIT(2),
714 TYPE_INTEGER, CONF_VALUE_8_BIT(3),
719 TYPE_INTEGER, CONF_VALUE_8_BIT(4),
724 EL_TIMEGATE_SWITCH, -1,
725 TYPE_INTEGER, CONF_VALUE_16_BIT(1),
726 &li.time_timegate, 10
730 EL_LIGHT_SWITCH_ACTIVE, -1,
731 TYPE_INTEGER, CONF_VALUE_16_BIT(1),
736 EL_SHIELD_NORMAL, -1,
737 TYPE_INTEGER, CONF_VALUE_16_BIT(1),
738 &li.shield_normal_time, 10
741 EL_SHIELD_NORMAL, -1,
742 TYPE_INTEGER, CONF_VALUE_16_BIT(2),
743 &li.score[SC_SHIELD], 10
747 EL_SHIELD_DEADLY, -1,
748 TYPE_INTEGER, CONF_VALUE_16_BIT(1),
749 &li.shield_deadly_time, 10
752 EL_SHIELD_DEADLY, -1,
753 TYPE_INTEGER, CONF_VALUE_16_BIT(2),
754 &li.score[SC_SHIELD], 10
759 TYPE_INTEGER, CONF_VALUE_16_BIT(1),
764 TYPE_INTEGER, CONF_VALUE_16_BIT(2),
765 &li.extra_time_score, 10
769 EL_TIME_ORB_FULL, -1,
770 TYPE_INTEGER, CONF_VALUE_16_BIT(1),
771 &li.time_orb_time, 10
774 EL_TIME_ORB_FULL, -1,
775 TYPE_BOOLEAN, CONF_VALUE_8_BIT(1),
776 &li.use_time_orb_bug, FALSE
781 TYPE_BOOLEAN, CONF_VALUE_8_BIT(1),
782 &li.use_spring_bug, FALSE
787 TYPE_INTEGER, CONF_VALUE_16_BIT(1),
788 &li.android_move_time, 10
792 TYPE_INTEGER, CONF_VALUE_16_BIT(2),
793 &li.android_clone_time, 10
796 EL_EMC_ANDROID, SAVE_CONF_NEVER,
797 TYPE_ELEMENT_LIST, CONF_VALUE_BYTES(1),
798 &li.android_clone_element[0], EL_EMPTY, NULL,
799 &li.num_android_clone_elements, 1, MAX_ANDROID_ELEMENTS_OLD
803 TYPE_ELEMENT_LIST, CONF_VALUE_BYTES(2),
804 &li.android_clone_element[0], EL_EMPTY, NULL,
805 &li.num_android_clone_elements, 1, MAX_ANDROID_ELEMENTS
810 TYPE_INTEGER, CONF_VALUE_16_BIT(1),
815 TYPE_INTEGER, CONF_VALUE_16_BIT(2),
820 EL_EMC_MAGNIFIER, -1,
821 TYPE_INTEGER, CONF_VALUE_16_BIT(1),
822 &li.magnify_score, 10
825 EL_EMC_MAGNIFIER, -1,
826 TYPE_INTEGER, CONF_VALUE_16_BIT(2),
831 EL_EMC_MAGIC_BALL, -1,
832 TYPE_INTEGER, CONF_VALUE_16_BIT(1),
836 EL_EMC_MAGIC_BALL, -1,
837 TYPE_BOOLEAN, CONF_VALUE_8_BIT(1),
838 &li.ball_random, FALSE
841 EL_EMC_MAGIC_BALL, -1,
842 TYPE_BOOLEAN, CONF_VALUE_8_BIT(2),
843 &li.ball_active_initial, FALSE
846 EL_EMC_MAGIC_BALL, -1,
847 TYPE_CONTENT_LIST, CONF_VALUE_BYTES(1),
848 &li.ball_content, EL_EMPTY, NULL,
849 &li.num_ball_contents, 4, MAX_ELEMENT_CONTENTS
853 EL_SOKOBAN_FIELD_EMPTY, -1,
854 TYPE_BOOLEAN, CONF_VALUE_8_BIT(1),
855 &li.sb_fields_needed, TRUE
859 EL_SOKOBAN_OBJECT, -1,
860 TYPE_BOOLEAN, CONF_VALUE_8_BIT(1),
861 &li.sb_objects_needed, TRUE
866 TYPE_BOOLEAN, CONF_VALUE_8_BIT(1),
867 &li.mm_laser_red, FALSE
871 TYPE_BOOLEAN, CONF_VALUE_8_BIT(2),
872 &li.mm_laser_green, FALSE
876 TYPE_BOOLEAN, CONF_VALUE_8_BIT(3),
877 &li.mm_laser_blue, TRUE
882 TYPE_BOOLEAN, CONF_VALUE_8_BIT(1),
883 &li.df_laser_red, TRUE
887 TYPE_BOOLEAN, CONF_VALUE_8_BIT(2),
888 &li.df_laser_green, TRUE
892 TYPE_BOOLEAN, CONF_VALUE_8_BIT(3),
893 &li.df_laser_blue, FALSE
897 EL_MM_FUSE_ACTIVE, -1,
898 TYPE_INTEGER, CONF_VALUE_16_BIT(1),
903 TYPE_INTEGER, CONF_VALUE_16_BIT(1),
908 TYPE_INTEGER, CONF_VALUE_16_BIT(1),
912 EL_MM_STEEL_BLOCK, -1,
913 TYPE_INTEGER, CONF_VALUE_16_BIT(1),
914 &li.mm_time_block, 75
918 TYPE_INTEGER, CONF_VALUE_16_BIT(1),
919 &li.score[SC_ELEM_BONUS], 10
922 // ---------- unused values -------------------------------------------------
925 EL_UNKNOWN, SAVE_CONF_NEVER,
926 TYPE_INTEGER, CONF_VALUE_16_BIT(1),
927 &li.score[SC_UNKNOWN_15], 10
937 static struct LevelFileConfigInfo chunk_config_NOTE[] =
941 TYPE_INTEGER, CONF_VALUE_8_BIT(1),
942 &xx_envelope.xsize, MAX_ENVELOPE_XSIZE,
946 TYPE_INTEGER, CONF_VALUE_8_BIT(2),
947 &xx_envelope.ysize, MAX_ENVELOPE_YSIZE,
952 TYPE_BOOLEAN, CONF_VALUE_8_BIT(3),
953 &xx_envelope.autowrap, FALSE
957 TYPE_BOOLEAN, CONF_VALUE_8_BIT(4),
958 &xx_envelope.centered, FALSE
963 TYPE_STRING, CONF_VALUE_BYTES(1),
964 &xx_envelope.text, -1, NULL,
965 &xx_string_length_unused, -1, MAX_ENVELOPE_TEXT_LEN,
966 &xx_default_string_empty[0]
976 static struct LevelFileConfigInfo chunk_config_CUSX_base[] =
980 TYPE_STRING, CONF_VALUE_BYTES(1),
981 &xx_ei.description[0], -1,
982 &yy_ei.description[0],
983 &xx_string_length_unused, -1, MAX_ELEMENT_NAME_LEN,
984 &xx_default_description[0]
989 TYPE_BITFIELD, CONF_VALUE_32_BIT(1),
990 &xx_ei.properties[EP_BITFIELD_BASE_NR], EP_BITMASK_BASE_DEFAULT,
991 &yy_ei.properties[EP_BITFIELD_BASE_NR]
993 #if ENABLE_RESERVED_CODE
994 // (reserved for later use)
997 TYPE_BITFIELD, CONF_VALUE_32_BIT(2),
998 &xx_ei.properties[EP_BITFIELD_BASE_NR + 1], EP_BITMASK_DEFAULT,
999 &yy_ei.properties[EP_BITFIELD_BASE_NR + 1]
1005 TYPE_BOOLEAN, CONF_VALUE_8_BIT(1),
1006 &xx_ei.use_gfx_element, FALSE,
1007 &yy_ei.use_gfx_element
1011 TYPE_ELEMENT, CONF_VALUE_16_BIT(1),
1012 &xx_ei.gfx_element_initial, EL_EMPTY_SPACE,
1013 &yy_ei.gfx_element_initial
1018 TYPE_BITFIELD, CONF_VALUE_8_BIT(2),
1019 &xx_ei.access_direction, MV_ALL_DIRECTIONS,
1020 &yy_ei.access_direction
1025 TYPE_INTEGER, CONF_VALUE_16_BIT(2),
1026 &xx_ei.collect_score_initial, 10,
1027 &yy_ei.collect_score_initial
1031 TYPE_INTEGER, CONF_VALUE_16_BIT(3),
1032 &xx_ei.collect_count_initial, 1,
1033 &yy_ei.collect_count_initial
1038 TYPE_INTEGER, CONF_VALUE_16_BIT(4),
1039 &xx_ei.ce_value_fixed_initial, 0,
1040 &yy_ei.ce_value_fixed_initial
1044 TYPE_INTEGER, CONF_VALUE_16_BIT(5),
1045 &xx_ei.ce_value_random_initial, 0,
1046 &yy_ei.ce_value_random_initial
1050 TYPE_BOOLEAN, CONF_VALUE_8_BIT(3),
1051 &xx_ei.use_last_ce_value, FALSE,
1052 &yy_ei.use_last_ce_value
1057 TYPE_INTEGER, CONF_VALUE_16_BIT(6),
1058 &xx_ei.push_delay_fixed, 8,
1059 &yy_ei.push_delay_fixed
1063 TYPE_INTEGER, CONF_VALUE_16_BIT(7),
1064 &xx_ei.push_delay_random, 8,
1065 &yy_ei.push_delay_random
1069 TYPE_INTEGER, CONF_VALUE_16_BIT(8),
1070 &xx_ei.drop_delay_fixed, 0,
1071 &yy_ei.drop_delay_fixed
1075 TYPE_INTEGER, CONF_VALUE_16_BIT(9),
1076 &xx_ei.drop_delay_random, 0,
1077 &yy_ei.drop_delay_random
1081 TYPE_INTEGER, CONF_VALUE_16_BIT(10),
1082 &xx_ei.move_delay_fixed, 0,
1083 &yy_ei.move_delay_fixed
1087 TYPE_INTEGER, CONF_VALUE_16_BIT(11),
1088 &xx_ei.move_delay_random, 0,
1089 &yy_ei.move_delay_random
1093 TYPE_INTEGER, CONF_VALUE_16_BIT(16),
1094 &xx_ei.step_delay_fixed, 0,
1095 &yy_ei.step_delay_fixed
1099 TYPE_INTEGER, CONF_VALUE_16_BIT(17),
1100 &xx_ei.step_delay_random, 0,
1101 &yy_ei.step_delay_random
1106 TYPE_BITFIELD, CONF_VALUE_32_BIT(3),
1107 &xx_ei.move_pattern, MV_ALL_DIRECTIONS,
1112 TYPE_BITFIELD, CONF_VALUE_8_BIT(4),
1113 &xx_ei.move_direction_initial, MV_START_AUTOMATIC,
1114 &yy_ei.move_direction_initial
1118 TYPE_INTEGER, CONF_VALUE_8_BIT(5),
1119 &xx_ei.move_stepsize, TILEX / 8,
1120 &yy_ei.move_stepsize
1125 TYPE_ELEMENT, CONF_VALUE_16_BIT(12),
1126 &xx_ei.move_enter_element, EL_EMPTY_SPACE,
1127 &yy_ei.move_enter_element
1131 TYPE_ELEMENT, CONF_VALUE_16_BIT(13),
1132 &xx_ei.move_leave_element, EL_EMPTY_SPACE,
1133 &yy_ei.move_leave_element
1137 TYPE_INTEGER, CONF_VALUE_8_BIT(6),
1138 &xx_ei.move_leave_type, LEAVE_TYPE_UNLIMITED,
1139 &yy_ei.move_leave_type
1144 TYPE_INTEGER, CONF_VALUE_8_BIT(7),
1145 &xx_ei.slippery_type, SLIPPERY_ANY_RANDOM,
1146 &yy_ei.slippery_type
1151 TYPE_INTEGER, CONF_VALUE_8_BIT(8),
1152 &xx_ei.explosion_type, EXPLODES_3X3,
1153 &yy_ei.explosion_type
1157 TYPE_INTEGER, CONF_VALUE_16_BIT(14),
1158 &xx_ei.explosion_delay, 16,
1159 &yy_ei.explosion_delay
1163 TYPE_INTEGER, CONF_VALUE_16_BIT(15),
1164 &xx_ei.ignition_delay, 8,
1165 &yy_ei.ignition_delay
1170 TYPE_CONTENT_LIST, CONF_VALUE_BYTES(2),
1171 &xx_ei.content, EL_EMPTY_SPACE,
1173 &xx_num_contents, 1, 1
1176 // ---------- "num_change_pages" must be the last entry ---------------------
1179 -1, SAVE_CONF_ALWAYS,
1180 TYPE_INTEGER, CONF_VALUE_8_BIT(9),
1181 &xx_ei.num_change_pages, 1,
1182 &yy_ei.num_change_pages
1193 static struct LevelFileConfigInfo chunk_config_CUSX_change[] =
1195 // ---------- "current_change_page" must be the first entry -----------------
1198 -1, SAVE_CONF_ALWAYS,
1199 TYPE_INTEGER, CONF_VALUE_8_BIT(1),
1200 &xx_current_change_page, -1
1203 // ---------- (the remaining entries can be in any order) -------------------
1207 TYPE_BOOLEAN, CONF_VALUE_8_BIT(2),
1208 &xx_change.can_change, FALSE
1213 TYPE_BITFIELD, CONF_VALUE_32_BIT(1),
1214 &xx_event_bits[0], 0
1218 TYPE_BITFIELD, CONF_VALUE_32_BIT(2),
1219 &xx_event_bits[1], 0
1224 TYPE_BITFIELD, CONF_VALUE_8_BIT(3),
1225 &xx_change.trigger_player, CH_PLAYER_ANY
1229 TYPE_BITFIELD, CONF_VALUE_8_BIT(4),
1230 &xx_change.trigger_side, CH_SIDE_ANY
1234 TYPE_BITFIELD, CONF_VALUE_32_BIT(3),
1235 &xx_change.trigger_page, CH_PAGE_ANY
1240 TYPE_ELEMENT, CONF_VALUE_16_BIT(1),
1241 &xx_change.target_element, EL_EMPTY_SPACE
1246 TYPE_INTEGER, CONF_VALUE_16_BIT(2),
1247 &xx_change.delay_fixed, 0
1251 TYPE_INTEGER, CONF_VALUE_16_BIT(3),
1252 &xx_change.delay_random, 0
1256 TYPE_INTEGER, CONF_VALUE_16_BIT(4),
1257 &xx_change.delay_frames, FRAMES_PER_SECOND
1262 TYPE_ELEMENT, CONF_VALUE_16_BIT(5),
1263 &xx_change.initial_trigger_element, EL_EMPTY_SPACE
1268 TYPE_BOOLEAN, CONF_VALUE_8_BIT(6),
1269 &xx_change.explode, FALSE
1273 TYPE_BOOLEAN, CONF_VALUE_8_BIT(7),
1274 &xx_change.use_target_content, FALSE
1278 TYPE_BOOLEAN, CONF_VALUE_8_BIT(8),
1279 &xx_change.only_if_complete, FALSE
1283 TYPE_BOOLEAN, CONF_VALUE_8_BIT(9),
1284 &xx_change.use_random_replace, FALSE
1288 TYPE_INTEGER, CONF_VALUE_8_BIT(10),
1289 &xx_change.random_percentage, 100
1293 TYPE_INTEGER, CONF_VALUE_8_BIT(11),
1294 &xx_change.replace_when, CP_WHEN_EMPTY
1299 TYPE_BOOLEAN, CONF_VALUE_8_BIT(12),
1300 &xx_change.has_action, FALSE
1304 TYPE_INTEGER, CONF_VALUE_8_BIT(13),
1305 &xx_change.action_type, CA_NO_ACTION
1309 TYPE_INTEGER, CONF_VALUE_8_BIT(14),
1310 &xx_change.action_mode, CA_MODE_UNDEFINED
1314 TYPE_INTEGER, CONF_VALUE_16_BIT(6),
1315 &xx_change.action_arg, CA_ARG_UNDEFINED
1320 TYPE_ELEMENT, CONF_VALUE_16_BIT(7),
1321 &xx_change.action_element, EL_EMPTY_SPACE
1326 TYPE_CONTENT_LIST, CONF_VALUE_BYTES(1),
1327 &xx_change.target_content, EL_EMPTY_SPACE, NULL,
1328 &xx_num_contents, 1, 1
1338 static struct LevelFileConfigInfo chunk_config_GRPX[] =
1342 TYPE_STRING, CONF_VALUE_BYTES(1),
1343 &xx_ei.description[0], -1, NULL,
1344 &xx_string_length_unused, -1, MAX_ELEMENT_NAME_LEN,
1345 &xx_default_description[0]
1350 TYPE_BOOLEAN, CONF_VALUE_8_BIT(1),
1351 &xx_ei.use_gfx_element, FALSE
1355 TYPE_ELEMENT, CONF_VALUE_16_BIT(1),
1356 &xx_ei.gfx_element_initial, EL_EMPTY_SPACE
1361 TYPE_INTEGER, CONF_VALUE_8_BIT(2),
1362 &xx_group.choice_mode, ANIM_RANDOM
1367 TYPE_ELEMENT_LIST, CONF_VALUE_BYTES(2),
1368 &xx_group.element[0], EL_EMPTY_SPACE, NULL,
1369 &xx_group.num_elements, 1, MAX_ELEMENTS_IN_GROUP
1379 static struct LevelFileConfigInfo chunk_config_CONF[] = // (OBSOLETE)
1383 TYPE_BOOLEAN, CONF_VALUE_8_BIT(9),
1384 &li.block_snap_field, TRUE
1388 TYPE_BOOLEAN, CONF_VALUE_8_BIT(13),
1389 &li.continuous_snapping, TRUE
1393 TYPE_INTEGER, CONF_VALUE_8_BIT(1),
1394 &li.initial_player_stepsize[0], STEPSIZE_NORMAL
1398 TYPE_BOOLEAN, CONF_VALUE_8_BIT(10),
1399 &li.use_start_element[0], FALSE
1403 TYPE_ELEMENT, CONF_VALUE_16_BIT(1),
1404 &li.start_element[0], EL_PLAYER_1
1408 TYPE_BOOLEAN, CONF_VALUE_8_BIT(11),
1409 &li.use_artwork_element[0], FALSE
1413 TYPE_ELEMENT, CONF_VALUE_16_BIT(2),
1414 &li.artwork_element[0], EL_PLAYER_1
1418 TYPE_BOOLEAN, CONF_VALUE_8_BIT(12),
1419 &li.use_explosion_element[0], FALSE
1423 TYPE_ELEMENT, CONF_VALUE_16_BIT(3),
1424 &li.explosion_element[0], EL_PLAYER_1
1439 filetype_id_list[] =
1441 { LEVEL_FILE_TYPE_RND, "RND" },
1442 { LEVEL_FILE_TYPE_BD, "BD" },
1443 { LEVEL_FILE_TYPE_EM, "EM" },
1444 { LEVEL_FILE_TYPE_SP, "SP" },
1445 { LEVEL_FILE_TYPE_DX, "DX" },
1446 { LEVEL_FILE_TYPE_SB, "SB" },
1447 { LEVEL_FILE_TYPE_DC, "DC" },
1448 { LEVEL_FILE_TYPE_MM, "MM" },
1449 { LEVEL_FILE_TYPE_MM, "DF" },
1454 // ============================================================================
1455 // level file functions
1456 // ============================================================================
1458 static boolean check_special_flags(char *flag)
1460 if (strEqual(options.special_flags, flag) ||
1461 strEqual(leveldir_current->special_flags, flag))
1467 static struct DateInfo getCurrentDate(void)
1469 time_t epoch_seconds = time(NULL);
1470 struct tm *now = localtime(&epoch_seconds);
1471 struct DateInfo date;
1473 date.year = now->tm_year + 1900;
1474 date.month = now->tm_mon + 1;
1475 date.day = now->tm_mday;
1477 date.src = DATE_SRC_CLOCK;
1482 static void resetEventFlags(struct ElementChangeInfo *change)
1486 for (i = 0; i < NUM_CHANGE_EVENTS; i++)
1487 change->has_event[i] = FALSE;
1490 static void resetEventBits(void)
1494 for (i = 0; i < NUM_CE_BITFIELDS; i++)
1495 xx_event_bits[i] = 0;
1498 static void setEventFlagsFromEventBits(struct ElementChangeInfo *change)
1502 /* important: only change event flag if corresponding event bit is set
1503 (this is because all xx_event_bits[] values are loaded separately,
1504 and all xx_event_bits[] values are set back to zero before loading
1505 another value xx_event_bits[x] (each value representing 32 flags)) */
1507 for (i = 0; i < NUM_CHANGE_EVENTS; i++)
1508 if (xx_event_bits[CH_EVENT_BITFIELD_NR(i)] & CH_EVENT_BIT(i))
1509 change->has_event[i] = TRUE;
1512 static void setEventBitsFromEventFlags(struct ElementChangeInfo *change)
1516 /* in contrast to the above function setEventFlagsFromEventBits(), it
1517 would also be possible to set all bits in xx_event_bits[] to 0 or 1
1518 depending on the corresponding change->has_event[i] values here, as
1519 all xx_event_bits[] values are reset in resetEventBits() before */
1521 for (i = 0; i < NUM_CHANGE_EVENTS; i++)
1522 if (change->has_event[i])
1523 xx_event_bits[CH_EVENT_BITFIELD_NR(i)] |= CH_EVENT_BIT(i);
1526 static char *getDefaultElementDescription(struct ElementInfo *ei)
1528 static char description[MAX_ELEMENT_NAME_LEN + 1];
1529 char *default_description = (ei->custom_description != NULL ?
1530 ei->custom_description :
1531 ei->editor_description);
1534 // always start with reliable default values
1535 for (i = 0; i < MAX_ELEMENT_NAME_LEN + 1; i++)
1536 description[i] = '\0';
1538 // truncate element description to MAX_ELEMENT_NAME_LEN bytes
1539 strncpy(description, default_description, MAX_ELEMENT_NAME_LEN);
1541 return &description[0];
1544 static void setElementDescriptionToDefault(struct ElementInfo *ei)
1546 char *default_description = getDefaultElementDescription(ei);
1549 for (i = 0; i < MAX_ELEMENT_NAME_LEN + 1; i++)
1550 ei->description[i] = default_description[i];
1553 static void setConfigToDefaultsFromConfigList(struct LevelFileConfigInfo *conf)
1557 for (i = 0; conf[i].data_type != -1; i++)
1559 int default_value = conf[i].default_value;
1560 int data_type = conf[i].data_type;
1561 int conf_type = conf[i].conf_type;
1562 int byte_mask = conf_type & CONF_MASK_BYTES;
1564 if (byte_mask == CONF_MASK_MULTI_BYTES)
1566 int default_num_entities = conf[i].default_num_entities;
1567 int max_num_entities = conf[i].max_num_entities;
1569 *(int *)(conf[i].num_entities) = default_num_entities;
1571 if (data_type == TYPE_STRING)
1573 char *default_string = conf[i].default_string;
1574 char *string = (char *)(conf[i].value);
1576 strncpy(string, default_string, max_num_entities);
1578 else if (data_type == TYPE_ELEMENT_LIST)
1580 int *element_array = (int *)(conf[i].value);
1583 for (j = 0; j < max_num_entities; j++)
1584 element_array[j] = default_value;
1586 else if (data_type == TYPE_CONTENT_LIST)
1588 struct Content *content = (struct Content *)(conf[i].value);
1591 for (c = 0; c < max_num_entities; c++)
1592 for (y = 0; y < 3; y++)
1593 for (x = 0; x < 3; x++)
1594 content[c].e[x][y] = default_value;
1597 else // constant size configuration data (1, 2 or 4 bytes)
1599 if (data_type == TYPE_BOOLEAN)
1600 *(boolean *)(conf[i].value) = default_value;
1602 *(int *) (conf[i].value) = default_value;
1607 static void copyConfigFromConfigList(struct LevelFileConfigInfo *conf)
1611 for (i = 0; conf[i].data_type != -1; i++)
1613 int data_type = conf[i].data_type;
1614 int conf_type = conf[i].conf_type;
1615 int byte_mask = conf_type & CONF_MASK_BYTES;
1617 if (byte_mask == CONF_MASK_MULTI_BYTES)
1619 int max_num_entities = conf[i].max_num_entities;
1621 if (data_type == TYPE_STRING)
1623 char *string = (char *)(conf[i].value);
1624 char *string_copy = (char *)(conf[i].value_copy);
1626 strncpy(string_copy, string, max_num_entities);
1628 else if (data_type == TYPE_ELEMENT_LIST)
1630 int *element_array = (int *)(conf[i].value);
1631 int *element_array_copy = (int *)(conf[i].value_copy);
1634 for (j = 0; j < max_num_entities; j++)
1635 element_array_copy[j] = element_array[j];
1637 else if (data_type == TYPE_CONTENT_LIST)
1639 struct Content *content = (struct Content *)(conf[i].value);
1640 struct Content *content_copy = (struct Content *)(conf[i].value_copy);
1643 for (c = 0; c < max_num_entities; c++)
1644 for (y = 0; y < 3; y++)
1645 for (x = 0; x < 3; x++)
1646 content_copy[c].e[x][y] = content[c].e[x][y];
1649 else // constant size configuration data (1, 2 or 4 bytes)
1651 if (data_type == TYPE_BOOLEAN)
1652 *(boolean *)(conf[i].value_copy) = *(boolean *)(conf[i].value);
1654 *(int *) (conf[i].value_copy) = *(int *) (conf[i].value);
1659 void copyElementInfo(struct ElementInfo *ei_from, struct ElementInfo *ei_to)
1663 xx_ei = *ei_from; // copy element data into temporary buffer
1664 yy_ei = *ei_to; // copy element data into temporary buffer
1666 copyConfigFromConfigList(chunk_config_CUSX_base);
1671 // ---------- reinitialize and copy change pages ----------
1673 ei_to->num_change_pages = ei_from->num_change_pages;
1674 ei_to->current_change_page = ei_from->current_change_page;
1676 setElementChangePages(ei_to, ei_to->num_change_pages);
1678 for (i = 0; i < ei_to->num_change_pages; i++)
1679 ei_to->change_page[i] = ei_from->change_page[i];
1681 // ---------- copy group element info ----------
1682 if (ei_from->group != NULL && ei_to->group != NULL) // group or internal
1683 *ei_to->group = *ei_from->group;
1685 // mark this custom element as modified
1686 ei_to->modified_settings = TRUE;
1689 void setElementChangePages(struct ElementInfo *ei, int change_pages)
1691 int change_page_size = sizeof(struct ElementChangeInfo);
1693 ei->num_change_pages = MAX(1, change_pages);
1696 checked_realloc(ei->change_page, ei->num_change_pages * change_page_size);
1698 if (ei->current_change_page >= ei->num_change_pages)
1699 ei->current_change_page = ei->num_change_pages - 1;
1701 ei->change = &ei->change_page[ei->current_change_page];
1704 void setElementChangeInfoToDefaults(struct ElementChangeInfo *change)
1706 xx_change = *change; // copy change data into temporary buffer
1708 setConfigToDefaultsFromConfigList(chunk_config_CUSX_change);
1710 *change = xx_change;
1712 resetEventFlags(change);
1714 change->direct_action = 0;
1715 change->other_action = 0;
1717 change->pre_change_function = NULL;
1718 change->change_function = NULL;
1719 change->post_change_function = NULL;
1722 static void setLevelInfoToDefaults_Level(struct LevelInfo *level)
1726 li = *level; // copy level data into temporary buffer
1727 setConfigToDefaultsFromConfigList(chunk_config_INFO);
1728 *level = li; // copy temporary buffer back to level data
1730 setLevelInfoToDefaults_EM();
1731 setLevelInfoToDefaults_SP();
1732 setLevelInfoToDefaults_MM();
1734 level->native_em_level = &native_em_level;
1735 level->native_sp_level = &native_sp_level;
1736 level->native_mm_level = &native_mm_level;
1738 level->file_version = FILE_VERSION_ACTUAL;
1739 level->game_version = GAME_VERSION_ACTUAL;
1741 level->creation_date = getCurrentDate();
1743 level->encoding_16bit_field = TRUE;
1744 level->encoding_16bit_yamyam = TRUE;
1745 level->encoding_16bit_amoeba = TRUE;
1747 // clear level name and level author string buffers
1748 for (i = 0; i < MAX_LEVEL_NAME_LEN; i++)
1749 level->name[i] = '\0';
1750 for (i = 0; i < MAX_LEVEL_AUTHOR_LEN; i++)
1751 level->author[i] = '\0';
1753 // set level name and level author to default values
1754 strcpy(level->name, NAMELESS_LEVEL_NAME);
1755 strcpy(level->author, ANONYMOUS_NAME);
1757 // set level playfield to playable default level with player and exit
1758 for (x = 0; x < MAX_LEV_FIELDX; x++)
1759 for (y = 0; y < MAX_LEV_FIELDY; y++)
1760 level->field[x][y] = EL_SAND;
1762 level->field[0][0] = EL_PLAYER_1;
1763 level->field[STD_LEV_FIELDX - 1][STD_LEV_FIELDY - 1] = EL_EXIT_CLOSED;
1765 BorderElement = EL_STEELWALL;
1767 // detect custom elements when loading them
1768 level->file_has_custom_elements = FALSE;
1770 // set all bug compatibility flags to "false" => do not emulate this bug
1771 level->use_action_after_change_bug = FALSE;
1773 if (leveldir_current)
1775 // try to determine better author name than 'anonymous'
1776 if (!strEqual(leveldir_current->author, ANONYMOUS_NAME))
1778 strncpy(level->author, leveldir_current->author, MAX_LEVEL_AUTHOR_LEN);
1779 level->author[MAX_LEVEL_AUTHOR_LEN] = '\0';
1783 switch (LEVELCLASS(leveldir_current))
1785 case LEVELCLASS_TUTORIAL:
1786 strcpy(level->author, PROGRAM_AUTHOR_STRING);
1789 case LEVELCLASS_CONTRIB:
1790 strncpy(level->author, leveldir_current->name, MAX_LEVEL_AUTHOR_LEN);
1791 level->author[MAX_LEVEL_AUTHOR_LEN] = '\0';
1794 case LEVELCLASS_PRIVATE:
1795 strncpy(level->author, getRealName(), MAX_LEVEL_AUTHOR_LEN);
1796 level->author[MAX_LEVEL_AUTHOR_LEN] = '\0';
1800 // keep default value
1807 static void setLevelInfoToDefaults_Elements(struct LevelInfo *level)
1809 static boolean clipboard_elements_initialized = FALSE;
1812 InitElementPropertiesStatic();
1814 li = *level; // copy level data into temporary buffer
1815 setConfigToDefaultsFromConfigList(chunk_config_ELEM);
1816 *level = li; // copy temporary buffer back to level data
1818 for (i = 0; i < MAX_NUM_ELEMENTS; i++)
1821 struct ElementInfo *ei = &element_info[element];
1823 // never initialize clipboard elements after the very first time
1824 // (to be able to use clipboard elements between several levels)
1825 if (IS_CLIPBOARD_ELEMENT(element) && clipboard_elements_initialized)
1828 if (IS_ENVELOPE(element))
1830 int envelope_nr = element - EL_ENVELOPE_1;
1832 setConfigToDefaultsFromConfigList(chunk_config_NOTE);
1834 level->envelope[envelope_nr] = xx_envelope;
1837 if (IS_CUSTOM_ELEMENT(element) ||
1838 IS_GROUP_ELEMENT(element) ||
1839 IS_INTERNAL_ELEMENT(element))
1841 xx_ei = *ei; // copy element data into temporary buffer
1843 setConfigToDefaultsFromConfigList(chunk_config_CUSX_base);
1848 setElementChangePages(ei, 1);
1849 setElementChangeInfoToDefaults(ei->change);
1851 if (IS_CUSTOM_ELEMENT(element) ||
1852 IS_GROUP_ELEMENT(element) ||
1853 IS_INTERNAL_ELEMENT(element))
1855 setElementDescriptionToDefault(ei);
1857 ei->modified_settings = FALSE;
1860 if (IS_CUSTOM_ELEMENT(element) ||
1861 IS_INTERNAL_ELEMENT(element))
1863 // internal values used in level editor
1865 ei->access_type = 0;
1866 ei->access_layer = 0;
1867 ei->access_protected = 0;
1868 ei->walk_to_action = 0;
1869 ei->smash_targets = 0;
1872 ei->can_explode_by_fire = FALSE;
1873 ei->can_explode_smashed = FALSE;
1874 ei->can_explode_impact = FALSE;
1876 ei->current_change_page = 0;
1879 if (IS_GROUP_ELEMENT(element) ||
1880 IS_INTERNAL_ELEMENT(element))
1882 struct ElementGroupInfo *group;
1884 // initialize memory for list of elements in group
1885 if (ei->group == NULL)
1886 ei->group = checked_malloc(sizeof(struct ElementGroupInfo));
1890 xx_group = *group; // copy group data into temporary buffer
1892 setConfigToDefaultsFromConfigList(chunk_config_GRPX);
1898 clipboard_elements_initialized = TRUE;
1901 static void setLevelInfoToDefaults(struct LevelInfo *level,
1902 boolean level_info_only,
1903 boolean reset_file_status)
1905 setLevelInfoToDefaults_Level(level);
1907 if (!level_info_only)
1908 setLevelInfoToDefaults_Elements(level);
1910 if (reset_file_status)
1912 level->no_valid_file = FALSE;
1913 level->no_level_file = FALSE;
1916 level->changed = FALSE;
1919 static void setFileInfoToDefaults(struct LevelFileInfo *level_file_info)
1921 level_file_info->nr = 0;
1922 level_file_info->type = LEVEL_FILE_TYPE_UNKNOWN;
1923 level_file_info->packed = FALSE;
1925 setString(&level_file_info->basename, NULL);
1926 setString(&level_file_info->filename, NULL);
1929 int getMappedElement_SB(int, boolean);
1931 static void ActivateLevelTemplate(void)
1935 if (check_special_flags("load_xsb_to_ces"))
1937 // fill smaller playfields with padding "beyond border wall" elements
1938 if (level.fieldx < level_template.fieldx ||
1939 level.fieldy < level_template.fieldy)
1941 short field[level.fieldx][level.fieldy];
1942 int new_fieldx = MAX(level.fieldx, level_template.fieldx);
1943 int new_fieldy = MAX(level.fieldy, level_template.fieldy);
1944 int pos_fieldx = (new_fieldx - level.fieldx) / 2;
1945 int pos_fieldy = (new_fieldy - level.fieldy) / 2;
1947 // copy old playfield (which is smaller than the visible area)
1948 for (y = 0; y < level.fieldy; y++) for (x = 0; x < level.fieldx; x++)
1949 field[x][y] = level.field[x][y];
1951 // fill new, larger playfield with "beyond border wall" elements
1952 for (y = 0; y < new_fieldy; y++) for (x = 0; x < new_fieldx; x++)
1953 level.field[x][y] = getMappedElement_SB('_', TRUE);
1955 // copy the old playfield to the middle of the new playfield
1956 for (y = 0; y < level.fieldy; y++) for (x = 0; x < level.fieldx; x++)
1957 level.field[pos_fieldx + x][pos_fieldy + y] = field[x][y];
1959 level.fieldx = new_fieldx;
1960 level.fieldy = new_fieldy;
1964 // Currently there is no special action needed to activate the template
1965 // data, because 'element_info' property settings overwrite the original
1966 // level data, while all other variables do not change.
1968 // Exception: 'from_level_template' elements in the original level playfield
1969 // are overwritten with the corresponding elements at the same position in
1970 // playfield from the level template.
1972 for (x = 0; x < level.fieldx; x++)
1973 for (y = 0; y < level.fieldy; y++)
1974 if (level.field[x][y] == EL_FROM_LEVEL_TEMPLATE)
1975 level.field[x][y] = level_template.field[x][y];
1977 if (check_special_flags("load_xsb_to_ces"))
1979 struct LevelInfo level_backup = level;
1981 // overwrite all individual level settings from template level settings
1982 level = level_template;
1984 // restore level file info
1985 level.file_info = level_backup.file_info;
1987 // restore playfield size
1988 level.fieldx = level_backup.fieldx;
1989 level.fieldy = level_backup.fieldy;
1991 // restore playfield content
1992 for (x = 0; x < level.fieldx; x++)
1993 for (y = 0; y < level.fieldy; y++)
1994 level.field[x][y] = level_backup.field[x][y];
1996 // restore name and author from individual level
1997 strcpy(level.name, level_backup.name);
1998 strcpy(level.author, level_backup.author);
2000 // restore flag "use_custom_template"
2001 level.use_custom_template = level_backup.use_custom_template;
2005 static char *getLevelFilenameFromBasename(char *basename)
2007 static char *filename = NULL;
2009 checked_free(filename);
2011 filename = getPath2(getCurrentLevelDir(), basename);
2016 static int getFileTypeFromBasename(char *basename)
2018 // !!! ALSO SEE COMMENT IN checkForPackageFromBasename() !!!
2020 static char *filename = NULL;
2021 struct stat file_status;
2023 // ---------- try to determine file type from filename ----------
2025 // check for typical filename of a Supaplex level package file
2026 if (strlen(basename) == 10 && strPrefixLower(basename, "levels.d"))
2027 return LEVEL_FILE_TYPE_SP;
2029 // check for typical filename of a Diamond Caves II level package file
2030 if (strSuffixLower(basename, ".dc") ||
2031 strSuffixLower(basename, ".dc2"))
2032 return LEVEL_FILE_TYPE_DC;
2034 // check for typical filename of a Sokoban level package file
2035 if (strSuffixLower(basename, ".xsb") &&
2036 strchr(basename, '%') == NULL)
2037 return LEVEL_FILE_TYPE_SB;
2039 // ---------- try to determine file type from filesize ----------
2041 checked_free(filename);
2042 filename = getPath2(getCurrentLevelDir(), basename);
2044 if (stat(filename, &file_status) == 0)
2046 // check for typical filesize of a Supaplex level package file
2047 if (file_status.st_size == 170496)
2048 return LEVEL_FILE_TYPE_SP;
2051 return LEVEL_FILE_TYPE_UNKNOWN;
2054 static int getFileTypeFromMagicBytes(char *filename, int type)
2058 if ((file = openFile(filename, MODE_READ)))
2060 char chunk_name[CHUNK_ID_LEN + 1];
2062 getFileChunkBE(file, chunk_name, NULL);
2064 if (strEqual(chunk_name, "MMII") ||
2065 strEqual(chunk_name, "MIRR"))
2066 type = LEVEL_FILE_TYPE_MM;
2074 static boolean checkForPackageFromBasename(char *basename)
2076 // !!! WON'T WORK ANYMORE IF getFileTypeFromBasename() ALSO DETECTS !!!
2077 // !!! SINGLE LEVELS (CURRENTLY ONLY DETECTS LEVEL PACKAGES !!!
2079 return (getFileTypeFromBasename(basename) != LEVEL_FILE_TYPE_UNKNOWN);
2082 static char *getSingleLevelBasenameExt(int nr, char *extension)
2084 static char basename[MAX_FILENAME_LEN];
2087 sprintf(basename, "%s", LEVELTEMPLATE_FILENAME);
2089 sprintf(basename, "%03d.%s", nr, extension);
2094 static char *getSingleLevelBasename(int nr)
2096 return getSingleLevelBasenameExt(nr, LEVELFILE_EXTENSION);
2099 static char *getPackedLevelBasename(int type)
2101 static char basename[MAX_FILENAME_LEN];
2102 char *directory = getCurrentLevelDir();
2104 DirectoryEntry *dir_entry;
2106 strcpy(basename, UNDEFINED_FILENAME); // default: undefined file
2108 if ((dir = openDirectory(directory)) == NULL)
2110 Warn("cannot read current level directory '%s'", directory);
2115 while ((dir_entry = readDirectory(dir)) != NULL) // loop all entries
2117 char *entry_basename = dir_entry->basename;
2118 int entry_type = getFileTypeFromBasename(entry_basename);
2120 if (entry_type != LEVEL_FILE_TYPE_UNKNOWN) // found valid level package
2122 if (type == LEVEL_FILE_TYPE_UNKNOWN ||
2125 strcpy(basename, entry_basename);
2132 closeDirectory(dir);
2137 static char *getSingleLevelFilename(int nr)
2139 return getLevelFilenameFromBasename(getSingleLevelBasename(nr));
2142 #if ENABLE_UNUSED_CODE
2143 static char *getPackedLevelFilename(int type)
2145 return getLevelFilenameFromBasename(getPackedLevelBasename(type));
2149 char *getDefaultLevelFilename(int nr)
2151 return getSingleLevelFilename(nr);
2154 #if ENABLE_UNUSED_CODE
2155 static void setLevelFileInfo_SingleLevelFilename(struct LevelFileInfo *lfi,
2159 lfi->packed = FALSE;
2161 setString(&lfi->basename, getSingleLevelBasename(lfi->nr, lfi->type));
2162 setString(&lfi->filename, getLevelFilenameFromBasename(lfi->basename));
2166 static void setLevelFileInfo_FormatLevelFilename(struct LevelFileInfo *lfi,
2167 int type, char *format, ...)
2169 static char basename[MAX_FILENAME_LEN];
2172 va_start(ap, format);
2173 vsprintf(basename, format, ap);
2177 lfi->packed = FALSE;
2179 setString(&lfi->basename, basename);
2180 setString(&lfi->filename, getLevelFilenameFromBasename(lfi->basename));
2183 static void setLevelFileInfo_PackedLevelFilename(struct LevelFileInfo *lfi,
2189 setString(&lfi->basename, getPackedLevelBasename(lfi->type));
2190 setString(&lfi->filename, getLevelFilenameFromBasename(lfi->basename));
2193 static int getFiletypeFromID(char *filetype_id)
2195 char *filetype_id_lower;
2196 int filetype = LEVEL_FILE_TYPE_UNKNOWN;
2199 if (filetype_id == NULL)
2200 return LEVEL_FILE_TYPE_UNKNOWN;
2202 filetype_id_lower = getStringToLower(filetype_id);
2204 for (i = 0; filetype_id_list[i].id != NULL; i++)
2206 char *id_lower = getStringToLower(filetype_id_list[i].id);
2208 if (strEqual(filetype_id_lower, id_lower))
2209 filetype = filetype_id_list[i].filetype;
2213 if (filetype != LEVEL_FILE_TYPE_UNKNOWN)
2217 free(filetype_id_lower);
2222 char *getLocalLevelTemplateFilename(void)
2224 return getDefaultLevelFilename(-1);
2227 char *getGlobalLevelTemplateFilename(void)
2229 // global variable "leveldir_current" must be modified in the loop below
2230 LevelDirTree *leveldir_current_last = leveldir_current;
2231 char *filename = NULL;
2233 // check for template level in path from current to topmost tree node
2235 while (leveldir_current != NULL)
2237 filename = getDefaultLevelFilename(-1);
2239 if (fileExists(filename))
2242 leveldir_current = leveldir_current->node_parent;
2245 // restore global variable "leveldir_current" modified in above loop
2246 leveldir_current = leveldir_current_last;
2251 static void determineLevelFileInfo_Filename(struct LevelFileInfo *lfi)
2255 // special case: level number is negative => check for level template file
2258 setLevelFileInfo_FormatLevelFilename(lfi, LEVEL_FILE_TYPE_RND,
2259 getSingleLevelBasename(-1));
2261 // replace local level template filename with global template filename
2262 setString(&lfi->filename, getGlobalLevelTemplateFilename());
2264 // no fallback if template file not existing
2268 // special case: check for file name/pattern specified in "levelinfo.conf"
2269 if (leveldir_current->level_filename != NULL)
2271 int filetype = getFiletypeFromID(leveldir_current->level_filetype);
2273 setLevelFileInfo_FormatLevelFilename(lfi, filetype,
2274 leveldir_current->level_filename, nr);
2276 lfi->packed = checkForPackageFromBasename(leveldir_current->level_filename);
2278 if (fileExists(lfi->filename))
2281 else if (leveldir_current->level_filetype != NULL)
2283 int filetype = getFiletypeFromID(leveldir_current->level_filetype);
2285 // check for specified native level file with standard file name
2286 setLevelFileInfo_FormatLevelFilename(lfi, filetype,
2287 "%03d.%s", nr, LEVELFILE_EXTENSION);
2288 if (fileExists(lfi->filename))
2292 // check for native Rocks'n'Diamonds level file
2293 setLevelFileInfo_FormatLevelFilename(lfi, LEVEL_FILE_TYPE_RND,
2294 "%03d.%s", nr, LEVELFILE_EXTENSION);
2295 if (fileExists(lfi->filename))
2298 // check for Emerald Mine level file (V1)
2299 setLevelFileInfo_FormatLevelFilename(lfi, LEVEL_FILE_TYPE_EM, "a%c%c",
2300 'a' + (nr / 10) % 26, '0' + nr % 10);
2301 if (fileExists(lfi->filename))
2303 setLevelFileInfo_FormatLevelFilename(lfi, LEVEL_FILE_TYPE_EM, "A%c%c",
2304 'A' + (nr / 10) % 26, '0' + nr % 10);
2305 if (fileExists(lfi->filename))
2308 // check for Emerald Mine level file (V2 to V5)
2309 setLevelFileInfo_FormatLevelFilename(lfi, LEVEL_FILE_TYPE_EM, "%d", nr);
2310 if (fileExists(lfi->filename))
2313 // check for Emerald Mine level file (V6 / single mode)
2314 setLevelFileInfo_FormatLevelFilename(lfi, LEVEL_FILE_TYPE_EM, "%02ds", nr);
2315 if (fileExists(lfi->filename))
2317 setLevelFileInfo_FormatLevelFilename(lfi, LEVEL_FILE_TYPE_EM, "%02dS", nr);
2318 if (fileExists(lfi->filename))
2321 // check for Emerald Mine level file (V6 / teamwork mode)
2322 setLevelFileInfo_FormatLevelFilename(lfi, LEVEL_FILE_TYPE_EM, "%02dt", nr);
2323 if (fileExists(lfi->filename))
2325 setLevelFileInfo_FormatLevelFilename(lfi, LEVEL_FILE_TYPE_EM, "%02dT", nr);
2326 if (fileExists(lfi->filename))
2329 // check for various packed level file formats
2330 setLevelFileInfo_PackedLevelFilename(lfi, LEVEL_FILE_TYPE_UNKNOWN);
2331 if (fileExists(lfi->filename))
2334 // no known level file found -- use default values (and fail later)
2335 setLevelFileInfo_FormatLevelFilename(lfi, LEVEL_FILE_TYPE_RND,
2336 "%03d.%s", nr, LEVELFILE_EXTENSION);
2339 static void determineLevelFileInfo_Filetype(struct LevelFileInfo *lfi)
2341 if (lfi->type == LEVEL_FILE_TYPE_UNKNOWN)
2342 lfi->type = getFileTypeFromBasename(lfi->basename);
2344 if (lfi->type == LEVEL_FILE_TYPE_RND)
2345 lfi->type = getFileTypeFromMagicBytes(lfi->filename, lfi->type);
2348 static void setLevelFileInfo(struct LevelFileInfo *level_file_info, int nr)
2350 // always start with reliable default values
2351 setFileInfoToDefaults(level_file_info);
2353 level_file_info->nr = nr; // set requested level number
2355 determineLevelFileInfo_Filename(level_file_info);
2356 determineLevelFileInfo_Filetype(level_file_info);
2359 static void copyLevelFileInfo(struct LevelFileInfo *lfi_from,
2360 struct LevelFileInfo *lfi_to)
2362 lfi_to->nr = lfi_from->nr;
2363 lfi_to->type = lfi_from->type;
2364 lfi_to->packed = lfi_from->packed;
2366 setString(&lfi_to->basename, lfi_from->basename);
2367 setString(&lfi_to->filename, lfi_from->filename);
2370 // ----------------------------------------------------------------------------
2371 // functions for loading R'n'D level
2372 // ----------------------------------------------------------------------------
2374 int getMappedElement(int element)
2376 // remap some (historic, now obsolete) elements
2380 case EL_PLAYER_OBSOLETE:
2381 element = EL_PLAYER_1;
2384 case EL_KEY_OBSOLETE:
2388 case EL_EM_KEY_1_FILE_OBSOLETE:
2389 element = EL_EM_KEY_1;
2392 case EL_EM_KEY_2_FILE_OBSOLETE:
2393 element = EL_EM_KEY_2;
2396 case EL_EM_KEY_3_FILE_OBSOLETE:
2397 element = EL_EM_KEY_3;
2400 case EL_EM_KEY_4_FILE_OBSOLETE:
2401 element = EL_EM_KEY_4;
2404 case EL_ENVELOPE_OBSOLETE:
2405 element = EL_ENVELOPE_1;
2413 if (element >= NUM_FILE_ELEMENTS)
2415 Warn("invalid level element %d", element);
2417 element = EL_UNKNOWN;
2425 static int getMappedElementByVersion(int element, int game_version)
2427 // remap some elements due to certain game version
2429 if (game_version <= VERSION_IDENT(2,2,0,0))
2431 // map game font elements
2432 element = (element == EL_CHAR('[') ? EL_CHAR_AUMLAUT :
2433 element == EL_CHAR('\\') ? EL_CHAR_OUMLAUT :
2434 element == EL_CHAR(']') ? EL_CHAR_UUMLAUT :
2435 element == EL_CHAR('^') ? EL_CHAR_COPYRIGHT : element);
2438 if (game_version < VERSION_IDENT(3,0,0,0))
2440 // map Supaplex gravity tube elements
2441 element = (element == EL_SP_GRAVITY_PORT_LEFT ? EL_SP_PORT_LEFT :
2442 element == EL_SP_GRAVITY_PORT_RIGHT ? EL_SP_PORT_RIGHT :
2443 element == EL_SP_GRAVITY_PORT_UP ? EL_SP_PORT_UP :
2444 element == EL_SP_GRAVITY_PORT_DOWN ? EL_SP_PORT_DOWN :
2451 static int LoadLevel_VERS(File *file, int chunk_size, struct LevelInfo *level)
2453 level->file_version = getFileVersion(file);
2454 level->game_version = getFileVersion(file);
2459 static int LoadLevel_DATE(File *file, int chunk_size, struct LevelInfo *level)
2461 level->creation_date.year = getFile16BitBE(file);
2462 level->creation_date.month = getFile8Bit(file);
2463 level->creation_date.day = getFile8Bit(file);
2465 level->creation_date.src = DATE_SRC_LEVELFILE;
2470 static int LoadLevel_HEAD(File *file, int chunk_size, struct LevelInfo *level)
2472 int initial_player_stepsize;
2473 int initial_player_gravity;
2476 level->fieldx = getFile8Bit(file);
2477 level->fieldy = getFile8Bit(file);
2479 level->time = getFile16BitBE(file);
2480 level->gems_needed = getFile16BitBE(file);
2482 for (i = 0; i < MAX_LEVEL_NAME_LEN; i++)
2483 level->name[i] = getFile8Bit(file);
2484 level->name[MAX_LEVEL_NAME_LEN] = 0;
2486 for (i = 0; i < LEVEL_SCORE_ELEMENTS; i++)
2487 level->score[i] = getFile8Bit(file);
2489 level->num_yamyam_contents = STD_ELEMENT_CONTENTS;
2490 for (i = 0; i < STD_ELEMENT_CONTENTS; i++)
2491 for (y = 0; y < 3; y++)
2492 for (x = 0; x < 3; x++)
2493 level->yamyam_content[i].e[x][y] = getMappedElement(getFile8Bit(file));
2495 level->amoeba_speed = getFile8Bit(file);
2496 level->time_magic_wall = getFile8Bit(file);
2497 level->time_wheel = getFile8Bit(file);
2498 level->amoeba_content = getMappedElement(getFile8Bit(file));
2500 initial_player_stepsize = (getFile8Bit(file) == 1 ? STEPSIZE_FAST :
2503 for (i = 0; i < MAX_PLAYERS; i++)
2504 level->initial_player_stepsize[i] = initial_player_stepsize;
2506 initial_player_gravity = (getFile8Bit(file) == 1 ? TRUE : FALSE);
2508 for (i = 0; i < MAX_PLAYERS; i++)
2509 level->initial_player_gravity[i] = initial_player_gravity;
2511 level->encoding_16bit_field = (getFile8Bit(file) == 1 ? TRUE : FALSE);
2512 level->em_slippery_gems = (getFile8Bit(file) == 1 ? TRUE : FALSE);
2514 level->use_custom_template = (getFile8Bit(file) == 1 ? TRUE : FALSE);
2516 level->block_last_field = (getFile8Bit(file) == 1 ? TRUE : FALSE);
2517 level->sp_block_last_field = (getFile8Bit(file) == 1 ? TRUE : FALSE);
2518 level->can_move_into_acid_bits = getFile32BitBE(file);
2519 level->dont_collide_with_bits = getFile8Bit(file);
2521 level->use_spring_bug = (getFile8Bit(file) == 1 ? TRUE : FALSE);
2522 level->use_step_counter = (getFile8Bit(file) == 1 ? TRUE : FALSE);
2524 level->instant_relocation = (getFile8Bit(file) == 1 ? TRUE : FALSE);
2525 level->can_pass_to_walkable = (getFile8Bit(file) == 1 ? TRUE : FALSE);
2526 level->grow_into_diggable = (getFile8Bit(file) == 1 ? TRUE : FALSE);
2528 level->game_engine_type = getFile8Bit(file);
2530 ReadUnusedBytesFromFile(file, LEVEL_CHUNK_HEAD_UNUSED);
2535 static int LoadLevel_NAME(File *file, int chunk_size, struct LevelInfo *level)
2539 for (i = 0; i < MAX_LEVEL_NAME_LEN; i++)
2540 level->name[i] = getFile8Bit(file);
2541 level->name[MAX_LEVEL_NAME_LEN] = 0;
2546 static int LoadLevel_AUTH(File *file, int chunk_size, struct LevelInfo *level)
2550 for (i = 0; i < MAX_LEVEL_AUTHOR_LEN; i++)
2551 level->author[i] = getFile8Bit(file);
2552 level->author[MAX_LEVEL_AUTHOR_LEN] = 0;
2557 static int LoadLevel_BODY(File *file, int chunk_size, struct LevelInfo *level)
2560 int chunk_size_expected = level->fieldx * level->fieldy;
2562 /* Note: "chunk_size" was wrong before version 2.0 when elements are
2563 stored with 16-bit encoding (and should be twice as big then).
2564 Even worse, playfield data was stored 16-bit when only yamyam content
2565 contained 16-bit elements and vice versa. */
2567 if (level->encoding_16bit_field && level->file_version >= FILE_VERSION_2_0)
2568 chunk_size_expected *= 2;
2570 if (chunk_size_expected != chunk_size)
2572 ReadUnusedBytesFromFile(file, chunk_size);
2573 return chunk_size_expected;
2576 for (y = 0; y < level->fieldy; y++)
2577 for (x = 0; x < level->fieldx; x++)
2578 level->field[x][y] =
2579 getMappedElement(level->encoding_16bit_field ? getFile16BitBE(file) :
2584 static int LoadLevel_CONT(File *file, int chunk_size, struct LevelInfo *level)
2587 int header_size = 4;
2588 int content_size = MAX_ELEMENT_CONTENTS * 3 * 3;
2589 int chunk_size_expected = header_size + content_size;
2591 /* Note: "chunk_size" was wrong before version 2.0 when elements are
2592 stored with 16-bit encoding (and should be twice as big then).
2593 Even worse, playfield data was stored 16-bit when only yamyam content
2594 contained 16-bit elements and vice versa. */
2596 if (level->encoding_16bit_field && level->file_version >= FILE_VERSION_2_0)
2597 chunk_size_expected += content_size;
2599 if (chunk_size_expected != chunk_size)
2601 ReadUnusedBytesFromFile(file, chunk_size);
2602 return chunk_size_expected;
2606 level->num_yamyam_contents = getFile8Bit(file);
2610 // correct invalid number of content fields -- should never happen
2611 if (level->num_yamyam_contents < 1 ||
2612 level->num_yamyam_contents > MAX_ELEMENT_CONTENTS)
2613 level->num_yamyam_contents = STD_ELEMENT_CONTENTS;
2615 for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
2616 for (y = 0; y < 3; y++)
2617 for (x = 0; x < 3; x++)
2618 level->yamyam_content[i].e[x][y] =
2619 getMappedElement(level->encoding_16bit_field ?
2620 getFile16BitBE(file) : getFile8Bit(file));
2624 static int LoadLevel_CNT2(File *file, int chunk_size, struct LevelInfo *level)
2629 int content_array[MAX_ELEMENT_CONTENTS][3][3];
2631 element = getMappedElement(getFile16BitBE(file));
2632 num_contents = getFile8Bit(file);
2634 getFile8Bit(file); // content x size (unused)
2635 getFile8Bit(file); // content y size (unused)
2637 ReadUnusedBytesFromFile(file, LEVEL_CHUNK_CNT2_UNUSED);
2639 for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
2640 for (y = 0; y < 3; y++)
2641 for (x = 0; x < 3; x++)
2642 content_array[i][x][y] = getMappedElement(getFile16BitBE(file));
2644 // correct invalid number of content fields -- should never happen
2645 if (num_contents < 1 || num_contents > MAX_ELEMENT_CONTENTS)
2646 num_contents = STD_ELEMENT_CONTENTS;
2648 if (element == EL_YAMYAM)
2650 level->num_yamyam_contents = num_contents;
2652 for (i = 0; i < num_contents; i++)
2653 for (y = 0; y < 3; y++)
2654 for (x = 0; x < 3; x++)
2655 level->yamyam_content[i].e[x][y] = content_array[i][x][y];
2657 else if (element == EL_BD_AMOEBA)
2659 level->amoeba_content = content_array[0][0][0];
2663 Warn("cannot load content for element '%d'", element);
2669 static int LoadLevel_CNT3(File *file, int chunk_size, struct LevelInfo *level)
2675 int chunk_size_expected;
2677 element = getMappedElement(getFile16BitBE(file));
2678 if (!IS_ENVELOPE(element))
2679 element = EL_ENVELOPE_1;
2681 envelope_nr = element - EL_ENVELOPE_1;
2683 envelope_len = getFile16BitBE(file);
2685 level->envelope[envelope_nr].xsize = getFile8Bit(file);
2686 level->envelope[envelope_nr].ysize = getFile8Bit(file);
2688 ReadUnusedBytesFromFile(file, LEVEL_CHUNK_CNT3_UNUSED);
2690 chunk_size_expected = LEVEL_CHUNK_CNT3_SIZE(envelope_len);
2691 if (chunk_size_expected != chunk_size)
2693 ReadUnusedBytesFromFile(file, chunk_size - LEVEL_CHUNK_CNT3_HEADER);
2694 return chunk_size_expected;
2697 for (i = 0; i < envelope_len; i++)
2698 level->envelope[envelope_nr].text[i] = getFile8Bit(file);
2703 static int LoadLevel_CUS1(File *file, int chunk_size, struct LevelInfo *level)
2705 int num_changed_custom_elements = getFile16BitBE(file);
2706 int chunk_size_expected = 2 + num_changed_custom_elements * 6;
2709 if (chunk_size_expected != chunk_size)
2711 ReadUnusedBytesFromFile(file, chunk_size - 2);
2712 return chunk_size_expected;
2715 for (i = 0; i < num_changed_custom_elements; i++)
2717 int element = getMappedElement(getFile16BitBE(file));
2718 int properties = getFile32BitBE(file);
2720 if (IS_CUSTOM_ELEMENT(element))
2721 element_info[element].properties[EP_BITFIELD_BASE_NR] = properties;
2723 Warn("invalid custom element number %d", element);
2725 // older game versions that wrote level files with CUS1 chunks used
2726 // different default push delay values (not yet stored in level file)
2727 element_info[element].push_delay_fixed = 2;
2728 element_info[element].push_delay_random = 8;
2731 level->file_has_custom_elements = TRUE;
2736 static int LoadLevel_CUS2(File *file, int chunk_size, struct LevelInfo *level)
2738 int num_changed_custom_elements = getFile16BitBE(file);
2739 int chunk_size_expected = 2 + num_changed_custom_elements * 4;
2742 if (chunk_size_expected != chunk_size)
2744 ReadUnusedBytesFromFile(file, chunk_size - 2);
2745 return chunk_size_expected;
2748 for (i = 0; i < num_changed_custom_elements; i++)
2750 int element = getMappedElement(getFile16BitBE(file));
2751 int custom_target_element = getMappedElement(getFile16BitBE(file));
2753 if (IS_CUSTOM_ELEMENT(element))
2754 element_info[element].change->target_element = custom_target_element;
2756 Warn("invalid custom element number %d", element);
2759 level->file_has_custom_elements = TRUE;
2764 static int LoadLevel_CUS3(File *file, int chunk_size, struct LevelInfo *level)
2766 int num_changed_custom_elements = getFile16BitBE(file);
2767 int chunk_size_expected = LEVEL_CHUNK_CUS3_SIZE(num_changed_custom_elements);
2770 if (chunk_size_expected != chunk_size)
2772 ReadUnusedBytesFromFile(file, chunk_size - 2);
2773 return chunk_size_expected;
2776 for (i = 0; i < num_changed_custom_elements; i++)
2778 int element = getMappedElement(getFile16BitBE(file));
2779 struct ElementInfo *ei = &element_info[element];
2780 unsigned int event_bits;
2782 if (!IS_CUSTOM_ELEMENT(element))
2784 Warn("invalid custom element number %d", element);
2786 element = EL_INTERNAL_DUMMY;
2789 for (j = 0; j < MAX_ELEMENT_NAME_LEN; j++)
2790 ei->description[j] = getFile8Bit(file);
2791 ei->description[MAX_ELEMENT_NAME_LEN] = 0;
2793 ei->properties[EP_BITFIELD_BASE_NR] = getFile32BitBE(file);
2795 // some free bytes for future properties and padding
2796 ReadUnusedBytesFromFile(file, 7);
2798 ei->use_gfx_element = getFile8Bit(file);
2799 ei->gfx_element_initial = getMappedElement(getFile16BitBE(file));
2801 ei->collect_score_initial = getFile8Bit(file);
2802 ei->collect_count_initial = getFile8Bit(file);
2804 ei->push_delay_fixed = getFile16BitBE(file);
2805 ei->push_delay_random = getFile16BitBE(file);
2806 ei->move_delay_fixed = getFile16BitBE(file);
2807 ei->move_delay_random = getFile16BitBE(file);
2809 ei->move_pattern = getFile16BitBE(file);
2810 ei->move_direction_initial = getFile8Bit(file);
2811 ei->move_stepsize = getFile8Bit(file);
2813 for (y = 0; y < 3; y++)
2814 for (x = 0; x < 3; x++)
2815 ei->content.e[x][y] = getMappedElement(getFile16BitBE(file));
2817 event_bits = getFile32BitBE(file);
2818 for (j = 0; j < NUM_CHANGE_EVENTS; j++)
2819 if (event_bits & (1 << j))
2820 ei->change->has_event[j] = TRUE;
2822 ei->change->target_element = getMappedElement(getFile16BitBE(file));
2824 ei->change->delay_fixed = getFile16BitBE(file);
2825 ei->change->delay_random = getFile16BitBE(file);
2826 ei->change->delay_frames = getFile16BitBE(file);
2828 ei->change->initial_trigger_element= getMappedElement(getFile16BitBE(file));
2830 ei->change->explode = getFile8Bit(file);
2831 ei->change->use_target_content = getFile8Bit(file);
2832 ei->change->only_if_complete = getFile8Bit(file);
2833 ei->change->use_random_replace = getFile8Bit(file);
2835 ei->change->random_percentage = getFile8Bit(file);
2836 ei->change->replace_when = getFile8Bit(file);
2838 for (y = 0; y < 3; y++)
2839 for (x = 0; x < 3; x++)
2840 ei->change->target_content.e[x][y] =
2841 getMappedElement(getFile16BitBE(file));
2843 ei->slippery_type = getFile8Bit(file);
2845 // some free bytes for future properties and padding
2846 ReadUnusedBytesFromFile(file, LEVEL_CPART_CUS3_UNUSED);
2848 // mark that this custom element has been modified
2849 ei->modified_settings = TRUE;
2852 level->file_has_custom_elements = TRUE;
2857 static int LoadLevel_CUS4(File *file, int chunk_size, struct LevelInfo *level)
2859 struct ElementInfo *ei;
2860 int chunk_size_expected;
2864 // ---------- custom element base property values (96 bytes) ----------------
2866 element = getMappedElement(getFile16BitBE(file));
2868 if (!IS_CUSTOM_ELEMENT(element))
2870 Warn("invalid custom element number %d", element);
2872 ReadUnusedBytesFromFile(file, chunk_size - 2);
2877 ei = &element_info[element];
2879 for (i = 0; i < MAX_ELEMENT_NAME_LEN; i++)
2880 ei->description[i] = getFile8Bit(file);
2881 ei->description[MAX_ELEMENT_NAME_LEN] = 0;
2883 ei->properties[EP_BITFIELD_BASE_NR] = getFile32BitBE(file);
2885 ReadUnusedBytesFromFile(file, 4); // reserved for more base properties
2887 ei->num_change_pages = getFile8Bit(file);
2889 chunk_size_expected = LEVEL_CHUNK_CUS4_SIZE(ei->num_change_pages);
2890 if (chunk_size_expected != chunk_size)
2892 ReadUnusedBytesFromFile(file, chunk_size - 43);
2893 return chunk_size_expected;
2896 ei->ce_value_fixed_initial = getFile16BitBE(file);
2897 ei->ce_value_random_initial = getFile16BitBE(file);
2898 ei->use_last_ce_value = getFile8Bit(file);
2900 ei->use_gfx_element = getFile8Bit(file);
2901 ei->gfx_element_initial = getMappedElement(getFile16BitBE(file));
2903 ei->collect_score_initial = getFile8Bit(file);
2904 ei->collect_count_initial = getFile8Bit(file);
2906 ei->drop_delay_fixed = getFile8Bit(file);
2907 ei->push_delay_fixed = getFile8Bit(file);
2908 ei->drop_delay_random = getFile8Bit(file);
2909 ei->push_delay_random = getFile8Bit(file);
2910 ei->move_delay_fixed = getFile16BitBE(file);
2911 ei->move_delay_random = getFile16BitBE(file);
2913 // bits 0 - 15 of "move_pattern" ...
2914 ei->move_pattern = getFile16BitBE(file);
2915 ei->move_direction_initial = getFile8Bit(file);
2916 ei->move_stepsize = getFile8Bit(file);
2918 ei->slippery_type = getFile8Bit(file);
2920 for (y = 0; y < 3; y++)
2921 for (x = 0; x < 3; x++)
2922 ei->content.e[x][y] = getMappedElement(getFile16BitBE(file));
2924 ei->move_enter_element = getMappedElement(getFile16BitBE(file));
2925 ei->move_leave_element = getMappedElement(getFile16BitBE(file));
2926 ei->move_leave_type = getFile8Bit(file);
2928 // ... bits 16 - 31 of "move_pattern" (not nice, but downward compatible)
2929 ei->move_pattern |= (getFile16BitBE(file) << 16);
2931 ei->access_direction = getFile8Bit(file);
2933 ei->explosion_delay = getFile8Bit(file);
2934 ei->ignition_delay = getFile8Bit(file);
2935 ei->explosion_type = getFile8Bit(file);
2937 // some free bytes for future custom property values and padding
2938 ReadUnusedBytesFromFile(file, 1);
2940 // ---------- change page property values (48 bytes) ------------------------
2942 setElementChangePages(ei, ei->num_change_pages);
2944 for (i = 0; i < ei->num_change_pages; i++)
2946 struct ElementChangeInfo *change = &ei->change_page[i];
2947 unsigned int event_bits;
2949 // always start with reliable default values
2950 setElementChangeInfoToDefaults(change);
2952 // bits 0 - 31 of "has_event[]" ...
2953 event_bits = getFile32BitBE(file);
2954 for (j = 0; j < MIN(NUM_CHANGE_EVENTS, 32); j++)
2955 if (event_bits & (1 << j))
2956 change->has_event[j] = TRUE;
2958 change->target_element = getMappedElement(getFile16BitBE(file));
2960 change->delay_fixed = getFile16BitBE(file);
2961 change->delay_random = getFile16BitBE(file);
2962 change->delay_frames = getFile16BitBE(file);
2964 change->initial_trigger_element = getMappedElement(getFile16BitBE(file));
2966 change->explode = getFile8Bit(file);
2967 change->use_target_content = getFile8Bit(file);
2968 change->only_if_complete = getFile8Bit(file);
2969 change->use_random_replace = getFile8Bit(file);
2971 change->random_percentage = getFile8Bit(file);
2972 change->replace_when = getFile8Bit(file);
2974 for (y = 0; y < 3; y++)
2975 for (x = 0; x < 3; x++)
2976 change->target_content.e[x][y]= getMappedElement(getFile16BitBE(file));
2978 change->can_change = getFile8Bit(file);
2980 change->trigger_side = getFile8Bit(file);
2982 change->trigger_player = getFile8Bit(file);
2983 change->trigger_page = getFile8Bit(file);
2985 change->trigger_page = (change->trigger_page == CH_PAGE_ANY_FILE ?
2986 CH_PAGE_ANY : (1 << change->trigger_page));
2988 change->has_action = getFile8Bit(file);
2989 change->action_type = getFile8Bit(file);
2990 change->action_mode = getFile8Bit(file);
2991 change->action_arg = getFile16BitBE(file);
2993 // ... bits 32 - 39 of "has_event[]" (not nice, but downward compatible)
2994 event_bits = getFile8Bit(file);
2995 for (j = 32; j < NUM_CHANGE_EVENTS; j++)
2996 if (event_bits & (1 << (j - 32)))
2997 change->has_event[j] = TRUE;
3000 // mark this custom element as modified
3001 ei->modified_settings = TRUE;
3003 level->file_has_custom_elements = TRUE;
3008 static int LoadLevel_GRP1(File *file, int chunk_size, struct LevelInfo *level)
3010 struct ElementInfo *ei;
3011 struct ElementGroupInfo *group;
3015 element = getMappedElement(getFile16BitBE(file));
3017 if (!IS_GROUP_ELEMENT(element))
3019 Warn("invalid group element number %d", element);
3021 ReadUnusedBytesFromFile(file, chunk_size - 2);
3026 ei = &element_info[element];
3028 for (i = 0; i < MAX_ELEMENT_NAME_LEN; i++)
3029 ei->description[i] = getFile8Bit(file);
3030 ei->description[MAX_ELEMENT_NAME_LEN] = 0;
3032 group = element_info[element].group;
3034 group->num_elements = getFile8Bit(file);
3036 ei->use_gfx_element = getFile8Bit(file);
3037 ei->gfx_element_initial = getMappedElement(getFile16BitBE(file));
3039 group->choice_mode = getFile8Bit(file);
3041 // some free bytes for future values and padding
3042 ReadUnusedBytesFromFile(file, 3);
3044 for (i = 0; i < MAX_ELEMENTS_IN_GROUP; i++)
3045 group->element[i] = getMappedElement(getFile16BitBE(file));
3047 // mark this group element as modified
3048 element_info[element].modified_settings = TRUE;
3050 level->file_has_custom_elements = TRUE;
3055 static int LoadLevel_MicroChunk(File *file, struct LevelFileConfigInfo *conf,
3056 int element, int real_element)
3058 int micro_chunk_size = 0;
3059 int conf_type = getFile8Bit(file);
3060 int byte_mask = conf_type & CONF_MASK_BYTES;
3061 boolean element_found = FALSE;
3064 micro_chunk_size += 1;
3066 if (byte_mask == CONF_MASK_MULTI_BYTES)
3068 int num_bytes = getFile16BitBE(file);
3069 byte *buffer = checked_malloc(num_bytes);
3071 ReadBytesFromFile(file, buffer, num_bytes);
3073 for (i = 0; conf[i].data_type != -1; i++)
3075 if (conf[i].element == element &&
3076 conf[i].conf_type == conf_type)
3078 int data_type = conf[i].data_type;
3079 int num_entities = num_bytes / CONF_ENTITY_NUM_BYTES(data_type);
3080 int max_num_entities = conf[i].max_num_entities;
3082 if (num_entities > max_num_entities)
3084 Warn("truncating number of entities for element %d from %d to %d",
3085 element, num_entities, max_num_entities);
3087 num_entities = max_num_entities;
3090 if (num_entities == 0 && (data_type == TYPE_ELEMENT_LIST ||
3091 data_type == TYPE_CONTENT_LIST))
3093 // for element and content lists, zero entities are not allowed
3094 Warn("found empty list of entities for element %d", element);
3096 // do not set "num_entities" here to prevent reading behind buffer
3098 *(int *)(conf[i].num_entities) = 1; // at least one is required
3102 *(int *)(conf[i].num_entities) = num_entities;
3105 element_found = TRUE;
3107 if (data_type == TYPE_STRING)
3109 char *string = (char *)(conf[i].value);
3112 for (j = 0; j < max_num_entities; j++)
3113 string[j] = (j < num_entities ? buffer[j] : '\0');
3115 else if (data_type == TYPE_ELEMENT_LIST)
3117 int *element_array = (int *)(conf[i].value);
3120 for (j = 0; j < num_entities; j++)
3122 getMappedElement(CONF_ELEMENTS_ELEMENT(buffer, j));
3124 else if (data_type == TYPE_CONTENT_LIST)
3126 struct Content *content= (struct Content *)(conf[i].value);
3129 for (c = 0; c < num_entities; c++)
3130 for (y = 0; y < 3; y++)
3131 for (x = 0; x < 3; x++)
3132 content[c].e[x][y] =
3133 getMappedElement(CONF_CONTENTS_ELEMENT(buffer, c, x, y));
3136 element_found = FALSE;
3142 checked_free(buffer);
3144 micro_chunk_size += 2 + num_bytes;
3146 else // constant size configuration data (1, 2 or 4 bytes)
3148 int value = (byte_mask == CONF_MASK_1_BYTE ? getFile8Bit (file) :
3149 byte_mask == CONF_MASK_2_BYTE ? getFile16BitBE(file) :
3150 byte_mask == CONF_MASK_4_BYTE ? getFile32BitBE(file) : 0);
3152 for (i = 0; conf[i].data_type != -1; i++)
3154 if (conf[i].element == element &&
3155 conf[i].conf_type == conf_type)
3157 int data_type = conf[i].data_type;
3159 if (data_type == TYPE_ELEMENT)
3160 value = getMappedElement(value);
3162 if (data_type == TYPE_BOOLEAN)
3163 *(boolean *)(conf[i].value) = (value ? TRUE : FALSE);
3165 *(int *) (conf[i].value) = value;
3167 element_found = TRUE;
3173 micro_chunk_size += CONF_VALUE_NUM_BYTES(byte_mask);
3178 char *error_conf_chunk_bytes =
3179 (byte_mask == CONF_MASK_1_BYTE ? "CONF_VALUE_8_BIT" :
3180 byte_mask == CONF_MASK_2_BYTE ? "CONF_VALUE_16_BIT" :
3181 byte_mask == CONF_MASK_4_BYTE ? "CONF_VALUE_32_BIT" :"CONF_VALUE_BYTES");
3182 int error_conf_chunk_token = conf_type & CONF_MASK_TOKEN;
3183 int error_element = real_element;
3185 Warn("cannot load micro chunk '%s(%d)' value for element %d ['%s']",
3186 error_conf_chunk_bytes, error_conf_chunk_token,
3187 error_element, EL_NAME(error_element));
3190 return micro_chunk_size;
3193 static int LoadLevel_INFO(File *file, int chunk_size, struct LevelInfo *level)
3195 int real_chunk_size = 0;
3197 li = *level; // copy level data into temporary buffer
3199 while (!checkEndOfFile(file))
3201 real_chunk_size += LoadLevel_MicroChunk(file, chunk_config_INFO, -1, -1);
3203 if (real_chunk_size >= chunk_size)
3207 *level = li; // copy temporary buffer back to level data
3209 return real_chunk_size;
3212 static int LoadLevel_CONF(File *file, int chunk_size, struct LevelInfo *level)
3214 int real_chunk_size = 0;
3216 li = *level; // copy level data into temporary buffer
3218 while (!checkEndOfFile(file))
3220 int element = getMappedElement(getFile16BitBE(file));
3222 real_chunk_size += 2;
3223 real_chunk_size += LoadLevel_MicroChunk(file, chunk_config_CONF,
3225 if (real_chunk_size >= chunk_size)
3229 *level = li; // copy temporary buffer back to level data
3231 return real_chunk_size;
3234 static int LoadLevel_ELEM(File *file, int chunk_size, struct LevelInfo *level)
3236 int real_chunk_size = 0;
3238 li = *level; // copy level data into temporary buffer
3240 while (!checkEndOfFile(file))
3242 int element = getMappedElement(getFile16BitBE(file));
3244 real_chunk_size += 2;
3245 real_chunk_size += LoadLevel_MicroChunk(file, chunk_config_ELEM,
3247 if (real_chunk_size >= chunk_size)
3251 *level = li; // copy temporary buffer back to level data
3253 return real_chunk_size;
3256 static int LoadLevel_NOTE(File *file, int chunk_size, struct LevelInfo *level)
3258 int element = getMappedElement(getFile16BitBE(file));
3259 int envelope_nr = element - EL_ENVELOPE_1;
3260 int real_chunk_size = 2;
3262 xx_envelope = level->envelope[envelope_nr]; // copy into temporary buffer
3264 while (!checkEndOfFile(file))
3266 real_chunk_size += LoadLevel_MicroChunk(file, chunk_config_NOTE,
3269 if (real_chunk_size >= chunk_size)
3273 level->envelope[envelope_nr] = xx_envelope; // copy from temporary buffer
3275 return real_chunk_size;
3278 static int LoadLevel_CUSX(File *file, int chunk_size, struct LevelInfo *level)
3280 int element = getMappedElement(getFile16BitBE(file));
3281 int real_chunk_size = 2;
3282 struct ElementInfo *ei = &element_info[element];
3285 xx_ei = *ei; // copy element data into temporary buffer
3287 xx_ei.num_change_pages = -1;
3289 while (!checkEndOfFile(file))
3291 real_chunk_size += LoadLevel_MicroChunk(file, chunk_config_CUSX_base,
3293 if (xx_ei.num_change_pages != -1)
3296 if (real_chunk_size >= chunk_size)
3302 if (ei->num_change_pages == -1)
3304 Warn("LoadLevel_CUSX(): missing 'num_change_pages' for '%s'",
3307 ei->num_change_pages = 1;
3309 setElementChangePages(ei, 1);
3310 setElementChangeInfoToDefaults(ei->change);
3312 return real_chunk_size;
3315 // initialize number of change pages stored for this custom element
3316 setElementChangePages(ei, ei->num_change_pages);
3317 for (i = 0; i < ei->num_change_pages; i++)
3318 setElementChangeInfoToDefaults(&ei->change_page[i]);
3320 // start with reading properties for the first change page
3321 xx_current_change_page = 0;
3323 while (!checkEndOfFile(file))
3325 struct ElementChangeInfo *change = &ei->change_page[xx_current_change_page];
3327 xx_change = *change; // copy change data into temporary buffer
3329 resetEventBits(); // reset bits; change page might have changed
3331 real_chunk_size += LoadLevel_MicroChunk(file, chunk_config_CUSX_change,
3334 *change = xx_change;
3336 setEventFlagsFromEventBits(change);
3338 if (real_chunk_size >= chunk_size)
3342 level->file_has_custom_elements = TRUE;
3344 return real_chunk_size;
3347 static int LoadLevel_GRPX(File *file, int chunk_size, struct LevelInfo *level)
3349 int element = getMappedElement(getFile16BitBE(file));
3350 int real_chunk_size = 2;
3351 struct ElementInfo *ei = &element_info[element];
3352 struct ElementGroupInfo *group = ei->group;
3354 xx_ei = *ei; // copy element data into temporary buffer
3355 xx_group = *group; // copy group data into temporary buffer
3357 while (!checkEndOfFile(file))
3359 real_chunk_size += LoadLevel_MicroChunk(file, chunk_config_GRPX,
3362 if (real_chunk_size >= chunk_size)
3369 level->file_has_custom_elements = TRUE;
3371 return real_chunk_size;
3374 static void LoadLevelFromFileInfo_RND(struct LevelInfo *level,
3375 struct LevelFileInfo *level_file_info,
3376 boolean level_info_only)
3378 char *filename = level_file_info->filename;
3379 char cookie[MAX_LINE_LEN];
3380 char chunk_name[CHUNK_ID_LEN + 1];
3384 if (!(file = openFile(filename, MODE_READ)))
3386 level->no_valid_file = TRUE;
3387 level->no_level_file = TRUE;
3389 if (level_info_only)
3392 Warn("cannot read level '%s' -- using empty level", filename);
3394 if (!setup.editor.use_template_for_new_levels)
3397 // if level file not found, try to initialize level data from template
3398 filename = getGlobalLevelTemplateFilename();
3400 if (!(file = openFile(filename, MODE_READ)))
3403 // default: for empty levels, use level template for custom elements
3404 level->use_custom_template = TRUE;
3406 level->no_valid_file = FALSE;
3409 getFileChunkBE(file, chunk_name, NULL);
3410 if (strEqual(chunk_name, "RND1"))
3412 getFile32BitBE(file); // not used
3414 getFileChunkBE(file, chunk_name, NULL);
3415 if (!strEqual(chunk_name, "CAVE"))
3417 level->no_valid_file = TRUE;
3419 Warn("unknown format of level file '%s'", filename);
3426 else // check for pre-2.0 file format with cookie string
3428 strcpy(cookie, chunk_name);
3429 if (getStringFromFile(file, &cookie[4], MAX_LINE_LEN - 4) == NULL)
3431 if (strlen(cookie) > 0 && cookie[strlen(cookie) - 1] == '\n')
3432 cookie[strlen(cookie) - 1] = '\0';
3434 if (!checkCookieString(cookie, LEVEL_COOKIE_TMPL))
3436 level->no_valid_file = TRUE;
3438 Warn("unknown format of level file '%s'", filename);
3445 if ((level->file_version = getFileVersionFromCookieString(cookie)) == -1)
3447 level->no_valid_file = TRUE;
3449 Warn("unsupported version of level file '%s'", filename);
3456 // pre-2.0 level files have no game version, so use file version here
3457 level->game_version = level->file_version;
3460 if (level->file_version < FILE_VERSION_1_2)
3462 // level files from versions before 1.2.0 without chunk structure
3463 LoadLevel_HEAD(file, LEVEL_CHUNK_HEAD_SIZE, level);
3464 LoadLevel_BODY(file, level->fieldx * level->fieldy, level);
3472 int (*loader)(File *, int, struct LevelInfo *);
3476 { "VERS", LEVEL_CHUNK_VERS_SIZE, LoadLevel_VERS },
3477 { "DATE", LEVEL_CHUNK_DATE_SIZE, LoadLevel_DATE },
3478 { "HEAD", LEVEL_CHUNK_HEAD_SIZE, LoadLevel_HEAD },
3479 { "NAME", LEVEL_CHUNK_NAME_SIZE, LoadLevel_NAME },
3480 { "AUTH", LEVEL_CHUNK_AUTH_SIZE, LoadLevel_AUTH },
3481 { "INFO", -1, LoadLevel_INFO },
3482 { "BODY", -1, LoadLevel_BODY },
3483 { "CONT", -1, LoadLevel_CONT },
3484 { "CNT2", LEVEL_CHUNK_CNT2_SIZE, LoadLevel_CNT2 },
3485 { "CNT3", -1, LoadLevel_CNT3 },
3486 { "CUS1", -1, LoadLevel_CUS1 },
3487 { "CUS2", -1, LoadLevel_CUS2 },
3488 { "CUS3", -1, LoadLevel_CUS3 },
3489 { "CUS4", -1, LoadLevel_CUS4 },
3490 { "GRP1", -1, LoadLevel_GRP1 },
3491 { "CONF", -1, LoadLevel_CONF },
3492 { "ELEM", -1, LoadLevel_ELEM },
3493 { "NOTE", -1, LoadLevel_NOTE },
3494 { "CUSX", -1, LoadLevel_CUSX },
3495 { "GRPX", -1, LoadLevel_GRPX },
3500 while (getFileChunkBE(file, chunk_name, &chunk_size))
3504 while (chunk_info[i].name != NULL &&
3505 !strEqual(chunk_name, chunk_info[i].name))
3508 if (chunk_info[i].name == NULL)
3510 Warn("unknown chunk '%s' in level file '%s'",
3511 chunk_name, filename);
3513 ReadUnusedBytesFromFile(file, chunk_size);
3515 else if (chunk_info[i].size != -1 &&
3516 chunk_info[i].size != chunk_size)
3518 Warn("wrong size (%d) of chunk '%s' in level file '%s'",
3519 chunk_size, chunk_name, filename);
3521 ReadUnusedBytesFromFile(file, chunk_size);
3525 // call function to load this level chunk
3526 int chunk_size_expected =
3527 (chunk_info[i].loader)(file, chunk_size, level);
3529 // the size of some chunks cannot be checked before reading other
3530 // chunks first (like "HEAD" and "BODY") that contain some header
3531 // information, so check them here
3532 if (chunk_size_expected != chunk_size)
3534 Warn("wrong size (%d) of chunk '%s' in level file '%s'",
3535 chunk_size, chunk_name, filename);
3545 // ----------------------------------------------------------------------------
3546 // functions for loading EM level
3547 // ----------------------------------------------------------------------------
3549 static void CopyNativeLevel_RND_to_EM(struct LevelInfo *level)
3551 static int ball_xy[8][2] =
3562 struct LevelInfo_EM *level_em = level->native_em_level;
3563 struct CAVE *cav = level_em->cav;
3566 cav->width = MIN(level->fieldx, MAX_PLAYFIELD_WIDTH);
3567 cav->height = MIN(level->fieldy, MAX_PLAYFIELD_HEIGHT);
3569 cav->time_seconds = level->time;
3570 cav->gems_needed = level->gems_needed;
3572 cav->emerald_score = level->score[SC_EMERALD];
3573 cav->diamond_score = level->score[SC_DIAMOND];
3574 cav->alien_score = level->score[SC_ROBOT];
3575 cav->tank_score = level->score[SC_SPACESHIP];
3576 cav->bug_score = level->score[SC_BUG];
3577 cav->eater_score = level->score[SC_YAMYAM];
3578 cav->nut_score = level->score[SC_NUT];
3579 cav->dynamite_score = level->score[SC_DYNAMITE];
3580 cav->key_score = level->score[SC_KEY];
3581 cav->exit_score = level->score[SC_TIME_BONUS];
3583 cav->num_eater_arrays = level->num_yamyam_contents;
3585 for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
3586 for (y = 0; y < 3; y++)
3587 for (x = 0; x < 3; x++)
3588 cav->eater_array[i][y * 3 + x] =
3589 map_element_RND_to_EM_cave(level->yamyam_content[i].e[x][y]);
3591 cav->amoeba_time = level->amoeba_speed;
3592 cav->wonderwall_time = level->time_magic_wall;
3593 cav->wheel_time = level->time_wheel;
3595 cav->android_move_time = level->android_move_time;
3596 cav->android_clone_time = level->android_clone_time;
3597 cav->ball_random = level->ball_random;
3598 cav->ball_active = level->ball_active_initial;
3599 cav->ball_time = level->ball_time;
3600 cav->num_ball_arrays = level->num_ball_contents;
3602 cav->lenses_score = level->lenses_score;
3603 cav->magnify_score = level->magnify_score;
3604 cav->slurp_score = level->slurp_score;
3606 cav->lenses_time = level->lenses_time;
3607 cav->magnify_time = level->magnify_time;
3609 cav->wind_direction =
3610 map_direction_RND_to_EM(level->wind_direction_initial);
3612 for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
3613 for (j = 0; j < 8; j++)
3614 cav->ball_array[i][j] =
3615 map_element_RND_to_EM_cave(level->ball_content[i].
3616 e[ball_xy[j][0]][ball_xy[j][1]]);
3618 map_android_clone_elements_RND_to_EM(level);
3620 // first fill the complete playfield with the empty space element
3621 for (y = 0; y < EM_MAX_CAVE_HEIGHT; y++)
3622 for (x = 0; x < EM_MAX_CAVE_WIDTH; x++)
3623 cav->cave[x][y] = Cblank;
3625 // then copy the real level contents from level file into the playfield
3626 for (y = 0; y < cav->height; y++) for (x = 0; x < cav->width; x++)
3628 int new_element = map_element_RND_to_EM_cave(level->field[x][y]);
3630 if (level->field[x][y] == EL_AMOEBA_DEAD)
3631 new_element = map_element_RND_to_EM_cave(EL_AMOEBA_WET);
3633 cav->cave[x][y] = new_element;
3636 for (i = 0; i < MAX_PLAYERS; i++)
3638 cav->player_x[i] = -1;
3639 cav->player_y[i] = -1;
3642 // initialize player positions and delete players from the playfield
3643 for (y = 0; y < cav->height; y++) for (x = 0; x < cav->width; x++)
3645 if (IS_PLAYER_ELEMENT(level->field[x][y]))
3647 int player_nr = GET_PLAYER_NR(level->field[x][y]);
3649 cav->player_x[player_nr] = x;
3650 cav->player_y[player_nr] = y;
3652 cav->cave[x][y] = map_element_RND_to_EM_cave(EL_EMPTY);
3657 static void CopyNativeLevel_EM_to_RND(struct LevelInfo *level)
3659 static int ball_xy[8][2] =
3670 struct LevelInfo_EM *level_em = level->native_em_level;
3671 struct CAVE *cav = level_em->cav;
3674 level->fieldx = MIN(cav->width, MAX_LEV_FIELDX);
3675 level->fieldy = MIN(cav->height, MAX_LEV_FIELDY);
3677 level->time = cav->time_seconds;
3678 level->gems_needed = cav->gems_needed;
3680 sprintf(level->name, "Level %d", level->file_info.nr);
3682 level->score[SC_EMERALD] = cav->emerald_score;
3683 level->score[SC_DIAMOND] = cav->diamond_score;
3684 level->score[SC_ROBOT] = cav->alien_score;
3685 level->score[SC_SPACESHIP] = cav->tank_score;
3686 level->score[SC_BUG] = cav->bug_score;
3687 level->score[SC_YAMYAM] = cav->eater_score;
3688 level->score[SC_NUT] = cav->nut_score;
3689 level->score[SC_DYNAMITE] = cav->dynamite_score;
3690 level->score[SC_KEY] = cav->key_score;
3691 level->score[SC_TIME_BONUS] = cav->exit_score;
3693 level->num_yamyam_contents = cav->num_eater_arrays;
3695 for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
3696 for (y = 0; y < 3; y++)
3697 for (x = 0; x < 3; x++)
3698 level->yamyam_content[i].e[x][y] =
3699 map_element_EM_to_RND_cave(cav->eater_array[i][y * 3 + x]);
3701 level->amoeba_speed = cav->amoeba_time;
3702 level->time_magic_wall = cav->wonderwall_time;
3703 level->time_wheel = cav->wheel_time;
3705 level->android_move_time = cav->android_move_time;
3706 level->android_clone_time = cav->android_clone_time;
3707 level->ball_random = cav->ball_random;
3708 level->ball_active_initial = cav->ball_active;
3709 level->ball_time = cav->ball_time;
3710 level->num_ball_contents = cav->num_ball_arrays;
3712 level->lenses_score = cav->lenses_score;
3713 level->magnify_score = cav->magnify_score;
3714 level->slurp_score = cav->slurp_score;
3716 level->lenses_time = cav->lenses_time;
3717 level->magnify_time = cav->magnify_time;
3719 level->wind_direction_initial =
3720 map_direction_EM_to_RND(cav->wind_direction);
3722 for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
3723 for (j = 0; j < 8; j++)
3724 level->ball_content[i].e[ball_xy[j][0]][ball_xy[j][1]] =
3725 map_element_EM_to_RND_cave(cav->ball_array[i][j]);
3727 map_android_clone_elements_EM_to_RND(level);
3729 // convert the playfield (some elements need special treatment)
3730 for (y = 0; y < level->fieldy; y++) for (x = 0; x < level->fieldx; x++)
3732 int new_element = map_element_EM_to_RND_cave(cav->cave[x][y]);
3734 if (new_element == EL_AMOEBA_WET && level->amoeba_speed == 0)
3735 new_element = EL_AMOEBA_DEAD;
3737 level->field[x][y] = new_element;
3740 for (i = 0; i < MAX_PLAYERS; i++)
3742 // in case of all players set to the same field, use the first player
3743 int nr = MAX_PLAYERS - i - 1;
3744 int jx = cav->player_x[nr];
3745 int jy = cav->player_y[nr];
3747 if (jx != -1 && jy != -1)
3748 level->field[jx][jy] = EL_PLAYER_1 + nr;
3751 // time score is counted for each 10 seconds left in Emerald Mine levels
3752 level->time_score_base = 10;
3756 // ----------------------------------------------------------------------------
3757 // functions for loading SP level
3758 // ----------------------------------------------------------------------------
3760 static void CopyNativeLevel_RND_to_SP(struct LevelInfo *level)
3762 struct LevelInfo_SP *level_sp = level->native_sp_level;
3763 LevelInfoType *header = &level_sp->header;
3766 level_sp->width = level->fieldx;
3767 level_sp->height = level->fieldy;
3769 for (x = 0; x < level->fieldx; x++)
3770 for (y = 0; y < level->fieldy; y++)
3771 level_sp->playfield[x][y] = map_element_RND_to_SP(level->field[x][y]);
3773 header->InitialGravity = (level->initial_player_gravity[0] ? 1 : 0);
3775 for (i = 0; i < SP_LEVEL_NAME_LEN; i++)
3776 header->LevelTitle[i] = level->name[i];
3777 // !!! NO STRING TERMINATION IN SUPAPLEX VB CODE YET -- FIX THIS !!!
3779 header->InfotronsNeeded = level->gems_needed;
3781 header->SpecialPortCount = 0;
3783 for (x = 0; x < level->fieldx; x++) for (y = 0; y < level->fieldy; y++)
3785 boolean gravity_port_found = FALSE;
3786 boolean gravity_port_valid = FALSE;
3787 int gravity_port_flag;
3788 int gravity_port_base_element;
3789 int element = level->field[x][y];
3791 if (element >= EL_SP_GRAVITY_ON_PORT_RIGHT &&
3792 element <= EL_SP_GRAVITY_ON_PORT_UP)
3794 gravity_port_found = TRUE;
3795 gravity_port_valid = TRUE;
3796 gravity_port_flag = 1;
3797 gravity_port_base_element = EL_SP_GRAVITY_ON_PORT_RIGHT;
3799 else if (element >= EL_SP_GRAVITY_OFF_PORT_RIGHT &&
3800 element <= EL_SP_GRAVITY_OFF_PORT_UP)
3802 gravity_port_found = TRUE;
3803 gravity_port_valid = TRUE;
3804 gravity_port_flag = 0;
3805 gravity_port_base_element = EL_SP_GRAVITY_OFF_PORT_RIGHT;
3807 else if (element >= EL_SP_GRAVITY_PORT_RIGHT &&
3808 element <= EL_SP_GRAVITY_PORT_UP)
3810 // change R'n'D style gravity inverting special port to normal port
3811 // (there are no gravity inverting ports in native Supaplex engine)
3813 gravity_port_found = TRUE;
3814 gravity_port_valid = FALSE;
3815 gravity_port_base_element = EL_SP_GRAVITY_PORT_RIGHT;
3818 if (gravity_port_found)
3820 if (gravity_port_valid &&
3821 header->SpecialPortCount < SP_MAX_SPECIAL_PORTS)
3823 SpecialPortType *port = &header->SpecialPort[header->SpecialPortCount];
3825 port->PortLocation = (y * level->fieldx + x) * 2;
3826 port->Gravity = gravity_port_flag;
3828 element += EL_SP_GRAVITY_PORT_RIGHT - gravity_port_base_element;
3830 header->SpecialPortCount++;
3834 // change special gravity port to normal port
3836 element += EL_SP_PORT_RIGHT - gravity_port_base_element;
3839 level_sp->playfield[x][y] = element - EL_SP_START;
3844 static void CopyNativeLevel_SP_to_RND(struct LevelInfo *level)
3846 struct LevelInfo_SP *level_sp = level->native_sp_level;
3847 LevelInfoType *header = &level_sp->header;
3848 boolean num_invalid_elements = 0;
3851 level->fieldx = level_sp->width;
3852 level->fieldy = level_sp->height;
3854 for (x = 0; x < level->fieldx; x++)
3856 for (y = 0; y < level->fieldy; y++)
3858 int element_old = level_sp->playfield[x][y];
3859 int element_new = getMappedElement(map_element_SP_to_RND(element_old));
3861 if (element_new == EL_UNKNOWN)
3863 num_invalid_elements++;
3865 Debug("level:native:SP", "invalid element %d at position %d, %d",
3869 level->field[x][y] = element_new;
3873 if (num_invalid_elements > 0)
3874 Warn("found %d invalid elements%s", num_invalid_elements,
3875 (!options.debug ? " (use '--debug' for more details)" : ""));
3877 for (i = 0; i < MAX_PLAYERS; i++)
3878 level->initial_player_gravity[i] =
3879 (header->InitialGravity == 1 ? TRUE : FALSE);
3881 // skip leading spaces
3882 for (i = 0; i < SP_LEVEL_NAME_LEN; i++)
3883 if (header->LevelTitle[i] != ' ')
3887 for (j = 0; i < SP_LEVEL_NAME_LEN; i++, j++)
3888 level->name[j] = header->LevelTitle[i];
3889 level->name[j] = '\0';
3891 // cut trailing spaces
3893 if (level->name[j - 1] == ' ' && level->name[j] == '\0')
3894 level->name[j - 1] = '\0';
3896 level->gems_needed = header->InfotronsNeeded;
3898 for (i = 0; i < header->SpecialPortCount; i++)
3900 SpecialPortType *port = &header->SpecialPort[i];
3901 int port_location = port->PortLocation;
3902 int gravity = port->Gravity;
3903 int port_x, port_y, port_element;
3905 port_x = (port_location / 2) % level->fieldx;
3906 port_y = (port_location / 2) / level->fieldx;
3908 if (port_x < 0 || port_x >= level->fieldx ||
3909 port_y < 0 || port_y >= level->fieldy)
3911 Warn("special port position (%d, %d) out of bounds", port_x, port_y);
3916 port_element = level->field[port_x][port_y];
3918 if (port_element < EL_SP_GRAVITY_PORT_RIGHT ||
3919 port_element > EL_SP_GRAVITY_PORT_UP)
3921 Warn("no special port at position (%d, %d)", port_x, port_y);
3926 // change previous (wrong) gravity inverting special port to either
3927 // gravity enabling special port or gravity disabling special port
3928 level->field[port_x][port_y] +=
3929 (gravity == 1 ? EL_SP_GRAVITY_ON_PORT_RIGHT :
3930 EL_SP_GRAVITY_OFF_PORT_RIGHT) - EL_SP_GRAVITY_PORT_RIGHT;
3933 // change special gravity ports without database entries to normal ports
3934 for (x = 0; x < level->fieldx; x++)
3935 for (y = 0; y < level->fieldy; y++)
3936 if (level->field[x][y] >= EL_SP_GRAVITY_PORT_RIGHT &&
3937 level->field[x][y] <= EL_SP_GRAVITY_PORT_UP)
3938 level->field[x][y] += EL_SP_PORT_RIGHT - EL_SP_GRAVITY_PORT_RIGHT;
3940 level->time = 0; // no time limit
3941 level->amoeba_speed = 0;
3942 level->time_magic_wall = 0;
3943 level->time_wheel = 0;
3944 level->amoeba_content = EL_EMPTY;
3946 // original Supaplex does not use score values -- rate by playing time
3947 for (i = 0; i < LEVEL_SCORE_ELEMENTS; i++)
3948 level->score[i] = 0;
3950 level->rate_time_over_score = TRUE;
3952 // there are no yamyams in supaplex levels
3953 for (i = 0; i < level->num_yamyam_contents; i++)
3954 for (x = 0; x < 3; x++)
3955 for (y = 0; y < 3; y++)
3956 level->yamyam_content[i].e[x][y] = EL_EMPTY;
3959 static void CopyNativeTape_RND_to_SP(struct LevelInfo *level)
3961 struct LevelInfo_SP *level_sp = level->native_sp_level;
3962 struct DemoInfo_SP *demo = &level_sp->demo;
3965 // always start with reliable default values
3966 demo->is_available = FALSE;
3969 if (TAPE_IS_EMPTY(tape))
3972 demo->level_nr = tape.level_nr; // (currently not used)
3974 level_sp->header.DemoRandomSeed = tape.random_seed;
3978 for (i = 0; i < tape.length; i++)
3980 int demo_action = map_key_RND_to_SP(tape.pos[i].action[0]);
3981 int demo_repeat = tape.pos[i].delay;
3982 int demo_entries = (demo_repeat + 15) / 16;
3984 if (demo->length + demo_entries >= SP_MAX_TAPE_LEN)
3986 Warn("tape truncated: size exceeds maximum SP demo size %d",
3992 for (j = 0; j < demo_repeat / 16; j++)
3993 demo->data[demo->length++] = 0xf0 | demo_action;
3995 if (demo_repeat % 16)
3996 demo->data[demo->length++] = ((demo_repeat % 16 - 1) << 4) | demo_action;
3999 demo->is_available = TRUE;
4002 static void setTapeInfoToDefaults(void);
4004 static void CopyNativeTape_SP_to_RND(struct LevelInfo *level)
4006 struct LevelInfo_SP *level_sp = level->native_sp_level;
4007 struct DemoInfo_SP *demo = &level_sp->demo;
4008 char *filename = level->file_info.filename;
4011 // always start with reliable default values
4012 setTapeInfoToDefaults();
4014 if (!demo->is_available)
4017 tape.level_nr = demo->level_nr; // (currently not used)
4018 tape.random_seed = level_sp->header.DemoRandomSeed;
4020 TapeSetDateFromEpochSeconds(getFileTimestampEpochSeconds(filename));
4023 tape.pos[tape.counter].delay = 0;
4025 for (i = 0; i < demo->length; i++)
4027 int demo_action = demo->data[i] & 0x0f;
4028 int demo_repeat = (demo->data[i] & 0xf0) >> 4;
4029 int tape_action = map_key_SP_to_RND(demo_action);
4030 int tape_repeat = demo_repeat + 1;
4031 byte action[MAX_TAPE_ACTIONS] = { tape_action };
4032 boolean success = 0;
4035 for (j = 0; j < tape_repeat; j++)
4036 success = TapeAddAction(action);
4040 Warn("SP demo truncated: size exceeds maximum tape size %d",
4047 TapeHaltRecording();
4051 // ----------------------------------------------------------------------------
4052 // functions for loading MM level
4053 // ----------------------------------------------------------------------------
4055 static void CopyNativeLevel_RND_to_MM(struct LevelInfo *level)
4057 struct LevelInfo_MM *level_mm = level->native_mm_level;
4060 level_mm->fieldx = MIN(level->fieldx, MM_MAX_PLAYFIELD_WIDTH);
4061 level_mm->fieldy = MIN(level->fieldy, MM_MAX_PLAYFIELD_HEIGHT);
4063 level_mm->time = level->time;
4064 level_mm->kettles_needed = level->gems_needed;
4065 level_mm->auto_count_kettles = level->auto_count_gems;
4067 level_mm->laser_red = level->mm_laser_red;
4068 level_mm->laser_green = level->mm_laser_green;
4069 level_mm->laser_blue = level->mm_laser_blue;
4071 strcpy(level_mm->name, level->name);
4072 strcpy(level_mm->author, level->author);
4074 level_mm->score[SC_EMERALD] = level->score[SC_EMERALD];
4075 level_mm->score[SC_PACMAN] = level->score[SC_PACMAN];
4076 level_mm->score[SC_KEY] = level->score[SC_KEY];
4077 level_mm->score[SC_TIME_BONUS] = level->score[SC_TIME_BONUS];
4078 level_mm->score[SC_ELEM_BONUS] = level->score[SC_ELEM_BONUS];
4080 level_mm->amoeba_speed = level->amoeba_speed;
4081 level_mm->time_fuse = level->mm_time_fuse;
4082 level_mm->time_bomb = level->mm_time_bomb;
4083 level_mm->time_ball = level->mm_time_ball;
4084 level_mm->time_block = level->mm_time_block;
4086 for (x = 0; x < level->fieldx; x++)
4087 for (y = 0; y < level->fieldy; y++)
4089 level_mm->field[x][y] = map_element_RND_to_MM(level->field[x][y]);
4092 static void CopyNativeLevel_MM_to_RND(struct LevelInfo *level)
4094 struct LevelInfo_MM *level_mm = level->native_mm_level;
4097 level->fieldx = MIN(level_mm->fieldx, MAX_LEV_FIELDX);
4098 level->fieldy = MIN(level_mm->fieldy, MAX_LEV_FIELDY);
4100 level->time = level_mm->time;
4101 level->gems_needed = level_mm->kettles_needed;
4102 level->auto_count_gems = level_mm->auto_count_kettles;
4104 level->mm_laser_red = level_mm->laser_red;
4105 level->mm_laser_green = level_mm->laser_green;
4106 level->mm_laser_blue = level_mm->laser_blue;
4108 strcpy(level->name, level_mm->name);
4110 // only overwrite author from 'levelinfo.conf' if author defined in level
4111 if (!strEqual(level_mm->author, ANONYMOUS_NAME))
4112 strcpy(level->author, level_mm->author);
4114 level->score[SC_EMERALD] = level_mm->score[SC_EMERALD];
4115 level->score[SC_PACMAN] = level_mm->score[SC_PACMAN];
4116 level->score[SC_KEY] = level_mm->score[SC_KEY];
4117 level->score[SC_TIME_BONUS] = level_mm->score[SC_TIME_BONUS];
4118 level->score[SC_ELEM_BONUS] = level_mm->score[SC_ELEM_BONUS];
4120 level->amoeba_speed = level_mm->amoeba_speed;
4121 level->mm_time_fuse = level_mm->time_fuse;
4122 level->mm_time_bomb = level_mm->time_bomb;
4123 level->mm_time_ball = level_mm->time_ball;
4124 level->mm_time_block = level_mm->time_block;
4126 for (x = 0; x < level->fieldx; x++)
4127 for (y = 0; y < level->fieldy; y++)
4128 level->field[x][y] = map_element_MM_to_RND(level_mm->field[x][y]);
4132 // ----------------------------------------------------------------------------
4133 // functions for loading DC level
4134 // ----------------------------------------------------------------------------
4136 #define DC_LEVEL_HEADER_SIZE 344
4138 static unsigned short getDecodedWord_DC(unsigned short data_encoded,
4141 static int last_data_encoded;
4145 int diff_hi, diff_lo;
4146 int data_hi, data_lo;
4147 unsigned short data_decoded;
4151 last_data_encoded = 0;
4158 diff = data_encoded - last_data_encoded;
4159 diff_hi = diff & ~0xff;
4160 diff_lo = diff & 0xff;
4164 data_hi = diff_hi - (offset1 << 8) + (offset2 & 0xff00);
4165 data_lo = (diff_lo + (data_hi >> 16)) & 0x00ff;
4166 data_hi = data_hi & 0xff00;
4168 data_decoded = data_hi | data_lo;
4170 last_data_encoded = data_encoded;
4172 offset1 = (offset1 + 1) % 31;
4173 offset2 = offset2 & 0xff;
4175 return data_decoded;
4178 static int getMappedElement_DC(int element)
4186 // 0x0117 - 0x036e: (?)
4189 // 0x042d - 0x0684: (?)
4205 element = EL_CRYSTAL;
4208 case 0x0e77: // quicksand (boulder)
4209 element = EL_QUICKSAND_FAST_FULL;
4212 case 0x0e99: // slow quicksand (boulder)
4213 element = EL_QUICKSAND_FULL;
4217 element = EL_EM_EXIT_OPEN;
4221 element = EL_EM_EXIT_CLOSED;
4225 element = EL_EM_STEEL_EXIT_OPEN;
4229 element = EL_EM_STEEL_EXIT_CLOSED;
4232 case 0x0f4f: // dynamite (lit 1)
4233 element = EL_EM_DYNAMITE_ACTIVE;
4236 case 0x0f57: // dynamite (lit 2)
4237 element = EL_EM_DYNAMITE_ACTIVE;
4240 case 0x0f5f: // dynamite (lit 3)
4241 element = EL_EM_DYNAMITE_ACTIVE;
4244 case 0x0f67: // dynamite (lit 4)
4245 element = EL_EM_DYNAMITE_ACTIVE;
4252 element = EL_AMOEBA_WET;
4256 element = EL_AMOEBA_DROP;
4260 element = EL_DC_MAGIC_WALL;
4264 element = EL_SPACESHIP_UP;
4268 element = EL_SPACESHIP_DOWN;
4272 element = EL_SPACESHIP_LEFT;
4276 element = EL_SPACESHIP_RIGHT;
4280 element = EL_BUG_UP;
4284 element = EL_BUG_DOWN;
4288 element = EL_BUG_LEFT;
4292 element = EL_BUG_RIGHT;
4296 element = EL_MOLE_UP;
4300 element = EL_MOLE_DOWN;
4304 element = EL_MOLE_LEFT;
4308 element = EL_MOLE_RIGHT;
4316 element = EL_YAMYAM_UP;
4320 element = EL_SWITCHGATE_OPEN;
4324 element = EL_SWITCHGATE_CLOSED;
4328 element = EL_DC_SWITCHGATE_SWITCH_UP;
4332 element = EL_TIMEGATE_CLOSED;
4335 case 0x144c: // conveyor belt switch (green)
4336 element = EL_CONVEYOR_BELT_3_SWITCH_MIDDLE;
4339 case 0x144f: // conveyor belt switch (red)
4340 element = EL_CONVEYOR_BELT_1_SWITCH_MIDDLE;
4343 case 0x1452: // conveyor belt switch (blue)
4344 element = EL_CONVEYOR_BELT_4_SWITCH_MIDDLE;
4348 element = EL_CONVEYOR_BELT_3_MIDDLE;
4352 element = EL_CONVEYOR_BELT_3_LEFT;
4356 element = EL_CONVEYOR_BELT_3_RIGHT;
4360 element = EL_CONVEYOR_BELT_1_MIDDLE;
4364 element = EL_CONVEYOR_BELT_1_LEFT;
4368 element = EL_CONVEYOR_BELT_1_RIGHT;
4372 element = EL_CONVEYOR_BELT_4_MIDDLE;
4376 element = EL_CONVEYOR_BELT_4_LEFT;
4380 element = EL_CONVEYOR_BELT_4_RIGHT;
4384 element = EL_EXPANDABLE_WALL_HORIZONTAL;
4388 element = EL_EXPANDABLE_WALL_VERTICAL;
4392 element = EL_EXPANDABLE_WALL_ANY;
4395 case 0x14ce: // growing steel wall (left/right)
4396 element = EL_EXPANDABLE_STEELWALL_HORIZONTAL;
4399 case 0x14df: // growing steel wall (up/down)
4400 element = EL_EXPANDABLE_STEELWALL_VERTICAL;
4403 case 0x14e8: // growing steel wall (up/down/left/right)
4404 element = EL_EXPANDABLE_STEELWALL_ANY;
4408 element = EL_SHIELD_DEADLY;
4412 element = EL_EXTRA_TIME;
4420 element = EL_EMPTY_SPACE;
4423 case 0x1578: // quicksand (empty)
4424 element = EL_QUICKSAND_FAST_EMPTY;
4427 case 0x1579: // slow quicksand (empty)
4428 element = EL_QUICKSAND_EMPTY;
4438 element = EL_EM_DYNAMITE;
4441 case 0x15a1: // key (red)
4442 element = EL_EM_KEY_1;
4445 case 0x15a2: // key (yellow)
4446 element = EL_EM_KEY_2;
4449 case 0x15a3: // key (blue)
4450 element = EL_EM_KEY_4;
4453 case 0x15a4: // key (green)
4454 element = EL_EM_KEY_3;
4457 case 0x15a5: // key (white)
4458 element = EL_DC_KEY_WHITE;
4462 element = EL_WALL_SLIPPERY;
4469 case 0x15a8: // wall (not round)
4473 case 0x15a9: // (blue)
4474 element = EL_CHAR_A;
4477 case 0x15aa: // (blue)
4478 element = EL_CHAR_B;
4481 case 0x15ab: // (blue)
4482 element = EL_CHAR_C;
4485 case 0x15ac: // (blue)
4486 element = EL_CHAR_D;
4489 case 0x15ad: // (blue)
4490 element = EL_CHAR_E;
4493 case 0x15ae: // (blue)
4494 element = EL_CHAR_F;
4497 case 0x15af: // (blue)
4498 element = EL_CHAR_G;
4501 case 0x15b0: // (blue)
4502 element = EL_CHAR_H;
4505 case 0x15b1: // (blue)
4506 element = EL_CHAR_I;
4509 case 0x15b2: // (blue)
4510 element = EL_CHAR_J;
4513 case 0x15b3: // (blue)
4514 element = EL_CHAR_K;
4517 case 0x15b4: // (blue)
4518 element = EL_CHAR_L;
4521 case 0x15b5: // (blue)
4522 element = EL_CHAR_M;
4525 case 0x15b6: // (blue)
4526 element = EL_CHAR_N;
4529 case 0x15b7: // (blue)
4530 element = EL_CHAR_O;
4533 case 0x15b8: // (blue)
4534 element = EL_CHAR_P;
4537 case 0x15b9: // (blue)
4538 element = EL_CHAR_Q;
4541 case 0x15ba: // (blue)
4542 element = EL_CHAR_R;
4545 case 0x15bb: // (blue)
4546 element = EL_CHAR_S;
4549 case 0x15bc: // (blue)
4550 element = EL_CHAR_T;
4553 case 0x15bd: // (blue)
4554 element = EL_CHAR_U;
4557 case 0x15be: // (blue)
4558 element = EL_CHAR_V;
4561 case 0x15bf: // (blue)
4562 element = EL_CHAR_W;
4565 case 0x15c0: // (blue)
4566 element = EL_CHAR_X;
4569 case 0x15c1: // (blue)
4570 element = EL_CHAR_Y;
4573 case 0x15c2: // (blue)
4574 element = EL_CHAR_Z;
4577 case 0x15c3: // (blue)
4578 element = EL_CHAR_AUMLAUT;
4581 case 0x15c4: // (blue)
4582 element = EL_CHAR_OUMLAUT;
4585 case 0x15c5: // (blue)
4586 element = EL_CHAR_UUMLAUT;
4589 case 0x15c6: // (blue)
4590 element = EL_CHAR_0;
4593 case 0x15c7: // (blue)
4594 element = EL_CHAR_1;
4597 case 0x15c8: // (blue)
4598 element = EL_CHAR_2;
4601 case 0x15c9: // (blue)
4602 element = EL_CHAR_3;
4605 case 0x15ca: // (blue)
4606 element = EL_CHAR_4;
4609 case 0x15cb: // (blue)
4610 element = EL_CHAR_5;
4613 case 0x15cc: // (blue)
4614 element = EL_CHAR_6;
4617 case 0x15cd: // (blue)
4618 element = EL_CHAR_7;
4621 case 0x15ce: // (blue)
4622 element = EL_CHAR_8;
4625 case 0x15cf: // (blue)
4626 element = EL_CHAR_9;
4629 case 0x15d0: // (blue)
4630 element = EL_CHAR_PERIOD;
4633 case 0x15d1: // (blue)
4634 element = EL_CHAR_EXCLAM;
4637 case 0x15d2: // (blue)
4638 element = EL_CHAR_COLON;
4641 case 0x15d3: // (blue)
4642 element = EL_CHAR_LESS;
4645 case 0x15d4: // (blue)
4646 element = EL_CHAR_GREATER;
4649 case 0x15d5: // (blue)
4650 element = EL_CHAR_QUESTION;
4653 case 0x15d6: // (blue)
4654 element = EL_CHAR_COPYRIGHT;
4657 case 0x15d7: // (blue)
4658 element = EL_CHAR_UP;
4661 case 0x15d8: // (blue)
4662 element = EL_CHAR_DOWN;
4665 case 0x15d9: // (blue)
4666 element = EL_CHAR_BUTTON;
4669 case 0x15da: // (blue)
4670 element = EL_CHAR_PLUS;
4673 case 0x15db: // (blue)
4674 element = EL_CHAR_MINUS;
4677 case 0x15dc: // (blue)
4678 element = EL_CHAR_APOSTROPHE;
4681 case 0x15dd: // (blue)
4682 element = EL_CHAR_PARENLEFT;
4685 case 0x15de: // (blue)
4686 element = EL_CHAR_PARENRIGHT;
4689 case 0x15df: // (green)
4690 element = EL_CHAR_A;
4693 case 0x15e0: // (green)
4694 element = EL_CHAR_B;
4697 case 0x15e1: // (green)
4698 element = EL_CHAR_C;
4701 case 0x15e2: // (green)
4702 element = EL_CHAR_D;
4705 case 0x15e3: // (green)
4706 element = EL_CHAR_E;
4709 case 0x15e4: // (green)
4710 element = EL_CHAR_F;
4713 case 0x15e5: // (green)
4714 element = EL_CHAR_G;
4717 case 0x15e6: // (green)
4718 element = EL_CHAR_H;
4721 case 0x15e7: // (green)
4722 element = EL_CHAR_I;
4725 case 0x15e8: // (green)
4726 element = EL_CHAR_J;
4729 case 0x15e9: // (green)
4730 element = EL_CHAR_K;
4733 case 0x15ea: // (green)
4734 element = EL_CHAR_L;
4737 case 0x15eb: // (green)
4738 element = EL_CHAR_M;
4741 case 0x15ec: // (green)
4742 element = EL_CHAR_N;
4745 case 0x15ed: // (green)
4746 element = EL_CHAR_O;
4749 case 0x15ee: // (green)
4750 element = EL_CHAR_P;
4753 case 0x15ef: // (green)
4754 element = EL_CHAR_Q;
4757 case 0x15f0: // (green)
4758 element = EL_CHAR_R;
4761 case 0x15f1: // (green)
4762 element = EL_CHAR_S;
4765 case 0x15f2: // (green)
4766 element = EL_CHAR_T;
4769 case 0x15f3: // (green)
4770 element = EL_CHAR_U;
4773 case 0x15f4: // (green)
4774 element = EL_CHAR_V;
4777 case 0x15f5: // (green)
4778 element = EL_CHAR_W;
4781 case 0x15f6: // (green)
4782 element = EL_CHAR_X;
4785 case 0x15f7: // (green)
4786 element = EL_CHAR_Y;
4789 case 0x15f8: // (green)
4790 element = EL_CHAR_Z;
4793 case 0x15f9: // (green)
4794 element = EL_CHAR_AUMLAUT;
4797 case 0x15fa: // (green)
4798 element = EL_CHAR_OUMLAUT;
4801 case 0x15fb: // (green)
4802 element = EL_CHAR_UUMLAUT;
4805 case 0x15fc: // (green)
4806 element = EL_CHAR_0;
4809 case 0x15fd: // (green)
4810 element = EL_CHAR_1;
4813 case 0x15fe: // (green)
4814 element = EL_CHAR_2;
4817 case 0x15ff: // (green)
4818 element = EL_CHAR_3;
4821 case 0x1600: // (green)
4822 element = EL_CHAR_4;
4825 case 0x1601: // (green)
4826 element = EL_CHAR_5;
4829 case 0x1602: // (green)
4830 element = EL_CHAR_6;
4833 case 0x1603: // (green)
4834 element = EL_CHAR_7;
4837 case 0x1604: // (green)
4838 element = EL_CHAR_8;
4841 case 0x1605: // (green)
4842 element = EL_CHAR_9;
4845 case 0x1606: // (green)
4846 element = EL_CHAR_PERIOD;
4849 case 0x1607: // (green)
4850 element = EL_CHAR_EXCLAM;
4853 case 0x1608: // (green)
4854 element = EL_CHAR_COLON;
4857 case 0x1609: // (green)
4858 element = EL_CHAR_LESS;
4861 case 0x160a: // (green)
4862 element = EL_CHAR_GREATER;
4865 case 0x160b: // (green)
4866 element = EL_CHAR_QUESTION;
4869 case 0x160c: // (green)
4870 element = EL_CHAR_COPYRIGHT;
4873 case 0x160d: // (green)
4874 element = EL_CHAR_UP;
4877 case 0x160e: // (green)
4878 element = EL_CHAR_DOWN;
4881 case 0x160f: // (green)
4882 element = EL_CHAR_BUTTON;
4885 case 0x1610: // (green)
4886 element = EL_CHAR_PLUS;
4889 case 0x1611: // (green)
4890 element = EL_CHAR_MINUS;
4893 case 0x1612: // (green)
4894 element = EL_CHAR_APOSTROPHE;
4897 case 0x1613: // (green)
4898 element = EL_CHAR_PARENLEFT;
4901 case 0x1614: // (green)
4902 element = EL_CHAR_PARENRIGHT;
4905 case 0x1615: // (blue steel)
4906 element = EL_STEEL_CHAR_A;
4909 case 0x1616: // (blue steel)
4910 element = EL_STEEL_CHAR_B;
4913 case 0x1617: // (blue steel)
4914 element = EL_STEEL_CHAR_C;
4917 case 0x1618: // (blue steel)
4918 element = EL_STEEL_CHAR_D;
4921 case 0x1619: // (blue steel)
4922 element = EL_STEEL_CHAR_E;
4925 case 0x161a: // (blue steel)
4926 element = EL_STEEL_CHAR_F;
4929 case 0x161b: // (blue steel)
4930 element = EL_STEEL_CHAR_G;
4933 case 0x161c: // (blue steel)
4934 element = EL_STEEL_CHAR_H;
4937 case 0x161d: // (blue steel)
4938 element = EL_STEEL_CHAR_I;
4941 case 0x161e: // (blue steel)
4942 element = EL_STEEL_CHAR_J;
4945 case 0x161f: // (blue steel)
4946 element = EL_STEEL_CHAR_K;
4949 case 0x1620: // (blue steel)
4950 element = EL_STEEL_CHAR_L;
4953 case 0x1621: // (blue steel)
4954 element = EL_STEEL_CHAR_M;
4957 case 0x1622: // (blue steel)
4958 element = EL_STEEL_CHAR_N;
4961 case 0x1623: // (blue steel)
4962 element = EL_STEEL_CHAR_O;
4965 case 0x1624: // (blue steel)
4966 element = EL_STEEL_CHAR_P;
4969 case 0x1625: // (blue steel)
4970 element = EL_STEEL_CHAR_Q;
4973 case 0x1626: // (blue steel)
4974 element = EL_STEEL_CHAR_R;
4977 case 0x1627: // (blue steel)
4978 element = EL_STEEL_CHAR_S;
4981 case 0x1628: // (blue steel)
4982 element = EL_STEEL_CHAR_T;
4985 case 0x1629: // (blue steel)
4986 element = EL_STEEL_CHAR_U;
4989 case 0x162a: // (blue steel)
4990 element = EL_STEEL_CHAR_V;
4993 case 0x162b: // (blue steel)
4994 element = EL_STEEL_CHAR_W;
4997 case 0x162c: // (blue steel)
4998 element = EL_STEEL_CHAR_X;
5001 case 0x162d: // (blue steel)
5002 element = EL_STEEL_CHAR_Y;
5005 case 0x162e: // (blue steel)
5006 element = EL_STEEL_CHAR_Z;
5009 case 0x162f: // (blue steel)
5010 element = EL_STEEL_CHAR_AUMLAUT;
5013 case 0x1630: // (blue steel)
5014 element = EL_STEEL_CHAR_OUMLAUT;
5017 case 0x1631: // (blue steel)
5018 element = EL_STEEL_CHAR_UUMLAUT;
5021 case 0x1632: // (blue steel)
5022 element = EL_STEEL_CHAR_0;
5025 case 0x1633: // (blue steel)
5026 element = EL_STEEL_CHAR_1;
5029 case 0x1634: // (blue steel)
5030 element = EL_STEEL_CHAR_2;
5033 case 0x1635: // (blue steel)
5034 element = EL_STEEL_CHAR_3;
5037 case 0x1636: // (blue steel)
5038 element = EL_STEEL_CHAR_4;
5041 case 0x1637: // (blue steel)
5042 element = EL_STEEL_CHAR_5;
5045 case 0x1638: // (blue steel)
5046 element = EL_STEEL_CHAR_6;
5049 case 0x1639: // (blue steel)
5050 element = EL_STEEL_CHAR_7;
5053 case 0x163a: // (blue steel)
5054 element = EL_STEEL_CHAR_8;
5057 case 0x163b: // (blue steel)
5058 element = EL_STEEL_CHAR_9;
5061 case 0x163c: // (blue steel)
5062 element = EL_STEEL_CHAR_PERIOD;
5065 case 0x163d: // (blue steel)
5066 element = EL_STEEL_CHAR_EXCLAM;
5069 case 0x163e: // (blue steel)
5070 element = EL_STEEL_CHAR_COLON;
5073 case 0x163f: // (blue steel)
5074 element = EL_STEEL_CHAR_LESS;
5077 case 0x1640: // (blue steel)
5078 element = EL_STEEL_CHAR_GREATER;
5081 case 0x1641: // (blue steel)
5082 element = EL_STEEL_CHAR_QUESTION;
5085 case 0x1642: // (blue steel)
5086 element = EL_STEEL_CHAR_COPYRIGHT;
5089 case 0x1643: // (blue steel)
5090 element = EL_STEEL_CHAR_UP;
5093 case 0x1644: // (blue steel)
5094 element = EL_STEEL_CHAR_DOWN;
5097 case 0x1645: // (blue steel)
5098 element = EL_STEEL_CHAR_BUTTON;
5101 case 0x1646: // (blue steel)
5102 element = EL_STEEL_CHAR_PLUS;
5105 case 0x1647: // (blue steel)
5106 element = EL_STEEL_CHAR_MINUS;
5109 case 0x1648: // (blue steel)
5110 element = EL_STEEL_CHAR_APOSTROPHE;
5113 case 0x1649: // (blue steel)
5114 element = EL_STEEL_CHAR_PARENLEFT;
5117 case 0x164a: // (blue steel)
5118 element = EL_STEEL_CHAR_PARENRIGHT;
5121 case 0x164b: // (green steel)
5122 element = EL_STEEL_CHAR_A;
5125 case 0x164c: // (green steel)
5126 element = EL_STEEL_CHAR_B;
5129 case 0x164d: // (green steel)
5130 element = EL_STEEL_CHAR_C;
5133 case 0x164e: // (green steel)
5134 element = EL_STEEL_CHAR_D;
5137 case 0x164f: // (green steel)
5138 element = EL_STEEL_CHAR_E;
5141 case 0x1650: // (green steel)
5142 element = EL_STEEL_CHAR_F;
5145 case 0x1651: // (green steel)
5146 element = EL_STEEL_CHAR_G;
5149 case 0x1652: // (green steel)
5150 element = EL_STEEL_CHAR_H;
5153 case 0x1653: // (green steel)
5154 element = EL_STEEL_CHAR_I;
5157 case 0x1654: // (green steel)
5158 element = EL_STEEL_CHAR_J;
5161 case 0x1655: // (green steel)
5162 element = EL_STEEL_CHAR_K;
5165 case 0x1656: // (green steel)
5166 element = EL_STEEL_CHAR_L;
5169 case 0x1657: // (green steel)
5170 element = EL_STEEL_CHAR_M;
5173 case 0x1658: // (green steel)
5174 element = EL_STEEL_CHAR_N;
5177 case 0x1659: // (green steel)
5178 element = EL_STEEL_CHAR_O;
5181 case 0x165a: // (green steel)
5182 element = EL_STEEL_CHAR_P;
5185 case 0x165b: // (green steel)
5186 element = EL_STEEL_CHAR_Q;
5189 case 0x165c: // (green steel)
5190 element = EL_STEEL_CHAR_R;
5193 case 0x165d: // (green steel)
5194 element = EL_STEEL_CHAR_S;
5197 case 0x165e: // (green steel)
5198 element = EL_STEEL_CHAR_T;
5201 case 0x165f: // (green steel)
5202 element = EL_STEEL_CHAR_U;
5205 case 0x1660: // (green steel)
5206 element = EL_STEEL_CHAR_V;
5209 case 0x1661: // (green steel)
5210 element = EL_STEEL_CHAR_W;
5213 case 0x1662: // (green steel)
5214 element = EL_STEEL_CHAR_X;
5217 case 0x1663: // (green steel)
5218 element = EL_STEEL_CHAR_Y;
5221 case 0x1664: // (green steel)
5222 element = EL_STEEL_CHAR_Z;
5225 case 0x1665: // (green steel)
5226 element = EL_STEEL_CHAR_AUMLAUT;
5229 case 0x1666: // (green steel)
5230 element = EL_STEEL_CHAR_OUMLAUT;
5233 case 0x1667: // (green steel)
5234 element = EL_STEEL_CHAR_UUMLAUT;
5237 case 0x1668: // (green steel)
5238 element = EL_STEEL_CHAR_0;
5241 case 0x1669: // (green steel)
5242 element = EL_STEEL_CHAR_1;
5245 case 0x166a: // (green steel)
5246 element = EL_STEEL_CHAR_2;
5249 case 0x166b: // (green steel)
5250 element = EL_STEEL_CHAR_3;
5253 case 0x166c: // (green steel)
5254 element = EL_STEEL_CHAR_4;
5257 case 0x166d: // (green steel)
5258 element = EL_STEEL_CHAR_5;
5261 case 0x166e: // (green steel)
5262 element = EL_STEEL_CHAR_6;
5265 case 0x166f: // (green steel)
5266 element = EL_STEEL_CHAR_7;
5269 case 0x1670: // (green steel)
5270 element = EL_STEEL_CHAR_8;
5273 case 0x1671: // (green steel)
5274 element = EL_STEEL_CHAR_9;
5277 case 0x1672: // (green steel)
5278 element = EL_STEEL_CHAR_PERIOD;
5281 case 0x1673: // (green steel)
5282 element = EL_STEEL_CHAR_EXCLAM;
5285 case 0x1674: // (green steel)
5286 element = EL_STEEL_CHAR_COLON;
5289 case 0x1675: // (green steel)
5290 element = EL_STEEL_CHAR_LESS;
5293 case 0x1676: // (green steel)
5294 element = EL_STEEL_CHAR_GREATER;
5297 case 0x1677: // (green steel)
5298 element = EL_STEEL_CHAR_QUESTION;
5301 case 0x1678: // (green steel)
5302 element = EL_STEEL_CHAR_COPYRIGHT;
5305 case 0x1679: // (green steel)
5306 element = EL_STEEL_CHAR_UP;
5309 case 0x167a: // (green steel)
5310 element = EL_STEEL_CHAR_DOWN;
5313 case 0x167b: // (green steel)
5314 element = EL_STEEL_CHAR_BUTTON;
5317 case 0x167c: // (green steel)
5318 element = EL_STEEL_CHAR_PLUS;
5321 case 0x167d: // (green steel)
5322 element = EL_STEEL_CHAR_MINUS;
5325 case 0x167e: // (green steel)
5326 element = EL_STEEL_CHAR_APOSTROPHE;
5329 case 0x167f: // (green steel)
5330 element = EL_STEEL_CHAR_PARENLEFT;
5333 case 0x1680: // (green steel)
5334 element = EL_STEEL_CHAR_PARENRIGHT;
5337 case 0x1681: // gate (red)
5338 element = EL_EM_GATE_1;
5341 case 0x1682: // secret gate (red)
5342 element = EL_EM_GATE_1_GRAY;
5345 case 0x1683: // gate (yellow)
5346 element = EL_EM_GATE_2;
5349 case 0x1684: // secret gate (yellow)
5350 element = EL_EM_GATE_2_GRAY;
5353 case 0x1685: // gate (blue)
5354 element = EL_EM_GATE_4;
5357 case 0x1686: // secret gate (blue)
5358 element = EL_EM_GATE_4_GRAY;
5361 case 0x1687: // gate (green)
5362 element = EL_EM_GATE_3;
5365 case 0x1688: // secret gate (green)
5366 element = EL_EM_GATE_3_GRAY;
5369 case 0x1689: // gate (white)
5370 element = EL_DC_GATE_WHITE;
5373 case 0x168a: // secret gate (white)
5374 element = EL_DC_GATE_WHITE_GRAY;
5377 case 0x168b: // secret gate (no key)
5378 element = EL_DC_GATE_FAKE_GRAY;
5382 element = EL_ROBOT_WHEEL;
5386 element = EL_DC_TIMEGATE_SWITCH;
5390 element = EL_ACID_POOL_BOTTOM;
5394 element = EL_ACID_POOL_TOPLEFT;
5398 element = EL_ACID_POOL_TOPRIGHT;
5402 element = EL_ACID_POOL_BOTTOMLEFT;
5406 element = EL_ACID_POOL_BOTTOMRIGHT;
5410 element = EL_STEELWALL;
5414 element = EL_STEELWALL_SLIPPERY;
5417 case 0x1695: // steel wall (not round)
5418 element = EL_STEELWALL;
5421 case 0x1696: // steel wall (left)
5422 element = EL_DC_STEELWALL_1_LEFT;
5425 case 0x1697: // steel wall (bottom)
5426 element = EL_DC_STEELWALL_1_BOTTOM;
5429 case 0x1698: // steel wall (right)
5430 element = EL_DC_STEELWALL_1_RIGHT;
5433 case 0x1699: // steel wall (top)
5434 element = EL_DC_STEELWALL_1_TOP;
5437 case 0x169a: // steel wall (left/bottom)
5438 element = EL_DC_STEELWALL_1_BOTTOMLEFT;
5441 case 0x169b: // steel wall (right/bottom)
5442 element = EL_DC_STEELWALL_1_BOTTOMRIGHT;
5445 case 0x169c: // steel wall (right/top)
5446 element = EL_DC_STEELWALL_1_TOPRIGHT;
5449 case 0x169d: // steel wall (left/top)
5450 element = EL_DC_STEELWALL_1_TOPLEFT;
5453 case 0x169e: // steel wall (right/bottom small)
5454 element = EL_DC_STEELWALL_1_BOTTOMRIGHT_2;
5457 case 0x169f: // steel wall (left/bottom small)
5458 element = EL_DC_STEELWALL_1_BOTTOMLEFT_2;
5461 case 0x16a0: // steel wall (right/top small)
5462 element = EL_DC_STEELWALL_1_TOPRIGHT_2;
5465 case 0x16a1: // steel wall (left/top small)
5466 element = EL_DC_STEELWALL_1_TOPLEFT_2;
5469 case 0x16a2: // steel wall (left/right)
5470 element = EL_DC_STEELWALL_1_VERTICAL;
5473 case 0x16a3: // steel wall (top/bottom)
5474 element = EL_DC_STEELWALL_1_HORIZONTAL;
5477 case 0x16a4: // steel wall 2 (left end)
5478 element = EL_DC_STEELWALL_2_LEFT;
5481 case 0x16a5: // steel wall 2 (right end)
5482 element = EL_DC_STEELWALL_2_RIGHT;
5485 case 0x16a6: // steel wall 2 (top end)
5486 element = EL_DC_STEELWALL_2_TOP;
5489 case 0x16a7: // steel wall 2 (bottom end)
5490 element = EL_DC_STEELWALL_2_BOTTOM;
5493 case 0x16a8: // steel wall 2 (left/right)
5494 element = EL_DC_STEELWALL_2_HORIZONTAL;
5497 case 0x16a9: // steel wall 2 (up/down)
5498 element = EL_DC_STEELWALL_2_VERTICAL;
5501 case 0x16aa: // steel wall 2 (mid)
5502 element = EL_DC_STEELWALL_2_MIDDLE;
5506 element = EL_SIGN_EXCLAMATION;
5510 element = EL_SIGN_RADIOACTIVITY;
5514 element = EL_SIGN_STOP;
5518 element = EL_SIGN_WHEELCHAIR;
5522 element = EL_SIGN_PARKING;
5526 element = EL_SIGN_NO_ENTRY;
5530 element = EL_SIGN_HEART;
5534 element = EL_SIGN_GIVE_WAY;
5538 element = EL_SIGN_ENTRY_FORBIDDEN;
5542 element = EL_SIGN_EMERGENCY_EXIT;
5546 element = EL_SIGN_YIN_YANG;
5550 element = EL_WALL_EMERALD;
5554 element = EL_WALL_DIAMOND;
5558 element = EL_WALL_PEARL;
5562 element = EL_WALL_CRYSTAL;
5566 element = EL_INVISIBLE_WALL;
5570 element = EL_INVISIBLE_STEELWALL;
5574 // EL_INVISIBLE_SAND
5577 element = EL_LIGHT_SWITCH;
5581 element = EL_ENVELOPE_1;
5585 if (element >= 0x0117 && element <= 0x036e) // (?)
5586 element = EL_DIAMOND;
5587 else if (element >= 0x042d && element <= 0x0684) // (?)
5588 element = EL_EMERALD;
5589 else if (element >= 0x157c && element <= 0x158b)
5591 else if (element >= 0x1590 && element <= 0x159f)
5592 element = EL_DC_LANDMINE;
5593 else if (element >= 0x16bc && element <= 0x16cb)
5594 element = EL_INVISIBLE_SAND;
5597 Warn("unknown Diamond Caves element 0x%04x", element);
5599 element = EL_UNKNOWN;
5604 return getMappedElement(element);
5607 static void LoadLevelFromFileStream_DC(File *file, struct LevelInfo *level,
5610 byte header[DC_LEVEL_HEADER_SIZE];
5612 int envelope_header_pos = 62;
5613 int envelope_content_pos = 94;
5614 int level_name_pos = 251;
5615 int level_author_pos = 292;
5616 int envelope_header_len;
5617 int envelope_content_len;
5619 int level_author_len;
5621 int num_yamyam_contents;
5624 getDecodedWord_DC(0, TRUE); // initialize DC2 decoding engine
5626 for (i = 0; i < DC_LEVEL_HEADER_SIZE / 2; i++)
5628 unsigned short header_word = getDecodedWord_DC(getFile16BitBE(file), FALSE);
5630 header[i * 2 + 0] = header_word >> 8;
5631 header[i * 2 + 1] = header_word & 0xff;
5634 // read some values from level header to check level decoding integrity
5635 fieldx = header[6] | (header[7] << 8);
5636 fieldy = header[8] | (header[9] << 8);
5637 num_yamyam_contents = header[60] | (header[61] << 8);
5639 // do some simple sanity checks to ensure that level was correctly decoded
5640 if (fieldx < 1 || fieldx > 256 ||
5641 fieldy < 1 || fieldy > 256 ||
5642 num_yamyam_contents < 1 || num_yamyam_contents > 8)
5644 level->no_valid_file = TRUE;
5646 Warn("cannot decode level from stream -- using empty level");
5651 // maximum envelope header size is 31 bytes
5652 envelope_header_len = header[envelope_header_pos];
5653 // maximum envelope content size is 110 (156?) bytes
5654 envelope_content_len = header[envelope_content_pos];
5656 // maximum level title size is 40 bytes
5657 level_name_len = MIN(header[level_name_pos], MAX_LEVEL_NAME_LEN);
5658 // maximum level author size is 30 (51?) bytes
5659 level_author_len = MIN(header[level_author_pos], MAX_LEVEL_AUTHOR_LEN);
5663 for (i = 0; i < envelope_header_len; i++)
5664 if (envelope_size < MAX_ENVELOPE_TEXT_LEN)
5665 level->envelope[0].text[envelope_size++] =
5666 header[envelope_header_pos + 1 + i];
5668 if (envelope_header_len > 0 && envelope_content_len > 0)
5670 if (envelope_size < MAX_ENVELOPE_TEXT_LEN)
5671 level->envelope[0].text[envelope_size++] = '\n';
5672 if (envelope_size < MAX_ENVELOPE_TEXT_LEN)
5673 level->envelope[0].text[envelope_size++] = '\n';
5676 for (i = 0; i < envelope_content_len; i++)
5677 if (envelope_size < MAX_ENVELOPE_TEXT_LEN)
5678 level->envelope[0].text[envelope_size++] =
5679 header[envelope_content_pos + 1 + i];
5681 level->envelope[0].text[envelope_size] = '\0';
5683 level->envelope[0].xsize = MAX_ENVELOPE_XSIZE;
5684 level->envelope[0].ysize = 10;
5685 level->envelope[0].autowrap = TRUE;
5686 level->envelope[0].centered = TRUE;
5688 for (i = 0; i < level_name_len; i++)
5689 level->name[i] = header[level_name_pos + 1 + i];
5690 level->name[level_name_len] = '\0';
5692 for (i = 0; i < level_author_len; i++)
5693 level->author[i] = header[level_author_pos + 1 + i];
5694 level->author[level_author_len] = '\0';
5696 num_yamyam_contents = header[60] | (header[61] << 8);
5697 level->num_yamyam_contents =
5698 MIN(MAX(MIN_ELEMENT_CONTENTS, num_yamyam_contents), MAX_ELEMENT_CONTENTS);
5700 for (i = 0; i < num_yamyam_contents; i++)
5702 for (y = 0; y < 3; y++) for (x = 0; x < 3; x++)
5704 unsigned short word = getDecodedWord_DC(getFile16BitBE(file), FALSE);
5705 int element_dc = ((word & 0xff) << 8) | ((word >> 8) & 0xff);
5707 if (i < MAX_ELEMENT_CONTENTS)
5708 level->yamyam_content[i].e[x][y] = getMappedElement_DC(element_dc);
5712 fieldx = header[6] | (header[7] << 8);
5713 fieldy = header[8] | (header[9] << 8);
5714 level->fieldx = MIN(MAX(MIN_LEV_FIELDX, fieldx), MAX_LEV_FIELDX);
5715 level->fieldy = MIN(MAX(MIN_LEV_FIELDY, fieldy), MAX_LEV_FIELDY);
5717 for (y = 0; y < fieldy; y++) for (x = 0; x < fieldx; x++)
5719 unsigned short word = getDecodedWord_DC(getFile16BitBE(file), FALSE);
5720 int element_dc = ((word & 0xff) << 8) | ((word >> 8) & 0xff);
5722 if (x < MAX_LEV_FIELDX && y < MAX_LEV_FIELDY)
5723 level->field[x][y] = getMappedElement_DC(element_dc);
5726 x = MIN(MAX(0, (header[10] | (header[11] << 8)) - 1), MAX_LEV_FIELDX - 1);
5727 y = MIN(MAX(0, (header[12] | (header[13] << 8)) - 1), MAX_LEV_FIELDY - 1);
5728 level->field[x][y] = EL_PLAYER_1;
5730 x = MIN(MAX(0, (header[14] | (header[15] << 8)) - 1), MAX_LEV_FIELDX - 1);
5731 y = MIN(MAX(0, (header[16] | (header[17] << 8)) - 1), MAX_LEV_FIELDY - 1);
5732 level->field[x][y] = EL_PLAYER_2;
5734 level->gems_needed = header[18] | (header[19] << 8);
5736 level->score[SC_EMERALD] = header[20] | (header[21] << 8);
5737 level->score[SC_DIAMOND] = header[22] | (header[23] << 8);
5738 level->score[SC_PEARL] = header[24] | (header[25] << 8);
5739 level->score[SC_CRYSTAL] = header[26] | (header[27] << 8);
5740 level->score[SC_NUT] = header[28] | (header[29] << 8);
5741 level->score[SC_ROBOT] = header[30] | (header[31] << 8);
5742 level->score[SC_SPACESHIP] = header[32] | (header[33] << 8);
5743 level->score[SC_BUG] = header[34] | (header[35] << 8);
5744 level->score[SC_YAMYAM] = header[36] | (header[37] << 8);
5745 level->score[SC_DYNAMITE] = header[38] | (header[39] << 8);
5746 level->score[SC_KEY] = header[40] | (header[41] << 8);
5747 level->score[SC_TIME_BONUS] = header[42] | (header[43] << 8);
5749 level->time = header[44] | (header[45] << 8);
5751 level->amoeba_speed = header[46] | (header[47] << 8);
5752 level->time_light = header[48] | (header[49] << 8);
5753 level->time_timegate = header[50] | (header[51] << 8);
5754 level->time_wheel = header[52] | (header[53] << 8);
5755 level->time_magic_wall = header[54] | (header[55] << 8);
5756 level->extra_time = header[56] | (header[57] << 8);
5757 level->shield_normal_time = header[58] | (header[59] << 8);
5759 // shield and extra time elements do not have a score
5760 level->score[SC_SHIELD] = 0;
5761 level->extra_time_score = 0;
5763 // set time for normal and deadly shields to the same value
5764 level->shield_deadly_time = level->shield_normal_time;
5766 // Diamond Caves has the same (strange) behaviour as Emerald Mine that gems
5767 // can slip down from flat walls, like normal walls and steel walls
5768 level->em_slippery_gems = TRUE;
5770 // time score is counted for each 10 seconds left in Diamond Caves levels
5771 level->time_score_base = 10;
5774 static void LoadLevelFromFileInfo_DC(struct LevelInfo *level,
5775 struct LevelFileInfo *level_file_info,
5776 boolean level_info_only)
5778 char *filename = level_file_info->filename;
5780 int num_magic_bytes = 8;
5781 char magic_bytes[num_magic_bytes + 1];
5782 int num_levels_to_skip = level_file_info->nr - leveldir_current->first_level;
5784 if (!(file = openFile(filename, MODE_READ)))
5786 level->no_valid_file = TRUE;
5788 if (!level_info_only)
5789 Warn("cannot read level '%s' -- using empty level", filename);
5794 // fseek(file, 0x0000, SEEK_SET);
5796 if (level_file_info->packed)
5798 // read "magic bytes" from start of file
5799 if (getStringFromFile(file, magic_bytes, num_magic_bytes + 1) == NULL)
5800 magic_bytes[0] = '\0';
5802 // check "magic bytes" for correct file format
5803 if (!strPrefix(magic_bytes, "DC2"))
5805 level->no_valid_file = TRUE;
5807 Warn("unknown DC level file '%s' -- using empty level", filename);
5812 if (strPrefix(magic_bytes, "DC2Win95") ||
5813 strPrefix(magic_bytes, "DC2Win98"))
5815 int position_first_level = 0x00fa;
5816 int extra_bytes = 4;
5819 // advance file stream to first level inside the level package
5820 skip_bytes = position_first_level - num_magic_bytes - extra_bytes;
5822 // each block of level data is followed by block of non-level data
5823 num_levels_to_skip *= 2;
5825 // at least skip header bytes, therefore use ">= 0" instead of "> 0"
5826 while (num_levels_to_skip >= 0)
5828 // advance file stream to next level inside the level package
5829 if (seekFile(file, skip_bytes, SEEK_CUR) != 0)
5831 level->no_valid_file = TRUE;
5833 Warn("cannot fseek in file '%s' -- using empty level", filename);
5838 // skip apparently unused extra bytes following each level
5839 ReadUnusedBytesFromFile(file, extra_bytes);
5841 // read size of next level in level package
5842 skip_bytes = getFile32BitLE(file);
5844 num_levels_to_skip--;
5849 level->no_valid_file = TRUE;
5851 Warn("unknown DC2 level file '%s' -- using empty level", filename);
5857 LoadLevelFromFileStream_DC(file, level, level_file_info->nr);
5863 // ----------------------------------------------------------------------------
5864 // functions for loading SB level
5865 // ----------------------------------------------------------------------------
5867 int getMappedElement_SB(int element_ascii, boolean use_ces)
5875 sb_element_mapping[] =
5877 { ' ', EL_EMPTY, EL_CUSTOM_1 }, // floor (space)
5878 { '#', EL_STEELWALL, EL_CUSTOM_2 }, // wall
5879 { '@', EL_PLAYER_1, EL_CUSTOM_3 }, // player
5880 { '$', EL_SOKOBAN_OBJECT, EL_CUSTOM_4 }, // box
5881 { '.', EL_SOKOBAN_FIELD_EMPTY, EL_CUSTOM_5 }, // goal square
5882 { '*', EL_SOKOBAN_FIELD_FULL, EL_CUSTOM_6 }, // box on goal square
5883 { '+', EL_SOKOBAN_FIELD_PLAYER, EL_CUSTOM_7 }, // player on goal square
5884 { '_', EL_INVISIBLE_STEELWALL, EL_FROM_LEVEL_TEMPLATE }, // floor beyond border
5891 for (i = 0; sb_element_mapping[i].ascii != 0; i++)
5892 if (element_ascii == sb_element_mapping[i].ascii)
5893 return (use_ces ? sb_element_mapping[i].ce : sb_element_mapping[i].sb);
5895 return EL_UNDEFINED;
5898 static void SetLevelSettings_SB(struct LevelInfo *level)
5902 level->use_step_counter = TRUE;
5905 level->score[SC_TIME_BONUS] = 0;
5906 level->time_score_base = 1;
5907 level->rate_time_over_score = TRUE;
5910 level->auto_exit_sokoban = TRUE;
5913 static void LoadLevelFromFileInfo_SB(struct LevelInfo *level,
5914 struct LevelFileInfo *level_file_info,
5915 boolean level_info_only)
5917 char *filename = level_file_info->filename;
5918 char line[MAX_LINE_LEN], line_raw[MAX_LINE_LEN], previous_line[MAX_LINE_LEN];
5919 char last_comment[MAX_LINE_LEN];
5920 char level_name[MAX_LINE_LEN];
5923 int num_levels_to_skip = level_file_info->nr - leveldir_current->first_level;
5924 boolean read_continued_line = FALSE;
5925 boolean reading_playfield = FALSE;
5926 boolean got_valid_playfield_line = FALSE;
5927 boolean invalid_playfield_char = FALSE;
5928 boolean load_xsb_to_ces = check_special_flags("load_xsb_to_ces");
5929 int file_level_nr = 0;
5931 int x = 0, y = 0; // initialized to make compilers happy
5933 last_comment[0] = '\0';
5934 level_name[0] = '\0';
5936 if (!(file = openFile(filename, MODE_READ)))
5938 level->no_valid_file = TRUE;
5940 if (!level_info_only)
5941 Warn("cannot read level '%s' -- using empty level", filename);
5946 while (!checkEndOfFile(file))
5948 // level successfully read, but next level may follow here
5949 if (!got_valid_playfield_line && reading_playfield)
5951 // read playfield from single level file -- skip remaining file
5952 if (!level_file_info->packed)
5955 if (file_level_nr >= num_levels_to_skip)
5960 last_comment[0] = '\0';
5961 level_name[0] = '\0';
5963 reading_playfield = FALSE;
5966 got_valid_playfield_line = FALSE;
5968 // read next line of input file
5969 if (!getStringFromFile(file, line, MAX_LINE_LEN))
5972 // check if line was completely read and is terminated by line break
5973 if (strlen(line) > 0 && line[strlen(line) - 1] == '\n')
5976 // cut trailing line break (this can be newline and/or carriage return)
5977 for (line_ptr = &line[strlen(line)]; line_ptr >= line; line_ptr--)
5978 if ((*line_ptr == '\n' || *line_ptr == '\r') && *(line_ptr + 1) == '\0')
5981 // copy raw input line for later use (mainly debugging output)
5982 strcpy(line_raw, line);
5984 if (read_continued_line)
5986 // append new line to existing line, if there is enough space
5987 if (strlen(previous_line) + strlen(line_ptr) < MAX_LINE_LEN)
5988 strcat(previous_line, line_ptr);
5990 strcpy(line, previous_line); // copy storage buffer to line
5992 read_continued_line = FALSE;
5995 // if the last character is '\', continue at next line
5996 if (strlen(line) > 0 && line[strlen(line) - 1] == '\\')
5998 line[strlen(line) - 1] = '\0'; // cut off trailing backslash
5999 strcpy(previous_line, line); // copy line to storage buffer
6001 read_continued_line = TRUE;
6007 if (line[0] == '\0')
6010 // extract comment text from comment line
6013 for (line_ptr = line; *line_ptr; line_ptr++)
6014 if (*line_ptr != ' ' && *line_ptr != '\t' && *line_ptr != ';')
6017 strcpy(last_comment, line_ptr);
6022 // extract level title text from line containing level title
6023 if (line[0] == '\'')
6025 strcpy(level_name, &line[1]);
6027 if (strlen(level_name) > 0 && level_name[strlen(level_name) - 1] == '\'')
6028 level_name[strlen(level_name) - 1] = '\0';
6033 // skip lines containing only spaces (or empty lines)
6034 for (line_ptr = line; *line_ptr; line_ptr++)
6035 if (*line_ptr != ' ')
6037 if (*line_ptr == '\0')
6040 // at this point, we have found a line containing part of a playfield
6042 got_valid_playfield_line = TRUE;
6044 if (!reading_playfield)
6046 reading_playfield = TRUE;
6047 invalid_playfield_char = FALSE;
6049 for (x = 0; x < MAX_LEV_FIELDX; x++)
6050 for (y = 0; y < MAX_LEV_FIELDY; y++)
6051 level->field[x][y] = getMappedElement_SB(' ', load_xsb_to_ces);
6056 // start with topmost tile row
6060 // skip playfield line if larger row than allowed
6061 if (y >= MAX_LEV_FIELDY)
6064 // start with leftmost tile column
6067 // read playfield elements from line
6068 for (line_ptr = line; *line_ptr; line_ptr++)
6070 int mapped_sb_element = getMappedElement_SB(*line_ptr, load_xsb_to_ces);
6072 // stop parsing playfield line if larger column than allowed
6073 if (x >= MAX_LEV_FIELDX)
6076 if (mapped_sb_element == EL_UNDEFINED)
6078 invalid_playfield_char = TRUE;
6083 level->field[x][y] = mapped_sb_element;
6085 // continue with next tile column
6088 level->fieldx = MAX(x, level->fieldx);
6091 if (invalid_playfield_char)
6093 // if first playfield line, treat invalid lines as comment lines
6095 reading_playfield = FALSE;
6100 // continue with next tile row
6108 level->fieldx = MIN(MAX(MIN_LEV_FIELDX, level->fieldx), MAX_LEV_FIELDX);
6109 level->fieldy = MIN(MAX(MIN_LEV_FIELDY, level->fieldy), MAX_LEV_FIELDY);
6111 if (!reading_playfield)
6113 level->no_valid_file = TRUE;
6115 Warn("cannot read level '%s' -- using empty level", filename);
6120 if (*level_name != '\0')
6122 strncpy(level->name, level_name, MAX_LEVEL_NAME_LEN);
6123 level->name[MAX_LEVEL_NAME_LEN] = '\0';
6125 else if (*last_comment != '\0')
6127 strncpy(level->name, last_comment, MAX_LEVEL_NAME_LEN);
6128 level->name[MAX_LEVEL_NAME_LEN] = '\0';
6132 sprintf(level->name, "--> Level %d <--", level_file_info->nr);
6135 // set all empty fields beyond the border walls to invisible steel wall
6136 for (y = 0; y < level->fieldy; y++) for (x = 0; x < level->fieldx; x++)
6138 if ((x == 0 || x == level->fieldx - 1 ||
6139 y == 0 || y == level->fieldy - 1) &&
6140 level->field[x][y] == getMappedElement_SB(' ', load_xsb_to_ces))
6141 FloodFillLevel(x, y, getMappedElement_SB('_', load_xsb_to_ces),
6142 level->field, level->fieldx, level->fieldy);
6145 // set special level settings for Sokoban levels
6146 SetLevelSettings_SB(level);
6148 if (load_xsb_to_ces)
6150 // special global settings can now be set in level template
6151 level->use_custom_template = TRUE;
6156 // -------------------------------------------------------------------------
6157 // functions for handling native levels
6158 // -------------------------------------------------------------------------
6160 static void LoadLevelFromFileInfo_EM(struct LevelInfo *level,
6161 struct LevelFileInfo *level_file_info,
6162 boolean level_info_only)
6164 if (!LoadNativeLevel_EM(level_file_info->filename, level_info_only))
6165 level->no_valid_file = TRUE;
6168 static void LoadLevelFromFileInfo_SP(struct LevelInfo *level,
6169 struct LevelFileInfo *level_file_info,
6170 boolean level_info_only)
6174 // determine position of requested level inside level package
6175 if (level_file_info->packed)
6176 pos = level_file_info->nr - leveldir_current->first_level;
6178 if (!LoadNativeLevel_SP(level_file_info->filename, pos, level_info_only))
6179 level->no_valid_file = TRUE;
6182 static void LoadLevelFromFileInfo_MM(struct LevelInfo *level,
6183 struct LevelFileInfo *level_file_info,
6184 boolean level_info_only)
6186 if (!LoadNativeLevel_MM(level_file_info->filename, level_info_only))
6187 level->no_valid_file = TRUE;
6190 void CopyNativeLevel_RND_to_Native(struct LevelInfo *level)
6192 if (level->game_engine_type == GAME_ENGINE_TYPE_EM)
6193 CopyNativeLevel_RND_to_EM(level);
6194 else if (level->game_engine_type == GAME_ENGINE_TYPE_SP)
6195 CopyNativeLevel_RND_to_SP(level);
6196 else if (level->game_engine_type == GAME_ENGINE_TYPE_MM)
6197 CopyNativeLevel_RND_to_MM(level);
6200 void CopyNativeLevel_Native_to_RND(struct LevelInfo *level)
6202 if (level->game_engine_type == GAME_ENGINE_TYPE_EM)
6203 CopyNativeLevel_EM_to_RND(level);
6204 else if (level->game_engine_type == GAME_ENGINE_TYPE_SP)
6205 CopyNativeLevel_SP_to_RND(level);
6206 else if (level->game_engine_type == GAME_ENGINE_TYPE_MM)
6207 CopyNativeLevel_MM_to_RND(level);
6210 void SaveNativeLevel(struct LevelInfo *level)
6212 if (level->game_engine_type == GAME_ENGINE_TYPE_SP)
6214 char *basename = getSingleLevelBasenameExt(level->file_info.nr, "sp");
6215 char *filename = getLevelFilenameFromBasename(basename);
6217 CopyNativeLevel_RND_to_SP(level);
6218 CopyNativeTape_RND_to_SP(level);
6220 SaveNativeLevel_SP(filename);
6225 // ----------------------------------------------------------------------------
6226 // functions for loading generic level
6227 // ----------------------------------------------------------------------------
6229 static void LoadLevelFromFileInfo(struct LevelInfo *level,
6230 struct LevelFileInfo *level_file_info,
6231 boolean level_info_only)
6233 // always start with reliable default values
6234 setLevelInfoToDefaults(level, level_info_only, TRUE);
6236 switch (level_file_info->type)
6238 case LEVEL_FILE_TYPE_RND:
6239 LoadLevelFromFileInfo_RND(level, level_file_info, level_info_only);
6242 case LEVEL_FILE_TYPE_EM:
6243 LoadLevelFromFileInfo_EM(level, level_file_info, level_info_only);
6244 level->game_engine_type = GAME_ENGINE_TYPE_EM;
6247 case LEVEL_FILE_TYPE_SP:
6248 LoadLevelFromFileInfo_SP(level, level_file_info, level_info_only);
6249 level->game_engine_type = GAME_ENGINE_TYPE_SP;
6252 case LEVEL_FILE_TYPE_MM:
6253 LoadLevelFromFileInfo_MM(level, level_file_info, level_info_only);
6254 level->game_engine_type = GAME_ENGINE_TYPE_MM;
6257 case LEVEL_FILE_TYPE_DC:
6258 LoadLevelFromFileInfo_DC(level, level_file_info, level_info_only);
6261 case LEVEL_FILE_TYPE_SB:
6262 LoadLevelFromFileInfo_SB(level, level_file_info, level_info_only);
6266 LoadLevelFromFileInfo_RND(level, level_file_info, level_info_only);
6270 // if level file is invalid, restore level structure to default values
6271 if (level->no_valid_file)
6272 setLevelInfoToDefaults(level, level_info_only, FALSE);
6274 if (level->game_engine_type == GAME_ENGINE_TYPE_UNKNOWN)
6275 level->game_engine_type = GAME_ENGINE_TYPE_RND;
6277 if (level_file_info->type != LEVEL_FILE_TYPE_RND)
6278 CopyNativeLevel_Native_to_RND(level);
6281 void LoadLevelFromFilename(struct LevelInfo *level, char *filename)
6283 static struct LevelFileInfo level_file_info;
6285 // always start with reliable default values
6286 setFileInfoToDefaults(&level_file_info);
6288 level_file_info.nr = 0; // unknown level number
6289 level_file_info.type = LEVEL_FILE_TYPE_RND; // no others supported yet
6291 setString(&level_file_info.filename, filename);
6293 LoadLevelFromFileInfo(level, &level_file_info, FALSE);
6296 static void LoadLevel_InitVersion(struct LevelInfo *level)
6300 if (leveldir_current == NULL) // only when dumping level
6303 // all engine modifications also valid for levels which use latest engine
6304 if (level->game_version < VERSION_IDENT(3,2,0,5))
6306 // time bonus score was given for 10 s instead of 1 s before 3.2.0-5
6307 level->time_score_base = 10;
6310 if (leveldir_current->latest_engine)
6312 // ---------- use latest game engine --------------------------------------
6314 /* For all levels which are forced to use the latest game engine version
6315 (normally all but user contributed, private and undefined levels), set
6316 the game engine version to the actual version; this allows for actual
6317 corrections in the game engine to take effect for existing, converted
6318 levels (from "classic" or other existing games) to make the emulation
6319 of the corresponding game more accurate, while (hopefully) not breaking
6320 existing levels created from other players. */
6322 level->game_version = GAME_VERSION_ACTUAL;
6324 /* Set special EM style gems behaviour: EM style gems slip down from
6325 normal, steel and growing wall. As this is a more fundamental change,
6326 it seems better to set the default behaviour to "off" (as it is more
6327 natural) and make it configurable in the level editor (as a property
6328 of gem style elements). Already existing converted levels (neither
6329 private nor contributed levels) are changed to the new behaviour. */
6331 if (level->file_version < FILE_VERSION_2_0)
6332 level->em_slippery_gems = TRUE;
6337 // ---------- use game engine the level was created with --------------------
6339 /* For all levels which are not forced to use the latest game engine
6340 version (normally user contributed, private and undefined levels),
6341 use the version of the game engine the levels were created for.
6343 Since 2.0.1, the game engine version is now directly stored
6344 in the level file (chunk "VERS"), so there is no need anymore
6345 to set the game version from the file version (except for old,
6346 pre-2.0 levels, where the game version is still taken from the
6347 file format version used to store the level -- see above). */
6349 // player was faster than enemies in 1.0.0 and before
6350 if (level->file_version == FILE_VERSION_1_0)
6351 for (i = 0; i < MAX_PLAYERS; i++)
6352 level->initial_player_stepsize[i] = STEPSIZE_FAST;
6354 // default behaviour for EM style gems was "slippery" only in 2.0.1
6355 if (level->game_version == VERSION_IDENT(2,0,1,0))
6356 level->em_slippery_gems = TRUE;
6358 // springs could be pushed over pits before (pre-release version) 2.2.0
6359 if (level->game_version < VERSION_IDENT(2,2,0,0))
6360 level->use_spring_bug = TRUE;
6362 if (level->game_version < VERSION_IDENT(3,2,0,5))
6364 // time orb caused limited time in endless time levels before 3.2.0-5
6365 level->use_time_orb_bug = TRUE;
6367 // default behaviour for snapping was "no snap delay" before 3.2.0-5
6368 level->block_snap_field = FALSE;
6370 // extra time score was same value as time left score before 3.2.0-5
6371 level->extra_time_score = level->score[SC_TIME_BONUS];
6374 if (level->game_version < VERSION_IDENT(3,2,0,7))
6376 // default behaviour for snapping was "not continuous" before 3.2.0-7
6377 level->continuous_snapping = FALSE;
6380 // only few elements were able to actively move into acid before 3.1.0
6381 // trigger settings did not exist before 3.1.0; set to default "any"
6382 if (level->game_version < VERSION_IDENT(3,1,0,0))
6384 // correct "can move into acid" settings (all zero in old levels)
6386 level->can_move_into_acid_bits = 0; // nothing can move into acid
6387 level->dont_collide_with_bits = 0; // nothing is deadly when colliding
6389 setMoveIntoAcidProperty(level, EL_ROBOT, TRUE);
6390 setMoveIntoAcidProperty(level, EL_SATELLITE, TRUE);
6391 setMoveIntoAcidProperty(level, EL_PENGUIN, TRUE);
6392 setMoveIntoAcidProperty(level, EL_BALLOON, TRUE);
6394 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
6395 SET_PROPERTY(EL_CUSTOM_START + i, EP_CAN_MOVE_INTO_ACID, TRUE);
6397 // correct trigger settings (stored as zero == "none" in old levels)
6399 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
6401 int element = EL_CUSTOM_START + i;
6402 struct ElementInfo *ei = &element_info[element];
6404 for (j = 0; j < ei->num_change_pages; j++)
6406 struct ElementChangeInfo *change = &ei->change_page[j];
6408 change->trigger_player = CH_PLAYER_ANY;
6409 change->trigger_page = CH_PAGE_ANY;
6414 // try to detect and fix "Snake Bite" levels, which are broken with 3.2.0
6416 int element = EL_CUSTOM_256;
6417 struct ElementInfo *ei = &element_info[element];
6418 struct ElementChangeInfo *change = &ei->change_page[0];
6420 /* This is needed to fix a problem that was caused by a bugfix in function
6421 game.c/CreateFieldExt() introduced with 3.2.0 that corrects the behaviour
6422 when a custom element changes to EL_SOKOBAN_FIELD_PLAYER (before, it did
6423 not replace walkable elements, but instead just placed the player on it,
6424 without placing the Sokoban field under the player). Unfortunately, this
6425 breaks "Snake Bite" style levels when the snake is halfway through a door
6426 that just closes (the snake head is still alive and can be moved in this
6427 case). This can be fixed by replacing the EL_SOKOBAN_FIELD_PLAYER by the
6428 player (without Sokoban element) which then gets killed as designed). */
6430 if ((strncmp(leveldir_current->identifier, "snake_bite", 10) == 0 ||
6431 strncmp(ei->description, "pause b4 death", 14) == 0) &&
6432 change->target_element == EL_SOKOBAN_FIELD_PLAYER)
6433 change->target_element = EL_PLAYER_1;
6436 // try to detect and fix "Zelda" style levels, which are broken with 3.2.5
6437 if (level->game_version < VERSION_IDENT(3,2,5,0))
6439 /* This is needed to fix a problem that was caused by a bugfix in function
6440 game.c/CheckTriggeredElementChangeExt() introduced with 3.2.5 that
6441 corrects the behaviour when a custom element changes to another custom
6442 element with a higher element number that has change actions defined.
6443 Normally, only one change per frame is allowed for custom elements.
6444 Therefore, it is checked if a custom element already changed in the
6445 current frame; if it did, subsequent changes are suppressed.
6446 Unfortunately, this is only checked for element changes, but not for
6447 change actions, which are still executed. As the function above loops
6448 through all custom elements from lower to higher, an element change
6449 resulting in a lower CE number won't be checked again, while a target
6450 element with a higher number will also be checked, and potential change
6451 actions will get executed for this CE, too (which is wrong), while
6452 further changes are ignored (which is correct). As this bugfix breaks
6453 Zelda II (and introduces graphical bugs to Zelda I, and also breaks a
6454 few other levels like Alan Bond's "FMV"), allow the previous, incorrect
6455 behaviour for existing levels and tapes that make use of this bug */
6457 level->use_action_after_change_bug = TRUE;
6460 // not centering level after relocating player was default only in 3.2.3
6461 if (level->game_version == VERSION_IDENT(3,2,3,0)) // (no pre-releases)
6462 level->shifted_relocation = TRUE;
6464 // EM style elements always chain-exploded in R'n'D engine before 3.2.6
6465 if (level->game_version < VERSION_IDENT(3,2,6,0))
6466 level->em_explodes_by_fire = TRUE;
6468 // levels were solved by the first player entering an exit up to 4.1.0.0
6469 if (level->game_version <= VERSION_IDENT(4,1,0,0))
6470 level->solved_by_one_player = TRUE;
6472 // game logic of "game of life" and "biomaze" was buggy before 4.1.1.1
6473 if (level->game_version < VERSION_IDENT(4,1,1,1))
6474 level->use_life_bugs = TRUE;
6476 // only Sokoban fields (but not objects) had to be solved before 4.1.1.1
6477 if (level->game_version < VERSION_IDENT(4,1,1,1))
6478 level->sb_objects_needed = FALSE;
6480 // CE actions were triggered by unfinished digging/collecting up to 4.2.2.0
6481 if (level->game_version <= VERSION_IDENT(4,2,2,0))
6482 level->finish_dig_collect = FALSE;
6484 // CE changing to player was kept under the player if walkable up to 4.2.3.1
6485 if (level->game_version <= VERSION_IDENT(4,2,3,1))
6486 level->keep_walkable_ce = TRUE;
6489 static void LoadLevel_InitSettings_SB(struct LevelInfo *level)
6491 boolean is_sokoban_level = TRUE; // unless non-Sokoban elements found
6494 // check if this level is (not) a Sokoban level
6495 for (y = 0; y < level->fieldy; y++)
6496 for (x = 0; x < level->fieldx; x++)
6497 if (!IS_SB_ELEMENT(Tile[x][y]))
6498 is_sokoban_level = FALSE;
6500 if (is_sokoban_level)
6502 // set special level settings for Sokoban levels
6503 SetLevelSettings_SB(level);
6507 static void LoadLevel_InitSettings(struct LevelInfo *level)
6509 // adjust level settings for (non-native) Sokoban-style levels
6510 LoadLevel_InitSettings_SB(level);
6513 static void LoadLevel_InitStandardElements(struct LevelInfo *level)
6517 // map elements that have changed in newer versions
6518 level->amoeba_content = getMappedElementByVersion(level->amoeba_content,
6519 level->game_version);
6520 for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
6521 for (x = 0; x < 3; x++)
6522 for (y = 0; y < 3; y++)
6523 level->yamyam_content[i].e[x][y] =
6524 getMappedElementByVersion(level->yamyam_content[i].e[x][y],
6525 level->game_version);
6529 static void LoadLevel_InitCustomElements(struct LevelInfo *level)
6533 // map custom element change events that have changed in newer versions
6534 // (these following values were accidentally changed in version 3.0.1)
6535 // (this seems to be needed only for 'ab_levelset3' and 'ab_levelset4')
6536 if (level->game_version <= VERSION_IDENT(3,0,0,0))
6538 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
6540 int element = EL_CUSTOM_START + i;
6542 // order of checking and copying events to be mapped is important
6543 // (do not change the start and end value -- they are constant)
6544 for (j = CE_BY_OTHER_ACTION; j >= CE_VALUE_GETS_ZERO; j--)
6546 if (HAS_CHANGE_EVENT(element, j - 2))
6548 SET_CHANGE_EVENT(element, j - 2, FALSE);
6549 SET_CHANGE_EVENT(element, j, TRUE);
6553 // order of checking and copying events to be mapped is important
6554 // (do not change the start and end value -- they are constant)
6555 for (j = CE_PLAYER_COLLECTS_X; j >= CE_HITTING_SOMETHING; j--)
6557 if (HAS_CHANGE_EVENT(element, j - 1))
6559 SET_CHANGE_EVENT(element, j - 1, FALSE);
6560 SET_CHANGE_EVENT(element, j, TRUE);
6566 // initialize "can_change" field for old levels with only one change page
6567 if (level->game_version <= VERSION_IDENT(3,0,2,0))
6569 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
6571 int element = EL_CUSTOM_START + i;
6573 if (CAN_CHANGE(element))
6574 element_info[element].change->can_change = TRUE;
6578 // correct custom element values (for old levels without these options)
6579 if (level->game_version < VERSION_IDENT(3,1,1,0))
6581 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
6583 int element = EL_CUSTOM_START + i;
6584 struct ElementInfo *ei = &element_info[element];
6586 if (ei->access_direction == MV_NO_DIRECTION)
6587 ei->access_direction = MV_ALL_DIRECTIONS;
6591 // correct custom element values (fix invalid values for all versions)
6594 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
6596 int element = EL_CUSTOM_START + i;
6597 struct ElementInfo *ei = &element_info[element];
6599 for (j = 0; j < ei->num_change_pages; j++)
6601 struct ElementChangeInfo *change = &ei->change_page[j];
6603 if (change->trigger_player == CH_PLAYER_NONE)
6604 change->trigger_player = CH_PLAYER_ANY;
6606 if (change->trigger_side == CH_SIDE_NONE)
6607 change->trigger_side = CH_SIDE_ANY;
6612 // initialize "can_explode" field for old levels which did not store this
6613 // !!! CHECK THIS -- "<= 3,1,0,0" IS PROBABLY WRONG !!!
6614 if (level->game_version <= VERSION_IDENT(3,1,0,0))
6616 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
6618 int element = EL_CUSTOM_START + i;
6620 if (EXPLODES_1X1_OLD(element))
6621 element_info[element].explosion_type = EXPLODES_1X1;
6623 SET_PROPERTY(element, EP_CAN_EXPLODE, (EXPLODES_BY_FIRE(element) ||
6624 EXPLODES_SMASHED(element) ||
6625 EXPLODES_IMPACT(element)));
6629 // correct previously hard-coded move delay values for maze runner style
6630 if (level->game_version < VERSION_IDENT(3,1,1,0))
6632 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
6634 int element = EL_CUSTOM_START + i;
6636 if (element_info[element].move_pattern & MV_MAZE_RUNNER_STYLE)
6638 // previously hard-coded and therefore ignored
6639 element_info[element].move_delay_fixed = 9;
6640 element_info[element].move_delay_random = 0;
6645 // set some other uninitialized values of custom elements in older levels
6646 if (level->game_version < VERSION_IDENT(3,1,0,0))
6648 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
6650 int element = EL_CUSTOM_START + i;
6652 element_info[element].access_direction = MV_ALL_DIRECTIONS;
6654 element_info[element].explosion_delay = 17;
6655 element_info[element].ignition_delay = 8;
6659 // set mouse click change events to work for left/middle/right mouse button
6660 if (level->game_version < VERSION_IDENT(4,2,3,0))
6662 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
6664 int element = EL_CUSTOM_START + i;
6665 struct ElementInfo *ei = &element_info[element];
6667 for (j = 0; j < ei->num_change_pages; j++)
6669 struct ElementChangeInfo *change = &ei->change_page[j];
6671 if (change->has_event[CE_CLICKED_BY_MOUSE] ||
6672 change->has_event[CE_PRESSED_BY_MOUSE] ||
6673 change->has_event[CE_MOUSE_CLICKED_ON_X] ||
6674 change->has_event[CE_MOUSE_PRESSED_ON_X])
6675 change->trigger_side = CH_SIDE_ANY;
6681 static void LoadLevel_InitElements(struct LevelInfo *level)
6683 LoadLevel_InitStandardElements(level);
6685 if (level->file_has_custom_elements)
6686 LoadLevel_InitCustomElements(level);
6688 // initialize element properties for level editor etc.
6689 InitElementPropertiesEngine(level->game_version);
6690 InitElementPropertiesGfxElement();
6693 static void LoadLevel_InitPlayfield(struct LevelInfo *level)
6697 // map elements that have changed in newer versions
6698 for (y = 0; y < level->fieldy; y++)
6699 for (x = 0; x < level->fieldx; x++)
6700 level->field[x][y] = getMappedElementByVersion(level->field[x][y],
6701 level->game_version);
6703 // clear unused playfield data (nicer if level gets resized in editor)
6704 for (x = 0; x < MAX_LEV_FIELDX; x++)
6705 for (y = 0; y < MAX_LEV_FIELDY; y++)
6706 if (x >= level->fieldx || y >= level->fieldy)
6707 level->field[x][y] = EL_EMPTY;
6709 // copy elements to runtime playfield array
6710 for (x = 0; x < MAX_LEV_FIELDX; x++)
6711 for (y = 0; y < MAX_LEV_FIELDY; y++)
6712 Tile[x][y] = level->field[x][y];
6714 // initialize level size variables for faster access
6715 lev_fieldx = level->fieldx;
6716 lev_fieldy = level->fieldy;
6718 // determine border element for this level
6719 if (level->file_info.type == LEVEL_FILE_TYPE_DC)
6720 BorderElement = EL_EMPTY; // (in editor, SetBorderElement() is used)
6725 static void LoadLevel_InitNativeEngines(struct LevelInfo *level)
6727 struct LevelFileInfo *level_file_info = &level->file_info;
6729 if (level_file_info->type == LEVEL_FILE_TYPE_RND)
6730 CopyNativeLevel_RND_to_Native(level);
6733 static void LoadLevelTemplate_LoadAndInit(void)
6735 LoadLevelFromFileInfo(&level_template, &level_template.file_info, FALSE);
6737 LoadLevel_InitVersion(&level_template);
6738 LoadLevel_InitElements(&level_template);
6739 LoadLevel_InitSettings(&level_template);
6741 ActivateLevelTemplate();
6744 void LoadLevelTemplate(int nr)
6746 if (!fileExists(getGlobalLevelTemplateFilename()))
6748 Warn("no level template found for this level");
6753 setLevelFileInfo(&level_template.file_info, nr);
6755 LoadLevelTemplate_LoadAndInit();
6758 static void LoadNetworkLevelTemplate(struct NetworkLevelInfo *network_level)
6760 copyLevelFileInfo(&network_level->tmpl_info, &level_template.file_info);
6762 LoadLevelTemplate_LoadAndInit();
6765 static void LoadLevel_LoadAndInit(struct NetworkLevelInfo *network_level)
6767 LoadLevelFromFileInfo(&level, &level.file_info, FALSE);
6769 if (level.use_custom_template)
6771 if (network_level != NULL)
6772 LoadNetworkLevelTemplate(network_level);
6774 LoadLevelTemplate(-1);
6777 LoadLevel_InitVersion(&level);
6778 LoadLevel_InitElements(&level);
6779 LoadLevel_InitPlayfield(&level);
6780 LoadLevel_InitSettings(&level);
6782 LoadLevel_InitNativeEngines(&level);
6785 void LoadLevel(int nr)
6787 SetLevelSetInfo(leveldir_current->identifier, nr);
6789 setLevelFileInfo(&level.file_info, nr);
6791 LoadLevel_LoadAndInit(NULL);
6794 void LoadLevelInfoOnly(int nr)
6796 setLevelFileInfo(&level.file_info, nr);
6798 LoadLevelFromFileInfo(&level, &level.file_info, TRUE);
6801 void LoadNetworkLevel(struct NetworkLevelInfo *network_level)
6803 SetLevelSetInfo(network_level->leveldir_identifier,
6804 network_level->file_info.nr);
6806 copyLevelFileInfo(&network_level->file_info, &level.file_info);
6808 LoadLevel_LoadAndInit(network_level);
6811 static int SaveLevel_VERS(FILE *file, struct LevelInfo *level)
6815 chunk_size += putFileVersion(file, level->file_version);
6816 chunk_size += putFileVersion(file, level->game_version);
6821 static int SaveLevel_DATE(FILE *file, struct LevelInfo *level)
6825 chunk_size += putFile16BitBE(file, level->creation_date.year);
6826 chunk_size += putFile8Bit(file, level->creation_date.month);
6827 chunk_size += putFile8Bit(file, level->creation_date.day);
6832 #if ENABLE_HISTORIC_CHUNKS
6833 static void SaveLevel_HEAD(FILE *file, struct LevelInfo *level)
6837 putFile8Bit(file, level->fieldx);
6838 putFile8Bit(file, level->fieldy);
6840 putFile16BitBE(file, level->time);
6841 putFile16BitBE(file, level->gems_needed);
6843 for (i = 0; i < MAX_LEVEL_NAME_LEN; i++)
6844 putFile8Bit(file, level->name[i]);
6846 for (i = 0; i < LEVEL_SCORE_ELEMENTS; i++)
6847 putFile8Bit(file, level->score[i]);
6849 for (i = 0; i < STD_ELEMENT_CONTENTS; i++)
6850 for (y = 0; y < 3; y++)
6851 for (x = 0; x < 3; x++)
6852 putFile8Bit(file, (level->encoding_16bit_yamyam ? EL_EMPTY :
6853 level->yamyam_content[i].e[x][y]));
6854 putFile8Bit(file, level->amoeba_speed);
6855 putFile8Bit(file, level->time_magic_wall);
6856 putFile8Bit(file, level->time_wheel);
6857 putFile8Bit(file, (level->encoding_16bit_amoeba ? EL_EMPTY :
6858 level->amoeba_content));
6859 putFile8Bit(file, (level->initial_player_stepsize == STEPSIZE_FAST ? 1 : 0));
6860 putFile8Bit(file, (level->initial_gravity ? 1 : 0));
6861 putFile8Bit(file, (level->encoding_16bit_field ? 1 : 0));
6862 putFile8Bit(file, (level->em_slippery_gems ? 1 : 0));
6864 putFile8Bit(file, (level->use_custom_template ? 1 : 0));
6866 putFile8Bit(file, (level->block_last_field ? 1 : 0));
6867 putFile8Bit(file, (level->sp_block_last_field ? 1 : 0));
6868 putFile32BitBE(file, level->can_move_into_acid_bits);
6869 putFile8Bit(file, level->dont_collide_with_bits);
6871 putFile8Bit(file, (level->use_spring_bug ? 1 : 0));
6872 putFile8Bit(file, (level->use_step_counter ? 1 : 0));
6874 putFile8Bit(file, (level->instant_relocation ? 1 : 0));
6875 putFile8Bit(file, (level->can_pass_to_walkable ? 1 : 0));
6876 putFile8Bit(file, (level->grow_into_diggable ? 1 : 0));
6878 putFile8Bit(file, level->game_engine_type);
6880 WriteUnusedBytesToFile(file, LEVEL_CHUNK_HEAD_UNUSED);
6884 static int SaveLevel_NAME(FILE *file, struct LevelInfo *level)
6889 for (i = 0; i < MAX_LEVEL_NAME_LEN; i++)
6890 chunk_size += putFile8Bit(file, level->name[i]);
6895 static int SaveLevel_AUTH(FILE *file, struct LevelInfo *level)
6900 for (i = 0; i < MAX_LEVEL_AUTHOR_LEN; i++)
6901 chunk_size += putFile8Bit(file, level->author[i]);
6906 #if ENABLE_HISTORIC_CHUNKS
6907 static int SaveLevel_BODY(FILE *file, struct LevelInfo *level)
6912 for (y = 0; y < level->fieldy; y++)
6913 for (x = 0; x < level->fieldx; x++)
6914 if (level->encoding_16bit_field)
6915 chunk_size += putFile16BitBE(file, level->field[x][y]);
6917 chunk_size += putFile8Bit(file, level->field[x][y]);
6923 static int SaveLevel_BODY(FILE *file, struct LevelInfo *level)
6928 for (y = 0; y < level->fieldy; y++)
6929 for (x = 0; x < level->fieldx; x++)
6930 chunk_size += putFile16BitBE(file, level->field[x][y]);
6935 #if ENABLE_HISTORIC_CHUNKS
6936 static void SaveLevel_CONT(FILE *file, struct LevelInfo *level)
6940 putFile8Bit(file, EL_YAMYAM);
6941 putFile8Bit(file, level->num_yamyam_contents);
6942 putFile8Bit(file, 0);
6943 putFile8Bit(file, 0);
6945 for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
6946 for (y = 0; y < 3; y++)
6947 for (x = 0; x < 3; x++)
6948 if (level->encoding_16bit_field)
6949 putFile16BitBE(file, level->yamyam_content[i].e[x][y]);
6951 putFile8Bit(file, level->yamyam_content[i].e[x][y]);
6955 #if ENABLE_HISTORIC_CHUNKS
6956 static void SaveLevel_CNT2(FILE *file, struct LevelInfo *level, int element)
6959 int num_contents, content_xsize, content_ysize;
6960 int content_array[MAX_ELEMENT_CONTENTS][3][3];
6962 if (element == EL_YAMYAM)
6964 num_contents = level->num_yamyam_contents;
6968 for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
6969 for (y = 0; y < 3; y++)
6970 for (x = 0; x < 3; x++)
6971 content_array[i][x][y] = level->yamyam_content[i].e[x][y];
6973 else if (element == EL_BD_AMOEBA)
6979 for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
6980 for (y = 0; y < 3; y++)
6981 for (x = 0; x < 3; x++)
6982 content_array[i][x][y] = EL_EMPTY;
6983 content_array[0][0][0] = level->amoeba_content;
6987 // chunk header already written -- write empty chunk data
6988 WriteUnusedBytesToFile(file, LEVEL_CHUNK_CNT2_SIZE);
6990 Warn("cannot save content for element '%d'", element);
6995 putFile16BitBE(file, element);
6996 putFile8Bit(file, num_contents);
6997 putFile8Bit(file, content_xsize);
6998 putFile8Bit(file, content_ysize);
7000 WriteUnusedBytesToFile(file, LEVEL_CHUNK_CNT2_UNUSED);
7002 for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
7003 for (y = 0; y < 3; y++)
7004 for (x = 0; x < 3; x++)
7005 putFile16BitBE(file, content_array[i][x][y]);
7009 #if ENABLE_HISTORIC_CHUNKS
7010 static int SaveLevel_CNT3(FILE *file, struct LevelInfo *level, int element)
7012 int envelope_nr = element - EL_ENVELOPE_1;
7013 int envelope_len = strlen(level->envelope_text[envelope_nr]) + 1;
7017 chunk_size += putFile16BitBE(file, element);
7018 chunk_size += putFile16BitBE(file, envelope_len);
7019 chunk_size += putFile8Bit(file, level->envelope_xsize[envelope_nr]);
7020 chunk_size += putFile8Bit(file, level->envelope_ysize[envelope_nr]);
7022 WriteUnusedBytesToFile(file, LEVEL_CHUNK_CNT3_UNUSED);
7023 chunk_size += LEVEL_CHUNK_CNT3_UNUSED;
7025 for (i = 0; i < envelope_len; i++)
7026 chunk_size += putFile8Bit(file, level->envelope_text[envelope_nr][i]);
7032 #if ENABLE_HISTORIC_CHUNKS
7033 static void SaveLevel_CUS1(FILE *file, struct LevelInfo *level,
7034 int num_changed_custom_elements)
7038 putFile16BitBE(file, num_changed_custom_elements);
7040 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
7042 int element = EL_CUSTOM_START + i;
7044 struct ElementInfo *ei = &element_info[element];
7046 if (ei->properties[EP_BITFIELD_BASE_NR] != EP_BITMASK_DEFAULT)
7048 if (check < num_changed_custom_elements)
7050 putFile16BitBE(file, element);
7051 putFile32BitBE(file, ei->properties[EP_BITFIELD_BASE_NR]);
7058 if (check != num_changed_custom_elements) // should not happen
7059 Warn("inconsistent number of custom element properties");
7063 #if ENABLE_HISTORIC_CHUNKS
7064 static void SaveLevel_CUS2(FILE *file, struct LevelInfo *level,
7065 int num_changed_custom_elements)
7069 putFile16BitBE(file, num_changed_custom_elements);
7071 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
7073 int element = EL_CUSTOM_START + i;
7075 if (element_info[element].change->target_element != EL_EMPTY_SPACE)
7077 if (check < num_changed_custom_elements)
7079 putFile16BitBE(file, element);
7080 putFile16BitBE(file, element_info[element].change->target_element);
7087 if (check != num_changed_custom_elements) // should not happen
7088 Warn("inconsistent number of custom target elements");
7092 #if ENABLE_HISTORIC_CHUNKS
7093 static void SaveLevel_CUS3(FILE *file, struct LevelInfo *level,
7094 int num_changed_custom_elements)
7096 int i, j, x, y, check = 0;
7098 putFile16BitBE(file, num_changed_custom_elements);
7100 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
7102 int element = EL_CUSTOM_START + i;
7103 struct ElementInfo *ei = &element_info[element];
7105 if (ei->modified_settings)
7107 if (check < num_changed_custom_elements)
7109 putFile16BitBE(file, element);
7111 for (j = 0; j < MAX_ELEMENT_NAME_LEN; j++)
7112 putFile8Bit(file, ei->description[j]);
7114 putFile32BitBE(file, ei->properties[EP_BITFIELD_BASE_NR]);
7116 // some free bytes for future properties and padding
7117 WriteUnusedBytesToFile(file, 7);
7119 putFile8Bit(file, ei->use_gfx_element);
7120 putFile16BitBE(file, ei->gfx_element_initial);
7122 putFile8Bit(file, ei->collect_score_initial);
7123 putFile8Bit(file, ei->collect_count_initial);
7125 putFile16BitBE(file, ei->push_delay_fixed);
7126 putFile16BitBE(file, ei->push_delay_random);
7127 putFile16BitBE(file, ei->move_delay_fixed);
7128 putFile16BitBE(file, ei->move_delay_random);
7130 putFile16BitBE(file, ei->move_pattern);
7131 putFile8Bit(file, ei->move_direction_initial);
7132 putFile8Bit(file, ei->move_stepsize);
7134 for (y = 0; y < 3; y++)
7135 for (x = 0; x < 3; x++)
7136 putFile16BitBE(file, ei->content.e[x][y]);
7138 putFile32BitBE(file, ei->change->events);
7140 putFile16BitBE(file, ei->change->target_element);
7142 putFile16BitBE(file, ei->change->delay_fixed);
7143 putFile16BitBE(file, ei->change->delay_random);
7144 putFile16BitBE(file, ei->change->delay_frames);
7146 putFile16BitBE(file, ei->change->initial_trigger_element);
7148 putFile8Bit(file, ei->change->explode);
7149 putFile8Bit(file, ei->change->use_target_content);
7150 putFile8Bit(file, ei->change->only_if_complete);
7151 putFile8Bit(file, ei->change->use_random_replace);
7153 putFile8Bit(file, ei->change->random_percentage);
7154 putFile8Bit(file, ei->change->replace_when);
7156 for (y = 0; y < 3; y++)
7157 for (x = 0; x < 3; x++)
7158 putFile16BitBE(file, ei->change->content.e[x][y]);
7160 putFile8Bit(file, ei->slippery_type);
7162 // some free bytes for future properties and padding
7163 WriteUnusedBytesToFile(file, LEVEL_CPART_CUS3_UNUSED);
7170 if (check != num_changed_custom_elements) // should not happen
7171 Warn("inconsistent number of custom element properties");
7175 #if ENABLE_HISTORIC_CHUNKS
7176 static void SaveLevel_CUS4(FILE *file, struct LevelInfo *level, int element)
7178 struct ElementInfo *ei = &element_info[element];
7181 // ---------- custom element base property values (96 bytes) ----------------
7183 putFile16BitBE(file, element);
7185 for (i = 0; i < MAX_ELEMENT_NAME_LEN; i++)
7186 putFile8Bit(file, ei->description[i]);
7188 putFile32BitBE(file, ei->properties[EP_BITFIELD_BASE_NR]);
7190 WriteUnusedBytesToFile(file, 4); // reserved for more base properties
7192 putFile8Bit(file, ei->num_change_pages);
7194 putFile16BitBE(file, ei->ce_value_fixed_initial);
7195 putFile16BitBE(file, ei->ce_value_random_initial);
7196 putFile8Bit(file, ei->use_last_ce_value);
7198 putFile8Bit(file, ei->use_gfx_element);
7199 putFile16BitBE(file, ei->gfx_element_initial);
7201 putFile8Bit(file, ei->collect_score_initial);
7202 putFile8Bit(file, ei->collect_count_initial);
7204 putFile8Bit(file, ei->drop_delay_fixed);
7205 putFile8Bit(file, ei->push_delay_fixed);
7206 putFile8Bit(file, ei->drop_delay_random);
7207 putFile8Bit(file, ei->push_delay_random);
7208 putFile16BitBE(file, ei->move_delay_fixed);
7209 putFile16BitBE(file, ei->move_delay_random);
7211 // bits 0 - 15 of "move_pattern" ...
7212 putFile16BitBE(file, ei->move_pattern & 0xffff);
7213 putFile8Bit(file, ei->move_direction_initial);
7214 putFile8Bit(file, ei->move_stepsize);
7216 putFile8Bit(file, ei->slippery_type);
7218 for (y = 0; y < 3; y++)
7219 for (x = 0; x < 3; x++)
7220 putFile16BitBE(file, ei->content.e[x][y]);
7222 putFile16BitBE(file, ei->move_enter_element);
7223 putFile16BitBE(file, ei->move_leave_element);
7224 putFile8Bit(file, ei->move_leave_type);
7226 // ... bits 16 - 31 of "move_pattern" (not nice, but downward compatible)
7227 putFile16BitBE(file, (ei->move_pattern >> 16) & 0xffff);
7229 putFile8Bit(file, ei->access_direction);
7231 putFile8Bit(file, ei->explosion_delay);
7232 putFile8Bit(file, ei->ignition_delay);
7233 putFile8Bit(file, ei->explosion_type);
7235 // some free bytes for future custom property values and padding
7236 WriteUnusedBytesToFile(file, 1);
7238 // ---------- change page property values (48 bytes) ------------------------
7240 for (i = 0; i < ei->num_change_pages; i++)
7242 struct ElementChangeInfo *change = &ei->change_page[i];
7243 unsigned int event_bits;
7245 // bits 0 - 31 of "has_event[]" ...
7247 for (j = 0; j < MIN(NUM_CHANGE_EVENTS, 32); j++)
7248 if (change->has_event[j])
7249 event_bits |= (1 << j);
7250 putFile32BitBE(file, event_bits);
7252 putFile16BitBE(file, change->target_element);
7254 putFile16BitBE(file, change->delay_fixed);
7255 putFile16BitBE(file, change->delay_random);
7256 putFile16BitBE(file, change->delay_frames);
7258 putFile16BitBE(file, change->initial_trigger_element);
7260 putFile8Bit(file, change->explode);
7261 putFile8Bit(file, change->use_target_content);
7262 putFile8Bit(file, change->only_if_complete);
7263 putFile8Bit(file, change->use_random_replace);
7265 putFile8Bit(file, change->random_percentage);
7266 putFile8Bit(file, change->replace_when);
7268 for (y = 0; y < 3; y++)
7269 for (x = 0; x < 3; x++)
7270 putFile16BitBE(file, change->target_content.e[x][y]);
7272 putFile8Bit(file, change->can_change);
7274 putFile8Bit(file, change->trigger_side);
7276 putFile8Bit(file, change->trigger_player);
7277 putFile8Bit(file, (change->trigger_page == CH_PAGE_ANY ? CH_PAGE_ANY_FILE :
7278 log_2(change->trigger_page)));
7280 putFile8Bit(file, change->has_action);
7281 putFile8Bit(file, change->action_type);
7282 putFile8Bit(file, change->action_mode);
7283 putFile16BitBE(file, change->action_arg);
7285 // ... bits 32 - 39 of "has_event[]" (not nice, but downward compatible)
7287 for (j = 32; j < NUM_CHANGE_EVENTS; j++)
7288 if (change->has_event[j])
7289 event_bits |= (1 << (j - 32));
7290 putFile8Bit(file, event_bits);
7295 #if ENABLE_HISTORIC_CHUNKS
7296 static void SaveLevel_GRP1(FILE *file, struct LevelInfo *level, int element)
7298 struct ElementInfo *ei = &element_info[element];
7299 struct ElementGroupInfo *group = ei->group;
7302 putFile16BitBE(file, element);
7304 for (i = 0; i < MAX_ELEMENT_NAME_LEN; i++)
7305 putFile8Bit(file, ei->description[i]);
7307 putFile8Bit(file, group->num_elements);
7309 putFile8Bit(file, ei->use_gfx_element);
7310 putFile16BitBE(file, ei->gfx_element_initial);
7312 putFile8Bit(file, group->choice_mode);
7314 // some free bytes for future values and padding
7315 WriteUnusedBytesToFile(file, 3);
7317 for (i = 0; i < MAX_ELEMENTS_IN_GROUP; i++)
7318 putFile16BitBE(file, group->element[i]);
7322 static int SaveLevel_MicroChunk(FILE *file, struct LevelFileConfigInfo *entry,
7323 boolean write_element)
7325 int save_type = entry->save_type;
7326 int data_type = entry->data_type;
7327 int conf_type = entry->conf_type;
7328 int byte_mask = conf_type & CONF_MASK_BYTES;
7329 int element = entry->element;
7330 int default_value = entry->default_value;
7332 boolean modified = FALSE;
7334 if (byte_mask != CONF_MASK_MULTI_BYTES)
7336 void *value_ptr = entry->value;
7337 int value = (data_type == TYPE_BOOLEAN ? *(boolean *)value_ptr :
7340 // check if any settings have been modified before saving them
7341 if (value != default_value)
7344 // do not save if explicitly told or if unmodified default settings
7345 if ((save_type == SAVE_CONF_NEVER) ||
7346 (save_type == SAVE_CONF_WHEN_CHANGED && !modified))
7350 num_bytes += putFile16BitBE(file, element);
7352 num_bytes += putFile8Bit(file, conf_type);
7353 num_bytes += (byte_mask == CONF_MASK_1_BYTE ? putFile8Bit (file, value) :
7354 byte_mask == CONF_MASK_2_BYTE ? putFile16BitBE(file, value) :
7355 byte_mask == CONF_MASK_4_BYTE ? putFile32BitBE(file, value) :
7358 else if (data_type == TYPE_STRING)
7360 char *default_string = entry->default_string;
7361 char *string = (char *)(entry->value);
7362 int string_length = strlen(string);
7365 // check if any settings have been modified before saving them
7366 if (!strEqual(string, default_string))
7369 // do not save if explicitly told or if unmodified default settings
7370 if ((save_type == SAVE_CONF_NEVER) ||
7371 (save_type == SAVE_CONF_WHEN_CHANGED && !modified))
7375 num_bytes += putFile16BitBE(file, element);
7377 num_bytes += putFile8Bit(file, conf_type);
7378 num_bytes += putFile16BitBE(file, string_length);
7380 for (i = 0; i < string_length; i++)
7381 num_bytes += putFile8Bit(file, string[i]);
7383 else if (data_type == TYPE_ELEMENT_LIST)
7385 int *element_array = (int *)(entry->value);
7386 int num_elements = *(int *)(entry->num_entities);
7389 // check if any settings have been modified before saving them
7390 for (i = 0; i < num_elements; i++)
7391 if (element_array[i] != default_value)
7394 // do not save if explicitly told or if unmodified default settings
7395 if ((save_type == SAVE_CONF_NEVER) ||
7396 (save_type == SAVE_CONF_WHEN_CHANGED && !modified))
7400 num_bytes += putFile16BitBE(file, element);
7402 num_bytes += putFile8Bit(file, conf_type);
7403 num_bytes += putFile16BitBE(file, num_elements * CONF_ELEMENT_NUM_BYTES);
7405 for (i = 0; i < num_elements; i++)
7406 num_bytes += putFile16BitBE(file, element_array[i]);
7408 else if (data_type == TYPE_CONTENT_LIST)
7410 struct Content *content = (struct Content *)(entry->value);
7411 int num_contents = *(int *)(entry->num_entities);
7414 // check if any settings have been modified before saving them
7415 for (i = 0; i < num_contents; i++)
7416 for (y = 0; y < 3; y++)
7417 for (x = 0; x < 3; x++)
7418 if (content[i].e[x][y] != default_value)
7421 // do not save if explicitly told or if unmodified default settings
7422 if ((save_type == SAVE_CONF_NEVER) ||
7423 (save_type == SAVE_CONF_WHEN_CHANGED && !modified))
7427 num_bytes += putFile16BitBE(file, element);
7429 num_bytes += putFile8Bit(file, conf_type);
7430 num_bytes += putFile16BitBE(file, num_contents * CONF_CONTENT_NUM_BYTES);
7432 for (i = 0; i < num_contents; i++)
7433 for (y = 0; y < 3; y++)
7434 for (x = 0; x < 3; x++)
7435 num_bytes += putFile16BitBE(file, content[i].e[x][y]);
7441 static int SaveLevel_INFO(FILE *file, struct LevelInfo *level)
7446 li = *level; // copy level data into temporary buffer
7448 for (i = 0; chunk_config_INFO[i].data_type != -1; i++)
7449 chunk_size += SaveLevel_MicroChunk(file, &chunk_config_INFO[i], FALSE);
7454 static int SaveLevel_ELEM(FILE *file, struct LevelInfo *level)
7459 li = *level; // copy level data into temporary buffer
7461 for (i = 0; chunk_config_ELEM[i].data_type != -1; i++)
7462 chunk_size += SaveLevel_MicroChunk(file, &chunk_config_ELEM[i], TRUE);
7467 static int SaveLevel_NOTE(FILE *file, struct LevelInfo *level, int element)
7469 int envelope_nr = element - EL_ENVELOPE_1;
7473 chunk_size += putFile16BitBE(file, element);
7475 // copy envelope data into temporary buffer
7476 xx_envelope = level->envelope[envelope_nr];
7478 for (i = 0; chunk_config_NOTE[i].data_type != -1; i++)
7479 chunk_size += SaveLevel_MicroChunk(file, &chunk_config_NOTE[i], FALSE);
7484 static int SaveLevel_CUSX(FILE *file, struct LevelInfo *level, int element)
7486 struct ElementInfo *ei = &element_info[element];
7490 chunk_size += putFile16BitBE(file, element);
7492 xx_ei = *ei; // copy element data into temporary buffer
7494 // set default description string for this specific element
7495 strcpy(xx_default_description, getDefaultElementDescription(ei));
7497 for (i = 0; chunk_config_CUSX_base[i].data_type != -1; i++)
7498 chunk_size += SaveLevel_MicroChunk(file, &chunk_config_CUSX_base[i], FALSE);
7500 for (i = 0; i < ei->num_change_pages; i++)
7502 struct ElementChangeInfo *change = &ei->change_page[i];
7504 xx_current_change_page = i;
7506 xx_change = *change; // copy change data into temporary buffer
7509 setEventBitsFromEventFlags(change);
7511 for (j = 0; chunk_config_CUSX_change[j].data_type != -1; j++)
7512 chunk_size += SaveLevel_MicroChunk(file, &chunk_config_CUSX_change[j],
7519 static int SaveLevel_GRPX(FILE *file, struct LevelInfo *level, int element)
7521 struct ElementInfo *ei = &element_info[element];
7522 struct ElementGroupInfo *group = ei->group;
7526 chunk_size += putFile16BitBE(file, element);
7528 xx_ei = *ei; // copy element data into temporary buffer
7529 xx_group = *group; // copy group data into temporary buffer
7531 // set default description string for this specific element
7532 strcpy(xx_default_description, getDefaultElementDescription(ei));
7534 for (i = 0; chunk_config_GRPX[i].data_type != -1; i++)
7535 chunk_size += SaveLevel_MicroChunk(file, &chunk_config_GRPX[i], FALSE);
7540 static void SaveLevelFromFilename(struct LevelInfo *level, char *filename,
7541 boolean save_as_template)
7547 if (!(file = fopen(filename, MODE_WRITE)))
7549 Warn("cannot save level file '%s'", filename);
7554 level->file_version = FILE_VERSION_ACTUAL;
7555 level->game_version = GAME_VERSION_ACTUAL;
7557 level->creation_date = getCurrentDate();
7559 putFileChunkBE(file, "RND1", CHUNK_SIZE_UNDEFINED);
7560 putFileChunkBE(file, "CAVE", CHUNK_SIZE_NONE);
7562 chunk_size = SaveLevel_VERS(NULL, level);
7563 putFileChunkBE(file, "VERS", chunk_size);
7564 SaveLevel_VERS(file, level);
7566 chunk_size = SaveLevel_DATE(NULL, level);
7567 putFileChunkBE(file, "DATE", chunk_size);
7568 SaveLevel_DATE(file, level);
7570 chunk_size = SaveLevel_NAME(NULL, level);
7571 putFileChunkBE(file, "NAME", chunk_size);
7572 SaveLevel_NAME(file, level);
7574 chunk_size = SaveLevel_AUTH(NULL, level);
7575 putFileChunkBE(file, "AUTH", chunk_size);
7576 SaveLevel_AUTH(file, level);
7578 chunk_size = SaveLevel_INFO(NULL, level);
7579 putFileChunkBE(file, "INFO", chunk_size);
7580 SaveLevel_INFO(file, level);
7582 chunk_size = SaveLevel_BODY(NULL, level);
7583 putFileChunkBE(file, "BODY", chunk_size);
7584 SaveLevel_BODY(file, level);
7586 chunk_size = SaveLevel_ELEM(NULL, level);
7587 if (chunk_size > LEVEL_CHUNK_ELEM_UNCHANGED) // save if changed
7589 putFileChunkBE(file, "ELEM", chunk_size);
7590 SaveLevel_ELEM(file, level);
7593 for (i = 0; i < NUM_ENVELOPES; i++)
7595 int element = EL_ENVELOPE_1 + i;
7597 chunk_size = SaveLevel_NOTE(NULL, level, element);
7598 if (chunk_size > LEVEL_CHUNK_NOTE_UNCHANGED) // save if changed
7600 putFileChunkBE(file, "NOTE", chunk_size);
7601 SaveLevel_NOTE(file, level, element);
7605 // if not using template level, check for non-default custom/group elements
7606 if (!level->use_custom_template || save_as_template)
7608 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
7610 int element = EL_CUSTOM_START + i;
7612 chunk_size = SaveLevel_CUSX(NULL, level, element);
7613 if (chunk_size > LEVEL_CHUNK_CUSX_UNCHANGED) // save if changed
7615 putFileChunkBE(file, "CUSX", chunk_size);
7616 SaveLevel_CUSX(file, level, element);
7620 for (i = 0; i < NUM_GROUP_ELEMENTS; i++)
7622 int element = EL_GROUP_START + i;
7624 chunk_size = SaveLevel_GRPX(NULL, level, element);
7625 if (chunk_size > LEVEL_CHUNK_GRPX_UNCHANGED) // save if changed
7627 putFileChunkBE(file, "GRPX", chunk_size);
7628 SaveLevel_GRPX(file, level, element);
7635 SetFilePermissions(filename, PERMS_PRIVATE);
7638 void SaveLevel(int nr)
7640 char *filename = getDefaultLevelFilename(nr);
7642 SaveLevelFromFilename(&level, filename, FALSE);
7645 void SaveLevelTemplate(void)
7647 char *filename = getLocalLevelTemplateFilename();
7649 SaveLevelFromFilename(&level, filename, TRUE);
7652 boolean SaveLevelChecked(int nr)
7654 char *filename = getDefaultLevelFilename(nr);
7655 boolean new_level = !fileExists(filename);
7656 boolean level_saved = FALSE;
7658 if (new_level || Request("Save this level and kill the old?", REQ_ASK))
7663 Request("Level saved!", REQ_CONFIRM);
7671 void DumpLevel(struct LevelInfo *level)
7673 if (level->no_level_file || level->no_valid_file)
7675 Warn("cannot dump -- no valid level file found");
7681 Print("Level xxx (file version %08d, game version %08d)\n",
7682 level->file_version, level->game_version);
7685 Print("Level author: '%s'\n", level->author);
7686 Print("Level title: '%s'\n", level->name);
7688 Print("Playfield size: %d x %d\n", level->fieldx, level->fieldy);
7690 Print("Level time: %d seconds\n", level->time);
7691 Print("Gems needed: %d\n", level->gems_needed);
7693 Print("Time for magic wall: %d seconds\n", level->time_magic_wall);
7694 Print("Time for wheel: %d seconds\n", level->time_wheel);
7695 Print("Time for light: %d seconds\n", level->time_light);
7696 Print("Time for timegate: %d seconds\n", level->time_timegate);
7698 Print("Amoeba speed: %d\n", level->amoeba_speed);
7701 Print("EM style slippery gems: %s\n", (level->em_slippery_gems ? "yes" : "no"));
7702 Print("Player blocks last field: %s\n", (level->block_last_field ? "yes" : "no"));
7703 Print("SP player blocks last field: %s\n", (level->sp_block_last_field ? "yes" : "no"));
7704 Print("use spring bug: %s\n", (level->use_spring_bug ? "yes" : "no"));
7705 Print("use step counter: %s\n", (level->use_step_counter ? "yes" : "no"));
7706 Print("rate time over score: %s\n", (level->rate_time_over_score ? "yes" : "no"));
7711 void DumpLevels(void)
7713 static LevelDirTree *dumplevel_leveldir = NULL;
7715 dumplevel_leveldir = getTreeInfoFromIdentifier(leveldir_first,
7716 global.dumplevel_leveldir);
7718 if (dumplevel_leveldir == NULL)
7719 Fail("no such level identifier: '%s'", global.dumplevel_leveldir);
7721 if (global.dumplevel_level_nr < dumplevel_leveldir->first_level ||
7722 global.dumplevel_level_nr > dumplevel_leveldir->last_level)
7723 Fail("no such level number: %d", global.dumplevel_level_nr);
7725 leveldir_current = dumplevel_leveldir;
7727 LoadLevel(global.dumplevel_level_nr);
7734 // ============================================================================
7735 // tape file functions
7736 // ============================================================================
7738 static void setTapeInfoToDefaults(void)
7742 // always start with reliable default values (empty tape)
7745 // default values (also for pre-1.2 tapes) with only the first player
7746 tape.player_participates[0] = TRUE;
7747 for (i = 1; i < MAX_PLAYERS; i++)
7748 tape.player_participates[i] = FALSE;
7750 // at least one (default: the first) player participates in every tape
7751 tape.num_participating_players = 1;
7753 tape.property_bits = TAPE_PROPERTY_NONE;
7755 tape.level_nr = level_nr;
7757 tape.changed = FALSE;
7759 tape.recording = FALSE;
7760 tape.playing = FALSE;
7761 tape.pausing = FALSE;
7763 tape.scr_fieldx = SCR_FIELDX_DEFAULT;
7764 tape.scr_fieldy = SCR_FIELDY_DEFAULT;
7766 tape.no_info_chunk = TRUE;
7767 tape.no_valid_file = FALSE;
7770 static int getTapePosSize(struct TapeInfo *tape)
7772 int tape_pos_size = 0;
7774 if (tape->use_key_actions)
7775 tape_pos_size += tape->num_participating_players;
7777 if (tape->use_mouse_actions)
7778 tape_pos_size += 3; // x and y position and mouse button mask
7780 tape_pos_size += 1; // tape action delay value
7782 return tape_pos_size;
7785 static void setTapeActionFlags(struct TapeInfo *tape, int value)
7787 tape->use_key_actions = FALSE;
7788 tape->use_mouse_actions = FALSE;
7790 if (value != TAPE_USE_MOUSE_ACTIONS_ONLY)
7791 tape->use_key_actions = TRUE;
7793 if (value != TAPE_USE_KEY_ACTIONS_ONLY)
7794 tape->use_mouse_actions = TRUE;
7797 static int getTapeActionValue(struct TapeInfo *tape)
7799 return (tape->use_key_actions &&
7800 tape->use_mouse_actions ? TAPE_USE_KEY_AND_MOUSE_ACTIONS :
7801 tape->use_key_actions ? TAPE_USE_KEY_ACTIONS_ONLY :
7802 tape->use_mouse_actions ? TAPE_USE_MOUSE_ACTIONS_ONLY :
7803 TAPE_ACTIONS_DEFAULT);
7806 static int LoadTape_VERS(File *file, int chunk_size, struct TapeInfo *tape)
7808 tape->file_version = getFileVersion(file);
7809 tape->game_version = getFileVersion(file);
7814 static int LoadTape_HEAD(File *file, int chunk_size, struct TapeInfo *tape)
7818 tape->random_seed = getFile32BitBE(file);
7819 tape->date = getFile32BitBE(file);
7820 tape->length = getFile32BitBE(file);
7822 // read header fields that are new since version 1.2
7823 if (tape->file_version >= FILE_VERSION_1_2)
7825 byte store_participating_players = getFile8Bit(file);
7828 // since version 1.2, tapes store which players participate in the tape
7829 tape->num_participating_players = 0;
7830 for (i = 0; i < MAX_PLAYERS; i++)
7832 tape->player_participates[i] = FALSE;
7834 if (store_participating_players & (1 << i))
7836 tape->player_participates[i] = TRUE;
7837 tape->num_participating_players++;
7841 setTapeActionFlags(tape, getFile8Bit(file));
7843 tape->property_bits = getFile8Bit(file);
7845 ReadUnusedBytesFromFile(file, TAPE_CHUNK_HEAD_UNUSED);
7847 engine_version = getFileVersion(file);
7848 if (engine_version > 0)
7849 tape->engine_version = engine_version;
7851 tape->engine_version = tape->game_version;
7857 static int LoadTape_SCRN(File *file, int chunk_size, struct TapeInfo *tape)
7859 tape->scr_fieldx = getFile8Bit(file);
7860 tape->scr_fieldy = getFile8Bit(file);
7865 static int LoadTape_INFO(File *file, int chunk_size, struct TapeInfo *tape)
7867 char *level_identifier = NULL;
7868 int level_identifier_size;
7871 tape->no_info_chunk = FALSE;
7873 level_identifier_size = getFile16BitBE(file);
7875 level_identifier = checked_malloc(level_identifier_size);
7877 for (i = 0; i < level_identifier_size; i++)
7878 level_identifier[i] = getFile8Bit(file);
7880 strncpy(tape->level_identifier, level_identifier, MAX_FILENAME_LEN);
7881 tape->level_identifier[MAX_FILENAME_LEN] = '\0';
7883 checked_free(level_identifier);
7885 tape->level_nr = getFile16BitBE(file);
7887 chunk_size = 2 + level_identifier_size + 2;
7892 static int LoadTape_BODY(File *file, int chunk_size, struct TapeInfo *tape)
7895 int tape_pos_size = getTapePosSize(tape);
7896 int chunk_size_expected = tape_pos_size * tape->length;
7898 if (chunk_size_expected != chunk_size)
7900 ReadUnusedBytesFromFile(file, chunk_size);
7901 return chunk_size_expected;
7904 for (i = 0; i < tape->length; i++)
7906 if (i >= MAX_TAPE_LEN)
7908 Warn("tape truncated -- size exceeds maximum tape size %d",
7911 // tape too large; read and ignore remaining tape data from this chunk
7912 for (;i < tape->length; i++)
7913 ReadUnusedBytesFromFile(file, tape_pos_size);
7918 if (tape->use_key_actions)
7920 for (j = 0; j < MAX_PLAYERS; j++)
7922 tape->pos[i].action[j] = MV_NONE;
7924 if (tape->player_participates[j])
7925 tape->pos[i].action[j] = getFile8Bit(file);
7929 if (tape->use_mouse_actions)
7931 tape->pos[i].action[TAPE_ACTION_LX] = getFile8Bit(file);
7932 tape->pos[i].action[TAPE_ACTION_LY] = getFile8Bit(file);
7933 tape->pos[i].action[TAPE_ACTION_BUTTON] = getFile8Bit(file);
7936 tape->pos[i].delay = getFile8Bit(file);
7938 if (tape->file_version == FILE_VERSION_1_0)
7940 // eliminate possible diagonal moves in old tapes
7941 // this is only for backward compatibility
7943 byte joy_dir[4] = { JOY_LEFT, JOY_RIGHT, JOY_UP, JOY_DOWN };
7944 byte action = tape->pos[i].action[0];
7945 int k, num_moves = 0;
7947 for (k = 0; k<4; k++)
7949 if (action & joy_dir[k])
7951 tape->pos[i + num_moves].action[0] = joy_dir[k];
7953 tape->pos[i + num_moves].delay = 0;
7962 tape->length += num_moves;
7965 else if (tape->file_version < FILE_VERSION_2_0)
7967 // convert pre-2.0 tapes to new tape format
7969 if (tape->pos[i].delay > 1)
7972 tape->pos[i + 1] = tape->pos[i];
7973 tape->pos[i + 1].delay = 1;
7976 for (j = 0; j < MAX_PLAYERS; j++)
7977 tape->pos[i].action[j] = MV_NONE;
7978 tape->pos[i].delay--;
7985 if (checkEndOfFile(file))
7989 if (i != tape->length)
7990 chunk_size = tape_pos_size * i;
7995 static void LoadTape_SokobanSolution(char *filename)
7998 int move_delay = TILESIZE / level.initial_player_stepsize[0];
8000 if (!(file = openFile(filename, MODE_READ)))
8002 tape.no_valid_file = TRUE;
8007 while (!checkEndOfFile(file))
8009 unsigned char c = getByteFromFile(file);
8011 if (checkEndOfFile(file))
8018 tape.pos[tape.length].action[0] = MV_UP;
8019 tape.pos[tape.length].delay = move_delay + (c < 'a' ? 2 : 0);
8025 tape.pos[tape.length].action[0] = MV_DOWN;
8026 tape.pos[tape.length].delay = move_delay + (c < 'a' ? 2 : 0);
8032 tape.pos[tape.length].action[0] = MV_LEFT;
8033 tape.pos[tape.length].delay = move_delay + (c < 'a' ? 2 : 0);
8039 tape.pos[tape.length].action[0] = MV_RIGHT;
8040 tape.pos[tape.length].delay = move_delay + (c < 'a' ? 2 : 0);
8048 // ignore white-space characters
8052 tape.no_valid_file = TRUE;
8054 Warn("unsupported Sokoban solution file '%s' ['%d']", filename, c);
8062 if (tape.no_valid_file)
8065 tape.length_frames = GetTapeLengthFrames();
8066 tape.length_seconds = GetTapeLengthSeconds();
8069 void LoadTapeFromFilename(char *filename)
8071 char cookie[MAX_LINE_LEN];
8072 char chunk_name[CHUNK_ID_LEN + 1];
8076 // always start with reliable default values
8077 setTapeInfoToDefaults();
8079 if (strSuffix(filename, ".sln"))
8081 LoadTape_SokobanSolution(filename);
8086 if (!(file = openFile(filename, MODE_READ)))
8088 tape.no_valid_file = TRUE;
8093 getFileChunkBE(file, chunk_name, NULL);
8094 if (strEqual(chunk_name, "RND1"))
8096 getFile32BitBE(file); // not used
8098 getFileChunkBE(file, chunk_name, NULL);
8099 if (!strEqual(chunk_name, "TAPE"))
8101 tape.no_valid_file = TRUE;
8103 Warn("unknown format of tape file '%s'", filename);
8110 else // check for pre-2.0 file format with cookie string
8112 strcpy(cookie, chunk_name);
8113 if (getStringFromFile(file, &cookie[4], MAX_LINE_LEN - 4) == NULL)
8115 if (strlen(cookie) > 0 && cookie[strlen(cookie) - 1] == '\n')
8116 cookie[strlen(cookie) - 1] = '\0';
8118 if (!checkCookieString(cookie, TAPE_COOKIE_TMPL))
8120 tape.no_valid_file = TRUE;
8122 Warn("unknown format of tape file '%s'", filename);
8129 if ((tape.file_version = getFileVersionFromCookieString(cookie)) == -1)
8131 tape.no_valid_file = TRUE;
8133 Warn("unsupported version of tape file '%s'", filename);
8140 // pre-2.0 tape files have no game version, so use file version here
8141 tape.game_version = tape.file_version;
8144 if (tape.file_version < FILE_VERSION_1_2)
8146 // tape files from versions before 1.2.0 without chunk structure
8147 LoadTape_HEAD(file, TAPE_CHUNK_HEAD_SIZE, &tape);
8148 LoadTape_BODY(file, 2 * tape.length, &tape);
8156 int (*loader)(File *, int, struct TapeInfo *);
8160 { "VERS", TAPE_CHUNK_VERS_SIZE, LoadTape_VERS },
8161 { "HEAD", TAPE_CHUNK_HEAD_SIZE, LoadTape_HEAD },
8162 { "SCRN", TAPE_CHUNK_SCRN_SIZE, LoadTape_SCRN },
8163 { "INFO", -1, LoadTape_INFO },
8164 { "BODY", -1, LoadTape_BODY },
8168 while (getFileChunkBE(file, chunk_name, &chunk_size))
8172 while (chunk_info[i].name != NULL &&
8173 !strEqual(chunk_name, chunk_info[i].name))
8176 if (chunk_info[i].name == NULL)
8178 Warn("unknown chunk '%s' in tape file '%s'",
8179 chunk_name, filename);
8181 ReadUnusedBytesFromFile(file, chunk_size);
8183 else if (chunk_info[i].size != -1 &&
8184 chunk_info[i].size != chunk_size)
8186 Warn("wrong size (%d) of chunk '%s' in tape file '%s'",
8187 chunk_size, chunk_name, filename);
8189 ReadUnusedBytesFromFile(file, chunk_size);
8193 // call function to load this tape chunk
8194 int chunk_size_expected =
8195 (chunk_info[i].loader)(file, chunk_size, &tape);
8197 // the size of some chunks cannot be checked before reading other
8198 // chunks first (like "HEAD" and "BODY") that contain some header
8199 // information, so check them here
8200 if (chunk_size_expected != chunk_size)
8202 Warn("wrong size (%d) of chunk '%s' in tape file '%s'",
8203 chunk_size, chunk_name, filename);
8211 tape.length_frames = GetTapeLengthFrames();
8212 tape.length_seconds = GetTapeLengthSeconds();
8215 Debug("files:LoadTapeFromFilename", "tape file version: %d",
8217 Debug("files:LoadTapeFromFilename", "tape game version: %d",
8219 Debug("files:LoadTapeFromFilename", "tape engine version: %d",
8220 tape.engine_version);
8224 void LoadTape(int nr)
8226 char *filename = getTapeFilename(nr);
8228 LoadTapeFromFilename(filename);
8231 void LoadSolutionTape(int nr)
8233 char *filename = getSolutionTapeFilename(nr);
8235 LoadTapeFromFilename(filename);
8237 if (TAPE_IS_EMPTY(tape) &&
8238 level.game_engine_type == GAME_ENGINE_TYPE_SP &&
8239 level.native_sp_level->demo.is_available)
8240 CopyNativeTape_SP_to_RND(&level);
8243 static boolean checkSaveTape_SCRN(struct TapeInfo *tape)
8245 // chunk required for team mode tapes with non-default screen size
8246 return (tape->num_participating_players > 1 &&
8247 (tape->scr_fieldx != SCR_FIELDX_DEFAULT ||
8248 tape->scr_fieldy != SCR_FIELDY_DEFAULT));
8251 static void SaveTape_VERS(FILE *file, struct TapeInfo *tape)
8253 putFileVersion(file, tape->file_version);
8254 putFileVersion(file, tape->game_version);
8257 static void SaveTape_HEAD(FILE *file, struct TapeInfo *tape)
8260 byte store_participating_players = 0;
8262 // set bits for participating players for compact storage
8263 for (i = 0; i < MAX_PLAYERS; i++)
8264 if (tape->player_participates[i])
8265 store_participating_players |= (1 << i);
8267 putFile32BitBE(file, tape->random_seed);
8268 putFile32BitBE(file, tape->date);
8269 putFile32BitBE(file, tape->length);
8271 putFile8Bit(file, store_participating_players);
8273 putFile8Bit(file, getTapeActionValue(tape));
8275 putFile8Bit(file, tape->property_bits);
8277 // unused bytes not at the end here for 4-byte alignment of engine_version
8278 WriteUnusedBytesToFile(file, TAPE_CHUNK_HEAD_UNUSED);
8280 putFileVersion(file, tape->engine_version);
8283 static void SaveTape_SCRN(FILE *file, struct TapeInfo *tape)
8285 putFile8Bit(file, tape->scr_fieldx);
8286 putFile8Bit(file, tape->scr_fieldy);
8289 static void SaveTape_INFO(FILE *file, struct TapeInfo *tape)
8291 int level_identifier_size = strlen(tape->level_identifier) + 1;
8294 putFile16BitBE(file, level_identifier_size);
8296 for (i = 0; i < level_identifier_size; i++)
8297 putFile8Bit(file, tape->level_identifier[i]);
8299 putFile16BitBE(file, tape->level_nr);
8302 static void SaveTape_BODY(FILE *file, struct TapeInfo *tape)
8306 for (i = 0; i < tape->length; i++)
8308 if (tape->use_key_actions)
8310 for (j = 0; j < MAX_PLAYERS; j++)
8311 if (tape->player_participates[j])
8312 putFile8Bit(file, tape->pos[i].action[j]);
8315 if (tape->use_mouse_actions)
8317 putFile8Bit(file, tape->pos[i].action[TAPE_ACTION_LX]);
8318 putFile8Bit(file, tape->pos[i].action[TAPE_ACTION_LY]);
8319 putFile8Bit(file, tape->pos[i].action[TAPE_ACTION_BUTTON]);
8322 putFile8Bit(file, tape->pos[i].delay);
8326 void SaveTapeToFilename(char *filename)
8330 int info_chunk_size;
8331 int body_chunk_size;
8333 if (!(file = fopen(filename, MODE_WRITE)))
8335 Warn("cannot save level recording file '%s'", filename);
8340 tape_pos_size = getTapePosSize(&tape);
8342 info_chunk_size = 2 + (strlen(tape.level_identifier) + 1) + 2;
8343 body_chunk_size = tape_pos_size * tape.length;
8345 putFileChunkBE(file, "RND1", CHUNK_SIZE_UNDEFINED);
8346 putFileChunkBE(file, "TAPE", CHUNK_SIZE_NONE);
8348 putFileChunkBE(file, "VERS", TAPE_CHUNK_VERS_SIZE);
8349 SaveTape_VERS(file, &tape);
8351 putFileChunkBE(file, "HEAD", TAPE_CHUNK_HEAD_SIZE);
8352 SaveTape_HEAD(file, &tape);
8354 if (checkSaveTape_SCRN(&tape))
8356 putFileChunkBE(file, "SCRN", TAPE_CHUNK_SCRN_SIZE);
8357 SaveTape_SCRN(file, &tape);
8360 putFileChunkBE(file, "INFO", info_chunk_size);
8361 SaveTape_INFO(file, &tape);
8363 putFileChunkBE(file, "BODY", body_chunk_size);
8364 SaveTape_BODY(file, &tape);
8368 SetFilePermissions(filename, PERMS_PRIVATE);
8371 static void SaveTapeExt(char *filename)
8375 tape.file_version = FILE_VERSION_ACTUAL;
8376 tape.game_version = GAME_VERSION_ACTUAL;
8378 tape.num_participating_players = 0;
8380 // count number of participating players
8381 for (i = 0; i < MAX_PLAYERS; i++)
8382 if (tape.player_participates[i])
8383 tape.num_participating_players++;
8385 SaveTapeToFilename(filename);
8387 tape.changed = FALSE;
8390 void SaveTape(int nr)
8392 char *filename = getTapeFilename(nr);
8394 InitTapeDirectory(leveldir_current->subdir);
8396 SaveTapeExt(filename);
8399 void SaveScoreTape(int nr)
8401 char *filename = getScoreTapeFilename(tape.score_tape_basename, nr);
8403 // used instead of "leveldir_current->subdir" (for network games)
8404 InitScoreTapeDirectory(levelset.identifier, nr);
8406 SaveTapeExt(filename);
8409 static boolean SaveTapeCheckedExt(int nr, char *msg_replace, char *msg_saved,
8410 unsigned int req_state_added)
8412 char *filename = getTapeFilename(nr);
8413 boolean new_tape = !fileExists(filename);
8414 boolean tape_saved = FALSE;
8416 if (new_tape || Request(msg_replace, REQ_ASK | req_state_added))
8421 Request(msg_saved, REQ_CONFIRM | req_state_added);
8429 boolean SaveTapeChecked(int nr)
8431 return SaveTapeCheckedExt(nr, "Replace old tape?", "Tape saved!", 0);
8434 boolean SaveTapeChecked_LevelSolved(int nr)
8436 return SaveTapeCheckedExt(nr, "Level solved! Replace old tape?",
8437 "Level solved! Tape saved!", REQ_STAY_OPEN);
8440 void DumpTape(struct TapeInfo *tape)
8442 int tape_frame_counter;
8445 if (tape->no_valid_file)
8447 Warn("cannot dump -- no valid tape file found");
8454 Print("Tape of Level %03d (file version %08d, game version %08d)\n",
8455 tape->level_nr, tape->file_version, tape->game_version);
8456 Print(" (effective engine version %08d)\n",
8457 tape->engine_version);
8458 Print("Level series identifier: '%s'\n", tape->level_identifier);
8460 Print("Special tape properties: ");
8461 if (tape->property_bits == TAPE_PROPERTY_NONE)
8463 if (tape->property_bits & TAPE_PROPERTY_EM_RANDOM_BUG)
8464 Print("[em_random_bug]");
8465 if (tape->property_bits & TAPE_PROPERTY_GAME_SPEED)
8466 Print("[game_speed]");
8467 if (tape->property_bits & TAPE_PROPERTY_PAUSE_MODE)
8469 if (tape->property_bits & TAPE_PROPERTY_SINGLE_STEP)
8470 Print("[single_step]");
8471 if (tape->property_bits & TAPE_PROPERTY_SNAPSHOT)
8472 Print("[snapshot]");
8473 if (tape->property_bits & TAPE_PROPERTY_REPLAYED)
8474 Print("[replayed]");
8475 if (tape->property_bits & TAPE_PROPERTY_TAS_KEYS)
8476 Print("[tas_keys]");
8477 if (tape->property_bits & TAPE_PROPERTY_SMALL_GRAPHICS)
8478 Print("[small_graphics]");
8481 int year2 = tape->date / 10000;
8482 int year4 = (year2 < 70 ? 2000 + year2 : 1900 + year2);
8483 int month_index_raw = (tape->date / 100) % 100;
8484 int month_index = month_index_raw % 12; // prevent invalid index
8485 int month = month_index + 1;
8486 int day = tape->date % 100;
8488 Print("Tape date: %04d-%02d-%02d\n", year4, month, day);
8492 tape_frame_counter = 0;
8494 for (i = 0; i < tape->length; i++)
8496 if (i >= MAX_TAPE_LEN)
8501 for (j = 0; j < MAX_PLAYERS; j++)
8503 if (tape->player_participates[j])
8505 int action = tape->pos[i].action[j];
8507 Print("%d:%02x ", j, action);
8508 Print("[%c%c%c%c|%c%c] - ",
8509 (action & JOY_LEFT ? '<' : ' '),
8510 (action & JOY_RIGHT ? '>' : ' '),
8511 (action & JOY_UP ? '^' : ' '),
8512 (action & JOY_DOWN ? 'v' : ' '),
8513 (action & JOY_BUTTON_1 ? '1' : ' '),
8514 (action & JOY_BUTTON_2 ? '2' : ' '));
8518 Print("(%03d) ", tape->pos[i].delay);
8519 Print("[%05d]\n", tape_frame_counter);
8521 tape_frame_counter += tape->pos[i].delay;
8527 void DumpTapes(void)
8529 static LevelDirTree *dumptape_leveldir = NULL;
8531 dumptape_leveldir = getTreeInfoFromIdentifier(leveldir_first,
8532 global.dumptape_leveldir);
8534 if (dumptape_leveldir == NULL)
8535 Fail("no such level identifier: '%s'", global.dumptape_leveldir);
8537 if (global.dumptape_level_nr < dumptape_leveldir->first_level ||
8538 global.dumptape_level_nr > dumptape_leveldir->last_level)
8539 Fail("no such level number: %d", global.dumptape_level_nr);
8541 leveldir_current = dumptape_leveldir;
8543 if (options.mytapes)
8544 LoadTape(global.dumptape_level_nr);
8546 LoadSolutionTape(global.dumptape_level_nr);
8554 // ============================================================================
8555 // score file functions
8556 // ============================================================================
8558 static void setScoreInfoToDefaultsExt(struct ScoreInfo *scores)
8562 for (i = 0; i < MAX_SCORE_ENTRIES; i++)
8564 strcpy(scores->entry[i].tape_basename, UNDEFINED_FILENAME);
8565 strcpy(scores->entry[i].name, EMPTY_PLAYER_NAME);
8566 scores->entry[i].score = 0;
8567 scores->entry[i].time = 0;
8570 scores->num_entries = 0;
8571 scores->last_added = -1;
8572 scores->last_added_local = -1;
8574 scores->updated = FALSE;
8575 scores->uploaded = FALSE;
8576 scores->force_last_added = FALSE;
8579 static void setScoreInfoToDefaults(void)
8581 setScoreInfoToDefaultsExt(&scores);
8584 static void setServerScoreInfoToDefaults(void)
8586 setScoreInfoToDefaultsExt(&server_scores);
8589 static void LoadScore_OLD(int nr)
8592 char *filename = getScoreFilename(nr);
8593 char cookie[MAX_LINE_LEN];
8594 char line[MAX_LINE_LEN];
8598 if (!(file = fopen(filename, MODE_READ)))
8601 // check file identifier
8602 if (fgets(cookie, MAX_LINE_LEN, file) == NULL)
8604 if (strlen(cookie) > 0 && cookie[strlen(cookie) - 1] == '\n')
8605 cookie[strlen(cookie) - 1] = '\0';
8607 if (!checkCookieString(cookie, SCORE_COOKIE_TMPL))
8609 Warn("unknown format of score file '%s'", filename);
8616 for (i = 0; i < MAX_SCORE_ENTRIES; i++)
8618 if (fscanf(file, "%d", &scores.entry[i].score) == EOF)
8619 Warn("fscanf() failed; %s", strerror(errno));
8621 if (fgets(line, MAX_LINE_LEN, file) == NULL)
8624 if (strlen(line) > 0 && line[strlen(line) - 1] == '\n')
8625 line[strlen(line) - 1] = '\0';
8627 for (line_ptr = line; *line_ptr; line_ptr++)
8629 if (*line_ptr != ' ' && *line_ptr != '\t' && *line_ptr != '\0')
8631 strncpy(scores.entry[i].name, line_ptr, MAX_PLAYER_NAME_LEN);
8632 scores.entry[i].name[MAX_PLAYER_NAME_LEN] = '\0';
8641 static void ConvertScore_OLD(void)
8643 // only convert score to time for levels that rate playing time over score
8644 if (!level.rate_time_over_score)
8647 // convert old score to playing time for score-less levels (like Supaplex)
8648 int time_final_max = 999;
8651 for (i = 0; i < MAX_SCORE_ENTRIES; i++)
8653 int score = scores.entry[i].score;
8655 if (score > 0 && score < time_final_max)
8656 scores.entry[i].time = (time_final_max - score - 1) * FRAMES_PER_SECOND;
8660 static int LoadScore_VERS(File *file, int chunk_size, struct ScoreInfo *scores)
8662 scores->file_version = getFileVersion(file);
8663 scores->game_version = getFileVersion(file);
8668 static int LoadScore_INFO(File *file, int chunk_size, struct ScoreInfo *scores)
8670 char *level_identifier = NULL;
8671 int level_identifier_size;
8674 level_identifier_size = getFile16BitBE(file);
8676 level_identifier = checked_malloc(level_identifier_size);
8678 for (i = 0; i < level_identifier_size; i++)
8679 level_identifier[i] = getFile8Bit(file);
8681 strncpy(scores->level_identifier, level_identifier, MAX_FILENAME_LEN);
8682 scores->level_identifier[MAX_FILENAME_LEN] = '\0';
8684 checked_free(level_identifier);
8686 scores->level_nr = getFile16BitBE(file);
8687 scores->num_entries = getFile16BitBE(file);
8689 chunk_size = 2 + level_identifier_size + 2 + 2;
8694 static int LoadScore_NAME(File *file, int chunk_size, struct ScoreInfo *scores)
8698 for (i = 0; i < scores->num_entries; i++)
8700 for (j = 0; j < MAX_PLAYER_NAME_LEN; j++)
8701 scores->entry[i].name[j] = getFile8Bit(file);
8703 scores->entry[i].name[MAX_PLAYER_NAME_LEN] = '\0';
8706 chunk_size = scores->num_entries * MAX_PLAYER_NAME_LEN;
8711 static int LoadScore_SCOR(File *file, int chunk_size, struct ScoreInfo *scores)
8715 for (i = 0; i < scores->num_entries; i++)
8716 scores->entry[i].score = getFile16BitBE(file);
8718 chunk_size = scores->num_entries * 2;
8723 static int LoadScore_TIME(File *file, int chunk_size, struct ScoreInfo *scores)
8727 for (i = 0; i < scores->num_entries; i++)
8728 scores->entry[i].time = getFile32BitBE(file);
8730 chunk_size = scores->num_entries * 4;
8735 static int LoadScore_TAPE(File *file, int chunk_size, struct ScoreInfo *scores)
8739 for (i = 0; i < scores->num_entries; i++)
8741 for (j = 0; j < MAX_SCORE_TAPE_BASENAME_LEN; j++)
8742 scores->entry[i].tape_basename[j] = getFile8Bit(file);
8744 scores->entry[i].tape_basename[MAX_SCORE_TAPE_BASENAME_LEN] = '\0';
8747 chunk_size = scores->num_entries * MAX_SCORE_TAPE_BASENAME_LEN;
8752 void LoadScore(int nr)
8754 char *filename = getScoreFilename(nr);
8755 char cookie[MAX_LINE_LEN];
8756 char chunk_name[CHUNK_ID_LEN + 1];
8758 boolean old_score_file_format = FALSE;
8761 // always start with reliable default values
8762 setScoreInfoToDefaults();
8764 if (!(file = openFile(filename, MODE_READ)))
8767 getFileChunkBE(file, chunk_name, NULL);
8768 if (strEqual(chunk_name, "RND1"))
8770 getFile32BitBE(file); // not used
8772 getFileChunkBE(file, chunk_name, NULL);
8773 if (!strEqual(chunk_name, "SCOR"))
8775 Warn("unknown format of score file '%s'", filename);
8782 else // check for old file format with cookie string
8784 strcpy(cookie, chunk_name);
8785 if (getStringFromFile(file, &cookie[4], MAX_LINE_LEN - 4) == NULL)
8787 if (strlen(cookie) > 0 && cookie[strlen(cookie) - 1] == '\n')
8788 cookie[strlen(cookie) - 1] = '\0';
8790 if (!checkCookieString(cookie, SCORE_COOKIE_TMPL))
8792 Warn("unknown format of score file '%s'", filename);
8799 old_score_file_format = TRUE;
8802 if (old_score_file_format)
8804 // score files from versions before 4.2.4.0 without chunk structure
8807 // convert score to time, if possible (mainly for Supaplex levels)
8816 int (*loader)(File *, int, struct ScoreInfo *);
8820 { "VERS", SCORE_CHUNK_VERS_SIZE, LoadScore_VERS },
8821 { "INFO", -1, LoadScore_INFO },
8822 { "NAME", -1, LoadScore_NAME },
8823 { "SCOR", -1, LoadScore_SCOR },
8824 { "TIME", -1, LoadScore_TIME },
8825 { "TAPE", -1, LoadScore_TAPE },
8830 while (getFileChunkBE(file, chunk_name, &chunk_size))
8834 while (chunk_info[i].name != NULL &&
8835 !strEqual(chunk_name, chunk_info[i].name))
8838 if (chunk_info[i].name == NULL)
8840 Warn("unknown chunk '%s' in score file '%s'",
8841 chunk_name, filename);
8843 ReadUnusedBytesFromFile(file, chunk_size);
8845 else if (chunk_info[i].size != -1 &&
8846 chunk_info[i].size != chunk_size)
8848 Warn("wrong size (%d) of chunk '%s' in score file '%s'",
8849 chunk_size, chunk_name, filename);
8851 ReadUnusedBytesFromFile(file, chunk_size);
8855 // call function to load this score chunk
8856 int chunk_size_expected =
8857 (chunk_info[i].loader)(file, chunk_size, &scores);
8859 // the size of some chunks cannot be checked before reading other
8860 // chunks first (like "HEAD" and "BODY") that contain some header
8861 // information, so check them here
8862 if (chunk_size_expected != chunk_size)
8864 Warn("wrong size (%d) of chunk '%s' in score file '%s'",
8865 chunk_size, chunk_name, filename);
8874 #if ENABLE_HISTORIC_CHUNKS
8875 void SaveScore_OLD(int nr)
8878 char *filename = getScoreFilename(nr);
8881 // used instead of "leveldir_current->subdir" (for network games)
8882 InitScoreDirectory(levelset.identifier);
8884 if (!(file = fopen(filename, MODE_WRITE)))
8886 Warn("cannot save score for level %d", nr);
8891 fprintf(file, "%s\n\n", SCORE_COOKIE);
8893 for (i = 0; i < MAX_SCORE_ENTRIES; i++)
8894 fprintf(file, "%d %s\n", scores.entry[i].score, scores.entry[i].name);
8898 SetFilePermissions(filename, PERMS_PRIVATE);
8902 static void SaveScore_VERS(FILE *file, struct ScoreInfo *scores)
8904 putFileVersion(file, scores->file_version);
8905 putFileVersion(file, scores->game_version);
8908 static void SaveScore_INFO(FILE *file, struct ScoreInfo *scores)
8910 int level_identifier_size = strlen(scores->level_identifier) + 1;
8913 putFile16BitBE(file, level_identifier_size);
8915 for (i = 0; i < level_identifier_size; i++)
8916 putFile8Bit(file, scores->level_identifier[i]);
8918 putFile16BitBE(file, scores->level_nr);
8919 putFile16BitBE(file, scores->num_entries);
8922 static void SaveScore_NAME(FILE *file, struct ScoreInfo *scores)
8926 for (i = 0; i < scores->num_entries; i++)
8928 int name_size = strlen(scores->entry[i].name);
8930 for (j = 0; j < MAX_PLAYER_NAME_LEN; j++)
8931 putFile8Bit(file, (j < name_size ? scores->entry[i].name[j] : 0));
8935 static void SaveScore_SCOR(FILE *file, struct ScoreInfo *scores)
8939 for (i = 0; i < scores->num_entries; i++)
8940 putFile16BitBE(file, scores->entry[i].score);
8943 static void SaveScore_TIME(FILE *file, struct ScoreInfo *scores)
8947 for (i = 0; i < scores->num_entries; i++)
8948 putFile32BitBE(file, scores->entry[i].time);
8951 static void SaveScore_TAPE(FILE *file, struct ScoreInfo *scores)
8955 for (i = 0; i < scores->num_entries; i++)
8957 int size = strlen(scores->entry[i].tape_basename);
8959 for (j = 0; j < MAX_SCORE_TAPE_BASENAME_LEN; j++)
8960 putFile8Bit(file, (j < size ? scores->entry[i].tape_basename[j] : 0));
8964 static void SaveScoreToFilename(char *filename)
8967 int info_chunk_size;
8968 int name_chunk_size;
8969 int scor_chunk_size;
8970 int time_chunk_size;
8971 int tape_chunk_size;
8973 if (!(file = fopen(filename, MODE_WRITE)))
8975 Warn("cannot save score file '%s'", filename);
8980 info_chunk_size = 2 + (strlen(scores.level_identifier) + 1) + 2 + 2;
8981 name_chunk_size = scores.num_entries * MAX_PLAYER_NAME_LEN;
8982 scor_chunk_size = scores.num_entries * 2;
8983 time_chunk_size = scores.num_entries * 4;
8984 tape_chunk_size = scores.num_entries * MAX_SCORE_TAPE_BASENAME_LEN;
8986 putFileChunkBE(file, "RND1", CHUNK_SIZE_UNDEFINED);
8987 putFileChunkBE(file, "SCOR", CHUNK_SIZE_NONE);
8989 putFileChunkBE(file, "VERS", SCORE_CHUNK_VERS_SIZE);
8990 SaveScore_VERS(file, &scores);
8992 putFileChunkBE(file, "INFO", info_chunk_size);
8993 SaveScore_INFO(file, &scores);
8995 putFileChunkBE(file, "NAME", name_chunk_size);
8996 SaveScore_NAME(file, &scores);
8998 putFileChunkBE(file, "SCOR", scor_chunk_size);
8999 SaveScore_SCOR(file, &scores);
9001 putFileChunkBE(file, "TIME", time_chunk_size);
9002 SaveScore_TIME(file, &scores);
9004 putFileChunkBE(file, "TAPE", tape_chunk_size);
9005 SaveScore_TAPE(file, &scores);
9009 SetFilePermissions(filename, PERMS_PRIVATE);
9012 void SaveScore(int nr)
9014 char *filename = getScoreFilename(nr);
9017 // used instead of "leveldir_current->subdir" (for network games)
9018 InitScoreDirectory(levelset.identifier);
9020 scores.file_version = FILE_VERSION_ACTUAL;
9021 scores.game_version = GAME_VERSION_ACTUAL;
9023 strncpy(scores.level_identifier, levelset.identifier, MAX_FILENAME_LEN);
9024 scores.level_identifier[MAX_FILENAME_LEN] = '\0';
9025 scores.level_nr = level_nr;
9027 for (i = 0; i < MAX_SCORE_ENTRIES; i++)
9028 if (scores.entry[i].score == 0 &&
9029 scores.entry[i].time == 0 &&
9030 strEqual(scores.entry[i].name, EMPTY_PLAYER_NAME))
9033 scores.num_entries = i;
9035 if (scores.num_entries == 0)
9038 SaveScoreToFilename(filename);
9041 void ExecuteAsThread(SDL_ThreadFunction function, char *name, void *data,
9044 #if defined(PLATFORM_EMSCRIPTEN)
9045 // threads currently not fully supported by Emscripten/SDL and some browsers
9048 SDL_Thread *thread = SDL_CreateThread(function, name, data);
9051 SDL_DetachThread(thread);
9053 Error("Cannot create thread to %s!", error);
9055 // nasty kludge to lower probability of intermingled thread error messages
9060 char *getPasswordJSON(char *password)
9062 static char password_json[MAX_FILENAME_LEN] = "";
9063 static boolean initialized = FALSE;
9067 if (password != NULL &&
9068 !strEqual(password, "") &&
9069 !strEqual(password, UNDEFINED_PASSWORD))
9070 snprintf(password_json, MAX_FILENAME_LEN,
9071 " \"password\": \"%s\",\n",
9072 setup.api_server_password);
9077 return password_json;
9080 struct ApiGetScoreThreadData
9083 char *score_cache_filename;
9086 static void *CreateThreadData_ApiGetScore(int nr)
9088 struct ApiGetScoreThreadData *data =
9089 checked_malloc(sizeof(struct ApiGetScoreThreadData));
9090 char *score_cache_filename = getScoreCacheFilename(nr);
9092 data->level_nr = nr;
9093 data->score_cache_filename = getStringCopy(score_cache_filename);
9098 static void FreeThreadData_ApiGetScore(void *data_raw)
9100 struct ApiGetScoreThreadData *data = data_raw;
9102 checked_free(data->score_cache_filename);
9106 static boolean SetRequest_ApiGetScore(struct HttpRequest *request,
9109 struct ApiGetScoreThreadData *data = data_raw;
9110 int level_nr = data->level_nr;
9112 request->hostname = setup.api_server_hostname;
9113 request->port = API_SERVER_PORT;
9114 request->method = API_SERVER_METHOD;
9115 request->uri = API_SERVER_URI_GET;
9117 char *levelset_identifier = getEscapedJSON(leveldir_current->identifier);
9118 char *levelset_name = getEscapedJSON(leveldir_current->name);
9120 snprintf(request->body, MAX_HTTP_BODY_SIZE,
9123 " \"game_version\": \"%s\",\n"
9124 " \"game_platform\": \"%s\",\n"
9125 " \"levelset_identifier\": \"%s\",\n"
9126 " \"levelset_name\": \"%s\",\n"
9127 " \"level_nr\": \"%d\"\n"
9129 getPasswordJSON(setup.api_server_password),
9130 getProgramRealVersionString(),
9131 getProgramPlatformString(),
9132 levelset_identifier,
9136 checked_free(levelset_identifier);
9137 checked_free(levelset_name);
9139 ConvertHttpRequestBodyToServerEncoding(request);
9144 static void HandleResponse_ApiGetScore(struct HttpResponse *response,
9147 struct ApiGetScoreThreadData *data = data_raw;
9149 if (response->body_size == 0)
9151 // no scores available for this level
9156 ConvertHttpResponseBodyToClientEncoding(response);
9158 char *filename = data->score_cache_filename;
9162 // used instead of "leveldir_current->subdir" (for network games)
9163 InitScoreCacheDirectory(levelset.identifier);
9165 if (!(file = fopen(filename, MODE_WRITE)))
9167 Warn("cannot save score cache file '%s'", filename);
9172 for (i = 0; i < response->body_size; i++)
9173 fputc(response->body[i], file);
9177 SetFilePermissions(filename, PERMS_PRIVATE);
9179 server_scores.updated = TRUE;
9182 #if defined(PLATFORM_EMSCRIPTEN)
9183 static void Emscripten_ApiGetScore_Loaded(unsigned handle, void *data_raw,
9184 void *buffer, unsigned int size)
9186 struct HttpResponse *response = GetHttpResponseFromBuffer(buffer, size);
9188 if (response != NULL)
9190 HandleResponse_ApiGetScore(response, data_raw);
9192 checked_free(response);
9196 Error("server response too large to handle (%d bytes)", size);
9199 FreeThreadData_ApiGetScore(data_raw);
9202 static void Emscripten_ApiGetScore_Failed(unsigned handle, void *data_raw,
9203 int code, const char *status)
9205 Error("server failed to handle request: %d %s", code, status);
9207 FreeThreadData_ApiGetScore(data_raw);
9210 static void Emscripten_ApiGetScore_Progress(unsigned handle, void *data_raw,
9211 int bytes, int size)
9213 // nothing to do here
9216 static void Emscripten_ApiGetScore_HttpRequest(struct HttpRequest *request,
9219 if (!SetRequest_ApiGetScore(request, data_raw))
9221 FreeThreadData_ApiGetScore(data_raw);
9226 emscripten_async_wget2_data(request->uri,
9231 Emscripten_ApiGetScore_Loaded,
9232 Emscripten_ApiGetScore_Failed,
9233 Emscripten_ApiGetScore_Progress);
9238 static void ApiGetScore_HttpRequestExt(struct HttpRequest *request,
9239 struct HttpResponse *response,
9242 if (!SetRequest_ApiGetScore(request, data_raw))
9245 if (!DoHttpRequest(request, response))
9247 Error("HTTP request failed: %s", GetHttpError());
9252 if (!HTTP_SUCCESS(response->status_code))
9254 // do not show error message if no scores found for this level set
9255 if (response->status_code == 404)
9258 Error("server failed to handle request: %d %s",
9259 response->status_code,
9260 response->status_text);
9265 HandleResponse_ApiGetScore(response, data_raw);
9268 static void ApiGetScore_HttpRequest(struct HttpRequest *request,
9269 struct HttpResponse *response,
9272 ApiGetScore_HttpRequestExt(request, response, data_raw);
9274 FreeThreadData_ApiGetScore(data_raw);
9278 static int ApiGetScoreThread(void *data_raw)
9280 struct HttpRequest *request = checked_calloc(sizeof(struct HttpRequest));
9281 struct HttpResponse *response = checked_calloc(sizeof(struct HttpResponse));
9283 program.api_thread_count++;
9285 #if defined(PLATFORM_EMSCRIPTEN)
9286 Emscripten_ApiGetScore_HttpRequest(request, data_raw);
9288 ApiGetScore_HttpRequest(request, response, data_raw);
9291 program.api_thread_count--;
9293 checked_free(request);
9294 checked_free(response);
9299 static void ApiGetScoreAsThread(int nr)
9301 struct ApiGetScoreThreadData *data = CreateThreadData_ApiGetScore(nr);
9303 ExecuteAsThread(ApiGetScoreThread,
9304 "ApiGetScore", data,
9305 "download scores from server");
9308 static void LoadServerScoreFromCache(int nr)
9310 struct ScoreEntry score_entry;
9319 { &score_entry.score, FALSE, 0 },
9320 { &score_entry.time, FALSE, 0 },
9321 { score_entry.name, TRUE, MAX_PLAYER_NAME_LEN },
9322 { score_entry.tape_basename, TRUE, MAX_FILENAME_LEN },
9326 char *filename = getScoreCacheFilename(nr);
9327 SetupFileHash *score_hash = loadSetupFileHash(filename);
9330 server_scores.num_entries = 0;
9332 if (score_hash == NULL)
9335 for (i = 0; i < MAX_SCORE_ENTRIES; i++)
9337 score_entry = server_scores.entry[i];
9339 for (j = 0; score_mapping[j].value != NULL; j++)
9343 sprintf(token, "%02d.%d", i, j);
9345 char *value = getHashEntry(score_hash, token);
9350 if (score_mapping[j].is_string)
9352 char *score_value = (char *)score_mapping[j].value;
9353 int value_size = score_mapping[j].string_size;
9355 strncpy(score_value, value, value_size);
9356 score_value[value_size] = '\0';
9360 int *score_value = (int *)score_mapping[j].value;
9362 *score_value = atoi(value);
9365 server_scores.num_entries = i + 1;
9368 server_scores.entry[i] = score_entry;
9371 freeSetupFileHash(score_hash);
9374 void LoadServerScore(int nr, boolean download_score)
9376 if (!setup.use_api_server)
9379 // always start with reliable default values
9380 setServerScoreInfoToDefaults();
9382 // 1st step: load server scores from cache file (which may not exist)
9383 // (this should prevent reading it while the thread is writing to it)
9384 LoadServerScoreFromCache(nr);
9386 if (download_score && runtime.use_api_server)
9388 // 2nd step: download server scores from score server to cache file
9389 // (as thread, as it might time out if the server is not reachable)
9390 ApiGetScoreAsThread(nr);
9394 static char *get_file_base64(char *filename)
9396 struct stat file_status;
9398 if (stat(filename, &file_status) != 0)
9400 Error("cannot stat file '%s'", filename);
9405 int buffer_size = file_status.st_size;
9406 byte *buffer = checked_malloc(buffer_size);
9410 if (!(file = fopen(filename, MODE_READ)))
9412 Error("cannot open file '%s'", filename);
9414 checked_free(buffer);
9419 for (i = 0; i < buffer_size; i++)
9421 int c = fgetc(file);
9425 Error("cannot read from input file '%s'", filename);
9428 checked_free(buffer);
9433 buffer[i] = (byte)c;
9438 int buffer_encoded_size = base64_encoded_size(buffer_size);
9439 char *buffer_encoded = checked_malloc(buffer_encoded_size);
9441 base64_encode(buffer_encoded, buffer, buffer_size);
9443 checked_free(buffer);
9445 return buffer_encoded;
9448 struct ApiAddScoreThreadData
9452 char *score_tape_filename;
9453 struct ScoreEntry score_entry;
9456 static void *CreateThreadData_ApiAddScore(int nr, boolean tape_saved,
9457 char *score_tape_filename)
9459 struct ApiAddScoreThreadData *data =
9460 checked_malloc(sizeof(struct ApiAddScoreThreadData));
9461 struct ScoreEntry *score_entry = &scores.entry[scores.last_added];
9463 if (score_tape_filename == NULL)
9464 score_tape_filename = getScoreTapeFilename(score_entry->tape_basename, nr);
9466 data->level_nr = nr;
9467 data->tape_saved = tape_saved;
9468 data->score_entry = *score_entry;
9469 data->score_tape_filename = getStringCopy(score_tape_filename);
9474 static void FreeThreadData_ApiAddScore(void *data_raw)
9476 struct ApiAddScoreThreadData *data = data_raw;
9478 checked_free(data->score_tape_filename);
9482 static boolean SetRequest_ApiAddScore(struct HttpRequest *request,
9485 struct ApiAddScoreThreadData *data = data_raw;
9486 struct ScoreEntry *score_entry = &data->score_entry;
9487 char *score_tape_filename = data->score_tape_filename;
9488 boolean tape_saved = data->tape_saved;
9489 int level_nr = data->level_nr;
9491 request->hostname = setup.api_server_hostname;
9492 request->port = API_SERVER_PORT;
9493 request->method = API_SERVER_METHOD;
9494 request->uri = API_SERVER_URI_ADD;
9496 char *tape_base64 = get_file_base64(score_tape_filename);
9498 if (tape_base64 == NULL)
9500 Error("loading and base64 encoding score tape file failed");
9505 char *player_name_raw = score_entry->name;
9506 char *player_uuid_raw = setup.player_uuid;
9508 if (options.player_name != NULL && global.autoplay_leveldir != NULL)
9510 player_name_raw = options.player_name;
9511 player_uuid_raw = "";
9514 char *levelset_identifier = getEscapedJSON(leveldir_current->identifier);
9515 char *levelset_name = getEscapedJSON(leveldir_current->name);
9516 char *levelset_author = getEscapedJSON(leveldir_current->author);
9517 char *level_name = getEscapedJSON(level.name);
9518 char *level_author = getEscapedJSON(level.author);
9519 char *player_name = getEscapedJSON(player_name_raw);
9520 char *player_uuid = getEscapedJSON(player_uuid_raw);
9522 snprintf(request->body, MAX_HTTP_BODY_SIZE,
9525 " \"game_version\": \"%s\",\n"
9526 " \"game_platform\": \"%s\",\n"
9527 " \"batch_time\": \"%d\",\n"
9528 " \"levelset_identifier\": \"%s\",\n"
9529 " \"levelset_name\": \"%s\",\n"
9530 " \"levelset_author\": \"%s\",\n"
9531 " \"levelset_num_levels\": \"%d\",\n"
9532 " \"levelset_first_level\": \"%d\",\n"
9533 " \"level_nr\": \"%d\",\n"
9534 " \"level_name\": \"%s\",\n"
9535 " \"level_author\": \"%s\",\n"
9536 " \"use_step_counter\": \"%d\",\n"
9537 " \"rate_time_over_score\": \"%d\",\n"
9538 " \"player_name\": \"%s\",\n"
9539 " \"player_uuid\": \"%s\",\n"
9540 " \"score\": \"%d\",\n"
9541 " \"time\": \"%d\",\n"
9542 " \"tape_basename\": \"%s\",\n"
9543 " \"tape_saved\": \"%d\",\n"
9544 " \"tape\": \"%s\"\n"
9546 getPasswordJSON(setup.api_server_password),
9547 getProgramRealVersionString(),
9548 getProgramPlatformString(),
9549 (int)global.autoplay_time,
9550 levelset_identifier,
9553 leveldir_current->levels,
9554 leveldir_current->first_level,
9558 level.use_step_counter,
9559 level.rate_time_over_score,
9564 score_entry->tape_basename,
9568 checked_free(tape_base64);
9570 checked_free(levelset_identifier);
9571 checked_free(levelset_name);
9572 checked_free(levelset_author);
9573 checked_free(level_name);
9574 checked_free(level_author);
9575 checked_free(player_name);
9576 checked_free(player_uuid);
9578 ConvertHttpRequestBodyToServerEncoding(request);
9583 static void HandleResponse_ApiAddScore(struct HttpResponse *response,
9586 server_scores.uploaded = TRUE;
9589 #if defined(PLATFORM_EMSCRIPTEN)
9590 static void Emscripten_ApiAddScore_Loaded(unsigned handle, void *data_raw,
9591 void *buffer, unsigned int size)
9593 struct HttpResponse *response = GetHttpResponseFromBuffer(buffer, size);
9595 if (response != NULL)
9597 HandleResponse_ApiAddScore(response, data_raw);
9599 checked_free(response);
9603 Error("server response too large to handle (%d bytes)", size);
9606 FreeThreadData_ApiAddScore(data_raw);
9609 static void Emscripten_ApiAddScore_Failed(unsigned handle, void *data_raw,
9610 int code, const char *status)
9612 Error("server failed to handle request: %d %s", code, status);
9614 FreeThreadData_ApiAddScore(data_raw);
9617 static void Emscripten_ApiAddScore_Progress(unsigned handle, void *data_raw,
9618 int bytes, int size)
9620 // nothing to do here
9623 static void Emscripten_ApiAddScore_HttpRequest(struct HttpRequest *request,
9626 if (!SetRequest_ApiAddScore(request, data_raw))
9628 FreeThreadData_ApiAddScore(data_raw);
9633 emscripten_async_wget2_data(request->uri,
9638 Emscripten_ApiAddScore_Loaded,
9639 Emscripten_ApiAddScore_Failed,
9640 Emscripten_ApiAddScore_Progress);
9645 static void ApiAddScore_HttpRequestExt(struct HttpRequest *request,
9646 struct HttpResponse *response,
9649 if (!SetRequest_ApiAddScore(request, data_raw))
9652 if (!DoHttpRequest(request, response))
9654 Error("HTTP request failed: %s", GetHttpError());
9659 if (!HTTP_SUCCESS(response->status_code))
9661 Error("server failed to handle request: %d %s",
9662 response->status_code,
9663 response->status_text);
9668 HandleResponse_ApiAddScore(response, data_raw);
9671 static void ApiAddScore_HttpRequest(struct HttpRequest *request,
9672 struct HttpResponse *response,
9675 ApiAddScore_HttpRequestExt(request, response, data_raw);
9677 FreeThreadData_ApiAddScore(data_raw);
9681 static int ApiAddScoreThread(void *data_raw)
9683 struct HttpRequest *request = checked_calloc(sizeof(struct HttpRequest));
9684 struct HttpResponse *response = checked_calloc(sizeof(struct HttpResponse));
9686 program.api_thread_count++;
9688 #if defined(PLATFORM_EMSCRIPTEN)
9689 Emscripten_ApiAddScore_HttpRequest(request, data_raw);
9691 ApiAddScore_HttpRequest(request, response, data_raw);
9694 program.api_thread_count--;
9696 checked_free(request);
9697 checked_free(response);
9702 static void ApiAddScoreAsThread(int nr, boolean tape_saved,
9703 char *score_tape_filename)
9705 struct ApiAddScoreThreadData *data =
9706 CreateThreadData_ApiAddScore(nr, tape_saved, score_tape_filename);
9708 ExecuteAsThread(ApiAddScoreThread,
9709 "ApiAddScore", data,
9710 "upload score to server");
9713 void SaveServerScore(int nr, boolean tape_saved)
9715 if (!runtime.use_api_server)
9718 ApiAddScoreAsThread(nr, tape_saved, NULL);
9721 void SaveServerScoreFromFile(int nr, boolean tape_saved,
9722 char *score_tape_filename)
9724 if (!runtime.use_api_server)
9727 ApiAddScoreAsThread(nr, tape_saved, score_tape_filename);
9730 void LoadLocalAndServerScore(int nr, boolean download_score)
9732 int last_added_local = scores.last_added_local;
9734 // needed if only showing server scores
9735 setScoreInfoToDefaults();
9737 if (!strEqual(setup.scores_in_highscore_list, STR_SCORES_TYPE_SERVER_ONLY))
9740 // restore last added local score entry (before merging server scores)
9741 scores.last_added = scores.last_added_local = last_added_local;
9743 if (setup.use_api_server &&
9744 !strEqual(setup.scores_in_highscore_list, STR_SCORES_TYPE_LOCAL_ONLY))
9746 // load server scores from cache file and trigger update from server
9747 LoadServerScore(nr, download_score);
9749 // merge local scores with scores from server
9755 // ============================================================================
9756 // setup file functions
9757 // ============================================================================
9759 #define TOKEN_STR_PLAYER_PREFIX "player_"
9762 static struct TokenInfo global_setup_tokens[] =
9766 &setup.player_name, "player_name"
9770 &setup.multiple_users, "multiple_users"
9774 &setup.sound, "sound"
9778 &setup.sound_loops, "repeating_sound_loops"
9782 &setup.sound_music, "background_music"
9786 &setup.sound_simple, "simple_sound_effects"
9790 &setup.toons, "toons"
9794 &setup.scroll_delay, "scroll_delay"
9798 &setup.forced_scroll_delay, "forced_scroll_delay"
9802 &setup.scroll_delay_value, "scroll_delay_value"
9806 &setup.engine_snapshot_mode, "engine_snapshot_mode"
9810 &setup.engine_snapshot_memory, "engine_snapshot_memory"
9814 &setup.fade_screens, "fade_screens"
9818 &setup.autorecord, "automatic_tape_recording"
9822 &setup.show_titlescreen, "show_titlescreen"
9826 &setup.quick_doors, "quick_doors"
9830 &setup.team_mode, "team_mode"
9834 &setup.handicap, "handicap"
9838 &setup.skip_levels, "skip_levels"
9842 &setup.increment_levels, "increment_levels"
9846 &setup.auto_play_next_level, "auto_play_next_level"
9850 &setup.count_score_after_game, "count_score_after_game"
9854 &setup.show_scores_after_game, "show_scores_after_game"
9858 &setup.time_limit, "time_limit"
9862 &setup.fullscreen, "fullscreen"
9866 &setup.window_scaling_percent, "window_scaling_percent"
9870 &setup.window_scaling_quality, "window_scaling_quality"
9874 &setup.screen_rendering_mode, "screen_rendering_mode"
9878 &setup.vsync_mode, "vsync_mode"
9882 &setup.ask_on_escape, "ask_on_escape"
9886 &setup.ask_on_escape_editor, "ask_on_escape_editor"
9890 &setup.ask_on_game_over, "ask_on_game_over"
9894 &setup.ask_on_quit_game, "ask_on_quit_game"
9898 &setup.ask_on_quit_program, "ask_on_quit_program"
9902 &setup.quick_switch, "quick_player_switch"
9906 &setup.input_on_focus, "input_on_focus"
9910 &setup.prefer_aga_graphics, "prefer_aga_graphics"
9914 &setup.prefer_lowpass_sounds, "prefer_lowpass_sounds"
9918 &setup.prefer_extra_panel_items, "prefer_extra_panel_items"
9922 &setup.game_speed_extended, "game_speed_extended"
9926 &setup.game_frame_delay, "game_frame_delay"
9930 &setup.sp_show_border_elements, "sp_show_border_elements"
9934 &setup.small_game_graphics, "small_game_graphics"
9938 &setup.show_load_save_buttons, "show_load_save_buttons"
9942 &setup.show_undo_redo_buttons, "show_undo_redo_buttons"
9946 &setup.scores_in_highscore_list, "scores_in_highscore_list"
9950 &setup.graphics_set, "graphics_set"
9954 &setup.sounds_set, "sounds_set"
9958 &setup.music_set, "music_set"
9962 &setup.override_level_graphics, "override_level_graphics"
9966 &setup.override_level_sounds, "override_level_sounds"
9970 &setup.override_level_music, "override_level_music"
9974 &setup.volume_simple, "volume_simple"
9978 &setup.volume_loops, "volume_loops"
9982 &setup.volume_music, "volume_music"
9986 &setup.network_mode, "network_mode"
9990 &setup.network_player_nr, "network_player"
9994 &setup.network_server_hostname, "network_server_hostname"
9998 &setup.touch.control_type, "touch.control_type"
10002 &setup.touch.move_distance, "touch.move_distance"
10006 &setup.touch.drop_distance, "touch.drop_distance"
10010 &setup.touch.transparency, "touch.transparency"
10014 &setup.touch.draw_outlined, "touch.draw_outlined"
10018 &setup.touch.draw_pressed, "touch.draw_pressed"
10022 &setup.touch.grid_xsize[0], "touch.virtual_buttons.0.xsize"
10026 &setup.touch.grid_ysize[0], "touch.virtual_buttons.0.ysize"
10030 &setup.touch.grid_xsize[1], "touch.virtual_buttons.1.xsize"
10034 &setup.touch.grid_ysize[1], "touch.virtual_buttons.1.ysize"
10038 static struct TokenInfo auto_setup_tokens[] =
10042 &setup.auto_setup.editor_zoom_tilesize, "editor.zoom_tilesize"
10046 static struct TokenInfo server_setup_tokens[] =
10050 &setup.player_uuid, "player_uuid"
10054 &setup.use_api_server, TEST_PREFIX "use_api_server"
10058 &setup.api_server_hostname, TEST_PREFIX "api_server_hostname"
10062 &setup.api_server_password, TEST_PREFIX "api_server_password"
10066 &setup.ask_for_uploading_tapes, TEST_PREFIX "ask_for_uploading_tapes"
10070 &setup.provide_uploading_tapes, TEST_PREFIX "provide_uploading_tapes"
10074 static struct TokenInfo editor_setup_tokens[] =
10078 &setup.editor.el_classic, "editor.el_classic"
10082 &setup.editor.el_custom, "editor.el_custom"
10086 &setup.editor.el_user_defined, "editor.el_user_defined"
10090 &setup.editor.el_dynamic, "editor.el_dynamic"
10094 &setup.editor.el_headlines, "editor.el_headlines"
10098 &setup.editor.show_element_token, "editor.show_element_token"
10102 &setup.editor.show_read_only_warning, "editor.show_read_only_warning"
10106 static struct TokenInfo editor_cascade_setup_tokens[] =
10110 &setup.editor_cascade.el_bd, "editor.cascade.el_bd"
10114 &setup.editor_cascade.el_em, "editor.cascade.el_em"
10118 &setup.editor_cascade.el_emc, "editor.cascade.el_emc"
10122 &setup.editor_cascade.el_rnd, "editor.cascade.el_rnd"
10126 &setup.editor_cascade.el_sb, "editor.cascade.el_sb"
10130 &setup.editor_cascade.el_sp, "editor.cascade.el_sp"
10134 &setup.editor_cascade.el_dc, "editor.cascade.el_dc"
10138 &setup.editor_cascade.el_dx, "editor.cascade.el_dx"
10142 &setup.editor_cascade.el_mm, "editor.cascade.el_mm"
10146 &setup.editor_cascade.el_df, "editor.cascade.el_df"
10150 &setup.editor_cascade.el_chars, "editor.cascade.el_chars"
10154 &setup.editor_cascade.el_steel_chars, "editor.cascade.el_steel_chars"
10158 &setup.editor_cascade.el_ce, "editor.cascade.el_ce"
10162 &setup.editor_cascade.el_ge, "editor.cascade.el_ge"
10166 &setup.editor_cascade.el_ref, "editor.cascade.el_ref"
10170 &setup.editor_cascade.el_user, "editor.cascade.el_user"
10174 &setup.editor_cascade.el_dynamic, "editor.cascade.el_dynamic"
10178 static struct TokenInfo shortcut_setup_tokens[] =
10182 &setup.shortcut.save_game, "shortcut.save_game"
10186 &setup.shortcut.load_game, "shortcut.load_game"
10190 &setup.shortcut.toggle_pause, "shortcut.toggle_pause"
10194 &setup.shortcut.focus_player[0], "shortcut.focus_player_1"
10198 &setup.shortcut.focus_player[1], "shortcut.focus_player_2"
10202 &setup.shortcut.focus_player[2], "shortcut.focus_player_3"
10206 &setup.shortcut.focus_player[3], "shortcut.focus_player_4"
10210 &setup.shortcut.focus_player_all, "shortcut.focus_player_all"
10214 &setup.shortcut.tape_eject, "shortcut.tape_eject"
10218 &setup.shortcut.tape_extra, "shortcut.tape_extra"
10222 &setup.shortcut.tape_stop, "shortcut.tape_stop"
10226 &setup.shortcut.tape_pause, "shortcut.tape_pause"
10230 &setup.shortcut.tape_record, "shortcut.tape_record"
10234 &setup.shortcut.tape_play, "shortcut.tape_play"
10238 &setup.shortcut.sound_simple, "shortcut.sound_simple"
10242 &setup.shortcut.sound_loops, "shortcut.sound_loops"
10246 &setup.shortcut.sound_music, "shortcut.sound_music"
10250 &setup.shortcut.snap_left, "shortcut.snap_left"
10254 &setup.shortcut.snap_right, "shortcut.snap_right"
10258 &setup.shortcut.snap_up, "shortcut.snap_up"
10262 &setup.shortcut.snap_down, "shortcut.snap_down"
10266 static struct SetupInputInfo setup_input;
10267 static struct TokenInfo player_setup_tokens[] =
10271 &setup_input.use_joystick, ".use_joystick"
10275 &setup_input.joy.device_name, ".joy.device_name"
10279 &setup_input.joy.xleft, ".joy.xleft"
10283 &setup_input.joy.xmiddle, ".joy.xmiddle"
10287 &setup_input.joy.xright, ".joy.xright"
10291 &setup_input.joy.yupper, ".joy.yupper"
10295 &setup_input.joy.ymiddle, ".joy.ymiddle"
10299 &setup_input.joy.ylower, ".joy.ylower"
10303 &setup_input.joy.snap, ".joy.snap_field"
10307 &setup_input.joy.drop, ".joy.place_bomb"
10311 &setup_input.key.left, ".key.move_left"
10315 &setup_input.key.right, ".key.move_right"
10319 &setup_input.key.up, ".key.move_up"
10323 &setup_input.key.down, ".key.move_down"
10327 &setup_input.key.snap, ".key.snap_field"
10331 &setup_input.key.drop, ".key.place_bomb"
10335 static struct TokenInfo system_setup_tokens[] =
10339 &setup.system.sdl_renderdriver, "system.sdl_renderdriver"
10343 &setup.system.sdl_videodriver, "system.sdl_videodriver"
10347 &setup.system.sdl_audiodriver, "system.sdl_audiodriver"
10351 &setup.system.audio_fragment_size, "system.audio_fragment_size"
10355 static struct TokenInfo internal_setup_tokens[] =
10359 &setup.internal.program_title, "program_title"
10363 &setup.internal.program_version, "program_version"
10367 &setup.internal.program_author, "program_author"
10371 &setup.internal.program_email, "program_email"
10375 &setup.internal.program_website, "program_website"
10379 &setup.internal.program_copyright, "program_copyright"
10383 &setup.internal.program_company, "program_company"
10387 &setup.internal.program_icon_file, "program_icon_file"
10391 &setup.internal.default_graphics_set, "default_graphics_set"
10395 &setup.internal.default_sounds_set, "default_sounds_set"
10399 &setup.internal.default_music_set, "default_music_set"
10403 &setup.internal.fallback_graphics_file, "fallback_graphics_file"
10407 &setup.internal.fallback_sounds_file, "fallback_sounds_file"
10411 &setup.internal.fallback_music_file, "fallback_music_file"
10415 &setup.internal.default_level_series, "default_level_series"
10419 &setup.internal.default_window_width, "default_window_width"
10423 &setup.internal.default_window_height, "default_window_height"
10427 &setup.internal.choose_from_top_leveldir, "choose_from_top_leveldir"
10431 &setup.internal.show_scaling_in_title, "show_scaling_in_title"
10435 &setup.internal.create_user_levelset, "create_user_levelset"
10439 &setup.internal.menu_game, "menu_game"
10443 &setup.internal.menu_editor, "menu_editor"
10447 &setup.internal.menu_graphics, "menu_graphics"
10451 &setup.internal.menu_sound, "menu_sound"
10455 &setup.internal.menu_artwork, "menu_artwork"
10459 &setup.internal.menu_input, "menu_input"
10463 &setup.internal.menu_touch, "menu_touch"
10467 &setup.internal.menu_shortcuts, "menu_shortcuts"
10471 &setup.internal.menu_exit, "menu_exit"
10475 &setup.internal.menu_save_and_exit, "menu_save_and_exit"
10479 static struct TokenInfo debug_setup_tokens[] =
10483 &setup.debug.frame_delay[0], "debug.frame_delay_0"
10487 &setup.debug.frame_delay[1], "debug.frame_delay_1"
10491 &setup.debug.frame_delay[2], "debug.frame_delay_2"
10495 &setup.debug.frame_delay[3], "debug.frame_delay_3"
10499 &setup.debug.frame_delay[4], "debug.frame_delay_4"
10503 &setup.debug.frame_delay[5], "debug.frame_delay_5"
10507 &setup.debug.frame_delay[6], "debug.frame_delay_6"
10511 &setup.debug.frame_delay[7], "debug.frame_delay_7"
10515 &setup.debug.frame_delay[8], "debug.frame_delay_8"
10519 &setup.debug.frame_delay[9], "debug.frame_delay_9"
10523 &setup.debug.frame_delay_key[0], "debug.key.frame_delay_0"
10527 &setup.debug.frame_delay_key[1], "debug.key.frame_delay_1"
10531 &setup.debug.frame_delay_key[2], "debug.key.frame_delay_2"
10535 &setup.debug.frame_delay_key[3], "debug.key.frame_delay_3"
10539 &setup.debug.frame_delay_key[4], "debug.key.frame_delay_4"
10543 &setup.debug.frame_delay_key[5], "debug.key.frame_delay_5"
10547 &setup.debug.frame_delay_key[6], "debug.key.frame_delay_6"
10551 &setup.debug.frame_delay_key[7], "debug.key.frame_delay_7"
10555 &setup.debug.frame_delay_key[8], "debug.key.frame_delay_8"
10559 &setup.debug.frame_delay_key[9], "debug.key.frame_delay_9"
10563 &setup.debug.frame_delay_use_mod_key, "debug.frame_delay.use_mod_key"},
10566 &setup.debug.frame_delay_game_only, "debug.frame_delay.game_only"
10570 &setup.debug.show_frames_per_second, "debug.show_frames_per_second"
10574 &setup.debug.xsn_mode, "debug.xsn_mode"
10578 &setup.debug.xsn_percent, "debug.xsn_percent"
10582 static struct TokenInfo options_setup_tokens[] =
10586 &setup.options.verbose, "options.verbose"
10590 static void setSetupInfoToDefaults(struct SetupInfo *si)
10594 si->player_name = getStringCopy(getDefaultUserName(user.nr));
10596 si->multiple_users = TRUE;
10599 si->sound_loops = TRUE;
10600 si->sound_music = TRUE;
10601 si->sound_simple = TRUE;
10603 si->scroll_delay = TRUE;
10604 si->forced_scroll_delay = FALSE;
10605 si->scroll_delay_value = STD_SCROLL_DELAY;
10606 si->engine_snapshot_mode = getStringCopy(STR_SNAPSHOT_MODE_DEFAULT);
10607 si->engine_snapshot_memory = SNAPSHOT_MEMORY_DEFAULT;
10608 si->fade_screens = TRUE;
10609 si->autorecord = TRUE;
10610 si->show_titlescreen = TRUE;
10611 si->quick_doors = FALSE;
10612 si->team_mode = FALSE;
10613 si->handicap = TRUE;
10614 si->skip_levels = TRUE;
10615 si->increment_levels = TRUE;
10616 si->auto_play_next_level = TRUE;
10617 si->count_score_after_game = TRUE;
10618 si->show_scores_after_game = TRUE;
10619 si->time_limit = TRUE;
10620 si->fullscreen = FALSE;
10621 si->window_scaling_percent = STD_WINDOW_SCALING_PERCENT;
10622 si->window_scaling_quality = getStringCopy(SCALING_QUALITY_DEFAULT);
10623 si->screen_rendering_mode = getStringCopy(STR_SPECIAL_RENDERING_DEFAULT);
10624 si->vsync_mode = getStringCopy(STR_VSYNC_MODE_DEFAULT);
10625 si->ask_on_escape = TRUE;
10626 si->ask_on_escape_editor = TRUE;
10627 si->ask_on_game_over = TRUE;
10628 si->ask_on_quit_game = TRUE;
10629 si->ask_on_quit_program = TRUE;
10630 si->quick_switch = FALSE;
10631 si->input_on_focus = FALSE;
10632 si->prefer_aga_graphics = TRUE;
10633 si->prefer_lowpass_sounds = FALSE;
10634 si->prefer_extra_panel_items = TRUE;
10635 si->game_speed_extended = FALSE;
10636 si->game_frame_delay = GAME_FRAME_DELAY;
10637 si->sp_show_border_elements = FALSE;
10638 si->small_game_graphics = FALSE;
10639 si->show_load_save_buttons = FALSE;
10640 si->show_undo_redo_buttons = FALSE;
10641 si->scores_in_highscore_list = getStringCopy(STR_SCORES_TYPE_DEFAULT);
10643 si->graphics_set = getStringCopy(GFX_CLASSIC_SUBDIR);
10644 si->sounds_set = getStringCopy(SND_CLASSIC_SUBDIR);
10645 si->music_set = getStringCopy(MUS_CLASSIC_SUBDIR);
10647 si->override_level_graphics = FALSE;
10648 si->override_level_sounds = FALSE;
10649 si->override_level_music = FALSE;
10651 si->volume_simple = 100; // percent
10652 si->volume_loops = 100; // percent
10653 si->volume_music = 100; // percent
10655 si->network_mode = FALSE;
10656 si->network_player_nr = 0; // first player
10657 si->network_server_hostname = getStringCopy(STR_NETWORK_AUTO_DETECT);
10659 si->touch.control_type = getStringCopy(TOUCH_CONTROL_DEFAULT);
10660 si->touch.move_distance = TOUCH_MOVE_DISTANCE_DEFAULT; // percent
10661 si->touch.drop_distance = TOUCH_DROP_DISTANCE_DEFAULT; // percent
10662 si->touch.transparency = TOUCH_TRANSPARENCY_DEFAULT; // percent
10663 si->touch.draw_outlined = TRUE;
10664 si->touch.draw_pressed = TRUE;
10666 for (i = 0; i < 2; i++)
10668 char *default_grid_button[6][2] =
10674 { "111222", " vv " },
10675 { "111222", " vv " }
10677 int grid_xsize = DEFAULT_GRID_XSIZE(i);
10678 int grid_ysize = DEFAULT_GRID_YSIZE(i);
10679 int min_xsize = MIN(6, grid_xsize);
10680 int min_ysize = MIN(6, grid_ysize);
10681 int startx = grid_xsize - min_xsize;
10682 int starty = grid_ysize - min_ysize;
10685 // virtual buttons grid can only be set to defaults if video is initialized
10686 // (this will be repeated if virtual buttons are not loaded from setup file)
10687 if (video.initialized)
10689 si->touch.grid_xsize[i] = grid_xsize;
10690 si->touch.grid_ysize[i] = grid_ysize;
10694 si->touch.grid_xsize[i] = -1;
10695 si->touch.grid_ysize[i] = -1;
10698 for (x = 0; x < MAX_GRID_XSIZE; x++)
10699 for (y = 0; y < MAX_GRID_YSIZE; y++)
10700 si->touch.grid_button[i][x][y] = CHAR_GRID_BUTTON_NONE;
10702 for (x = 0; x < min_xsize; x++)
10703 for (y = 0; y < min_ysize; y++)
10704 si->touch.grid_button[i][x][starty + y] =
10705 default_grid_button[y][0][x];
10707 for (x = 0; x < min_xsize; x++)
10708 for (y = 0; y < min_ysize; y++)
10709 si->touch.grid_button[i][startx + x][starty + y] =
10710 default_grid_button[y][1][x];
10713 si->touch.grid_initialized = video.initialized;
10715 si->editor.el_boulderdash = TRUE;
10716 si->editor.el_emerald_mine = TRUE;
10717 si->editor.el_emerald_mine_club = TRUE;
10718 si->editor.el_more = TRUE;
10719 si->editor.el_sokoban = TRUE;
10720 si->editor.el_supaplex = TRUE;
10721 si->editor.el_diamond_caves = TRUE;
10722 si->editor.el_dx_boulderdash = TRUE;
10724 si->editor.el_mirror_magic = TRUE;
10725 si->editor.el_deflektor = TRUE;
10727 si->editor.el_chars = TRUE;
10728 si->editor.el_steel_chars = TRUE;
10730 si->editor.el_classic = TRUE;
10731 si->editor.el_custom = TRUE;
10733 si->editor.el_user_defined = FALSE;
10734 si->editor.el_dynamic = TRUE;
10736 si->editor.el_headlines = TRUE;
10738 si->editor.show_element_token = FALSE;
10740 si->editor.show_read_only_warning = TRUE;
10742 si->editor.use_template_for_new_levels = TRUE;
10744 si->shortcut.save_game = DEFAULT_KEY_SAVE_GAME;
10745 si->shortcut.load_game = DEFAULT_KEY_LOAD_GAME;
10746 si->shortcut.toggle_pause = DEFAULT_KEY_TOGGLE_PAUSE;
10748 si->shortcut.focus_player[0] = DEFAULT_KEY_FOCUS_PLAYER_1;
10749 si->shortcut.focus_player[1] = DEFAULT_KEY_FOCUS_PLAYER_2;
10750 si->shortcut.focus_player[2] = DEFAULT_KEY_FOCUS_PLAYER_3;
10751 si->shortcut.focus_player[3] = DEFAULT_KEY_FOCUS_PLAYER_4;
10752 si->shortcut.focus_player_all = DEFAULT_KEY_FOCUS_PLAYER_ALL;
10754 si->shortcut.tape_eject = DEFAULT_KEY_TAPE_EJECT;
10755 si->shortcut.tape_extra = DEFAULT_KEY_TAPE_EXTRA;
10756 si->shortcut.tape_stop = DEFAULT_KEY_TAPE_STOP;
10757 si->shortcut.tape_pause = DEFAULT_KEY_TAPE_PAUSE;
10758 si->shortcut.tape_record = DEFAULT_KEY_TAPE_RECORD;
10759 si->shortcut.tape_play = DEFAULT_KEY_TAPE_PLAY;
10761 si->shortcut.sound_simple = DEFAULT_KEY_SOUND_SIMPLE;
10762 si->shortcut.sound_loops = DEFAULT_KEY_SOUND_LOOPS;
10763 si->shortcut.sound_music = DEFAULT_KEY_SOUND_MUSIC;
10765 si->shortcut.snap_left = DEFAULT_KEY_SNAP_LEFT;
10766 si->shortcut.snap_right = DEFAULT_KEY_SNAP_RIGHT;
10767 si->shortcut.snap_up = DEFAULT_KEY_SNAP_UP;
10768 si->shortcut.snap_down = DEFAULT_KEY_SNAP_DOWN;
10770 for (i = 0; i < MAX_PLAYERS; i++)
10772 si->input[i].use_joystick = FALSE;
10773 si->input[i].joy.device_name=getStringCopy(getDeviceNameFromJoystickNr(i));
10774 si->input[i].joy.xleft = JOYSTICK_XLEFT;
10775 si->input[i].joy.xmiddle = JOYSTICK_XMIDDLE;
10776 si->input[i].joy.xright = JOYSTICK_XRIGHT;
10777 si->input[i].joy.yupper = JOYSTICK_YUPPER;
10778 si->input[i].joy.ymiddle = JOYSTICK_YMIDDLE;
10779 si->input[i].joy.ylower = JOYSTICK_YLOWER;
10780 si->input[i].joy.snap = (i == 0 ? JOY_BUTTON_1 : 0);
10781 si->input[i].joy.drop = (i == 0 ? JOY_BUTTON_2 : 0);
10782 si->input[i].key.left = (i == 0 ? DEFAULT_KEY_LEFT : KSYM_UNDEFINED);
10783 si->input[i].key.right = (i == 0 ? DEFAULT_KEY_RIGHT : KSYM_UNDEFINED);
10784 si->input[i].key.up = (i == 0 ? DEFAULT_KEY_UP : KSYM_UNDEFINED);
10785 si->input[i].key.down = (i == 0 ? DEFAULT_KEY_DOWN : KSYM_UNDEFINED);
10786 si->input[i].key.snap = (i == 0 ? DEFAULT_KEY_SNAP : KSYM_UNDEFINED);
10787 si->input[i].key.drop = (i == 0 ? DEFAULT_KEY_DROP : KSYM_UNDEFINED);
10790 si->system.sdl_renderdriver = getStringCopy(ARG_DEFAULT);
10791 si->system.sdl_videodriver = getStringCopy(ARG_DEFAULT);
10792 si->system.sdl_audiodriver = getStringCopy(ARG_DEFAULT);
10793 si->system.audio_fragment_size = DEFAULT_AUDIO_FRAGMENT_SIZE;
10795 si->internal.program_title = getStringCopy(PROGRAM_TITLE_STRING);
10796 si->internal.program_version = getStringCopy(getProgramRealVersionString());
10797 si->internal.program_author = getStringCopy(PROGRAM_AUTHOR_STRING);
10798 si->internal.program_email = getStringCopy(PROGRAM_EMAIL_STRING);
10799 si->internal.program_website = getStringCopy(PROGRAM_WEBSITE_STRING);
10800 si->internal.program_copyright = getStringCopy(PROGRAM_COPYRIGHT_STRING);
10801 si->internal.program_company = getStringCopy(PROGRAM_COMPANY_STRING);
10803 si->internal.program_icon_file = getStringCopy(PROGRAM_ICON_FILENAME);
10805 si->internal.default_graphics_set = getStringCopy(GFX_CLASSIC_SUBDIR);
10806 si->internal.default_sounds_set = getStringCopy(SND_CLASSIC_SUBDIR);
10807 si->internal.default_music_set = getStringCopy(MUS_CLASSIC_SUBDIR);
10809 si->internal.fallback_graphics_file = getStringCopy(UNDEFINED_FILENAME);
10810 si->internal.fallback_sounds_file = getStringCopy(UNDEFINED_FILENAME);
10811 si->internal.fallback_music_file = getStringCopy(UNDEFINED_FILENAME);
10813 si->internal.default_level_series = getStringCopy(UNDEFINED_LEVELSET);
10814 si->internal.choose_from_top_leveldir = FALSE;
10815 si->internal.show_scaling_in_title = TRUE;
10816 si->internal.create_user_levelset = TRUE;
10818 si->internal.default_window_width = WIN_XSIZE_DEFAULT;
10819 si->internal.default_window_height = WIN_YSIZE_DEFAULT;
10821 si->debug.frame_delay[0] = DEFAULT_FRAME_DELAY_0;
10822 si->debug.frame_delay[1] = DEFAULT_FRAME_DELAY_1;
10823 si->debug.frame_delay[2] = DEFAULT_FRAME_DELAY_2;
10824 si->debug.frame_delay[3] = DEFAULT_FRAME_DELAY_3;
10825 si->debug.frame_delay[4] = DEFAULT_FRAME_DELAY_4;
10826 si->debug.frame_delay[5] = DEFAULT_FRAME_DELAY_5;
10827 si->debug.frame_delay[6] = DEFAULT_FRAME_DELAY_6;
10828 si->debug.frame_delay[7] = DEFAULT_FRAME_DELAY_7;
10829 si->debug.frame_delay[8] = DEFAULT_FRAME_DELAY_8;
10830 si->debug.frame_delay[9] = DEFAULT_FRAME_DELAY_9;
10832 si->debug.frame_delay_key[0] = DEFAULT_KEY_FRAME_DELAY_0;
10833 si->debug.frame_delay_key[1] = DEFAULT_KEY_FRAME_DELAY_1;
10834 si->debug.frame_delay_key[2] = DEFAULT_KEY_FRAME_DELAY_2;
10835 si->debug.frame_delay_key[3] = DEFAULT_KEY_FRAME_DELAY_3;
10836 si->debug.frame_delay_key[4] = DEFAULT_KEY_FRAME_DELAY_4;
10837 si->debug.frame_delay_key[5] = DEFAULT_KEY_FRAME_DELAY_5;
10838 si->debug.frame_delay_key[6] = DEFAULT_KEY_FRAME_DELAY_6;
10839 si->debug.frame_delay_key[7] = DEFAULT_KEY_FRAME_DELAY_7;
10840 si->debug.frame_delay_key[8] = DEFAULT_KEY_FRAME_DELAY_8;
10841 si->debug.frame_delay_key[9] = DEFAULT_KEY_FRAME_DELAY_9;
10843 si->debug.frame_delay_use_mod_key = DEFAULT_FRAME_DELAY_USE_MOD_KEY;
10844 si->debug.frame_delay_game_only = DEFAULT_FRAME_DELAY_GAME_ONLY;
10846 si->debug.show_frames_per_second = FALSE;
10848 si->debug.xsn_mode = AUTO;
10849 si->debug.xsn_percent = 0;
10851 si->options.verbose = FALSE;
10853 #if defined(PLATFORM_ANDROID)
10854 si->fullscreen = TRUE;
10857 setHideSetupEntry(&setup.debug.xsn_mode);
10860 static void setSetupInfoToDefaults_AutoSetup(struct SetupInfo *si)
10862 si->auto_setup.editor_zoom_tilesize = MINI_TILESIZE;
10865 static void setSetupInfoToDefaults_ServerSetup(struct SetupInfo *si)
10867 si->player_uuid = NULL; // (will be set later)
10869 si->use_api_server = TRUE;
10870 si->api_server_hostname = getStringCopy(API_SERVER_HOSTNAME);
10871 si->api_server_password = getStringCopy(UNDEFINED_PASSWORD);
10872 si->ask_for_uploading_tapes = TRUE;
10873 si->provide_uploading_tapes = TRUE;
10876 static void setSetupInfoToDefaults_EditorCascade(struct SetupInfo *si)
10878 si->editor_cascade.el_bd = TRUE;
10879 si->editor_cascade.el_em = TRUE;
10880 si->editor_cascade.el_emc = TRUE;
10881 si->editor_cascade.el_rnd = TRUE;
10882 si->editor_cascade.el_sb = TRUE;
10883 si->editor_cascade.el_sp = TRUE;
10884 si->editor_cascade.el_dc = TRUE;
10885 si->editor_cascade.el_dx = TRUE;
10887 si->editor_cascade.el_mm = TRUE;
10888 si->editor_cascade.el_df = TRUE;
10890 si->editor_cascade.el_chars = FALSE;
10891 si->editor_cascade.el_steel_chars = FALSE;
10892 si->editor_cascade.el_ce = FALSE;
10893 si->editor_cascade.el_ge = FALSE;
10894 si->editor_cascade.el_ref = FALSE;
10895 si->editor_cascade.el_user = FALSE;
10896 si->editor_cascade.el_dynamic = FALSE;
10899 #define MAX_HIDE_SETUP_TOKEN_SIZE 20
10901 static char *getHideSetupToken(void *setup_value)
10903 static char hide_setup_token[MAX_HIDE_SETUP_TOKEN_SIZE];
10905 if (setup_value != NULL)
10906 snprintf(hide_setup_token, MAX_HIDE_SETUP_TOKEN_SIZE, "%p", setup_value);
10908 return hide_setup_token;
10911 void setHideSetupEntry(void *setup_value)
10913 char *hide_setup_token = getHideSetupToken(setup_value);
10915 if (hide_setup_hash == NULL)
10916 hide_setup_hash = newSetupFileHash();
10918 if (setup_value != NULL)
10919 setHashEntry(hide_setup_hash, hide_setup_token, "");
10922 void removeHideSetupEntry(void *setup_value)
10924 char *hide_setup_token = getHideSetupToken(setup_value);
10926 if (setup_value != NULL)
10927 removeHashEntry(hide_setup_hash, hide_setup_token);
10930 boolean hideSetupEntry(void *setup_value)
10932 char *hide_setup_token = getHideSetupToken(setup_value);
10934 return (setup_value != NULL &&
10935 getHashEntry(hide_setup_hash, hide_setup_token) != NULL);
10938 static void setSetupInfoFromTokenText(SetupFileHash *setup_file_hash,
10939 struct TokenInfo *token_info,
10940 int token_nr, char *token_text)
10942 char *token_hide_text = getStringCat2(token_text, ".hide");
10943 char *token_hide_value = getHashEntry(setup_file_hash, token_hide_text);
10945 // set the value of this setup option in the setup option structure
10946 setSetupInfo(token_info, token_nr, getHashEntry(setup_file_hash, token_text));
10948 // check if this setup option should be hidden in the setup menu
10949 if (token_hide_value != NULL && get_boolean_from_string(token_hide_value))
10950 setHideSetupEntry(token_info[token_nr].value);
10952 free(token_hide_text);
10955 static void setSetupInfoFromTokenInfo(SetupFileHash *setup_file_hash,
10956 struct TokenInfo *token_info,
10959 setSetupInfoFromTokenText(setup_file_hash, token_info, token_nr,
10960 token_info[token_nr].text);
10963 static void decodeSetupFileHash_Default(SetupFileHash *setup_file_hash)
10967 if (!setup_file_hash)
10970 for (i = 0; i < ARRAY_SIZE(global_setup_tokens); i++)
10971 setSetupInfoFromTokenInfo(setup_file_hash, global_setup_tokens, i);
10973 setup.touch.grid_initialized = TRUE;
10974 for (i = 0; i < 2; i++)
10976 int grid_xsize = setup.touch.grid_xsize[i];
10977 int grid_ysize = setup.touch.grid_ysize[i];
10980 // if virtual buttons are not loaded from setup file, repeat initializing
10981 // virtual buttons grid with default values later when video is initialized
10982 if (grid_xsize == -1 ||
10985 setup.touch.grid_initialized = FALSE;
10990 for (y = 0; y < grid_ysize; y++)
10992 char token_string[MAX_LINE_LEN];
10994 sprintf(token_string, "touch.virtual_buttons.%d.%02d", i, y);
10996 char *value_string = getHashEntry(setup_file_hash, token_string);
10998 if (value_string == NULL)
11001 for (x = 0; x < grid_xsize; x++)
11003 char c = value_string[x];
11005 setup.touch.grid_button[i][x][y] =
11006 (c == '.' ? CHAR_GRID_BUTTON_NONE : c);
11011 for (i = 0; i < ARRAY_SIZE(editor_setup_tokens); i++)
11012 setSetupInfoFromTokenInfo(setup_file_hash, editor_setup_tokens, i);
11014 for (i = 0; i < ARRAY_SIZE(shortcut_setup_tokens); i++)
11015 setSetupInfoFromTokenInfo(setup_file_hash, shortcut_setup_tokens, i);
11017 for (pnr = 0; pnr < MAX_PLAYERS; pnr++)
11021 sprintf(prefix, "%s%d", TOKEN_STR_PLAYER_PREFIX, pnr + 1);
11023 setup_input = setup.input[pnr];
11024 for (i = 0; i < ARRAY_SIZE(player_setup_tokens); i++)
11026 char full_token[100];
11028 sprintf(full_token, "%s%s", prefix, player_setup_tokens[i].text);
11029 setSetupInfoFromTokenText(setup_file_hash, player_setup_tokens, i,
11032 setup.input[pnr] = setup_input;
11035 for (i = 0; i < ARRAY_SIZE(system_setup_tokens); i++)
11036 setSetupInfoFromTokenInfo(setup_file_hash, system_setup_tokens, i);
11038 for (i = 0; i < ARRAY_SIZE(internal_setup_tokens); i++)
11039 setSetupInfoFromTokenInfo(setup_file_hash, internal_setup_tokens, i);
11041 for (i = 0; i < ARRAY_SIZE(debug_setup_tokens); i++)
11042 setSetupInfoFromTokenInfo(setup_file_hash, debug_setup_tokens, i);
11044 for (i = 0; i < ARRAY_SIZE(options_setup_tokens); i++)
11045 setSetupInfoFromTokenInfo(setup_file_hash, options_setup_tokens, i);
11047 setHideRelatedSetupEntries();
11050 static void decodeSetupFileHash_AutoSetup(SetupFileHash *setup_file_hash)
11054 if (!setup_file_hash)
11057 for (i = 0; i < ARRAY_SIZE(auto_setup_tokens); i++)
11058 setSetupInfo(auto_setup_tokens, i,
11059 getHashEntry(setup_file_hash,
11060 auto_setup_tokens[i].text));
11063 static void decodeSetupFileHash_ServerSetup(SetupFileHash *setup_file_hash)
11067 if (!setup_file_hash)
11070 for (i = 0; i < ARRAY_SIZE(server_setup_tokens); i++)
11071 setSetupInfo(server_setup_tokens, i,
11072 getHashEntry(setup_file_hash,
11073 server_setup_tokens[i].text));
11076 static void decodeSetupFileHash_EditorCascade(SetupFileHash *setup_file_hash)
11080 if (!setup_file_hash)
11083 for (i = 0; i < ARRAY_SIZE(editor_cascade_setup_tokens); i++)
11084 setSetupInfo(editor_cascade_setup_tokens, i,
11085 getHashEntry(setup_file_hash,
11086 editor_cascade_setup_tokens[i].text));
11089 void LoadUserNames(void)
11091 int last_user_nr = user.nr;
11094 if (global.user_names != NULL)
11096 for (i = 0; i < MAX_PLAYER_NAMES; i++)
11097 checked_free(global.user_names[i]);
11099 checked_free(global.user_names);
11102 global.user_names = checked_calloc(MAX_PLAYER_NAMES * sizeof(char *));
11104 for (i = 0; i < MAX_PLAYER_NAMES; i++)
11108 SetupFileHash *setup_file_hash = loadSetupFileHash(getSetupFilename());
11110 if (setup_file_hash)
11112 char *player_name = getHashEntry(setup_file_hash, "player_name");
11114 global.user_names[i] = getFixedUserName(player_name);
11116 freeSetupFileHash(setup_file_hash);
11119 if (global.user_names[i] == NULL)
11120 global.user_names[i] = getStringCopy(getDefaultUserName(i));
11123 user.nr = last_user_nr;
11126 void LoadSetupFromFilename(char *filename)
11128 SetupFileHash *setup_file_hash = loadSetupFileHash(filename);
11130 if (setup_file_hash)
11132 decodeSetupFileHash_Default(setup_file_hash);
11134 freeSetupFileHash(setup_file_hash);
11138 Debug("setup", "using default setup values");
11142 static void LoadSetup_SpecialPostProcessing(void)
11144 char *player_name_new;
11146 // needed to work around problems with fixed length strings
11147 player_name_new = getFixedUserName(setup.player_name);
11148 free(setup.player_name);
11149 setup.player_name = player_name_new;
11151 // "scroll_delay: on(3) / off(0)" was replaced by scroll delay value
11152 if (setup.scroll_delay == FALSE)
11154 setup.scroll_delay_value = MIN_SCROLL_DELAY;
11155 setup.scroll_delay = TRUE; // now always "on"
11158 // make sure that scroll delay value stays inside valid range
11159 setup.scroll_delay_value =
11160 MIN(MAX(MIN_SCROLL_DELAY, setup.scroll_delay_value), MAX_SCROLL_DELAY);
11163 void LoadSetup_Default(void)
11167 // always start with reliable default values
11168 setSetupInfoToDefaults(&setup);
11170 // try to load setup values from default setup file
11171 filename = getDefaultSetupFilename();
11173 if (fileExists(filename))
11174 LoadSetupFromFilename(filename);
11176 // try to load setup values from user setup file
11177 filename = getSetupFilename();
11179 LoadSetupFromFilename(filename);
11181 LoadSetup_SpecialPostProcessing();
11184 void LoadSetup_AutoSetup(void)
11186 char *filename = getPath2(getSetupDir(), AUTOSETUP_FILENAME);
11187 SetupFileHash *setup_file_hash = NULL;
11189 // always start with reliable default values
11190 setSetupInfoToDefaults_AutoSetup(&setup);
11192 setup_file_hash = loadSetupFileHash(filename);
11194 if (setup_file_hash)
11196 decodeSetupFileHash_AutoSetup(setup_file_hash);
11198 freeSetupFileHash(setup_file_hash);
11204 void LoadSetup_ServerSetup(void)
11206 char *filename = getPath2(getSetupDir(), SERVERSETUP_FILENAME);
11207 SetupFileHash *setup_file_hash = NULL;
11209 // always start with reliable default values
11210 setSetupInfoToDefaults_ServerSetup(&setup);
11212 setup_file_hash = loadSetupFileHash(filename);
11214 if (setup_file_hash)
11216 decodeSetupFileHash_ServerSetup(setup_file_hash);
11218 freeSetupFileHash(setup_file_hash);
11223 if (setup.player_uuid == NULL)
11225 // player UUID does not yet exist in setup file
11226 setup.player_uuid = getStringCopy(getUUID());
11228 SaveSetup_ServerSetup();
11232 void LoadSetup_EditorCascade(void)
11234 char *filename = getPath2(getSetupDir(), EDITORCASCADE_FILENAME);
11235 SetupFileHash *setup_file_hash = NULL;
11237 // always start with reliable default values
11238 setSetupInfoToDefaults_EditorCascade(&setup);
11240 setup_file_hash = loadSetupFileHash(filename);
11242 if (setup_file_hash)
11244 decodeSetupFileHash_EditorCascade(setup_file_hash);
11246 freeSetupFileHash(setup_file_hash);
11252 void LoadSetup(void)
11254 LoadSetup_Default();
11255 LoadSetup_AutoSetup();
11256 LoadSetup_ServerSetup();
11257 LoadSetup_EditorCascade();
11260 static void addGameControllerMappingToHash(SetupFileHash *mappings_hash,
11261 char *mapping_line)
11263 char mapping_guid[MAX_LINE_LEN];
11264 char *mapping_start, *mapping_end;
11266 // get GUID from game controller mapping line: copy complete line
11267 strncpy(mapping_guid, mapping_line, MAX_LINE_LEN - 1);
11268 mapping_guid[MAX_LINE_LEN - 1] = '\0';
11270 // get GUID from game controller mapping line: cut after GUID part
11271 mapping_start = strchr(mapping_guid, ',');
11272 if (mapping_start != NULL)
11273 *mapping_start = '\0';
11275 // cut newline from game controller mapping line
11276 mapping_end = strchr(mapping_line, '\n');
11277 if (mapping_end != NULL)
11278 *mapping_end = '\0';
11280 // add mapping entry to game controller mappings hash
11281 setHashEntry(mappings_hash, mapping_guid, mapping_line);
11284 static void LoadSetup_ReadGameControllerMappings(SetupFileHash *mappings_hash,
11289 if (!(file = fopen(filename, MODE_READ)))
11291 Warn("cannot read game controller mappings file '%s'", filename);
11296 while (!feof(file))
11298 char line[MAX_LINE_LEN];
11300 if (!fgets(line, MAX_LINE_LEN, file))
11303 addGameControllerMappingToHash(mappings_hash, line);
11309 void SaveSetup_Default(void)
11311 char *filename = getSetupFilename();
11315 InitUserDataDirectory();
11317 if (!(file = fopen(filename, MODE_WRITE)))
11319 Warn("cannot write setup file '%s'", filename);
11324 fprintFileHeader(file, SETUP_FILENAME);
11326 for (i = 0; i < ARRAY_SIZE(global_setup_tokens); i++)
11328 // just to make things nicer :)
11329 if (global_setup_tokens[i].value == &setup.multiple_users ||
11330 global_setup_tokens[i].value == &setup.sound ||
11331 global_setup_tokens[i].value == &setup.graphics_set ||
11332 global_setup_tokens[i].value == &setup.volume_simple ||
11333 global_setup_tokens[i].value == &setup.network_mode ||
11334 global_setup_tokens[i].value == &setup.touch.control_type ||
11335 global_setup_tokens[i].value == &setup.touch.grid_xsize[0] ||
11336 global_setup_tokens[i].value == &setup.touch.grid_xsize[1])
11337 fprintf(file, "\n");
11339 fprintf(file, "%s\n", getSetupLine(global_setup_tokens, "", i));
11342 for (i = 0; i < 2; i++)
11344 int grid_xsize = setup.touch.grid_xsize[i];
11345 int grid_ysize = setup.touch.grid_ysize[i];
11348 fprintf(file, "\n");
11350 for (y = 0; y < grid_ysize; y++)
11352 char token_string[MAX_LINE_LEN];
11353 char value_string[MAX_LINE_LEN];
11355 sprintf(token_string, "touch.virtual_buttons.%d.%02d", i, y);
11357 for (x = 0; x < grid_xsize; x++)
11359 char c = setup.touch.grid_button[i][x][y];
11361 value_string[x] = (c == CHAR_GRID_BUTTON_NONE ? '.' : c);
11364 value_string[grid_xsize] = '\0';
11366 fprintf(file, "%s\n", getFormattedSetupEntry(token_string, value_string));
11370 fprintf(file, "\n");
11371 for (i = 0; i < ARRAY_SIZE(editor_setup_tokens); i++)
11372 fprintf(file, "%s\n", getSetupLine(editor_setup_tokens, "", i));
11374 fprintf(file, "\n");
11375 for (i = 0; i < ARRAY_SIZE(shortcut_setup_tokens); i++)
11376 fprintf(file, "%s\n", getSetupLine(shortcut_setup_tokens, "", i));
11378 for (pnr = 0; pnr < MAX_PLAYERS; pnr++)
11382 sprintf(prefix, "%s%d", TOKEN_STR_PLAYER_PREFIX, pnr + 1);
11383 fprintf(file, "\n");
11385 setup_input = setup.input[pnr];
11386 for (i = 0; i < ARRAY_SIZE(player_setup_tokens); i++)
11387 fprintf(file, "%s\n", getSetupLine(player_setup_tokens, prefix, i));
11390 fprintf(file, "\n");
11391 for (i = 0; i < ARRAY_SIZE(system_setup_tokens); i++)
11392 fprintf(file, "%s\n", getSetupLine(system_setup_tokens, "", i));
11394 // (internal setup values not saved to user setup file)
11396 fprintf(file, "\n");
11397 for (i = 0; i < ARRAY_SIZE(debug_setup_tokens); i++)
11398 if (!strPrefix(debug_setup_tokens[i].text, "debug.xsn_") ||
11399 setup.debug.xsn_mode != AUTO)
11400 fprintf(file, "%s\n", getSetupLine(debug_setup_tokens, "", i));
11402 fprintf(file, "\n");
11403 for (i = 0; i < ARRAY_SIZE(options_setup_tokens); i++)
11404 fprintf(file, "%s\n", getSetupLine(options_setup_tokens, "", i));
11408 SetFilePermissions(filename, PERMS_PRIVATE);
11411 void SaveSetup_AutoSetup(void)
11413 char *filename = getPath2(getSetupDir(), AUTOSETUP_FILENAME);
11417 InitUserDataDirectory();
11419 if (!(file = fopen(filename, MODE_WRITE)))
11421 Warn("cannot write auto setup file '%s'", filename);
11428 fprintFileHeader(file, AUTOSETUP_FILENAME);
11430 for (i = 0; i < ARRAY_SIZE(auto_setup_tokens); i++)
11431 fprintf(file, "%s\n", getSetupLine(auto_setup_tokens, "", i));
11435 SetFilePermissions(filename, PERMS_PRIVATE);
11440 void SaveSetup_ServerSetup(void)
11442 char *filename = getPath2(getSetupDir(), SERVERSETUP_FILENAME);
11446 InitUserDataDirectory();
11448 if (!(file = fopen(filename, MODE_WRITE)))
11450 Warn("cannot write server setup file '%s'", filename);
11457 fprintFileHeader(file, SERVERSETUP_FILENAME);
11459 for (i = 0; i < ARRAY_SIZE(server_setup_tokens); i++)
11461 // just to make things nicer :)
11462 if (server_setup_tokens[i].value == &setup.use_api_server)
11463 fprintf(file, "\n");
11465 fprintf(file, "%s\n", getSetupLine(server_setup_tokens, "", i));
11470 SetFilePermissions(filename, PERMS_PRIVATE);
11475 void SaveSetup_EditorCascade(void)
11477 char *filename = getPath2(getSetupDir(), EDITORCASCADE_FILENAME);
11481 InitUserDataDirectory();
11483 if (!(file = fopen(filename, MODE_WRITE)))
11485 Warn("cannot write editor cascade state file '%s'", filename);
11492 fprintFileHeader(file, EDITORCASCADE_FILENAME);
11494 for (i = 0; i < ARRAY_SIZE(editor_cascade_setup_tokens); i++)
11495 fprintf(file, "%s\n", getSetupLine(editor_cascade_setup_tokens, "", i));
11499 SetFilePermissions(filename, PERMS_PRIVATE);
11504 void SaveSetup(void)
11506 SaveSetup_Default();
11507 SaveSetup_AutoSetup();
11508 SaveSetup_ServerSetup();
11509 SaveSetup_EditorCascade();
11512 static void SaveSetup_WriteGameControllerMappings(SetupFileHash *mappings_hash,
11517 if (!(file = fopen(filename, MODE_WRITE)))
11519 Warn("cannot write game controller mappings file '%s'", filename);
11524 BEGIN_HASH_ITERATION(mappings_hash, itr)
11526 fprintf(file, "%s\n", HASH_ITERATION_VALUE(itr));
11528 END_HASH_ITERATION(mappings_hash, itr)
11533 void SaveSetup_AddGameControllerMapping(char *mapping)
11535 char *filename = getPath2(getSetupDir(), GAMECONTROLLER_BASENAME);
11536 SetupFileHash *mappings_hash = newSetupFileHash();
11538 InitUserDataDirectory();
11540 // load existing personal game controller mappings
11541 LoadSetup_ReadGameControllerMappings(mappings_hash, filename);
11543 // add new mapping to personal game controller mappings
11544 addGameControllerMappingToHash(mappings_hash, mapping);
11546 // save updated personal game controller mappings
11547 SaveSetup_WriteGameControllerMappings(mappings_hash, filename);
11549 freeSetupFileHash(mappings_hash);
11553 void LoadCustomElementDescriptions(void)
11555 char *filename = getCustomArtworkConfigFilename(ARTWORK_TYPE_GRAPHICS);
11556 SetupFileHash *setup_file_hash;
11559 for (i = 0; i < NUM_FILE_ELEMENTS; i++)
11561 if (element_info[i].custom_description != NULL)
11563 free(element_info[i].custom_description);
11564 element_info[i].custom_description = NULL;
11568 if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
11571 for (i = 0; i < NUM_FILE_ELEMENTS; i++)
11573 char *token = getStringCat2(element_info[i].token_name, ".name");
11574 char *value = getHashEntry(setup_file_hash, token);
11577 element_info[i].custom_description = getStringCopy(value);
11582 freeSetupFileHash(setup_file_hash);
11585 static int getElementFromToken(char *token)
11587 char *value = getHashEntry(element_token_hash, token);
11590 return atoi(value);
11592 Warn("unknown element token '%s'", token);
11594 return EL_UNDEFINED;
11597 void FreeGlobalAnimEventInfo(void)
11599 struct GlobalAnimEventInfo *gaei = &global_anim_event_info;
11601 if (gaei->event_list == NULL)
11606 for (i = 0; i < gaei->num_event_lists; i++)
11608 checked_free(gaei->event_list[i]->event_value);
11609 checked_free(gaei->event_list[i]);
11612 checked_free(gaei->event_list);
11614 gaei->event_list = NULL;
11615 gaei->num_event_lists = 0;
11618 static int AddGlobalAnimEventList(void)
11620 struct GlobalAnimEventInfo *gaei = &global_anim_event_info;
11621 int list_pos = gaei->num_event_lists++;
11623 gaei->event_list = checked_realloc(gaei->event_list, gaei->num_event_lists *
11624 sizeof(struct GlobalAnimEventListInfo *));
11626 gaei->event_list[list_pos] =
11627 checked_calloc(sizeof(struct GlobalAnimEventListInfo));
11629 struct GlobalAnimEventListInfo *gaeli = gaei->event_list[list_pos];
11631 gaeli->event_value = NULL;
11632 gaeli->num_event_values = 0;
11637 static int AddGlobalAnimEventValue(int list_pos, int event_value)
11639 // do not add empty global animation events
11640 if (event_value == ANIM_EVENT_NONE)
11643 // if list position is undefined, create new list
11644 if (list_pos == ANIM_EVENT_UNDEFINED)
11645 list_pos = AddGlobalAnimEventList();
11647 struct GlobalAnimEventInfo *gaei = &global_anim_event_info;
11648 struct GlobalAnimEventListInfo *gaeli = gaei->event_list[list_pos];
11649 int value_pos = gaeli->num_event_values++;
11651 gaeli->event_value = checked_realloc(gaeli->event_value,
11652 gaeli->num_event_values * sizeof(int *));
11654 gaeli->event_value[value_pos] = event_value;
11659 int GetGlobalAnimEventValue(int list_pos, int value_pos)
11661 if (list_pos == ANIM_EVENT_UNDEFINED)
11662 return ANIM_EVENT_NONE;
11664 struct GlobalAnimEventInfo *gaei = &global_anim_event_info;
11665 struct GlobalAnimEventListInfo *gaeli = gaei->event_list[list_pos];
11667 return gaeli->event_value[value_pos];
11670 int GetGlobalAnimEventValueCount(int list_pos)
11672 if (list_pos == ANIM_EVENT_UNDEFINED)
11675 struct GlobalAnimEventInfo *gaei = &global_anim_event_info;
11676 struct GlobalAnimEventListInfo *gaeli = gaei->event_list[list_pos];
11678 return gaeli->num_event_values;
11681 // This function checks if a string <s> of the format "string1, string2, ..."
11682 // exactly contains a string <s_contained>.
11684 static boolean string_has_parameter(char *s, char *s_contained)
11688 if (s == NULL || s_contained == NULL)
11691 if (strlen(s_contained) > strlen(s))
11694 if (strncmp(s, s_contained, strlen(s_contained)) == 0)
11696 char next_char = s[strlen(s_contained)];
11698 // check if next character is delimiter or whitespace
11699 return (next_char == ',' || next_char == '\0' ||
11700 next_char == ' ' || next_char == '\t' ? TRUE : FALSE);
11703 // check if string contains another parameter string after a comma
11704 substring = strchr(s, ',');
11705 if (substring == NULL) // string does not contain a comma
11708 // advance string pointer to next character after the comma
11711 // skip potential whitespaces after the comma
11712 while (*substring == ' ' || *substring == '\t')
11715 return string_has_parameter(substring, s_contained);
11718 static int get_anim_parameter_value(char *s)
11720 int event_value[] =
11728 char *pattern_1[] =
11736 char *pattern_2 = ".part_";
11737 char *matching_char = NULL;
11739 int pattern_1_len = 0;
11740 int result = ANIM_EVENT_NONE;
11743 for (i = 0; i < ARRAY_SIZE(event_value); i++)
11745 matching_char = strstr(s_ptr, pattern_1[i]);
11746 pattern_1_len = strlen(pattern_1[i]);
11747 result = event_value[i];
11749 if (matching_char != NULL)
11753 if (matching_char == NULL)
11754 return ANIM_EVENT_NONE;
11756 s_ptr = matching_char + pattern_1_len;
11758 // check for main animation number ("anim_X" or "anim_XX")
11759 if (*s_ptr >= '0' && *s_ptr <= '9')
11761 int gic_anim_nr = (*s_ptr++ - '0');
11763 if (*s_ptr >= '0' && *s_ptr <= '9')
11764 gic_anim_nr = 10 * gic_anim_nr + (*s_ptr++ - '0');
11766 if (gic_anim_nr < 1 || gic_anim_nr > MAX_GLOBAL_ANIMS)
11767 return ANIM_EVENT_NONE;
11769 result |= gic_anim_nr << ANIM_EVENT_ANIM_BIT;
11773 // invalid main animation number specified
11775 return ANIM_EVENT_NONE;
11778 // check for animation part number ("part_X" or "part_XX") (optional)
11779 if (strPrefix(s_ptr, pattern_2))
11781 s_ptr += strlen(pattern_2);
11783 if (*s_ptr >= '0' && *s_ptr <= '9')
11785 int gic_part_nr = (*s_ptr++ - '0');
11787 if (*s_ptr >= '0' && *s_ptr <= '9')
11788 gic_part_nr = 10 * gic_part_nr + (*s_ptr++ - '0');
11790 if (gic_part_nr < 1 || gic_part_nr > MAX_GLOBAL_ANIM_PARTS)
11791 return ANIM_EVENT_NONE;
11793 result |= gic_part_nr << ANIM_EVENT_PART_BIT;
11797 // invalid animation part number specified
11799 return ANIM_EVENT_NONE;
11803 // discard result if next character is neither delimiter nor whitespace
11804 if (!(*s_ptr == ',' || *s_ptr == '\0' ||
11805 *s_ptr == ' ' || *s_ptr == '\t'))
11806 return ANIM_EVENT_NONE;
11811 static int get_anim_parameter_values(char *s)
11813 int list_pos = ANIM_EVENT_UNDEFINED;
11814 int event_value = ANIM_EVENT_DEFAULT;
11816 if (string_has_parameter(s, "any"))
11817 event_value |= ANIM_EVENT_ANY;
11819 if (string_has_parameter(s, "click:self") ||
11820 string_has_parameter(s, "click") ||
11821 string_has_parameter(s, "self"))
11822 event_value |= ANIM_EVENT_SELF;
11824 if (string_has_parameter(s, "unclick:any"))
11825 event_value |= ANIM_EVENT_UNCLICK_ANY;
11827 // if animation event found, add it to global animation event list
11828 if (event_value != ANIM_EVENT_NONE)
11829 list_pos = AddGlobalAnimEventValue(list_pos, event_value);
11833 // add optional "click:anim_X" or "click:anim_X.part_X" parameter
11834 event_value = get_anim_parameter_value(s);
11836 // if animation event found, add it to global animation event list
11837 if (event_value != ANIM_EVENT_NONE)
11838 list_pos = AddGlobalAnimEventValue(list_pos, event_value);
11840 // continue with next part of the string, starting with next comma
11841 s = strchr(s + 1, ',');
11847 static int get_anim_action_parameter_value(char *token)
11849 // check most common default case first to massively speed things up
11850 if (strEqual(token, ARG_UNDEFINED))
11851 return ANIM_EVENT_ACTION_NONE;
11853 int result = getImageIDFromToken(token);
11857 char *gfx_token = getStringCat2("gfx.", token);
11859 result = getImageIDFromToken(gfx_token);
11861 checked_free(gfx_token);
11866 Key key = getKeyFromX11KeyName(token);
11868 if (key != KSYM_UNDEFINED)
11869 result = -(int)key;
11873 result = ANIM_EVENT_ACTION_NONE;
11878 int get_parameter_value(char *value_raw, char *suffix, int type)
11880 char *value = getStringToLower(value_raw);
11881 int result = 0; // probably a save default value
11883 if (strEqual(suffix, ".direction"))
11885 result = (strEqual(value, "left") ? MV_LEFT :
11886 strEqual(value, "right") ? MV_RIGHT :
11887 strEqual(value, "up") ? MV_UP :
11888 strEqual(value, "down") ? MV_DOWN : MV_NONE);
11890 else if (strEqual(suffix, ".position"))
11892 result = (strEqual(value, "left") ? POS_LEFT :
11893 strEqual(value, "right") ? POS_RIGHT :
11894 strEqual(value, "top") ? POS_TOP :
11895 strEqual(value, "upper") ? POS_UPPER :
11896 strEqual(value, "middle") ? POS_MIDDLE :
11897 strEqual(value, "lower") ? POS_LOWER :
11898 strEqual(value, "bottom") ? POS_BOTTOM :
11899 strEqual(value, "any") ? POS_ANY :
11900 strEqual(value, "last") ? POS_LAST : POS_UNDEFINED);
11902 else if (strEqual(suffix, ".align"))
11904 result = (strEqual(value, "left") ? ALIGN_LEFT :
11905 strEqual(value, "right") ? ALIGN_RIGHT :
11906 strEqual(value, "center") ? ALIGN_CENTER :
11907 strEqual(value, "middle") ? ALIGN_CENTER : ALIGN_DEFAULT);
11909 else if (strEqual(suffix, ".valign"))
11911 result = (strEqual(value, "top") ? VALIGN_TOP :
11912 strEqual(value, "bottom") ? VALIGN_BOTTOM :
11913 strEqual(value, "middle") ? VALIGN_MIDDLE :
11914 strEqual(value, "center") ? VALIGN_MIDDLE : VALIGN_DEFAULT);
11916 else if (strEqual(suffix, ".anim_mode"))
11918 result = (string_has_parameter(value, "none") ? ANIM_NONE :
11919 string_has_parameter(value, "loop") ? ANIM_LOOP :
11920 string_has_parameter(value, "linear") ? ANIM_LINEAR :
11921 string_has_parameter(value, "pingpong") ? ANIM_PINGPONG :
11922 string_has_parameter(value, "pingpong2") ? ANIM_PINGPONG2 :
11923 string_has_parameter(value, "random") ? ANIM_RANDOM :
11924 string_has_parameter(value, "ce_value") ? ANIM_CE_VALUE :
11925 string_has_parameter(value, "ce_score") ? ANIM_CE_SCORE :
11926 string_has_parameter(value, "ce_delay") ? ANIM_CE_DELAY :
11927 string_has_parameter(value, "horizontal") ? ANIM_HORIZONTAL :
11928 string_has_parameter(value, "vertical") ? ANIM_VERTICAL :
11929 string_has_parameter(value, "centered") ? ANIM_CENTERED :
11930 string_has_parameter(value, "all") ? ANIM_ALL :
11933 if (string_has_parameter(value, "once"))
11934 result |= ANIM_ONCE;
11936 if (string_has_parameter(value, "reverse"))
11937 result |= ANIM_REVERSE;
11939 if (string_has_parameter(value, "opaque_player"))
11940 result |= ANIM_OPAQUE_PLAYER;
11942 if (string_has_parameter(value, "static_panel"))
11943 result |= ANIM_STATIC_PANEL;
11945 else if (strEqual(suffix, ".init_event") ||
11946 strEqual(suffix, ".anim_event"))
11948 result = get_anim_parameter_values(value);
11950 else if (strEqual(suffix, ".init_delay_action") ||
11951 strEqual(suffix, ".anim_delay_action") ||
11952 strEqual(suffix, ".post_delay_action") ||
11953 strEqual(suffix, ".init_event_action") ||
11954 strEqual(suffix, ".anim_event_action"))
11956 result = get_anim_action_parameter_value(value_raw);
11958 else if (strEqual(suffix, ".class"))
11960 result = (strEqual(value, ARG_UNDEFINED) ? ARG_UNDEFINED_VALUE :
11961 get_hash_from_key(value));
11963 else if (strEqual(suffix, ".style"))
11965 result = STYLE_DEFAULT;
11967 if (string_has_parameter(value, "accurate_borders"))
11968 result |= STYLE_ACCURATE_BORDERS;
11970 if (string_has_parameter(value, "inner_corners"))
11971 result |= STYLE_INNER_CORNERS;
11973 if (string_has_parameter(value, "reverse"))
11974 result |= STYLE_REVERSE;
11976 if (string_has_parameter(value, "leftmost_position"))
11977 result |= STYLE_LEFTMOST_POSITION;
11979 if (string_has_parameter(value, "block_clicks"))
11980 result |= STYLE_BLOCK;
11982 if (string_has_parameter(value, "passthrough_clicks"))
11983 result |= STYLE_PASSTHROUGH;
11985 if (string_has_parameter(value, "multiple_actions"))
11986 result |= STYLE_MULTIPLE_ACTIONS;
11988 else if (strEqual(suffix, ".fade_mode"))
11990 result = (string_has_parameter(value, "none") ? FADE_MODE_NONE :
11991 string_has_parameter(value, "fade") ? FADE_MODE_FADE :
11992 string_has_parameter(value, "crossfade") ? FADE_MODE_CROSSFADE :
11993 string_has_parameter(value, "melt") ? FADE_MODE_MELT :
11994 string_has_parameter(value, "curtain") ? FADE_MODE_CURTAIN :
11995 FADE_MODE_DEFAULT);
11997 else if (strEqual(suffix, ".auto_delay_unit"))
11999 result = (string_has_parameter(value, "ms") ? AUTO_DELAY_UNIT_MS :
12000 string_has_parameter(value, "frames") ? AUTO_DELAY_UNIT_FRAMES :
12001 AUTO_DELAY_UNIT_DEFAULT);
12003 else if (strPrefix(suffix, ".font")) // (may also be ".font_xyz")
12005 result = gfx.get_font_from_token_function(value);
12007 else // generic parameter of type integer or boolean
12009 result = (strEqual(value, ARG_UNDEFINED) ? ARG_UNDEFINED_VALUE :
12010 type == TYPE_INTEGER ? get_integer_from_string(value) :
12011 type == TYPE_BOOLEAN ? get_boolean_from_string(value) :
12012 ARG_UNDEFINED_VALUE);
12020 static int get_token_parameter_value(char *token, char *value_raw)
12024 if (token == NULL || value_raw == NULL)
12025 return ARG_UNDEFINED_VALUE;
12027 suffix = strrchr(token, '.');
12028 if (suffix == NULL)
12031 if (strEqual(suffix, ".element"))
12032 return getElementFromToken(value_raw);
12034 // !!! USE CORRECT VALUE TYPE (currently works also for TYPE_BOOLEAN) !!!
12035 return get_parameter_value(value_raw, suffix, TYPE_INTEGER);
12038 void InitMenuDesignSettings_Static(void)
12042 // always start with reliable default values from static default config
12043 for (i = 0; image_config_vars[i].token != NULL; i++)
12045 char *value = getHashEntry(image_config_hash, image_config_vars[i].token);
12048 *image_config_vars[i].value =
12049 get_token_parameter_value(image_config_vars[i].token, value);
12053 static void InitMenuDesignSettings_SpecialPreProcessing(void)
12057 // the following initializes hierarchical values from static configuration
12059 // special case: initialize "ARG_DEFAULT" values in static default config
12060 // (e.g., initialize "[titlemessage].fade_mode" from "[title].fade_mode")
12061 titlescreen_initial_first_default.fade_mode =
12062 title_initial_first_default.fade_mode;
12063 titlescreen_initial_first_default.fade_delay =
12064 title_initial_first_default.fade_delay;
12065 titlescreen_initial_first_default.post_delay =
12066 title_initial_first_default.post_delay;
12067 titlescreen_initial_first_default.auto_delay =
12068 title_initial_first_default.auto_delay;
12069 titlescreen_initial_first_default.auto_delay_unit =
12070 title_initial_first_default.auto_delay_unit;
12071 titlescreen_first_default.fade_mode = title_first_default.fade_mode;
12072 titlescreen_first_default.fade_delay = title_first_default.fade_delay;
12073 titlescreen_first_default.post_delay = title_first_default.post_delay;
12074 titlescreen_first_default.auto_delay = title_first_default.auto_delay;
12075 titlescreen_first_default.auto_delay_unit =
12076 title_first_default.auto_delay_unit;
12077 titlemessage_initial_first_default.fade_mode =
12078 title_initial_first_default.fade_mode;
12079 titlemessage_initial_first_default.fade_delay =
12080 title_initial_first_default.fade_delay;
12081 titlemessage_initial_first_default.post_delay =
12082 title_initial_first_default.post_delay;
12083 titlemessage_initial_first_default.auto_delay =
12084 title_initial_first_default.auto_delay;
12085 titlemessage_initial_first_default.auto_delay_unit =
12086 title_initial_first_default.auto_delay_unit;
12087 titlemessage_first_default.fade_mode = title_first_default.fade_mode;
12088 titlemessage_first_default.fade_delay = title_first_default.fade_delay;
12089 titlemessage_first_default.post_delay = title_first_default.post_delay;
12090 titlemessage_first_default.auto_delay = title_first_default.auto_delay;
12091 titlemessage_first_default.auto_delay_unit =
12092 title_first_default.auto_delay_unit;
12094 titlescreen_initial_default.fade_mode = title_initial_default.fade_mode;
12095 titlescreen_initial_default.fade_delay = title_initial_default.fade_delay;
12096 titlescreen_initial_default.post_delay = title_initial_default.post_delay;
12097 titlescreen_initial_default.auto_delay = title_initial_default.auto_delay;
12098 titlescreen_initial_default.auto_delay_unit =
12099 title_initial_default.auto_delay_unit;
12100 titlescreen_default.fade_mode = title_default.fade_mode;
12101 titlescreen_default.fade_delay = title_default.fade_delay;
12102 titlescreen_default.post_delay = title_default.post_delay;
12103 titlescreen_default.auto_delay = title_default.auto_delay;
12104 titlescreen_default.auto_delay_unit = title_default.auto_delay_unit;
12105 titlemessage_initial_default.fade_mode = title_initial_default.fade_mode;
12106 titlemessage_initial_default.fade_delay = title_initial_default.fade_delay;
12107 titlemessage_initial_default.post_delay = title_initial_default.post_delay;
12108 titlemessage_initial_default.auto_delay_unit =
12109 title_initial_default.auto_delay_unit;
12110 titlemessage_default.fade_mode = title_default.fade_mode;
12111 titlemessage_default.fade_delay = title_default.fade_delay;
12112 titlemessage_default.post_delay = title_default.post_delay;
12113 titlemessage_default.auto_delay = title_default.auto_delay;
12114 titlemessage_default.auto_delay_unit = title_default.auto_delay_unit;
12116 // special case: initialize "ARG_DEFAULT" values in static default config
12117 // (e.g., init "titlemessage_1.fade_mode" from "[titlemessage].fade_mode")
12118 for (i = 0; i < MAX_NUM_TITLE_MESSAGES; i++)
12120 titlescreen_initial_first[i] = titlescreen_initial_first_default;
12121 titlescreen_first[i] = titlescreen_first_default;
12122 titlemessage_initial_first[i] = titlemessage_initial_first_default;
12123 titlemessage_first[i] = titlemessage_first_default;
12125 titlescreen_initial[i] = titlescreen_initial_default;
12126 titlescreen[i] = titlescreen_default;
12127 titlemessage_initial[i] = titlemessage_initial_default;
12128 titlemessage[i] = titlemessage_default;
12131 // special case: initialize "ARG_DEFAULT" values in static default config
12132 // (eg, init "menu.enter_screen.SCORES.xyz" from "menu.enter_screen.xyz")
12133 for (i = 0; i < NUM_SPECIAL_GFX_ARGS; i++)
12135 if (i == GFX_SPECIAL_ARG_TITLE) // title values already initialized
12138 menu.enter_screen[i] = menu.enter_screen[GFX_SPECIAL_ARG_DEFAULT];
12139 menu.leave_screen[i] = menu.leave_screen[GFX_SPECIAL_ARG_DEFAULT];
12140 menu.next_screen[i] = menu.next_screen[GFX_SPECIAL_ARG_DEFAULT];
12143 // special case: initialize "ARG_DEFAULT" values in static default config
12144 // (eg, init "viewport.door_1.MAIN.xyz" from "viewport.door_1.xyz")
12145 for (i = 0; i < NUM_SPECIAL_GFX_ARGS; i++)
12147 viewport.window[i] = viewport.window[GFX_SPECIAL_ARG_DEFAULT];
12148 viewport.playfield[i] = viewport.playfield[GFX_SPECIAL_ARG_DEFAULT];
12149 viewport.door_1[i] = viewport.door_1[GFX_SPECIAL_ARG_DEFAULT];
12151 if (i == GFX_SPECIAL_ARG_EDITOR) // editor values already initialized
12154 viewport.door_2[i] = viewport.door_2[GFX_SPECIAL_ARG_DEFAULT];
12158 static void InitMenuDesignSettings_SpecialPostProcessing(void)
12162 struct XY *dst, *src;
12164 game_buttons_xy[] =
12166 { &game.button.save, &game.button.stop },
12167 { &game.button.pause2, &game.button.pause },
12168 { &game.button.load, &game.button.play },
12169 { &game.button.undo, &game.button.stop },
12170 { &game.button.redo, &game.button.play },
12176 // special case: initialize later added SETUP list size from LEVELS value
12177 if (menu.list_size[GAME_MODE_SETUP] == -1)
12178 menu.list_size[GAME_MODE_SETUP] = menu.list_size[GAME_MODE_LEVELS];
12180 // set default position for snapshot buttons to stop/pause/play buttons
12181 for (i = 0; game_buttons_xy[i].dst != NULL; i++)
12182 if ((*game_buttons_xy[i].dst).x == -1 &&
12183 (*game_buttons_xy[i].dst).y == -1)
12184 *game_buttons_xy[i].dst = *game_buttons_xy[i].src;
12186 // --------------------------------------------------------------------------
12187 // dynamic viewports (including playfield margins, borders and alignments)
12188 // --------------------------------------------------------------------------
12190 // dynamic viewports currently only supported for landscape mode
12191 int display_width = MAX(video.display_width, video.display_height);
12192 int display_height = MIN(video.display_width, video.display_height);
12194 for (i = 0; i < NUM_SPECIAL_GFX_ARGS; i++)
12196 struct RectWithBorder *vp_window = &viewport.window[i];
12197 struct RectWithBorder *vp_playfield = &viewport.playfield[i];
12198 struct RectWithBorder *vp_door_1 = &viewport.door_1[i];
12199 struct RectWithBorder *vp_door_2 = &viewport.door_2[i];
12200 boolean dynamic_window_width = (vp_window->min_width != -1);
12201 boolean dynamic_window_height = (vp_window->min_height != -1);
12202 boolean dynamic_playfield_width = (vp_playfield->min_width != -1);
12203 boolean dynamic_playfield_height = (vp_playfield->min_height != -1);
12205 // adjust window size if min/max width/height is specified
12207 if (vp_window->min_width != -1)
12209 int window_width = display_width;
12211 // when using static window height, use aspect ratio of display
12212 if (vp_window->min_height == -1)
12213 window_width = vp_window->height * display_width / display_height;
12215 vp_window->width = MAX(vp_window->min_width, window_width);
12218 if (vp_window->min_height != -1)
12220 int window_height = display_height;
12222 // when using static window width, use aspect ratio of display
12223 if (vp_window->min_width == -1)
12224 window_height = vp_window->width * display_height / display_width;
12226 vp_window->height = MAX(vp_window->min_height, window_height);
12229 if (vp_window->max_width != -1)
12230 vp_window->width = MIN(vp_window->width, vp_window->max_width);
12232 if (vp_window->max_height != -1)
12233 vp_window->height = MIN(vp_window->height, vp_window->max_height);
12235 int playfield_width = vp_window->width;
12236 int playfield_height = vp_window->height;
12238 // adjust playfield size and position according to specified margins
12240 playfield_width -= vp_playfield->margin_left;
12241 playfield_width -= vp_playfield->margin_right;
12243 playfield_height -= vp_playfield->margin_top;
12244 playfield_height -= vp_playfield->margin_bottom;
12246 // adjust playfield size if min/max width/height is specified
12248 if (vp_playfield->min_width != -1)
12249 vp_playfield->width = MAX(vp_playfield->min_width, playfield_width);
12251 if (vp_playfield->min_height != -1)
12252 vp_playfield->height = MAX(vp_playfield->min_height, playfield_height);
12254 if (vp_playfield->max_width != -1)
12255 vp_playfield->width = MIN(vp_playfield->width, vp_playfield->max_width);
12257 if (vp_playfield->max_height != -1)
12258 vp_playfield->height = MIN(vp_playfield->height,vp_playfield->max_height);
12260 // adjust playfield position according to specified alignment
12262 if (vp_playfield->align == ALIGN_LEFT || vp_playfield->x > 0)
12263 vp_playfield->x = ALIGNED_VP_XPOS(vp_playfield);
12264 else if (vp_playfield->align == ALIGN_CENTER)
12265 vp_playfield->x = playfield_width / 2 - vp_playfield->width / 2;
12266 else if (vp_playfield->align == ALIGN_RIGHT)
12267 vp_playfield->x += playfield_width - vp_playfield->width;
12269 if (vp_playfield->valign == VALIGN_TOP || vp_playfield->y > 0)
12270 vp_playfield->y = ALIGNED_VP_YPOS(vp_playfield);
12271 else if (vp_playfield->valign == VALIGN_MIDDLE)
12272 vp_playfield->y = playfield_height / 2 - vp_playfield->height / 2;
12273 else if (vp_playfield->valign == VALIGN_BOTTOM)
12274 vp_playfield->y += playfield_height - vp_playfield->height;
12276 vp_playfield->x += vp_playfield->margin_left;
12277 vp_playfield->y += vp_playfield->margin_top;
12279 // adjust individual playfield borders if only default border is specified
12281 if (vp_playfield->border_left == -1)
12282 vp_playfield->border_left = vp_playfield->border_size;
12283 if (vp_playfield->border_right == -1)
12284 vp_playfield->border_right = vp_playfield->border_size;
12285 if (vp_playfield->border_top == -1)
12286 vp_playfield->border_top = vp_playfield->border_size;
12287 if (vp_playfield->border_bottom == -1)
12288 vp_playfield->border_bottom = vp_playfield->border_size;
12290 // set dynamic playfield borders if borders are specified as undefined
12291 // (but only if window size was dynamic and playfield size was static)
12293 if (dynamic_window_width && !dynamic_playfield_width)
12295 if (vp_playfield->border_left == -1)
12297 vp_playfield->border_left = (vp_playfield->x -
12298 vp_playfield->margin_left);
12299 vp_playfield->x -= vp_playfield->border_left;
12300 vp_playfield->width += vp_playfield->border_left;
12303 if (vp_playfield->border_right == -1)
12305 vp_playfield->border_right = (vp_window->width -
12307 vp_playfield->width -
12308 vp_playfield->margin_right);
12309 vp_playfield->width += vp_playfield->border_right;
12313 if (dynamic_window_height && !dynamic_playfield_height)
12315 if (vp_playfield->border_top == -1)
12317 vp_playfield->border_top = (vp_playfield->y -
12318 vp_playfield->margin_top);
12319 vp_playfield->y -= vp_playfield->border_top;
12320 vp_playfield->height += vp_playfield->border_top;
12323 if (vp_playfield->border_bottom == -1)
12325 vp_playfield->border_bottom = (vp_window->height -
12327 vp_playfield->height -
12328 vp_playfield->margin_bottom);
12329 vp_playfield->height += vp_playfield->border_bottom;
12333 // adjust playfield size to be a multiple of a defined alignment tile size
12335 int align_size = vp_playfield->align_size;
12336 int playfield_xtiles = vp_playfield->width / align_size;
12337 int playfield_ytiles = vp_playfield->height / align_size;
12338 int playfield_width_corrected = playfield_xtiles * align_size;
12339 int playfield_height_corrected = playfield_ytiles * align_size;
12340 boolean is_playfield_mode = (i == GFX_SPECIAL_ARG_PLAYING ||
12341 i == GFX_SPECIAL_ARG_EDITOR);
12343 if (is_playfield_mode &&
12344 dynamic_playfield_width &&
12345 vp_playfield->width != playfield_width_corrected)
12347 int playfield_xdiff = vp_playfield->width - playfield_width_corrected;
12349 vp_playfield->width = playfield_width_corrected;
12351 if (vp_playfield->align == ALIGN_LEFT)
12353 vp_playfield->border_left += playfield_xdiff;
12355 else if (vp_playfield->align == ALIGN_RIGHT)
12357 vp_playfield->border_right += playfield_xdiff;
12359 else if (vp_playfield->align == ALIGN_CENTER)
12361 int border_left_diff = playfield_xdiff / 2;
12362 int border_right_diff = playfield_xdiff - border_left_diff;
12364 vp_playfield->border_left += border_left_diff;
12365 vp_playfield->border_right += border_right_diff;
12369 if (is_playfield_mode &&
12370 dynamic_playfield_height &&
12371 vp_playfield->height != playfield_height_corrected)
12373 int playfield_ydiff = vp_playfield->height - playfield_height_corrected;
12375 vp_playfield->height = playfield_height_corrected;
12377 if (vp_playfield->valign == VALIGN_TOP)
12379 vp_playfield->border_top += playfield_ydiff;
12381 else if (vp_playfield->align == VALIGN_BOTTOM)
12383 vp_playfield->border_right += playfield_ydiff;
12385 else if (vp_playfield->align == VALIGN_MIDDLE)
12387 int border_top_diff = playfield_ydiff / 2;
12388 int border_bottom_diff = playfield_ydiff - border_top_diff;
12390 vp_playfield->border_top += border_top_diff;
12391 vp_playfield->border_bottom += border_bottom_diff;
12395 // adjust door positions according to specified alignment
12397 for (j = 0; j < 2; j++)
12399 struct RectWithBorder *vp_door = (j == 0 ? vp_door_1 : vp_door_2);
12401 if (vp_door->align == ALIGN_LEFT || vp_door->x > 0)
12402 vp_door->x = ALIGNED_VP_XPOS(vp_door);
12403 else if (vp_door->align == ALIGN_CENTER)
12404 vp_door->x = vp_window->width / 2 - vp_door->width / 2;
12405 else if (vp_door->align == ALIGN_RIGHT)
12406 vp_door->x += vp_window->width - vp_door->width;
12408 if (vp_door->valign == VALIGN_TOP || vp_door->y > 0)
12409 vp_door->y = ALIGNED_VP_YPOS(vp_door);
12410 else if (vp_door->valign == VALIGN_MIDDLE)
12411 vp_door->y = vp_window->height / 2 - vp_door->height / 2;
12412 else if (vp_door->valign == VALIGN_BOTTOM)
12413 vp_door->y += vp_window->height - vp_door->height;
12418 static void InitMenuDesignSettings_SpecialPostProcessing_AfterGraphics(void)
12422 struct XYTileSize *dst, *src;
12425 editor_buttons_xy[] =
12428 &editor.button.element_left, &editor.palette.element_left,
12429 IMG_GFX_EDITOR_BUTTON_ELEMENT_LEFT
12432 &editor.button.element_middle, &editor.palette.element_middle,
12433 IMG_GFX_EDITOR_BUTTON_ELEMENT_MIDDLE
12436 &editor.button.element_right, &editor.palette.element_right,
12437 IMG_GFX_EDITOR_BUTTON_ELEMENT_RIGHT
12444 // set default position for element buttons to element graphics
12445 for (i = 0; editor_buttons_xy[i].dst != NULL; i++)
12447 if ((*editor_buttons_xy[i].dst).x == -1 &&
12448 (*editor_buttons_xy[i].dst).y == -1)
12450 struct GraphicInfo *gd = &graphic_info[editor_buttons_xy[i].graphic];
12452 gd->width = gd->height = editor_buttons_xy[i].src->tile_size;
12454 *editor_buttons_xy[i].dst = *editor_buttons_xy[i].src;
12458 // adjust editor palette rows and columns if specified to be dynamic
12460 if (editor.palette.cols == -1)
12462 int vp_width = viewport.playfield[GFX_SPECIAL_ARG_EDITOR].width;
12463 int bt_width = graphic_info[IMG_EDITOR_PALETTE_BUTTON].width;
12464 int sc_width = graphic_info[IMG_EDITOR_PALETTE_SCROLLBAR].width;
12466 editor.palette.cols = (vp_width - sc_width) / bt_width;
12468 if (editor.palette.x == -1)
12470 int palette_width = editor.palette.cols * bt_width + sc_width;
12472 editor.palette.x = (vp_width - palette_width) / 2;
12476 if (editor.palette.rows == -1)
12478 int vp_height = viewport.playfield[GFX_SPECIAL_ARG_EDITOR].height;
12479 int bt_height = graphic_info[IMG_EDITOR_PALETTE_BUTTON].height;
12480 int tx_height = getFontHeight(FONT_TEXT_2);
12482 editor.palette.rows = (vp_height - tx_height) / bt_height;
12484 if (editor.palette.y == -1)
12486 int palette_height = editor.palette.rows * bt_height + tx_height;
12488 editor.palette.y = (vp_height - palette_height) / 2;
12493 static void LoadMenuDesignSettingsFromFilename(char *filename)
12495 static struct TitleFadingInfo tfi;
12496 static struct TitleMessageInfo tmi;
12497 static struct TokenInfo title_tokens[] =
12499 { TYPE_INTEGER, &tfi.fade_mode, ".fade_mode" },
12500 { TYPE_INTEGER, &tfi.fade_delay, ".fade_delay" },
12501 { TYPE_INTEGER, &tfi.post_delay, ".post_delay" },
12502 { TYPE_INTEGER, &tfi.auto_delay, ".auto_delay" },
12503 { TYPE_INTEGER, &tfi.auto_delay_unit, ".auto_delay_unit" },
12507 static struct TokenInfo titlemessage_tokens[] =
12509 { TYPE_INTEGER, &tmi.x, ".x" },
12510 { TYPE_INTEGER, &tmi.y, ".y" },
12511 { TYPE_INTEGER, &tmi.width, ".width" },
12512 { TYPE_INTEGER, &tmi.height, ".height" },
12513 { TYPE_INTEGER, &tmi.chars, ".chars" },
12514 { TYPE_INTEGER, &tmi.lines, ".lines" },
12515 { TYPE_INTEGER, &tmi.align, ".align" },
12516 { TYPE_INTEGER, &tmi.valign, ".valign" },
12517 { TYPE_INTEGER, &tmi.font, ".font" },
12518 { TYPE_BOOLEAN, &tmi.autowrap, ".autowrap" },
12519 { TYPE_BOOLEAN, &tmi.centered, ".centered" },
12520 { TYPE_BOOLEAN, &tmi.parse_comments, ".parse_comments" },
12521 { TYPE_INTEGER, &tmi.sort_priority, ".sort_priority" },
12522 { TYPE_INTEGER, &tmi.fade_mode, ".fade_mode" },
12523 { TYPE_INTEGER, &tmi.fade_delay, ".fade_delay" },
12524 { TYPE_INTEGER, &tmi.post_delay, ".post_delay" },
12525 { TYPE_INTEGER, &tmi.auto_delay, ".auto_delay" },
12526 { TYPE_INTEGER, &tmi.auto_delay_unit, ".auto_delay_unit" },
12532 struct TitleFadingInfo *info;
12537 // initialize first titles from "enter screen" definitions, if defined
12538 { &title_initial_first_default, "menu.enter_screen.TITLE" },
12539 { &title_first_default, "menu.enter_screen.TITLE" },
12541 // initialize title screens from "next screen" definitions, if defined
12542 { &title_initial_default, "menu.next_screen.TITLE" },
12543 { &title_default, "menu.next_screen.TITLE" },
12549 struct TitleMessageInfo *array;
12552 titlemessage_arrays[] =
12554 // initialize first titles from "enter screen" definitions, if defined
12555 { titlescreen_initial_first, "menu.enter_screen.TITLE" },
12556 { titlescreen_first, "menu.enter_screen.TITLE" },
12557 { titlemessage_initial_first, "menu.enter_screen.TITLE" },
12558 { titlemessage_first, "menu.enter_screen.TITLE" },
12560 // initialize titles from "next screen" definitions, if defined
12561 { titlescreen_initial, "menu.next_screen.TITLE" },
12562 { titlescreen, "menu.next_screen.TITLE" },
12563 { titlemessage_initial, "menu.next_screen.TITLE" },
12564 { titlemessage, "menu.next_screen.TITLE" },
12566 // overwrite titles with title definitions, if defined
12567 { titlescreen_initial_first, "[title_initial]" },
12568 { titlescreen_first, "[title]" },
12569 { titlemessage_initial_first, "[title_initial]" },
12570 { titlemessage_first, "[title]" },
12572 { titlescreen_initial, "[title_initial]" },
12573 { titlescreen, "[title]" },
12574 { titlemessage_initial, "[title_initial]" },
12575 { titlemessage, "[title]" },
12577 // overwrite titles with title screen/message definitions, if defined
12578 { titlescreen_initial_first, "[titlescreen_initial]" },
12579 { titlescreen_first, "[titlescreen]" },
12580 { titlemessage_initial_first, "[titlemessage_initial]" },
12581 { titlemessage_first, "[titlemessage]" },
12583 { titlescreen_initial, "[titlescreen_initial]" },
12584 { titlescreen, "[titlescreen]" },
12585 { titlemessage_initial, "[titlemessage_initial]" },
12586 { titlemessage, "[titlemessage]" },
12590 SetupFileHash *setup_file_hash;
12593 if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
12596 // the following initializes hierarchical values from dynamic configuration
12598 // special case: initialize with default values that may be overwritten
12599 // (e.g., init "menu.draw_xoffset.INFO" from "menu.draw_xoffset")
12600 for (i = 0; i < NUM_SPECIAL_GFX_ARGS; i++)
12602 struct TokenIntPtrInfo menu_config[] =
12604 { "menu.draw_xoffset", &menu.draw_xoffset[i] },
12605 { "menu.draw_yoffset", &menu.draw_yoffset[i] },
12606 { "menu.list_size", &menu.list_size[i] }
12609 for (j = 0; j < ARRAY_SIZE(menu_config); j++)
12611 char *token = menu_config[j].token;
12612 char *value = getHashEntry(setup_file_hash, token);
12615 *menu_config[j].value = get_integer_from_string(value);
12619 // special case: initialize with default values that may be overwritten
12620 // (eg, init "menu.draw_xoffset.INFO[XXX]" from "menu.draw_xoffset.INFO")
12621 for (i = 0; i < NUM_SPECIAL_GFX_INFO_ARGS; i++)
12623 struct TokenIntPtrInfo menu_config[] =
12625 { "menu.draw_xoffset.INFO", &menu.draw_xoffset_info[i] },
12626 { "menu.draw_yoffset.INFO", &menu.draw_yoffset_info[i] },
12627 { "menu.list_size.INFO", &menu.list_size_info[i] }
12630 for (j = 0; j < ARRAY_SIZE(menu_config); j++)
12632 char *token = menu_config[j].token;
12633 char *value = getHashEntry(setup_file_hash, token);
12636 *menu_config[j].value = get_integer_from_string(value);
12640 // special case: initialize with default values that may be overwritten
12641 // (eg, init "menu.draw_xoffset.SETUP[XXX]" from "menu.draw_xoffset.SETUP")
12642 for (i = 0; i < NUM_SPECIAL_GFX_SETUP_ARGS; i++)
12644 struct TokenIntPtrInfo menu_config[] =
12646 { "menu.draw_xoffset.SETUP", &menu.draw_xoffset_setup[i] },
12647 { "menu.draw_yoffset.SETUP", &menu.draw_yoffset_setup[i] }
12650 for (j = 0; j < ARRAY_SIZE(menu_config); j++)
12652 char *token = menu_config[j].token;
12653 char *value = getHashEntry(setup_file_hash, token);
12656 *menu_config[j].value = get_integer_from_string(value);
12660 // special case: initialize with default values that may be overwritten
12661 // (eg, init "menu.line_spacing.INFO[XXX]" from "menu.line_spacing.INFO")
12662 for (i = 0; i < NUM_SPECIAL_GFX_INFO_ARGS; i++)
12664 struct TokenIntPtrInfo menu_config[] =
12666 { "menu.left_spacing.INFO", &menu.left_spacing_info[i] },
12667 { "menu.right_spacing.INFO", &menu.right_spacing_info[i] },
12668 { "menu.top_spacing.INFO", &menu.top_spacing_info[i] },
12669 { "menu.bottom_spacing.INFO", &menu.bottom_spacing_info[i] },
12670 { "menu.paragraph_spacing.INFO", &menu.paragraph_spacing_info[i] },
12671 { "menu.headline1_spacing.INFO", &menu.headline1_spacing_info[i] },
12672 { "menu.headline2_spacing.INFO", &menu.headline2_spacing_info[i] },
12673 { "menu.line_spacing.INFO", &menu.line_spacing_info[i] },
12674 { "menu.extra_spacing.INFO", &menu.extra_spacing_info[i] },
12677 for (j = 0; j < ARRAY_SIZE(menu_config); j++)
12679 char *token = menu_config[j].token;
12680 char *value = getHashEntry(setup_file_hash, token);
12683 *menu_config[j].value = get_integer_from_string(value);
12687 // special case: initialize with default values that may be overwritten
12688 // (eg, init "menu.enter_screen.SCORES.xyz" from "menu.enter_screen.xyz")
12689 for (i = 0; i < NUM_SPECIAL_GFX_ARGS; i++)
12691 struct TokenIntPtrInfo menu_config[] =
12693 { "menu.enter_screen.fade_mode", &menu.enter_screen[i].fade_mode },
12694 { "menu.enter_screen.fade_delay", &menu.enter_screen[i].fade_delay },
12695 { "menu.enter_screen.post_delay", &menu.enter_screen[i].post_delay },
12696 { "menu.leave_screen.fade_mode", &menu.leave_screen[i].fade_mode },
12697 { "menu.leave_screen.fade_delay", &menu.leave_screen[i].fade_delay },
12698 { "menu.leave_screen.post_delay", &menu.leave_screen[i].post_delay },
12699 { "menu.next_screen.fade_mode", &menu.next_screen[i].fade_mode },
12700 { "menu.next_screen.fade_delay", &menu.next_screen[i].fade_delay },
12701 { "menu.next_screen.post_delay", &menu.next_screen[i].post_delay }
12704 for (j = 0; j < ARRAY_SIZE(menu_config); j++)
12706 char *token = menu_config[j].token;
12707 char *value = getHashEntry(setup_file_hash, token);
12710 *menu_config[j].value = get_token_parameter_value(token, value);
12714 // special case: initialize with default values that may be overwritten
12715 // (eg, init "viewport.door_1.MAIN.xyz" from "viewport.door_1.xyz")
12716 for (i = 0; i < NUM_SPECIAL_GFX_ARGS; i++)
12720 char *token_prefix;
12721 struct RectWithBorder *struct_ptr;
12725 { "viewport.window", &viewport.window[i] },
12726 { "viewport.playfield", &viewport.playfield[i] },
12727 { "viewport.door_1", &viewport.door_1[i] },
12728 { "viewport.door_2", &viewport.door_2[i] }
12731 for (j = 0; j < ARRAY_SIZE(vp_struct); j++)
12733 struct TokenIntPtrInfo vp_config[] =
12735 { ".x", &vp_struct[j].struct_ptr->x },
12736 { ".y", &vp_struct[j].struct_ptr->y },
12737 { ".width", &vp_struct[j].struct_ptr->width },
12738 { ".height", &vp_struct[j].struct_ptr->height },
12739 { ".min_width", &vp_struct[j].struct_ptr->min_width },
12740 { ".min_height", &vp_struct[j].struct_ptr->min_height },
12741 { ".max_width", &vp_struct[j].struct_ptr->max_width },
12742 { ".max_height", &vp_struct[j].struct_ptr->max_height },
12743 { ".margin_left", &vp_struct[j].struct_ptr->margin_left },
12744 { ".margin_right", &vp_struct[j].struct_ptr->margin_right },
12745 { ".margin_top", &vp_struct[j].struct_ptr->margin_top },
12746 { ".margin_bottom", &vp_struct[j].struct_ptr->margin_bottom },
12747 { ".border_left", &vp_struct[j].struct_ptr->border_left },
12748 { ".border_right", &vp_struct[j].struct_ptr->border_right },
12749 { ".border_top", &vp_struct[j].struct_ptr->border_top },
12750 { ".border_bottom", &vp_struct[j].struct_ptr->border_bottom },
12751 { ".border_size", &vp_struct[j].struct_ptr->border_size },
12752 { ".align_size", &vp_struct[j].struct_ptr->align_size },
12753 { ".align", &vp_struct[j].struct_ptr->align },
12754 { ".valign", &vp_struct[j].struct_ptr->valign }
12757 for (k = 0; k < ARRAY_SIZE(vp_config); k++)
12759 char *token = getStringCat2(vp_struct[j].token_prefix,
12760 vp_config[k].token);
12761 char *value = getHashEntry(setup_file_hash, token);
12764 *vp_config[k].value = get_token_parameter_value(token, value);
12771 // special case: initialize with default values that may be overwritten
12772 // (e.g., init "[title].fade_mode" from "menu.next_screen.TITLE.fade_mode")
12773 for (i = 0; title_info[i].info != NULL; i++)
12775 struct TitleFadingInfo *info = title_info[i].info;
12776 char *base_token = title_info[i].text;
12778 for (j = 0; title_tokens[j].type != -1; j++)
12780 char *token = getStringCat2(base_token, title_tokens[j].text);
12781 char *value = getHashEntry(setup_file_hash, token);
12785 int parameter_value = get_token_parameter_value(token, value);
12789 *(int *)title_tokens[j].value = (int)parameter_value;
12798 // special case: initialize with default values that may be overwritten
12799 // (e.g., init "titlemessage_1.fade_mode" from "[titlemessage].fade_mode")
12800 for (i = 0; titlemessage_arrays[i].array != NULL; i++)
12802 struct TitleMessageInfo *array = titlemessage_arrays[i].array;
12803 char *base_token = titlemessage_arrays[i].text;
12805 for (j = 0; titlemessage_tokens[j].type != -1; j++)
12807 char *token = getStringCat2(base_token, titlemessage_tokens[j].text);
12808 char *value = getHashEntry(setup_file_hash, token);
12812 int parameter_value = get_token_parameter_value(token, value);
12814 for (k = 0; k < MAX_NUM_TITLE_MESSAGES; k++)
12818 if (titlemessage_tokens[j].type == TYPE_INTEGER)
12819 *(int *)titlemessage_tokens[j].value = (int)parameter_value;
12821 *(boolean *)titlemessage_tokens[j].value = (boolean)parameter_value;
12831 // special case: check if network and preview player positions are redefined,
12832 // to compare this later against the main menu level preview being redefined
12833 struct TokenIntPtrInfo menu_config_players[] =
12835 { "main.network_players.x", &menu.main.network_players.redefined },
12836 { "main.network_players.y", &menu.main.network_players.redefined },
12837 { "main.preview_players.x", &menu.main.preview_players.redefined },
12838 { "main.preview_players.y", &menu.main.preview_players.redefined },
12839 { "preview.x", &preview.redefined },
12840 { "preview.y", &preview.redefined }
12843 for (i = 0; i < ARRAY_SIZE(menu_config_players); i++)
12844 *menu_config_players[i].value = FALSE;
12846 for (i = 0; i < ARRAY_SIZE(menu_config_players); i++)
12847 if (getHashEntry(setup_file_hash, menu_config_players[i].token) != NULL)
12848 *menu_config_players[i].value = TRUE;
12850 // read (and overwrite with) values that may be specified in config file
12851 for (i = 0; image_config_vars[i].token != NULL; i++)
12853 char *value = getHashEntry(setup_file_hash, image_config_vars[i].token);
12855 // (ignore definitions set to "[DEFAULT]" which are already initialized)
12856 if (value != NULL && !strEqual(value, ARG_DEFAULT))
12857 *image_config_vars[i].value =
12858 get_token_parameter_value(image_config_vars[i].token, value);
12861 freeSetupFileHash(setup_file_hash);
12864 void LoadMenuDesignSettings(void)
12866 char *filename_base = UNDEFINED_FILENAME, *filename_local;
12868 InitMenuDesignSettings_Static();
12869 InitMenuDesignSettings_SpecialPreProcessing();
12871 if (!GFX_OVERRIDE_ARTWORK(ARTWORK_TYPE_GRAPHICS))
12873 // first look for special settings configured in level series config
12874 filename_base = getCustomArtworkLevelConfigFilename(ARTWORK_TYPE_GRAPHICS);
12876 if (fileExists(filename_base))
12877 LoadMenuDesignSettingsFromFilename(filename_base);
12880 filename_local = getCustomArtworkConfigFilename(ARTWORK_TYPE_GRAPHICS);
12882 if (filename_local != NULL && !strEqual(filename_base, filename_local))
12883 LoadMenuDesignSettingsFromFilename(filename_local);
12885 InitMenuDesignSettings_SpecialPostProcessing();
12888 void LoadMenuDesignSettings_AfterGraphics(void)
12890 InitMenuDesignSettings_SpecialPostProcessing_AfterGraphics();
12893 void LoadUserDefinedEditorElementList(int **elements, int *num_elements)
12895 char *filename = getEditorSetupFilename();
12896 SetupFileList *setup_file_list, *list;
12897 SetupFileHash *element_hash;
12898 int num_unknown_tokens = 0;
12901 if ((setup_file_list = loadSetupFileList(filename)) == NULL)
12904 element_hash = newSetupFileHash();
12906 for (i = 0; i < NUM_FILE_ELEMENTS; i++)
12907 setHashEntry(element_hash, element_info[i].token_name, i_to_a(i));
12909 // determined size may be larger than needed (due to unknown elements)
12911 for (list = setup_file_list; list != NULL; list = list->next)
12914 // add space for up to 3 more elements for padding that may be needed
12915 *num_elements += 3;
12917 // free memory for old list of elements, if needed
12918 checked_free(*elements);
12920 // allocate memory for new list of elements
12921 *elements = checked_malloc(*num_elements * sizeof(int));
12924 for (list = setup_file_list; list != NULL; list = list->next)
12926 char *value = getHashEntry(element_hash, list->token);
12928 if (value == NULL) // try to find obsolete token mapping
12930 char *mapped_token = get_mapped_token(list->token);
12932 if (mapped_token != NULL)
12934 value = getHashEntry(element_hash, mapped_token);
12936 free(mapped_token);
12942 (*elements)[(*num_elements)++] = atoi(value);
12946 if (num_unknown_tokens == 0)
12949 Warn("unknown token(s) found in config file:");
12950 Warn("- config file: '%s'", filename);
12952 num_unknown_tokens++;
12955 Warn("- token: '%s'", list->token);
12959 if (num_unknown_tokens > 0)
12962 while (*num_elements % 4) // pad with empty elements, if needed
12963 (*elements)[(*num_elements)++] = EL_EMPTY;
12965 freeSetupFileList(setup_file_list);
12966 freeSetupFileHash(element_hash);
12969 for (i = 0; i < *num_elements; i++)
12970 Debug("editor", "element '%s' [%d]\n",
12971 element_info[(*elements)[i]].token_name, (*elements)[i]);
12975 static struct MusicFileInfo *get_music_file_info_ext(char *basename, int music,
12978 SetupFileHash *setup_file_hash = NULL;
12979 struct MusicFileInfo tmp_music_file_info, *new_music_file_info;
12980 char *filename_music, *filename_prefix, *filename_info;
12986 token_to_value_ptr[] =
12988 { "title_header", &tmp_music_file_info.title_header },
12989 { "artist_header", &tmp_music_file_info.artist_header },
12990 { "album_header", &tmp_music_file_info.album_header },
12991 { "year_header", &tmp_music_file_info.year_header },
12993 { "title", &tmp_music_file_info.title },
12994 { "artist", &tmp_music_file_info.artist },
12995 { "album", &tmp_music_file_info.album },
12996 { "year", &tmp_music_file_info.year },
13002 filename_music = (is_sound ? getCustomSoundFilename(basename) :
13003 getCustomMusicFilename(basename));
13005 if (filename_music == NULL)
13008 // ---------- try to replace file extension ----------
13010 filename_prefix = getStringCopy(filename_music);
13011 if (strrchr(filename_prefix, '.') != NULL)
13012 *strrchr(filename_prefix, '.') = '\0';
13013 filename_info = getStringCat2(filename_prefix, ".txt");
13015 if (fileExists(filename_info))
13016 setup_file_hash = loadSetupFileHash(filename_info);
13018 free(filename_prefix);
13019 free(filename_info);
13021 if (setup_file_hash == NULL)
13023 // ---------- try to add file extension ----------
13025 filename_prefix = getStringCopy(filename_music);
13026 filename_info = getStringCat2(filename_prefix, ".txt");
13028 if (fileExists(filename_info))
13029 setup_file_hash = loadSetupFileHash(filename_info);
13031 free(filename_prefix);
13032 free(filename_info);
13035 if (setup_file_hash == NULL)
13038 // ---------- music file info found ----------
13040 clear_mem(&tmp_music_file_info, sizeof(struct MusicFileInfo));
13042 for (i = 0; token_to_value_ptr[i].token != NULL; i++)
13044 char *value = getHashEntry(setup_file_hash, token_to_value_ptr[i].token);
13046 *token_to_value_ptr[i].value_ptr =
13047 getStringCopy(value != NULL && *value != '\0' ? value : UNKNOWN_NAME);
13050 tmp_music_file_info.basename = getStringCopy(basename);
13051 tmp_music_file_info.music = music;
13052 tmp_music_file_info.is_sound = is_sound;
13054 new_music_file_info = checked_malloc(sizeof(struct MusicFileInfo));
13055 *new_music_file_info = tmp_music_file_info;
13057 return new_music_file_info;
13060 static struct MusicFileInfo *get_music_file_info(char *basename, int music)
13062 return get_music_file_info_ext(basename, music, FALSE);
13065 static struct MusicFileInfo *get_sound_file_info(char *basename, int sound)
13067 return get_music_file_info_ext(basename, sound, TRUE);
13070 static boolean music_info_listed_ext(struct MusicFileInfo *list,
13071 char *basename, boolean is_sound)
13073 for (; list != NULL; list = list->next)
13074 if (list->is_sound == is_sound && strEqual(list->basename, basename))
13080 static boolean music_info_listed(struct MusicFileInfo *list, char *basename)
13082 return music_info_listed_ext(list, basename, FALSE);
13085 static boolean sound_info_listed(struct MusicFileInfo *list, char *basename)
13087 return music_info_listed_ext(list, basename, TRUE);
13090 void LoadMusicInfo(void)
13092 char *music_directory = getCustomMusicDirectory();
13093 int num_music = getMusicListSize();
13094 int num_music_noconf = 0;
13095 int num_sounds = getSoundListSize();
13097 DirectoryEntry *dir_entry;
13098 struct FileInfo *music, *sound;
13099 struct MusicFileInfo *next, **new;
13102 while (music_file_info != NULL)
13104 next = music_file_info->next;
13106 checked_free(music_file_info->basename);
13108 checked_free(music_file_info->title_header);
13109 checked_free(music_file_info->artist_header);
13110 checked_free(music_file_info->album_header);
13111 checked_free(music_file_info->year_header);
13113 checked_free(music_file_info->title);
13114 checked_free(music_file_info->artist);
13115 checked_free(music_file_info->album);
13116 checked_free(music_file_info->year);
13118 free(music_file_info);
13120 music_file_info = next;
13123 new = &music_file_info;
13125 for (i = 0; i < num_music; i++)
13127 music = getMusicListEntry(i);
13129 if (music->filename == NULL)
13132 if (strEqual(music->filename, UNDEFINED_FILENAME))
13135 // a configured file may be not recognized as music
13136 if (!FileIsMusic(music->filename))
13139 if (!music_info_listed(music_file_info, music->filename))
13141 *new = get_music_file_info(music->filename, i);
13144 new = &(*new)->next;
13148 if ((dir = openDirectory(music_directory)) == NULL)
13150 Warn("cannot read music directory '%s'", music_directory);
13155 while ((dir_entry = readDirectory(dir)) != NULL) // loop all entries
13157 char *basename = dir_entry->basename;
13158 boolean music_already_used = FALSE;
13161 // skip all music files that are configured in music config file
13162 for (i = 0; i < num_music; i++)
13164 music = getMusicListEntry(i);
13166 if (music->filename == NULL)
13169 if (strEqual(basename, music->filename))
13171 music_already_used = TRUE;
13176 if (music_already_used)
13179 if (!FileIsMusic(dir_entry->filename))
13182 if (!music_info_listed(music_file_info, basename))
13184 *new = get_music_file_info(basename, MAP_NOCONF_MUSIC(num_music_noconf));
13187 new = &(*new)->next;
13190 num_music_noconf++;
13193 closeDirectory(dir);
13195 for (i = 0; i < num_sounds; i++)
13197 sound = getSoundListEntry(i);
13199 if (sound->filename == NULL)
13202 if (strEqual(sound->filename, UNDEFINED_FILENAME))
13205 // a configured file may be not recognized as sound
13206 if (!FileIsSound(sound->filename))
13209 if (!sound_info_listed(music_file_info, sound->filename))
13211 *new = get_sound_file_info(sound->filename, i);
13213 new = &(*new)->next;
13218 static void add_helpanim_entry(int element, int action, int direction,
13219 int delay, int *num_list_entries)
13221 struct HelpAnimInfo *new_list_entry;
13222 (*num_list_entries)++;
13225 checked_realloc(helpanim_info,
13226 *num_list_entries * sizeof(struct HelpAnimInfo));
13227 new_list_entry = &helpanim_info[*num_list_entries - 1];
13229 new_list_entry->element = element;
13230 new_list_entry->action = action;
13231 new_list_entry->direction = direction;
13232 new_list_entry->delay = delay;
13235 static void print_unknown_token(char *filename, char *token, int token_nr)
13240 Warn("unknown token(s) found in config file:");
13241 Warn("- config file: '%s'", filename);
13244 Warn("- token: '%s'", token);
13247 static void print_unknown_token_end(int token_nr)
13253 void LoadHelpAnimInfo(void)
13255 char *filename = getHelpAnimFilename();
13256 SetupFileList *setup_file_list = NULL, *list;
13257 SetupFileHash *element_hash, *action_hash, *direction_hash;
13258 int num_list_entries = 0;
13259 int num_unknown_tokens = 0;
13262 if (fileExists(filename))
13263 setup_file_list = loadSetupFileList(filename);
13265 if (setup_file_list == NULL)
13267 // use reliable default values from static configuration
13268 SetupFileList *insert_ptr;
13270 insert_ptr = setup_file_list =
13271 newSetupFileList(helpanim_config[0].token,
13272 helpanim_config[0].value);
13274 for (i = 1; helpanim_config[i].token; i++)
13275 insert_ptr = addListEntry(insert_ptr,
13276 helpanim_config[i].token,
13277 helpanim_config[i].value);
13280 element_hash = newSetupFileHash();
13281 action_hash = newSetupFileHash();
13282 direction_hash = newSetupFileHash();
13284 for (i = 0; i < MAX_NUM_ELEMENTS; i++)
13285 setHashEntry(element_hash, element_info[i].token_name, i_to_a(i));
13287 for (i = 0; i < NUM_ACTIONS; i++)
13288 setHashEntry(action_hash, element_action_info[i].suffix,
13289 i_to_a(element_action_info[i].value));
13291 // do not store direction index (bit) here, but direction value!
13292 for (i = 0; i < NUM_DIRECTIONS_FULL; i++)
13293 setHashEntry(direction_hash, element_direction_info[i].suffix,
13294 i_to_a(1 << element_direction_info[i].value));
13296 for (list = setup_file_list; list != NULL; list = list->next)
13298 char *element_token, *action_token, *direction_token;
13299 char *element_value, *action_value, *direction_value;
13300 int delay = atoi(list->value);
13302 if (strEqual(list->token, "end"))
13304 add_helpanim_entry(HELPANIM_LIST_NEXT, -1, -1, -1, &num_list_entries);
13309 /* first try to break element into element/action/direction parts;
13310 if this does not work, also accept combined "element[.act][.dir]"
13311 elements (like "dynamite.active"), which are unique elements */
13313 if (strchr(list->token, '.') == NULL) // token contains no '.'
13315 element_value = getHashEntry(element_hash, list->token);
13316 if (element_value != NULL) // element found
13317 add_helpanim_entry(atoi(element_value), -1, -1, delay,
13318 &num_list_entries);
13321 // no further suffixes found -- this is not an element
13322 print_unknown_token(filename, list->token, num_unknown_tokens++);
13328 // token has format "<prefix>.<something>"
13330 action_token = strchr(list->token, '.'); // suffix may be action ...
13331 direction_token = action_token; // ... or direction
13333 element_token = getStringCopy(list->token);
13334 *strchr(element_token, '.') = '\0';
13336 element_value = getHashEntry(element_hash, element_token);
13338 if (element_value == NULL) // this is no element
13340 element_value = getHashEntry(element_hash, list->token);
13341 if (element_value != NULL) // combined element found
13342 add_helpanim_entry(atoi(element_value), -1, -1, delay,
13343 &num_list_entries);
13345 print_unknown_token(filename, list->token, num_unknown_tokens++);
13347 free(element_token);
13352 action_value = getHashEntry(action_hash, action_token);
13354 if (action_value != NULL) // action found
13356 add_helpanim_entry(atoi(element_value), atoi(action_value), -1, delay,
13357 &num_list_entries);
13359 free(element_token);
13364 direction_value = getHashEntry(direction_hash, direction_token);
13366 if (direction_value != NULL) // direction found
13368 add_helpanim_entry(atoi(element_value), -1, atoi(direction_value), delay,
13369 &num_list_entries);
13371 free(element_token);
13376 if (strchr(action_token + 1, '.') == NULL)
13378 // no further suffixes found -- this is not an action nor direction
13380 element_value = getHashEntry(element_hash, list->token);
13381 if (element_value != NULL) // combined element found
13382 add_helpanim_entry(atoi(element_value), -1, -1, delay,
13383 &num_list_entries);
13385 print_unknown_token(filename, list->token, num_unknown_tokens++);
13387 free(element_token);
13392 // token has format "<prefix>.<suffix>.<something>"
13394 direction_token = strchr(action_token + 1, '.');
13396 action_token = getStringCopy(action_token);
13397 *strchr(action_token + 1, '.') = '\0';
13399 action_value = getHashEntry(action_hash, action_token);
13401 if (action_value == NULL) // this is no action
13403 element_value = getHashEntry(element_hash, list->token);
13404 if (element_value != NULL) // combined element found
13405 add_helpanim_entry(atoi(element_value), -1, -1, delay,
13406 &num_list_entries);
13408 print_unknown_token(filename, list->token, num_unknown_tokens++);
13410 free(element_token);
13411 free(action_token);
13416 direction_value = getHashEntry(direction_hash, direction_token);
13418 if (direction_value != NULL) // direction found
13420 add_helpanim_entry(atoi(element_value), atoi(action_value),
13421 atoi(direction_value), delay, &num_list_entries);
13423 free(element_token);
13424 free(action_token);
13429 // this is no direction
13431 element_value = getHashEntry(element_hash, list->token);
13432 if (element_value != NULL) // combined element found
13433 add_helpanim_entry(atoi(element_value), -1, -1, delay,
13434 &num_list_entries);
13436 print_unknown_token(filename, list->token, num_unknown_tokens++);
13438 free(element_token);
13439 free(action_token);
13442 print_unknown_token_end(num_unknown_tokens);
13444 add_helpanim_entry(HELPANIM_LIST_NEXT, -1, -1, -1, &num_list_entries);
13445 add_helpanim_entry(HELPANIM_LIST_END, -1, -1, -1, &num_list_entries);
13447 freeSetupFileList(setup_file_list);
13448 freeSetupFileHash(element_hash);
13449 freeSetupFileHash(action_hash);
13450 freeSetupFileHash(direction_hash);
13453 for (i = 0; i < num_list_entries; i++)
13454 Debug("files:LoadHelpAnimInfo", "'%s': %d, %d, %d => %d",
13455 EL_NAME(helpanim_info[i].element),
13456 helpanim_info[i].element,
13457 helpanim_info[i].action,
13458 helpanim_info[i].direction,
13459 helpanim_info[i].delay);
13463 void LoadHelpTextInfo(void)
13465 char *filename = getHelpTextFilename();
13468 if (helptext_info != NULL)
13470 freeSetupFileHash(helptext_info);
13471 helptext_info = NULL;
13474 if (fileExists(filename))
13475 helptext_info = loadSetupFileHash(filename);
13477 if (helptext_info == NULL)
13479 // use reliable default values from static configuration
13480 helptext_info = newSetupFileHash();
13482 for (i = 0; helptext_config[i].token; i++)
13483 setHashEntry(helptext_info,
13484 helptext_config[i].token,
13485 helptext_config[i].value);
13489 BEGIN_HASH_ITERATION(helptext_info, itr)
13491 Debug("files:LoadHelpTextInfo", "'%s' => '%s'",
13492 HASH_ITERATION_TOKEN(itr), HASH_ITERATION_VALUE(itr));
13494 END_HASH_ITERATION(hash, itr)
13499 // ----------------------------------------------------------------------------
13501 // ----------------------------------------------------------------------------
13503 #define MAX_NUM_CONVERT_LEVELS 1000
13505 void ConvertLevels(void)
13507 static LevelDirTree *convert_leveldir = NULL;
13508 static int convert_level_nr = -1;
13509 static int num_levels_handled = 0;
13510 static int num_levels_converted = 0;
13511 static boolean levels_failed[MAX_NUM_CONVERT_LEVELS];
13514 convert_leveldir = getTreeInfoFromIdentifier(leveldir_first,
13515 global.convert_leveldir);
13517 if (convert_leveldir == NULL)
13518 Fail("no such level identifier: '%s'", global.convert_leveldir);
13520 leveldir_current = convert_leveldir;
13522 if (global.convert_level_nr != -1)
13524 convert_leveldir->first_level = global.convert_level_nr;
13525 convert_leveldir->last_level = global.convert_level_nr;
13528 convert_level_nr = convert_leveldir->first_level;
13530 PrintLine("=", 79);
13531 Print("Converting levels\n");
13532 PrintLine("-", 79);
13533 Print("Level series identifier: '%s'\n", convert_leveldir->identifier);
13534 Print("Level series name: '%s'\n", convert_leveldir->name);
13535 Print("Level series author: '%s'\n", convert_leveldir->author);
13536 Print("Number of levels: %d\n", convert_leveldir->levels);
13537 PrintLine("=", 79);
13540 for (i = 0; i < MAX_NUM_CONVERT_LEVELS; i++)
13541 levels_failed[i] = FALSE;
13543 while (convert_level_nr <= convert_leveldir->last_level)
13545 char *level_filename;
13548 level_nr = convert_level_nr++;
13550 Print("Level %03d: ", level_nr);
13552 LoadLevel(level_nr);
13553 if (level.no_level_file || level.no_valid_file)
13555 Print("(no level)\n");
13559 Print("converting level ... ");
13562 // special case: conversion of some EMC levels as requested by ACME
13563 level.game_engine_type = GAME_ENGINE_TYPE_RND;
13566 level_filename = getDefaultLevelFilename(level_nr);
13567 new_level = !fileExists(level_filename);
13571 SaveLevel(level_nr);
13573 num_levels_converted++;
13575 Print("converted.\n");
13579 if (level_nr >= 0 && level_nr < MAX_NUM_CONVERT_LEVELS)
13580 levels_failed[level_nr] = TRUE;
13582 Print("NOT CONVERTED -- LEVEL ALREADY EXISTS.\n");
13585 num_levels_handled++;
13589 PrintLine("=", 79);
13590 Print("Number of levels handled: %d\n", num_levels_handled);
13591 Print("Number of levels converted: %d (%d%%)\n", num_levels_converted,
13592 (num_levels_handled ?
13593 num_levels_converted * 100 / num_levels_handled : 0));
13594 PrintLine("-", 79);
13595 Print("Summary (for automatic parsing by scripts):\n");
13596 Print("LEVELDIR '%s', CONVERTED %d/%d (%d%%)",
13597 convert_leveldir->identifier, num_levels_converted,
13598 num_levels_handled,
13599 (num_levels_handled ?
13600 num_levels_converted * 100 / num_levels_handled : 0));
13602 if (num_levels_handled != num_levels_converted)
13604 Print(", FAILED:");
13605 for (i = 0; i < MAX_NUM_CONVERT_LEVELS; i++)
13606 if (levels_failed[i])
13611 PrintLine("=", 79);
13613 CloseAllAndExit(0);
13617 // ----------------------------------------------------------------------------
13618 // create and save images for use in level sketches (raw BMP format)
13619 // ----------------------------------------------------------------------------
13621 void CreateLevelSketchImages(void)
13627 InitElementPropertiesGfxElement();
13629 bitmap1 = CreateBitmap(TILEX, TILEY, DEFAULT_DEPTH);
13630 bitmap2 = CreateBitmap(MINI_TILEX, MINI_TILEY, DEFAULT_DEPTH);
13632 for (i = 0; i < NUM_FILE_ELEMENTS; i++)
13634 int element = getMappedElement(i);
13635 char basename1[16];
13636 char basename2[16];
13640 sprintf(basename1, "%04d.bmp", i);
13641 sprintf(basename2, "%04ds.bmp", i);
13643 filename1 = getPath2(global.create_sketch_images_dir, basename1);
13644 filename2 = getPath2(global.create_sketch_images_dir, basename2);
13646 DrawSizedElement(0, 0, element, TILESIZE);
13647 BlitBitmap(drawto, bitmap1, SX, SY, TILEX, TILEY, 0, 0);
13649 if (SDL_SaveBMP(bitmap1->surface, filename1) != 0)
13650 Fail("cannot save level sketch image file '%s'", filename1);
13652 DrawSizedElement(0, 0, element, MINI_TILESIZE);
13653 BlitBitmap(drawto, bitmap2, SX, SY, MINI_TILEX, MINI_TILEY, 0, 0);
13655 if (SDL_SaveBMP(bitmap2->surface, filename2) != 0)
13656 Fail("cannot save level sketch image file '%s'", filename2);
13661 // create corresponding SQL statements (for normal and small images)
13664 printf("insert into phpbb_words values (NULL, '`%03d', '<IMG class=\"levelsketch\" src=\"/I/%04d.png\"/>');\n", i, i);
13665 printf("insert into phpbb_words values (NULL, '¸%03d', '<IMG class=\"levelsketch\" src=\"/I/%04ds.png\"/>');\n", i, i);
13668 printf("insert into phpbb_words values (NULL, '`%04d', '<IMG class=\"levelsketch\" src=\"/I/%04d.png\"/>');\n", i, i);
13669 printf("insert into phpbb_words values (NULL, '¸%04d', '<IMG class=\"levelsketch\" src=\"/I/%04ds.png\"/>');\n", i, i);
13671 // optional: create content for forum level sketch demonstration post
13673 fprintf(stderr, "%03d `%03d%c", i, i, (i % 10 < 9 ? ' ' : '\n'));
13676 FreeBitmap(bitmap1);
13677 FreeBitmap(bitmap2);
13680 fprintf(stderr, "\n");
13682 Info("%d normal and small images created", NUM_FILE_ELEMENTS);
13684 CloseAllAndExit(0);
13688 // ----------------------------------------------------------------------------
13689 // create and save images for element collecting animations (raw BMP format)
13690 // ----------------------------------------------------------------------------
13692 static boolean createCollectImage(int element)
13694 return (IS_COLLECTIBLE(element) && !IS_SP_ELEMENT(element));
13697 void CreateCollectElementImages(void)
13701 int anim_frames = num_steps - 1;
13702 int tile_size = TILESIZE;
13703 int anim_width = tile_size * anim_frames;
13704 int anim_height = tile_size;
13705 int num_collect_images = 0;
13706 int pos_collect_images = 0;
13708 for (i = 0; i < MAX_NUM_ELEMENTS; i++)
13709 if (createCollectImage(i))
13710 num_collect_images++;
13712 Info("Creating %d element collecting animation images ...",
13713 num_collect_images);
13715 int dst_width = anim_width * 2;
13716 int dst_height = anim_height * num_collect_images / 2;
13717 Bitmap *dst_bitmap = CreateBitmap(dst_width, dst_height, DEFAULT_DEPTH);
13718 char *basename = "RocksCollect.bmp";
13719 char *filename = getPath2(global.create_collect_images_dir, basename);
13721 for (i = 0; i < MAX_NUM_ELEMENTS; i++)
13723 if (!createCollectImage(i))
13726 int dst_x = (pos_collect_images / (num_collect_images / 2)) * anim_width;
13727 int dst_y = (pos_collect_images % (num_collect_images / 2)) * anim_height;
13728 int graphic = el2img(i);
13729 char *token_name = element_info[i].token_name;
13730 Bitmap *tmp_bitmap = CreateBitmap(tile_size, tile_size, DEFAULT_DEPTH);
13731 Bitmap *src_bitmap;
13734 Info("- creating collecting image for '%s' ...", token_name);
13736 getGraphicSource(graphic, 0, &src_bitmap, &src_x, &src_y);
13738 BlitBitmap(src_bitmap, tmp_bitmap, src_x, src_y,
13739 tile_size, tile_size, 0, 0);
13741 tmp_bitmap->surface_masked = tmp_bitmap->surface;
13743 for (j = 0; j < anim_frames; j++)
13745 int frame_size_final = tile_size * (anim_frames - j) / num_steps;
13746 int frame_size = frame_size_final * num_steps;
13747 int offset = (tile_size - frame_size_final) / 2;
13748 Bitmap *frame_bitmap = ZoomBitmap(tmp_bitmap, frame_size, frame_size);
13750 while (frame_size > frame_size_final)
13754 Bitmap *half_bitmap = ZoomBitmap(frame_bitmap, frame_size, frame_size);
13756 FreeBitmap(frame_bitmap);
13758 frame_bitmap = half_bitmap;
13761 BlitBitmap(frame_bitmap, dst_bitmap, 0, 0,
13762 frame_size_final, frame_size_final,
13763 dst_x + j * tile_size + offset, dst_y + offset);
13765 FreeBitmap(frame_bitmap);
13768 tmp_bitmap->surface_masked = NULL;
13770 FreeBitmap(tmp_bitmap);
13772 pos_collect_images++;
13775 if (SDL_SaveBMP(dst_bitmap->surface, filename) != 0)
13776 Fail("cannot save element collecting image file '%s'", filename);
13778 FreeBitmap(dst_bitmap);
13782 CloseAllAndExit(0);
13786 // ----------------------------------------------------------------------------
13787 // create and save images for custom and group elements (raw BMP format)
13788 // ----------------------------------------------------------------------------
13790 void CreateCustomElementImages(char *directory)
13792 char *src_basename = "RocksCE-template.ilbm";
13793 char *dst_basename = "RocksCE.bmp";
13794 char *src_filename = getPath2(directory, src_basename);
13795 char *dst_filename = getPath2(directory, dst_basename);
13796 Bitmap *src_bitmap;
13798 int yoffset_ce = 0;
13799 int yoffset_ge = (TILEY * NUM_CUSTOM_ELEMENTS / 16);
13802 InitVideoDefaults();
13804 ReCreateBitmap(&backbuffer, video.width, video.height);
13806 src_bitmap = LoadImage(src_filename);
13808 bitmap = CreateBitmap(TILEX * 16 * 2,
13809 TILEY * (NUM_CUSTOM_ELEMENTS + NUM_GROUP_ELEMENTS) / 16,
13812 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
13819 BlitBitmap(src_bitmap, bitmap, 0, 0, TILEX, TILEY,
13820 TILEX * x, TILEY * y + yoffset_ce);
13822 BlitBitmap(src_bitmap, bitmap, 0, TILEY,
13824 TILEX * x + TILEX * 16,
13825 TILEY * y + yoffset_ce);
13827 for (j = 2; j >= 0; j--)
13831 BlitBitmap(src_bitmap, bitmap,
13832 TILEX + c * 7, 0, 6, 10,
13833 TILEX * x + 6 + j * 7,
13834 TILEY * y + 11 + yoffset_ce);
13836 BlitBitmap(src_bitmap, bitmap,
13837 TILEX + c * 8, TILEY, 6, 10,
13838 TILEX * 16 + TILEX * x + 6 + j * 8,
13839 TILEY * y + 10 + yoffset_ce);
13845 for (i = 0; i < NUM_GROUP_ELEMENTS; i++)
13852 BlitBitmap(src_bitmap, bitmap, 0, 0, TILEX, TILEY,
13853 TILEX * x, TILEY * y + yoffset_ge);
13855 BlitBitmap(src_bitmap, bitmap, 0, TILEY,
13857 TILEX * x + TILEX * 16,
13858 TILEY * y + yoffset_ge);
13860 for (j = 1; j >= 0; j--)
13864 BlitBitmap(src_bitmap, bitmap, TILEX + c * 10, 11, 10, 10,
13865 TILEX * x + 6 + j * 10,
13866 TILEY * y + 11 + yoffset_ge);
13868 BlitBitmap(src_bitmap, bitmap,
13869 TILEX + c * 8, TILEY + 12, 6, 10,
13870 TILEX * 16 + TILEX * x + 10 + j * 8,
13871 TILEY * y + 10 + yoffset_ge);
13877 if (SDL_SaveBMP(bitmap->surface, dst_filename) != 0)
13878 Fail("cannot save CE graphics file '%s'", dst_filename);
13880 FreeBitmap(bitmap);
13882 CloseAllAndExit(0);