1 /***********************************************************
2 * Rocks'n'Diamonds -- McDuffin Strikes Back! *
3 *----------------------------------------------------------*
4 * (c) 1995-2002 Artsoft Entertainment *
6 * Detmolder Strasse 189 *
9 * e-mail: info@artsoft.org *
10 *----------------------------------------------------------*
12 ***********************************************************/
19 #include "libgame/libgame.h"
27 #define CHUNK_ID_LEN 4 /* IFF style chunk id length */
28 #define CHUNK_SIZE_UNDEFINED 0 /* undefined chunk size == 0 */
29 #define CHUNK_SIZE_NONE -1 /* do not write chunk size */
30 #define FILE_VERS_CHUNK_SIZE 8 /* size of file version chunk */
31 #define LEVEL_HEADER_SIZE 80 /* size of level file header */
32 #define LEVEL_HEADER_UNUSED 6 /* unused level header bytes */
33 #define LEVEL_CHUNK_CNT2_SIZE 160 /* size of level CNT2 chunk */
34 #define LEVEL_CHUNK_CNT2_UNUSED 11 /* unused CNT2 chunk bytes */
35 #define LEVEL_CHUNK_CNT3_HEADER 16 /* size of level CNT3 header */
36 #define LEVEL_CHUNK_CNT3_UNUSED 10 /* unused CNT3 chunk bytes */
37 #define LEVEL_CPART_CUS3_SIZE 134 /* size of CUS3 chunk part */
38 #define LEVEL_CPART_CUS3_UNUSED 15 /* unused CUS3 bytes / part */
39 #define LEVEL_CHUNK_GRP1_SIZE 74 /* size of level GRP1 chunk */
40 #define TAPE_HEADER_SIZE 20 /* size of tape file header */
41 #define TAPE_HEADER_UNUSED 3 /* unused tape header bytes */
43 #define LEVEL_CHUNK_CNT3_SIZE(x) (LEVEL_CHUNK_CNT3_HEADER + (x))
44 #define LEVEL_CHUNK_CUS3_SIZE(x) (2 + (x) * LEVEL_CPART_CUS3_SIZE)
45 #define LEVEL_CHUNK_CUS4_SIZE(x) (48 + 48 + (x) * 48)
47 /* file identifier strings */
48 #define LEVEL_COOKIE_TMPL "ROCKSNDIAMONDS_LEVEL_FILE_VERSION_x.x"
49 #define TAPE_COOKIE_TMPL "ROCKSNDIAMONDS_TAPE_FILE_VERSION_x.x"
50 #define SCORE_COOKIE "ROCKSNDIAMONDS_SCORE_FILE_VERSION_1.2"
52 /* values for level file type identifier */
53 #define LEVEL_FILE_TYPE_UNKNOWN 0
54 #define LEVEL_FILE_TYPE_RND 1
55 #define LEVEL_FILE_TYPE_BD 2
56 #define LEVEL_FILE_TYPE_EM 3
57 #define LEVEL_FILE_TYPE_SP 4
58 #define LEVEL_FILE_TYPE_DX 5
59 #define LEVEL_FILE_TYPE_SB 6
60 #define LEVEL_FILE_TYPE_DC 7
62 #define LEVEL_FILE_TYPE_RND_PACKED (10 + LEVEL_FILE_TYPE_RND)
63 #define LEVEL_FILE_TYPE_EM_PACKED (10 + LEVEL_FILE_TYPE_EM)
65 #define IS_SINGLE_LEVEL_FILE(x) (x < 10)
66 #define IS_PACKED_LEVEL_FILE(x) (x > 10)
69 /* ========================================================================= */
70 /* level file functions */
71 /* ========================================================================= */
73 void setElementChangePages(struct ElementInfo *ei, int change_pages)
75 int change_page_size = sizeof(struct ElementChangeInfo);
77 ei->num_change_pages = MAX(1, change_pages);
80 checked_realloc(ei->change_page, ei->num_change_pages * change_page_size);
82 if (ei->current_change_page >= ei->num_change_pages)
83 ei->current_change_page = ei->num_change_pages - 1;
85 ei->change = &ei->change_page[ei->current_change_page];
88 void setElementChangeInfoToDefaults(struct ElementChangeInfo *change)
92 change->can_change = FALSE;
94 change->events = CE_BITMASK_DEFAULT;
96 change->trigger_player = CH_PLAYER_ANY;
97 change->trigger_side = CH_SIDE_ANY;
98 change->trigger_page = CH_PAGE_ANY;
100 change->target_element = EL_EMPTY_SPACE;
102 change->delay_fixed = 0;
103 change->delay_random = 0;
104 change->delay_frames = 1;
106 change->trigger_element = EL_EMPTY_SPACE;
108 change->explode = FALSE;
109 change->use_content = FALSE;
110 change->only_complete = FALSE;
111 change->use_random_change = FALSE;
112 change->random = 100;
113 change->power = CP_NON_DESTRUCTIVE;
115 for (x = 0; x < 3; x++)
116 for (y = 0; y < 3; y++)
117 change->content[x][y] = EL_EMPTY_SPACE;
119 change->direct_action = 0;
120 change->other_action = 0;
122 change->pre_change_function = NULL;
123 change->change_function = NULL;
124 change->post_change_function = NULL;
127 static void setLevelInfoToDefaults(struct LevelInfo *level)
131 level->file_version = FILE_VERSION_ACTUAL;
132 level->game_version = GAME_VERSION_ACTUAL;
134 level->encoding_16bit_field = FALSE; /* default: only 8-bit elements */
135 level->encoding_16bit_yamyam = FALSE; /* default: only 8-bit elements */
136 level->encoding_16bit_amoeba = FALSE; /* default: only 8-bit elements */
138 level->fieldx = STD_LEV_FIELDX;
139 level->fieldy = STD_LEV_FIELDY;
141 for (x = 0; x < MAX_LEV_FIELDX; x++)
142 for (y = 0; y < MAX_LEV_FIELDY; y++)
143 level->field[x][y] = EL_SAND;
146 level->gems_needed = 0;
148 level->amoeba_speed = 10;
150 level->time_magic_wall = 10;
151 level->time_wheel = 10;
152 level->time_light = 10;
153 level->time_timegate = 10;
155 level->amoeba_content = EL_DIAMOND;
157 level->double_speed = FALSE;
158 level->initial_gravity = FALSE;
159 level->em_slippery_gems = FALSE;
160 level->block_last_field = FALSE;
161 level->sp_block_last_field = TRUE;
163 level->use_spring_bug = FALSE;
165 level->can_move_into_acid_bits = ~0; /* everything can move into acid */
167 level->player_can_fall_into_acid = TRUE;
169 level->use_step_counter = FALSE;
171 level->use_custom_template = FALSE;
173 for (i = 0; i < MAX_LEVEL_NAME_LEN; i++)
174 level->name[i] = '\0';
175 for (i = 0; i < MAX_LEVEL_AUTHOR_LEN; i++)
176 level->author[i] = '\0';
178 strcpy(level->name, NAMELESS_LEVEL_NAME);
179 strcpy(level->author, ANONYMOUS_NAME);
181 for (i = 0; i < 4; i++)
183 level->envelope_text[i][0] = '\0';
184 level->envelope_xsize[i] = MAX_ENVELOPE_XSIZE;
185 level->envelope_ysize[i] = MAX_ENVELOPE_YSIZE;
188 for (i = 0; i < LEVEL_SCORE_ELEMENTS; i++)
189 level->score[i] = 10;
191 level->num_yamyam_contents = STD_ELEMENT_CONTENTS;
192 for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
193 for (x = 0; x < 3; x++)
194 for (y = 0; y < 3; y++)
195 level->yamyam_content[i][x][y] =
196 (i < STD_ELEMENT_CONTENTS ? EL_ROCK : EL_EMPTY);
198 level->field[0][0] = EL_PLAYER_1;
199 level->field[STD_LEV_FIELDX - 1][STD_LEV_FIELDY - 1] = EL_EXIT_CLOSED;
201 for (i = 0; i < MAX_NUM_ELEMENTS; i++)
205 setElementChangePages(&element_info[element], 1);
206 setElementChangeInfoToDefaults(element_info[element].change);
208 if (IS_CUSTOM_ELEMENT(element) || IS_GROUP_ELEMENT(element))
210 for (j = 0; j < MAX_ELEMENT_NAME_LEN + 1; j++)
211 element_info[element].description[j] = '\0';
213 if (element_info[element].custom_description != NULL)
214 strncpy(element_info[element].description,
215 element_info[element].custom_description,MAX_ELEMENT_NAME_LEN);
217 strcpy(element_info[element].description,
218 element_info[element].editor_description);
220 element_info[element].use_gfx_element = FALSE;
221 element_info[element].gfx_element = EL_EMPTY_SPACE;
224 if (IS_CUSTOM_ELEMENT(element))
226 element_info[element].access_direction = MV_ALL_DIRECTIONS;
228 element_info[element].collect_score = 10; /* special default */
229 element_info[element].collect_count = 1; /* special default */
231 element_info[element].push_delay_fixed = -1; /* initialize later */
232 element_info[element].push_delay_random = -1; /* initialize later */
233 element_info[element].move_delay_fixed = 0;
234 element_info[element].move_delay_random = 0;
236 element_info[element].move_pattern = MV_ALL_DIRECTIONS;
237 element_info[element].move_direction_initial = MV_START_AUTOMATIC;
238 element_info[element].move_stepsize = TILEX / 8;
239 element_info[element].move_enter_element = EL_EMPTY_SPACE;
240 element_info[element].move_leave_element = EL_EMPTY_SPACE;
241 element_info[element].move_leave_type = LEAVE_TYPE_UNLIMITED;
243 element_info[element].slippery_type = SLIPPERY_ANY_RANDOM;
245 element_info[element].explosion_delay = 18;
246 element_info[element].ignition_delay = 8;
248 for (x = 0; x < 3; x++)
249 for (y = 0; y < 3; y++)
250 element_info[element].content[x][y] = EL_EMPTY_SPACE;
252 element_info[element].access_type = 0;
253 element_info[element].access_layer = 0;
254 element_info[element].access_protected = 0;
255 element_info[element].walk_to_action = 0;
256 element_info[element].smash_targets = 0;
257 element_info[element].deadliness = 0;
258 element_info[element].consistency = 0;
260 element_info[element].can_explode_by_fire = FALSE;
261 element_info[element].can_explode_smashed = FALSE;
262 element_info[element].can_explode_impact = FALSE;
264 element_info[element].current_change_page = 0;
266 /* start with no properties at all */
267 for (j = 0; j < NUM_EP_BITFIELDS; j++)
268 Properties[element][j] = EP_BITMASK_DEFAULT;
270 /* now set default properties */
271 SET_PROPERTY(element, EP_CAN_MOVE_INTO_ACID, TRUE);
273 element_info[element].modified_settings = FALSE;
275 else if (IS_GROUP_ELEMENT(element) || element == EL_INTERNAL_EDITOR)
277 /* initialize memory for list of elements in group */
278 if (element_info[element].group == NULL)
279 element_info[element].group =
280 checked_malloc(sizeof(struct ElementGroupInfo));
282 for (j = 0; j < MAX_ELEMENTS_IN_GROUP; j++)
283 element_info[element].group->element[j] = EL_EMPTY_SPACE;
285 /* default: only one element in group */
286 element_info[element].group->num_elements = 1;
288 element_info[element].group->choice_mode = ANIM_RANDOM;
292 BorderElement = EL_STEELWALL;
294 level->no_valid_file = FALSE;
296 if (leveldir_current == NULL) /* only when dumping level */
299 /* try to determine better author name than 'anonymous' */
300 if (strcmp(leveldir_current->author, ANONYMOUS_NAME) != 0)
302 strncpy(level->author, leveldir_current->author, MAX_LEVEL_AUTHOR_LEN);
303 level->author[MAX_LEVEL_AUTHOR_LEN] = '\0';
307 switch (LEVELCLASS(leveldir_current))
309 case LEVELCLASS_TUTORIAL:
310 strcpy(level->author, PROGRAM_AUTHOR_STRING);
313 case LEVELCLASS_CONTRIB:
314 strncpy(level->author, leveldir_current->name, MAX_LEVEL_AUTHOR_LEN);
315 level->author[MAX_LEVEL_AUTHOR_LEN] = '\0';
318 case LEVELCLASS_PRIVATE:
319 strncpy(level->author, getRealName(), MAX_LEVEL_AUTHOR_LEN);
320 level->author[MAX_LEVEL_AUTHOR_LEN] = '\0';
324 /* keep default value */
330 static void setFileInfoToDefaults(struct LevelFileInfo *level_file_info)
332 level_file_info->nr = 0;
333 level_file_info->type = LEVEL_FILE_TYPE_UNKNOWN;
334 level_file_info->packed = FALSE;
335 level_file_info->basename = NULL;
336 level_file_info->filename = NULL;
339 static void ActivateLevelTemplate()
341 /* Currently there is no special action needed to activate the template
342 data, because 'element_info' and 'Properties' overwrite the original
343 level data, while all other variables do not change. */
346 static char *getLevelFilenameFromBasename(char *basename)
348 static char *filename = NULL;
350 checked_free(filename);
352 filename = getPath2(getCurrentLevelDir(), basename);
357 static int getFileTypeFromBasename(char *basename)
359 static char *filename = NULL;
360 struct stat file_status;
362 /* ---------- try to determine file type from filename ---------- */
364 /* check for typical filename of a Supaplex level package file */
365 if (strlen(basename) == 10 && (strncmp(basename, "levels.d", 8) == 0 ||
366 strncmp(basename, "LEVELS.D", 8) == 0))
367 return LEVEL_FILE_TYPE_SP;
369 /* ---------- try to determine file type from filesize ---------- */
371 checked_free(filename);
372 filename = getPath2(getCurrentLevelDir(), basename);
374 if (stat(filename, &file_status) == 0)
376 /* check for typical filesize of a Supaplex level package file */
377 if (file_status.st_size == 170496)
378 return LEVEL_FILE_TYPE_SP;
381 return LEVEL_FILE_TYPE_UNKNOWN;
384 static char *getSingleLevelBasename(int nr, int type)
386 static char basename[MAX_FILENAME_LEN];
387 char *level_filename = getStringCopy(leveldir_current->level_filename);
389 if (level_filename == NULL)
390 level_filename = getStringCat2("%03d.", LEVELFILE_EXTENSION);
394 case LEVEL_FILE_TYPE_RND:
396 sprintf(basename, "template.%s", LEVELFILE_EXTENSION);
398 sprintf(basename, "%03d.%s", nr, LEVELFILE_EXTENSION);
401 case LEVEL_FILE_TYPE_EM:
402 sprintf(basename, "%d", nr);
405 case LEVEL_FILE_TYPE_UNKNOWN:
407 sprintf(basename, level_filename, nr);
411 free(level_filename);
416 static char *getPackedLevelBasename(int type)
418 static char basename[MAX_FILENAME_LEN];
419 char *directory = getCurrentLevelDir();
421 struct dirent *dir_entry;
423 strcpy(basename, UNDEFINED_FILENAME); /* default: undefined file */
425 if ((dir = opendir(directory)) == NULL)
427 Error(ERR_WARN, "cannot read current level directory '%s'", directory);
432 while ((dir_entry = readdir(dir)) != NULL) /* loop until last dir entry */
434 char *entry_basename = dir_entry->d_name;
435 int entry_type = getFileTypeFromBasename(entry_basename);
437 if (entry_type != LEVEL_FILE_TYPE_UNKNOWN) /* found valid level package */
439 if (type == LEVEL_FILE_TYPE_UNKNOWN ||
442 strcpy(basename, entry_basename);
454 static char *getSingleLevelFilename(int nr, int type)
456 return getLevelFilenameFromBasename(getSingleLevelBasename(nr, type));
460 static char *getPackedLevelFilename(int type)
462 return getLevelFilenameFromBasename(getPackedLevelBasename(type));
466 char *getDefaultLevelFilename(int nr)
468 return getSingleLevelFilename(nr, LEVEL_FILE_TYPE_RND);
471 static void setLevelFileInfo_SingleLevelFilename(struct LevelFileInfo *lfi,
476 lfi->basename = getSingleLevelBasename(lfi->nr, lfi->type);
477 lfi->filename = getLevelFilenameFromBasename(lfi->basename);
480 static void setLevelFileInfo_PackedLevelFilename(struct LevelFileInfo *lfi,
485 lfi->basename = getPackedLevelBasename(lfi->type);
486 lfi->filename = getLevelFilenameFromBasename(lfi->basename);
489 static void determineLevelFileInfo_Filename(struct LevelFileInfo *lfi)
491 /* special case: level number is negative => check for level template file */
494 setLevelFileInfo_SingleLevelFilename(lfi, LEVEL_FILE_TYPE_RND);
499 if (leveldir_current->level_filename != NULL)
501 /* check for file name/pattern specified in "levelinfo.conf" */
502 setLevelFileInfo_SingleLevelFilename(lfi, LEVEL_FILE_TYPE_UNKNOWN);
503 if (fileExists(lfi->filename))
507 /* check for native Rocks'n'Diamonds level file */
508 setLevelFileInfo_SingleLevelFilename(lfi, LEVEL_FILE_TYPE_RND);
509 if (fileExists(lfi->filename))
512 /* check for classic Emerald Mine level file */
513 setLevelFileInfo_SingleLevelFilename(lfi, LEVEL_FILE_TYPE_EM);
514 if (fileExists(lfi->filename))
517 /* check for various packed level file formats */
518 setLevelFileInfo_PackedLevelFilename(lfi, LEVEL_FILE_TYPE_UNKNOWN);
519 if (fileExists(lfi->filename))
522 /* no known level file found -- try to use default values */
523 setLevelFileInfo_SingleLevelFilename(lfi, LEVEL_FILE_TYPE_UNKNOWN);
526 static void determineLevelFileInfo_Filetype(struct LevelFileInfo *lfi)
528 if (lfi->type == LEVEL_FILE_TYPE_UNKNOWN)
529 lfi->type = getFileTypeFromBasename(lfi->basename);
532 static struct LevelFileInfo *getLevelFileInfo(int nr)
534 static struct LevelFileInfo level_file_info;
536 /* always start with reliable default values */
537 setFileInfoToDefaults(&level_file_info);
539 level_file_info.nr = nr; /* set requested level number */
541 determineLevelFileInfo_Filename(&level_file_info);
542 determineLevelFileInfo_Filetype(&level_file_info);
544 return &level_file_info;
548 /* ------------------------------------------------------------------------- */
549 /* functions for loading R'n'D level */
550 /* ------------------------------------------------------------------------- */
552 int getMappedElement(int element)
554 /* remap some (historic, now obsolete) elements */
559 case EL_PLAYER_OBSOLETE:
560 element = EL_PLAYER_1;
563 case EL_KEY_OBSOLETE:
566 case EL_EM_KEY_1_FILE_OBSOLETE:
567 element = EL_EM_KEY_1;
570 case EL_EM_KEY_2_FILE_OBSOLETE:
571 element = EL_EM_KEY_2;
574 case EL_EM_KEY_3_FILE_OBSOLETE:
575 element = EL_EM_KEY_3;
578 case EL_EM_KEY_4_FILE_OBSOLETE:
579 element = EL_EM_KEY_4;
582 case EL_ENVELOPE_OBSOLETE:
583 element = EL_ENVELOPE_1;
591 if (element >= NUM_FILE_ELEMENTS)
593 Error(ERR_WARN, "invalid level element %d", element);
595 element = EL_UNKNOWN;
600 if (element >= NUM_FILE_ELEMENTS)
602 Error(ERR_WARN, "invalid level element %d", element);
604 element = EL_UNKNOWN;
606 else if (element == EL_PLAYER_OBSOLETE)
607 element = EL_PLAYER_1;
608 else if (element == EL_KEY_OBSOLETE)
615 int getMappedElementByVersion(int element, int game_version)
617 /* remap some elements due to certain game version */
619 if (game_version <= VERSION_IDENT(2,2,0,0))
621 /* map game font elements */
622 element = (element == EL_CHAR('[') ? EL_CHAR_AUMLAUT :
623 element == EL_CHAR('\\') ? EL_CHAR_OUMLAUT :
624 element == EL_CHAR(']') ? EL_CHAR_UUMLAUT :
625 element == EL_CHAR('^') ? EL_CHAR_COPYRIGHT : element);
628 if (game_version < VERSION_IDENT(3,0,0,0))
630 /* map Supaplex gravity tube elements */
631 element = (element == EL_SP_GRAVITY_PORT_LEFT ? EL_SP_PORT_LEFT :
632 element == EL_SP_GRAVITY_PORT_RIGHT ? EL_SP_PORT_RIGHT :
633 element == EL_SP_GRAVITY_PORT_UP ? EL_SP_PORT_UP :
634 element == EL_SP_GRAVITY_PORT_DOWN ? EL_SP_PORT_DOWN :
641 static int LoadLevel_VERS(FILE *file, int chunk_size, struct LevelInfo *level)
643 level->file_version = getFileVersion(file);
644 level->game_version = getFileVersion(file);
649 static int LoadLevel_HEAD(FILE *file, int chunk_size, struct LevelInfo *level)
653 level->fieldx = getFile8Bit(file);
654 level->fieldy = getFile8Bit(file);
656 level->time = getFile16BitBE(file);
657 level->gems_needed = getFile16BitBE(file);
659 for (i = 0; i < MAX_LEVEL_NAME_LEN; i++)
660 level->name[i] = getFile8Bit(file);
661 level->name[MAX_LEVEL_NAME_LEN] = 0;
663 for (i = 0; i < LEVEL_SCORE_ELEMENTS; i++)
664 level->score[i] = getFile8Bit(file);
666 level->num_yamyam_contents = STD_ELEMENT_CONTENTS;
667 for (i = 0; i < STD_ELEMENT_CONTENTS; i++)
668 for (y = 0; y < 3; y++)
669 for (x = 0; x < 3; x++)
670 level->yamyam_content[i][x][y] = getMappedElement(getFile8Bit(file));
672 level->amoeba_speed = getFile8Bit(file);
673 level->time_magic_wall = getFile8Bit(file);
674 level->time_wheel = getFile8Bit(file);
675 level->amoeba_content = getMappedElement(getFile8Bit(file));
676 level->double_speed = (getFile8Bit(file) == 1 ? TRUE : FALSE);
677 level->initial_gravity = (getFile8Bit(file) == 1 ? TRUE : FALSE);
678 level->encoding_16bit_field = (getFile8Bit(file) == 1 ? TRUE : FALSE);
679 level->em_slippery_gems = (getFile8Bit(file) == 1 ? TRUE : FALSE);
681 level->use_custom_template = (getFile8Bit(file) == 1 ? TRUE : FALSE);
683 level->block_last_field = (getFile8Bit(file) == 1 ? TRUE : FALSE);
684 level->sp_block_last_field = (getFile8Bit(file) == 1 ? TRUE : FALSE);
686 level->use_spring_bug = (getFile8Bit(file) == 1 ? TRUE : FALSE);
688 level->can_move_into_acid_bits = getFile16BitBE(file);
690 level->use_step_counter = (getFile8Bit(file) == 1 ? TRUE : FALSE);
692 level->player_can_fall_into_acid = (getFile8Bit(file) == 1 ? TRUE : FALSE);
694 ReadUnusedBytesFromFile(file, LEVEL_HEADER_UNUSED);
699 static int LoadLevel_AUTH(FILE *file, int chunk_size, struct LevelInfo *level)
703 for (i = 0; i < MAX_LEVEL_AUTHOR_LEN; i++)
704 level->author[i] = getFile8Bit(file);
705 level->author[MAX_LEVEL_NAME_LEN] = 0;
710 static int LoadLevel_BODY(FILE *file, int chunk_size, struct LevelInfo *level)
713 int chunk_size_expected = level->fieldx * level->fieldy;
715 /* Note: "chunk_size" was wrong before version 2.0 when elements are
716 stored with 16-bit encoding (and should be twice as big then).
717 Even worse, playfield data was stored 16-bit when only yamyam content
718 contained 16-bit elements and vice versa. */
720 if (level->encoding_16bit_field && level->file_version >= FILE_VERSION_2_0)
721 chunk_size_expected *= 2;
723 if (chunk_size_expected != chunk_size)
725 ReadUnusedBytesFromFile(file, chunk_size);
726 return chunk_size_expected;
729 for (y = 0; y < level->fieldy; y++)
730 for (x = 0; x < level->fieldx; x++)
732 getMappedElement(level->encoding_16bit_field ? getFile16BitBE(file) :
737 static int LoadLevel_CONT(FILE *file, int chunk_size, struct LevelInfo *level)
741 int content_size = MAX_ELEMENT_CONTENTS * 3 * 3;
742 int chunk_size_expected = header_size + content_size;
744 /* Note: "chunk_size" was wrong before version 2.0 when elements are
745 stored with 16-bit encoding (and should be twice as big then).
746 Even worse, playfield data was stored 16-bit when only yamyam content
747 contained 16-bit elements and vice versa. */
749 if (level->encoding_16bit_field && level->file_version >= FILE_VERSION_2_0)
750 chunk_size_expected += content_size;
752 if (chunk_size_expected != chunk_size)
754 ReadUnusedBytesFromFile(file, chunk_size);
755 return chunk_size_expected;
759 level->num_yamyam_contents = getFile8Bit(file);
763 /* correct invalid number of content fields -- should never happen */
764 if (level->num_yamyam_contents < 1 ||
765 level->num_yamyam_contents > MAX_ELEMENT_CONTENTS)
766 level->num_yamyam_contents = STD_ELEMENT_CONTENTS;
768 for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
769 for (y = 0; y < 3; y++)
770 for (x = 0; x < 3; x++)
771 level->yamyam_content[i][x][y] =
772 getMappedElement(level->encoding_16bit_field ?
773 getFile16BitBE(file) : getFile8Bit(file));
777 static int LoadLevel_CNT2(FILE *file, int chunk_size, struct LevelInfo *level)
781 int num_contents, content_xsize, content_ysize;
782 int content_array[MAX_ELEMENT_CONTENTS][3][3];
784 element = getMappedElement(getFile16BitBE(file));
785 num_contents = getFile8Bit(file);
786 content_xsize = getFile8Bit(file);
787 content_ysize = getFile8Bit(file);
789 ReadUnusedBytesFromFile(file, LEVEL_CHUNK_CNT2_UNUSED);
791 for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
792 for (y = 0; y < 3; y++)
793 for (x = 0; x < 3; x++)
794 content_array[i][x][y] = getMappedElement(getFile16BitBE(file));
796 /* correct invalid number of content fields -- should never happen */
797 if (num_contents < 1 || num_contents > MAX_ELEMENT_CONTENTS)
798 num_contents = STD_ELEMENT_CONTENTS;
800 if (element == EL_YAMYAM)
802 level->num_yamyam_contents = num_contents;
804 for (i = 0; i < num_contents; i++)
805 for (y = 0; y < 3; y++)
806 for (x = 0; x < 3; x++)
807 level->yamyam_content[i][x][y] = content_array[i][x][y];
809 else if (element == EL_BD_AMOEBA)
811 level->amoeba_content = content_array[0][0][0];
815 Error(ERR_WARN, "cannot load content for element '%d'", element);
821 static int LoadLevel_CNT3(FILE *file, int chunk_size, struct LevelInfo *level)
827 int chunk_size_expected;
829 element = getMappedElement(getFile16BitBE(file));
830 if (!IS_ENVELOPE(element))
831 element = EL_ENVELOPE_1;
833 envelope_nr = element - EL_ENVELOPE_1;
835 envelope_len = getFile16BitBE(file);
837 level->envelope_xsize[envelope_nr] = getFile8Bit(file);
838 level->envelope_ysize[envelope_nr] = getFile8Bit(file);
840 ReadUnusedBytesFromFile(file, LEVEL_CHUNK_CNT3_UNUSED);
842 chunk_size_expected = LEVEL_CHUNK_CNT3_SIZE(envelope_len);
843 if (chunk_size_expected != chunk_size)
845 ReadUnusedBytesFromFile(file, chunk_size - LEVEL_CHUNK_CNT3_HEADER);
846 return chunk_size_expected;
849 for (i = 0; i < envelope_len; i++)
850 level->envelope_text[envelope_nr][i] = getFile8Bit(file);
855 static int LoadLevel_CUS1(FILE *file, int chunk_size, struct LevelInfo *level)
857 int num_changed_custom_elements = getFile16BitBE(file);
858 int chunk_size_expected = 2 + num_changed_custom_elements * 6;
861 if (chunk_size_expected != chunk_size)
863 ReadUnusedBytesFromFile(file, chunk_size - 2);
864 return chunk_size_expected;
867 for (i = 0; i < num_changed_custom_elements; i++)
869 int element = getFile16BitBE(file);
870 int properties = getFile32BitBE(file);
872 if (IS_CUSTOM_ELEMENT(element))
873 Properties[element][EP_BITFIELD_BASE] = properties;
875 Error(ERR_WARN, "invalid custom element number %d", element);
881 static int LoadLevel_CUS2(FILE *file, int chunk_size, struct LevelInfo *level)
883 int num_changed_custom_elements = getFile16BitBE(file);
884 int chunk_size_expected = 2 + num_changed_custom_elements * 4;
887 if (chunk_size_expected != chunk_size)
889 ReadUnusedBytesFromFile(file, chunk_size - 2);
890 return chunk_size_expected;
893 for (i = 0; i < num_changed_custom_elements; i++)
895 int element = getFile16BitBE(file);
896 int custom_target_element = getFile16BitBE(file);
898 if (IS_CUSTOM_ELEMENT(element))
899 element_info[element].change->target_element = custom_target_element;
901 Error(ERR_WARN, "invalid custom element number %d", element);
907 static int LoadLevel_CUS3(FILE *file, int chunk_size, struct LevelInfo *level)
909 int num_changed_custom_elements = getFile16BitBE(file);
910 int chunk_size_expected = LEVEL_CHUNK_CUS3_SIZE(num_changed_custom_elements);
913 if (chunk_size_expected != chunk_size)
915 ReadUnusedBytesFromFile(file, chunk_size - 2);
916 return chunk_size_expected;
919 for (i = 0; i < num_changed_custom_elements; i++)
921 int element = getFile16BitBE(file);
923 if (!IS_CUSTOM_ELEMENT(element))
925 Error(ERR_WARN, "invalid custom element number %d", element);
927 element = EL_INTERNAL_DUMMY;
930 for (j = 0; j < MAX_ELEMENT_NAME_LEN; j++)
931 element_info[element].description[j] = getFile8Bit(file);
932 element_info[element].description[MAX_ELEMENT_NAME_LEN] = 0;
934 Properties[element][EP_BITFIELD_BASE] = getFile32BitBE(file);
936 /* some free bytes for future properties and padding */
937 ReadUnusedBytesFromFile(file, 7);
939 element_info[element].use_gfx_element = getFile8Bit(file);
940 element_info[element].gfx_element =
941 getMappedElement(getFile16BitBE(file));
943 element_info[element].collect_score = getFile8Bit(file);
944 element_info[element].collect_count = getFile8Bit(file);
946 element_info[element].push_delay_fixed = getFile16BitBE(file);
947 element_info[element].push_delay_random = getFile16BitBE(file);
948 element_info[element].move_delay_fixed = getFile16BitBE(file);
949 element_info[element].move_delay_random = getFile16BitBE(file);
951 element_info[element].move_pattern = getFile16BitBE(file);
952 element_info[element].move_direction_initial = getFile8Bit(file);
953 element_info[element].move_stepsize = getFile8Bit(file);
955 for (y = 0; y < 3; y++)
956 for (x = 0; x < 3; x++)
957 element_info[element].content[x][y] =
958 getMappedElement(getFile16BitBE(file));
960 element_info[element].change->events = getFile32BitBE(file);
962 element_info[element].change->target_element =
963 getMappedElement(getFile16BitBE(file));
965 element_info[element].change->delay_fixed = getFile16BitBE(file);
966 element_info[element].change->delay_random = getFile16BitBE(file);
967 element_info[element].change->delay_frames = getFile16BitBE(file);
969 element_info[element].change->trigger_element =
970 getMappedElement(getFile16BitBE(file));
972 element_info[element].change->explode = getFile8Bit(file);
973 element_info[element].change->use_content = getFile8Bit(file);
974 element_info[element].change->only_complete = getFile8Bit(file);
975 element_info[element].change->use_random_change = getFile8Bit(file);
977 element_info[element].change->random = getFile8Bit(file);
978 element_info[element].change->power = getFile8Bit(file);
980 for (y = 0; y < 3; y++)
981 for (x = 0; x < 3; x++)
982 element_info[element].change->content[x][y] =
983 getMappedElement(getFile16BitBE(file));
985 element_info[element].slippery_type = getFile8Bit(file);
987 /* some free bytes for future properties and padding */
988 ReadUnusedBytesFromFile(file, LEVEL_CPART_CUS3_UNUSED);
990 /* mark that this custom element has been modified */
991 element_info[element].modified_settings = TRUE;
997 static int LoadLevel_CUS4(FILE *file, int chunk_size, struct LevelInfo *level)
999 struct ElementInfo *ei;
1000 int chunk_size_expected;
1004 element = getFile16BitBE(file);
1006 if (!IS_CUSTOM_ELEMENT(element))
1008 Error(ERR_WARN, "invalid custom element number %d", element);
1010 ReadUnusedBytesFromFile(file, chunk_size - 2);
1014 ei = &element_info[element];
1016 for (i = 0; i < MAX_ELEMENT_NAME_LEN; i++)
1017 ei->description[i] = getFile8Bit(file);
1018 ei->description[MAX_ELEMENT_NAME_LEN] = 0;
1020 Properties[element][EP_BITFIELD_BASE] = getFile32BitBE(file);
1021 ReadUnusedBytesFromFile(file, 4); /* reserved for more base properties */
1023 ei->num_change_pages = getFile8Bit(file);
1025 /* some free bytes for future base property values and padding */
1026 ReadUnusedBytesFromFile(file, 5);
1028 chunk_size_expected = LEVEL_CHUNK_CUS4_SIZE(ei->num_change_pages);
1029 if (chunk_size_expected != chunk_size)
1031 ReadUnusedBytesFromFile(file, chunk_size - 48);
1032 return chunk_size_expected;
1035 /* read custom property values */
1037 ei->use_gfx_element = getFile8Bit(file);
1038 ei->gfx_element = getMappedElement(getFile16BitBE(file));
1040 ei->collect_score = getFile8Bit(file);
1041 ei->collect_count = getFile8Bit(file);
1043 ei->push_delay_fixed = getFile16BitBE(file);
1044 ei->push_delay_random = getFile16BitBE(file);
1045 ei->move_delay_fixed = getFile16BitBE(file);
1046 ei->move_delay_random = getFile16BitBE(file);
1048 /* bits 0 - 15 of "move_pattern" ... */
1049 ei->move_pattern = getFile16BitBE(file);
1050 ei->move_direction_initial = getFile8Bit(file);
1051 ei->move_stepsize = getFile8Bit(file);
1053 ei->slippery_type = getFile8Bit(file);
1055 for (y = 0; y < 3; y++)
1056 for (x = 0; x < 3; x++)
1057 ei->content[x][y] = getMappedElement(getFile16BitBE(file));
1059 ei->move_enter_element = getMappedElement(getFile16BitBE(file));
1060 ei->move_leave_element = getMappedElement(getFile16BitBE(file));
1061 ei->move_leave_type = getFile8Bit(file);
1063 /* ... bits 16 - 31 of "move_pattern" (not nice, but downward compatible) */
1064 ei->move_pattern |= (getFile16BitBE(file) << 16);
1066 ei->access_direction = getFile8Bit(file);
1068 ei->explosion_delay = getFile8Bit(file);
1069 ei->ignition_delay = getFile8Bit(file);
1071 /* some free bytes for future custom property values and padding */
1072 ReadUnusedBytesFromFile(file, 2);
1074 /* read change property values */
1076 setElementChangePages(ei, ei->num_change_pages);
1078 for (i = 0; i < ei->num_change_pages; i++)
1080 struct ElementChangeInfo *change = &ei->change_page[i];
1082 /* always start with reliable default values */
1083 setElementChangeInfoToDefaults(change);
1085 change->events = getFile32BitBE(file);
1087 change->target_element = getMappedElement(getFile16BitBE(file));
1089 change->delay_fixed = getFile16BitBE(file);
1090 change->delay_random = getFile16BitBE(file);
1091 change->delay_frames = getFile16BitBE(file);
1093 change->trigger_element = getMappedElement(getFile16BitBE(file));
1095 change->explode = getFile8Bit(file);
1096 change->use_content = getFile8Bit(file);
1097 change->only_complete = getFile8Bit(file);
1098 change->use_random_change = getFile8Bit(file);
1100 change->random = getFile8Bit(file);
1101 change->power = getFile8Bit(file);
1103 for (y = 0; y < 3; y++)
1104 for (x = 0; x < 3; x++)
1105 change->content[x][y] = getMappedElement(getFile16BitBE(file));
1107 change->can_change = getFile8Bit(file);
1109 change->trigger_side = getFile8Bit(file);
1112 change->trigger_player = getFile8Bit(file);
1113 change->trigger_page = getFile8Bit(file);
1115 change->trigger_page = (change->trigger_page == CH_PAGE_ANY_FILE ?
1116 CH_PAGE_ANY : (1 << change->trigger_page));
1118 /* some free bytes for future change property values and padding */
1119 ReadUnusedBytesFromFile(file, 6);
1123 /* some free bytes for future change property values and padding */
1124 ReadUnusedBytesFromFile(file, 8);
1128 /* mark this custom element as modified */
1129 ei->modified_settings = TRUE;
1134 static int LoadLevel_GRP1(FILE *file, int chunk_size, struct LevelInfo *level)
1136 struct ElementInfo *ei;
1137 struct ElementGroupInfo *group;
1141 element = getFile16BitBE(file);
1143 if (!IS_GROUP_ELEMENT(element))
1145 Error(ERR_WARN, "invalid group element number %d", element);
1147 ReadUnusedBytesFromFile(file, chunk_size - 2);
1151 ei = &element_info[element];
1153 for (i = 0; i < MAX_ELEMENT_NAME_LEN; i++)
1154 ei->description[i] = getFile8Bit(file);
1155 ei->description[MAX_ELEMENT_NAME_LEN] = 0;
1157 group = element_info[element].group;
1159 group->num_elements = getFile8Bit(file);
1161 ei->use_gfx_element = getFile8Bit(file);
1162 ei->gfx_element = getMappedElement(getFile16BitBE(file));
1164 group->choice_mode = getFile8Bit(file);
1166 /* some free bytes for future values and padding */
1167 ReadUnusedBytesFromFile(file, 3);
1169 for (i = 0; i < MAX_ELEMENTS_IN_GROUP; i++)
1170 group->element[i] = getMappedElement(getFile16BitBE(file));
1172 /* mark this group element as modified */
1173 element_info[element].modified_settings = TRUE;
1178 static void LoadLevelFromFileInfo_RND(struct LevelInfo *level,
1179 struct LevelFileInfo *level_file_info)
1181 char *filename = level_file_info->filename;
1182 char cookie[MAX_LINE_LEN];
1183 char chunk_name[CHUNK_ID_LEN + 1];
1187 if (!(file = fopen(filename, MODE_READ)))
1189 level->no_valid_file = TRUE;
1191 if (level != &level_template)
1192 Error(ERR_WARN, "cannot read level '%s' -- using empty level", filename);
1197 getFileChunkBE(file, chunk_name, NULL);
1198 if (strcmp(chunk_name, "RND1") == 0)
1200 getFile32BitBE(file); /* not used */
1202 getFileChunkBE(file, chunk_name, NULL);
1203 if (strcmp(chunk_name, "CAVE") != 0)
1205 level->no_valid_file = TRUE;
1207 Error(ERR_WARN, "unknown format of level file '%s'", filename);
1212 else /* check for pre-2.0 file format with cookie string */
1214 strcpy(cookie, chunk_name);
1215 fgets(&cookie[4], MAX_LINE_LEN - 4, file);
1216 if (strlen(cookie) > 0 && cookie[strlen(cookie) - 1] == '\n')
1217 cookie[strlen(cookie) - 1] = '\0';
1219 if (!checkCookieString(cookie, LEVEL_COOKIE_TMPL))
1221 level->no_valid_file = TRUE;
1223 Error(ERR_WARN, "unknown format of level file '%s'", filename);
1228 if ((level->file_version = getFileVersionFromCookieString(cookie)) == -1)
1230 level->no_valid_file = TRUE;
1232 Error(ERR_WARN, "unsupported version of level file '%s'", filename);
1237 /* pre-2.0 level files have no game version, so use file version here */
1238 level->game_version = level->file_version;
1241 if (level->file_version < FILE_VERSION_1_2)
1243 /* level files from versions before 1.2.0 without chunk structure */
1244 LoadLevel_HEAD(file, LEVEL_HEADER_SIZE, level);
1245 LoadLevel_BODY(file, level->fieldx * level->fieldy, level);
1253 int (*loader)(FILE *, int, struct LevelInfo *);
1257 { "VERS", FILE_VERS_CHUNK_SIZE, LoadLevel_VERS },
1258 { "HEAD", LEVEL_HEADER_SIZE, LoadLevel_HEAD },
1259 { "AUTH", MAX_LEVEL_AUTHOR_LEN, LoadLevel_AUTH },
1260 { "BODY", -1, LoadLevel_BODY },
1261 { "CONT", -1, LoadLevel_CONT },
1262 { "CNT2", LEVEL_CHUNK_CNT2_SIZE, LoadLevel_CNT2 },
1263 { "CNT3", -1, LoadLevel_CNT3 },
1264 { "CUS1", -1, LoadLevel_CUS1 },
1265 { "CUS2", -1, LoadLevel_CUS2 },
1266 { "CUS3", -1, LoadLevel_CUS3 },
1267 { "CUS4", -1, LoadLevel_CUS4 },
1268 { "GRP1", -1, LoadLevel_GRP1 },
1272 while (getFileChunkBE(file, chunk_name, &chunk_size))
1276 while (chunk_info[i].name != NULL &&
1277 strcmp(chunk_name, chunk_info[i].name) != 0)
1280 if (chunk_info[i].name == NULL)
1282 Error(ERR_WARN, "unknown chunk '%s' in level file '%s'",
1283 chunk_name, filename);
1284 ReadUnusedBytesFromFile(file, chunk_size);
1286 else if (chunk_info[i].size != -1 &&
1287 chunk_info[i].size != chunk_size)
1289 Error(ERR_WARN, "wrong size (%d) of chunk '%s' in level file '%s'",
1290 chunk_size, chunk_name, filename);
1291 ReadUnusedBytesFromFile(file, chunk_size);
1295 /* call function to load this level chunk */
1296 int chunk_size_expected =
1297 (chunk_info[i].loader)(file, chunk_size, level);
1299 /* the size of some chunks cannot be checked before reading other
1300 chunks first (like "HEAD" and "BODY") that contain some header
1301 information, so check them here */
1302 if (chunk_size_expected != chunk_size)
1304 Error(ERR_WARN, "wrong size (%d) of chunk '%s' in level file '%s'",
1305 chunk_size, chunk_name, filename);
1314 /* ------------------------------------------------------------------------- */
1315 /* functions for loading EM level */
1316 /* ------------------------------------------------------------------------- */
1318 static int map_em_element_yam(int element)
1322 case 0x00: return EL_EMPTY;
1323 case 0x01: return EL_EMERALD;
1324 case 0x02: return EL_DIAMOND;
1325 case 0x03: return EL_ROCK;
1326 case 0x04: return EL_ROBOT;
1327 case 0x05: return EL_SPACESHIP_UP;
1328 case 0x06: return EL_BOMB;
1329 case 0x07: return EL_BUG_UP;
1330 case 0x08: return EL_AMOEBA_DROP;
1331 case 0x09: return EL_NUT;
1332 case 0x0a: return EL_YAMYAM;
1333 case 0x0b: return EL_QUICKSAND_FULL;
1334 case 0x0c: return EL_SAND;
1335 case 0x0d: return EL_WALL_SLIPPERY;
1336 case 0x0e: return EL_STEELWALL;
1337 case 0x0f: return EL_WALL;
1338 case 0x10: return EL_EM_KEY_1;
1339 case 0x11: return EL_EM_KEY_2;
1340 case 0x12: return EL_EM_KEY_4;
1341 case 0x13: return EL_EM_KEY_3;
1342 case 0x14: return EL_MAGIC_WALL;
1343 case 0x15: return EL_ROBOT_WHEEL;
1344 case 0x16: return EL_DYNAMITE;
1346 case 0x17: return EL_EM_KEY_1; /* EMC */
1347 case 0x18: return EL_BUG_UP; /* EMC */
1348 case 0x1a: return EL_DIAMOND; /* EMC */
1349 case 0x1b: return EL_EMERALD; /* EMC */
1350 case 0x25: return EL_NUT; /* EMC */
1351 case 0x80: return EL_EMPTY; /* EMC */
1352 case 0x85: return EL_EM_KEY_1; /* EMC */
1353 case 0x86: return EL_EM_KEY_2; /* EMC */
1354 case 0x87: return EL_EM_KEY_4; /* EMC */
1355 case 0x88: return EL_EM_KEY_3; /* EMC */
1356 case 0x94: return EL_QUICKSAND_EMPTY; /* EMC */
1357 case 0x9a: return EL_AMOEBA_WET; /* EMC */
1358 case 0xaf: return EL_DYNAMITE; /* EMC */
1359 case 0xbd: return EL_SAND; /* EMC */
1362 Error(ERR_WARN, "invalid level element %d", element);
1367 static int map_em_element_field(int element)
1369 if (element >= 0xc8 && element <= 0xe1)
1370 return EL_CHAR_A + (element - 0xc8);
1371 else if (element >= 0xe2 && element <= 0xeb)
1372 return EL_CHAR_0 + (element - 0xe2);
1376 case 0x00: return EL_ROCK;
1377 case 0x01: return EL_ROCK; /* EMC */
1378 case 0x02: return EL_DIAMOND;
1379 case 0x03: return EL_DIAMOND;
1380 case 0x04: return EL_ROBOT;
1381 case 0x05: return EL_ROBOT; /* EMC */
1382 case 0x06: return EL_EMPTY_SPACE; /* EMC */
1383 case 0x07: return EL_EMPTY_SPACE; /* EMC */
1384 case 0x08: return EL_SPACESHIP_UP;
1385 case 0x09: return EL_SPACESHIP_RIGHT;
1386 case 0x0a: return EL_SPACESHIP_DOWN;
1387 case 0x0b: return EL_SPACESHIP_LEFT;
1388 case 0x0c: return EL_SPACESHIP_UP;
1389 case 0x0d: return EL_SPACESHIP_RIGHT;
1390 case 0x0e: return EL_SPACESHIP_DOWN;
1391 case 0x0f: return EL_SPACESHIP_LEFT;
1393 case 0x10: return EL_BOMB;
1394 case 0x11: return EL_BOMB; /* EMC */
1395 case 0x12: return EL_EMERALD;
1396 case 0x13: return EL_EMERALD;
1397 case 0x14: return EL_BUG_UP;
1398 case 0x15: return EL_BUG_RIGHT;
1399 case 0x16: return EL_BUG_DOWN;
1400 case 0x17: return EL_BUG_LEFT;
1401 case 0x18: return EL_BUG_UP;
1402 case 0x19: return EL_BUG_RIGHT;
1403 case 0x1a: return EL_BUG_DOWN;
1404 case 0x1b: return EL_BUG_LEFT;
1405 case 0x1c: return EL_AMOEBA_DROP;
1406 case 0x1d: return EL_AMOEBA_DROP; /* EMC */
1407 case 0x1e: return EL_AMOEBA_DROP; /* EMC */
1408 case 0x1f: return EL_AMOEBA_DROP; /* EMC */
1410 case 0x20: return EL_ROCK;
1411 case 0x21: return EL_BOMB; /* EMC */
1412 case 0x22: return EL_DIAMOND; /* EMC */
1413 case 0x23: return EL_EMERALD; /* EMC */
1414 case 0x24: return EL_MAGIC_WALL;
1415 case 0x25: return EL_NUT;
1416 case 0x26: return EL_NUT; /* EMC */
1417 case 0x27: return EL_NUT; /* EMC */
1419 /* looks like magic wheel, but is _always_ activated */
1420 case 0x28: return EL_ROBOT_WHEEL; /* EMC */
1422 case 0x29: return EL_YAMYAM; /* up */
1423 case 0x2a: return EL_YAMYAM; /* down */
1424 case 0x2b: return EL_YAMYAM; /* left */ /* EMC */
1425 case 0x2c: return EL_YAMYAM; /* right */ /* EMC */
1426 case 0x2d: return EL_QUICKSAND_FULL;
1427 case 0x2e: return EL_EMPTY_SPACE; /* EMC */
1428 case 0x2f: return EL_EMPTY_SPACE; /* EMC */
1430 case 0x30: return EL_EMPTY_SPACE; /* EMC */
1431 case 0x31: return EL_SAND; /* EMC */
1432 case 0x32: return EL_SAND; /* EMC */
1433 case 0x33: return EL_SAND; /* EMC */
1434 case 0x34: return EL_QUICKSAND_FULL; /* EMC */
1435 case 0x35: return EL_QUICKSAND_FULL; /* EMC */
1436 case 0x36: return EL_QUICKSAND_FULL; /* EMC */
1437 case 0x37: return EL_SAND; /* EMC */
1438 case 0x38: return EL_ROCK; /* EMC */
1439 case 0x39: return EL_EXPANDABLE_WALL_HORIZONTAL; /* EMC */
1440 case 0x3a: return EL_EXPANDABLE_WALL_VERTICAL; /* EMC */
1441 case 0x3b: return EL_DYNAMITE_ACTIVE; /* 1 */
1442 case 0x3c: return EL_DYNAMITE_ACTIVE; /* 2 */
1443 case 0x3d: return EL_DYNAMITE_ACTIVE; /* 3 */
1444 case 0x3e: return EL_DYNAMITE_ACTIVE; /* 4 */
1445 case 0x3f: return EL_ACID_POOL_BOTTOM;
1447 case 0x40: return EL_EXIT_OPEN; /* 1 */
1448 case 0x41: return EL_EXIT_OPEN; /* 2 */
1449 case 0x42: return EL_EXIT_OPEN; /* 3 */
1450 case 0x43: return EL_BALLOON; /* EMC */
1451 case 0x44: return EL_UNKNOWN; /* EMC ("plant") */
1452 case 0x45: return EL_SPRING; /* EMC */
1453 case 0x46: return EL_SPRING; /* falling */ /* EMC */
1454 case 0x47: return EL_SPRING; /* left */ /* EMC */
1455 case 0x48: return EL_SPRING; /* right */ /* EMC */
1456 case 0x49: return EL_UNKNOWN; /* EMC ("ball 1") */
1457 case 0x4a: return EL_UNKNOWN; /* EMC ("ball 2") */
1458 case 0x4b: return EL_UNKNOWN; /* EMC ("android") */
1459 case 0x4c: return EL_EMPTY_SPACE; /* EMC */
1460 case 0x4d: return EL_UNKNOWN; /* EMC ("android") */
1461 case 0x4e: return EL_INVISIBLE_WALL; /* EMC (? "android") */
1462 case 0x4f: return EL_UNKNOWN; /* EMC ("android") */
1464 case 0x50: return EL_UNKNOWN; /* EMC ("android") */
1465 case 0x51: return EL_UNKNOWN; /* EMC ("android") */
1466 case 0x52: return EL_UNKNOWN; /* EMC ("android") */
1467 case 0x53: return EL_UNKNOWN; /* EMC ("android") */
1468 case 0x54: return EL_UNKNOWN; /* EMC ("android") */
1469 case 0x55: return EL_EMPTY_SPACE; /* EMC */
1470 case 0x56: return EL_EMPTY_SPACE; /* EMC */
1471 case 0x57: return EL_EMPTY_SPACE; /* EMC */
1472 case 0x58: return EL_EMPTY_SPACE; /* EMC */
1473 case 0x59: return EL_EMPTY_SPACE; /* EMC */
1474 case 0x5a: return EL_EMPTY_SPACE; /* EMC */
1475 case 0x5b: return EL_EMPTY_SPACE; /* EMC */
1476 case 0x5c: return EL_EMPTY_SPACE; /* EMC */
1477 case 0x5d: return EL_EMPTY_SPACE; /* EMC */
1478 case 0x5e: return EL_EMPTY_SPACE; /* EMC */
1479 case 0x5f: return EL_EMPTY_SPACE; /* EMC */
1481 case 0x60: return EL_EMPTY_SPACE; /* EMC */
1482 case 0x61: return EL_EMPTY_SPACE; /* EMC */
1483 case 0x62: return EL_EMPTY_SPACE; /* EMC */
1484 case 0x63: return EL_SPRING; /* left */ /* EMC */
1485 case 0x64: return EL_SPRING; /* right */ /* EMC */
1486 case 0x65: return EL_ACID; /* 1 */ /* EMC */
1487 case 0x66: return EL_ACID; /* 2 */ /* EMC */
1488 case 0x67: return EL_ACID; /* 3 */ /* EMC */
1489 case 0x68: return EL_ACID; /* 4 */ /* EMC */
1490 case 0x69: return EL_ACID; /* 5 */ /* EMC */
1491 case 0x6a: return EL_ACID; /* 6 */ /* EMC */
1492 case 0x6b: return EL_ACID; /* 7 */ /* EMC */
1493 case 0x6c: return EL_ACID; /* 8 */ /* EMC */
1494 case 0x6d: return EL_EMPTY_SPACE; /* EMC */
1495 case 0x6e: return EL_EMPTY_SPACE; /* EMC */
1496 case 0x6f: return EL_EMPTY_SPACE; /* EMC */
1498 case 0x70: return EL_EMPTY_SPACE; /* EMC */
1499 case 0x71: return EL_EMPTY_SPACE; /* EMC */
1500 case 0x72: return EL_NUT; /* left */ /* EMC */
1501 case 0x73: return EL_SAND; /* EMC (? "nut") */
1502 case 0x74: return EL_STEELWALL;
1503 case 0x75: return EL_EMPTY_SPACE; /* EMC */
1504 case 0x76: return EL_EMPTY_SPACE; /* EMC */
1505 case 0x77: return EL_BOMB; /* left */ /* EMC */
1506 case 0x78: return EL_BOMB; /* right */ /* EMC */
1507 case 0x79: return EL_ROCK; /* left */ /* EMC */
1508 case 0x7a: return EL_ROCK; /* right */ /* EMC */
1509 case 0x7b: return EL_ACID; /* (? EMC "blank") */
1510 case 0x7c: return EL_EMPTY_SPACE; /* EMC */
1511 case 0x7d: return EL_EMPTY_SPACE; /* EMC */
1512 case 0x7e: return EL_EMPTY_SPACE; /* EMC */
1513 case 0x7f: return EL_EMPTY_SPACE; /* EMC */
1515 case 0x80: return EL_EMPTY;
1516 case 0x81: return EL_WALL_SLIPPERY;
1517 case 0x82: return EL_SAND;
1518 case 0x83: return EL_STEELWALL;
1519 case 0x84: return EL_WALL;
1520 case 0x85: return EL_EM_KEY_1;
1521 case 0x86: return EL_EM_KEY_2;
1522 case 0x87: return EL_EM_KEY_4;
1523 case 0x88: return EL_EM_KEY_3;
1524 case 0x89: return EL_EM_GATE_1;
1525 case 0x8a: return EL_EM_GATE_2;
1526 case 0x8b: return EL_EM_GATE_4;
1527 case 0x8c: return EL_EM_GATE_3;
1528 case 0x8d: return EL_INVISIBLE_WALL; /* EMC (? "dripper") */
1529 case 0x8e: return EL_EM_GATE_1_GRAY;
1530 case 0x8f: return EL_EM_GATE_2_GRAY;
1532 case 0x90: return EL_EM_GATE_4_GRAY;
1533 case 0x91: return EL_EM_GATE_3_GRAY;
1534 case 0x92: return EL_MAGIC_WALL;
1535 case 0x93: return EL_ROBOT_WHEEL;
1536 case 0x94: return EL_QUICKSAND_EMPTY; /* (? EMC "sand") */
1537 case 0x95: return EL_ACID_POOL_TOPLEFT;
1538 case 0x96: return EL_ACID_POOL_TOPRIGHT;
1539 case 0x97: return EL_ACID_POOL_BOTTOMLEFT;
1540 case 0x98: return EL_ACID_POOL_BOTTOMRIGHT;
1541 case 0x99: return EL_ACID; /* (? EMC "fake blank") */
1542 case 0x9a: return EL_AMOEBA_DEAD; /* 1 */
1543 case 0x9b: return EL_AMOEBA_DEAD; /* 2 */
1544 case 0x9c: return EL_AMOEBA_DEAD; /* 3 */
1545 case 0x9d: return EL_AMOEBA_DEAD; /* 4 */
1546 case 0x9e: return EL_EXIT_CLOSED;
1547 case 0x9f: return EL_CHAR_LESS; /* arrow left */
1549 /* looks like normal sand, but behaves like wall */
1550 case 0xa0: return EL_UNKNOWN; /* EMC ("fake grass") */
1551 case 0xa1: return EL_UNKNOWN; /* EMC ("lenses") */
1552 case 0xa2: return EL_UNKNOWN; /* EMC ("magnify") */
1553 case 0xa3: return EL_UNKNOWN; /* EMC ("fake blank") */
1554 case 0xa4: return EL_UNKNOWN; /* EMC ("fake grass") */
1555 case 0xa5: return EL_UNKNOWN; /* EMC ("switch") */
1556 case 0xa6: return EL_UNKNOWN; /* EMC ("switch") */
1557 case 0xa7: return EL_EMPTY_SPACE; /* EMC */
1558 case 0xa8: return EL_EMC_WALL_1; /* EMC ("decor 8") */
1559 case 0xa9: return EL_EMC_WALL_2; /* EMC ("decor 9") */
1560 case 0xaa: return EL_EMC_WALL_3; /* EMC ("decor 10") */
1561 case 0xab: return EL_EMC_WALL_7; /* EMC ("decor 5") */
1562 case 0xac: return EL_CHAR_COMMA; /* EMC */
1563 case 0xad: return EL_CHAR_QUOTEDBL; /* EMC */
1564 case 0xae: return EL_CHAR_MINUS; /* EMC */
1565 case 0xaf: return EL_DYNAMITE;
1567 case 0xb0: return EL_EMC_STEELWALL_1; /* EMC ("steel 3") */
1568 case 0xb1: return EL_EMC_WALL_8; /* EMC ("decor 6") */
1569 case 0xb2: return EL_UNKNOWN; /* EMC ("decor 7") */
1570 case 0xb3: return EL_STEELWALL; /* 2 */ /* EMC */
1571 case 0xb4: return EL_WALL_SLIPPERY; /* 2 */ /* EMC */
1572 case 0xb5: return EL_EMC_WALL_6; /* EMC ("decor 2") */
1573 case 0xb6: return EL_EMC_WALL_5; /* EMC ("decor 4") */
1574 case 0xb7: return EL_EMC_WALL_4; /* EMC ("decor 3") */
1575 case 0xb8: return EL_BALLOON_SWITCH_ANY; /* EMC */
1576 case 0xb9: return EL_BALLOON_SWITCH_RIGHT; /* EMC */
1577 case 0xba: return EL_BALLOON_SWITCH_DOWN; /* EMC */
1578 case 0xbb: return EL_BALLOON_SWITCH_LEFT; /* EMC */
1579 case 0xbc: return EL_BALLOON_SWITCH_UP; /* EMC */
1580 case 0xbd: return EL_SAND; /* EMC ("dirt") */
1581 case 0xbe: return EL_UNKNOWN; /* EMC ("plant") */
1582 case 0xbf: return EL_UNKNOWN; /* EMC ("key 5") */
1584 case 0xc0: return EL_UNKNOWN; /* EMC ("key 6") */
1585 case 0xc1: return EL_UNKNOWN; /* EMC ("key 7") */
1586 case 0xc2: return EL_UNKNOWN; /* EMC ("key 8") */
1587 case 0xc3: return EL_UNKNOWN; /* EMC ("door 5") */
1588 case 0xc4: return EL_UNKNOWN; /* EMC ("door 6") */
1589 case 0xc5: return EL_UNKNOWN; /* EMC ("door 7") */
1590 case 0xc6: return EL_UNKNOWN; /* EMC ("door 8") */
1591 case 0xc7: return EL_UNKNOWN; /* EMC ("bumper") */
1593 /* characters: see above */
1595 case 0xec: return EL_CHAR_PERIOD;
1596 case 0xed: return EL_CHAR_EXCLAM;
1597 case 0xee: return EL_CHAR_COLON;
1598 case 0xef: return EL_CHAR_QUESTION;
1600 case 0xf0: return EL_CHAR_GREATER; /* arrow right */
1601 case 0xf1: return EL_CHAR_COPYRIGHT; /* EMC: "decor 1" */
1602 case 0xf2: return EL_UNKNOWN; /* EMC ("fake door 5") */
1603 case 0xf3: return EL_UNKNOWN; /* EMC ("fake door 6") */
1604 case 0xf4: return EL_UNKNOWN; /* EMC ("fake door 7") */
1605 case 0xf5: return EL_UNKNOWN; /* EMC ("fake door 8") */
1606 case 0xf6: return EL_EMPTY_SPACE; /* EMC */
1607 case 0xf7: return EL_EMPTY_SPACE; /* EMC */
1609 case 0xf8: return EL_EMPTY_SPACE; /* EMC */
1610 case 0xf9: return EL_EMPTY_SPACE; /* EMC */
1611 case 0xfa: return EL_EMPTY_SPACE; /* EMC */
1612 case 0xfb: return EL_EMPTY_SPACE; /* EMC */
1613 case 0xfc: return EL_EMPTY_SPACE; /* EMC */
1614 case 0xfd: return EL_EMPTY_SPACE; /* EMC */
1616 case 0xfe: return EL_PLAYER_1; /* EMC: "blank" */
1617 case 0xff: return EL_PLAYER_2; /* EMC: "blank" */
1620 /* should never happen (all 8-bit value cases should be handled) */
1621 Error(ERR_WARN, "invalid level element %d", element);
1626 #define EM_LEVEL_SIZE 2106
1627 #define EM_LEVEL_XSIZE 64
1628 #define EM_LEVEL_YSIZE 32
1630 static void LoadLevelFromFileInfo_EM(struct LevelInfo *level,
1631 struct LevelFileInfo *level_file_info)
1633 char *filename = level_file_info->filename;
1635 unsigned char leveldata[EM_LEVEL_SIZE];
1636 unsigned char *header = &leveldata[EM_LEVEL_XSIZE * EM_LEVEL_YSIZE];
1637 unsigned char code0 = 0x65;
1638 unsigned char code1 = 0x11;
1639 boolean level_is_crypted = FALSE;
1640 int nr = level_file_info->nr;
1643 if (!(file = fopen(filename, MODE_READ)))
1645 level->no_valid_file = TRUE;
1647 Error(ERR_WARN, "cannot read level '%s' -- using empty level", filename);
1652 for(i = 0; i < EM_LEVEL_SIZE; i++)
1653 leveldata[i] = fgetc(file);
1657 /* check if level data is crypted by testing against known starting bytes
1658 of the few existing crypted level files (from Emerald Mine 1 + 2) */
1660 if ((leveldata[0] == 0xf1 ||
1661 leveldata[0] == 0xf5) && leveldata[2] == 0xe7 && leveldata[3] == 0xee)
1663 level_is_crypted = TRUE;
1665 if (leveldata[0] == 0xf5) /* error in crypted Emerald Mine 2 levels */
1666 leveldata[0] = 0xf1;
1669 if (level_is_crypted) /* decode crypted level data */
1671 for(i = 0; i < EM_LEVEL_SIZE; i++)
1673 leveldata[i] ^= code0;
1674 leveldata[i] -= code1;
1676 code0 = (code0 + 7) & 0xff;
1680 level->fieldx = EM_LEVEL_XSIZE;
1681 level->fieldy = EM_LEVEL_YSIZE;
1683 level->time = header[46] * 10;
1684 level->gems_needed = header[47];
1686 /* The original Emerald Mine levels have their level number stored
1687 at the second byte of the level file...
1688 Do not trust this information at other level files, e.g. EMC,
1689 but correct it anyway (normally the first row is completely
1690 steel wall, so the correction does not hurt anyway). */
1692 if (leveldata[1] == nr)
1693 leveldata[1] = leveldata[2]; /* correct level number field */
1695 sprintf(level->name, "Level %d", nr); /* set level name */
1697 level->score[SC_EMERALD] = header[36];
1698 level->score[SC_DIAMOND] = header[37];
1699 level->score[SC_ROBOT] = header[38];
1700 level->score[SC_SPACESHIP] = header[39];
1701 level->score[SC_BUG] = header[40];
1702 level->score[SC_YAMYAM] = header[41];
1703 level->score[SC_NUT] = header[42];
1704 level->score[SC_DYNAMITE] = header[43];
1705 level->score[SC_TIME_BONUS] = header[44];
1707 level->num_yamyam_contents = 4;
1709 for(i = 0; i < level->num_yamyam_contents; i++)
1710 for(y = 0; y < 3; y++)
1711 for(x = 0; x < 3; x++)
1712 level->yamyam_content[i][x][y] =
1713 map_em_element_yam(header[i * 9 + y * 3 + x]);
1715 level->amoeba_speed = (header[52] * 256 + header[53]) % 256;
1716 level->time_magic_wall = (header[54] * 256 + header[55]) * 16 / 100;
1717 level->time_wheel = (header[56] * 256 + header[57]) * 16 / 100;
1718 level->amoeba_content = EL_DIAMOND;
1720 for (y = 0; y < level->fieldy; y++) for (x = 0; x < level->fieldx; x++)
1722 int new_element = map_em_element_field(leveldata[y * EM_LEVEL_XSIZE + x]);
1724 if (new_element == EL_AMOEBA_DEAD && level->amoeba_speed)
1725 new_element = EL_AMOEBA_WET;
1727 level->field[x][y] = new_element;
1730 x = (header[48] * 256 + header[49]) % EM_LEVEL_XSIZE;
1731 y = (header[48] * 256 + header[49]) / EM_LEVEL_XSIZE;
1732 level->field[x][y] = EL_PLAYER_1;
1734 x = (header[50] * 256 + header[51]) % EM_LEVEL_XSIZE;
1735 y = (header[50] * 256 + header[51]) / EM_LEVEL_XSIZE;
1736 level->field[x][y] = EL_PLAYER_2;
1739 /* ------------------------------------------------------------------------- */
1740 /* functions for loading SP level */
1741 /* ------------------------------------------------------------------------- */
1743 #define NUM_SUPAPLEX_LEVELS_PER_PACKAGE 111
1744 #define SP_LEVEL_SIZE 1536
1745 #define SP_LEVEL_XSIZE 60
1746 #define SP_LEVEL_YSIZE 24
1747 #define SP_LEVEL_NAME_LEN 23
1749 static void LoadLevelFromFileStream_SP(FILE *file, struct LevelInfo *level,
1754 /* read level body (width * height == 60 * 24 tiles == 1440 bytes) */
1755 for (y = 0; y < SP_LEVEL_YSIZE; y++)
1757 for (x = 0; x < SP_LEVEL_XSIZE; x++)
1759 int element_old = fgetc(file);
1762 if (element_old <= 0x27)
1763 element_new = getMappedElement(EL_SP_START + element_old);
1764 else if (element_old == 0x28)
1765 element_new = EL_INVISIBLE_WALL;
1768 Error(ERR_WARN, "in level %d, at position %d, %d:", nr, x, y);
1769 Error(ERR_WARN, "invalid level element %d", element_old);
1771 element_new = EL_UNKNOWN;
1774 level->field[x][y] = element_new;
1778 ReadUnusedBytesFromFile(file, 4);
1780 /* Initial gravitation: 1 == "on", anything else (0) == "off" */
1781 level->initial_gravity = (fgetc(file) == 1 ? TRUE : FALSE);
1783 ReadUnusedBytesFromFile(file, 1);
1785 /* level title in uppercase letters, padded with dashes ("-") (23 bytes) */
1786 for (i = 0; i < SP_LEVEL_NAME_LEN; i++)
1787 level->name[i] = fgetc(file);
1788 level->name[SP_LEVEL_NAME_LEN] = '\0';
1790 /* initial "freeze zonks": 2 == "on", anything else (0) == "off" */
1791 ReadUnusedBytesFromFile(file, 1); /* !!! NOT SUPPORTED YET !!! */
1793 /* number of infotrons needed; 0 means that Supaplex will count the total
1794 amount of infotrons in the level and use the low byte of that number.
1795 (a multiple of 256 infotrons will result in "0 infotrons needed"!) */
1796 level->gems_needed = fgetc(file);
1798 /* information about special gravity port entries */
1799 ReadUnusedBytesFromFile(file, 65); /* !!! NOT SUPPORTED YET !!! */
1801 level->fieldx = SP_LEVEL_XSIZE;
1802 level->fieldy = SP_LEVEL_YSIZE;
1804 level->time = 0; /* no time limit */
1805 level->amoeba_speed = 0;
1806 level->time_magic_wall = 0;
1807 level->time_wheel = 0;
1808 level->amoeba_content = EL_EMPTY;
1810 for(i = 0; i < LEVEL_SCORE_ELEMENTS; i++)
1811 level->score[i] = 0; /* !!! CORRECT THIS !!! */
1813 /* there are no yamyams in supaplex levels */
1814 for(i = 0; i < level->num_yamyam_contents; i++)
1815 for(y = 0; y < 3; y++)
1816 for(x = 0; x < 3; x++)
1817 level->yamyam_content[i][x][y] = EL_EMPTY;
1820 static void LoadLevelFromFileInfo_SP(struct LevelInfo *level,
1821 struct LevelFileInfo *level_file_info)
1823 char *filename = level_file_info->filename;
1825 int nr = level_file_info->nr - leveldir_current->first_level;
1827 char name_first, name_last;
1828 struct LevelInfo multipart_level;
1829 int multipart_xpos, multipart_ypos;
1830 boolean is_multipart_level;
1831 boolean is_first_part;
1832 boolean reading_multipart_level = FALSE;
1833 boolean use_empty_level = FALSE;
1835 if (!(file = fopen(filename, MODE_READ)))
1837 level->no_valid_file = TRUE;
1839 Error(ERR_WARN, "cannot read level '%s' -- using empty level", filename);
1844 /* position file stream to the requested level inside the level package */
1845 if (fseek(file, nr * SP_LEVEL_SIZE, SEEK_SET) != 0)
1847 level->no_valid_file = TRUE;
1849 Error(ERR_WARN, "cannot fseek level '%s' -- using empty level", filename);
1854 /* there exist Supaplex level package files with multi-part levels which
1855 can be detected as follows: instead of leading and trailing dashes ('-')
1856 to pad the level name, they have leading and trailing numbers which are
1857 the x and y coordinations of the current part of the multi-part level;
1858 if there are '?' characters instead of numbers on the left or right side
1859 of the level name, the multi-part level consists of only horizontal or
1862 for (l = nr; l < NUM_SUPAPLEX_LEVELS_PER_PACKAGE; l++)
1864 LoadLevelFromFileStream_SP(file, level, l);
1866 /* check if this level is a part of a bigger multi-part level */
1868 name_first = level->name[0];
1869 name_last = level->name[SP_LEVEL_NAME_LEN - 1];
1871 is_multipart_level =
1872 ((name_first == '?' || (name_first >= '0' && name_first <= '9')) &&
1873 (name_last == '?' || (name_last >= '0' && name_last <= '9')));
1876 ((name_first == '?' || name_first == '1') &&
1877 (name_last == '?' || name_last == '1'));
1879 /* correct leading multipart level meta information in level name */
1880 for (i = 0; i < SP_LEVEL_NAME_LEN && level->name[i] == name_first; i++)
1881 level->name[i] = '-';
1883 /* correct trailing multipart level meta information in level name */
1884 for (i = SP_LEVEL_NAME_LEN - 1; i>=0 && level->name[i] == name_last; i--)
1885 level->name[i] = '-';
1887 /* ---------- check for normal single level ---------- */
1889 if (!reading_multipart_level && !is_multipart_level)
1891 /* the current level is simply a normal single-part level, and we are
1892 not reading a multi-part level yet, so return the level as it is */
1897 /* ---------- check for empty level (unused multi-part) ---------- */
1899 if (!reading_multipart_level && is_multipart_level && !is_first_part)
1901 /* this is a part of a multi-part level, but not the first part
1902 (and we are not already reading parts of a multi-part level);
1903 in this case, use an empty level instead of the single part */
1905 use_empty_level = TRUE;
1910 /* ---------- check for finished multi-part level ---------- */
1912 if (reading_multipart_level &&
1913 (!is_multipart_level ||
1914 strcmp(level->name, multipart_level.name) != 0))
1916 /* we are already reading parts of a multi-part level, but this level is
1917 either not a multi-part level, or a part of a different multi-part
1918 level; in both cases, the multi-part level seems to be complete */
1923 /* ---------- here we have one part of a multi-part level ---------- */
1925 reading_multipart_level = TRUE;
1927 if (is_first_part) /* start with first part of new multi-part level */
1929 /* copy level info structure from first part */
1930 multipart_level = *level;
1932 /* clear playfield of new multi-part level */
1933 for (y = 0; y < MAX_LEV_FIELDY; y++)
1934 for (x = 0; x < MAX_LEV_FIELDX; x++)
1935 multipart_level.field[x][y] = EL_EMPTY;
1938 if (name_first == '?')
1940 if (name_last == '?')
1943 multipart_xpos = (int)(name_first - '0');
1944 multipart_ypos = (int)(name_last - '0');
1947 printf("----------> part (%d/%d) of multi-part level '%s'\n",
1948 multipart_xpos, multipart_ypos, multipart_level.name);
1951 if (multipart_xpos * SP_LEVEL_XSIZE > MAX_LEV_FIELDX ||
1952 multipart_ypos * SP_LEVEL_YSIZE > MAX_LEV_FIELDY)
1954 Error(ERR_WARN, "multi-part level is too big -- ignoring part of it");
1959 multipart_level.fieldx = MAX(multipart_level.fieldx,
1960 multipart_xpos * SP_LEVEL_XSIZE);
1961 multipart_level.fieldy = MAX(multipart_level.fieldy,
1962 multipart_ypos * SP_LEVEL_YSIZE);
1964 /* copy level part at the right position of multi-part level */
1965 for (y = 0; y < SP_LEVEL_YSIZE; y++)
1967 for (x = 0; x < SP_LEVEL_XSIZE; x++)
1969 int start_x = (multipart_xpos - 1) * SP_LEVEL_XSIZE;
1970 int start_y = (multipart_ypos - 1) * SP_LEVEL_YSIZE;
1972 multipart_level.field[start_x + x][start_y + y] = level->field[x][y];
1979 if (use_empty_level)
1981 setLevelInfoToDefaults(level);
1983 level->fieldx = SP_LEVEL_XSIZE;
1984 level->fieldy = SP_LEVEL_YSIZE;
1986 for (y = 0; y < SP_LEVEL_YSIZE; y++)
1987 for (x = 0; x < SP_LEVEL_XSIZE; x++)
1988 level->field[x][y] = EL_EMPTY;
1990 strcpy(level->name, "-------- EMPTY --------");
1992 Error(ERR_WARN, "single part of multi-part level -- using empty level");
1995 if (reading_multipart_level)
1996 *level = multipart_level;
1999 /* ------------------------------------------------------------------------- */
2000 /* functions for loading generic level */
2001 /* ------------------------------------------------------------------------- */
2003 void LoadLevelFromFileInfo(struct LevelInfo *level,
2004 struct LevelFileInfo *level_file_info)
2006 /* always start with reliable default values */
2007 setLevelInfoToDefaults(level);
2009 switch (level_file_info->type)
2011 case LEVEL_FILE_TYPE_RND:
2012 LoadLevelFromFileInfo_RND(level, level_file_info);
2015 case LEVEL_FILE_TYPE_EM:
2016 LoadLevelFromFileInfo_EM(level, level_file_info);
2019 case LEVEL_FILE_TYPE_SP:
2020 LoadLevelFromFileInfo_SP(level, level_file_info);
2024 LoadLevelFromFileInfo_RND(level, level_file_info);
2029 void LoadLevelFromFilename(struct LevelInfo *level, char *filename)
2031 static struct LevelFileInfo level_file_info;
2033 /* always start with reliable default values */
2034 setFileInfoToDefaults(&level_file_info);
2036 level_file_info.nr = 0; /* unknown level number */
2037 level_file_info.type = LEVEL_FILE_TYPE_RND; /* no others supported yet */
2038 level_file_info.filename = filename;
2040 LoadLevelFromFileInfo(level, &level_file_info);
2043 static void LoadLevel_InitVersion(struct LevelInfo *level, char *filename)
2045 if (leveldir_current == NULL) /* only when dumping level */
2049 printf("::: sort_priority: %d\n", leveldir_current->sort_priority);
2052 /* determine correct game engine version of current level */
2054 if (!leveldir_current->latest_engine)
2056 if (IS_LEVELCLASS_CONTRIB(leveldir_current) ||
2057 IS_LEVELCLASS_PRIVATE(leveldir_current) ||
2058 IS_LEVELCLASS_UNDEFINED(leveldir_current))
2062 printf("\n::: This level is private or contributed: '%s'\n", filename);
2066 printf("\n::: Use the stored game engine version for this level\n");
2069 /* For all levels which are not forced to use the latest game engine
2070 version (normally user contributed, private and undefined levels),
2071 use the version of the game engine the levels were created for.
2073 Since 2.0.1, the game engine version is now directly stored
2074 in the level file (chunk "VERS"), so there is no need anymore
2075 to set the game version from the file version (except for old,
2076 pre-2.0 levels, where the game version is still taken from the
2077 file format version used to store the level -- see above). */
2079 /* do some special adjustments to support older level versions */
2080 if (level->file_version == FILE_VERSION_1_0)
2082 Error(ERR_WARN, "level file '%s' has version number 1.0", filename);
2083 Error(ERR_WARN, "using high speed movement for player");
2085 /* player was faster than monsters in (pre-)1.0 levels */
2086 level->double_speed = TRUE;
2089 /* Default behaviour for EM style gems was "slippery" only in 2.0.1 */
2090 if (level->game_version == VERSION_IDENT(2,0,1,0))
2091 level->em_slippery_gems = TRUE;
2093 if (level->game_version < VERSION_IDENT(2,2,0,0))
2094 level->use_spring_bug = TRUE;
2096 if (level->game_version < VERSION_IDENT(3,0,9,0))
2100 level->can_move_into_acid_bits = 0; /* nothing can move into acid */
2102 setMoveIntoAcidProperty(level, EL_ROBOT, TRUE);
2103 setMoveIntoAcidProperty(level, EL_SATELLITE, TRUE);
2104 setMoveIntoAcidProperty(level, EL_PENGUIN, TRUE);
2105 setMoveIntoAcidProperty(level, EL_BALLOON, TRUE);
2107 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2108 SET_PROPERTY(EL_CUSTOM_START + i, EP_CAN_MOVE_INTO_ACID, TRUE);
2110 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2112 int element = EL_CUSTOM_START + i;
2113 struct ElementInfo *ei = &element_info[element];
2115 for (j = 0; j < ei->num_change_pages; j++)
2117 struct ElementChangeInfo *change = &ei->change_page[j];
2119 change->trigger_player = CH_PLAYER_ANY;
2120 change->trigger_page = CH_PAGE_ANY;
2128 printf("\n::: ALWAYS USE LATEST ENGINE FOR THIS LEVEL: [%d] '%s'\n",
2129 leveldir_current->sort_priority, filename);
2133 printf("\n::: Use latest game engine version for this level.\n");
2136 /* For all levels which are forced to use the latest game engine version
2137 (normally all but user contributed, private and undefined levels), set
2138 the game engine version to the actual version; this allows for actual
2139 corrections in the game engine to take effect for existing, converted
2140 levels (from "classic" or other existing games) to make the emulation
2141 of the corresponding game more accurate, while (hopefully) not breaking
2142 existing levels created from other players. */
2145 printf("::: changing engine from %d to %d\n",
2146 level->game_version, GAME_VERSION_ACTUAL);
2149 level->game_version = GAME_VERSION_ACTUAL;
2151 /* Set special EM style gems behaviour: EM style gems slip down from
2152 normal, steel and growing wall. As this is a more fundamental change,
2153 it seems better to set the default behaviour to "off" (as it is more
2154 natural) and make it configurable in the level editor (as a property
2155 of gem style elements). Already existing converted levels (neither
2156 private nor contributed levels) are changed to the new behaviour. */
2158 if (level->file_version < FILE_VERSION_2_0)
2159 level->em_slippery_gems = TRUE;
2163 printf("::: => %d\n", level->game_version);
2167 static void LoadLevel_InitElements(struct LevelInfo *level, char *filename)
2171 /* map custom element change events that have changed in newer versions
2172 (these following values were accidentally changed in version 3.0.1) */
2173 if (level->game_version <= VERSION_IDENT(3,0,0,0))
2175 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2177 int element = EL_CUSTOM_START + i;
2179 /* order of checking and copying events to be mapped is important */
2180 for (j = CE_BY_OTHER_ACTION; j >= CE_BY_PLAYER_OBSOLETE; j--)
2182 if (HAS_CHANGE_EVENT(element, j - 2))
2184 SET_CHANGE_EVENT(element, j - 2, FALSE);
2185 SET_CHANGE_EVENT(element, j, TRUE);
2189 /* order of checking and copying events to be mapped is important */
2190 for (j = CE_OTHER_GETS_COLLECTED; j >= CE_HITTING_SOMETHING; j--)
2192 if (HAS_CHANGE_EVENT(element, j - 1))
2194 SET_CHANGE_EVENT(element, j - 1, FALSE);
2195 SET_CHANGE_EVENT(element, j, TRUE);
2201 /* some custom element change events get mapped since version 3.0.3 */
2202 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2204 int element = EL_CUSTOM_START + i;
2206 if (HAS_CHANGE_EVENT(element, CE_BY_PLAYER_OBSOLETE) ||
2207 HAS_CHANGE_EVENT(element, CE_BY_COLLISION_OBSOLETE))
2209 SET_CHANGE_EVENT(element, CE_BY_PLAYER_OBSOLETE, FALSE);
2210 SET_CHANGE_EVENT(element, CE_BY_COLLISION_OBSOLETE, FALSE);
2212 SET_CHANGE_EVENT(element, CE_BY_DIRECT_ACTION, TRUE);
2216 /* initialize "can_change" field for old levels with only one change page */
2217 if (level->game_version <= VERSION_IDENT(3,0,2,0))
2219 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2221 int element = EL_CUSTOM_START + i;
2223 if (CAN_CHANGE(element))
2224 element_info[element].change->can_change = TRUE;
2228 /* correct custom element values (for old levels without these options) */
2229 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2231 int element = EL_CUSTOM_START + i;
2232 struct ElementInfo *ei = &element_info[element];
2234 if (ei->access_direction == MV_NO_MOVING)
2235 ei->access_direction = MV_ALL_DIRECTIONS;
2237 for (j = 0; j < ei->num_change_pages; j++)
2239 struct ElementChangeInfo *change = &ei->change_page[j];
2241 if (change->trigger_side == CH_SIDE_NONE)
2242 change->trigger_side = CH_SIDE_ANY;
2247 /* set default push delay values (corrected since version 3.0.7-1) */
2248 if (level->game_version < VERSION_IDENT(3,0,7,1))
2250 game.default_push_delay_fixed = 2;
2251 game.default_push_delay_random = 8;
2255 game.default_push_delay_fixed = 8;
2256 game.default_push_delay_random = 8;
2259 /* set uninitialized push delay values of custom elements in older levels */
2260 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2262 int element = EL_CUSTOM_START + i;
2264 if (element_info[element].push_delay_fixed == -1)
2265 element_info[element].push_delay_fixed = game.default_push_delay_fixed;
2266 if (element_info[element].push_delay_random == -1)
2267 element_info[element].push_delay_random = game.default_push_delay_random;
2271 /* map elements that have changed in newer versions */
2272 level->amoeba_content = getMappedElementByVersion(level->amoeba_content,
2273 level->game_version);
2274 for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
2275 for (x = 0; x < 3; x++)
2276 for (y = 0; y < 3; y++)
2277 level->yamyam_content[i][x][y] =
2278 getMappedElementByVersion(level->yamyam_content[i][x][y],
2279 level->game_version);
2281 /* initialize element properties for level editor etc. */
2282 InitElementPropertiesEngine(level->game_version);
2285 static void LoadLevel_InitPlayfield(struct LevelInfo *level, char *filename)
2289 /* map elements that have changed in newer versions */
2290 for (y = 0; y < level->fieldy; y++)
2292 for (x = 0; x < level->fieldx; x++)
2294 int element = level->field[x][y];
2297 element = getMappedElementByVersion(element, level->game_version);
2299 if (level->game_version <= VERSION_IDENT(2,2,0,0))
2301 /* map game font elements */
2302 element = (element == EL_CHAR('[') ? EL_CHAR_AUMLAUT :
2303 element == EL_CHAR('\\') ? EL_CHAR_OUMLAUT :
2304 element == EL_CHAR(']') ? EL_CHAR_UUMLAUT :
2305 element == EL_CHAR('^') ? EL_CHAR_COPYRIGHT : element);
2308 if (level->game_version < VERSION_IDENT(3,0,0,0))
2310 /* map Supaplex gravity tube elements */
2311 element = (element == EL_SP_GRAVITY_PORT_LEFT ? EL_SP_PORT_LEFT :
2312 element == EL_SP_GRAVITY_PORT_RIGHT ? EL_SP_PORT_RIGHT :
2313 element == EL_SP_GRAVITY_PORT_UP ? EL_SP_PORT_UP :
2314 element == EL_SP_GRAVITY_PORT_DOWN ? EL_SP_PORT_DOWN :
2319 level->field[x][y] = element;
2323 /* copy elements to runtime playfield array */
2324 for (x = 0; x < MAX_LEV_FIELDX; x++)
2325 for (y = 0; y < MAX_LEV_FIELDY; y++)
2326 Feld[x][y] = level->field[x][y];
2328 /* initialize level size variables for faster access */
2329 lev_fieldx = level->fieldx;
2330 lev_fieldy = level->fieldy;
2332 /* determine border element for this level */
2336 void LoadLevelTemplate(int nr)
2339 struct LevelFileInfo *level_file_info = getLevelFileInfo(nr);
2340 char *filename = level_file_info->filename;
2342 LoadLevelFromFileInfo(&level_template, level_file_info);
2344 char *filename = getDefaultLevelFilename(nr);
2346 LoadLevelFromFilename_RND(&level_template, filename);
2349 LoadLevel_InitVersion(&level, filename);
2350 LoadLevel_InitElements(&level, filename);
2352 ActivateLevelTemplate();
2355 void LoadLevel(int nr)
2358 struct LevelFileInfo *level_file_info = getLevelFileInfo(nr);
2359 char *filename = level_file_info->filename;
2361 LoadLevelFromFileInfo(&level, level_file_info);
2363 char *filename = getLevelFilename(nr);
2365 LoadLevelFromFilename_RND(&level, filename);
2368 if (level.use_custom_template)
2369 LoadLevelTemplate(-1);
2372 LoadLevel_InitVersion(&level, filename);
2373 LoadLevel_InitElements(&level, filename);
2374 LoadLevel_InitPlayfield(&level, filename);
2376 LoadLevel_InitLevel(&level, filename);
2380 static void SaveLevel_VERS(FILE *file, struct LevelInfo *level)
2382 putFileVersion(file, level->file_version);
2383 putFileVersion(file, level->game_version);
2386 static void SaveLevel_HEAD(FILE *file, struct LevelInfo *level)
2390 putFile8Bit(file, level->fieldx);
2391 putFile8Bit(file, level->fieldy);
2393 putFile16BitBE(file, level->time);
2394 putFile16BitBE(file, level->gems_needed);
2396 for (i = 0; i < MAX_LEVEL_NAME_LEN; i++)
2397 putFile8Bit(file, level->name[i]);
2399 for (i = 0; i < LEVEL_SCORE_ELEMENTS; i++)
2400 putFile8Bit(file, level->score[i]);
2402 for (i = 0; i < STD_ELEMENT_CONTENTS; i++)
2403 for (y = 0; y < 3; y++)
2404 for (x = 0; x < 3; x++)
2405 putFile8Bit(file, (level->encoding_16bit_yamyam ? EL_EMPTY :
2406 level->yamyam_content[i][x][y]));
2407 putFile8Bit(file, level->amoeba_speed);
2408 putFile8Bit(file, level->time_magic_wall);
2409 putFile8Bit(file, level->time_wheel);
2410 putFile8Bit(file, (level->encoding_16bit_amoeba ? EL_EMPTY :
2411 level->amoeba_content));
2412 putFile8Bit(file, (level->double_speed ? 1 : 0));
2413 putFile8Bit(file, (level->initial_gravity ? 1 : 0));
2414 putFile8Bit(file, (level->encoding_16bit_field ? 1 : 0));
2415 putFile8Bit(file, (level->em_slippery_gems ? 1 : 0));
2417 putFile8Bit(file, (level->use_custom_template ? 1 : 0));
2419 putFile8Bit(file, (level->block_last_field ? 1 : 0));
2420 putFile8Bit(file, (level->sp_block_last_field ? 1 : 0));
2422 putFile8Bit(file, (level->use_spring_bug ? 1 : 0));
2424 putFile16BitBE(file, level->can_move_into_acid_bits);
2426 putFile8Bit(file, (level->use_step_counter ? 1 : 0));
2428 putFile8Bit(file, (level->player_can_fall_into_acid ? 1 : 0));
2430 WriteUnusedBytesToFile(file, LEVEL_HEADER_UNUSED);
2433 static void SaveLevel_AUTH(FILE *file, struct LevelInfo *level)
2437 for (i = 0; i < MAX_LEVEL_AUTHOR_LEN; i++)
2438 putFile8Bit(file, level->author[i]);
2441 static void SaveLevel_BODY(FILE *file, struct LevelInfo *level)
2445 for (y = 0; y < level->fieldy; y++)
2446 for (x = 0; x < level->fieldx; x++)
2447 if (level->encoding_16bit_field)
2448 putFile16BitBE(file, level->field[x][y]);
2450 putFile8Bit(file, level->field[x][y]);
2454 static void SaveLevel_CONT(FILE *file, struct LevelInfo *level)
2458 putFile8Bit(file, EL_YAMYAM);
2459 putFile8Bit(file, level->num_yamyam_contents);
2460 putFile8Bit(file, 0);
2461 putFile8Bit(file, 0);
2463 for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
2464 for (y = 0; y < 3; y++)
2465 for (x = 0; x < 3; x++)
2466 if (level->encoding_16bit_field)
2467 putFile16BitBE(file, level->yamyam_content[i][x][y]);
2469 putFile8Bit(file, level->yamyam_content[i][x][y]);
2473 static void SaveLevel_CNT2(FILE *file, struct LevelInfo *level, int element)
2476 int num_contents, content_xsize, content_ysize;
2477 int content_array[MAX_ELEMENT_CONTENTS][3][3];
2479 if (element == EL_YAMYAM)
2481 num_contents = level->num_yamyam_contents;
2485 for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
2486 for (y = 0; y < 3; y++)
2487 for (x = 0; x < 3; x++)
2488 content_array[i][x][y] = level->yamyam_content[i][x][y];
2490 else if (element == EL_BD_AMOEBA)
2496 for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
2497 for (y = 0; y < 3; y++)
2498 for (x = 0; x < 3; x++)
2499 content_array[i][x][y] = EL_EMPTY;
2500 content_array[0][0][0] = level->amoeba_content;
2504 /* chunk header already written -- write empty chunk data */
2505 WriteUnusedBytesToFile(file, LEVEL_CHUNK_CNT2_SIZE);
2507 Error(ERR_WARN, "cannot save content for element '%d'", element);
2511 putFile16BitBE(file, element);
2512 putFile8Bit(file, num_contents);
2513 putFile8Bit(file, content_xsize);
2514 putFile8Bit(file, content_ysize);
2516 WriteUnusedBytesToFile(file, LEVEL_CHUNK_CNT2_UNUSED);
2518 for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
2519 for (y = 0; y < 3; y++)
2520 for (x = 0; x < 3; x++)
2521 putFile16BitBE(file, content_array[i][x][y]);
2524 static void SaveLevel_CNT3(FILE *file, struct LevelInfo *level, int element)
2527 int envelope_nr = element - EL_ENVELOPE_1;
2528 int envelope_len = strlen(level->envelope_text[envelope_nr]) + 1;
2530 putFile16BitBE(file, element);
2531 putFile16BitBE(file, envelope_len);
2532 putFile8Bit(file, level->envelope_xsize[envelope_nr]);
2533 putFile8Bit(file, level->envelope_ysize[envelope_nr]);
2535 WriteUnusedBytesToFile(file, LEVEL_CHUNK_CNT3_UNUSED);
2537 for (i = 0; i < envelope_len; i++)
2538 putFile8Bit(file, level->envelope_text[envelope_nr][i]);
2542 static void SaveLevel_CUS1(FILE *file, struct LevelInfo *level,
2543 int num_changed_custom_elements)
2547 putFile16BitBE(file, num_changed_custom_elements);
2549 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2551 int element = EL_CUSTOM_START + i;
2553 if (Properties[element][EP_BITFIELD_BASE] != EP_BITMASK_DEFAULT)
2555 if (check < num_changed_custom_elements)
2557 putFile16BitBE(file, element);
2558 putFile32BitBE(file, Properties[element][EP_BITFIELD_BASE]);
2565 if (check != num_changed_custom_elements) /* should not happen */
2566 Error(ERR_WARN, "inconsistent number of custom element properties");
2571 static void SaveLevel_CUS2(FILE *file, struct LevelInfo *level,
2572 int num_changed_custom_elements)
2576 putFile16BitBE(file, num_changed_custom_elements);
2578 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2580 int element = EL_CUSTOM_START + i;
2582 if (element_info[element].change->target_element != EL_EMPTY_SPACE)
2584 if (check < num_changed_custom_elements)
2586 putFile16BitBE(file, element);
2587 putFile16BitBE(file, element_info[element].change->target_element);
2594 if (check != num_changed_custom_elements) /* should not happen */
2595 Error(ERR_WARN, "inconsistent number of custom target elements");
2600 static void SaveLevel_CUS3(FILE *file, struct LevelInfo *level,
2601 int num_changed_custom_elements)
2603 int i, j, x, y, check = 0;
2605 putFile16BitBE(file, num_changed_custom_elements);
2607 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2609 int element = EL_CUSTOM_START + i;
2611 if (element_info[element].modified_settings)
2613 if (check < num_changed_custom_elements)
2615 putFile16BitBE(file, element);
2617 for (j = 0; j < MAX_ELEMENT_NAME_LEN; j++)
2618 putFile8Bit(file, element_info[element].description[j]);
2620 putFile32BitBE(file, Properties[element][EP_BITFIELD_BASE]);
2622 /* some free bytes for future properties and padding */
2623 WriteUnusedBytesToFile(file, 7);
2625 putFile8Bit(file, element_info[element].use_gfx_element);
2626 putFile16BitBE(file, element_info[element].gfx_element);
2628 putFile8Bit(file, element_info[element].collect_score);
2629 putFile8Bit(file, element_info[element].collect_count);
2631 putFile16BitBE(file, element_info[element].push_delay_fixed);
2632 putFile16BitBE(file, element_info[element].push_delay_random);
2633 putFile16BitBE(file, element_info[element].move_delay_fixed);
2634 putFile16BitBE(file, element_info[element].move_delay_random);
2636 putFile16BitBE(file, element_info[element].move_pattern);
2637 putFile8Bit(file, element_info[element].move_direction_initial);
2638 putFile8Bit(file, element_info[element].move_stepsize);
2640 for (y = 0; y < 3; y++)
2641 for (x = 0; x < 3; x++)
2642 putFile16BitBE(file, element_info[element].content[x][y]);
2644 putFile32BitBE(file, element_info[element].change->events);
2646 putFile16BitBE(file, element_info[element].change->target_element);
2648 putFile16BitBE(file, element_info[element].change->delay_fixed);
2649 putFile16BitBE(file, element_info[element].change->delay_random);
2650 putFile16BitBE(file, element_info[element].change->delay_frames);
2652 putFile16BitBE(file, element_info[element].change->trigger_element);
2654 putFile8Bit(file, element_info[element].change->explode);
2655 putFile8Bit(file, element_info[element].change->use_content);
2656 putFile8Bit(file, element_info[element].change->only_complete);
2657 putFile8Bit(file, element_info[element].change->use_random_change);
2659 putFile8Bit(file, element_info[element].change->random);
2660 putFile8Bit(file, element_info[element].change->power);
2662 for (y = 0; y < 3; y++)
2663 for (x = 0; x < 3; x++)
2664 putFile16BitBE(file, element_info[element].change->content[x][y]);
2666 putFile8Bit(file, element_info[element].slippery_type);
2668 /* some free bytes for future properties and padding */
2669 WriteUnusedBytesToFile(file, LEVEL_CPART_CUS3_UNUSED);
2676 if (check != num_changed_custom_elements) /* should not happen */
2677 Error(ERR_WARN, "inconsistent number of custom element properties");
2681 static void SaveLevel_CUS4(FILE *file, struct LevelInfo *level, int element)
2683 struct ElementInfo *ei = &element_info[element];
2686 putFile16BitBE(file, element);
2688 for (i = 0; i < MAX_ELEMENT_NAME_LEN; i++)
2689 putFile8Bit(file, ei->description[i]);
2691 putFile32BitBE(file, Properties[element][EP_BITFIELD_BASE]);
2692 WriteUnusedBytesToFile(file, 4); /* reserved for more base properties */
2694 putFile8Bit(file, ei->num_change_pages);
2696 /* some free bytes for future base property values and padding */
2697 WriteUnusedBytesToFile(file, 5);
2699 /* write custom property values */
2701 putFile8Bit(file, ei->use_gfx_element);
2702 putFile16BitBE(file, ei->gfx_element);
2704 putFile8Bit(file, ei->collect_score);
2705 putFile8Bit(file, ei->collect_count);
2707 putFile16BitBE(file, ei->push_delay_fixed);
2708 putFile16BitBE(file, ei->push_delay_random);
2709 putFile16BitBE(file, ei->move_delay_fixed);
2710 putFile16BitBE(file, ei->move_delay_random);
2712 /* bits 0 - 15 of "move_pattern" ... */
2713 putFile16BitBE(file, ei->move_pattern & 0xffff);
2714 putFile8Bit(file, ei->move_direction_initial);
2715 putFile8Bit(file, ei->move_stepsize);
2717 putFile8Bit(file, ei->slippery_type);
2719 for (y = 0; y < 3; y++)
2720 for (x = 0; x < 3; x++)
2721 putFile16BitBE(file, ei->content[x][y]);
2723 putFile16BitBE(file, ei->move_enter_element);
2724 putFile16BitBE(file, ei->move_leave_element);
2725 putFile8Bit(file, ei->move_leave_type);
2727 /* ... bits 16 - 31 of "move_pattern" (not nice, but downward compatible) */
2728 putFile16BitBE(file, (ei->move_pattern >> 16) & 0xffff);
2730 putFile8Bit(file, ei->access_direction);
2732 putFile8Bit(file, ei->explosion_delay);
2733 putFile8Bit(file, ei->ignition_delay);
2735 /* some free bytes for future custom property values and padding */
2736 WriteUnusedBytesToFile(file, 2);
2738 /* write change property values */
2740 for (i = 0; i < ei->num_change_pages; i++)
2742 struct ElementChangeInfo *change = &ei->change_page[i];
2744 putFile32BitBE(file, change->events);
2746 putFile16BitBE(file, change->target_element);
2748 putFile16BitBE(file, change->delay_fixed);
2749 putFile16BitBE(file, change->delay_random);
2750 putFile16BitBE(file, change->delay_frames);
2752 putFile16BitBE(file, change->trigger_element);
2754 putFile8Bit(file, change->explode);
2755 putFile8Bit(file, change->use_content);
2756 putFile8Bit(file, change->only_complete);
2757 putFile8Bit(file, change->use_random_change);
2759 putFile8Bit(file, change->random);
2760 putFile8Bit(file, change->power);
2762 for (y = 0; y < 3; y++)
2763 for (x = 0; x < 3; x++)
2764 putFile16BitBE(file, change->content[x][y]);
2766 putFile8Bit(file, change->can_change);
2768 putFile8Bit(file, change->trigger_side);
2771 putFile8Bit(file, change->trigger_player);
2772 putFile8Bit(file, (change->trigger_page == CH_PAGE_ANY ? CH_PAGE_ANY_FILE :
2773 log_2(change->trigger_page)));
2775 /* some free bytes for future change property values and padding */
2776 WriteUnusedBytesToFile(file, 6);
2780 /* some free bytes for future change property values and padding */
2781 WriteUnusedBytesToFile(file, 8);
2786 static void SaveLevel_GRP1(FILE *file, struct LevelInfo *level, int element)
2788 struct ElementInfo *ei = &element_info[element];
2789 struct ElementGroupInfo *group = ei->group;
2792 putFile16BitBE(file, element);
2794 for (i = 0; i < MAX_ELEMENT_NAME_LEN; i++)
2795 putFile8Bit(file, ei->description[i]);
2797 putFile8Bit(file, group->num_elements);
2799 putFile8Bit(file, ei->use_gfx_element);
2800 putFile16BitBE(file, ei->gfx_element);
2802 putFile8Bit(file, group->choice_mode);
2804 /* some free bytes for future values and padding */
2805 WriteUnusedBytesToFile(file, 3);
2807 for (i = 0; i < MAX_ELEMENTS_IN_GROUP; i++)
2808 putFile16BitBE(file, group->element[i]);
2811 static void SaveLevelFromFilename(struct LevelInfo *level, char *filename)
2813 int body_chunk_size;
2817 if (!(file = fopen(filename, MODE_WRITE)))
2819 Error(ERR_WARN, "cannot save level file '%s'", filename);
2823 level->file_version = FILE_VERSION_ACTUAL;
2824 level->game_version = GAME_VERSION_ACTUAL;
2826 /* check level field for 16-bit elements */
2827 level->encoding_16bit_field = FALSE;
2828 for (y = 0; y < level->fieldy; y++)
2829 for (x = 0; x < level->fieldx; x++)
2830 if (level->field[x][y] > 255)
2831 level->encoding_16bit_field = TRUE;
2833 /* check yamyam content for 16-bit elements */
2834 level->encoding_16bit_yamyam = FALSE;
2835 for (i = 0; i < level->num_yamyam_contents; i++)
2836 for (y = 0; y < 3; y++)
2837 for (x = 0; x < 3; x++)
2838 if (level->yamyam_content[i][x][y] > 255)
2839 level->encoding_16bit_yamyam = TRUE;
2841 /* check amoeba content for 16-bit elements */
2842 level->encoding_16bit_amoeba = FALSE;
2843 if (level->amoeba_content > 255)
2844 level->encoding_16bit_amoeba = TRUE;
2846 /* calculate size of "BODY" chunk */
2848 level->fieldx * level->fieldy * (level->encoding_16bit_field ? 2 : 1);
2850 putFileChunkBE(file, "RND1", CHUNK_SIZE_UNDEFINED);
2851 putFileChunkBE(file, "CAVE", CHUNK_SIZE_NONE);
2853 putFileChunkBE(file, "VERS", FILE_VERS_CHUNK_SIZE);
2854 SaveLevel_VERS(file, level);
2856 putFileChunkBE(file, "HEAD", LEVEL_HEADER_SIZE);
2857 SaveLevel_HEAD(file, level);
2859 putFileChunkBE(file, "AUTH", MAX_LEVEL_AUTHOR_LEN);
2860 SaveLevel_AUTH(file, level);
2862 putFileChunkBE(file, "BODY", body_chunk_size);
2863 SaveLevel_BODY(file, level);
2865 if (level->encoding_16bit_yamyam ||
2866 level->num_yamyam_contents != STD_ELEMENT_CONTENTS)
2868 putFileChunkBE(file, "CNT2", LEVEL_CHUNK_CNT2_SIZE);
2869 SaveLevel_CNT2(file, level, EL_YAMYAM);
2872 if (level->encoding_16bit_amoeba)
2874 putFileChunkBE(file, "CNT2", LEVEL_CHUNK_CNT2_SIZE);
2875 SaveLevel_CNT2(file, level, EL_BD_AMOEBA);
2878 /* check for envelope content */
2879 for (i = 0; i < 4; i++)
2881 if (strlen(level->envelope_text[i]) > 0)
2883 int envelope_len = strlen(level->envelope_text[i]) + 1;
2885 putFileChunkBE(file, "CNT3", LEVEL_CHUNK_CNT3_SIZE(envelope_len));
2886 SaveLevel_CNT3(file, level, EL_ENVELOPE_1 + i);
2890 /* check for non-default custom elements (unless using template level) */
2891 if (!level->use_custom_template)
2893 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2895 int element = EL_CUSTOM_START + i;
2897 if (element_info[element].modified_settings)
2899 int num_change_pages = element_info[element].num_change_pages;
2901 putFileChunkBE(file, "CUS4", LEVEL_CHUNK_CUS4_SIZE(num_change_pages));
2902 SaveLevel_CUS4(file, level, element);
2907 /* check for non-default group elements (unless using template level) */
2908 if (!level->use_custom_template)
2910 for (i = 0; i < NUM_GROUP_ELEMENTS; i++)
2912 int element = EL_GROUP_START + i;
2914 if (element_info[element].modified_settings)
2916 putFileChunkBE(file, "GRP1", LEVEL_CHUNK_GRP1_SIZE);
2917 SaveLevel_GRP1(file, level, element);
2924 SetFilePermissions(filename, PERMS_PRIVATE);
2927 void SaveLevel(int nr)
2929 char *filename = getDefaultLevelFilename(nr);
2931 SaveLevelFromFilename(&level, filename);
2934 void SaveLevelTemplate()
2936 char *filename = getDefaultLevelFilename(-1);
2938 SaveLevelFromFilename(&level, filename);
2941 void DumpLevel(struct LevelInfo *level)
2943 if (level->no_valid_file)
2945 Error(ERR_WARN, "cannot dump -- no valid level file found");
2950 printf_line("-", 79);
2951 printf("Level xxx (file version %08d, game version %08d)\n",
2952 level->file_version, level->game_version);
2953 printf_line("-", 79);
2955 printf("Level author: '%s'\n", level->author);
2956 printf("Level title: '%s'\n", level->name);
2958 printf("Playfield size: %d x %d\n", level->fieldx, level->fieldy);
2960 printf("Level time: %d seconds\n", level->time);
2961 printf("Gems needed: %d\n", level->gems_needed);
2963 printf("Time for magic wall: %d seconds\n", level->time_magic_wall);
2964 printf("Time for wheel: %d seconds\n", level->time_wheel);
2965 printf("Time for light: %d seconds\n", level->time_light);
2966 printf("Time for timegate: %d seconds\n", level->time_timegate);
2968 printf("Amoeba speed: %d\n", level->amoeba_speed);
2970 printf("Initial gravity: %s\n", (level->initial_gravity ? "yes" : "no"));
2971 printf("Double speed movement: %s\n", (level->double_speed ? "yes" : "no"));
2972 printf("EM style slippery gems: %s\n", (level->em_slippery_gems ? "yes" : "no"));
2973 printf("Player blocks last field: %s\n", (level->block_last_field ? "yes" : "no"));
2974 printf("SP player blocks last field: %s\n", (level->sp_block_last_field ? "yes" : "no"));
2975 printf("use spring bug: %s\n", (level->use_spring_bug ? "yes" : "no"));
2976 printf("use step counter: %s\n", (level->use_step_counter ? "yes" : "no"));
2978 printf_line("-", 79);
2982 /* ========================================================================= */
2983 /* tape file functions */
2984 /* ========================================================================= */
2986 static void setTapeInfoToDefaults()
2990 /* always start with reliable default values (empty tape) */
2993 /* default values (also for pre-1.2 tapes) with only the first player */
2994 tape.player_participates[0] = TRUE;
2995 for (i = 1; i < MAX_PLAYERS; i++)
2996 tape.player_participates[i] = FALSE;
2998 /* at least one (default: the first) player participates in every tape */
2999 tape.num_participating_players = 1;
3001 tape.level_nr = level_nr;
3003 tape.changed = FALSE;
3005 tape.recording = FALSE;
3006 tape.playing = FALSE;
3007 tape.pausing = FALSE;
3009 tape.no_valid_file = FALSE;
3012 static int LoadTape_VERS(FILE *file, int chunk_size, struct TapeInfo *tape)
3014 tape->file_version = getFileVersion(file);
3015 tape->game_version = getFileVersion(file);
3020 static int LoadTape_HEAD(FILE *file, int chunk_size, struct TapeInfo *tape)
3024 tape->random_seed = getFile32BitBE(file);
3025 tape->date = getFile32BitBE(file);
3026 tape->length = getFile32BitBE(file);
3028 /* read header fields that are new since version 1.2 */
3029 if (tape->file_version >= FILE_VERSION_1_2)
3031 byte store_participating_players = getFile8Bit(file);
3034 /* since version 1.2, tapes store which players participate in the tape */
3035 tape->num_participating_players = 0;
3036 for (i = 0; i < MAX_PLAYERS; i++)
3038 tape->player_participates[i] = FALSE;
3040 if (store_participating_players & (1 << i))
3042 tape->player_participates[i] = TRUE;
3043 tape->num_participating_players++;
3047 ReadUnusedBytesFromFile(file, TAPE_HEADER_UNUSED);
3049 engine_version = getFileVersion(file);
3050 if (engine_version > 0)
3051 tape->engine_version = engine_version;
3053 tape->engine_version = tape->game_version;
3059 static int LoadTape_INFO(FILE *file, int chunk_size, struct TapeInfo *tape)
3061 int level_identifier_size;
3064 level_identifier_size = getFile16BitBE(file);
3066 tape->level_identifier =
3067 checked_realloc(tape->level_identifier, level_identifier_size);
3069 for (i = 0; i < level_identifier_size; i++)
3070 tape->level_identifier[i] = getFile8Bit(file);
3072 tape->level_nr = getFile16BitBE(file);
3074 chunk_size = 2 + level_identifier_size + 2;
3079 static int LoadTape_BODY(FILE *file, int chunk_size, struct TapeInfo *tape)
3082 int chunk_size_expected =
3083 (tape->num_participating_players + 1) * tape->length;
3085 if (chunk_size_expected != chunk_size)
3087 ReadUnusedBytesFromFile(file, chunk_size);
3088 return chunk_size_expected;
3091 for (i = 0; i < tape->length; i++)
3093 if (i >= MAX_TAPELEN)
3096 for (j = 0; j < MAX_PLAYERS; j++)
3098 tape->pos[i].action[j] = MV_NO_MOVING;
3100 if (tape->player_participates[j])
3101 tape->pos[i].action[j] = getFile8Bit(file);
3104 tape->pos[i].delay = getFile8Bit(file);
3106 if (tape->file_version == FILE_VERSION_1_0)
3108 /* eliminate possible diagonal moves in old tapes */
3109 /* this is only for backward compatibility */
3111 byte joy_dir[4] = { JOY_LEFT, JOY_RIGHT, JOY_UP, JOY_DOWN };
3112 byte action = tape->pos[i].action[0];
3113 int k, num_moves = 0;
3115 for (k = 0; k<4; k++)
3117 if (action & joy_dir[k])
3119 tape->pos[i + num_moves].action[0] = joy_dir[k];
3121 tape->pos[i + num_moves].delay = 0;
3130 tape->length += num_moves;
3133 else if (tape->file_version < FILE_VERSION_2_0)
3135 /* convert pre-2.0 tapes to new tape format */
3137 if (tape->pos[i].delay > 1)
3140 tape->pos[i + 1] = tape->pos[i];
3141 tape->pos[i + 1].delay = 1;
3144 for (j = 0; j < MAX_PLAYERS; j++)
3145 tape->pos[i].action[j] = MV_NO_MOVING;
3146 tape->pos[i].delay--;
3157 if (i != tape->length)
3158 chunk_size = (tape->num_participating_players + 1) * i;
3163 void LoadTapeFromFilename(char *filename)
3165 char cookie[MAX_LINE_LEN];
3166 char chunk_name[CHUNK_ID_LEN + 1];
3170 /* always start with reliable default values */
3171 setTapeInfoToDefaults();
3173 if (!(file = fopen(filename, MODE_READ)))
3175 tape.no_valid_file = TRUE;
3177 Error(ERR_WARN, "cannot read tape '%s' -- using empty tape", filename);
3182 getFileChunkBE(file, chunk_name, NULL);
3183 if (strcmp(chunk_name, "RND1") == 0)
3185 getFile32BitBE(file); /* not used */
3187 getFileChunkBE(file, chunk_name, NULL);
3188 if (strcmp(chunk_name, "TAPE") != 0)
3190 tape.no_valid_file = TRUE;
3192 Error(ERR_WARN, "unknown format of tape file '%s'", filename);
3197 else /* check for pre-2.0 file format with cookie string */
3199 strcpy(cookie, chunk_name);
3200 fgets(&cookie[4], MAX_LINE_LEN - 4, file);
3201 if (strlen(cookie) > 0 && cookie[strlen(cookie) - 1] == '\n')
3202 cookie[strlen(cookie) - 1] = '\0';
3204 if (!checkCookieString(cookie, TAPE_COOKIE_TMPL))
3206 tape.no_valid_file = TRUE;
3208 Error(ERR_WARN, "unknown format of tape file '%s'", filename);
3213 if ((tape.file_version = getFileVersionFromCookieString(cookie)) == -1)
3215 tape.no_valid_file = TRUE;
3217 Error(ERR_WARN, "unsupported version of tape file '%s'", filename);
3222 /* pre-2.0 tape files have no game version, so use file version here */
3223 tape.game_version = tape.file_version;
3226 if (tape.file_version < FILE_VERSION_1_2)
3228 /* tape files from versions before 1.2.0 without chunk structure */
3229 LoadTape_HEAD(file, TAPE_HEADER_SIZE, &tape);
3230 LoadTape_BODY(file, 2 * tape.length, &tape);
3238 int (*loader)(FILE *, int, struct TapeInfo *);
3242 { "VERS", FILE_VERS_CHUNK_SIZE, LoadTape_VERS },
3243 { "HEAD", TAPE_HEADER_SIZE, LoadTape_HEAD },
3244 { "INFO", -1, LoadTape_INFO },
3245 { "BODY", -1, LoadTape_BODY },
3249 while (getFileChunkBE(file, chunk_name, &chunk_size))
3253 while (chunk_info[i].name != NULL &&
3254 strcmp(chunk_name, chunk_info[i].name) != 0)
3257 if (chunk_info[i].name == NULL)
3259 Error(ERR_WARN, "unknown chunk '%s' in tape file '%s'",
3260 chunk_name, filename);
3261 ReadUnusedBytesFromFile(file, chunk_size);
3263 else if (chunk_info[i].size != -1 &&
3264 chunk_info[i].size != chunk_size)
3266 Error(ERR_WARN, "wrong size (%d) of chunk '%s' in tape file '%s'",
3267 chunk_size, chunk_name, filename);
3268 ReadUnusedBytesFromFile(file, chunk_size);
3272 /* call function to load this tape chunk */
3273 int chunk_size_expected =
3274 (chunk_info[i].loader)(file, chunk_size, &tape);
3276 /* the size of some chunks cannot be checked before reading other
3277 chunks first (like "HEAD" and "BODY") that contain some header
3278 information, so check them here */
3279 if (chunk_size_expected != chunk_size)
3281 Error(ERR_WARN, "wrong size (%d) of chunk '%s' in tape file '%s'",
3282 chunk_size, chunk_name, filename);
3290 tape.length_seconds = GetTapeLength();
3293 printf("::: tape game version: %d\n", tape.game_version);
3294 printf("::: tape engine version: %d\n", tape.engine_version);
3298 void LoadTape(int nr)
3300 char *filename = getTapeFilename(nr);
3302 LoadTapeFromFilename(filename);
3305 void LoadSolutionTape(int nr)
3307 char *filename = getSolutionTapeFilename(nr);
3309 LoadTapeFromFilename(filename);
3312 static void SaveTape_VERS(FILE *file, struct TapeInfo *tape)
3314 putFileVersion(file, tape->file_version);
3315 putFileVersion(file, tape->game_version);
3318 static void SaveTape_HEAD(FILE *file, struct TapeInfo *tape)
3321 byte store_participating_players = 0;
3323 /* set bits for participating players for compact storage */
3324 for (i = 0; i < MAX_PLAYERS; i++)
3325 if (tape->player_participates[i])
3326 store_participating_players |= (1 << i);
3328 putFile32BitBE(file, tape->random_seed);
3329 putFile32BitBE(file, tape->date);
3330 putFile32BitBE(file, tape->length);
3332 putFile8Bit(file, store_participating_players);
3334 /* unused bytes not at the end here for 4-byte alignment of engine_version */
3335 WriteUnusedBytesToFile(file, TAPE_HEADER_UNUSED);
3337 putFileVersion(file, tape->engine_version);
3340 static void SaveTape_INFO(FILE *file, struct TapeInfo *tape)
3342 int level_identifier_size = strlen(tape->level_identifier) + 1;
3345 putFile16BitBE(file, level_identifier_size);
3347 for (i = 0; i < level_identifier_size; i++)
3348 putFile8Bit(file, tape->level_identifier[i]);
3350 putFile16BitBE(file, tape->level_nr);
3353 static void SaveTape_BODY(FILE *file, struct TapeInfo *tape)
3357 for (i = 0; i < tape->length; i++)
3359 for (j = 0; j < MAX_PLAYERS; j++)
3360 if (tape->player_participates[j])
3361 putFile8Bit(file, tape->pos[i].action[j]);
3363 putFile8Bit(file, tape->pos[i].delay);
3367 void SaveTape(int nr)
3369 char *filename = getTapeFilename(nr);
3371 boolean new_tape = TRUE;
3372 int num_participating_players = 0;
3373 int info_chunk_size;
3374 int body_chunk_size;
3377 InitTapeDirectory(leveldir_current->subdir);
3379 /* if a tape still exists, ask to overwrite it */
3380 if (access(filename, F_OK) == 0)
3383 if (!Request("Replace old tape ?", REQ_ASK))
3387 if (!(file = fopen(filename, MODE_WRITE)))
3389 Error(ERR_WARN, "cannot save level recording file '%s'", filename);
3393 tape.file_version = FILE_VERSION_ACTUAL;
3394 tape.game_version = GAME_VERSION_ACTUAL;
3396 /* count number of participating players */
3397 for (i = 0; i < MAX_PLAYERS; i++)
3398 if (tape.player_participates[i])
3399 num_participating_players++;
3401 info_chunk_size = 2 + (strlen(tape.level_identifier) + 1) + 2;
3402 body_chunk_size = (num_participating_players + 1) * tape.length;
3404 putFileChunkBE(file, "RND1", CHUNK_SIZE_UNDEFINED);
3405 putFileChunkBE(file, "TAPE", CHUNK_SIZE_NONE);
3407 putFileChunkBE(file, "VERS", FILE_VERS_CHUNK_SIZE);
3408 SaveTape_VERS(file, &tape);
3410 putFileChunkBE(file, "HEAD", TAPE_HEADER_SIZE);
3411 SaveTape_HEAD(file, &tape);
3413 putFileChunkBE(file, "INFO", info_chunk_size);
3414 SaveTape_INFO(file, &tape);
3416 putFileChunkBE(file, "BODY", body_chunk_size);
3417 SaveTape_BODY(file, &tape);
3421 SetFilePermissions(filename, PERMS_PRIVATE);
3423 tape.changed = FALSE;
3426 Request("tape saved !", REQ_CONFIRM);
3429 void DumpTape(struct TapeInfo *tape)
3434 if (tape->no_valid_file)
3436 Error(ERR_WARN, "cannot dump -- no valid tape file found");
3441 if (TAPE_IS_EMPTY(*tape))
3443 Error(ERR_WARN, "no tape available for level %d", tape->level_nr);
3449 printf_line("-", 79);
3450 printf("Tape of Level %03d (file version %08d, game version %08d)\n",
3451 tape->level_nr, tape->file_version, tape->game_version);
3452 printf("Level series identifier: '%s'\n", tape->level_identifier);
3453 printf_line("-", 79);
3455 for (i = 0; i < tape->length; i++)
3457 if (i >= MAX_TAPELEN)
3460 printf("%03d: ", i);
3462 for (j = 0; j < MAX_PLAYERS; j++)
3464 if (tape->player_participates[j])
3466 int action = tape->pos[i].action[j];
3468 printf("%d:%02x ", j, action);
3469 printf("[%c%c%c%c|%c%c] - ",
3470 (action & JOY_LEFT ? '<' : ' '),
3471 (action & JOY_RIGHT ? '>' : ' '),
3472 (action & JOY_UP ? '^' : ' '),
3473 (action & JOY_DOWN ? 'v' : ' '),
3474 (action & JOY_BUTTON_1 ? '1' : ' '),
3475 (action & JOY_BUTTON_2 ? '2' : ' '));
3479 printf("(%03d)\n", tape->pos[i].delay);
3482 printf_line("-", 79);
3486 /* ========================================================================= */
3487 /* score file functions */
3488 /* ========================================================================= */
3490 void LoadScore(int nr)
3493 char *filename = getScoreFilename(nr);
3494 char cookie[MAX_LINE_LEN];
3495 char line[MAX_LINE_LEN];
3499 /* always start with reliable default values */
3500 for (i = 0; i < MAX_SCORE_ENTRIES; i++)
3502 strcpy(highscore[i].Name, EMPTY_PLAYER_NAME);
3503 highscore[i].Score = 0;
3506 if (!(file = fopen(filename, MODE_READ)))
3509 /* check file identifier */
3510 fgets(cookie, MAX_LINE_LEN, file);
3511 if (strlen(cookie) > 0 && cookie[strlen(cookie) - 1] == '\n')
3512 cookie[strlen(cookie) - 1] = '\0';
3514 if (!checkCookieString(cookie, SCORE_COOKIE))
3516 Error(ERR_WARN, "unknown format of score file '%s'", filename);
3521 for (i = 0; i < MAX_SCORE_ENTRIES; i++)
3523 fscanf(file, "%d", &highscore[i].Score);
3524 fgets(line, MAX_LINE_LEN, file);
3526 if (line[strlen(line) - 1] == '\n')
3527 line[strlen(line) - 1] = '\0';
3529 for (line_ptr = line; *line_ptr; line_ptr++)
3531 if (*line_ptr != ' ' && *line_ptr != '\t' && *line_ptr != '\0')
3533 strncpy(highscore[i].Name, line_ptr, MAX_PLAYER_NAME_LEN);
3534 highscore[i].Name[MAX_PLAYER_NAME_LEN] = '\0';
3543 void SaveScore(int nr)
3546 char *filename = getScoreFilename(nr);
3549 InitScoreDirectory(leveldir_current->subdir);
3551 if (!(file = fopen(filename, MODE_WRITE)))
3553 Error(ERR_WARN, "cannot save score for level %d", nr);
3557 fprintf(file, "%s\n\n", SCORE_COOKIE);
3559 for (i = 0; i < MAX_SCORE_ENTRIES; i++)
3560 fprintf(file, "%d %s\n", highscore[i].Score, highscore[i].Name);
3564 SetFilePermissions(filename, PERMS_PUBLIC);
3568 /* ========================================================================= */
3569 /* setup file functions */
3570 /* ========================================================================= */
3572 #define TOKEN_STR_PLAYER_PREFIX "player_"
3575 #define SETUP_TOKEN_PLAYER_NAME 0
3576 #define SETUP_TOKEN_SOUND 1
3577 #define SETUP_TOKEN_SOUND_LOOPS 2
3578 #define SETUP_TOKEN_SOUND_MUSIC 3
3579 #define SETUP_TOKEN_SOUND_SIMPLE 4
3580 #define SETUP_TOKEN_TOONS 5
3581 #define SETUP_TOKEN_SCROLL_DELAY 6
3582 #define SETUP_TOKEN_SOFT_SCROLLING 7
3583 #define SETUP_TOKEN_FADING 8
3584 #define SETUP_TOKEN_AUTORECORD 9
3585 #define SETUP_TOKEN_QUICK_DOORS 10
3586 #define SETUP_TOKEN_TEAM_MODE 11
3587 #define SETUP_TOKEN_HANDICAP 12
3588 #define SETUP_TOKEN_TIME_LIMIT 13
3589 #define SETUP_TOKEN_FULLSCREEN 14
3590 #define SETUP_TOKEN_ASK_ON_ESCAPE 15
3591 #define SETUP_TOKEN_GRAPHICS_SET 16
3592 #define SETUP_TOKEN_SOUNDS_SET 17
3593 #define SETUP_TOKEN_MUSIC_SET 18
3594 #define SETUP_TOKEN_OVERRIDE_LEVEL_GRAPHICS 19
3595 #define SETUP_TOKEN_OVERRIDE_LEVEL_SOUNDS 20
3596 #define SETUP_TOKEN_OVERRIDE_LEVEL_MUSIC 21
3598 #define NUM_GLOBAL_SETUP_TOKENS 22
3601 #define SETUP_TOKEN_EDITOR_EL_BOULDERDASH 0
3602 #define SETUP_TOKEN_EDITOR_EL_EMERALD_MINE 1
3603 #define SETUP_TOKEN_EDITOR_EL_MORE 2
3604 #define SETUP_TOKEN_EDITOR_EL_SOKOBAN 3
3605 #define SETUP_TOKEN_EDITOR_EL_SUPAPLEX 4
3606 #define SETUP_TOKEN_EDITOR_EL_DIAMOND_CAVES 5
3607 #define SETUP_TOKEN_EDITOR_EL_DX_BOULDERDASH 6
3608 #define SETUP_TOKEN_EDITOR_EL_CHARS 7
3609 #define SETUP_TOKEN_EDITOR_EL_CUSTOM 8
3610 #define SETUP_TOKEN_EDITOR_EL_CUSTOM_MORE 9
3611 #define SETUP_TOKEN_EDITOR_EL_HEADLINES 10
3612 #define SETUP_TOKEN_EDITOR_EL_USER_DEFINED 11
3614 #define NUM_EDITOR_SETUP_TOKENS 12
3616 /* shortcut setup */
3617 #define SETUP_TOKEN_SHORTCUT_SAVE_GAME 0
3618 #define SETUP_TOKEN_SHORTCUT_LOAD_GAME 1
3619 #define SETUP_TOKEN_SHORTCUT_TOGGLE_PAUSE 2
3621 #define NUM_SHORTCUT_SETUP_TOKENS 3
3624 #define SETUP_TOKEN_PLAYER_USE_JOYSTICK 0
3625 #define SETUP_TOKEN_PLAYER_JOY_DEVICE_NAME 1
3626 #define SETUP_TOKEN_PLAYER_JOY_XLEFT 2
3627 #define SETUP_TOKEN_PLAYER_JOY_XMIDDLE 3
3628 #define SETUP_TOKEN_PLAYER_JOY_XRIGHT 4
3629 #define SETUP_TOKEN_PLAYER_JOY_YUPPER 5
3630 #define SETUP_TOKEN_PLAYER_JOY_YMIDDLE 6
3631 #define SETUP_TOKEN_PLAYER_JOY_YLOWER 7
3632 #define SETUP_TOKEN_PLAYER_JOY_SNAP 8
3633 #define SETUP_TOKEN_PLAYER_JOY_DROP 9
3634 #define SETUP_TOKEN_PLAYER_KEY_LEFT 10
3635 #define SETUP_TOKEN_PLAYER_KEY_RIGHT 11
3636 #define SETUP_TOKEN_PLAYER_KEY_UP 12
3637 #define SETUP_TOKEN_PLAYER_KEY_DOWN 13
3638 #define SETUP_TOKEN_PLAYER_KEY_SNAP 14
3639 #define SETUP_TOKEN_PLAYER_KEY_DROP 15
3641 #define NUM_PLAYER_SETUP_TOKENS 16
3644 #define SETUP_TOKEN_SYSTEM_SDL_AUDIODRIVER 0
3645 #define SETUP_TOKEN_SYSTEM_AUDIO_FRAGMENT_SIZE 1
3647 #define NUM_SYSTEM_SETUP_TOKENS 2
3650 #define SETUP_TOKEN_OPTIONS_VERBOSE 0
3652 #define NUM_OPTIONS_SETUP_TOKENS 1
3655 static struct SetupInfo si;
3656 static struct SetupEditorInfo sei;
3657 static struct SetupShortcutInfo ssi;
3658 static struct SetupInputInfo sii;
3659 static struct SetupSystemInfo syi;
3660 static struct OptionInfo soi;
3662 static struct TokenInfo global_setup_tokens[] =
3664 { TYPE_STRING, &si.player_name, "player_name" },
3665 { TYPE_SWITCH, &si.sound, "sound" },
3666 { TYPE_SWITCH, &si.sound_loops, "repeating_sound_loops" },
3667 { TYPE_SWITCH, &si.sound_music, "background_music" },
3668 { TYPE_SWITCH, &si.sound_simple, "simple_sound_effects" },
3669 { TYPE_SWITCH, &si.toons, "toons" },
3670 { TYPE_SWITCH, &si.scroll_delay, "scroll_delay" },
3671 { TYPE_SWITCH, &si.soft_scrolling, "soft_scrolling" },
3672 { TYPE_SWITCH, &si.fading, "screen_fading" },
3673 { TYPE_SWITCH, &si.autorecord, "automatic_tape_recording" },
3674 { TYPE_SWITCH, &si.quick_doors, "quick_doors" },
3675 { TYPE_SWITCH, &si.team_mode, "team_mode" },
3676 { TYPE_SWITCH, &si.handicap, "handicap" },
3677 { TYPE_SWITCH, &si.time_limit, "time_limit" },
3678 { TYPE_SWITCH, &si.fullscreen, "fullscreen" },
3679 { TYPE_SWITCH, &si.ask_on_escape, "ask_on_escape" },
3680 { TYPE_STRING, &si.graphics_set, "graphics_set" },
3681 { TYPE_STRING, &si.sounds_set, "sounds_set" },
3682 { TYPE_STRING, &si.music_set, "music_set" },
3683 { TYPE_SWITCH, &si.override_level_graphics, "override_level_graphics" },
3684 { TYPE_SWITCH, &si.override_level_sounds, "override_level_sounds" },
3685 { TYPE_SWITCH, &si.override_level_music, "override_level_music" },
3688 static struct TokenInfo editor_setup_tokens[] =
3690 { TYPE_SWITCH, &sei.el_boulderdash, "editor.el_boulderdash" },
3691 { TYPE_SWITCH, &sei.el_emerald_mine, "editor.el_emerald_mine" },
3692 { TYPE_SWITCH, &sei.el_more, "editor.el_more" },
3693 { TYPE_SWITCH, &sei.el_sokoban, "editor.el_sokoban" },
3694 { TYPE_SWITCH, &sei.el_supaplex, "editor.el_supaplex" },
3695 { TYPE_SWITCH, &sei.el_diamond_caves, "editor.el_diamond_caves" },
3696 { TYPE_SWITCH, &sei.el_dx_boulderdash,"editor.el_dx_boulderdash" },
3697 { TYPE_SWITCH, &sei.el_chars, "editor.el_chars" },
3698 { TYPE_SWITCH, &sei.el_custom, "editor.el_custom" },
3699 { TYPE_SWITCH, &sei.el_custom_more, "editor.el_custom_more" },
3700 { TYPE_SWITCH, &sei.el_headlines, "editor.el_headlines" },
3701 { TYPE_SWITCH, &sei.el_user_defined, "editor.el_user_defined" },
3704 static struct TokenInfo shortcut_setup_tokens[] =
3706 { TYPE_KEY_X11, &ssi.save_game, "shortcut.save_game" },
3707 { TYPE_KEY_X11, &ssi.load_game, "shortcut.load_game" },
3708 { TYPE_KEY_X11, &ssi.toggle_pause, "shortcut.toggle_pause" }
3711 static struct TokenInfo player_setup_tokens[] =
3713 { TYPE_BOOLEAN, &sii.use_joystick, ".use_joystick" },
3714 { TYPE_STRING, &sii.joy.device_name, ".joy.device_name" },
3715 { TYPE_INTEGER, &sii.joy.xleft, ".joy.xleft" },
3716 { TYPE_INTEGER, &sii.joy.xmiddle, ".joy.xmiddle" },
3717 { TYPE_INTEGER, &sii.joy.xright, ".joy.xright" },
3718 { TYPE_INTEGER, &sii.joy.yupper, ".joy.yupper" },
3719 { TYPE_INTEGER, &sii.joy.ymiddle, ".joy.ymiddle" },
3720 { TYPE_INTEGER, &sii.joy.ylower, ".joy.ylower" },
3721 { TYPE_INTEGER, &sii.joy.snap, ".joy.snap_field" },
3722 { TYPE_INTEGER, &sii.joy.drop, ".joy.place_bomb" },
3723 { TYPE_KEY_X11, &sii.key.left, ".key.move_left" },
3724 { TYPE_KEY_X11, &sii.key.right, ".key.move_right" },
3725 { TYPE_KEY_X11, &sii.key.up, ".key.move_up" },
3726 { TYPE_KEY_X11, &sii.key.down, ".key.move_down" },
3727 { TYPE_KEY_X11, &sii.key.snap, ".key.snap_field" },
3728 { TYPE_KEY_X11, &sii.key.drop, ".key.place_bomb" }
3731 static struct TokenInfo system_setup_tokens[] =
3733 { TYPE_STRING, &syi.sdl_audiodriver, "system.sdl_audiodriver" },
3734 { TYPE_INTEGER, &syi.audio_fragment_size,"system.audio_fragment_size" }
3737 static struct TokenInfo options_setup_tokens[] =
3739 { TYPE_BOOLEAN, &soi.verbose, "options.verbose" }
3742 static char *get_corrected_login_name(char *login_name)
3744 /* needed because player name must be a fixed length string */
3745 char *login_name_new = checked_malloc(MAX_PLAYER_NAME_LEN + 1);
3747 strncpy(login_name_new, login_name, MAX_PLAYER_NAME_LEN);
3748 login_name_new[MAX_PLAYER_NAME_LEN] = '\0';
3750 if (strlen(login_name) > MAX_PLAYER_NAME_LEN) /* name has been cut */
3751 if (strchr(login_name_new, ' '))
3752 *strchr(login_name_new, ' ') = '\0';
3754 return login_name_new;
3757 static void setSetupInfoToDefaults(struct SetupInfo *si)
3761 si->player_name = get_corrected_login_name(getLoginName());
3764 si->sound_loops = TRUE;
3765 si->sound_music = TRUE;
3766 si->sound_simple = TRUE;
3768 si->double_buffering = TRUE;
3769 si->direct_draw = !si->double_buffering;
3770 si->scroll_delay = TRUE;
3771 si->soft_scrolling = TRUE;
3773 si->autorecord = TRUE;
3774 si->quick_doors = FALSE;
3775 si->team_mode = FALSE;
3776 si->handicap = TRUE;
3777 si->time_limit = TRUE;
3778 si->fullscreen = FALSE;
3779 si->ask_on_escape = TRUE;
3781 si->graphics_set = getStringCopy(GFX_CLASSIC_SUBDIR);
3782 si->sounds_set = getStringCopy(SND_CLASSIC_SUBDIR);
3783 si->music_set = getStringCopy(MUS_CLASSIC_SUBDIR);
3784 si->override_level_graphics = FALSE;
3785 si->override_level_sounds = FALSE;
3786 si->override_level_music = FALSE;
3788 si->editor.el_boulderdash = TRUE;
3789 si->editor.el_emerald_mine = TRUE;
3790 si->editor.el_more = TRUE;
3791 si->editor.el_sokoban = TRUE;
3792 si->editor.el_supaplex = TRUE;
3793 si->editor.el_diamond_caves = TRUE;
3794 si->editor.el_dx_boulderdash = TRUE;
3795 si->editor.el_chars = TRUE;
3796 si->editor.el_custom = TRUE;
3797 si->editor.el_custom_more = FALSE;
3799 si->editor.el_headlines = TRUE;
3800 si->editor.el_user_defined = FALSE;
3802 si->shortcut.save_game = DEFAULT_KEY_SAVE_GAME;
3803 si->shortcut.load_game = DEFAULT_KEY_LOAD_GAME;
3804 si->shortcut.toggle_pause = DEFAULT_KEY_TOGGLE_PAUSE;
3806 for (i = 0; i < MAX_PLAYERS; i++)
3808 si->input[i].use_joystick = FALSE;
3809 si->input[i].joy.device_name=getStringCopy(getDeviceNameFromJoystickNr(i));
3810 si->input[i].joy.xleft = JOYSTICK_XLEFT;
3811 si->input[i].joy.xmiddle = JOYSTICK_XMIDDLE;
3812 si->input[i].joy.xright = JOYSTICK_XRIGHT;
3813 si->input[i].joy.yupper = JOYSTICK_YUPPER;
3814 si->input[i].joy.ymiddle = JOYSTICK_YMIDDLE;
3815 si->input[i].joy.ylower = JOYSTICK_YLOWER;
3816 si->input[i].joy.snap = (i == 0 ? JOY_BUTTON_1 : 0);
3817 si->input[i].joy.drop = (i == 0 ? JOY_BUTTON_2 : 0);
3818 si->input[i].key.left = (i == 0 ? DEFAULT_KEY_LEFT : KSYM_UNDEFINED);
3819 si->input[i].key.right = (i == 0 ? DEFAULT_KEY_RIGHT : KSYM_UNDEFINED);
3820 si->input[i].key.up = (i == 0 ? DEFAULT_KEY_UP : KSYM_UNDEFINED);
3821 si->input[i].key.down = (i == 0 ? DEFAULT_KEY_DOWN : KSYM_UNDEFINED);
3822 si->input[i].key.snap = (i == 0 ? DEFAULT_KEY_SNAP : KSYM_UNDEFINED);
3823 si->input[i].key.drop = (i == 0 ? DEFAULT_KEY_DROP : KSYM_UNDEFINED);
3826 si->system.sdl_audiodriver = getStringCopy(ARG_DEFAULT);
3827 si->system.audio_fragment_size = DEFAULT_AUDIO_FRAGMENT_SIZE;
3829 si->options.verbose = FALSE;
3832 static void decodeSetupFileHash(SetupFileHash *setup_file_hash)
3836 if (!setup_file_hash)
3841 for (i = 0; i < NUM_GLOBAL_SETUP_TOKENS; i++)
3842 setSetupInfo(global_setup_tokens, i,
3843 getHashEntry(setup_file_hash, global_setup_tokens[i].text));
3848 for (i = 0; i < NUM_EDITOR_SETUP_TOKENS; i++)
3849 setSetupInfo(editor_setup_tokens, i,
3850 getHashEntry(setup_file_hash,editor_setup_tokens[i].text));
3853 /* shortcut setup */
3854 ssi = setup.shortcut;
3855 for (i = 0; i < NUM_SHORTCUT_SETUP_TOKENS; i++)
3856 setSetupInfo(shortcut_setup_tokens, i,
3857 getHashEntry(setup_file_hash,shortcut_setup_tokens[i].text));
3858 setup.shortcut = ssi;
3861 for (pnr = 0; pnr < MAX_PLAYERS; pnr++)
3865 sprintf(prefix, "%s%d", TOKEN_STR_PLAYER_PREFIX, pnr + 1);
3867 sii = setup.input[pnr];
3868 for (i = 0; i < NUM_PLAYER_SETUP_TOKENS; i++)
3870 char full_token[100];
3872 sprintf(full_token, "%s%s", prefix, player_setup_tokens[i].text);
3873 setSetupInfo(player_setup_tokens, i,
3874 getHashEntry(setup_file_hash, full_token));
3876 setup.input[pnr] = sii;
3881 for (i = 0; i < NUM_SYSTEM_SETUP_TOKENS; i++)
3882 setSetupInfo(system_setup_tokens, i,
3883 getHashEntry(setup_file_hash, system_setup_tokens[i].text));
3887 soi = setup.options;
3888 for (i = 0; i < NUM_OPTIONS_SETUP_TOKENS; i++)
3889 setSetupInfo(options_setup_tokens, i,
3890 getHashEntry(setup_file_hash, options_setup_tokens[i].text));
3891 setup.options = soi;
3896 char *filename = getSetupFilename();
3897 SetupFileHash *setup_file_hash = NULL;
3899 /* always start with reliable default values */
3900 setSetupInfoToDefaults(&setup);
3902 setup_file_hash = loadSetupFileHash(filename);
3904 if (setup_file_hash)
3906 char *player_name_new;
3908 checkSetupFileHashIdentifier(setup_file_hash, getCookie("SETUP"));
3909 decodeSetupFileHash(setup_file_hash);
3911 setup.direct_draw = !setup.double_buffering;
3913 freeSetupFileHash(setup_file_hash);
3915 /* needed to work around problems with fixed length strings */
3916 player_name_new = get_corrected_login_name(setup.player_name);
3917 free(setup.player_name);
3918 setup.player_name = player_name_new;
3921 Error(ERR_WARN, "using default setup values");
3926 char *filename = getSetupFilename();
3930 InitUserDataDirectory();
3932 if (!(file = fopen(filename, MODE_WRITE)))
3934 Error(ERR_WARN, "cannot write setup file '%s'", filename);
3938 fprintf(file, "%s\n", getFormattedSetupEntry(TOKEN_STR_FILE_IDENTIFIER,
3939 getCookie("SETUP")));
3940 fprintf(file, "\n");
3944 for (i = 0; i < NUM_GLOBAL_SETUP_TOKENS; i++)
3946 /* just to make things nicer :) */
3947 if (i == SETUP_TOKEN_PLAYER_NAME + 1 ||
3948 i == SETUP_TOKEN_GRAPHICS_SET)
3949 fprintf(file, "\n");
3951 fprintf(file, "%s\n", getSetupLine(global_setup_tokens, "", i));
3956 fprintf(file, "\n");
3957 for (i = 0; i < NUM_EDITOR_SETUP_TOKENS; i++)
3958 fprintf(file, "%s\n", getSetupLine(editor_setup_tokens, "", i));
3960 /* shortcut setup */
3961 ssi = setup.shortcut;
3962 fprintf(file, "\n");
3963 for (i = 0; i < NUM_SHORTCUT_SETUP_TOKENS; i++)
3964 fprintf(file, "%s\n", getSetupLine(shortcut_setup_tokens, "", i));
3967 for (pnr = 0; pnr < MAX_PLAYERS; pnr++)
3971 sprintf(prefix, "%s%d", TOKEN_STR_PLAYER_PREFIX, pnr + 1);
3972 fprintf(file, "\n");
3974 sii = setup.input[pnr];
3975 for (i = 0; i < NUM_PLAYER_SETUP_TOKENS; i++)
3976 fprintf(file, "%s\n", getSetupLine(player_setup_tokens, prefix, i));
3981 fprintf(file, "\n");
3982 for (i = 0; i < NUM_SYSTEM_SETUP_TOKENS; i++)
3983 fprintf(file, "%s\n", getSetupLine(system_setup_tokens, "", i));
3986 soi = setup.options;
3987 fprintf(file, "\n");
3988 for (i = 0; i < NUM_OPTIONS_SETUP_TOKENS; i++)
3989 fprintf(file, "%s\n", getSetupLine(options_setup_tokens, "", i));
3993 SetFilePermissions(filename, PERMS_PRIVATE);
3996 void LoadCustomElementDescriptions()
3998 char *filename = getCustomArtworkConfigFilename(ARTWORK_TYPE_GRAPHICS);
3999 SetupFileHash *setup_file_hash;
4002 for (i = 0; i < NUM_FILE_ELEMENTS; i++)
4004 if (element_info[i].custom_description != NULL)
4006 free(element_info[i].custom_description);
4007 element_info[i].custom_description = NULL;
4011 if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
4014 for (i = 0; i < NUM_FILE_ELEMENTS; i++)
4016 char *token = getStringCat2(element_info[i].token_name, ".name");
4017 char *value = getHashEntry(setup_file_hash, token);
4020 element_info[i].custom_description = getStringCopy(value);
4025 freeSetupFileHash(setup_file_hash);
4028 void LoadSpecialMenuDesignSettings()
4030 char *filename = getCustomArtworkConfigFilename(ARTWORK_TYPE_GRAPHICS);
4031 SetupFileHash *setup_file_hash;
4034 /* always start with reliable default values from default config */
4035 for (i = 0; image_config_vars[i].token != NULL; i++)
4036 for (j = 0; image_config[j].token != NULL; j++)
4037 if (strcmp(image_config_vars[i].token, image_config[j].token) == 0)
4038 *image_config_vars[i].value =
4039 get_auto_parameter_value(image_config_vars[i].token,
4040 image_config[j].value);
4042 if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
4045 /* special case: initialize with default values that may be overwritten */
4046 for (i = 0; i < NUM_SPECIAL_GFX_ARGS; i++)
4048 char *value_x = getHashEntry(setup_file_hash, "menu.draw_xoffset");
4049 char *value_y = getHashEntry(setup_file_hash, "menu.draw_yoffset");
4050 char *list_size = getHashEntry(setup_file_hash, "menu.list_size");
4052 if (value_x != NULL)
4053 menu.draw_xoffset[i] = get_integer_from_string(value_x);
4054 if (value_y != NULL)
4055 menu.draw_yoffset[i] = get_integer_from_string(value_y);
4056 if (list_size != NULL)
4057 menu.list_size[i] = get_integer_from_string(list_size);
4060 /* read (and overwrite with) values that may be specified in config file */
4061 for (i = 0; image_config_vars[i].token != NULL; i++)
4063 char *value = getHashEntry(setup_file_hash, image_config_vars[i].token);
4066 *image_config_vars[i].value =
4067 get_auto_parameter_value(image_config_vars[i].token, value);
4070 freeSetupFileHash(setup_file_hash);
4073 void LoadUserDefinedEditorElementList(int **elements, int *num_elements)
4075 char *filename = getEditorSetupFilename();
4076 SetupFileList *setup_file_list, *list;
4077 SetupFileHash *element_hash;
4078 int num_unknown_tokens = 0;
4081 if ((setup_file_list = loadSetupFileList(filename)) == NULL)
4084 element_hash = newSetupFileHash();
4086 for (i = 0; i < NUM_FILE_ELEMENTS; i++)
4087 setHashEntry(element_hash, element_info[i].token_name, i_to_a(i));
4089 /* determined size may be larger than needed (due to unknown elements) */
4091 for (list = setup_file_list; list != NULL; list = list->next)
4094 /* add space for up to 3 more elements for padding that may be needed */
4097 *elements = checked_malloc(*num_elements * sizeof(int));
4100 for (list = setup_file_list; list != NULL; list = list->next)
4102 char *value = getHashEntry(element_hash, list->token);
4106 (*elements)[(*num_elements)++] = atoi(value);
4110 if (num_unknown_tokens == 0)
4112 Error(ERR_RETURN_LINE, "-");
4113 Error(ERR_RETURN, "warning: unknown token(s) found in config file:");
4114 Error(ERR_RETURN, "- config file: '%s'", filename);
4116 num_unknown_tokens++;
4119 Error(ERR_RETURN, "- token: '%s'", list->token);
4123 if (num_unknown_tokens > 0)
4124 Error(ERR_RETURN_LINE, "-");
4126 while (*num_elements % 4) /* pad with empty elements, if needed */
4127 (*elements)[(*num_elements)++] = EL_EMPTY;
4129 freeSetupFileList(setup_file_list);
4130 freeSetupFileHash(element_hash);
4134 for (i = 0; i < *num_elements; i++)
4135 printf("editor: element '%s' [%d]\n",
4136 element_info[(*elements)[i]].token_name, (*elements)[i]);
4140 static struct MusicFileInfo *get_music_file_info_ext(char *basename, int music,
4143 SetupFileHash *setup_file_hash = NULL;
4144 struct MusicFileInfo tmp_music_file_info, *new_music_file_info;
4145 char *filename_music, *filename_prefix, *filename_info;
4151 token_to_value_ptr[] =
4153 { "title_header", &tmp_music_file_info.title_header },
4154 { "artist_header", &tmp_music_file_info.artist_header },
4155 { "album_header", &tmp_music_file_info.album_header },
4156 { "year_header", &tmp_music_file_info.year_header },
4158 { "title", &tmp_music_file_info.title },
4159 { "artist", &tmp_music_file_info.artist },
4160 { "album", &tmp_music_file_info.album },
4161 { "year", &tmp_music_file_info.year },
4167 filename_music = (is_sound ? getCustomSoundFilename(basename) :
4168 getCustomMusicFilename(basename));
4170 if (filename_music == NULL)
4173 /* ---------- try to replace file extension ---------- */
4175 filename_prefix = getStringCopy(filename_music);
4176 if (strrchr(filename_prefix, '.') != NULL)
4177 *strrchr(filename_prefix, '.') = '\0';
4178 filename_info = getStringCat2(filename_prefix, ".txt");
4181 printf("trying to load file '%s'...\n", filename_info);
4184 if (fileExists(filename_info))
4185 setup_file_hash = loadSetupFileHash(filename_info);
4187 free(filename_prefix);
4188 free(filename_info);
4190 if (setup_file_hash == NULL)
4192 /* ---------- try to add file extension ---------- */
4194 filename_prefix = getStringCopy(filename_music);
4195 filename_info = getStringCat2(filename_prefix, ".txt");
4198 printf("trying to load file '%s'...\n", filename_info);
4201 if (fileExists(filename_info))
4202 setup_file_hash = loadSetupFileHash(filename_info);
4204 free(filename_prefix);
4205 free(filename_info);
4208 if (setup_file_hash == NULL)
4211 /* ---------- music file info found ---------- */
4213 memset(&tmp_music_file_info, 0, sizeof(struct MusicFileInfo));
4215 for (i = 0; token_to_value_ptr[i].token != NULL; i++)
4217 char *value = getHashEntry(setup_file_hash, token_to_value_ptr[i].token);
4219 *token_to_value_ptr[i].value_ptr =
4220 getStringCopy(value != NULL && *value != '\0' ? value : UNKNOWN_NAME);
4223 tmp_music_file_info.basename = getStringCopy(basename);
4224 tmp_music_file_info.music = music;
4225 tmp_music_file_info.is_sound = is_sound;
4227 new_music_file_info = checked_malloc(sizeof(struct MusicFileInfo));
4228 *new_music_file_info = tmp_music_file_info;
4230 return new_music_file_info;
4233 static struct MusicFileInfo *get_music_file_info(char *basename, int music)
4235 return get_music_file_info_ext(basename, music, FALSE);
4238 static struct MusicFileInfo *get_sound_file_info(char *basename, int sound)
4240 return get_music_file_info_ext(basename, sound, TRUE);
4243 static boolean music_info_listed_ext(struct MusicFileInfo *list,
4244 char *basename, boolean is_sound)
4246 for (; list != NULL; list = list->next)
4247 if (list->is_sound == is_sound && strcmp(list->basename, basename) == 0)
4253 static boolean music_info_listed(struct MusicFileInfo *list, char *basename)
4255 return music_info_listed_ext(list, basename, FALSE);
4258 static boolean sound_info_listed(struct MusicFileInfo *list, char *basename)
4260 return music_info_listed_ext(list, basename, TRUE);
4263 void LoadMusicInfo()
4265 char *music_directory = getCustomMusicDirectory();
4266 int num_music = getMusicListSize();
4267 int num_music_noconf = 0;
4268 int num_sounds = getSoundListSize();
4270 struct dirent *dir_entry;
4271 struct FileInfo *music, *sound;
4272 struct MusicFileInfo *next, **new;
4275 while (music_file_info != NULL)
4277 next = music_file_info->next;
4279 checked_free(music_file_info->basename);
4281 checked_free(music_file_info->title_header);
4282 checked_free(music_file_info->artist_header);
4283 checked_free(music_file_info->album_header);
4284 checked_free(music_file_info->year_header);
4286 checked_free(music_file_info->title);
4287 checked_free(music_file_info->artist);
4288 checked_free(music_file_info->album);
4289 checked_free(music_file_info->year);
4291 free(music_file_info);
4293 music_file_info = next;
4296 new = &music_file_info;
4299 printf("::: num_music == %d\n", num_music);
4302 for (i = 0; i < num_music; i++)
4304 music = getMusicListEntry(i);
4307 printf("::: %d [%08x]\n", i, music->filename);
4310 if (music->filename == NULL)
4313 if (strcmp(music->filename, UNDEFINED_FILENAME) == 0)
4316 /* a configured file may be not recognized as music */
4317 if (!FileIsMusic(music->filename))
4321 printf("::: -> '%s' (configured)\n", music->filename);
4324 if (!music_info_listed(music_file_info, music->filename))
4326 *new = get_music_file_info(music->filename, i);
4328 new = &(*new)->next;
4332 if ((dir = opendir(music_directory)) == NULL)
4334 Error(ERR_WARN, "cannot read music directory '%s'", music_directory);
4338 while ((dir_entry = readdir(dir)) != NULL) /* loop until last dir entry */
4340 char *basename = dir_entry->d_name;
4341 boolean music_already_used = FALSE;
4344 /* skip all music files that are configured in music config file */
4345 for (i = 0; i < num_music; i++)
4347 music = getMusicListEntry(i);
4349 if (music->filename == NULL)
4352 if (strcmp(basename, music->filename) == 0)
4354 music_already_used = TRUE;
4359 if (music_already_used)
4362 if (!FileIsMusic(basename))
4366 printf("::: -> '%s' (found in directory)\n", basename);
4369 if (!music_info_listed(music_file_info, basename))
4371 *new = get_music_file_info(basename, MAP_NOCONF_MUSIC(num_music_noconf));
4373 new = &(*new)->next;
4381 for (i = 0; i < num_sounds; i++)
4383 sound = getSoundListEntry(i);
4385 if (sound->filename == NULL)
4388 if (strcmp(sound->filename, UNDEFINED_FILENAME) == 0)
4391 /* a configured file may be not recognized as sound */
4392 if (!FileIsSound(sound->filename))
4396 printf("::: -> '%s' (configured)\n", sound->filename);
4399 if (!sound_info_listed(music_file_info, sound->filename))
4401 *new = get_sound_file_info(sound->filename, i);
4403 new = &(*new)->next;
4409 for (next = music_file_info; next != NULL; next = next->next)
4410 printf("::: title == '%s'\n", next->title);
4414 void add_helpanim_entry(int element, int action, int direction, int delay,
4415 int *num_list_entries)
4417 struct HelpAnimInfo *new_list_entry;
4418 (*num_list_entries)++;
4421 checked_realloc(helpanim_info,
4422 *num_list_entries * sizeof(struct HelpAnimInfo));
4423 new_list_entry = &helpanim_info[*num_list_entries - 1];
4425 new_list_entry->element = element;
4426 new_list_entry->action = action;
4427 new_list_entry->direction = direction;
4428 new_list_entry->delay = delay;
4431 void print_unknown_token(char *filename, char *token, int token_nr)
4435 Error(ERR_RETURN_LINE, "-");
4436 Error(ERR_RETURN, "warning: unknown token(s) found in config file:");
4437 Error(ERR_RETURN, "- config file: '%s'", filename);
4440 Error(ERR_RETURN, "- token: '%s'", token);
4443 void print_unknown_token_end(int token_nr)
4446 Error(ERR_RETURN_LINE, "-");
4449 void LoadHelpAnimInfo()
4451 char *filename = getHelpAnimFilename();
4452 SetupFileList *setup_file_list = NULL, *list;
4453 SetupFileHash *element_hash, *action_hash, *direction_hash;
4454 int num_list_entries = 0;
4455 int num_unknown_tokens = 0;
4458 if (fileExists(filename))
4459 setup_file_list = loadSetupFileList(filename);
4461 if (setup_file_list == NULL)
4463 /* use reliable default values from static configuration */
4464 SetupFileList *insert_ptr;
4466 insert_ptr = setup_file_list =
4467 newSetupFileList(helpanim_config[0].token,
4468 helpanim_config[0].value);
4470 for (i = 1; helpanim_config[i].token; i++)
4471 insert_ptr = addListEntry(insert_ptr,
4472 helpanim_config[i].token,
4473 helpanim_config[i].value);
4476 element_hash = newSetupFileHash();
4477 action_hash = newSetupFileHash();
4478 direction_hash = newSetupFileHash();
4480 for (i = 0; i < MAX_NUM_ELEMENTS; i++)
4481 setHashEntry(element_hash, element_info[i].token_name, i_to_a(i));
4483 for (i = 0; i < NUM_ACTIONS; i++)
4484 setHashEntry(action_hash, element_action_info[i].suffix,
4485 i_to_a(element_action_info[i].value));
4487 /* do not store direction index (bit) here, but direction value! */
4488 for (i = 0; i < NUM_DIRECTIONS; i++)
4489 setHashEntry(direction_hash, element_direction_info[i].suffix,
4490 i_to_a(1 << element_direction_info[i].value));
4492 for (list = setup_file_list; list != NULL; list = list->next)
4494 char *element_token, *action_token, *direction_token;
4495 char *element_value, *action_value, *direction_value;
4496 int delay = atoi(list->value);
4498 if (strcmp(list->token, "end") == 0)
4500 add_helpanim_entry(HELPANIM_LIST_NEXT, -1, -1, -1, &num_list_entries);
4505 /* first try to break element into element/action/direction parts;
4506 if this does not work, also accept combined "element[.act][.dir]"
4507 elements (like "dynamite.active"), which are unique elements */
4509 if (strchr(list->token, '.') == NULL) /* token contains no '.' */
4511 element_value = getHashEntry(element_hash, list->token);
4512 if (element_value != NULL) /* element found */
4513 add_helpanim_entry(atoi(element_value), -1, -1, delay,
4517 /* no further suffixes found -- this is not an element */
4518 print_unknown_token(filename, list->token, num_unknown_tokens++);
4524 /* token has format "<prefix>.<something>" */
4526 action_token = strchr(list->token, '.'); /* suffix may be action ... */
4527 direction_token = action_token; /* ... or direction */
4529 element_token = getStringCopy(list->token);
4530 *strchr(element_token, '.') = '\0';
4532 element_value = getHashEntry(element_hash, element_token);
4534 if (element_value == NULL) /* this is no element */
4536 element_value = getHashEntry(element_hash, list->token);
4537 if (element_value != NULL) /* combined element found */
4538 add_helpanim_entry(atoi(element_value), -1, -1, delay,
4541 print_unknown_token(filename, list->token, num_unknown_tokens++);
4543 free(element_token);
4548 action_value = getHashEntry(action_hash, action_token);
4550 if (action_value != NULL) /* action found */
4552 add_helpanim_entry(atoi(element_value), atoi(action_value), -1, delay,
4555 free(element_token);
4560 direction_value = getHashEntry(direction_hash, direction_token);
4562 if (direction_value != NULL) /* direction found */
4564 add_helpanim_entry(atoi(element_value), -1, atoi(direction_value), delay,
4567 free(element_token);
4572 if (strchr(action_token + 1, '.') == NULL)
4574 /* no further suffixes found -- this is not an action nor direction */
4576 element_value = getHashEntry(element_hash, list->token);
4577 if (element_value != NULL) /* combined element found */
4578 add_helpanim_entry(atoi(element_value), -1, -1, delay,
4581 print_unknown_token(filename, list->token, num_unknown_tokens++);
4583 free(element_token);
4588 /* token has format "<prefix>.<suffix>.<something>" */
4590 direction_token = strchr(action_token + 1, '.');
4592 action_token = getStringCopy(action_token);
4593 *strchr(action_token + 1, '.') = '\0';
4595 action_value = getHashEntry(action_hash, action_token);
4597 if (action_value == NULL) /* this is no action */
4599 element_value = getHashEntry(element_hash, list->token);
4600 if (element_value != NULL) /* combined element found */
4601 add_helpanim_entry(atoi(element_value), -1, -1, delay,
4604 print_unknown_token(filename, list->token, num_unknown_tokens++);
4606 free(element_token);
4612 direction_value = getHashEntry(direction_hash, direction_token);
4614 if (direction_value != NULL) /* direction found */
4616 add_helpanim_entry(atoi(element_value), atoi(action_value),
4617 atoi(direction_value), delay, &num_list_entries);
4619 free(element_token);
4625 /* this is no direction */
4627 element_value = getHashEntry(element_hash, list->token);
4628 if (element_value != NULL) /* combined element found */
4629 add_helpanim_entry(atoi(element_value), -1, -1, delay,
4632 print_unknown_token(filename, list->token, num_unknown_tokens++);
4634 free(element_token);
4638 print_unknown_token_end(num_unknown_tokens);
4640 add_helpanim_entry(HELPANIM_LIST_NEXT, -1, -1, -1, &num_list_entries);
4641 add_helpanim_entry(HELPANIM_LIST_END, -1, -1, -1, &num_list_entries);
4643 freeSetupFileList(setup_file_list);
4644 freeSetupFileHash(element_hash);
4645 freeSetupFileHash(action_hash);
4646 freeSetupFileHash(direction_hash);
4650 for (i = 0; i < num_list_entries; i++)
4651 printf("::: %d, %d, %d => %d\n",
4652 helpanim_info[i].element,
4653 helpanim_info[i].action,
4654 helpanim_info[i].direction,
4655 helpanim_info[i].delay);
4659 void LoadHelpTextInfo()
4661 char *filename = getHelpTextFilename();
4664 if (helptext_info != NULL)
4666 freeSetupFileHash(helptext_info);
4667 helptext_info = NULL;
4670 if (fileExists(filename))
4671 helptext_info = loadSetupFileHash(filename);
4673 if (helptext_info == NULL)
4675 /* use reliable default values from static configuration */
4676 helptext_info = newSetupFileHash();
4678 for (i = 0; helptext_config[i].token; i++)
4679 setHashEntry(helptext_info,
4680 helptext_config[i].token,
4681 helptext_config[i].value);
4686 BEGIN_HASH_ITERATION(helptext_info, itr)
4688 printf("::: '%s' => '%s'\n",
4689 HASH_ITERATION_TOKEN(itr), HASH_ITERATION_VALUE(itr));
4691 END_HASH_ITERATION(hash, itr)