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 11 /* 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;
95 change->sides = CH_SIDE_ANY;
97 change->target_element = EL_EMPTY_SPACE;
99 change->delay_fixed = 0;
100 change->delay_random = 0;
101 change->delay_frames = 1;
103 change->trigger_element = EL_EMPTY_SPACE;
105 change->explode = FALSE;
106 change->use_content = FALSE;
107 change->only_complete = FALSE;
108 change->use_random_change = FALSE;
109 change->random = 100;
110 change->power = CP_NON_DESTRUCTIVE;
112 for (x = 0; x < 3; x++)
113 for (y = 0; y < 3; y++)
114 change->content[x][y] = EL_EMPTY_SPACE;
116 change->direct_action = 0;
117 change->other_action = 0;
119 change->pre_change_function = NULL;
120 change->change_function = NULL;
121 change->post_change_function = NULL;
124 static void setLevelInfoToDefaults(struct LevelInfo *level)
128 level->file_version = FILE_VERSION_ACTUAL;
129 level->game_version = GAME_VERSION_ACTUAL;
131 level->encoding_16bit_field = FALSE; /* default: only 8-bit elements */
132 level->encoding_16bit_yamyam = FALSE; /* default: only 8-bit elements */
133 level->encoding_16bit_amoeba = FALSE; /* default: only 8-bit elements */
135 level->fieldx = STD_LEV_FIELDX;
136 level->fieldy = STD_LEV_FIELDY;
138 for (x = 0; x < MAX_LEV_FIELDX; x++)
139 for (y = 0; y < MAX_LEV_FIELDY; y++)
140 level->field[x][y] = EL_SAND;
143 level->gems_needed = 0;
144 level->amoeba_speed = 10;
145 level->time_magic_wall = 10;
146 level->time_wheel = 10;
147 level->time_light = 10;
148 level->time_timegate = 10;
149 level->amoeba_content = EL_DIAMOND;
150 level->double_speed = FALSE;
151 level->initial_gravity = FALSE;
152 level->em_slippery_gems = FALSE;
153 level->block_last_field = FALSE;
154 level->sp_block_last_field = TRUE;
156 level->use_custom_template = FALSE;
158 for (i = 0; i < MAX_LEVEL_NAME_LEN; i++)
159 level->name[i] = '\0';
160 for (i = 0; i < MAX_LEVEL_AUTHOR_LEN; i++)
161 level->author[i] = '\0';
163 strcpy(level->name, NAMELESS_LEVEL_NAME);
164 strcpy(level->author, ANONYMOUS_NAME);
166 for (i = 0; i < 4; i++)
168 level->envelope_text[i][0] = '\0';
169 level->envelope_xsize[i] = MAX_ENVELOPE_XSIZE;
170 level->envelope_ysize[i] = MAX_ENVELOPE_YSIZE;
173 for (i = 0; i < LEVEL_SCORE_ELEMENTS; i++)
174 level->score[i] = 10;
176 level->num_yamyam_contents = STD_ELEMENT_CONTENTS;
177 for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
178 for (x = 0; x < 3; x++)
179 for (y = 0; y < 3; y++)
180 level->yamyam_content[i][x][y] =
181 (i < STD_ELEMENT_CONTENTS ? EL_ROCK : EL_EMPTY);
183 level->field[0][0] = EL_PLAYER_1;
184 level->field[STD_LEV_FIELDX - 1][STD_LEV_FIELDY - 1] = EL_EXIT_CLOSED;
186 for (i = 0; i < MAX_NUM_ELEMENTS; i++)
190 setElementChangePages(&element_info[element], 1);
191 setElementChangeInfoToDefaults(element_info[element].change);
193 if (IS_CUSTOM_ELEMENT(element) || IS_GROUP_ELEMENT(element))
195 for (j = 0; j < MAX_ELEMENT_NAME_LEN + 1; j++)
196 element_info[element].description[j] = '\0';
198 if (element_info[element].custom_description != NULL)
199 strncpy(element_info[element].description,
200 element_info[element].custom_description,MAX_ELEMENT_NAME_LEN);
202 strcpy(element_info[element].description,
203 element_info[element].editor_description);
205 element_info[element].use_gfx_element = FALSE;
206 element_info[element].gfx_element = EL_EMPTY_SPACE;
209 if (IS_CUSTOM_ELEMENT(element))
211 element_info[element].access_direction = MV_ALL_DIRECTIONS;
213 element_info[element].collect_score = 10; /* special default */
214 element_info[element].collect_count = 1; /* special default */
216 element_info[element].push_delay_fixed = -1; /* initialize later */
217 element_info[element].push_delay_random = -1; /* initialize later */
218 element_info[element].move_delay_fixed = 0;
219 element_info[element].move_delay_random = 0;
221 element_info[element].move_pattern = MV_ALL_DIRECTIONS;
222 element_info[element].move_direction_initial = MV_START_AUTOMATIC;
223 element_info[element].move_stepsize = TILEX / 8;
224 element_info[element].move_enter_element = EL_EMPTY_SPACE;
225 element_info[element].move_leave_element = EL_EMPTY_SPACE;
226 element_info[element].move_leave_type = LEAVE_TYPE_UNLIMITED;
228 element_info[element].slippery_type = SLIPPERY_ANY_RANDOM;
230 element_info[element].explosion_delay = 18;
231 element_info[element].ignition_delay = 8;
233 for (x = 0; x < 3; x++)
234 for (y = 0; y < 3; y++)
235 element_info[element].content[x][y] = EL_EMPTY_SPACE;
237 element_info[element].access_type = 0;
238 element_info[element].access_layer = 0;
239 element_info[element].access_protected = 0;
240 element_info[element].walk_to_action = 0;
241 element_info[element].smash_targets = 0;
242 element_info[element].deadliness = 0;
243 element_info[element].consistency = 0;
245 element_info[element].can_explode_by_fire = FALSE;
246 element_info[element].can_explode_smashed = FALSE;
247 element_info[element].can_explode_impact = FALSE;
249 element_info[element].current_change_page = 0;
251 /* start with no properties at all */
252 for (j = 0; j < NUM_EP_BITFIELDS; j++)
253 Properties[element][j] = EP_BITMASK_DEFAULT;
255 element_info[element].modified_settings = FALSE;
257 else if (IS_GROUP_ELEMENT(element) || element == EL_INTERNAL_EDITOR)
259 /* initialize memory for list of elements in group */
260 if (element_info[element].group == NULL)
261 element_info[element].group =
262 checked_malloc(sizeof(struct ElementGroupInfo));
264 for (j = 0; j < MAX_ELEMENTS_IN_GROUP; j++)
265 element_info[element].group->element[j] = EL_EMPTY_SPACE;
267 /* default: only one element in group */
268 element_info[element].group->num_elements = 1;
270 element_info[element].group->choice_mode = ANIM_RANDOM;
274 BorderElement = EL_STEELWALL;
276 level->no_level_file = FALSE;
278 if (leveldir_current == NULL) /* only when dumping level */
281 /* try to determine better author name than 'anonymous' */
282 if (strcmp(leveldir_current->author, ANONYMOUS_NAME) != 0)
284 strncpy(level->author, leveldir_current->author, MAX_LEVEL_AUTHOR_LEN);
285 level->author[MAX_LEVEL_AUTHOR_LEN] = '\0';
289 switch (LEVELCLASS(leveldir_current))
291 case LEVELCLASS_TUTORIAL:
292 strcpy(level->author, PROGRAM_AUTHOR_STRING);
295 case LEVELCLASS_CONTRIB:
296 strncpy(level->author, leveldir_current->name, MAX_LEVEL_AUTHOR_LEN);
297 level->author[MAX_LEVEL_AUTHOR_LEN] = '\0';
300 case LEVELCLASS_PRIVATE:
301 strncpy(level->author, getRealName(), MAX_LEVEL_AUTHOR_LEN);
302 level->author[MAX_LEVEL_AUTHOR_LEN] = '\0';
306 /* keep default value */
312 static void setFileInfoToDefaults(struct LevelFileInfo *level_file_info)
314 level_file_info->nr = 0;
315 level_file_info->type = LEVEL_FILE_TYPE_UNKNOWN;
316 level_file_info->packed = FALSE;
317 level_file_info->basename = NULL;
318 level_file_info->filename = NULL;
321 static void ActivateLevelTemplate()
323 /* Currently there is no special action needed to activate the template
324 data, because 'element_info' and 'Properties' overwrite the original
325 level data, while all other variables do not change. */
328 static char *getLevelFilenameFromBasename(char *basename)
330 static char *filename = NULL;
332 checked_free(filename);
334 filename = getPath2(getCurrentLevelDir(), basename);
339 static int getFileTypeFromBasename(char *basename)
341 static char *filename = NULL;
342 struct stat file_status;
344 /* ---------- try to determine file type from filename ---------- */
346 /* check for typical filename of a Supaplex level package file */
347 if (strlen(basename) == 10 && (strncmp(basename, "levels.d", 8) == 0 ||
348 strncmp(basename, "LEVELS.D", 8) == 0))
349 return LEVEL_FILE_TYPE_SP;
351 /* ---------- try to determine file type from filesize ---------- */
353 checked_free(filename);
354 filename = getPath2(getCurrentLevelDir(), basename);
356 if (stat(filename, &file_status) == 0)
358 /* check for typical filesize of a Supaplex level package file */
359 if (file_status.st_size == 170496)
360 return LEVEL_FILE_TYPE_SP;
363 return LEVEL_FILE_TYPE_UNKNOWN;
366 static char *getSingleLevelBasename(int nr, int type)
368 static char basename[MAX_FILENAME_LEN];
369 char *level_filename = getStringCopy(leveldir_current->level_filename);
371 if (level_filename == NULL)
372 level_filename = getStringCat2("%03d.", LEVELFILE_EXTENSION);
376 case LEVEL_FILE_TYPE_RND:
378 sprintf(basename, "template.%s", LEVELFILE_EXTENSION);
380 sprintf(basename, "%03d.%s", nr, LEVELFILE_EXTENSION);
383 case LEVEL_FILE_TYPE_EM:
384 sprintf(basename, "%d", nr);
387 case LEVEL_FILE_TYPE_UNKNOWN:
389 sprintf(basename, level_filename, nr);
393 free(level_filename);
398 static char *getPackedLevelBasename(int type)
400 static char basename[MAX_FILENAME_LEN];
401 char *directory = getCurrentLevelDir();
403 struct dirent *dir_entry;
405 strcpy(basename, UNDEFINED_FILENAME); /* default: undefined file */
407 if ((dir = opendir(directory)) == NULL)
409 Error(ERR_WARN, "cannot read current level directory '%s'", directory);
414 while ((dir_entry = readdir(dir)) != NULL) /* loop until last dir entry */
416 char *entry_basename = dir_entry->d_name;
417 int entry_type = getFileTypeFromBasename(entry_basename);
419 if (entry_type != LEVEL_FILE_TYPE_UNKNOWN) /* found valid level package */
421 if (type == LEVEL_FILE_TYPE_UNKNOWN ||
424 strcpy(basename, entry_basename);
436 static char *getSingleLevelFilename(int nr, int type)
438 return getLevelFilenameFromBasename(getSingleLevelBasename(nr, type));
442 static char *getPackedLevelFilename(int type)
444 return getLevelFilenameFromBasename(getPackedLevelBasename(type));
448 char *getDefaultLevelFilename(int nr)
450 return getSingleLevelFilename(nr, LEVEL_FILE_TYPE_RND);
453 static void setLevelFileInfo_SingleLevelFilename(struct LevelFileInfo *lfi,
458 lfi->basename = getSingleLevelBasename(lfi->nr, lfi->type);
459 lfi->filename = getLevelFilenameFromBasename(lfi->basename);
462 static void setLevelFileInfo_PackedLevelFilename(struct LevelFileInfo *lfi,
467 lfi->basename = getPackedLevelBasename(lfi->type);
468 lfi->filename = getLevelFilenameFromBasename(lfi->basename);
471 static void determineLevelFileInfo_Filename(struct LevelFileInfo *lfi)
473 /* special case: level number is negative => check for level template file */
476 setLevelFileInfo_SingleLevelFilename(lfi, LEVEL_FILE_TYPE_RND);
481 if (leveldir_current->level_filename != NULL)
483 /* check for file name/pattern specified in "levelinfo.conf" */
484 setLevelFileInfo_SingleLevelFilename(lfi, LEVEL_FILE_TYPE_UNKNOWN);
485 if (fileExists(lfi->filename))
489 /* check for native Rocks'n'Diamonds level file */
490 setLevelFileInfo_SingleLevelFilename(lfi, LEVEL_FILE_TYPE_RND);
491 if (fileExists(lfi->filename))
494 /* check for classic Emerald Mine level file */
495 setLevelFileInfo_SingleLevelFilename(lfi, LEVEL_FILE_TYPE_EM);
496 if (fileExists(lfi->filename))
499 /* check for various packed level file formats */
500 setLevelFileInfo_PackedLevelFilename(lfi, LEVEL_FILE_TYPE_UNKNOWN);
501 if (fileExists(lfi->filename))
504 /* no known level file found -- try to use default values */
505 setLevelFileInfo_SingleLevelFilename(lfi, LEVEL_FILE_TYPE_UNKNOWN);
508 static void determineLevelFileInfo_Filetype(struct LevelFileInfo *lfi)
510 if (lfi->type == LEVEL_FILE_TYPE_UNKNOWN)
511 lfi->type = getFileTypeFromBasename(lfi->basename);
514 static struct LevelFileInfo *getLevelFileInfo(int nr)
516 static struct LevelFileInfo level_file_info;
518 /* always start with reliable default values */
519 setFileInfoToDefaults(&level_file_info);
521 level_file_info.nr = nr; /* set requested level number */
523 determineLevelFileInfo_Filename(&level_file_info);
524 determineLevelFileInfo_Filetype(&level_file_info);
526 return &level_file_info;
530 /* ------------------------------------------------------------------------- */
531 /* functions for loading R'n'D level */
532 /* ------------------------------------------------------------------------- */
534 int getMappedElement(int element)
536 /* map some (historic, now obsolete) elements */
541 case EL_PLAYER_OBSOLETE:
542 element = EL_PLAYER_1;
545 case EL_KEY_OBSOLETE:
548 case EL_EM_KEY_1_FILE_OBSOLETE:
549 element = EL_EM_KEY_1;
552 case EL_EM_KEY_2_FILE_OBSOLETE:
553 element = EL_EM_KEY_2;
556 case EL_EM_KEY_3_FILE_OBSOLETE:
557 element = EL_EM_KEY_3;
560 case EL_EM_KEY_4_FILE_OBSOLETE:
561 element = EL_EM_KEY_4;
564 case EL_ENVELOPE_OBSOLETE:
565 element = EL_ENVELOPE_1;
573 if (element >= NUM_FILE_ELEMENTS)
575 Error(ERR_WARN, "invalid level element %d", element);
577 element = EL_UNKNOWN;
582 if (element >= NUM_FILE_ELEMENTS)
584 Error(ERR_WARN, "invalid level element %d", element);
586 element = EL_UNKNOWN;
588 else if (element == EL_PLAYER_OBSOLETE)
589 element = EL_PLAYER_1;
590 else if (element == EL_KEY_OBSOLETE)
597 static int LoadLevel_VERS(FILE *file, int chunk_size, struct LevelInfo *level)
599 level->file_version = getFileVersion(file);
600 level->game_version = getFileVersion(file);
605 static int LoadLevel_HEAD(FILE *file, int chunk_size, struct LevelInfo *level)
609 level->fieldx = getFile8Bit(file);
610 level->fieldy = getFile8Bit(file);
612 level->time = getFile16BitBE(file);
613 level->gems_needed = getFile16BitBE(file);
615 for (i = 0; i < MAX_LEVEL_NAME_LEN; i++)
616 level->name[i] = getFile8Bit(file);
617 level->name[MAX_LEVEL_NAME_LEN] = 0;
619 for (i = 0; i < LEVEL_SCORE_ELEMENTS; i++)
620 level->score[i] = getFile8Bit(file);
622 level->num_yamyam_contents = STD_ELEMENT_CONTENTS;
623 for (i = 0; i < STD_ELEMENT_CONTENTS; i++)
624 for (y = 0; y < 3; y++)
625 for (x = 0; x < 3; x++)
626 level->yamyam_content[i][x][y] = getMappedElement(getFile8Bit(file));
628 level->amoeba_speed = getFile8Bit(file);
629 level->time_magic_wall = getFile8Bit(file);
630 level->time_wheel = getFile8Bit(file);
631 level->amoeba_content = getMappedElement(getFile8Bit(file));
632 level->double_speed = (getFile8Bit(file) == 1 ? TRUE : FALSE);
633 level->initial_gravity = (getFile8Bit(file) == 1 ? TRUE : FALSE);
634 level->encoding_16bit_field = (getFile8Bit(file) == 1 ? TRUE : FALSE);
635 level->em_slippery_gems = (getFile8Bit(file) == 1 ? TRUE : FALSE);
637 level->use_custom_template = (getFile8Bit(file) == 1 ? TRUE : FALSE);
639 level->block_last_field = (getFile8Bit(file) == 1 ? TRUE : FALSE);
640 level->sp_block_last_field = (getFile8Bit(file) == 1 ? TRUE : FALSE);
642 ReadUnusedBytesFromFile(file, LEVEL_HEADER_UNUSED);
647 static int LoadLevel_AUTH(FILE *file, int chunk_size, struct LevelInfo *level)
651 for (i = 0; i < MAX_LEVEL_AUTHOR_LEN; i++)
652 level->author[i] = getFile8Bit(file);
653 level->author[MAX_LEVEL_NAME_LEN] = 0;
658 static int LoadLevel_BODY(FILE *file, int chunk_size, struct LevelInfo *level)
661 int chunk_size_expected = level->fieldx * level->fieldy;
663 /* Note: "chunk_size" was wrong before version 2.0 when elements are
664 stored with 16-bit encoding (and should be twice as big then).
665 Even worse, playfield data was stored 16-bit when only yamyam content
666 contained 16-bit elements and vice versa. */
668 if (level->encoding_16bit_field && level->file_version >= FILE_VERSION_2_0)
669 chunk_size_expected *= 2;
671 if (chunk_size_expected != chunk_size)
673 ReadUnusedBytesFromFile(file, chunk_size);
674 return chunk_size_expected;
677 for (y = 0; y < level->fieldy; y++)
678 for (x = 0; x < level->fieldx; x++)
680 getMappedElement(level->encoding_16bit_field ? getFile16BitBE(file) :
685 static int LoadLevel_CONT(FILE *file, int chunk_size, struct LevelInfo *level)
689 int content_size = MAX_ELEMENT_CONTENTS * 3 * 3;
690 int chunk_size_expected = header_size + content_size;
692 /* Note: "chunk_size" was wrong before version 2.0 when elements are
693 stored with 16-bit encoding (and should be twice as big then).
694 Even worse, playfield data was stored 16-bit when only yamyam content
695 contained 16-bit elements and vice versa. */
697 if (level->encoding_16bit_field && level->file_version >= FILE_VERSION_2_0)
698 chunk_size_expected += content_size;
700 if (chunk_size_expected != chunk_size)
702 ReadUnusedBytesFromFile(file, chunk_size);
703 return chunk_size_expected;
707 level->num_yamyam_contents = getFile8Bit(file);
711 /* correct invalid number of content fields -- should never happen */
712 if (level->num_yamyam_contents < 1 ||
713 level->num_yamyam_contents > MAX_ELEMENT_CONTENTS)
714 level->num_yamyam_contents = STD_ELEMENT_CONTENTS;
716 for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
717 for (y = 0; y < 3; y++)
718 for (x = 0; x < 3; x++)
719 level->yamyam_content[i][x][y] =
720 getMappedElement(level->encoding_16bit_field ?
721 getFile16BitBE(file) : getFile8Bit(file));
725 static int LoadLevel_CNT2(FILE *file, int chunk_size, struct LevelInfo *level)
729 int num_contents, content_xsize, content_ysize;
730 int content_array[MAX_ELEMENT_CONTENTS][3][3];
732 element = getMappedElement(getFile16BitBE(file));
733 num_contents = getFile8Bit(file);
734 content_xsize = getFile8Bit(file);
735 content_ysize = getFile8Bit(file);
737 ReadUnusedBytesFromFile(file, LEVEL_CHUNK_CNT2_UNUSED);
739 for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
740 for (y = 0; y < 3; y++)
741 for (x = 0; x < 3; x++)
742 content_array[i][x][y] = getMappedElement(getFile16BitBE(file));
744 /* correct invalid number of content fields -- should never happen */
745 if (num_contents < 1 || num_contents > MAX_ELEMENT_CONTENTS)
746 num_contents = STD_ELEMENT_CONTENTS;
748 if (element == EL_YAMYAM)
750 level->num_yamyam_contents = num_contents;
752 for (i = 0; i < num_contents; i++)
753 for (y = 0; y < 3; y++)
754 for (x = 0; x < 3; x++)
755 level->yamyam_content[i][x][y] = content_array[i][x][y];
757 else if (element == EL_BD_AMOEBA)
759 level->amoeba_content = content_array[0][0][0];
763 Error(ERR_WARN, "cannot load content for element '%d'", element);
769 static int LoadLevel_CNT3(FILE *file, int chunk_size, struct LevelInfo *level)
775 int chunk_size_expected;
777 element = getMappedElement(getFile16BitBE(file));
778 if (!IS_ENVELOPE(element))
779 element = EL_ENVELOPE_1;
781 envelope_nr = element - EL_ENVELOPE_1;
783 envelope_len = getFile16BitBE(file);
785 level->envelope_xsize[envelope_nr] = getFile8Bit(file);
786 level->envelope_ysize[envelope_nr] = getFile8Bit(file);
788 ReadUnusedBytesFromFile(file, LEVEL_CHUNK_CNT3_UNUSED);
790 chunk_size_expected = LEVEL_CHUNK_CNT3_SIZE(envelope_len);
791 if (chunk_size_expected != chunk_size)
793 ReadUnusedBytesFromFile(file, chunk_size - LEVEL_CHUNK_CNT3_HEADER);
794 return chunk_size_expected;
797 for (i = 0; i < envelope_len; i++)
798 level->envelope_text[envelope_nr][i] = getFile8Bit(file);
803 static int LoadLevel_CUS1(FILE *file, int chunk_size, struct LevelInfo *level)
805 int num_changed_custom_elements = getFile16BitBE(file);
806 int chunk_size_expected = 2 + num_changed_custom_elements * 6;
809 if (chunk_size_expected != chunk_size)
811 ReadUnusedBytesFromFile(file, chunk_size - 2);
812 return chunk_size_expected;
815 for (i = 0; i < num_changed_custom_elements; i++)
817 int element = getFile16BitBE(file);
818 int properties = getFile32BitBE(file);
820 if (IS_CUSTOM_ELEMENT(element))
821 Properties[element][EP_BITFIELD_BASE] = properties;
823 Error(ERR_WARN, "invalid custom element number %d", element);
829 static int LoadLevel_CUS2(FILE *file, int chunk_size, struct LevelInfo *level)
831 int num_changed_custom_elements = getFile16BitBE(file);
832 int chunk_size_expected = 2 + num_changed_custom_elements * 4;
835 if (chunk_size_expected != chunk_size)
837 ReadUnusedBytesFromFile(file, chunk_size - 2);
838 return chunk_size_expected;
841 for (i = 0; i < num_changed_custom_elements; i++)
843 int element = getFile16BitBE(file);
844 int custom_target_element = getFile16BitBE(file);
846 if (IS_CUSTOM_ELEMENT(element))
847 element_info[element].change->target_element = custom_target_element;
849 Error(ERR_WARN, "invalid custom element number %d", element);
855 static int LoadLevel_CUS3(FILE *file, int chunk_size, struct LevelInfo *level)
857 int num_changed_custom_elements = getFile16BitBE(file);
858 int chunk_size_expected = LEVEL_CHUNK_CUS3_SIZE(num_changed_custom_elements);
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);
871 if (!IS_CUSTOM_ELEMENT(element))
873 Error(ERR_WARN, "invalid custom element number %d", element);
875 element = EL_INTERNAL_DUMMY;
878 for (j = 0; j < MAX_ELEMENT_NAME_LEN; j++)
879 element_info[element].description[j] = getFile8Bit(file);
880 element_info[element].description[MAX_ELEMENT_NAME_LEN] = 0;
882 Properties[element][EP_BITFIELD_BASE] = getFile32BitBE(file);
884 /* some free bytes for future properties and padding */
885 ReadUnusedBytesFromFile(file, 7);
887 element_info[element].use_gfx_element = getFile8Bit(file);
888 element_info[element].gfx_element =
889 getMappedElement(getFile16BitBE(file));
891 element_info[element].collect_score = getFile8Bit(file);
892 element_info[element].collect_count = getFile8Bit(file);
894 element_info[element].push_delay_fixed = getFile16BitBE(file);
895 element_info[element].push_delay_random = getFile16BitBE(file);
896 element_info[element].move_delay_fixed = getFile16BitBE(file);
897 element_info[element].move_delay_random = getFile16BitBE(file);
899 element_info[element].move_pattern = getFile16BitBE(file);
900 element_info[element].move_direction_initial = getFile8Bit(file);
901 element_info[element].move_stepsize = getFile8Bit(file);
903 for (y = 0; y < 3; y++)
904 for (x = 0; x < 3; x++)
905 element_info[element].content[x][y] =
906 getMappedElement(getFile16BitBE(file));
908 element_info[element].change->events = getFile32BitBE(file);
910 element_info[element].change->target_element =
911 getMappedElement(getFile16BitBE(file));
913 element_info[element].change->delay_fixed = getFile16BitBE(file);
914 element_info[element].change->delay_random = getFile16BitBE(file);
915 element_info[element].change->delay_frames = getFile16BitBE(file);
917 element_info[element].change->trigger_element =
918 getMappedElement(getFile16BitBE(file));
920 element_info[element].change->explode = getFile8Bit(file);
921 element_info[element].change->use_content = getFile8Bit(file);
922 element_info[element].change->only_complete = getFile8Bit(file);
923 element_info[element].change->use_random_change = getFile8Bit(file);
925 element_info[element].change->random = getFile8Bit(file);
926 element_info[element].change->power = getFile8Bit(file);
928 for (y = 0; y < 3; y++)
929 for (x = 0; x < 3; x++)
930 element_info[element].change->content[x][y] =
931 getMappedElement(getFile16BitBE(file));
933 element_info[element].slippery_type = getFile8Bit(file);
935 /* some free bytes for future properties and padding */
936 ReadUnusedBytesFromFile(file, LEVEL_CPART_CUS3_UNUSED);
938 /* mark that this custom element has been modified */
939 element_info[element].modified_settings = TRUE;
945 static int LoadLevel_CUS4(FILE *file, int chunk_size, struct LevelInfo *level)
947 struct ElementInfo *ei;
948 int chunk_size_expected;
952 element = getFile16BitBE(file);
954 if (!IS_CUSTOM_ELEMENT(element))
956 Error(ERR_WARN, "invalid custom element number %d", element);
958 ReadUnusedBytesFromFile(file, chunk_size - 2);
962 ei = &element_info[element];
964 for (i = 0; i < MAX_ELEMENT_NAME_LEN; i++)
965 ei->description[i] = getFile8Bit(file);
966 ei->description[MAX_ELEMENT_NAME_LEN] = 0;
968 Properties[element][EP_BITFIELD_BASE] = getFile32BitBE(file);
969 ReadUnusedBytesFromFile(file, 4); /* reserved for more base properties */
971 ei->num_change_pages = getFile8Bit(file);
973 /* some free bytes for future base property values and padding */
974 ReadUnusedBytesFromFile(file, 5);
976 chunk_size_expected = LEVEL_CHUNK_CUS4_SIZE(ei->num_change_pages);
977 if (chunk_size_expected != chunk_size)
979 ReadUnusedBytesFromFile(file, chunk_size - 48);
980 return chunk_size_expected;
983 /* read custom property values */
985 ei->use_gfx_element = getFile8Bit(file);
986 ei->gfx_element = getMappedElement(getFile16BitBE(file));
988 ei->collect_score = getFile8Bit(file);
989 ei->collect_count = getFile8Bit(file);
991 ei->push_delay_fixed = getFile16BitBE(file);
992 ei->push_delay_random = getFile16BitBE(file);
993 ei->move_delay_fixed = getFile16BitBE(file);
994 ei->move_delay_random = getFile16BitBE(file);
996 /* bits 0 - 15 of "move_pattern" ... */
997 ei->move_pattern = getFile16BitBE(file);
998 ei->move_direction_initial = getFile8Bit(file);
999 ei->move_stepsize = getFile8Bit(file);
1001 ei->slippery_type = getFile8Bit(file);
1003 for (y = 0; y < 3; y++)
1004 for (x = 0; x < 3; x++)
1005 ei->content[x][y] = getMappedElement(getFile16BitBE(file));
1007 ei->move_enter_element = getMappedElement(getFile16BitBE(file));
1008 ei->move_leave_element = getMappedElement(getFile16BitBE(file));
1009 ei->move_leave_type = getFile8Bit(file);
1011 /* ... bits 16 - 31 of "move_pattern" (not nice, but downward compatible) */
1012 ei->move_pattern |= (getFile16BitBE(file) << 16);
1014 ei->access_direction = getFile8Bit(file);
1016 ei->explosion_delay = getFile8Bit(file);
1017 ei->ignition_delay = getFile8Bit(file);
1019 /* some free bytes for future custom property values and padding */
1020 ReadUnusedBytesFromFile(file, 2);
1022 /* read change property values */
1024 setElementChangePages(ei, ei->num_change_pages);
1026 for (i = 0; i < ei->num_change_pages; i++)
1028 struct ElementChangeInfo *change = &ei->change_page[i];
1030 /* always start with reliable default values */
1031 setElementChangeInfoToDefaults(change);
1033 change->events = getFile32BitBE(file);
1035 change->target_element = getMappedElement(getFile16BitBE(file));
1037 change->delay_fixed = getFile16BitBE(file);
1038 change->delay_random = getFile16BitBE(file);
1039 change->delay_frames = getFile16BitBE(file);
1041 change->trigger_element = getMappedElement(getFile16BitBE(file));
1043 change->explode = getFile8Bit(file);
1044 change->use_content = getFile8Bit(file);
1045 change->only_complete = getFile8Bit(file);
1046 change->use_random_change = getFile8Bit(file);
1048 change->random = getFile8Bit(file);
1049 change->power = getFile8Bit(file);
1051 for (y = 0; y < 3; y++)
1052 for (x = 0; x < 3; x++)
1053 change->content[x][y] = getMappedElement(getFile16BitBE(file));
1055 change->can_change = getFile8Bit(file);
1057 change->sides = getFile8Bit(file);
1059 if (change->sides == CH_SIDE_NONE) /* correct empty sides field */
1060 change->sides = CH_SIDE_ANY;
1062 /* some free bytes for future change property values and padding */
1063 ReadUnusedBytesFromFile(file, 8);
1066 /* mark this custom element as modified */
1067 ei->modified_settings = TRUE;
1072 static int LoadLevel_GRP1(FILE *file, int chunk_size, struct LevelInfo *level)
1074 struct ElementInfo *ei;
1075 struct ElementGroupInfo *group;
1079 element = getFile16BitBE(file);
1081 if (!IS_GROUP_ELEMENT(element))
1083 Error(ERR_WARN, "invalid group element number %d", element);
1085 ReadUnusedBytesFromFile(file, chunk_size - 2);
1089 ei = &element_info[element];
1091 for (i = 0; i < MAX_ELEMENT_NAME_LEN; i++)
1092 ei->description[i] = getFile8Bit(file);
1093 ei->description[MAX_ELEMENT_NAME_LEN] = 0;
1095 group = element_info[element].group;
1097 group->num_elements = getFile8Bit(file);
1099 ei->use_gfx_element = getFile8Bit(file);
1100 ei->gfx_element = getMappedElement(getFile16BitBE(file));
1102 group->choice_mode = getFile8Bit(file);
1104 /* some free bytes for future values and padding */
1105 ReadUnusedBytesFromFile(file, 3);
1107 for (i = 0; i < MAX_ELEMENTS_IN_GROUP; i++)
1108 group->element[i] = getMappedElement(getFile16BitBE(file));
1110 /* mark this group element as modified */
1111 element_info[element].modified_settings = TRUE;
1116 static void LoadLevelFromFileInfo_RND(struct LevelInfo *level,
1117 struct LevelFileInfo *level_file_info)
1119 char *filename = level_file_info->filename;
1120 char cookie[MAX_LINE_LEN];
1121 char chunk_name[CHUNK_ID_LEN + 1];
1125 if (!(file = fopen(filename, MODE_READ)))
1127 level->no_level_file = TRUE;
1129 if (level != &level_template)
1130 Error(ERR_WARN, "cannot read level '%s' -- using empty level", filename);
1135 getFileChunkBE(file, chunk_name, NULL);
1136 if (strcmp(chunk_name, "RND1") == 0)
1138 getFile32BitBE(file); /* not used */
1140 getFileChunkBE(file, chunk_name, NULL);
1141 if (strcmp(chunk_name, "CAVE") != 0)
1143 Error(ERR_WARN, "unknown format of level file '%s'", filename);
1148 else /* check for pre-2.0 file format with cookie string */
1150 strcpy(cookie, chunk_name);
1151 fgets(&cookie[4], MAX_LINE_LEN - 4, file);
1152 if (strlen(cookie) > 0 && cookie[strlen(cookie) - 1] == '\n')
1153 cookie[strlen(cookie) - 1] = '\0';
1155 if (!checkCookieString(cookie, LEVEL_COOKIE_TMPL))
1157 Error(ERR_WARN, "unknown format of level file '%s'", filename);
1162 if ((level->file_version = getFileVersionFromCookieString(cookie)) == -1)
1164 Error(ERR_WARN, "unsupported version of level file '%s'", filename);
1169 /* pre-2.0 level files have no game version, so use file version here */
1170 level->game_version = level->file_version;
1173 if (level->file_version < FILE_VERSION_1_2)
1175 /* level files from versions before 1.2.0 without chunk structure */
1176 LoadLevel_HEAD(file, LEVEL_HEADER_SIZE, level);
1177 LoadLevel_BODY(file, level->fieldx * level->fieldy, level);
1185 int (*loader)(FILE *, int, struct LevelInfo *);
1189 { "VERS", FILE_VERS_CHUNK_SIZE, LoadLevel_VERS },
1190 { "HEAD", LEVEL_HEADER_SIZE, LoadLevel_HEAD },
1191 { "AUTH", MAX_LEVEL_AUTHOR_LEN, LoadLevel_AUTH },
1192 { "BODY", -1, LoadLevel_BODY },
1193 { "CONT", -1, LoadLevel_CONT },
1194 { "CNT2", LEVEL_CHUNK_CNT2_SIZE, LoadLevel_CNT2 },
1195 { "CNT3", -1, LoadLevel_CNT3 },
1196 { "CUS1", -1, LoadLevel_CUS1 },
1197 { "CUS2", -1, LoadLevel_CUS2 },
1198 { "CUS3", -1, LoadLevel_CUS3 },
1199 { "CUS4", -1, LoadLevel_CUS4 },
1200 { "GRP1", -1, LoadLevel_GRP1 },
1204 while (getFileChunkBE(file, chunk_name, &chunk_size))
1208 while (chunk_info[i].name != NULL &&
1209 strcmp(chunk_name, chunk_info[i].name) != 0)
1212 if (chunk_info[i].name == NULL)
1214 Error(ERR_WARN, "unknown chunk '%s' in level file '%s'",
1215 chunk_name, filename);
1216 ReadUnusedBytesFromFile(file, chunk_size);
1218 else if (chunk_info[i].size != -1 &&
1219 chunk_info[i].size != chunk_size)
1221 Error(ERR_WARN, "wrong size (%d) of chunk '%s' in level file '%s'",
1222 chunk_size, chunk_name, filename);
1223 ReadUnusedBytesFromFile(file, chunk_size);
1227 /* call function to load this level chunk */
1228 int chunk_size_expected =
1229 (chunk_info[i].loader)(file, chunk_size, level);
1231 /* the size of some chunks cannot be checked before reading other
1232 chunks first (like "HEAD" and "BODY") that contain some header
1233 information, so check them here */
1234 if (chunk_size_expected != chunk_size)
1236 Error(ERR_WARN, "wrong size (%d) of chunk '%s' in level file '%s'",
1237 chunk_size, chunk_name, filename);
1246 /* ------------------------------------------------------------------------- */
1247 /* functions for loading EM level */
1248 /* ------------------------------------------------------------------------- */
1250 static int map_em_element_yam(int element)
1254 case 0x00: return EL_EMPTY;
1255 case 0x01: return EL_EMERALD;
1256 case 0x02: return EL_DIAMOND;
1257 case 0x03: return EL_ROCK;
1258 case 0x04: return EL_ROBOT;
1259 case 0x05: return EL_SPACESHIP_UP;
1260 case 0x06: return EL_BOMB;
1261 case 0x07: return EL_BUG_UP;
1262 case 0x08: return EL_AMOEBA_DROP;
1263 case 0x09: return EL_NUT;
1264 case 0x0a: return EL_YAMYAM;
1265 case 0x0b: return EL_QUICKSAND_FULL;
1266 case 0x0c: return EL_SAND;
1267 case 0x0d: return EL_WALL_SLIPPERY;
1268 case 0x0e: return EL_STEELWALL;
1269 case 0x0f: return EL_WALL;
1270 case 0x10: return EL_EM_KEY_1;
1271 case 0x11: return EL_EM_KEY_2;
1272 case 0x12: return EL_EM_KEY_4;
1273 case 0x13: return EL_EM_KEY_3;
1274 case 0x14: return EL_MAGIC_WALL;
1275 case 0x15: return EL_ROBOT_WHEEL;
1276 case 0x16: return EL_DYNAMITE;
1278 case 0x17: return EL_EM_KEY_1; /* EMC */
1279 case 0x18: return EL_BUG_UP; /* EMC */
1280 case 0x1a: return EL_DIAMOND; /* EMC */
1281 case 0x1b: return EL_EMERALD; /* EMC */
1282 case 0x25: return EL_NUT; /* EMC */
1283 case 0x80: return EL_EMPTY; /* EMC */
1284 case 0x85: return EL_EM_KEY_1; /* EMC */
1285 case 0x86: return EL_EM_KEY_2; /* EMC */
1286 case 0x87: return EL_EM_KEY_4; /* EMC */
1287 case 0x88: return EL_EM_KEY_3; /* EMC */
1288 case 0x94: return EL_QUICKSAND_EMPTY; /* EMC */
1289 case 0x9a: return EL_AMOEBA_WET; /* EMC */
1290 case 0xaf: return EL_DYNAMITE; /* EMC */
1291 case 0xbd: return EL_SAND; /* EMC */
1294 Error(ERR_WARN, "invalid level element %d", element);
1299 static int map_em_element_field(int element)
1301 if (element >= 0xc8 && element <= 0xe1)
1302 return EL_CHAR_A + (element - 0xc8);
1303 else if (element >= 0xe2 && element <= 0xeb)
1304 return EL_CHAR_0 + (element - 0xe2);
1308 case 0x00: return EL_ROCK;
1309 case 0x01: return EL_ROCK; /* EMC */
1310 case 0x02: return EL_DIAMOND;
1311 case 0x03: return EL_DIAMOND;
1312 case 0x04: return EL_ROBOT;
1313 case 0x05: return EL_ROBOT; /* EMC */
1314 case 0x06: return EL_EMPTY_SPACE; /* EMC */
1315 case 0x07: return EL_EMPTY_SPACE; /* EMC */
1316 case 0x08: return EL_SPACESHIP_UP;
1317 case 0x09: return EL_SPACESHIP_RIGHT;
1318 case 0x0a: return EL_SPACESHIP_DOWN;
1319 case 0x0b: return EL_SPACESHIP_LEFT;
1320 case 0x0c: return EL_SPACESHIP_UP;
1321 case 0x0d: return EL_SPACESHIP_RIGHT;
1322 case 0x0e: return EL_SPACESHIP_DOWN;
1323 case 0x0f: return EL_SPACESHIP_LEFT;
1325 case 0x10: return EL_BOMB;
1326 case 0x11: return EL_BOMB; /* EMC */
1327 case 0x12: return EL_EMERALD;
1328 case 0x13: return EL_EMERALD;
1329 case 0x14: return EL_BUG_UP;
1330 case 0x15: return EL_BUG_RIGHT;
1331 case 0x16: return EL_BUG_DOWN;
1332 case 0x17: return EL_BUG_LEFT;
1333 case 0x18: return EL_BUG_UP;
1334 case 0x19: return EL_BUG_RIGHT;
1335 case 0x1a: return EL_BUG_DOWN;
1336 case 0x1b: return EL_BUG_LEFT;
1337 case 0x1c: return EL_AMOEBA_DROP;
1338 case 0x1d: return EL_AMOEBA_DROP; /* EMC */
1339 case 0x1e: return EL_AMOEBA_DROP; /* EMC */
1340 case 0x1f: return EL_AMOEBA_DROP; /* EMC */
1342 case 0x20: return EL_ROCK;
1343 case 0x21: return EL_BOMB; /* EMC */
1344 case 0x22: return EL_DIAMOND; /* EMC */
1345 case 0x23: return EL_EMERALD; /* EMC */
1346 case 0x24: return EL_MAGIC_WALL;
1347 case 0x25: return EL_NUT;
1348 case 0x26: return EL_NUT; /* EMC */
1349 case 0x27: return EL_NUT; /* EMC */
1351 /* looks like magic wheel, but is _always_ activated */
1352 case 0x28: return EL_ROBOT_WHEEL; /* EMC */
1354 case 0x29: return EL_YAMYAM; /* up */
1355 case 0x2a: return EL_YAMYAM; /* down */
1356 case 0x2b: return EL_YAMYAM; /* left */ /* EMC */
1357 case 0x2c: return EL_YAMYAM; /* right */ /* EMC */
1358 case 0x2d: return EL_QUICKSAND_FULL;
1359 case 0x2e: return EL_EMPTY_SPACE; /* EMC */
1360 case 0x2f: return EL_EMPTY_SPACE; /* EMC */
1362 case 0x30: return EL_EMPTY_SPACE; /* EMC */
1363 case 0x31: return EL_SAND; /* EMC */
1364 case 0x32: return EL_SAND; /* EMC */
1365 case 0x33: return EL_SAND; /* EMC */
1366 case 0x34: return EL_QUICKSAND_FULL; /* EMC */
1367 case 0x35: return EL_QUICKSAND_FULL; /* EMC */
1368 case 0x36: return EL_QUICKSAND_FULL; /* EMC */
1369 case 0x37: return EL_SAND; /* EMC */
1370 case 0x38: return EL_ROCK; /* EMC */
1371 case 0x39: return EL_EXPANDABLE_WALL_HORIZONTAL; /* EMC */
1372 case 0x3a: return EL_EXPANDABLE_WALL_VERTICAL; /* EMC */
1373 case 0x3b: return EL_DYNAMITE_ACTIVE; /* 1 */
1374 case 0x3c: return EL_DYNAMITE_ACTIVE; /* 2 */
1375 case 0x3d: return EL_DYNAMITE_ACTIVE; /* 3 */
1376 case 0x3e: return EL_DYNAMITE_ACTIVE; /* 4 */
1377 case 0x3f: return EL_ACID_POOL_BOTTOM;
1379 case 0x40: return EL_EXIT_OPEN; /* 1 */
1380 case 0x41: return EL_EXIT_OPEN; /* 2 */
1381 case 0x42: return EL_EXIT_OPEN; /* 3 */
1382 case 0x43: return EL_BALLOON; /* EMC */
1383 case 0x44: return EL_UNKNOWN; /* EMC ("plant") */
1384 case 0x45: return EL_SPRING; /* EMC */
1385 case 0x46: return EL_SPRING; /* falling */ /* EMC */
1386 case 0x47: return EL_SPRING; /* left */ /* EMC */
1387 case 0x48: return EL_SPRING; /* right */ /* EMC */
1388 case 0x49: return EL_UNKNOWN; /* EMC ("ball 1") */
1389 case 0x4a: return EL_UNKNOWN; /* EMC ("ball 2") */
1390 case 0x4b: return EL_UNKNOWN; /* EMC ("android") */
1391 case 0x4c: return EL_EMPTY_SPACE; /* EMC */
1392 case 0x4d: return EL_UNKNOWN; /* EMC ("android") */
1393 case 0x4e: return EL_INVISIBLE_WALL; /* EMC (? "android") */
1394 case 0x4f: return EL_UNKNOWN; /* EMC ("android") */
1396 case 0x50: return EL_UNKNOWN; /* EMC ("android") */
1397 case 0x51: return EL_UNKNOWN; /* EMC ("android") */
1398 case 0x52: return EL_UNKNOWN; /* EMC ("android") */
1399 case 0x53: return EL_UNKNOWN; /* EMC ("android") */
1400 case 0x54: return EL_UNKNOWN; /* EMC ("android") */
1401 case 0x55: return EL_EMPTY_SPACE; /* EMC */
1402 case 0x56: return EL_EMPTY_SPACE; /* EMC */
1403 case 0x57: return EL_EMPTY_SPACE; /* EMC */
1404 case 0x58: return EL_EMPTY_SPACE; /* EMC */
1405 case 0x59: return EL_EMPTY_SPACE; /* EMC */
1406 case 0x5a: return EL_EMPTY_SPACE; /* EMC */
1407 case 0x5b: return EL_EMPTY_SPACE; /* EMC */
1408 case 0x5c: return EL_EMPTY_SPACE; /* EMC */
1409 case 0x5d: return EL_EMPTY_SPACE; /* EMC */
1410 case 0x5e: return EL_EMPTY_SPACE; /* EMC */
1411 case 0x5f: return EL_EMPTY_SPACE; /* EMC */
1413 case 0x60: return EL_EMPTY_SPACE; /* EMC */
1414 case 0x61: return EL_EMPTY_SPACE; /* EMC */
1415 case 0x62: return EL_EMPTY_SPACE; /* EMC */
1416 case 0x63: return EL_SPRING; /* left */ /* EMC */
1417 case 0x64: return EL_SPRING; /* right */ /* EMC */
1418 case 0x65: return EL_ACID; /* 1 */ /* EMC */
1419 case 0x66: return EL_ACID; /* 2 */ /* EMC */
1420 case 0x67: return EL_ACID; /* 3 */ /* EMC */
1421 case 0x68: return EL_ACID; /* 4 */ /* EMC */
1422 case 0x69: return EL_ACID; /* 5 */ /* EMC */
1423 case 0x6a: return EL_ACID; /* 6 */ /* EMC */
1424 case 0x6b: return EL_ACID; /* 7 */ /* EMC */
1425 case 0x6c: return EL_ACID; /* 8 */ /* EMC */
1426 case 0x6d: return EL_EMPTY_SPACE; /* EMC */
1427 case 0x6e: return EL_EMPTY_SPACE; /* EMC */
1428 case 0x6f: return EL_EMPTY_SPACE; /* EMC */
1430 case 0x70: return EL_EMPTY_SPACE; /* EMC */
1431 case 0x71: return EL_EMPTY_SPACE; /* EMC */
1432 case 0x72: return EL_NUT; /* left */ /* EMC */
1433 case 0x73: return EL_SAND; /* EMC (? "nut") */
1434 case 0x74: return EL_STEELWALL;
1435 case 0x75: return EL_EMPTY_SPACE; /* EMC */
1436 case 0x76: return EL_EMPTY_SPACE; /* EMC */
1437 case 0x77: return EL_BOMB; /* left */ /* EMC */
1438 case 0x78: return EL_BOMB; /* right */ /* EMC */
1439 case 0x79: return EL_ROCK; /* left */ /* EMC */
1440 case 0x7a: return EL_ROCK; /* right */ /* EMC */
1441 case 0x7b: return EL_ACID; /* (? EMC "blank") */
1442 case 0x7c: return EL_EMPTY_SPACE; /* EMC */
1443 case 0x7d: return EL_EMPTY_SPACE; /* EMC */
1444 case 0x7e: return EL_EMPTY_SPACE; /* EMC */
1445 case 0x7f: return EL_EMPTY_SPACE; /* EMC */
1447 case 0x80: return EL_EMPTY;
1448 case 0x81: return EL_WALL_SLIPPERY;
1449 case 0x82: return EL_SAND;
1450 case 0x83: return EL_STEELWALL;
1451 case 0x84: return EL_WALL;
1452 case 0x85: return EL_EM_KEY_1;
1453 case 0x86: return EL_EM_KEY_2;
1454 case 0x87: return EL_EM_KEY_4;
1455 case 0x88: return EL_EM_KEY_3;
1456 case 0x89: return EL_EM_GATE_1;
1457 case 0x8a: return EL_EM_GATE_2;
1458 case 0x8b: return EL_EM_GATE_4;
1459 case 0x8c: return EL_EM_GATE_3;
1460 case 0x8d: return EL_INVISIBLE_WALL; /* EMC (? "dripper") */
1461 case 0x8e: return EL_EM_GATE_1_GRAY;
1462 case 0x8f: return EL_EM_GATE_2_GRAY;
1464 case 0x90: return EL_EM_GATE_4_GRAY;
1465 case 0x91: return EL_EM_GATE_3_GRAY;
1466 case 0x92: return EL_MAGIC_WALL;
1467 case 0x93: return EL_ROBOT_WHEEL;
1468 case 0x94: return EL_QUICKSAND_EMPTY; /* (? EMC "sand") */
1469 case 0x95: return EL_ACID_POOL_TOPLEFT;
1470 case 0x96: return EL_ACID_POOL_TOPRIGHT;
1471 case 0x97: return EL_ACID_POOL_BOTTOMLEFT;
1472 case 0x98: return EL_ACID_POOL_BOTTOMRIGHT;
1473 case 0x99: return EL_ACID; /* (? EMC "fake blank") */
1474 case 0x9a: return EL_AMOEBA_DEAD; /* 1 */
1475 case 0x9b: return EL_AMOEBA_DEAD; /* 2 */
1476 case 0x9c: return EL_AMOEBA_DEAD; /* 3 */
1477 case 0x9d: return EL_AMOEBA_DEAD; /* 4 */
1478 case 0x9e: return EL_EXIT_CLOSED;
1479 case 0x9f: return EL_CHAR_LESS; /* arrow left */
1481 /* looks like normal sand, but behaves like wall */
1482 case 0xa0: return EL_UNKNOWN; /* EMC ("fake grass") */
1483 case 0xa1: return EL_UNKNOWN; /* EMC ("lenses") */
1484 case 0xa2: return EL_UNKNOWN; /* EMC ("magnify") */
1485 case 0xa3: return EL_UNKNOWN; /* EMC ("fake blank") */
1486 case 0xa4: return EL_UNKNOWN; /* EMC ("fake grass") */
1487 case 0xa5: return EL_UNKNOWN; /* EMC ("switch") */
1488 case 0xa6: return EL_UNKNOWN; /* EMC ("switch") */
1489 case 0xa7: return EL_EMPTY_SPACE; /* EMC */
1490 case 0xa8: return EL_EMC_WALL_1; /* EMC ("decor 8") */
1491 case 0xa9: return EL_EMC_WALL_2; /* EMC ("decor 9") */
1492 case 0xaa: return EL_EMC_WALL_3; /* EMC ("decor 10") */
1493 case 0xab: return EL_EMC_WALL_7; /* EMC ("decor 5") */
1494 case 0xac: return EL_CHAR_COMMA; /* EMC */
1495 case 0xad: return EL_CHAR_QUOTEDBL; /* EMC */
1496 case 0xae: return EL_CHAR_MINUS; /* EMC */
1497 case 0xaf: return EL_DYNAMITE;
1499 case 0xb0: return EL_EMC_STEELWALL_1; /* EMC ("steel 3") */
1500 case 0xb1: return EL_EMC_WALL_8; /* EMC ("decor 6") */
1501 case 0xb2: return EL_UNKNOWN; /* EMC ("decor 7") */
1502 case 0xb3: return EL_STEELWALL; /* 2 */ /* EMC */
1503 case 0xb4: return EL_WALL_SLIPPERY; /* 2 */ /* EMC */
1504 case 0xb5: return EL_EMC_WALL_6; /* EMC ("decor 2") */
1505 case 0xb6: return EL_EMC_WALL_5; /* EMC ("decor 4") */
1506 case 0xb7: return EL_EMC_WALL_4; /* EMC ("decor 3") */
1507 case 0xb8: return EL_BALLOON_SWITCH_ANY; /* EMC */
1508 case 0xb9: return EL_BALLOON_SWITCH_RIGHT; /* EMC */
1509 case 0xba: return EL_BALLOON_SWITCH_DOWN; /* EMC */
1510 case 0xbb: return EL_BALLOON_SWITCH_LEFT; /* EMC */
1511 case 0xbc: return EL_BALLOON_SWITCH_UP; /* EMC */
1512 case 0xbd: return EL_SAND; /* EMC ("dirt") */
1513 case 0xbe: return EL_UNKNOWN; /* EMC ("plant") */
1514 case 0xbf: return EL_UNKNOWN; /* EMC ("key 5") */
1516 case 0xc0: return EL_UNKNOWN; /* EMC ("key 6") */
1517 case 0xc1: return EL_UNKNOWN; /* EMC ("key 7") */
1518 case 0xc2: return EL_UNKNOWN; /* EMC ("key 8") */
1519 case 0xc3: return EL_UNKNOWN; /* EMC ("door 5") */
1520 case 0xc4: return EL_UNKNOWN; /* EMC ("door 6") */
1521 case 0xc5: return EL_UNKNOWN; /* EMC ("door 7") */
1522 case 0xc6: return EL_UNKNOWN; /* EMC ("door 8") */
1523 case 0xc7: return EL_UNKNOWN; /* EMC ("bumper") */
1525 /* characters: see above */
1527 case 0xec: return EL_CHAR_PERIOD;
1528 case 0xed: return EL_CHAR_EXCLAM;
1529 case 0xee: return EL_CHAR_COLON;
1530 case 0xef: return EL_CHAR_QUESTION;
1532 case 0xf0: return EL_CHAR_GREATER; /* arrow right */
1533 case 0xf1: return EL_CHAR_COPYRIGHT; /* EMC: "decor 1" */
1534 case 0xf2: return EL_UNKNOWN; /* EMC ("fake door 5") */
1535 case 0xf3: return EL_UNKNOWN; /* EMC ("fake door 6") */
1536 case 0xf4: return EL_UNKNOWN; /* EMC ("fake door 7") */
1537 case 0xf5: return EL_UNKNOWN; /* EMC ("fake door 8") */
1538 case 0xf6: return EL_EMPTY_SPACE; /* EMC */
1539 case 0xf7: return EL_EMPTY_SPACE; /* EMC */
1541 case 0xf8: return EL_EMPTY_SPACE; /* EMC */
1542 case 0xf9: return EL_EMPTY_SPACE; /* EMC */
1543 case 0xfa: return EL_EMPTY_SPACE; /* EMC */
1544 case 0xfb: return EL_EMPTY_SPACE; /* EMC */
1545 case 0xfc: return EL_EMPTY_SPACE; /* EMC */
1546 case 0xfd: return EL_EMPTY_SPACE; /* EMC */
1548 case 0xfe: return EL_PLAYER_1; /* EMC: "blank" */
1549 case 0xff: return EL_PLAYER_2; /* EMC: "blank" */
1552 /* should never happen (all 8-bit value cases should be handled) */
1553 Error(ERR_WARN, "invalid level element %d", element);
1558 #define EM_LEVEL_SIZE 2106
1559 #define EM_LEVEL_XSIZE 64
1560 #define EM_LEVEL_YSIZE 32
1562 static void LoadLevelFromFileInfo_EM(struct LevelInfo *level,
1563 struct LevelFileInfo *level_file_info)
1565 char *filename = level_file_info->filename;
1567 unsigned char leveldata[EM_LEVEL_SIZE];
1568 unsigned char *header = &leveldata[EM_LEVEL_XSIZE * EM_LEVEL_YSIZE];
1569 unsigned char code0 = 0x65;
1570 unsigned char code1 = 0x11;
1571 boolean level_is_crypted = FALSE;
1572 int nr = level_file_info->nr;
1575 if (!(file = fopen(filename, MODE_READ)))
1577 level->no_level_file = TRUE;
1579 Error(ERR_WARN, "cannot read level '%s' -- using empty level", filename);
1584 for(i = 0; i < EM_LEVEL_SIZE; i++)
1585 leveldata[i] = fgetc(file);
1589 /* check if level data is crypted by testing against known starting bytes
1590 of the few existing crypted level files (from Emerald Mine 1 + 2) */
1592 if ((leveldata[0] == 0xf1 ||
1593 leveldata[0] == 0xf5) && leveldata[2] == 0xe7 && leveldata[3] == 0xee)
1595 level_is_crypted = TRUE;
1597 if (leveldata[0] == 0xf5) /* error in crypted Emerald Mine 2 levels */
1598 leveldata[0] = 0xf1;
1601 if (level_is_crypted) /* decode crypted level data */
1603 for(i = 0; i < EM_LEVEL_SIZE; i++)
1605 leveldata[i] ^= code0;
1606 leveldata[i] -= code1;
1608 code0 = (code0 + 7) & 0xff;
1612 level->fieldx = EM_LEVEL_XSIZE;
1613 level->fieldy = EM_LEVEL_YSIZE;
1615 level->time = header[46] * 10;
1616 level->gems_needed = header[47];
1618 /* The original Emerald Mine levels have their level number stored
1619 at the second byte of the level file...
1620 Do not trust this information at other level files, e.g. EMC,
1621 but correct it anyway (normally the first row is completely
1622 steel wall, so the correction does not hurt anyway). */
1624 if (leveldata[1] == nr)
1625 leveldata[1] = leveldata[2]; /* correct level number field */
1627 sprintf(level->name, "Level %d", nr); /* set level name */
1629 level->score[SC_EMERALD] = header[36];
1630 level->score[SC_DIAMOND] = header[37];
1631 level->score[SC_ROBOT] = header[38];
1632 level->score[SC_SPACESHIP] = header[39];
1633 level->score[SC_BUG] = header[40];
1634 level->score[SC_YAMYAM] = header[41];
1635 level->score[SC_NUT] = header[42];
1636 level->score[SC_DYNAMITE] = header[43];
1637 level->score[SC_TIME_BONUS] = header[44];
1639 level->num_yamyam_contents = 4;
1641 for(i = 0; i < level->num_yamyam_contents; i++)
1642 for(y = 0; y < 3; y++)
1643 for(x = 0; x < 3; x++)
1644 level->yamyam_content[i][x][y] =
1645 map_em_element_yam(header[i * 9 + y * 3 + x]);
1647 level->amoeba_speed = (header[52] * 256 + header[53]) % 256;
1648 level->time_magic_wall = (header[54] * 256 + header[55]) * 16 / 100;
1649 level->time_wheel = (header[56] * 256 + header[57]) * 16 / 100;
1650 level->amoeba_content = EL_DIAMOND;
1652 for (y = 0; y < level->fieldy; y++) for (x = 0; x < level->fieldx; x++)
1654 int new_element = map_em_element_field(leveldata[y * EM_LEVEL_XSIZE + x]);
1656 if (new_element == EL_AMOEBA_DEAD && level->amoeba_speed)
1657 new_element = EL_AMOEBA_WET;
1659 level->field[x][y] = new_element;
1662 x = (header[48] * 256 + header[49]) % EM_LEVEL_XSIZE;
1663 y = (header[48] * 256 + header[49]) / EM_LEVEL_XSIZE;
1664 level->field[x][y] = EL_PLAYER_1;
1666 x = (header[50] * 256 + header[51]) % EM_LEVEL_XSIZE;
1667 y = (header[50] * 256 + header[51]) / EM_LEVEL_XSIZE;
1668 level->field[x][y] = EL_PLAYER_2;
1671 /* ------------------------------------------------------------------------- */
1672 /* functions for loading SP level */
1673 /* ------------------------------------------------------------------------- */
1675 #define NUM_SUPAPLEX_LEVELS_PER_PACKAGE 111
1676 #define SP_LEVEL_SIZE 1536
1677 #define SP_LEVEL_XSIZE 60
1678 #define SP_LEVEL_YSIZE 24
1679 #define SP_LEVEL_NAME_LEN 23
1681 static void LoadLevelFromFileStream_SP(FILE *file, struct LevelInfo *level,
1686 /* read level body (width * height == 60 * 24 tiles == 1440 bytes) */
1687 for (y = 0; y < SP_LEVEL_YSIZE; y++)
1689 for (x = 0; x < SP_LEVEL_XSIZE; x++)
1691 int element_old = fgetc(file);
1694 if (element_old <= 0x27)
1695 element_new = getMappedElement(EL_SP_START + element_old);
1696 else if (element_old == 0x28)
1697 element_new = EL_INVISIBLE_WALL;
1700 Error(ERR_WARN, "in level %d, at position %d, %d:", nr, x, y);
1701 Error(ERR_WARN, "invalid level element %d", element_old);
1703 element_new = EL_UNKNOWN;
1706 level->field[x][y] = element_new;
1710 ReadUnusedBytesFromFile(file, 4);
1712 /* Initial gravitation: 1 == "on", anything else (0) == "off" */
1713 level->initial_gravity = (fgetc(file) == 1 ? TRUE : FALSE);
1715 ReadUnusedBytesFromFile(file, 1);
1717 /* level title in uppercase letters, padded with dashes ("-") (23 bytes) */
1718 for (i = 0; i < SP_LEVEL_NAME_LEN; i++)
1719 level->name[i] = fgetc(file);
1720 level->name[SP_LEVEL_NAME_LEN] = '\0';
1722 /* initial "freeze zonks": 2 == "on", anything else (0) == "off" */
1723 ReadUnusedBytesFromFile(file, 1); /* !!! NOT SUPPORTED YET !!! */
1725 /* number of infotrons needed; 0 means that Supaplex will count the total
1726 amount of infotrons in the level and use the low byte of that number.
1727 (a multiple of 256 infotrons will result in "0 infotrons needed"!) */
1728 level->gems_needed = fgetc(file);
1730 /* information about special gravity port entries */
1731 ReadUnusedBytesFromFile(file, 65); /* !!! NOT SUPPORTED YET !!! */
1733 level->fieldx = SP_LEVEL_XSIZE;
1734 level->fieldy = SP_LEVEL_YSIZE;
1736 level->time = 0; /* no time limit */
1737 level->amoeba_speed = 0;
1738 level->time_magic_wall = 0;
1739 level->time_wheel = 0;
1740 level->amoeba_content = EL_EMPTY;
1742 for(i = 0; i < LEVEL_SCORE_ELEMENTS; i++)
1743 level->score[i] = 0; /* !!! CORRECT THIS !!! */
1745 /* there are no yamyams in supaplex levels */
1746 for(i = 0; i < level->num_yamyam_contents; i++)
1747 for(y = 0; y < 3; y++)
1748 for(x = 0; x < 3; x++)
1749 level->yamyam_content[i][x][y] = EL_EMPTY;
1752 static void LoadLevelFromFileInfo_SP(struct LevelInfo *level,
1753 struct LevelFileInfo *level_file_info)
1755 char *filename = level_file_info->filename;
1757 int nr = level_file_info->nr - leveldir_current->first_level;
1759 char name_first, name_last;
1760 struct LevelInfo multipart_level;
1761 int multipart_xpos, multipart_ypos;
1762 boolean is_multipart_level;
1763 boolean is_first_part;
1764 boolean reading_multipart_level = FALSE;
1765 boolean use_empty_level = FALSE;
1767 if (!(file = fopen(filename, MODE_READ)))
1769 level->no_level_file = TRUE;
1771 Error(ERR_WARN, "cannot read level '%s' -- using empty level", filename);
1776 /* position file stream to the requested level inside the level package */
1777 if (fseek(file, nr * SP_LEVEL_SIZE, SEEK_SET) != 0)
1779 level->no_level_file = TRUE;
1781 Error(ERR_WARN, "cannot fseek level '%s' -- using empty level", filename);
1786 /* there exist Supaplex level package files with multi-part levels which
1787 can be detected as follows: instead of leading and trailing dashes ('-')
1788 to pad the level name, they have leading and trailing numbers which are
1789 the x and y coordinations of the current part of the multi-part level;
1790 if there are '?' characters instead of numbers on the left or right side
1791 of the level name, the multi-part level consists of only horizontal or
1794 for (l = nr; l < NUM_SUPAPLEX_LEVELS_PER_PACKAGE; l++)
1796 LoadLevelFromFileStream_SP(file, level, l);
1798 /* check if this level is a part of a bigger multi-part level */
1800 name_first = level->name[0];
1801 name_last = level->name[SP_LEVEL_NAME_LEN - 1];
1803 is_multipart_level =
1804 ((name_first == '?' || (name_first >= '0' && name_first <= '9')) &&
1805 (name_last == '?' || (name_last >= '0' && name_last <= '9')));
1808 ((name_first == '?' || name_first == '1') &&
1809 (name_last == '?' || name_last == '1'));
1811 /* correct leading multipart level meta information in level name */
1812 for (i = 0; i < SP_LEVEL_NAME_LEN && level->name[i] == name_first; i++)
1813 level->name[i] = '-';
1815 /* correct trailing multipart level meta information in level name */
1816 for (i = SP_LEVEL_NAME_LEN - 1; i>=0 && level->name[i] == name_last; i--)
1817 level->name[i] = '-';
1819 /* ---------- check for normal single level ---------- */
1821 if (!reading_multipart_level && !is_multipart_level)
1823 /* the current level is simply a normal single-part level, and we are
1824 not reading a multi-part level yet, so return the level as it is */
1829 /* ---------- check for empty level (unused multi-part) ---------- */
1831 if (!reading_multipart_level && is_multipart_level && !is_first_part)
1833 /* this is a part of a multi-part level, but not the first part
1834 (and we are not already reading parts of a multi-part level);
1835 in this case, use an empty level instead of the single part */
1837 use_empty_level = TRUE;
1842 /* ---------- check for finished multi-part level ---------- */
1844 if (reading_multipart_level &&
1845 (!is_multipart_level ||
1846 strcmp(level->name, multipart_level.name) != 0))
1848 /* we are already reading parts of a multi-part level, but this level is
1849 either not a multi-part level, or a part of a different multi-part
1850 level; in both cases, the multi-part level seems to be complete */
1855 /* ---------- here we have one part of a multi-part level ---------- */
1857 reading_multipart_level = TRUE;
1859 if (is_first_part) /* start with first part of new multi-part level */
1861 /* copy level info structure from first part */
1862 multipart_level = *level;
1864 /* clear playfield of new multi-part level */
1865 for (y = 0; y < MAX_LEV_FIELDY; y++)
1866 for (x = 0; x < MAX_LEV_FIELDX; x++)
1867 multipart_level.field[x][y] = EL_EMPTY;
1870 if (name_first == '?')
1872 if (name_last == '?')
1875 multipart_xpos = (int)(name_first - '0');
1876 multipart_ypos = (int)(name_last - '0');
1879 printf("----------> part (%d/%d) of multi-part level '%s'\n",
1880 multipart_xpos, multipart_ypos, multipart_level.name);
1883 if (multipart_xpos * SP_LEVEL_XSIZE > MAX_LEV_FIELDX ||
1884 multipart_ypos * SP_LEVEL_YSIZE > MAX_LEV_FIELDY)
1886 Error(ERR_WARN, "multi-part level is too big -- ignoring part of it");
1891 multipart_level.fieldx = MAX(multipart_level.fieldx,
1892 multipart_xpos * SP_LEVEL_XSIZE);
1893 multipart_level.fieldy = MAX(multipart_level.fieldy,
1894 multipart_ypos * SP_LEVEL_YSIZE);
1896 /* copy level part at the right position of multi-part level */
1897 for (y = 0; y < SP_LEVEL_YSIZE; y++)
1899 for (x = 0; x < SP_LEVEL_XSIZE; x++)
1901 int start_x = (multipart_xpos - 1) * SP_LEVEL_XSIZE;
1902 int start_y = (multipart_ypos - 1) * SP_LEVEL_YSIZE;
1904 multipart_level.field[start_x + x][start_y + y] = level->field[x][y];
1911 if (use_empty_level)
1913 setLevelInfoToDefaults(level);
1915 level->fieldx = SP_LEVEL_XSIZE;
1916 level->fieldy = SP_LEVEL_YSIZE;
1918 for (y = 0; y < SP_LEVEL_YSIZE; y++)
1919 for (x = 0; x < SP_LEVEL_XSIZE; x++)
1920 level->field[x][y] = EL_EMPTY;
1922 strcpy(level->name, "-------- EMPTY --------");
1924 Error(ERR_WARN, "single part of multi-part level -- using empty level");
1927 if (reading_multipart_level)
1928 *level = multipart_level;
1931 /* ------------------------------------------------------------------------- */
1932 /* functions for loading generic level */
1933 /* ------------------------------------------------------------------------- */
1935 void LoadLevelFromFileInfo(struct LevelInfo *level,
1936 struct LevelFileInfo *level_file_info)
1938 /* always start with reliable default values */
1939 setLevelInfoToDefaults(level);
1941 switch (level_file_info->type)
1943 case LEVEL_FILE_TYPE_RND:
1944 LoadLevelFromFileInfo_RND(level, level_file_info);
1947 case LEVEL_FILE_TYPE_EM:
1948 LoadLevelFromFileInfo_EM(level, level_file_info);
1951 case LEVEL_FILE_TYPE_SP:
1952 LoadLevelFromFileInfo_SP(level, level_file_info);
1956 LoadLevelFromFileInfo_RND(level, level_file_info);
1961 void LoadLevelFromFilename(struct LevelInfo *level, char *filename)
1963 static struct LevelFileInfo level_file_info;
1965 /* always start with reliable default values */
1966 setFileInfoToDefaults(&level_file_info);
1968 level_file_info.nr = 0; /* unknown level number */
1969 level_file_info.type = LEVEL_FILE_TYPE_RND; /* no others supported yet */
1970 level_file_info.filename = filename;
1972 LoadLevelFromFileInfo(level, &level_file_info);
1975 static void LoadLevel_InitVersion(struct LevelInfo *level, char *filename)
1977 if (leveldir_current == NULL) /* only when dumping level */
1981 printf("::: sort_priority: %d\n", leveldir_current->sort_priority);
1984 /* determine correct game engine version of current level */
1986 if (!leveldir_current->latest_engine)
1988 if (IS_LEVELCLASS_CONTRIB(leveldir_current) ||
1989 IS_LEVELCLASS_PRIVATE(leveldir_current) ||
1990 IS_LEVELCLASS_UNDEFINED(leveldir_current))
1994 printf("\n::: This level is private or contributed: '%s'\n", filename);
1998 printf("\n::: Use the stored game engine version for this level\n");
2001 /* For all levels which are not forced to use the latest game engine
2002 version (normally user contributed, private and undefined levels),
2003 use the version of the game engine the levels were created for.
2005 Since 2.0.1, the game engine version is now directly stored
2006 in the level file (chunk "VERS"), so there is no need anymore
2007 to set the game version from the file version (except for old,
2008 pre-2.0 levels, where the game version is still taken from the
2009 file format version used to store the level -- see above). */
2011 /* do some special adjustments to support older level versions */
2012 if (level->file_version == FILE_VERSION_1_0)
2014 Error(ERR_WARN, "level file '%s' has version number 1.0", filename);
2015 Error(ERR_WARN, "using high speed movement for player");
2017 /* player was faster than monsters in (pre-)1.0 levels */
2018 level->double_speed = TRUE;
2021 /* Default behaviour for EM style gems was "slippery" only in 2.0.1 */
2022 if (level->game_version == VERSION_IDENT(2,0,1,0))
2023 level->em_slippery_gems = TRUE;
2028 printf("\n::: ALWAYS USE LATEST ENGINE FOR THIS LEVEL: [%d] '%s'\n",
2029 leveldir_current->sort_priority, filename);
2033 printf("\n::: Use latest game engine version for this level.\n");
2036 /* For all levels which are forced to use the latest game engine version
2037 (normally all but user contributed, private and undefined levels), set
2038 the game engine version to the actual version; this allows for actual
2039 corrections in the game engine to take effect for existing, converted
2040 levels (from "classic" or other existing games) to make the emulation
2041 of the corresponding game more accurate, while (hopefully) not breaking
2042 existing levels created from other players. */
2045 printf("::: changing engine from %d to %d\n",
2046 level->game_version, GAME_VERSION_ACTUAL);
2049 level->game_version = GAME_VERSION_ACTUAL;
2051 /* Set special EM style gems behaviour: EM style gems slip down from
2052 normal, steel and growing wall. As this is a more fundamental change,
2053 it seems better to set the default behaviour to "off" (as it is more
2054 natural) and make it configurable in the level editor (as a property
2055 of gem style elements). Already existing converted levels (neither
2056 private nor contributed levels) are changed to the new behaviour. */
2058 if (level->file_version < FILE_VERSION_2_0)
2059 level->em_slippery_gems = TRUE;
2063 printf("::: => %d\n", level->game_version);
2067 static void LoadLevel_InitElements(struct LevelInfo *level, char *filename)
2071 /* map custom element change events that have changed in newer versions
2072 (these following values were accidentally changed in version 3.0.1) */
2073 if (level->game_version <= VERSION_IDENT(3,0,0,0))
2075 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2077 int element = EL_CUSTOM_START + i;
2079 /* order of checking and copying events to be mapped is important */
2080 for (j = CE_BY_OTHER_ACTION; j >= CE_BY_PLAYER_OBSOLETE; j--)
2082 if (HAS_CHANGE_EVENT(element, j - 2))
2084 SET_CHANGE_EVENT(element, j - 2, FALSE);
2085 SET_CHANGE_EVENT(element, j, TRUE);
2089 /* order of checking and copying events to be mapped is important */
2090 for (j = CE_OTHER_GETS_COLLECTED; j >= CE_HITTING_SOMETHING; j--)
2092 if (HAS_CHANGE_EVENT(element, j - 1))
2094 SET_CHANGE_EVENT(element, j - 1, FALSE);
2095 SET_CHANGE_EVENT(element, j, TRUE);
2101 /* some custom element change events get mapped since version 3.0.3 */
2102 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2104 int element = EL_CUSTOM_START + i;
2106 if (HAS_CHANGE_EVENT(element, CE_BY_PLAYER_OBSOLETE) ||
2107 HAS_CHANGE_EVENT(element, CE_BY_COLLISION_OBSOLETE))
2109 SET_CHANGE_EVENT(element, CE_BY_PLAYER_OBSOLETE, FALSE);
2110 SET_CHANGE_EVENT(element, CE_BY_COLLISION_OBSOLETE, FALSE);
2112 SET_CHANGE_EVENT(element, CE_BY_DIRECT_ACTION, TRUE);
2116 /* initialize "can_change" field for old levels with only one change page */
2117 if (level->game_version <= VERSION_IDENT(3,0,2,0))
2119 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2121 int element = EL_CUSTOM_START + i;
2123 if (CAN_CHANGE(element))
2124 element_info[element].change->can_change = TRUE;
2129 /* set default push delay values (corrected since version 3.0.7-1) */
2130 if (level->game_version < VERSION_IDENT(3,0,7,1))
2132 game.default_push_delay_fixed = 2;
2133 game.default_push_delay_random = 8;
2137 game.default_push_delay_fixed = 8;
2138 game.default_push_delay_random = 8;
2141 /* set uninitialized push delay values of custom elements in older levels */
2142 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2144 int element = EL_CUSTOM_START + i;
2146 if (element_info[element].push_delay_fixed == -1)
2147 element_info[element].push_delay_fixed = game.default_push_delay_fixed;
2148 if (element_info[element].push_delay_random == -1)
2149 element_info[element].push_delay_random = game.default_push_delay_random;
2153 /* initialize element properties for level editor etc. */
2154 InitElementPropertiesEngine(level->game_version);
2157 static void LoadLevel_InitPlayfield(struct LevelInfo *level, char *filename)
2161 /* map elements that have changed in newer versions */
2162 for (y = 0; y < level->fieldy; y++)
2164 for (x = 0; x < level->fieldx; x++)
2166 int element = level->field[x][y];
2168 if (level->game_version <= VERSION_IDENT(2,2,0,0))
2170 /* map game font elements */
2171 element = (element == EL_CHAR('[') ? EL_CHAR_AUMLAUT :
2172 element == EL_CHAR('\\') ? EL_CHAR_OUMLAUT :
2173 element == EL_CHAR(']') ? EL_CHAR_UUMLAUT :
2174 element == EL_CHAR('^') ? EL_CHAR_COPYRIGHT : element);
2177 if (level->game_version < VERSION_IDENT(3,0,0,0))
2179 /* map Supaplex gravity tube elements */
2180 element = (element == EL_SP_GRAVITY_PORT_LEFT ? EL_SP_PORT_LEFT :
2181 element == EL_SP_GRAVITY_PORT_RIGHT ? EL_SP_PORT_RIGHT :
2182 element == EL_SP_GRAVITY_PORT_UP ? EL_SP_PORT_UP :
2183 element == EL_SP_GRAVITY_PORT_DOWN ? EL_SP_PORT_DOWN :
2187 level->field[x][y] = element;
2191 /* copy elements to runtime playfield array */
2192 for (x = 0; x < MAX_LEV_FIELDX; x++)
2193 for (y = 0; y < MAX_LEV_FIELDY; y++)
2194 Feld[x][y] = level->field[x][y];
2196 /* initialize level size variables for faster access */
2197 lev_fieldx = level->fieldx;
2198 lev_fieldy = level->fieldy;
2200 /* determine border element for this level */
2204 void LoadLevelTemplate(int nr)
2207 struct LevelFileInfo *level_file_info = getLevelFileInfo(nr);
2208 char *filename = level_file_info->filename;
2210 LoadLevelFromFileInfo(&level_template, level_file_info);
2212 char *filename = getDefaultLevelFilename(nr);
2214 LoadLevelFromFilename_RND(&level_template, filename);
2217 LoadLevel_InitVersion(&level, filename);
2218 LoadLevel_InitElements(&level, filename);
2220 ActivateLevelTemplate();
2223 void LoadLevel(int nr)
2226 struct LevelFileInfo *level_file_info = getLevelFileInfo(nr);
2227 char *filename = level_file_info->filename;
2229 LoadLevelFromFileInfo(&level, level_file_info);
2231 char *filename = getLevelFilename(nr);
2233 LoadLevelFromFilename_RND(&level, filename);
2236 if (level.use_custom_template)
2237 LoadLevelTemplate(-1);
2240 LoadLevel_InitVersion(&level, filename);
2241 LoadLevel_InitElements(&level, filename);
2242 LoadLevel_InitPlayfield(&level, filename);
2244 LoadLevel_InitLevel(&level, filename);
2248 static void SaveLevel_VERS(FILE *file, struct LevelInfo *level)
2250 putFileVersion(file, level->file_version);
2251 putFileVersion(file, level->game_version);
2254 static void SaveLevel_HEAD(FILE *file, struct LevelInfo *level)
2258 putFile8Bit(file, level->fieldx);
2259 putFile8Bit(file, level->fieldy);
2261 putFile16BitBE(file, level->time);
2262 putFile16BitBE(file, level->gems_needed);
2264 for (i = 0; i < MAX_LEVEL_NAME_LEN; i++)
2265 putFile8Bit(file, level->name[i]);
2267 for (i = 0; i < LEVEL_SCORE_ELEMENTS; i++)
2268 putFile8Bit(file, level->score[i]);
2270 for (i = 0; i < STD_ELEMENT_CONTENTS; i++)
2271 for (y = 0; y < 3; y++)
2272 for (x = 0; x < 3; x++)
2273 putFile8Bit(file, (level->encoding_16bit_yamyam ? EL_EMPTY :
2274 level->yamyam_content[i][x][y]));
2275 putFile8Bit(file, level->amoeba_speed);
2276 putFile8Bit(file, level->time_magic_wall);
2277 putFile8Bit(file, level->time_wheel);
2278 putFile8Bit(file, (level->encoding_16bit_amoeba ? EL_EMPTY :
2279 level->amoeba_content));
2280 putFile8Bit(file, (level->double_speed ? 1 : 0));
2281 putFile8Bit(file, (level->initial_gravity ? 1 : 0));
2282 putFile8Bit(file, (level->encoding_16bit_field ? 1 : 0));
2283 putFile8Bit(file, (level->em_slippery_gems ? 1 : 0));
2285 putFile8Bit(file, (level->use_custom_template ? 1 : 0));
2287 putFile8Bit(file, (level->block_last_field ? 1 : 0));
2288 putFile8Bit(file, (level->sp_block_last_field ? 1 : 0));
2290 WriteUnusedBytesToFile(file, LEVEL_HEADER_UNUSED);
2293 static void SaveLevel_AUTH(FILE *file, struct LevelInfo *level)
2297 for (i = 0; i < MAX_LEVEL_AUTHOR_LEN; i++)
2298 putFile8Bit(file, level->author[i]);
2301 static void SaveLevel_BODY(FILE *file, struct LevelInfo *level)
2305 for (y = 0; y < level->fieldy; y++)
2306 for (x = 0; x < level->fieldx; x++)
2307 if (level->encoding_16bit_field)
2308 putFile16BitBE(file, level->field[x][y]);
2310 putFile8Bit(file, level->field[x][y]);
2314 static void SaveLevel_CONT(FILE *file, struct LevelInfo *level)
2318 putFile8Bit(file, EL_YAMYAM);
2319 putFile8Bit(file, level->num_yamyam_contents);
2320 putFile8Bit(file, 0);
2321 putFile8Bit(file, 0);
2323 for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
2324 for (y = 0; y < 3; y++)
2325 for (x = 0; x < 3; x++)
2326 if (level->encoding_16bit_field)
2327 putFile16BitBE(file, level->yamyam_content[i][x][y]);
2329 putFile8Bit(file, level->yamyam_content[i][x][y]);
2333 static void SaveLevel_CNT2(FILE *file, struct LevelInfo *level, int element)
2336 int num_contents, content_xsize, content_ysize;
2337 int content_array[MAX_ELEMENT_CONTENTS][3][3];
2339 if (element == EL_YAMYAM)
2341 num_contents = level->num_yamyam_contents;
2345 for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
2346 for (y = 0; y < 3; y++)
2347 for (x = 0; x < 3; x++)
2348 content_array[i][x][y] = level->yamyam_content[i][x][y];
2350 else if (element == EL_BD_AMOEBA)
2356 for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
2357 for (y = 0; y < 3; y++)
2358 for (x = 0; x < 3; x++)
2359 content_array[i][x][y] = EL_EMPTY;
2360 content_array[0][0][0] = level->amoeba_content;
2364 /* chunk header already written -- write empty chunk data */
2365 WriteUnusedBytesToFile(file, LEVEL_CHUNK_CNT2_SIZE);
2367 Error(ERR_WARN, "cannot save content for element '%d'", element);
2371 putFile16BitBE(file, element);
2372 putFile8Bit(file, num_contents);
2373 putFile8Bit(file, content_xsize);
2374 putFile8Bit(file, content_ysize);
2376 WriteUnusedBytesToFile(file, LEVEL_CHUNK_CNT2_UNUSED);
2378 for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
2379 for (y = 0; y < 3; y++)
2380 for (x = 0; x < 3; x++)
2381 putFile16BitBE(file, content_array[i][x][y]);
2384 static void SaveLevel_CNT3(FILE *file, struct LevelInfo *level, int element)
2387 int envelope_nr = element - EL_ENVELOPE_1;
2388 int envelope_len = strlen(level->envelope_text[envelope_nr]) + 1;
2390 putFile16BitBE(file, element);
2391 putFile16BitBE(file, envelope_len);
2392 putFile8Bit(file, level->envelope_xsize[envelope_nr]);
2393 putFile8Bit(file, level->envelope_ysize[envelope_nr]);
2395 WriteUnusedBytesToFile(file, LEVEL_CHUNK_CNT3_UNUSED);
2397 for (i = 0; i < envelope_len; i++)
2398 putFile8Bit(file, level->envelope_text[envelope_nr][i]);
2402 static void SaveLevel_CUS1(FILE *file, struct LevelInfo *level,
2403 int num_changed_custom_elements)
2407 putFile16BitBE(file, num_changed_custom_elements);
2409 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2411 int element = EL_CUSTOM_START + i;
2413 if (Properties[element][EP_BITFIELD_BASE] != EP_BITMASK_DEFAULT)
2415 if (check < num_changed_custom_elements)
2417 putFile16BitBE(file, element);
2418 putFile32BitBE(file, Properties[element][EP_BITFIELD_BASE]);
2425 if (check != num_changed_custom_elements) /* should not happen */
2426 Error(ERR_WARN, "inconsistent number of custom element properties");
2431 static void SaveLevel_CUS2(FILE *file, struct LevelInfo *level,
2432 int num_changed_custom_elements)
2436 putFile16BitBE(file, num_changed_custom_elements);
2438 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2440 int element = EL_CUSTOM_START + i;
2442 if (element_info[element].change->target_element != EL_EMPTY_SPACE)
2444 if (check < num_changed_custom_elements)
2446 putFile16BitBE(file, element);
2447 putFile16BitBE(file, element_info[element].change->target_element);
2454 if (check != num_changed_custom_elements) /* should not happen */
2455 Error(ERR_WARN, "inconsistent number of custom target elements");
2460 static void SaveLevel_CUS3(FILE *file, struct LevelInfo *level,
2461 int num_changed_custom_elements)
2463 int i, j, x, y, check = 0;
2465 putFile16BitBE(file, num_changed_custom_elements);
2467 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2469 int element = EL_CUSTOM_START + i;
2471 if (element_info[element].modified_settings)
2473 if (check < num_changed_custom_elements)
2475 putFile16BitBE(file, element);
2477 for (j = 0; j < MAX_ELEMENT_NAME_LEN; j++)
2478 putFile8Bit(file, element_info[element].description[j]);
2480 putFile32BitBE(file, Properties[element][EP_BITFIELD_BASE]);
2482 /* some free bytes for future properties and padding */
2483 WriteUnusedBytesToFile(file, 7);
2485 putFile8Bit(file, element_info[element].use_gfx_element);
2486 putFile16BitBE(file, element_info[element].gfx_element);
2488 putFile8Bit(file, element_info[element].collect_score);
2489 putFile8Bit(file, element_info[element].collect_count);
2491 putFile16BitBE(file, element_info[element].push_delay_fixed);
2492 putFile16BitBE(file, element_info[element].push_delay_random);
2493 putFile16BitBE(file, element_info[element].move_delay_fixed);
2494 putFile16BitBE(file, element_info[element].move_delay_random);
2496 putFile16BitBE(file, element_info[element].move_pattern);
2497 putFile8Bit(file, element_info[element].move_direction_initial);
2498 putFile8Bit(file, element_info[element].move_stepsize);
2500 for (y = 0; y < 3; y++)
2501 for (x = 0; x < 3; x++)
2502 putFile16BitBE(file, element_info[element].content[x][y]);
2504 putFile32BitBE(file, element_info[element].change->events);
2506 putFile16BitBE(file, element_info[element].change->target_element);
2508 putFile16BitBE(file, element_info[element].change->delay_fixed);
2509 putFile16BitBE(file, element_info[element].change->delay_random);
2510 putFile16BitBE(file, element_info[element].change->delay_frames);
2512 putFile16BitBE(file, element_info[element].change->trigger_element);
2514 putFile8Bit(file, element_info[element].change->explode);
2515 putFile8Bit(file, element_info[element].change->use_content);
2516 putFile8Bit(file, element_info[element].change->only_complete);
2517 putFile8Bit(file, element_info[element].change->use_random_change);
2519 putFile8Bit(file, element_info[element].change->random);
2520 putFile8Bit(file, element_info[element].change->power);
2522 for (y = 0; y < 3; y++)
2523 for (x = 0; x < 3; x++)
2524 putFile16BitBE(file, element_info[element].change->content[x][y]);
2526 putFile8Bit(file, element_info[element].slippery_type);
2528 /* some free bytes for future properties and padding */
2529 WriteUnusedBytesToFile(file, LEVEL_CPART_CUS3_UNUSED);
2536 if (check != num_changed_custom_elements) /* should not happen */
2537 Error(ERR_WARN, "inconsistent number of custom element properties");
2541 static void SaveLevel_CUS4(FILE *file, struct LevelInfo *level, int element)
2543 struct ElementInfo *ei = &element_info[element];
2546 putFile16BitBE(file, element);
2548 for (i = 0; i < MAX_ELEMENT_NAME_LEN; i++)
2549 putFile8Bit(file, ei->description[i]);
2551 putFile32BitBE(file, Properties[element][EP_BITFIELD_BASE]);
2552 WriteUnusedBytesToFile(file, 4); /* reserved for more base properties */
2554 putFile8Bit(file, ei->num_change_pages);
2556 /* some free bytes for future base property values and padding */
2557 WriteUnusedBytesToFile(file, 5);
2559 /* write custom property values */
2561 putFile8Bit(file, ei->use_gfx_element);
2562 putFile16BitBE(file, ei->gfx_element);
2564 putFile8Bit(file, ei->collect_score);
2565 putFile8Bit(file, ei->collect_count);
2567 putFile16BitBE(file, ei->push_delay_fixed);
2568 putFile16BitBE(file, ei->push_delay_random);
2569 putFile16BitBE(file, ei->move_delay_fixed);
2570 putFile16BitBE(file, ei->move_delay_random);
2572 /* bits 0 - 15 of "move_pattern" ... */
2573 putFile16BitBE(file, ei->move_pattern & 0xffff);
2574 putFile8Bit(file, ei->move_direction_initial);
2575 putFile8Bit(file, ei->move_stepsize);
2577 putFile8Bit(file, ei->slippery_type);
2579 for (y = 0; y < 3; y++)
2580 for (x = 0; x < 3; x++)
2581 putFile16BitBE(file, ei->content[x][y]);
2583 putFile16BitBE(file, ei->move_enter_element);
2584 putFile16BitBE(file, ei->move_leave_element);
2585 putFile8Bit(file, ei->move_leave_type);
2587 /* ... bits 16 - 31 of "move_pattern" (not nice, but downward compatible) */
2588 putFile16BitBE(file, (ei->move_pattern >> 16) & 0xffff);
2590 putFile8Bit(file, ei->access_direction);
2592 putFile8Bit(file, ei->explosion_delay);
2593 putFile8Bit(file, ei->ignition_delay);
2595 /* some free bytes for future custom property values and padding */
2596 WriteUnusedBytesToFile(file, 2);
2598 /* write change property values */
2600 for (i = 0; i < ei->num_change_pages; i++)
2602 struct ElementChangeInfo *change = &ei->change_page[i];
2604 putFile32BitBE(file, change->events);
2606 putFile16BitBE(file, change->target_element);
2608 putFile16BitBE(file, change->delay_fixed);
2609 putFile16BitBE(file, change->delay_random);
2610 putFile16BitBE(file, change->delay_frames);
2612 putFile16BitBE(file, change->trigger_element);
2614 putFile8Bit(file, change->explode);
2615 putFile8Bit(file, change->use_content);
2616 putFile8Bit(file, change->only_complete);
2617 putFile8Bit(file, change->use_random_change);
2619 putFile8Bit(file, change->random);
2620 putFile8Bit(file, change->power);
2622 for (y = 0; y < 3; y++)
2623 for (x = 0; x < 3; x++)
2624 putFile16BitBE(file, change->content[x][y]);
2626 putFile8Bit(file, change->can_change);
2628 putFile8Bit(file, change->sides);
2630 /* some free bytes for future change property values and padding */
2631 WriteUnusedBytesToFile(file, 8);
2635 static void SaveLevel_GRP1(FILE *file, struct LevelInfo *level, int element)
2637 struct ElementInfo *ei = &element_info[element];
2638 struct ElementGroupInfo *group = ei->group;
2641 putFile16BitBE(file, element);
2643 for (i = 0; i < MAX_ELEMENT_NAME_LEN; i++)
2644 putFile8Bit(file, ei->description[i]);
2646 putFile8Bit(file, group->num_elements);
2648 putFile8Bit(file, ei->use_gfx_element);
2649 putFile16BitBE(file, ei->gfx_element);
2651 putFile8Bit(file, group->choice_mode);
2653 /* some free bytes for future values and padding */
2654 WriteUnusedBytesToFile(file, 3);
2656 for (i = 0; i < MAX_ELEMENTS_IN_GROUP; i++)
2657 putFile16BitBE(file, group->element[i]);
2660 static void SaveLevelFromFilename(struct LevelInfo *level, char *filename)
2662 int body_chunk_size;
2666 if (!(file = fopen(filename, MODE_WRITE)))
2668 Error(ERR_WARN, "cannot save level file '%s'", filename);
2672 level->file_version = FILE_VERSION_ACTUAL;
2673 level->game_version = GAME_VERSION_ACTUAL;
2675 /* check level field for 16-bit elements */
2676 level->encoding_16bit_field = FALSE;
2677 for (y = 0; y < level->fieldy; y++)
2678 for (x = 0; x < level->fieldx; x++)
2679 if (level->field[x][y] > 255)
2680 level->encoding_16bit_field = TRUE;
2682 /* check yamyam content for 16-bit elements */
2683 level->encoding_16bit_yamyam = FALSE;
2684 for (i = 0; i < level->num_yamyam_contents; i++)
2685 for (y = 0; y < 3; y++)
2686 for (x = 0; x < 3; x++)
2687 if (level->yamyam_content[i][x][y] > 255)
2688 level->encoding_16bit_yamyam = TRUE;
2690 /* check amoeba content for 16-bit elements */
2691 level->encoding_16bit_amoeba = FALSE;
2692 if (level->amoeba_content > 255)
2693 level->encoding_16bit_amoeba = TRUE;
2695 /* calculate size of "BODY" chunk */
2697 level->fieldx * level->fieldy * (level->encoding_16bit_field ? 2 : 1);
2699 putFileChunkBE(file, "RND1", CHUNK_SIZE_UNDEFINED);
2700 putFileChunkBE(file, "CAVE", CHUNK_SIZE_NONE);
2702 putFileChunkBE(file, "VERS", FILE_VERS_CHUNK_SIZE);
2703 SaveLevel_VERS(file, level);
2705 putFileChunkBE(file, "HEAD", LEVEL_HEADER_SIZE);
2706 SaveLevel_HEAD(file, level);
2708 putFileChunkBE(file, "AUTH", MAX_LEVEL_AUTHOR_LEN);
2709 SaveLevel_AUTH(file, level);
2711 putFileChunkBE(file, "BODY", body_chunk_size);
2712 SaveLevel_BODY(file, level);
2714 if (level->encoding_16bit_yamyam ||
2715 level->num_yamyam_contents != STD_ELEMENT_CONTENTS)
2717 putFileChunkBE(file, "CNT2", LEVEL_CHUNK_CNT2_SIZE);
2718 SaveLevel_CNT2(file, level, EL_YAMYAM);
2721 if (level->encoding_16bit_amoeba)
2723 putFileChunkBE(file, "CNT2", LEVEL_CHUNK_CNT2_SIZE);
2724 SaveLevel_CNT2(file, level, EL_BD_AMOEBA);
2727 /* check for envelope content */
2728 for (i = 0; i < 4; i++)
2730 if (strlen(level->envelope_text[i]) > 0)
2732 int envelope_len = strlen(level->envelope_text[i]) + 1;
2734 putFileChunkBE(file, "CNT3", LEVEL_CHUNK_CNT3_SIZE(envelope_len));
2735 SaveLevel_CNT3(file, level, EL_ENVELOPE_1 + i);
2739 /* check for non-default custom elements (unless using template level) */
2740 if (!level->use_custom_template)
2742 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2744 int element = EL_CUSTOM_START + i;
2746 if (element_info[element].modified_settings)
2748 int num_change_pages = element_info[element].num_change_pages;
2750 putFileChunkBE(file, "CUS4", LEVEL_CHUNK_CUS4_SIZE(num_change_pages));
2751 SaveLevel_CUS4(file, level, element);
2756 /* check for non-default group elements (unless using template level) */
2757 if (!level->use_custom_template)
2759 for (i = 0; i < NUM_GROUP_ELEMENTS; i++)
2761 int element = EL_GROUP_START + i;
2763 if (element_info[element].modified_settings)
2765 putFileChunkBE(file, "GRP1", LEVEL_CHUNK_GRP1_SIZE);
2766 SaveLevel_GRP1(file, level, element);
2773 SetFilePermissions(filename, PERMS_PRIVATE);
2776 void SaveLevel(int nr)
2778 char *filename = getDefaultLevelFilename(nr);
2780 SaveLevelFromFilename(&level, filename);
2783 void SaveLevelTemplate()
2785 char *filename = getDefaultLevelFilename(-1);
2787 SaveLevelFromFilename(&level, filename);
2790 void DumpLevel(struct LevelInfo *level)
2792 printf_line("-", 79);
2793 printf("Level xxx (file version %08d, game version %08d)\n",
2794 level->file_version, level->game_version);
2795 printf_line("-", 79);
2797 printf("Level author: '%s'\n", level->author);
2798 printf("Level title: '%s'\n", level->name);
2800 printf("Playfield size: %d x %d\n", level->fieldx, level->fieldy);
2802 printf("Level time: %d seconds\n", level->time);
2803 printf("Gems needed: %d\n", level->gems_needed);
2805 printf("Time for magic wall: %d seconds\n", level->time_magic_wall);
2806 printf("Time for wheel: %d seconds\n", level->time_wheel);
2807 printf("Time for light: %d seconds\n", level->time_light);
2808 printf("Time for timegate: %d seconds\n", level->time_timegate);
2810 printf("Amoeba speed: %d\n", level->amoeba_speed);
2812 printf("Initial gravity: %s\n", (level->initial_gravity ? "yes" : "no"));
2813 printf("Double speed movement: %s\n", (level->double_speed ? "yes" : "no"));
2814 printf("EM style slippery gems: %s\n", (level->em_slippery_gems ? "yes" : "no"));
2815 printf("Player blocks last field: %s\n", (level->block_last_field ? "yes" : "no"));
2816 printf("SP player blocks last field: %s\n", (level->sp_block_last_field ? "yes" : "no"));
2818 printf_line("-", 79);
2822 /* ========================================================================= */
2823 /* tape file functions */
2824 /* ========================================================================= */
2826 static void setTapeInfoToDefaults()
2830 /* always start with reliable default values (empty tape) */
2833 /* default values (also for pre-1.2 tapes) with only the first player */
2834 tape.player_participates[0] = TRUE;
2835 for (i = 1; i < MAX_PLAYERS; i++)
2836 tape.player_participates[i] = FALSE;
2838 /* at least one (default: the first) player participates in every tape */
2839 tape.num_participating_players = 1;
2841 tape.level_nr = level_nr;
2843 tape.changed = FALSE;
2845 tape.recording = FALSE;
2846 tape.playing = FALSE;
2847 tape.pausing = FALSE;
2850 static int LoadTape_VERS(FILE *file, int chunk_size, struct TapeInfo *tape)
2852 tape->file_version = getFileVersion(file);
2853 tape->game_version = getFileVersion(file);
2858 static int LoadTape_HEAD(FILE *file, int chunk_size, struct TapeInfo *tape)
2862 tape->random_seed = getFile32BitBE(file);
2863 tape->date = getFile32BitBE(file);
2864 tape->length = getFile32BitBE(file);
2866 /* read header fields that are new since version 1.2 */
2867 if (tape->file_version >= FILE_VERSION_1_2)
2869 byte store_participating_players = getFile8Bit(file);
2872 /* since version 1.2, tapes store which players participate in the tape */
2873 tape->num_participating_players = 0;
2874 for (i = 0; i < MAX_PLAYERS; i++)
2876 tape->player_participates[i] = FALSE;
2878 if (store_participating_players & (1 << i))
2880 tape->player_participates[i] = TRUE;
2881 tape->num_participating_players++;
2885 ReadUnusedBytesFromFile(file, TAPE_HEADER_UNUSED);
2887 engine_version = getFileVersion(file);
2888 if (engine_version > 0)
2889 tape->engine_version = engine_version;
2891 tape->engine_version = tape->game_version;
2897 static int LoadTape_INFO(FILE *file, int chunk_size, struct TapeInfo *tape)
2899 int level_identifier_size;
2902 level_identifier_size = getFile16BitBE(file);
2904 tape->level_identifier =
2905 checked_realloc(tape->level_identifier, level_identifier_size);
2907 for (i = 0; i < level_identifier_size; i++)
2908 tape->level_identifier[i] = getFile8Bit(file);
2910 tape->level_nr = getFile16BitBE(file);
2912 chunk_size = 2 + level_identifier_size + 2;
2917 static int LoadTape_BODY(FILE *file, int chunk_size, struct TapeInfo *tape)
2920 int chunk_size_expected =
2921 (tape->num_participating_players + 1) * tape->length;
2923 if (chunk_size_expected != chunk_size)
2925 ReadUnusedBytesFromFile(file, chunk_size);
2926 return chunk_size_expected;
2929 for (i = 0; i < tape->length; i++)
2931 if (i >= MAX_TAPELEN)
2934 for (j = 0; j < MAX_PLAYERS; j++)
2936 tape->pos[i].action[j] = MV_NO_MOVING;
2938 if (tape->player_participates[j])
2939 tape->pos[i].action[j] = getFile8Bit(file);
2942 tape->pos[i].delay = getFile8Bit(file);
2944 if (tape->file_version == FILE_VERSION_1_0)
2946 /* eliminate possible diagonal moves in old tapes */
2947 /* this is only for backward compatibility */
2949 byte joy_dir[4] = { JOY_LEFT, JOY_RIGHT, JOY_UP, JOY_DOWN };
2950 byte action = tape->pos[i].action[0];
2951 int k, num_moves = 0;
2953 for (k = 0; k<4; k++)
2955 if (action & joy_dir[k])
2957 tape->pos[i + num_moves].action[0] = joy_dir[k];
2959 tape->pos[i + num_moves].delay = 0;
2968 tape->length += num_moves;
2971 else if (tape->file_version < FILE_VERSION_2_0)
2973 /* convert pre-2.0 tapes to new tape format */
2975 if (tape->pos[i].delay > 1)
2978 tape->pos[i + 1] = tape->pos[i];
2979 tape->pos[i + 1].delay = 1;
2982 for (j = 0; j < MAX_PLAYERS; j++)
2983 tape->pos[i].action[j] = MV_NO_MOVING;
2984 tape->pos[i].delay--;
2995 if (i != tape->length)
2996 chunk_size = (tape->num_participating_players + 1) * i;
3001 void LoadTapeFromFilename(char *filename)
3003 char cookie[MAX_LINE_LEN];
3004 char chunk_name[CHUNK_ID_LEN + 1];
3008 /* always start with reliable default values */
3009 setTapeInfoToDefaults();
3011 if (!(file = fopen(filename, MODE_READ)))
3014 getFileChunkBE(file, chunk_name, NULL);
3015 if (strcmp(chunk_name, "RND1") == 0)
3017 getFile32BitBE(file); /* not used */
3019 getFileChunkBE(file, chunk_name, NULL);
3020 if (strcmp(chunk_name, "TAPE") != 0)
3022 Error(ERR_WARN, "unknown format of tape file '%s'", filename);
3027 else /* check for pre-2.0 file format with cookie string */
3029 strcpy(cookie, chunk_name);
3030 fgets(&cookie[4], MAX_LINE_LEN - 4, file);
3031 if (strlen(cookie) > 0 && cookie[strlen(cookie) - 1] == '\n')
3032 cookie[strlen(cookie) - 1] = '\0';
3034 if (!checkCookieString(cookie, TAPE_COOKIE_TMPL))
3036 Error(ERR_WARN, "unknown format of tape file '%s'", filename);
3041 if ((tape.file_version = getFileVersionFromCookieString(cookie)) == -1)
3043 Error(ERR_WARN, "unsupported version of tape file '%s'", filename);
3048 /* pre-2.0 tape files have no game version, so use file version here */
3049 tape.game_version = tape.file_version;
3052 if (tape.file_version < FILE_VERSION_1_2)
3054 /* tape files from versions before 1.2.0 without chunk structure */
3055 LoadTape_HEAD(file, TAPE_HEADER_SIZE, &tape);
3056 LoadTape_BODY(file, 2 * tape.length, &tape);
3064 int (*loader)(FILE *, int, struct TapeInfo *);
3068 { "VERS", FILE_VERS_CHUNK_SIZE, LoadTape_VERS },
3069 { "HEAD", TAPE_HEADER_SIZE, LoadTape_HEAD },
3070 { "INFO", -1, LoadTape_INFO },
3071 { "BODY", -1, LoadTape_BODY },
3075 while (getFileChunkBE(file, chunk_name, &chunk_size))
3079 while (chunk_info[i].name != NULL &&
3080 strcmp(chunk_name, chunk_info[i].name) != 0)
3083 if (chunk_info[i].name == NULL)
3085 Error(ERR_WARN, "unknown chunk '%s' in tape file '%s'",
3086 chunk_name, filename);
3087 ReadUnusedBytesFromFile(file, chunk_size);
3089 else if (chunk_info[i].size != -1 &&
3090 chunk_info[i].size != chunk_size)
3092 Error(ERR_WARN, "wrong size (%d) of chunk '%s' in tape file '%s'",
3093 chunk_size, chunk_name, filename);
3094 ReadUnusedBytesFromFile(file, chunk_size);
3098 /* call function to load this tape chunk */
3099 int chunk_size_expected =
3100 (chunk_info[i].loader)(file, chunk_size, &tape);
3102 /* the size of some chunks cannot be checked before reading other
3103 chunks first (like "HEAD" and "BODY") that contain some header
3104 information, so check them here */
3105 if (chunk_size_expected != chunk_size)
3107 Error(ERR_WARN, "wrong size (%d) of chunk '%s' in tape file '%s'",
3108 chunk_size, chunk_name, filename);
3116 tape.length_seconds = GetTapeLength();
3119 printf("::: tape game version: %d\n", tape.game_version);
3120 printf("::: tape engine version: %d\n", tape.engine_version);
3124 void LoadTape(int nr)
3126 char *filename = getTapeFilename(nr);
3128 LoadTapeFromFilename(filename);
3131 void LoadSolutionTape(int nr)
3133 char *filename = getSolutionTapeFilename(nr);
3135 LoadTapeFromFilename(filename);
3138 static void SaveTape_VERS(FILE *file, struct TapeInfo *tape)
3140 putFileVersion(file, tape->file_version);
3141 putFileVersion(file, tape->game_version);
3144 static void SaveTape_HEAD(FILE *file, struct TapeInfo *tape)
3147 byte store_participating_players = 0;
3149 /* set bits for participating players for compact storage */
3150 for (i = 0; i < MAX_PLAYERS; i++)
3151 if (tape->player_participates[i])
3152 store_participating_players |= (1 << i);
3154 putFile32BitBE(file, tape->random_seed);
3155 putFile32BitBE(file, tape->date);
3156 putFile32BitBE(file, tape->length);
3158 putFile8Bit(file, store_participating_players);
3160 /* unused bytes not at the end here for 4-byte alignment of engine_version */
3161 WriteUnusedBytesToFile(file, TAPE_HEADER_UNUSED);
3163 putFileVersion(file, tape->engine_version);
3166 static void SaveTape_INFO(FILE *file, struct TapeInfo *tape)
3168 int level_identifier_size = strlen(tape->level_identifier) + 1;
3171 putFile16BitBE(file, level_identifier_size);
3173 for (i = 0; i < level_identifier_size; i++)
3174 putFile8Bit(file, tape->level_identifier[i]);
3176 putFile16BitBE(file, tape->level_nr);
3179 static void SaveTape_BODY(FILE *file, struct TapeInfo *tape)
3183 for (i = 0; i < tape->length; i++)
3185 for (j = 0; j < MAX_PLAYERS; j++)
3186 if (tape->player_participates[j])
3187 putFile8Bit(file, tape->pos[i].action[j]);
3189 putFile8Bit(file, tape->pos[i].delay);
3193 void SaveTape(int nr)
3195 char *filename = getTapeFilename(nr);
3197 boolean new_tape = TRUE;
3198 int num_participating_players = 0;
3199 int info_chunk_size;
3200 int body_chunk_size;
3203 InitTapeDirectory(leveldir_current->subdir);
3205 /* if a tape still exists, ask to overwrite it */
3206 if (access(filename, F_OK) == 0)
3209 if (!Request("Replace old tape ?", REQ_ASK))
3213 if (!(file = fopen(filename, MODE_WRITE)))
3215 Error(ERR_WARN, "cannot save level recording file '%s'", filename);
3219 tape.file_version = FILE_VERSION_ACTUAL;
3220 tape.game_version = GAME_VERSION_ACTUAL;
3222 /* count number of participating players */
3223 for (i = 0; i < MAX_PLAYERS; i++)
3224 if (tape.player_participates[i])
3225 num_participating_players++;
3227 info_chunk_size = 2 + (strlen(tape.level_identifier) + 1) + 2;
3228 body_chunk_size = (num_participating_players + 1) * tape.length;
3230 putFileChunkBE(file, "RND1", CHUNK_SIZE_UNDEFINED);
3231 putFileChunkBE(file, "TAPE", CHUNK_SIZE_NONE);
3233 putFileChunkBE(file, "VERS", FILE_VERS_CHUNK_SIZE);
3234 SaveTape_VERS(file, &tape);
3236 putFileChunkBE(file, "HEAD", TAPE_HEADER_SIZE);
3237 SaveTape_HEAD(file, &tape);
3239 putFileChunkBE(file, "INFO", info_chunk_size);
3240 SaveTape_INFO(file, &tape);
3242 putFileChunkBE(file, "BODY", body_chunk_size);
3243 SaveTape_BODY(file, &tape);
3247 SetFilePermissions(filename, PERMS_PRIVATE);
3249 tape.changed = FALSE;
3252 Request("tape saved !", REQ_CONFIRM);
3255 void DumpTape(struct TapeInfo *tape)
3259 if (TAPE_IS_EMPTY(*tape))
3261 Error(ERR_WARN, "no tape available for level %d", tape->level_nr);
3265 printf_line("-", 79);
3266 printf("Tape of Level %03d (file version %08d, game version %08d)\n",
3267 tape->level_nr, tape->file_version, tape->game_version);
3268 printf("Level series identifier: '%s'\n", tape->level_identifier);
3269 printf_line("-", 79);
3271 for (i = 0; i < tape->length; i++)
3273 if (i >= MAX_TAPELEN)
3276 printf("%03d: ", i);
3278 for (j = 0; j < MAX_PLAYERS; j++)
3280 if (tape->player_participates[j])
3282 int action = tape->pos[i].action[j];
3284 printf("%d:%02x ", j, action);
3285 printf("[%c%c%c%c|%c%c] - ",
3286 (action & JOY_LEFT ? '<' : ' '),
3287 (action & JOY_RIGHT ? '>' : ' '),
3288 (action & JOY_UP ? '^' : ' '),
3289 (action & JOY_DOWN ? 'v' : ' '),
3290 (action & JOY_BUTTON_1 ? '1' : ' '),
3291 (action & JOY_BUTTON_2 ? '2' : ' '));
3295 printf("(%03d)\n", tape->pos[i].delay);
3298 printf_line("-", 79);
3302 /* ========================================================================= */
3303 /* score file functions */
3304 /* ========================================================================= */
3306 void LoadScore(int nr)
3309 char *filename = getScoreFilename(nr);
3310 char cookie[MAX_LINE_LEN];
3311 char line[MAX_LINE_LEN];
3315 /* always start with reliable default values */
3316 for (i = 0; i < MAX_SCORE_ENTRIES; i++)
3318 strcpy(highscore[i].Name, EMPTY_PLAYER_NAME);
3319 highscore[i].Score = 0;
3322 if (!(file = fopen(filename, MODE_READ)))
3325 /* check file identifier */
3326 fgets(cookie, MAX_LINE_LEN, file);
3327 if (strlen(cookie) > 0 && cookie[strlen(cookie) - 1] == '\n')
3328 cookie[strlen(cookie) - 1] = '\0';
3330 if (!checkCookieString(cookie, SCORE_COOKIE))
3332 Error(ERR_WARN, "unknown format of score file '%s'", filename);
3337 for (i = 0; i < MAX_SCORE_ENTRIES; i++)
3339 fscanf(file, "%d", &highscore[i].Score);
3340 fgets(line, MAX_LINE_LEN, file);
3342 if (line[strlen(line) - 1] == '\n')
3343 line[strlen(line) - 1] = '\0';
3345 for (line_ptr = line; *line_ptr; line_ptr++)
3347 if (*line_ptr != ' ' && *line_ptr != '\t' && *line_ptr != '\0')
3349 strncpy(highscore[i].Name, line_ptr, MAX_PLAYER_NAME_LEN);
3350 highscore[i].Name[MAX_PLAYER_NAME_LEN] = '\0';
3359 void SaveScore(int nr)
3362 char *filename = getScoreFilename(nr);
3365 InitScoreDirectory(leveldir_current->subdir);
3367 if (!(file = fopen(filename, MODE_WRITE)))
3369 Error(ERR_WARN, "cannot save score for level %d", nr);
3373 fprintf(file, "%s\n\n", SCORE_COOKIE);
3375 for (i = 0; i < MAX_SCORE_ENTRIES; i++)
3376 fprintf(file, "%d %s\n", highscore[i].Score, highscore[i].Name);
3380 SetFilePermissions(filename, PERMS_PUBLIC);
3384 /* ========================================================================= */
3385 /* setup file functions */
3386 /* ========================================================================= */
3388 #define TOKEN_STR_PLAYER_PREFIX "player_"
3391 #define SETUP_TOKEN_PLAYER_NAME 0
3392 #define SETUP_TOKEN_SOUND 1
3393 #define SETUP_TOKEN_SOUND_LOOPS 2
3394 #define SETUP_TOKEN_SOUND_MUSIC 3
3395 #define SETUP_TOKEN_SOUND_SIMPLE 4
3396 #define SETUP_TOKEN_TOONS 5
3397 #define SETUP_TOKEN_SCROLL_DELAY 6
3398 #define SETUP_TOKEN_SOFT_SCROLLING 7
3399 #define SETUP_TOKEN_FADING 8
3400 #define SETUP_TOKEN_AUTORECORD 9
3401 #define SETUP_TOKEN_QUICK_DOORS 10
3402 #define SETUP_TOKEN_TEAM_MODE 11
3403 #define SETUP_TOKEN_HANDICAP 12
3404 #define SETUP_TOKEN_TIME_LIMIT 13
3405 #define SETUP_TOKEN_FULLSCREEN 14
3406 #define SETUP_TOKEN_ASK_ON_ESCAPE 15
3407 #define SETUP_TOKEN_GRAPHICS_SET 16
3408 #define SETUP_TOKEN_SOUNDS_SET 17
3409 #define SETUP_TOKEN_MUSIC_SET 18
3410 #define SETUP_TOKEN_OVERRIDE_LEVEL_GRAPHICS 19
3411 #define SETUP_TOKEN_OVERRIDE_LEVEL_SOUNDS 20
3412 #define SETUP_TOKEN_OVERRIDE_LEVEL_MUSIC 21
3414 #define NUM_GLOBAL_SETUP_TOKENS 22
3417 #define SETUP_TOKEN_EDITOR_EL_BOULDERDASH 0
3418 #define SETUP_TOKEN_EDITOR_EL_EMERALD_MINE 1
3419 #define SETUP_TOKEN_EDITOR_EL_MORE 2
3420 #define SETUP_TOKEN_EDITOR_EL_SOKOBAN 3
3421 #define SETUP_TOKEN_EDITOR_EL_SUPAPLEX 4
3422 #define SETUP_TOKEN_EDITOR_EL_DIAMOND_CAVES 5
3423 #define SETUP_TOKEN_EDITOR_EL_DX_BOULDERDASH 6
3424 #define SETUP_TOKEN_EDITOR_EL_CHARS 7
3425 #define SETUP_TOKEN_EDITOR_EL_CUSTOM 8
3426 #define SETUP_TOKEN_EDITOR_EL_CUSTOM_MORE 9
3427 #define SETUP_TOKEN_EDITOR_EL_HEADLINES 10
3428 #define SETUP_TOKEN_EDITOR_EL_USER_DEFINED 11
3430 #define NUM_EDITOR_SETUP_TOKENS 12
3432 /* shortcut setup */
3433 #define SETUP_TOKEN_SHORTCUT_SAVE_GAME 0
3434 #define SETUP_TOKEN_SHORTCUT_LOAD_GAME 1
3435 #define SETUP_TOKEN_SHORTCUT_TOGGLE_PAUSE 2
3437 #define NUM_SHORTCUT_SETUP_TOKENS 3
3440 #define SETUP_TOKEN_PLAYER_USE_JOYSTICK 0
3441 #define SETUP_TOKEN_PLAYER_JOY_DEVICE_NAME 1
3442 #define SETUP_TOKEN_PLAYER_JOY_XLEFT 2
3443 #define SETUP_TOKEN_PLAYER_JOY_XMIDDLE 3
3444 #define SETUP_TOKEN_PLAYER_JOY_XRIGHT 4
3445 #define SETUP_TOKEN_PLAYER_JOY_YUPPER 5
3446 #define SETUP_TOKEN_PLAYER_JOY_YMIDDLE 6
3447 #define SETUP_TOKEN_PLAYER_JOY_YLOWER 7
3448 #define SETUP_TOKEN_PLAYER_JOY_SNAP 8
3449 #define SETUP_TOKEN_PLAYER_JOY_DROP 9
3450 #define SETUP_TOKEN_PLAYER_KEY_LEFT 10
3451 #define SETUP_TOKEN_PLAYER_KEY_RIGHT 11
3452 #define SETUP_TOKEN_PLAYER_KEY_UP 12
3453 #define SETUP_TOKEN_PLAYER_KEY_DOWN 13
3454 #define SETUP_TOKEN_PLAYER_KEY_SNAP 14
3455 #define SETUP_TOKEN_PLAYER_KEY_DROP 15
3457 #define NUM_PLAYER_SETUP_TOKENS 16
3460 #define SETUP_TOKEN_SYSTEM_SDL_AUDIODRIVER 0
3461 #define SETUP_TOKEN_SYSTEM_AUDIO_FRAGMENT_SIZE 1
3463 #define NUM_SYSTEM_SETUP_TOKENS 2
3466 #define SETUP_TOKEN_OPTIONS_VERBOSE 0
3468 #define NUM_OPTIONS_SETUP_TOKENS 1
3471 static struct SetupInfo si;
3472 static struct SetupEditorInfo sei;
3473 static struct SetupShortcutInfo ssi;
3474 static struct SetupInputInfo sii;
3475 static struct SetupSystemInfo syi;
3476 static struct OptionInfo soi;
3478 static struct TokenInfo global_setup_tokens[] =
3480 { TYPE_STRING, &si.player_name, "player_name" },
3481 { TYPE_SWITCH, &si.sound, "sound" },
3482 { TYPE_SWITCH, &si.sound_loops, "repeating_sound_loops" },
3483 { TYPE_SWITCH, &si.sound_music, "background_music" },
3484 { TYPE_SWITCH, &si.sound_simple, "simple_sound_effects" },
3485 { TYPE_SWITCH, &si.toons, "toons" },
3486 { TYPE_SWITCH, &si.scroll_delay, "scroll_delay" },
3487 { TYPE_SWITCH, &si.soft_scrolling, "soft_scrolling" },
3488 { TYPE_SWITCH, &si.fading, "screen_fading" },
3489 { TYPE_SWITCH, &si.autorecord, "automatic_tape_recording" },
3490 { TYPE_SWITCH, &si.quick_doors, "quick_doors" },
3491 { TYPE_SWITCH, &si.team_mode, "team_mode" },
3492 { TYPE_SWITCH, &si.handicap, "handicap" },
3493 { TYPE_SWITCH, &si.time_limit, "time_limit" },
3494 { TYPE_SWITCH, &si.fullscreen, "fullscreen" },
3495 { TYPE_SWITCH, &si.ask_on_escape, "ask_on_escape" },
3496 { TYPE_STRING, &si.graphics_set, "graphics_set" },
3497 { TYPE_STRING, &si.sounds_set, "sounds_set" },
3498 { TYPE_STRING, &si.music_set, "music_set" },
3499 { TYPE_SWITCH, &si.override_level_graphics, "override_level_graphics" },
3500 { TYPE_SWITCH, &si.override_level_sounds, "override_level_sounds" },
3501 { TYPE_SWITCH, &si.override_level_music, "override_level_music" },
3504 static struct TokenInfo editor_setup_tokens[] =
3506 { TYPE_SWITCH, &sei.el_boulderdash, "editor.el_boulderdash" },
3507 { TYPE_SWITCH, &sei.el_emerald_mine, "editor.el_emerald_mine" },
3508 { TYPE_SWITCH, &sei.el_more, "editor.el_more" },
3509 { TYPE_SWITCH, &sei.el_sokoban, "editor.el_sokoban" },
3510 { TYPE_SWITCH, &sei.el_supaplex, "editor.el_supaplex" },
3511 { TYPE_SWITCH, &sei.el_diamond_caves, "editor.el_diamond_caves" },
3512 { TYPE_SWITCH, &sei.el_dx_boulderdash,"editor.el_dx_boulderdash" },
3513 { TYPE_SWITCH, &sei.el_chars, "editor.el_chars" },
3514 { TYPE_SWITCH, &sei.el_custom, "editor.el_custom" },
3515 { TYPE_SWITCH, &sei.el_custom_more, "editor.el_custom_more" },
3516 { TYPE_SWITCH, &sei.el_headlines, "editor.el_headlines" },
3517 { TYPE_SWITCH, &sei.el_user_defined, "editor.el_user_defined" },
3520 static struct TokenInfo shortcut_setup_tokens[] =
3522 { TYPE_KEY_X11, &ssi.save_game, "shortcut.save_game" },
3523 { TYPE_KEY_X11, &ssi.load_game, "shortcut.load_game" },
3524 { TYPE_KEY_X11, &ssi.toggle_pause, "shortcut.toggle_pause" }
3527 static struct TokenInfo player_setup_tokens[] =
3529 { TYPE_BOOLEAN, &sii.use_joystick, ".use_joystick" },
3530 { TYPE_STRING, &sii.joy.device_name, ".joy.device_name" },
3531 { TYPE_INTEGER, &sii.joy.xleft, ".joy.xleft" },
3532 { TYPE_INTEGER, &sii.joy.xmiddle, ".joy.xmiddle" },
3533 { TYPE_INTEGER, &sii.joy.xright, ".joy.xright" },
3534 { TYPE_INTEGER, &sii.joy.yupper, ".joy.yupper" },
3535 { TYPE_INTEGER, &sii.joy.ymiddle, ".joy.ymiddle" },
3536 { TYPE_INTEGER, &sii.joy.ylower, ".joy.ylower" },
3537 { TYPE_INTEGER, &sii.joy.snap, ".joy.snap_field" },
3538 { TYPE_INTEGER, &sii.joy.drop, ".joy.place_bomb" },
3539 { TYPE_KEY_X11, &sii.key.left, ".key.move_left" },
3540 { TYPE_KEY_X11, &sii.key.right, ".key.move_right" },
3541 { TYPE_KEY_X11, &sii.key.up, ".key.move_up" },
3542 { TYPE_KEY_X11, &sii.key.down, ".key.move_down" },
3543 { TYPE_KEY_X11, &sii.key.snap, ".key.snap_field" },
3544 { TYPE_KEY_X11, &sii.key.drop, ".key.place_bomb" }
3547 static struct TokenInfo system_setup_tokens[] =
3549 { TYPE_STRING, &syi.sdl_audiodriver, "system.sdl_audiodriver" },
3550 { TYPE_INTEGER, &syi.audio_fragment_size,"system.audio_fragment_size" }
3553 static struct TokenInfo options_setup_tokens[] =
3555 { TYPE_BOOLEAN, &soi.verbose, "options.verbose" }
3558 static char *get_corrected_login_name(char *login_name)
3560 /* needed because player name must be a fixed length string */
3561 char *login_name_new = checked_malloc(MAX_PLAYER_NAME_LEN + 1);
3563 strncpy(login_name_new, login_name, MAX_PLAYER_NAME_LEN);
3564 login_name_new[MAX_PLAYER_NAME_LEN] = '\0';
3566 if (strlen(login_name) > MAX_PLAYER_NAME_LEN) /* name has been cut */
3567 if (strchr(login_name_new, ' '))
3568 *strchr(login_name_new, ' ') = '\0';
3570 return login_name_new;
3573 static void setSetupInfoToDefaults(struct SetupInfo *si)
3577 si->player_name = get_corrected_login_name(getLoginName());
3580 si->sound_loops = TRUE;
3581 si->sound_music = TRUE;
3582 si->sound_simple = TRUE;
3584 si->double_buffering = TRUE;
3585 si->direct_draw = !si->double_buffering;
3586 si->scroll_delay = TRUE;
3587 si->soft_scrolling = TRUE;
3589 si->autorecord = TRUE;
3590 si->quick_doors = FALSE;
3591 si->team_mode = FALSE;
3592 si->handicap = TRUE;
3593 si->time_limit = TRUE;
3594 si->fullscreen = FALSE;
3595 si->ask_on_escape = TRUE;
3597 si->graphics_set = getStringCopy(GFX_CLASSIC_SUBDIR);
3598 si->sounds_set = getStringCopy(SND_CLASSIC_SUBDIR);
3599 si->music_set = getStringCopy(MUS_CLASSIC_SUBDIR);
3600 si->override_level_graphics = FALSE;
3601 si->override_level_sounds = FALSE;
3602 si->override_level_music = FALSE;
3604 si->editor.el_boulderdash = TRUE;
3605 si->editor.el_emerald_mine = TRUE;
3606 si->editor.el_more = TRUE;
3607 si->editor.el_sokoban = TRUE;
3608 si->editor.el_supaplex = TRUE;
3609 si->editor.el_diamond_caves = TRUE;
3610 si->editor.el_dx_boulderdash = TRUE;
3611 si->editor.el_chars = TRUE;
3612 si->editor.el_custom = TRUE;
3613 si->editor.el_custom_more = FALSE;
3615 si->editor.el_headlines = TRUE;
3616 si->editor.el_user_defined = FALSE;
3618 si->shortcut.save_game = DEFAULT_KEY_SAVE_GAME;
3619 si->shortcut.load_game = DEFAULT_KEY_LOAD_GAME;
3620 si->shortcut.toggle_pause = DEFAULT_KEY_TOGGLE_PAUSE;
3622 for (i = 0; i < MAX_PLAYERS; i++)
3624 si->input[i].use_joystick = FALSE;
3625 si->input[i].joy.device_name=getStringCopy(getDeviceNameFromJoystickNr(i));
3626 si->input[i].joy.xleft = JOYSTICK_XLEFT;
3627 si->input[i].joy.xmiddle = JOYSTICK_XMIDDLE;
3628 si->input[i].joy.xright = JOYSTICK_XRIGHT;
3629 si->input[i].joy.yupper = JOYSTICK_YUPPER;
3630 si->input[i].joy.ymiddle = JOYSTICK_YMIDDLE;
3631 si->input[i].joy.ylower = JOYSTICK_YLOWER;
3632 si->input[i].joy.snap = (i == 0 ? JOY_BUTTON_1 : 0);
3633 si->input[i].joy.drop = (i == 0 ? JOY_BUTTON_2 : 0);
3634 si->input[i].key.left = (i == 0 ? DEFAULT_KEY_LEFT : KSYM_UNDEFINED);
3635 si->input[i].key.right = (i == 0 ? DEFAULT_KEY_RIGHT : KSYM_UNDEFINED);
3636 si->input[i].key.up = (i == 0 ? DEFAULT_KEY_UP : KSYM_UNDEFINED);
3637 si->input[i].key.down = (i == 0 ? DEFAULT_KEY_DOWN : KSYM_UNDEFINED);
3638 si->input[i].key.snap = (i == 0 ? DEFAULT_KEY_SNAP : KSYM_UNDEFINED);
3639 si->input[i].key.drop = (i == 0 ? DEFAULT_KEY_DROP : KSYM_UNDEFINED);
3642 si->system.sdl_audiodriver = getStringCopy(ARG_DEFAULT);
3643 si->system.audio_fragment_size = DEFAULT_AUDIO_FRAGMENT_SIZE;
3645 si->options.verbose = FALSE;
3648 static void decodeSetupFileHash(SetupFileHash *setup_file_hash)
3652 if (!setup_file_hash)
3657 for (i = 0; i < NUM_GLOBAL_SETUP_TOKENS; i++)
3658 setSetupInfo(global_setup_tokens, i,
3659 getHashEntry(setup_file_hash, global_setup_tokens[i].text));
3664 for (i = 0; i < NUM_EDITOR_SETUP_TOKENS; i++)
3665 setSetupInfo(editor_setup_tokens, i,
3666 getHashEntry(setup_file_hash,editor_setup_tokens[i].text));
3669 /* shortcut setup */
3670 ssi = setup.shortcut;
3671 for (i = 0; i < NUM_SHORTCUT_SETUP_TOKENS; i++)
3672 setSetupInfo(shortcut_setup_tokens, i,
3673 getHashEntry(setup_file_hash,shortcut_setup_tokens[i].text));
3674 setup.shortcut = ssi;
3677 for (pnr = 0; pnr < MAX_PLAYERS; pnr++)
3681 sprintf(prefix, "%s%d", TOKEN_STR_PLAYER_PREFIX, pnr + 1);
3683 sii = setup.input[pnr];
3684 for (i = 0; i < NUM_PLAYER_SETUP_TOKENS; i++)
3686 char full_token[100];
3688 sprintf(full_token, "%s%s", prefix, player_setup_tokens[i].text);
3689 setSetupInfo(player_setup_tokens, i,
3690 getHashEntry(setup_file_hash, full_token));
3692 setup.input[pnr] = sii;
3697 for (i = 0; i < NUM_SYSTEM_SETUP_TOKENS; i++)
3698 setSetupInfo(system_setup_tokens, i,
3699 getHashEntry(setup_file_hash, system_setup_tokens[i].text));
3703 soi = setup.options;
3704 for (i = 0; i < NUM_OPTIONS_SETUP_TOKENS; i++)
3705 setSetupInfo(options_setup_tokens, i,
3706 getHashEntry(setup_file_hash, options_setup_tokens[i].text));
3707 setup.options = soi;
3712 char *filename = getSetupFilename();
3713 SetupFileHash *setup_file_hash = NULL;
3715 /* always start with reliable default values */
3716 setSetupInfoToDefaults(&setup);
3718 setup_file_hash = loadSetupFileHash(filename);
3720 if (setup_file_hash)
3722 char *player_name_new;
3724 checkSetupFileHashIdentifier(setup_file_hash, getCookie("SETUP"));
3725 decodeSetupFileHash(setup_file_hash);
3727 setup.direct_draw = !setup.double_buffering;
3729 freeSetupFileHash(setup_file_hash);
3731 /* needed to work around problems with fixed length strings */
3732 player_name_new = get_corrected_login_name(setup.player_name);
3733 free(setup.player_name);
3734 setup.player_name = player_name_new;
3737 Error(ERR_WARN, "using default setup values");
3742 char *filename = getSetupFilename();
3746 InitUserDataDirectory();
3748 if (!(file = fopen(filename, MODE_WRITE)))
3750 Error(ERR_WARN, "cannot write setup file '%s'", filename);
3754 fprintf(file, "%s\n", getFormattedSetupEntry(TOKEN_STR_FILE_IDENTIFIER,
3755 getCookie("SETUP")));
3756 fprintf(file, "\n");
3760 for (i = 0; i < NUM_GLOBAL_SETUP_TOKENS; i++)
3762 /* just to make things nicer :) */
3763 if (i == SETUP_TOKEN_PLAYER_NAME + 1 ||
3764 i == SETUP_TOKEN_GRAPHICS_SET)
3765 fprintf(file, "\n");
3767 fprintf(file, "%s\n", getSetupLine(global_setup_tokens, "", i));
3772 fprintf(file, "\n");
3773 for (i = 0; i < NUM_EDITOR_SETUP_TOKENS; i++)
3774 fprintf(file, "%s\n", getSetupLine(editor_setup_tokens, "", i));
3776 /* shortcut setup */
3777 ssi = setup.shortcut;
3778 fprintf(file, "\n");
3779 for (i = 0; i < NUM_SHORTCUT_SETUP_TOKENS; i++)
3780 fprintf(file, "%s\n", getSetupLine(shortcut_setup_tokens, "", i));
3783 for (pnr = 0; pnr < MAX_PLAYERS; pnr++)
3787 sprintf(prefix, "%s%d", TOKEN_STR_PLAYER_PREFIX, pnr + 1);
3788 fprintf(file, "\n");
3790 sii = setup.input[pnr];
3791 for (i = 0; i < NUM_PLAYER_SETUP_TOKENS; i++)
3792 fprintf(file, "%s\n", getSetupLine(player_setup_tokens, prefix, i));
3797 fprintf(file, "\n");
3798 for (i = 0; i < NUM_SYSTEM_SETUP_TOKENS; i++)
3799 fprintf(file, "%s\n", getSetupLine(system_setup_tokens, "", i));
3802 soi = setup.options;
3803 fprintf(file, "\n");
3804 for (i = 0; i < NUM_OPTIONS_SETUP_TOKENS; i++)
3805 fprintf(file, "%s\n", getSetupLine(options_setup_tokens, "", i));
3809 SetFilePermissions(filename, PERMS_PRIVATE);
3812 void LoadCustomElementDescriptions()
3814 char *filename = getCustomArtworkConfigFilename(ARTWORK_TYPE_GRAPHICS);
3815 SetupFileHash *setup_file_hash;
3818 for (i = 0; i < NUM_FILE_ELEMENTS; i++)
3820 if (element_info[i].custom_description != NULL)
3822 free(element_info[i].custom_description);
3823 element_info[i].custom_description = NULL;
3827 if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
3830 for (i = 0; i < NUM_FILE_ELEMENTS; i++)
3832 char *token = getStringCat2(element_info[i].token_name, ".name");
3833 char *value = getHashEntry(setup_file_hash, token);
3836 element_info[i].custom_description = getStringCopy(value);
3841 freeSetupFileHash(setup_file_hash);
3844 void LoadSpecialMenuDesignSettings()
3846 char *filename = getCustomArtworkConfigFilename(ARTWORK_TYPE_GRAPHICS);
3847 SetupFileHash *setup_file_hash;
3850 /* always start with reliable default values from default config */
3851 for (i = 0; image_config_vars[i].token != NULL; i++)
3852 for (j = 0; image_config[j].token != NULL; j++)
3853 if (strcmp(image_config_vars[i].token, image_config[j].token) == 0)
3854 *image_config_vars[i].value =
3855 get_auto_parameter_value(image_config_vars[i].token,
3856 image_config[j].value);
3858 if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
3861 /* special case: initialize with default values that may be overwritten */
3862 for (i = 0; i < NUM_SPECIAL_GFX_ARGS; i++)
3864 char *value_x = getHashEntry(setup_file_hash, "menu.draw_xoffset");
3865 char *value_y = getHashEntry(setup_file_hash, "menu.draw_yoffset");
3866 char *list_size = getHashEntry(setup_file_hash, "menu.list_size");
3868 if (value_x != NULL)
3869 menu.draw_xoffset[i] = get_integer_from_string(value_x);
3870 if (value_y != NULL)
3871 menu.draw_yoffset[i] = get_integer_from_string(value_y);
3872 if (list_size != NULL)
3873 menu.list_size[i] = get_integer_from_string(list_size);
3876 /* read (and overwrite with) values that may be specified in config file */
3877 for (i = 0; image_config_vars[i].token != NULL; i++)
3879 char *value = getHashEntry(setup_file_hash, image_config_vars[i].token);
3882 *image_config_vars[i].value =
3883 get_auto_parameter_value(image_config_vars[i].token, value);
3886 freeSetupFileHash(setup_file_hash);
3889 void LoadUserDefinedEditorElementList(int **elements, int *num_elements)
3891 char *filename = getEditorSetupFilename();
3892 SetupFileList *setup_file_list, *list;
3893 SetupFileHash *element_hash;
3894 int num_unknown_tokens = 0;
3897 if ((setup_file_list = loadSetupFileList(filename)) == NULL)
3900 element_hash = newSetupFileHash();
3902 for (i = 0; i < NUM_FILE_ELEMENTS; i++)
3903 setHashEntry(element_hash, element_info[i].token_name, i_to_a(i));
3905 /* determined size may be larger than needed (due to unknown elements) */
3907 for (list = setup_file_list; list != NULL; list = list->next)
3910 /* add space for up to 3 more elements for padding that may be needed */
3913 *elements = checked_malloc(*num_elements * sizeof(int));
3916 for (list = setup_file_list; list != NULL; list = list->next)
3918 char *value = getHashEntry(element_hash, list->token);
3922 (*elements)[(*num_elements)++] = atoi(value);
3926 if (num_unknown_tokens == 0)
3928 Error(ERR_RETURN_LINE, "-");
3929 Error(ERR_RETURN, "warning: unknown token(s) found in config file:");
3930 Error(ERR_RETURN, "- config file: '%s'", filename);
3932 num_unknown_tokens++;
3935 Error(ERR_RETURN, "- token: '%s'", list->token);
3939 if (num_unknown_tokens > 0)
3940 Error(ERR_RETURN_LINE, "-");
3942 while (*num_elements % 4) /* pad with empty elements, if needed */
3943 (*elements)[(*num_elements)++] = EL_EMPTY;
3945 freeSetupFileList(setup_file_list);
3946 freeSetupFileHash(element_hash);
3950 for (i = 0; i < *num_elements; i++)
3951 printf("editor: element '%s' [%d]\n",
3952 element_info[(*elements)[i]].token_name, (*elements)[i]);
3956 static struct MusicFileInfo *get_music_file_info_ext(char *basename, int music,
3959 SetupFileHash *setup_file_hash = NULL;
3960 struct MusicFileInfo tmp_music_file_info, *new_music_file_info;
3961 char *filename_music, *filename_prefix, *filename_info;
3967 token_to_value_ptr[] =
3969 { "title_header", &tmp_music_file_info.title_header },
3970 { "artist_header", &tmp_music_file_info.artist_header },
3971 { "album_header", &tmp_music_file_info.album_header },
3972 { "year_header", &tmp_music_file_info.year_header },
3974 { "title", &tmp_music_file_info.title },
3975 { "artist", &tmp_music_file_info.artist },
3976 { "album", &tmp_music_file_info.album },
3977 { "year", &tmp_music_file_info.year },
3983 filename_music = (is_sound ? getCustomSoundFilename(basename) :
3984 getCustomMusicFilename(basename));
3986 if (filename_music == NULL)
3989 /* ---------- try to replace file extension ---------- */
3991 filename_prefix = getStringCopy(filename_music);
3992 if (strrchr(filename_prefix, '.') != NULL)
3993 *strrchr(filename_prefix, '.') = '\0';
3994 filename_info = getStringCat2(filename_prefix, ".txt");
3997 printf("trying to load file '%s'...\n", filename_info);
4000 if (fileExists(filename_info))
4001 setup_file_hash = loadSetupFileHash(filename_info);
4003 free(filename_prefix);
4004 free(filename_info);
4006 if (setup_file_hash == NULL)
4008 /* ---------- try to add file extension ---------- */
4010 filename_prefix = getStringCopy(filename_music);
4011 filename_info = getStringCat2(filename_prefix, ".txt");
4014 printf("trying to load file '%s'...\n", filename_info);
4017 if (fileExists(filename_info))
4018 setup_file_hash = loadSetupFileHash(filename_info);
4020 free(filename_prefix);
4021 free(filename_info);
4024 if (setup_file_hash == NULL)
4027 /* ---------- music file info found ---------- */
4029 memset(&tmp_music_file_info, 0, sizeof(struct MusicFileInfo));
4031 for (i = 0; token_to_value_ptr[i].token != NULL; i++)
4033 char *value = getHashEntry(setup_file_hash, token_to_value_ptr[i].token);
4035 *token_to_value_ptr[i].value_ptr =
4036 getStringCopy(value != NULL && *value != '\0' ? value : UNKNOWN_NAME);
4039 tmp_music_file_info.basename = getStringCopy(basename);
4040 tmp_music_file_info.music = music;
4041 tmp_music_file_info.is_sound = is_sound;
4043 new_music_file_info = checked_malloc(sizeof(struct MusicFileInfo));
4044 *new_music_file_info = tmp_music_file_info;
4046 return new_music_file_info;
4049 static struct MusicFileInfo *get_music_file_info(char *basename, int music)
4051 return get_music_file_info_ext(basename, music, FALSE);
4054 static struct MusicFileInfo *get_sound_file_info(char *basename, int sound)
4056 return get_music_file_info_ext(basename, sound, TRUE);
4059 static boolean music_info_listed_ext(struct MusicFileInfo *list,
4060 char *basename, boolean is_sound)
4062 for (; list != NULL; list = list->next)
4063 if (list->is_sound == is_sound && strcmp(list->basename, basename) == 0)
4069 static boolean music_info_listed(struct MusicFileInfo *list, char *basename)
4071 return music_info_listed_ext(list, basename, FALSE);
4074 static boolean sound_info_listed(struct MusicFileInfo *list, char *basename)
4076 return music_info_listed_ext(list, basename, TRUE);
4079 void LoadMusicInfo()
4081 char *music_directory = getCustomMusicDirectory();
4082 int num_music = getMusicListSize();
4083 int num_music_noconf = 0;
4084 int num_sounds = getSoundListSize();
4086 struct dirent *dir_entry;
4087 struct FileInfo *music, *sound;
4088 struct MusicFileInfo *next, **new;
4091 while (music_file_info != NULL)
4093 next = music_file_info->next;
4095 checked_free(music_file_info->basename);
4097 checked_free(music_file_info->title_header);
4098 checked_free(music_file_info->artist_header);
4099 checked_free(music_file_info->album_header);
4100 checked_free(music_file_info->year_header);
4102 checked_free(music_file_info->title);
4103 checked_free(music_file_info->artist);
4104 checked_free(music_file_info->album);
4105 checked_free(music_file_info->year);
4107 free(music_file_info);
4109 music_file_info = next;
4112 new = &music_file_info;
4115 printf("::: num_music == %d\n", num_music);
4118 for (i = 0; i < num_music; i++)
4120 music = getMusicListEntry(i);
4123 printf("::: %d [%08x]\n", i, music->filename);
4126 if (music->filename == NULL)
4129 if (strcmp(music->filename, UNDEFINED_FILENAME) == 0)
4132 /* a configured file may be not recognized as music */
4133 if (!FileIsMusic(music->filename))
4137 printf("::: -> '%s' (configured)\n", music->filename);
4140 if (!music_info_listed(music_file_info, music->filename))
4142 *new = get_music_file_info(music->filename, i);
4144 new = &(*new)->next;
4148 if ((dir = opendir(music_directory)) == NULL)
4150 Error(ERR_WARN, "cannot read music directory '%s'", music_directory);
4154 while ((dir_entry = readdir(dir)) != NULL) /* loop until last dir entry */
4156 char *basename = dir_entry->d_name;
4157 boolean music_already_used = FALSE;
4160 /* skip all music files that are configured in music config file */
4161 for (i = 0; i < num_music; i++)
4163 music = getMusicListEntry(i);
4165 if (music->filename == NULL)
4168 if (strcmp(basename, music->filename) == 0)
4170 music_already_used = TRUE;
4175 if (music_already_used)
4178 if (!FileIsMusic(basename))
4182 printf("::: -> '%s' (found in directory)\n", basename);
4185 if (!music_info_listed(music_file_info, basename))
4187 *new = get_music_file_info(basename, MAP_NOCONF_MUSIC(num_music_noconf));
4189 new = &(*new)->next;
4197 for (i = 0; i < num_sounds; i++)
4199 sound = getSoundListEntry(i);
4201 if (sound->filename == NULL)
4204 if (strcmp(sound->filename, UNDEFINED_FILENAME) == 0)
4207 /* a configured file may be not recognized as sound */
4208 if (!FileIsSound(sound->filename))
4212 printf("::: -> '%s' (configured)\n", sound->filename);
4215 if (!sound_info_listed(music_file_info, sound->filename))
4217 *new = get_sound_file_info(sound->filename, i);
4219 new = &(*new)->next;
4225 for (next = music_file_info; next != NULL; next = next->next)
4226 printf("::: title == '%s'\n", next->title);
4230 void add_helpanim_entry(int element, int action, int direction, int delay,
4231 int *num_list_entries)
4233 struct HelpAnimInfo *new_list_entry;
4234 (*num_list_entries)++;
4237 checked_realloc(helpanim_info,
4238 *num_list_entries * sizeof(struct HelpAnimInfo));
4239 new_list_entry = &helpanim_info[*num_list_entries - 1];
4241 new_list_entry->element = element;
4242 new_list_entry->action = action;
4243 new_list_entry->direction = direction;
4244 new_list_entry->delay = delay;
4247 void print_unknown_token(char *filename, char *token, int token_nr)
4251 Error(ERR_RETURN_LINE, "-");
4252 Error(ERR_RETURN, "warning: unknown token(s) found in config file:");
4253 Error(ERR_RETURN, "- config file: '%s'", filename);
4256 Error(ERR_RETURN, "- token: '%s'", token);
4259 void print_unknown_token_end(int token_nr)
4262 Error(ERR_RETURN_LINE, "-");
4265 void LoadHelpAnimInfo()
4267 char *filename = getHelpAnimFilename();
4268 SetupFileList *setup_file_list = NULL, *list;
4269 SetupFileHash *element_hash, *action_hash, *direction_hash;
4270 int num_list_entries = 0;
4271 int num_unknown_tokens = 0;
4274 if (fileExists(filename))
4275 setup_file_list = loadSetupFileList(filename);
4277 if (setup_file_list == NULL)
4279 /* use reliable default values from static configuration */
4280 SetupFileList *insert_ptr;
4282 insert_ptr = setup_file_list =
4283 newSetupFileList(helpanim_config[0].token,
4284 helpanim_config[0].value);
4286 for (i = 1; helpanim_config[i].token; i++)
4287 insert_ptr = addListEntry(insert_ptr,
4288 helpanim_config[i].token,
4289 helpanim_config[i].value);
4292 element_hash = newSetupFileHash();
4293 action_hash = newSetupFileHash();
4294 direction_hash = newSetupFileHash();
4296 for (i = 0; i < MAX_NUM_ELEMENTS; i++)
4297 setHashEntry(element_hash, element_info[i].token_name, i_to_a(i));
4299 for (i = 0; i < NUM_ACTIONS; i++)
4300 setHashEntry(action_hash, element_action_info[i].suffix,
4301 i_to_a(element_action_info[i].value));
4303 /* do not store direction index (bit) here, but direction value! */
4304 for (i = 0; i < NUM_DIRECTIONS; i++)
4305 setHashEntry(direction_hash, element_direction_info[i].suffix,
4306 i_to_a(1 << element_direction_info[i].value));
4308 for (list = setup_file_list; list != NULL; list = list->next)
4310 char *element_token, *action_token, *direction_token;
4311 char *element_value, *action_value, *direction_value;
4312 int delay = atoi(list->value);
4314 if (strcmp(list->token, "end") == 0)
4316 add_helpanim_entry(HELPANIM_LIST_NEXT, -1, -1, -1, &num_list_entries);
4321 /* first try to break element into element/action/direction parts;
4322 if this does not work, also accept combined "element[.act][.dir]"
4323 elements (like "dynamite.active"), which are unique elements */
4325 if (strchr(list->token, '.') == NULL) /* token contains no '.' */
4327 element_value = getHashEntry(element_hash, list->token);
4328 if (element_value != NULL) /* element found */
4329 add_helpanim_entry(atoi(element_value), -1, -1, delay,
4333 /* no further suffixes found -- this is not an element */
4334 print_unknown_token(filename, list->token, num_unknown_tokens++);
4340 /* token has format "<prefix>.<something>" */
4342 action_token = strchr(list->token, '.'); /* suffix may be action ... */
4343 direction_token = action_token; /* ... or direction */
4345 element_token = getStringCopy(list->token);
4346 *strchr(element_token, '.') = '\0';
4348 element_value = getHashEntry(element_hash, element_token);
4350 if (element_value == NULL) /* this is no element */
4352 element_value = getHashEntry(element_hash, list->token);
4353 if (element_value != NULL) /* combined element found */
4354 add_helpanim_entry(atoi(element_value), -1, -1, delay,
4357 print_unknown_token(filename, list->token, num_unknown_tokens++);
4359 free(element_token);
4364 action_value = getHashEntry(action_hash, action_token);
4366 if (action_value != NULL) /* action found */
4368 add_helpanim_entry(atoi(element_value), atoi(action_value), -1, delay,
4371 free(element_token);
4376 direction_value = getHashEntry(direction_hash, direction_token);
4378 if (direction_value != NULL) /* direction found */
4380 add_helpanim_entry(atoi(element_value), -1, atoi(direction_value), delay,
4383 free(element_token);
4388 if (strchr(action_token + 1, '.') == NULL)
4390 /* no further suffixes found -- this is not an action nor direction */
4392 element_value = getHashEntry(element_hash, list->token);
4393 if (element_value != NULL) /* combined element found */
4394 add_helpanim_entry(atoi(element_value), -1, -1, delay,
4397 print_unknown_token(filename, list->token, num_unknown_tokens++);
4399 free(element_token);
4404 /* token has format "<prefix>.<suffix>.<something>" */
4406 direction_token = strchr(action_token + 1, '.');
4408 action_token = getStringCopy(action_token);
4409 *strchr(action_token + 1, '.') = '\0';
4411 action_value = getHashEntry(action_hash, action_token);
4413 if (action_value == NULL) /* this is no action */
4415 element_value = getHashEntry(element_hash, list->token);
4416 if (element_value != NULL) /* combined element found */
4417 add_helpanim_entry(atoi(element_value), -1, -1, delay,
4420 print_unknown_token(filename, list->token, num_unknown_tokens++);
4422 free(element_token);
4428 direction_value = getHashEntry(direction_hash, direction_token);
4430 if (direction_value != NULL) /* direction found */
4432 add_helpanim_entry(atoi(element_value), atoi(action_value),
4433 atoi(direction_value), delay, &num_list_entries);
4435 free(element_token);
4441 /* this is no direction */
4443 element_value = getHashEntry(element_hash, list->token);
4444 if (element_value != NULL) /* combined element found */
4445 add_helpanim_entry(atoi(element_value), -1, -1, delay,
4448 print_unknown_token(filename, list->token, num_unknown_tokens++);
4450 free(element_token);
4454 print_unknown_token_end(num_unknown_tokens);
4456 add_helpanim_entry(HELPANIM_LIST_NEXT, -1, -1, -1, &num_list_entries);
4457 add_helpanim_entry(HELPANIM_LIST_END, -1, -1, -1, &num_list_entries);
4459 freeSetupFileList(setup_file_list);
4460 freeSetupFileHash(element_hash);
4461 freeSetupFileHash(action_hash);
4462 freeSetupFileHash(direction_hash);
4466 for (i = 0; i < num_list_entries; i++)
4467 printf("::: %d, %d, %d => %d\n",
4468 helpanim_info[i].element,
4469 helpanim_info[i].action,
4470 helpanim_info[i].direction,
4471 helpanim_info[i].delay);
4475 void LoadHelpTextInfo()
4477 char *filename = getHelpTextFilename();
4480 if (helptext_info != NULL)
4482 freeSetupFileHash(helptext_info);
4483 helptext_info = NULL;
4486 if (fileExists(filename))
4487 helptext_info = loadSetupFileHash(filename);
4489 if (helptext_info == NULL)
4491 /* use reliable default values from static configuration */
4492 helptext_info = newSetupFileHash();
4494 for (i = 0; helptext_config[i].token; i++)
4495 setHashEntry(helptext_info,
4496 helptext_config[i].token,
4497 helptext_config[i].value);
4502 BEGIN_HASH_ITERATION(helptext_info, itr)
4504 printf("::: '%s' => '%s'\n",
4505 HASH_ITERATION_TOKEN(itr), HASH_ITERATION_VALUE(itr));
4507 END_HASH_ITERATION(hash, itr)