rnd-20040221-1-src
[rocksndiamonds.git] / src / files.c
1 /***********************************************************
2 * Rocks'n'Diamonds -- McDuffin Strikes Back!               *
3 *----------------------------------------------------------*
4 * (c) 1995-2002 Artsoft Entertainment                      *
5 *               Holger Schemel                             *
6 *               Detmolder Strasse 189                      *
7 *               33604 Bielefeld                            *
8 *               Germany                                    *
9 *               e-mail: info@artsoft.org                   *
10 *----------------------------------------------------------*
11 * files.c                                                  *
12 ***********************************************************/
13
14 #include <ctype.h>
15 #include <sys/stat.h>
16 #include <dirent.h>
17 #include <math.h>
18
19 #include "libgame/libgame.h"
20
21 #include "files.h"
22 #include "init.h"
23 #include "tools.h"
24 #include "tape.h"
25
26
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     10      /* 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   */
42
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)
46
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"
51
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
61
62 #define LEVEL_FILE_TYPE_RND_PACKED      (10 + LEVEL_FILE_TYPE_RND)
63 #define LEVEL_FILE_TYPE_EM_PACKED       (10 + LEVEL_FILE_TYPE_EM)
64
65 #define IS_SINGLE_LEVEL_FILE(x)         (x < 10)
66 #define IS_PACKED_LEVEL_FILE(x)         (x > 10)
67
68
69 /* ========================================================================= */
70 /* level file functions                                                      */
71 /* ========================================================================= */
72
73 void setElementChangePages(struct ElementInfo *ei, int change_pages)
74 {
75   int change_page_size = sizeof(struct ElementChangeInfo);
76
77   ei->num_change_pages = MAX(1, change_pages);
78
79   ei->change_page =
80     checked_realloc(ei->change_page, ei->num_change_pages * change_page_size);
81
82   if (ei->current_change_page >= ei->num_change_pages)
83     ei->current_change_page = ei->num_change_pages - 1;
84
85   ei->change = &ei->change_page[ei->current_change_page];
86 }
87
88 void setElementChangeInfoToDefaults(struct ElementChangeInfo *change)
89 {
90   int x, y;
91
92   change->can_change = FALSE;
93
94   change->events = CE_BITMASK_DEFAULT;
95   change->sides = CH_SIDE_ANY;
96
97   change->target_element = EL_EMPTY_SPACE;
98
99   change->delay_fixed = 0;
100   change->delay_random = 0;
101   change->delay_frames = 1;
102
103   change->trigger_element = EL_EMPTY_SPACE;
104
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;
111
112   for (x = 0; x < 3; x++)
113     for (y = 0; y < 3; y++)
114       change->content[x][y] = EL_EMPTY_SPACE;
115
116   change->direct_action = 0;
117   change->other_action = 0;
118
119   change->pre_change_function = NULL;
120   change->change_function = NULL;
121   change->post_change_function = NULL;
122 }
123
124 static void setMoveIntoAcid(struct LevelInfo *level, int element)
125 {
126   int bit_nr = get_special_property_bit(element, EP_CAN_MOVE_INTO_ACID);
127
128   if (bit_nr > -1)
129     level->can_move_into_acid |= (1 << bit_nr);
130 }
131
132 static void setLevelInfoToDefaults(struct LevelInfo *level)
133 {
134   int i, j, x, y;
135
136   level->file_version = FILE_VERSION_ACTUAL;
137   level->game_version = GAME_VERSION_ACTUAL;
138
139   level->encoding_16bit_field  = FALSE; /* default: only 8-bit elements */
140   level->encoding_16bit_yamyam = FALSE; /* default: only 8-bit elements */
141   level->encoding_16bit_amoeba = FALSE; /* default: only 8-bit elements */
142
143   level->fieldx = STD_LEV_FIELDX;
144   level->fieldy = STD_LEV_FIELDY;
145
146   for (x = 0; x < MAX_LEV_FIELDX; x++)
147     for (y = 0; y < MAX_LEV_FIELDY; y++)
148       level->field[x][y] = EL_SAND;
149
150   level->time = 100;
151   level->gems_needed = 0;
152
153   level->amoeba_speed = 10;
154
155   level->time_magic_wall = 10;
156   level->time_wheel = 10;
157   level->time_light = 10;
158   level->time_timegate = 10;
159
160   level->amoeba_content = EL_DIAMOND;
161
162   level->double_speed = FALSE;
163   level->initial_gravity = FALSE;
164   level->em_slippery_gems = FALSE;
165   level->block_last_field = FALSE;
166   level->sp_block_last_field = TRUE;
167   level->use_spring_bug = FALSE;
168
169   level->can_move_into_acid = ~0;       /* everything can move into acid */
170
171   level->use_custom_template = FALSE;
172
173   for (i = 0; i < MAX_LEVEL_NAME_LEN; i++)
174     level->name[i] = '\0';
175   for (i = 0; i < MAX_LEVEL_AUTHOR_LEN; i++)
176     level->author[i] = '\0';
177
178   strcpy(level->name, NAMELESS_LEVEL_NAME);
179   strcpy(level->author, ANONYMOUS_NAME);
180
181   for (i = 0; i < 4; i++)
182   {
183     level->envelope_text[i][0] = '\0';
184     level->envelope_xsize[i] = MAX_ENVELOPE_XSIZE;
185     level->envelope_ysize[i] = MAX_ENVELOPE_YSIZE;
186   }
187
188   for (i = 0; i < LEVEL_SCORE_ELEMENTS; i++)
189     level->score[i] = 10;
190
191   level->num_yamyam_contents = STD_ELEMENT_CONTENTS;
192   for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
193     for (x = 0; x < 3; x++)
194       for (y = 0; y < 3; y++)
195         level->yamyam_content[i][x][y] =
196           (i < STD_ELEMENT_CONTENTS ? EL_ROCK : EL_EMPTY);
197
198   level->field[0][0] = EL_PLAYER_1;
199   level->field[STD_LEV_FIELDX - 1][STD_LEV_FIELDY - 1] = EL_EXIT_CLOSED;
200
201   for (i = 0; i < MAX_NUM_ELEMENTS; i++)
202   {
203     int element = i;
204
205     setElementChangePages(&element_info[element], 1);
206     setElementChangeInfoToDefaults(element_info[element].change);
207
208     if (IS_CUSTOM_ELEMENT(element) || IS_GROUP_ELEMENT(element))
209     {
210       for (j = 0; j < MAX_ELEMENT_NAME_LEN + 1; j++)
211         element_info[element].description[j] = '\0';
212
213       if (element_info[element].custom_description != NULL)
214         strncpy(element_info[element].description,
215                 element_info[element].custom_description,MAX_ELEMENT_NAME_LEN);
216       else
217         strcpy(element_info[element].description,
218                element_info[element].editor_description);
219
220       element_info[element].use_gfx_element = FALSE;
221       element_info[element].gfx_element = EL_EMPTY_SPACE;
222     }
223
224     if (IS_CUSTOM_ELEMENT(element))
225     {
226       element_info[element].access_direction = MV_ALL_DIRECTIONS;
227
228       element_info[element].collect_score = 10;         /* special default */
229       element_info[element].collect_count = 1;          /* special default */
230
231       element_info[element].push_delay_fixed = -1;      /* initialize later */
232       element_info[element].push_delay_random = -1;     /* initialize later */
233       element_info[element].move_delay_fixed = 0;
234       element_info[element].move_delay_random = 0;
235
236       element_info[element].move_pattern = MV_ALL_DIRECTIONS;
237       element_info[element].move_direction_initial = MV_START_AUTOMATIC;
238       element_info[element].move_stepsize = TILEX / 8;
239       element_info[element].move_enter_element = EL_EMPTY_SPACE;
240       element_info[element].move_leave_element = EL_EMPTY_SPACE;
241       element_info[element].move_leave_type = LEAVE_TYPE_UNLIMITED;
242
243       element_info[element].slippery_type = SLIPPERY_ANY_RANDOM;
244
245       element_info[element].explosion_delay = 18;
246       element_info[element].ignition_delay = 8;
247
248       for (x = 0; x < 3; x++)
249         for (y = 0; y < 3; y++)
250           element_info[element].content[x][y] = EL_EMPTY_SPACE;
251
252       element_info[element].access_type = 0;
253       element_info[element].access_layer = 0;
254       element_info[element].access_protected = 0;
255       element_info[element].walk_to_action = 0;
256       element_info[element].smash_targets = 0;
257       element_info[element].deadliness = 0;
258       element_info[element].consistency = 0;
259
260       element_info[element].can_explode_by_fire = FALSE;
261       element_info[element].can_explode_smashed = FALSE;
262       element_info[element].can_explode_impact = FALSE;
263
264       element_info[element].current_change_page = 0;
265
266       /* start with no properties at all */
267       for (j = 0; j < NUM_EP_BITFIELDS; j++)
268         Properties[element][j] = EP_BITMASK_DEFAULT;
269
270       element_info[element].modified_settings = FALSE;
271     }
272     else if (IS_GROUP_ELEMENT(element) || element == EL_INTERNAL_EDITOR)
273     {
274       /* initialize memory for list of elements in group */
275       if (element_info[element].group == NULL)
276         element_info[element].group =
277           checked_malloc(sizeof(struct ElementGroupInfo));
278
279       for (j = 0; j < MAX_ELEMENTS_IN_GROUP; j++)
280         element_info[element].group->element[j] = EL_EMPTY_SPACE;
281
282       /* default: only one element in group */
283       element_info[element].group->num_elements = 1;
284
285       element_info[element].group->choice_mode = ANIM_RANDOM;
286     }
287   }
288
289   BorderElement = EL_STEELWALL;
290
291   level->no_level_file = FALSE;
292
293   if (leveldir_current == NULL)         /* only when dumping level */
294     return;
295
296   /* try to determine better author name than 'anonymous' */
297   if (strcmp(leveldir_current->author, ANONYMOUS_NAME) != 0)
298   {
299     strncpy(level->author, leveldir_current->author, MAX_LEVEL_AUTHOR_LEN);
300     level->author[MAX_LEVEL_AUTHOR_LEN] = '\0';
301   }
302   else
303   {
304     switch (LEVELCLASS(leveldir_current))
305     {
306       case LEVELCLASS_TUTORIAL:
307         strcpy(level->author, PROGRAM_AUTHOR_STRING);
308         break;
309
310       case LEVELCLASS_CONTRIB:
311         strncpy(level->author, leveldir_current->name, MAX_LEVEL_AUTHOR_LEN);
312         level->author[MAX_LEVEL_AUTHOR_LEN] = '\0';
313         break;
314
315       case LEVELCLASS_PRIVATE:
316         strncpy(level->author, getRealName(), MAX_LEVEL_AUTHOR_LEN);
317         level->author[MAX_LEVEL_AUTHOR_LEN] = '\0';
318         break;
319
320       default:
321         /* keep default value */
322         break;
323     }
324   }
325 }
326
327 static void setFileInfoToDefaults(struct LevelFileInfo *level_file_info)
328 {
329   level_file_info->nr = 0;
330   level_file_info->type = LEVEL_FILE_TYPE_UNKNOWN;
331   level_file_info->packed = FALSE;
332   level_file_info->basename = NULL;
333   level_file_info->filename = NULL;
334 }
335
336 static void ActivateLevelTemplate()
337 {
338   /* Currently there is no special action needed to activate the template
339      data, because 'element_info' and 'Properties' overwrite the original
340      level data, while all other variables do not change. */
341 }
342
343 static char *getLevelFilenameFromBasename(char *basename)
344 {
345   static char *filename = NULL;
346
347   checked_free(filename);
348
349   filename = getPath2(getCurrentLevelDir(), basename);
350
351   return filename;
352 }
353
354 static int getFileTypeFromBasename(char *basename)
355 {
356   static char *filename = NULL;
357   struct stat file_status;
358
359   /* ---------- try to determine file type from filename ---------- */
360
361   /* check for typical filename of a Supaplex level package file */
362   if (strlen(basename) == 10 && (strncmp(basename, "levels.d", 8) == 0 ||
363                                  strncmp(basename, "LEVELS.D", 8) == 0))
364     return LEVEL_FILE_TYPE_SP;
365
366   /* ---------- try to determine file type from filesize ---------- */
367
368   checked_free(filename);
369   filename = getPath2(getCurrentLevelDir(), basename);
370
371   if (stat(filename, &file_status) == 0)
372   {
373     /* check for typical filesize of a Supaplex level package file */
374     if (file_status.st_size == 170496)
375       return LEVEL_FILE_TYPE_SP;
376   }
377
378   return LEVEL_FILE_TYPE_UNKNOWN;
379 }
380
381 static char *getSingleLevelBasename(int nr, int type)
382 {
383   static char basename[MAX_FILENAME_LEN];
384   char *level_filename = getStringCopy(leveldir_current->level_filename);
385
386   if (level_filename == NULL)
387     level_filename = getStringCat2("%03d.", LEVELFILE_EXTENSION);
388
389   switch (type)
390   {
391     case LEVEL_FILE_TYPE_RND:
392       if (nr < 0)
393         sprintf(basename, "template.%s", LEVELFILE_EXTENSION);
394       else
395         sprintf(basename, "%03d.%s", nr, LEVELFILE_EXTENSION);
396       break;
397
398     case LEVEL_FILE_TYPE_EM:
399       sprintf(basename, "%d", nr);
400       break;
401
402     case LEVEL_FILE_TYPE_UNKNOWN:
403     default:
404       sprintf(basename, level_filename, nr);
405       break;
406   }
407
408   free(level_filename);
409
410   return basename;
411 }
412
413 static char *getPackedLevelBasename(int type)
414 {
415   static char basename[MAX_FILENAME_LEN];
416   char *directory = getCurrentLevelDir();
417   DIR *dir;
418   struct dirent *dir_entry;
419
420   strcpy(basename, UNDEFINED_FILENAME);         /* default: undefined file */
421
422   if ((dir = opendir(directory)) == NULL)
423   {
424     Error(ERR_WARN, "cannot read current level directory '%s'", directory);
425
426     return basename;
427   }
428
429   while ((dir_entry = readdir(dir)) != NULL)    /* loop until last dir entry */
430   {
431     char *entry_basename = dir_entry->d_name;
432     int entry_type = getFileTypeFromBasename(entry_basename);
433
434     if (entry_type != LEVEL_FILE_TYPE_UNKNOWN)  /* found valid level package */
435     {
436       if (type == LEVEL_FILE_TYPE_UNKNOWN ||
437           type == entry_type)
438       {
439         strcpy(basename, entry_basename);
440
441         break;
442       }
443     }
444   }
445
446   closedir(dir);
447
448   return basename;
449 }
450
451 static char *getSingleLevelFilename(int nr, int type)
452 {
453   return getLevelFilenameFromBasename(getSingleLevelBasename(nr, type));
454 }
455
456 #if 0
457 static char *getPackedLevelFilename(int type)
458 {
459   return getLevelFilenameFromBasename(getPackedLevelBasename(type));
460 }
461 #endif
462
463 char *getDefaultLevelFilename(int nr)
464 {
465   return getSingleLevelFilename(nr, LEVEL_FILE_TYPE_RND);
466 }
467
468 static void setLevelFileInfo_SingleLevelFilename(struct LevelFileInfo *lfi,
469                                                  int type)
470 {
471   lfi->type = type;
472   lfi->packed = FALSE;
473   lfi->basename = getSingleLevelBasename(lfi->nr, lfi->type);
474   lfi->filename = getLevelFilenameFromBasename(lfi->basename);
475 }
476
477 static void setLevelFileInfo_PackedLevelFilename(struct LevelFileInfo *lfi,
478                                                  int type)
479 {
480   lfi->type = type;
481   lfi->packed = TRUE;
482   lfi->basename = getPackedLevelBasename(lfi->type);
483   lfi->filename = getLevelFilenameFromBasename(lfi->basename);
484 }
485
486 static void determineLevelFileInfo_Filename(struct LevelFileInfo *lfi)
487 {
488   /* special case: level number is negative => check for level template file */
489   if (lfi->nr < 0)
490   {
491     setLevelFileInfo_SingleLevelFilename(lfi, LEVEL_FILE_TYPE_RND);
492
493     return;
494   }
495
496   if (leveldir_current->level_filename != NULL)
497   {
498     /* check for file name/pattern specified in "levelinfo.conf" */
499     setLevelFileInfo_SingleLevelFilename(lfi, LEVEL_FILE_TYPE_UNKNOWN);
500     if (fileExists(lfi->filename))
501       return;
502   }
503
504   /* check for native Rocks'n'Diamonds level file */
505   setLevelFileInfo_SingleLevelFilename(lfi, LEVEL_FILE_TYPE_RND);
506   if (fileExists(lfi->filename))
507     return;
508
509   /* check for classic Emerald Mine level file */
510   setLevelFileInfo_SingleLevelFilename(lfi, LEVEL_FILE_TYPE_EM);
511   if (fileExists(lfi->filename))
512     return;
513
514   /* check for various packed level file formats */
515   setLevelFileInfo_PackedLevelFilename(lfi, LEVEL_FILE_TYPE_UNKNOWN);
516   if (fileExists(lfi->filename))
517     return;
518
519   /* no known level file found -- try to use default values */
520   setLevelFileInfo_SingleLevelFilename(lfi, LEVEL_FILE_TYPE_UNKNOWN);
521 }
522
523 static void determineLevelFileInfo_Filetype(struct LevelFileInfo *lfi)
524 {
525   if (lfi->type == LEVEL_FILE_TYPE_UNKNOWN)
526     lfi->type = getFileTypeFromBasename(lfi->basename);
527 }
528
529 static struct LevelFileInfo *getLevelFileInfo(int nr)
530 {
531   static struct LevelFileInfo level_file_info;
532
533   /* always start with reliable default values */
534   setFileInfoToDefaults(&level_file_info);
535
536   level_file_info.nr = nr;      /* set requested level number */
537
538   determineLevelFileInfo_Filename(&level_file_info);
539   determineLevelFileInfo_Filetype(&level_file_info);
540
541   return &level_file_info;
542 }
543
544
545 /* ------------------------------------------------------------------------- */
546 /* functions for loading R'n'D level                                         */
547 /* ------------------------------------------------------------------------- */
548
549 int getMappedElement(int element)
550 {
551   /* map some (historic, now obsolete) elements */
552
553 #if 1
554   switch (element)
555   {
556     case EL_PLAYER_OBSOLETE:
557       element = EL_PLAYER_1;
558       break;
559
560     case EL_KEY_OBSOLETE:
561       element = EL_KEY_1;
562
563     case EL_EM_KEY_1_FILE_OBSOLETE:
564       element = EL_EM_KEY_1;
565       break;
566
567     case EL_EM_KEY_2_FILE_OBSOLETE:
568       element = EL_EM_KEY_2;
569       break;
570
571     case EL_EM_KEY_3_FILE_OBSOLETE:
572       element = EL_EM_KEY_3;
573       break;
574
575     case EL_EM_KEY_4_FILE_OBSOLETE:
576       element = EL_EM_KEY_4;
577       break;
578
579     case EL_ENVELOPE_OBSOLETE:
580       element = EL_ENVELOPE_1;
581       break;
582
583     case EL_SP_EMPTY:
584       element = EL_EMPTY;
585       break;
586
587     default:
588       if (element >= NUM_FILE_ELEMENTS)
589       {
590         Error(ERR_WARN, "invalid level element %d", element);
591
592         element = EL_UNKNOWN;
593       }
594       break;
595   }
596 #else
597   if (element >= NUM_FILE_ELEMENTS)
598   {
599     Error(ERR_WARN, "invalid level element %d", element);
600
601     element = EL_UNKNOWN;
602   }
603   else if (element == EL_PLAYER_OBSOLETE)
604     element = EL_PLAYER_1;
605   else if (element == EL_KEY_OBSOLETE)
606     element = EL_KEY_1;
607 #endif
608
609   return element;
610 }
611
612 static int LoadLevel_VERS(FILE *file, int chunk_size, struct LevelInfo *level)
613 {
614   level->file_version = getFileVersion(file);
615   level->game_version = getFileVersion(file);
616
617   return chunk_size;
618 }
619
620 static int LoadLevel_HEAD(FILE *file, int chunk_size, struct LevelInfo *level)
621 {
622   int i, x, y;
623
624   level->fieldx = getFile8Bit(file);
625   level->fieldy = getFile8Bit(file);
626
627   level->time           = getFile16BitBE(file);
628   level->gems_needed    = getFile16BitBE(file);
629
630   for (i = 0; i < MAX_LEVEL_NAME_LEN; i++)
631     level->name[i] = getFile8Bit(file);
632   level->name[MAX_LEVEL_NAME_LEN] = 0;
633
634   for (i = 0; i < LEVEL_SCORE_ELEMENTS; i++)
635     level->score[i] = getFile8Bit(file);
636
637   level->num_yamyam_contents = STD_ELEMENT_CONTENTS;
638   for (i = 0; i < STD_ELEMENT_CONTENTS; i++)
639     for (y = 0; y < 3; y++)
640       for (x = 0; x < 3; x++)
641         level->yamyam_content[i][x][y] = getMappedElement(getFile8Bit(file));
642
643   level->amoeba_speed           = getFile8Bit(file);
644   level->time_magic_wall        = getFile8Bit(file);
645   level->time_wheel             = getFile8Bit(file);
646   level->amoeba_content         = getMappedElement(getFile8Bit(file));
647   level->double_speed           = (getFile8Bit(file) == 1 ? TRUE : FALSE);
648   level->initial_gravity        = (getFile8Bit(file) == 1 ? TRUE : FALSE);
649   level->encoding_16bit_field   = (getFile8Bit(file) == 1 ? TRUE : FALSE);
650   level->em_slippery_gems       = (getFile8Bit(file) == 1 ? TRUE : FALSE);
651
652   level->use_custom_template    = (getFile8Bit(file) == 1 ? TRUE : FALSE);
653
654   level->block_last_field       = (getFile8Bit(file) == 1 ? TRUE : FALSE);
655   level->sp_block_last_field    = (getFile8Bit(file) == 1 ? TRUE : FALSE);
656
657   level->use_spring_bug         = (getFile8Bit(file) == 1 ? TRUE : FALSE);
658
659   ReadUnusedBytesFromFile(file, LEVEL_HEADER_UNUSED);
660
661   return chunk_size;
662 }
663
664 static int LoadLevel_AUTH(FILE *file, int chunk_size, struct LevelInfo *level)
665 {
666   int i;
667
668   for (i = 0; i < MAX_LEVEL_AUTHOR_LEN; i++)
669     level->author[i] = getFile8Bit(file);
670   level->author[MAX_LEVEL_NAME_LEN] = 0;
671
672   return chunk_size;
673 }
674
675 static int LoadLevel_BODY(FILE *file, int chunk_size, struct LevelInfo *level)
676 {
677   int x, y;
678   int chunk_size_expected = level->fieldx * level->fieldy;
679
680   /* Note: "chunk_size" was wrong before version 2.0 when elements are
681      stored with 16-bit encoding (and should be twice as big then).
682      Even worse, playfield data was stored 16-bit when only yamyam content
683      contained 16-bit elements and vice versa. */
684
685   if (level->encoding_16bit_field && level->file_version >= FILE_VERSION_2_0)
686     chunk_size_expected *= 2;
687
688   if (chunk_size_expected != chunk_size)
689   {
690     ReadUnusedBytesFromFile(file, chunk_size);
691     return chunk_size_expected;
692   }
693
694   for (y = 0; y < level->fieldy; y++)
695     for (x = 0; x < level->fieldx; x++)
696       level->field[x][y] =
697         getMappedElement(level->encoding_16bit_field ? getFile16BitBE(file) :
698                          getFile8Bit(file));
699   return chunk_size;
700 }
701
702 static int LoadLevel_CONT(FILE *file, int chunk_size, struct LevelInfo *level)
703 {
704   int i, x, y;
705   int header_size = 4;
706   int content_size = MAX_ELEMENT_CONTENTS * 3 * 3;
707   int chunk_size_expected = header_size + content_size;
708
709   /* Note: "chunk_size" was wrong before version 2.0 when elements are
710      stored with 16-bit encoding (and should be twice as big then).
711      Even worse, playfield data was stored 16-bit when only yamyam content
712      contained 16-bit elements and vice versa. */
713
714   if (level->encoding_16bit_field && level->file_version >= FILE_VERSION_2_0)
715     chunk_size_expected += content_size;
716
717   if (chunk_size_expected != chunk_size)
718   {
719     ReadUnusedBytesFromFile(file, chunk_size);
720     return chunk_size_expected;
721   }
722
723   getFile8Bit(file);
724   level->num_yamyam_contents = getFile8Bit(file);
725   getFile8Bit(file);
726   getFile8Bit(file);
727
728   /* correct invalid number of content fields -- should never happen */
729   if (level->num_yamyam_contents < 1 ||
730       level->num_yamyam_contents > MAX_ELEMENT_CONTENTS)
731     level->num_yamyam_contents = STD_ELEMENT_CONTENTS;
732
733   for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
734     for (y = 0; y < 3; y++)
735       for (x = 0; x < 3; x++)
736         level->yamyam_content[i][x][y] =
737           getMappedElement(level->encoding_16bit_field ?
738                            getFile16BitBE(file) : getFile8Bit(file));
739   return chunk_size;
740 }
741
742 static int LoadLevel_CNT2(FILE *file, int chunk_size, struct LevelInfo *level)
743 {
744   int i, x, y;
745   int element;
746   int num_contents, content_xsize, content_ysize;
747   int content_array[MAX_ELEMENT_CONTENTS][3][3];
748
749   element = getMappedElement(getFile16BitBE(file));
750   num_contents = getFile8Bit(file);
751   content_xsize = getFile8Bit(file);
752   content_ysize = getFile8Bit(file);
753
754   ReadUnusedBytesFromFile(file, LEVEL_CHUNK_CNT2_UNUSED);
755
756   for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
757     for (y = 0; y < 3; y++)
758       for (x = 0; x < 3; x++)
759         content_array[i][x][y] = getMappedElement(getFile16BitBE(file));
760
761   /* correct invalid number of content fields -- should never happen */
762   if (num_contents < 1 || num_contents > MAX_ELEMENT_CONTENTS)
763     num_contents = STD_ELEMENT_CONTENTS;
764
765   if (element == EL_YAMYAM)
766   {
767     level->num_yamyam_contents = num_contents;
768
769     for (i = 0; i < num_contents; i++)
770       for (y = 0; y < 3; y++)
771         for (x = 0; x < 3; x++)
772           level->yamyam_content[i][x][y] = content_array[i][x][y];
773   }
774   else if (element == EL_BD_AMOEBA)
775   {
776     level->amoeba_content = content_array[0][0][0];
777   }
778   else
779   {
780     Error(ERR_WARN, "cannot load content for element '%d'", element);
781   }
782
783   return chunk_size;
784 }
785
786 static int LoadLevel_CNT3(FILE *file, int chunk_size, struct LevelInfo *level)
787 {
788   int i;
789   int element;
790   int envelope_nr;
791   int envelope_len;
792   int chunk_size_expected;
793
794   element = getMappedElement(getFile16BitBE(file));
795   if (!IS_ENVELOPE(element))
796     element = EL_ENVELOPE_1;
797
798   envelope_nr = element - EL_ENVELOPE_1;
799
800   envelope_len = getFile16BitBE(file);
801
802   level->envelope_xsize[envelope_nr] = getFile8Bit(file);
803   level->envelope_ysize[envelope_nr] = getFile8Bit(file);
804
805   ReadUnusedBytesFromFile(file, LEVEL_CHUNK_CNT3_UNUSED);
806
807   chunk_size_expected = LEVEL_CHUNK_CNT3_SIZE(envelope_len);
808   if (chunk_size_expected != chunk_size)
809   {
810     ReadUnusedBytesFromFile(file, chunk_size - LEVEL_CHUNK_CNT3_HEADER);
811     return chunk_size_expected;
812   }
813
814   for (i = 0; i < envelope_len; i++)
815     level->envelope_text[envelope_nr][i] = getFile8Bit(file);
816
817   return chunk_size;
818 }
819
820 static int LoadLevel_CUS1(FILE *file, int chunk_size, struct LevelInfo *level)
821 {
822   int num_changed_custom_elements = getFile16BitBE(file);
823   int chunk_size_expected = 2 + num_changed_custom_elements * 6;
824   int i;
825
826   if (chunk_size_expected != chunk_size)
827   {
828     ReadUnusedBytesFromFile(file, chunk_size - 2);
829     return chunk_size_expected;
830   }
831
832   for (i = 0; i < num_changed_custom_elements; i++)
833   {
834     int element = getFile16BitBE(file);
835     int properties = getFile32BitBE(file);
836
837     if (IS_CUSTOM_ELEMENT(element))
838       Properties[element][EP_BITFIELD_BASE] = properties;
839     else
840       Error(ERR_WARN, "invalid custom element number %d", element);
841   }
842
843   return chunk_size;
844 }
845
846 static int LoadLevel_CUS2(FILE *file, int chunk_size, struct LevelInfo *level)
847 {
848   int num_changed_custom_elements = getFile16BitBE(file);
849   int chunk_size_expected = 2 + num_changed_custom_elements * 4;
850   int i;
851
852   if (chunk_size_expected != chunk_size)
853   {
854     ReadUnusedBytesFromFile(file, chunk_size - 2);
855     return chunk_size_expected;
856   }
857
858   for (i = 0; i < num_changed_custom_elements; i++)
859   {
860     int element = getFile16BitBE(file);
861     int custom_target_element = getFile16BitBE(file);
862
863     if (IS_CUSTOM_ELEMENT(element))
864       element_info[element].change->target_element = custom_target_element;
865     else
866       Error(ERR_WARN, "invalid custom element number %d", element);
867   }
868
869   return chunk_size;
870 }
871
872 static int LoadLevel_CUS3(FILE *file, int chunk_size, struct LevelInfo *level)
873 {
874   int num_changed_custom_elements = getFile16BitBE(file);
875   int chunk_size_expected = LEVEL_CHUNK_CUS3_SIZE(num_changed_custom_elements);
876   int i, j, x, y;
877
878   if (chunk_size_expected != chunk_size)
879   {
880     ReadUnusedBytesFromFile(file, chunk_size - 2);
881     return chunk_size_expected;
882   }
883
884   for (i = 0; i < num_changed_custom_elements; i++)
885   {
886     int element = getFile16BitBE(file);
887
888     if (!IS_CUSTOM_ELEMENT(element))
889     {
890       Error(ERR_WARN, "invalid custom element number %d", element);
891
892       element = EL_INTERNAL_DUMMY;
893     }
894
895     for (j = 0; j < MAX_ELEMENT_NAME_LEN; j++)
896       element_info[element].description[j] = getFile8Bit(file);
897     element_info[element].description[MAX_ELEMENT_NAME_LEN] = 0;
898
899     Properties[element][EP_BITFIELD_BASE] = getFile32BitBE(file);
900
901     /* some free bytes for future properties and padding */
902     ReadUnusedBytesFromFile(file, 7);
903
904     element_info[element].use_gfx_element = getFile8Bit(file);
905     element_info[element].gfx_element =
906       getMappedElement(getFile16BitBE(file));
907
908     element_info[element].collect_score = getFile8Bit(file);
909     element_info[element].collect_count = getFile8Bit(file);
910
911     element_info[element].push_delay_fixed = getFile16BitBE(file);
912     element_info[element].push_delay_random = getFile16BitBE(file);
913     element_info[element].move_delay_fixed = getFile16BitBE(file);
914     element_info[element].move_delay_random = getFile16BitBE(file);
915
916     element_info[element].move_pattern = getFile16BitBE(file);
917     element_info[element].move_direction_initial = getFile8Bit(file);
918     element_info[element].move_stepsize = getFile8Bit(file);
919
920     for (y = 0; y < 3; y++)
921       for (x = 0; x < 3; x++)
922         element_info[element].content[x][y] =
923           getMappedElement(getFile16BitBE(file));
924
925     element_info[element].change->events = getFile32BitBE(file);
926
927     element_info[element].change->target_element =
928       getMappedElement(getFile16BitBE(file));
929
930     element_info[element].change->delay_fixed = getFile16BitBE(file);
931     element_info[element].change->delay_random = getFile16BitBE(file);
932     element_info[element].change->delay_frames = getFile16BitBE(file);
933
934     element_info[element].change->trigger_element =
935       getMappedElement(getFile16BitBE(file));
936
937     element_info[element].change->explode = getFile8Bit(file);
938     element_info[element].change->use_content = getFile8Bit(file);
939     element_info[element].change->only_complete = getFile8Bit(file);
940     element_info[element].change->use_random_change = getFile8Bit(file);
941
942     element_info[element].change->random = getFile8Bit(file);
943     element_info[element].change->power = getFile8Bit(file);
944
945     for (y = 0; y < 3; y++)
946       for (x = 0; x < 3; x++)
947         element_info[element].change->content[x][y] =
948           getMappedElement(getFile16BitBE(file));
949
950     element_info[element].slippery_type = getFile8Bit(file);
951
952     /* some free bytes for future properties and padding */
953     ReadUnusedBytesFromFile(file, LEVEL_CPART_CUS3_UNUSED);
954
955     /* mark that this custom element has been modified */
956     element_info[element].modified_settings = TRUE;
957   }
958
959   return chunk_size;
960 }
961
962 static int LoadLevel_CUS4(FILE *file, int chunk_size, struct LevelInfo *level)
963 {
964   struct ElementInfo *ei;
965   int chunk_size_expected;
966   int element;
967   int i, x, y;
968
969   element = getFile16BitBE(file);
970
971   if (!IS_CUSTOM_ELEMENT(element))
972   {
973     Error(ERR_WARN, "invalid custom element number %d", element);
974
975     ReadUnusedBytesFromFile(file, chunk_size - 2);
976     return chunk_size;
977   }
978
979   ei = &element_info[element];
980
981   for (i = 0; i < MAX_ELEMENT_NAME_LEN; i++)
982     ei->description[i] = getFile8Bit(file);
983   ei->description[MAX_ELEMENT_NAME_LEN] = 0;
984
985   Properties[element][EP_BITFIELD_BASE] = getFile32BitBE(file);
986   ReadUnusedBytesFromFile(file, 4);     /* reserved for more base properties */
987
988   ei->num_change_pages = getFile8Bit(file);
989
990   /* some free bytes for future base property values and padding */
991   ReadUnusedBytesFromFile(file, 5);
992
993   chunk_size_expected = LEVEL_CHUNK_CUS4_SIZE(ei->num_change_pages);
994   if (chunk_size_expected != chunk_size)
995   {
996     ReadUnusedBytesFromFile(file, chunk_size - 48);
997     return chunk_size_expected;
998   }
999
1000   /* read custom property values */
1001
1002   ei->use_gfx_element = getFile8Bit(file);
1003   ei->gfx_element = getMappedElement(getFile16BitBE(file));
1004
1005   ei->collect_score = getFile8Bit(file);
1006   ei->collect_count = getFile8Bit(file);
1007
1008   ei->push_delay_fixed = getFile16BitBE(file);
1009   ei->push_delay_random = getFile16BitBE(file);
1010   ei->move_delay_fixed = getFile16BitBE(file);
1011   ei->move_delay_random = getFile16BitBE(file);
1012
1013   /* bits 0 - 15 of "move_pattern" ... */
1014   ei->move_pattern = getFile16BitBE(file);
1015   ei->move_direction_initial = getFile8Bit(file);
1016   ei->move_stepsize = getFile8Bit(file);
1017
1018   ei->slippery_type = getFile8Bit(file);
1019
1020   for (y = 0; y < 3; y++)
1021     for (x = 0; x < 3; x++)
1022       ei->content[x][y] = getMappedElement(getFile16BitBE(file));
1023
1024   ei->move_enter_element = getMappedElement(getFile16BitBE(file));
1025   ei->move_leave_element = getMappedElement(getFile16BitBE(file));
1026   ei->move_leave_type = getFile8Bit(file);
1027
1028   /* ... bits 16 - 31 of "move_pattern" (not nice, but downward compatible) */
1029   ei->move_pattern |= (getFile16BitBE(file) << 16);
1030
1031   ei->access_direction = getFile8Bit(file);
1032
1033   ei->explosion_delay = getFile8Bit(file);
1034   ei->ignition_delay = getFile8Bit(file);
1035
1036   /* some free bytes for future custom property values and padding */
1037   ReadUnusedBytesFromFile(file, 2);
1038
1039   /* read change property values */
1040
1041   setElementChangePages(ei, ei->num_change_pages);
1042
1043   for (i = 0; i < ei->num_change_pages; i++)
1044   {
1045     struct ElementChangeInfo *change = &ei->change_page[i];
1046
1047     /* always start with reliable default values */
1048     setElementChangeInfoToDefaults(change);
1049
1050     change->events = getFile32BitBE(file);
1051
1052     change->target_element = getMappedElement(getFile16BitBE(file));
1053
1054     change->delay_fixed = getFile16BitBE(file);
1055     change->delay_random = getFile16BitBE(file);
1056     change->delay_frames = getFile16BitBE(file);
1057
1058     change->trigger_element = getMappedElement(getFile16BitBE(file));
1059
1060     change->explode = getFile8Bit(file);
1061     change->use_content = getFile8Bit(file);
1062     change->only_complete = getFile8Bit(file);
1063     change->use_random_change = getFile8Bit(file);
1064
1065     change->random = getFile8Bit(file);
1066     change->power = getFile8Bit(file);
1067
1068     for (y = 0; y < 3; y++)
1069       for (x = 0; x < 3; x++)
1070         change->content[x][y] = getMappedElement(getFile16BitBE(file));
1071
1072     change->can_change = getFile8Bit(file);
1073
1074     change->sides = getFile8Bit(file);
1075
1076     if (change->sides == CH_SIDE_NONE)  /* correct empty sides field */
1077       change->sides = CH_SIDE_ANY;
1078
1079     /* some free bytes for future change property values and padding */
1080     ReadUnusedBytesFromFile(file, 8);
1081   }
1082
1083   /* mark this custom element as modified */
1084   ei->modified_settings = TRUE;
1085
1086   return chunk_size;
1087 }
1088
1089 static int LoadLevel_GRP1(FILE *file, int chunk_size, struct LevelInfo *level)
1090 {
1091   struct ElementInfo *ei;
1092   struct ElementGroupInfo *group;
1093   int element;
1094   int i;
1095
1096   element = getFile16BitBE(file);
1097
1098   if (!IS_GROUP_ELEMENT(element))
1099   {
1100     Error(ERR_WARN, "invalid group element number %d", element);
1101
1102     ReadUnusedBytesFromFile(file, chunk_size - 2);
1103     return chunk_size;
1104   }
1105
1106   ei = &element_info[element];
1107
1108   for (i = 0; i < MAX_ELEMENT_NAME_LEN; i++)
1109     ei->description[i] = getFile8Bit(file);
1110   ei->description[MAX_ELEMENT_NAME_LEN] = 0;
1111
1112   group = element_info[element].group;
1113
1114   group->num_elements = getFile8Bit(file);
1115
1116   ei->use_gfx_element = getFile8Bit(file);
1117   ei->gfx_element = getMappedElement(getFile16BitBE(file));
1118
1119   group->choice_mode = getFile8Bit(file);
1120
1121   /* some free bytes for future values and padding */
1122   ReadUnusedBytesFromFile(file, 3);
1123
1124   for (i = 0; i < MAX_ELEMENTS_IN_GROUP; i++)
1125     group->element[i] = getMappedElement(getFile16BitBE(file));
1126
1127   /* mark this group element as modified */
1128   element_info[element].modified_settings = TRUE;
1129
1130   return chunk_size;
1131 }
1132
1133 static void LoadLevelFromFileInfo_RND(struct LevelInfo *level,
1134                                       struct LevelFileInfo *level_file_info)
1135 {
1136   char *filename = level_file_info->filename;
1137   char cookie[MAX_LINE_LEN];
1138   char chunk_name[CHUNK_ID_LEN + 1];
1139   int chunk_size;
1140   FILE *file;
1141
1142   if (!(file = fopen(filename, MODE_READ)))
1143   {
1144     level->no_level_file = TRUE;
1145
1146     if (level != &level_template)
1147       Error(ERR_WARN, "cannot read level '%s' -- using empty level", filename);
1148
1149     return;
1150   }
1151
1152   getFileChunkBE(file, chunk_name, NULL);
1153   if (strcmp(chunk_name, "RND1") == 0)
1154   {
1155     getFile32BitBE(file);               /* not used */
1156
1157     getFileChunkBE(file, chunk_name, NULL);
1158     if (strcmp(chunk_name, "CAVE") != 0)
1159     {
1160       Error(ERR_WARN, "unknown format of level file '%s'", filename);
1161       fclose(file);
1162       return;
1163     }
1164   }
1165   else  /* check for pre-2.0 file format with cookie string */
1166   {
1167     strcpy(cookie, chunk_name);
1168     fgets(&cookie[4], MAX_LINE_LEN - 4, file);
1169     if (strlen(cookie) > 0 && cookie[strlen(cookie) - 1] == '\n')
1170       cookie[strlen(cookie) - 1] = '\0';
1171
1172     if (!checkCookieString(cookie, LEVEL_COOKIE_TMPL))
1173     {
1174       Error(ERR_WARN, "unknown format of level file '%s'", filename);
1175       fclose(file);
1176       return;
1177     }
1178
1179     if ((level->file_version = getFileVersionFromCookieString(cookie)) == -1)
1180     {
1181       Error(ERR_WARN, "unsupported version of level file '%s'", filename);
1182       fclose(file);
1183       return;
1184     }
1185
1186     /* pre-2.0 level files have no game version, so use file version here */
1187     level->game_version = level->file_version;
1188   }
1189
1190   if (level->file_version < FILE_VERSION_1_2)
1191   {
1192     /* level files from versions before 1.2.0 without chunk structure */
1193     LoadLevel_HEAD(file, LEVEL_HEADER_SIZE,             level);
1194     LoadLevel_BODY(file, level->fieldx * level->fieldy, level);
1195   }
1196   else
1197   {
1198     static struct
1199     {
1200       char *name;
1201       int size;
1202       int (*loader)(FILE *, int, struct LevelInfo *);
1203     }
1204     chunk_info[] =
1205     {
1206       { "VERS", FILE_VERS_CHUNK_SIZE,   LoadLevel_VERS },
1207       { "HEAD", LEVEL_HEADER_SIZE,      LoadLevel_HEAD },
1208       { "AUTH", MAX_LEVEL_AUTHOR_LEN,   LoadLevel_AUTH },
1209       { "BODY", -1,                     LoadLevel_BODY },
1210       { "CONT", -1,                     LoadLevel_CONT },
1211       { "CNT2", LEVEL_CHUNK_CNT2_SIZE,  LoadLevel_CNT2 },
1212       { "CNT3", -1,                     LoadLevel_CNT3 },
1213       { "CUS1", -1,                     LoadLevel_CUS1 },
1214       { "CUS2", -1,                     LoadLevel_CUS2 },
1215       { "CUS3", -1,                     LoadLevel_CUS3 },
1216       { "CUS4", -1,                     LoadLevel_CUS4 },
1217       { "GRP1", -1,                     LoadLevel_GRP1 },
1218       {  NULL,  0,                      NULL }
1219     };
1220
1221     while (getFileChunkBE(file, chunk_name, &chunk_size))
1222     {
1223       int i = 0;
1224
1225       while (chunk_info[i].name != NULL &&
1226              strcmp(chunk_name, chunk_info[i].name) != 0)
1227         i++;
1228
1229       if (chunk_info[i].name == NULL)
1230       {
1231         Error(ERR_WARN, "unknown chunk '%s' in level file '%s'",
1232               chunk_name, filename);
1233         ReadUnusedBytesFromFile(file, chunk_size);
1234       }
1235       else if (chunk_info[i].size != -1 &&
1236                chunk_info[i].size != chunk_size)
1237       {
1238         Error(ERR_WARN, "wrong size (%d) of chunk '%s' in level file '%s'",
1239               chunk_size, chunk_name, filename);
1240         ReadUnusedBytesFromFile(file, chunk_size);
1241       }
1242       else
1243       {
1244         /* call function to load this level chunk */
1245         int chunk_size_expected =
1246           (chunk_info[i].loader)(file, chunk_size, level);
1247
1248         /* the size of some chunks cannot be checked before reading other
1249            chunks first (like "HEAD" and "BODY") that contain some header
1250            information, so check them here */
1251         if (chunk_size_expected != chunk_size)
1252         {
1253           Error(ERR_WARN, "wrong size (%d) of chunk '%s' in level file '%s'",
1254                 chunk_size, chunk_name, filename);
1255         }
1256       }
1257     }
1258   }
1259
1260   fclose(file);
1261 }
1262
1263 /* ------------------------------------------------------------------------- */
1264 /* functions for loading EM level                                            */
1265 /* ------------------------------------------------------------------------- */
1266
1267 static int map_em_element_yam(int element)
1268 {
1269   switch (element)
1270   {
1271     case 0x00:  return EL_EMPTY;
1272     case 0x01:  return EL_EMERALD;
1273     case 0x02:  return EL_DIAMOND;
1274     case 0x03:  return EL_ROCK;
1275     case 0x04:  return EL_ROBOT;
1276     case 0x05:  return EL_SPACESHIP_UP;
1277     case 0x06:  return EL_BOMB;
1278     case 0x07:  return EL_BUG_UP;
1279     case 0x08:  return EL_AMOEBA_DROP;
1280     case 0x09:  return EL_NUT;
1281     case 0x0a:  return EL_YAMYAM;
1282     case 0x0b:  return EL_QUICKSAND_FULL;
1283     case 0x0c:  return EL_SAND;
1284     case 0x0d:  return EL_WALL_SLIPPERY;
1285     case 0x0e:  return EL_STEELWALL;
1286     case 0x0f:  return EL_WALL;
1287     case 0x10:  return EL_EM_KEY_1;
1288     case 0x11:  return EL_EM_KEY_2;
1289     case 0x12:  return EL_EM_KEY_4;
1290     case 0x13:  return EL_EM_KEY_3;
1291     case 0x14:  return EL_MAGIC_WALL;
1292     case 0x15:  return EL_ROBOT_WHEEL;
1293     case 0x16:  return EL_DYNAMITE;
1294
1295     case 0x17:  return EL_EM_KEY_1;                     /* EMC */
1296     case 0x18:  return EL_BUG_UP;                       /* EMC */
1297     case 0x1a:  return EL_DIAMOND;                      /* EMC */
1298     case 0x1b:  return EL_EMERALD;                      /* EMC */
1299     case 0x25:  return EL_NUT;                          /* EMC */
1300     case 0x80:  return EL_EMPTY;                        /* EMC */
1301     case 0x85:  return EL_EM_KEY_1;                     /* EMC */
1302     case 0x86:  return EL_EM_KEY_2;                     /* EMC */
1303     case 0x87:  return EL_EM_KEY_4;                     /* EMC */
1304     case 0x88:  return EL_EM_KEY_3;                     /* EMC */
1305     case 0x94:  return EL_QUICKSAND_EMPTY;              /* EMC */
1306     case 0x9a:  return EL_AMOEBA_WET;                   /* EMC */
1307     case 0xaf:  return EL_DYNAMITE;                     /* EMC */
1308     case 0xbd:  return EL_SAND;                         /* EMC */
1309
1310     default:
1311       Error(ERR_WARN, "invalid level element %d", element);
1312       return EL_UNKNOWN;
1313   }
1314 }
1315
1316 static int map_em_element_field(int element)
1317 {
1318   if (element >= 0xc8 && element <= 0xe1)
1319     return EL_CHAR_A + (element - 0xc8);
1320   else if (element >= 0xe2 && element <= 0xeb)
1321     return EL_CHAR_0 + (element - 0xe2);
1322
1323   switch (element)
1324   {
1325     case 0x00:  return EL_ROCK;
1326     case 0x01:  return EL_ROCK;                         /* EMC */
1327     case 0x02:  return EL_DIAMOND;
1328     case 0x03:  return EL_DIAMOND;
1329     case 0x04:  return EL_ROBOT;
1330     case 0x05:  return EL_ROBOT;                        /* EMC */
1331     case 0x06:  return EL_EMPTY_SPACE;                  /* EMC */
1332     case 0x07:  return EL_EMPTY_SPACE;                  /* EMC */
1333     case 0x08:  return EL_SPACESHIP_UP;
1334     case 0x09:  return EL_SPACESHIP_RIGHT;
1335     case 0x0a:  return EL_SPACESHIP_DOWN;
1336     case 0x0b:  return EL_SPACESHIP_LEFT;
1337     case 0x0c:  return EL_SPACESHIP_UP;
1338     case 0x0d:  return EL_SPACESHIP_RIGHT;
1339     case 0x0e:  return EL_SPACESHIP_DOWN;
1340     case 0x0f:  return EL_SPACESHIP_LEFT;
1341
1342     case 0x10:  return EL_BOMB;
1343     case 0x11:  return EL_BOMB;                         /* EMC */
1344     case 0x12:  return EL_EMERALD;
1345     case 0x13:  return EL_EMERALD;
1346     case 0x14:  return EL_BUG_UP;
1347     case 0x15:  return EL_BUG_RIGHT;
1348     case 0x16:  return EL_BUG_DOWN;
1349     case 0x17:  return EL_BUG_LEFT;
1350     case 0x18:  return EL_BUG_UP;
1351     case 0x19:  return EL_BUG_RIGHT;
1352     case 0x1a:  return EL_BUG_DOWN;
1353     case 0x1b:  return EL_BUG_LEFT;
1354     case 0x1c:  return EL_AMOEBA_DROP;
1355     case 0x1d:  return EL_AMOEBA_DROP;                  /* EMC */
1356     case 0x1e:  return EL_AMOEBA_DROP;                  /* EMC */
1357     case 0x1f:  return EL_AMOEBA_DROP;                  /* EMC */
1358
1359     case 0x20:  return EL_ROCK;
1360     case 0x21:  return EL_BOMB;                         /* EMC */
1361     case 0x22:  return EL_DIAMOND;                      /* EMC */
1362     case 0x23:  return EL_EMERALD;                      /* EMC */
1363     case 0x24:  return EL_MAGIC_WALL;
1364     case 0x25:  return EL_NUT;
1365     case 0x26:  return EL_NUT;                          /* EMC */
1366     case 0x27:  return EL_NUT;                          /* EMC */
1367
1368       /* looks like magic wheel, but is _always_ activated */
1369     case 0x28:  return EL_ROBOT_WHEEL;                  /* EMC */
1370
1371     case 0x29:  return EL_YAMYAM;       /* up */
1372     case 0x2a:  return EL_YAMYAM;       /* down */
1373     case 0x2b:  return EL_YAMYAM;       /* left */      /* EMC */
1374     case 0x2c:  return EL_YAMYAM;       /* right */     /* EMC */
1375     case 0x2d:  return EL_QUICKSAND_FULL;
1376     case 0x2e:  return EL_EMPTY_SPACE;                  /* EMC */
1377     case 0x2f:  return EL_EMPTY_SPACE;                  /* EMC */
1378
1379     case 0x30:  return EL_EMPTY_SPACE;                  /* EMC */
1380     case 0x31:  return EL_SAND;                         /* EMC */
1381     case 0x32:  return EL_SAND;                         /* EMC */
1382     case 0x33:  return EL_SAND;                         /* EMC */
1383     case 0x34:  return EL_QUICKSAND_FULL;               /* EMC */
1384     case 0x35:  return EL_QUICKSAND_FULL;               /* EMC */
1385     case 0x36:  return EL_QUICKSAND_FULL;               /* EMC */
1386     case 0x37:  return EL_SAND;                         /* EMC */
1387     case 0x38:  return EL_ROCK;                         /* EMC */
1388     case 0x39:  return EL_EXPANDABLE_WALL_HORIZONTAL;   /* EMC */
1389     case 0x3a:  return EL_EXPANDABLE_WALL_VERTICAL;     /* EMC */
1390     case 0x3b:  return EL_DYNAMITE_ACTIVE;      /* 1 */
1391     case 0x3c:  return EL_DYNAMITE_ACTIVE;      /* 2 */
1392     case 0x3d:  return EL_DYNAMITE_ACTIVE;      /* 3 */
1393     case 0x3e:  return EL_DYNAMITE_ACTIVE;      /* 4 */
1394     case 0x3f:  return EL_ACID_POOL_BOTTOM;
1395
1396     case 0x40:  return EL_EXIT_OPEN;    /* 1 */
1397     case 0x41:  return EL_EXIT_OPEN;    /* 2 */
1398     case 0x42:  return EL_EXIT_OPEN;    /* 3 */
1399     case 0x43:  return EL_BALLOON;                      /* EMC */
1400     case 0x44:  return EL_UNKNOWN;                      /* EMC ("plant") */
1401     case 0x45:  return EL_SPRING;                       /* EMC */
1402     case 0x46:  return EL_SPRING;       /* falling */   /* EMC */
1403     case 0x47:  return EL_SPRING;       /* left */      /* EMC */
1404     case 0x48:  return EL_SPRING;       /* right */     /* EMC */
1405     case 0x49:  return EL_UNKNOWN;                      /* EMC ("ball 1") */
1406     case 0x4a:  return EL_UNKNOWN;                      /* EMC ("ball 2") */
1407     case 0x4b:  return EL_UNKNOWN;                      /* EMC ("android") */
1408     case 0x4c:  return EL_EMPTY_SPACE;                  /* EMC */
1409     case 0x4d:  return EL_UNKNOWN;                      /* EMC ("android") */
1410     case 0x4e:  return EL_INVISIBLE_WALL;               /* EMC (? "android") */
1411     case 0x4f:  return EL_UNKNOWN;                      /* EMC ("android") */
1412
1413     case 0x50:  return EL_UNKNOWN;                      /* EMC ("android") */
1414     case 0x51:  return EL_UNKNOWN;                      /* EMC ("android") */
1415     case 0x52:  return EL_UNKNOWN;                      /* EMC ("android") */
1416     case 0x53:  return EL_UNKNOWN;                      /* EMC ("android") */
1417     case 0x54:  return EL_UNKNOWN;                      /* EMC ("android") */
1418     case 0x55:  return EL_EMPTY_SPACE;                  /* EMC */
1419     case 0x56:  return EL_EMPTY_SPACE;                  /* EMC */
1420     case 0x57:  return EL_EMPTY_SPACE;                  /* EMC */
1421     case 0x58:  return EL_EMPTY_SPACE;                  /* EMC */
1422     case 0x59:  return EL_EMPTY_SPACE;                  /* EMC */
1423     case 0x5a:  return EL_EMPTY_SPACE;                  /* EMC */
1424     case 0x5b:  return EL_EMPTY_SPACE;                  /* EMC */
1425     case 0x5c:  return EL_EMPTY_SPACE;                  /* EMC */
1426     case 0x5d:  return EL_EMPTY_SPACE;                  /* EMC */
1427     case 0x5e:  return EL_EMPTY_SPACE;                  /* EMC */
1428     case 0x5f:  return EL_EMPTY_SPACE;                  /* EMC */
1429
1430     case 0x60:  return EL_EMPTY_SPACE;                  /* EMC */
1431     case 0x61:  return EL_EMPTY_SPACE;                  /* EMC */
1432     case 0x62:  return EL_EMPTY_SPACE;                  /* EMC */
1433     case 0x63:  return EL_SPRING;       /* left */      /* EMC */
1434     case 0x64:  return EL_SPRING;       /* right */     /* EMC */
1435     case 0x65:  return EL_ACID;         /* 1 */         /* EMC */
1436     case 0x66:  return EL_ACID;         /* 2 */         /* EMC */
1437     case 0x67:  return EL_ACID;         /* 3 */         /* EMC */
1438     case 0x68:  return EL_ACID;         /* 4 */         /* EMC */
1439     case 0x69:  return EL_ACID;         /* 5 */         /* EMC */
1440     case 0x6a:  return EL_ACID;         /* 6 */         /* EMC */
1441     case 0x6b:  return EL_ACID;         /* 7 */         /* EMC */
1442     case 0x6c:  return EL_ACID;         /* 8 */         /* EMC */
1443     case 0x6d:  return EL_EMPTY_SPACE;                  /* EMC */
1444     case 0x6e:  return EL_EMPTY_SPACE;                  /* EMC */
1445     case 0x6f:  return EL_EMPTY_SPACE;                  /* EMC */
1446
1447     case 0x70:  return EL_EMPTY_SPACE;                  /* EMC */
1448     case 0x71:  return EL_EMPTY_SPACE;                  /* EMC */
1449     case 0x72:  return EL_NUT;          /* left */      /* EMC */
1450     case 0x73:  return EL_SAND;                         /* EMC (? "nut") */
1451     case 0x74:  return EL_STEELWALL;
1452     case 0x75:  return EL_EMPTY_SPACE;                  /* EMC */
1453     case 0x76:  return EL_EMPTY_SPACE;                  /* EMC */
1454     case 0x77:  return EL_BOMB;         /* left */      /* EMC */
1455     case 0x78:  return EL_BOMB;         /* right */     /* EMC */
1456     case 0x79:  return EL_ROCK;         /* left */      /* EMC */
1457     case 0x7a:  return EL_ROCK;         /* right */     /* EMC */
1458     case 0x7b:  return EL_ACID;                         /* (? EMC "blank") */
1459     case 0x7c:  return EL_EMPTY_SPACE;                  /* EMC */
1460     case 0x7d:  return EL_EMPTY_SPACE;                  /* EMC */
1461     case 0x7e:  return EL_EMPTY_SPACE;                  /* EMC */
1462     case 0x7f:  return EL_EMPTY_SPACE;                  /* EMC */
1463
1464     case 0x80:  return EL_EMPTY;
1465     case 0x81:  return EL_WALL_SLIPPERY;
1466     case 0x82:  return EL_SAND;
1467     case 0x83:  return EL_STEELWALL;
1468     case 0x84:  return EL_WALL;
1469     case 0x85:  return EL_EM_KEY_1;
1470     case 0x86:  return EL_EM_KEY_2;
1471     case 0x87:  return EL_EM_KEY_4;
1472     case 0x88:  return EL_EM_KEY_3;
1473     case 0x89:  return EL_EM_GATE_1;
1474     case 0x8a:  return EL_EM_GATE_2;
1475     case 0x8b:  return EL_EM_GATE_4;
1476     case 0x8c:  return EL_EM_GATE_3;
1477     case 0x8d:  return EL_INVISIBLE_WALL;               /* EMC (? "dripper") */
1478     case 0x8e:  return EL_EM_GATE_1_GRAY;
1479     case 0x8f:  return EL_EM_GATE_2_GRAY;
1480
1481     case 0x90:  return EL_EM_GATE_4_GRAY;
1482     case 0x91:  return EL_EM_GATE_3_GRAY;
1483     case 0x92:  return EL_MAGIC_WALL;
1484     case 0x93:  return EL_ROBOT_WHEEL;
1485     case 0x94:  return EL_QUICKSAND_EMPTY;              /* (? EMC "sand") */
1486     case 0x95:  return EL_ACID_POOL_TOPLEFT;
1487     case 0x96:  return EL_ACID_POOL_TOPRIGHT;
1488     case 0x97:  return EL_ACID_POOL_BOTTOMLEFT;
1489     case 0x98:  return EL_ACID_POOL_BOTTOMRIGHT;
1490     case 0x99:  return EL_ACID;                 /* (? EMC "fake blank") */
1491     case 0x9a:  return EL_AMOEBA_DEAD;          /* 1 */
1492     case 0x9b:  return EL_AMOEBA_DEAD;          /* 2 */
1493     case 0x9c:  return EL_AMOEBA_DEAD;          /* 3 */
1494     case 0x9d:  return EL_AMOEBA_DEAD;          /* 4 */
1495     case 0x9e:  return EL_EXIT_CLOSED;
1496     case 0x9f:  return EL_CHAR_LESS;            /* arrow left */
1497
1498       /* looks like normal sand, but behaves like wall */
1499     case 0xa0:  return EL_UNKNOWN;              /* EMC ("fake grass") */
1500     case 0xa1:  return EL_UNKNOWN;              /* EMC ("lenses") */
1501     case 0xa2:  return EL_UNKNOWN;              /* EMC ("magnify") */
1502     case 0xa3:  return EL_UNKNOWN;              /* EMC ("fake blank") */
1503     case 0xa4:  return EL_UNKNOWN;              /* EMC ("fake grass") */
1504     case 0xa5:  return EL_UNKNOWN;              /* EMC ("switch") */
1505     case 0xa6:  return EL_UNKNOWN;              /* EMC ("switch") */
1506     case 0xa7:  return EL_EMPTY_SPACE;                  /* EMC */
1507     case 0xa8:  return EL_EMC_WALL_1;                   /* EMC ("decor 8") */
1508     case 0xa9:  return EL_EMC_WALL_2;                   /* EMC ("decor 9") */
1509     case 0xaa:  return EL_EMC_WALL_3;                   /* EMC ("decor 10") */
1510     case 0xab:  return EL_EMC_WALL_7;                   /* EMC ("decor 5") */
1511     case 0xac:  return EL_CHAR_COMMA;                   /* EMC */
1512     case 0xad:  return EL_CHAR_QUOTEDBL;                /* EMC */
1513     case 0xae:  return EL_CHAR_MINUS;                   /* EMC */
1514     case 0xaf:  return EL_DYNAMITE;
1515
1516     case 0xb0:  return EL_EMC_STEELWALL_1;              /* EMC ("steel 3") */
1517     case 0xb1:  return EL_EMC_WALL_8;                   /* EMC ("decor 6") */
1518     case 0xb2:  return EL_UNKNOWN;                      /* EMC ("decor 7") */
1519     case 0xb3:  return EL_STEELWALL;            /* 2 */ /* EMC */
1520     case 0xb4:  return EL_WALL_SLIPPERY;        /* 2 */ /* EMC */
1521     case 0xb5:  return EL_EMC_WALL_6;                   /* EMC ("decor 2") */
1522     case 0xb6:  return EL_EMC_WALL_5;                   /* EMC ("decor 4") */
1523     case 0xb7:  return EL_EMC_WALL_4;                   /* EMC ("decor 3") */
1524     case 0xb8:  return EL_BALLOON_SWITCH_ANY;           /* EMC */
1525     case 0xb9:  return EL_BALLOON_SWITCH_RIGHT;         /* EMC */
1526     case 0xba:  return EL_BALLOON_SWITCH_DOWN;          /* EMC */
1527     case 0xbb:  return EL_BALLOON_SWITCH_LEFT;          /* EMC */
1528     case 0xbc:  return EL_BALLOON_SWITCH_UP;            /* EMC */
1529     case 0xbd:  return EL_SAND;                         /* EMC ("dirt") */
1530     case 0xbe:  return EL_UNKNOWN;                      /* EMC ("plant") */
1531     case 0xbf:  return EL_UNKNOWN;                      /* EMC ("key 5") */
1532
1533     case 0xc0:  return EL_UNKNOWN;                      /* EMC ("key 6") */
1534     case 0xc1:  return EL_UNKNOWN;                      /* EMC ("key 7") */
1535     case 0xc2:  return EL_UNKNOWN;                      /* EMC ("key 8") */
1536     case 0xc3:  return EL_UNKNOWN;                      /* EMC ("door 5") */
1537     case 0xc4:  return EL_UNKNOWN;                      /* EMC ("door 6") */
1538     case 0xc5:  return EL_UNKNOWN;                      /* EMC ("door 7") */
1539     case 0xc6:  return EL_UNKNOWN;                      /* EMC ("door 8") */
1540     case 0xc7:  return EL_UNKNOWN;                      /* EMC ("bumper") */
1541
1542       /* characters: see above */
1543
1544     case 0xec:  return EL_CHAR_PERIOD;
1545     case 0xed:  return EL_CHAR_EXCLAM;
1546     case 0xee:  return EL_CHAR_COLON;
1547     case 0xef:  return EL_CHAR_QUESTION;
1548
1549     case 0xf0:  return EL_CHAR_GREATER;                 /* arrow right */
1550     case 0xf1:  return EL_CHAR_COPYRIGHT;               /* EMC: "decor 1" */
1551     case 0xf2:  return EL_UNKNOWN;              /* EMC ("fake door 5") */
1552     case 0xf3:  return EL_UNKNOWN;              /* EMC ("fake door 6") */
1553     case 0xf4:  return EL_UNKNOWN;              /* EMC ("fake door 7") */
1554     case 0xf5:  return EL_UNKNOWN;              /* EMC ("fake door 8") */
1555     case 0xf6:  return EL_EMPTY_SPACE;                  /* EMC */
1556     case 0xf7:  return EL_EMPTY_SPACE;                  /* EMC */
1557
1558     case 0xf8:  return EL_EMPTY_SPACE;                  /* EMC */
1559     case 0xf9:  return EL_EMPTY_SPACE;                  /* EMC */
1560     case 0xfa:  return EL_EMPTY_SPACE;                  /* EMC */
1561     case 0xfb:  return EL_EMPTY_SPACE;                  /* EMC */
1562     case 0xfc:  return EL_EMPTY_SPACE;                  /* EMC */
1563     case 0xfd:  return EL_EMPTY_SPACE;                  /* EMC */
1564
1565     case 0xfe:  return EL_PLAYER_1;                     /* EMC: "blank" */
1566     case 0xff:  return EL_PLAYER_2;                     /* EMC: "blank" */
1567
1568     default:
1569       /* should never happen (all 8-bit value cases should be handled) */
1570       Error(ERR_WARN, "invalid level element %d", element);
1571       return EL_UNKNOWN;
1572   }
1573 }
1574
1575 #define EM_LEVEL_SIZE                   2106
1576 #define EM_LEVEL_XSIZE                  64
1577 #define EM_LEVEL_YSIZE                  32
1578
1579 static void LoadLevelFromFileInfo_EM(struct LevelInfo *level,
1580                                      struct LevelFileInfo *level_file_info)
1581 {
1582   char *filename = level_file_info->filename;
1583   FILE *file;
1584   unsigned char leveldata[EM_LEVEL_SIZE];
1585   unsigned char *header = &leveldata[EM_LEVEL_XSIZE * EM_LEVEL_YSIZE];
1586   unsigned char code0 = 0x65;
1587   unsigned char code1 = 0x11;
1588   boolean level_is_crypted = FALSE;
1589   int nr = level_file_info->nr;
1590   int i, x, y;
1591
1592   if (!(file = fopen(filename, MODE_READ)))
1593   {
1594     level->no_level_file = TRUE;
1595
1596     Error(ERR_WARN, "cannot read level '%s' -- using empty level", filename);
1597
1598     return;
1599   }
1600
1601   for(i = 0; i < EM_LEVEL_SIZE; i++)
1602     leveldata[i] = fgetc(file);
1603
1604   fclose(file);
1605
1606   /* check if level data is crypted by testing against known starting bytes
1607      of the few existing crypted level files (from Emerald Mine 1 + 2) */
1608
1609   if ((leveldata[0] == 0xf1 ||
1610        leveldata[0] == 0xf5) && leveldata[2] == 0xe7 && leveldata[3] == 0xee)
1611   {
1612     level_is_crypted = TRUE;
1613
1614     if (leveldata[0] == 0xf5)   /* error in crypted Emerald Mine 2 levels */
1615       leveldata[0] = 0xf1;
1616   }
1617
1618   if (level_is_crypted)         /* decode crypted level data */
1619   {
1620     for(i = 0; i < EM_LEVEL_SIZE; i++)
1621     {
1622       leveldata[i] ^= code0;
1623       leveldata[i] -= code1;
1624
1625       code0  = (code0 + 7) & 0xff;
1626     }
1627   }
1628
1629   level->fieldx = EM_LEVEL_XSIZE;
1630   level->fieldy = EM_LEVEL_YSIZE;
1631
1632   level->time           = header[46] * 10;
1633   level->gems_needed    = header[47];
1634
1635   /* The original Emerald Mine levels have their level number stored
1636      at the second byte of the level file...
1637      Do not trust this information at other level files, e.g. EMC,
1638      but correct it anyway (normally the first row is completely
1639      steel wall, so the correction does not hurt anyway). */
1640
1641   if (leveldata[1] == nr)
1642     leveldata[1] = leveldata[2];        /* correct level number field */
1643
1644   sprintf(level->name, "Level %d", nr);         /* set level name */
1645
1646   level->score[SC_EMERALD]      = header[36];
1647   level->score[SC_DIAMOND]      = header[37];
1648   level->score[SC_ROBOT]        = header[38];
1649   level->score[SC_SPACESHIP]    = header[39];
1650   level->score[SC_BUG]          = header[40];
1651   level->score[SC_YAMYAM]       = header[41];
1652   level->score[SC_NUT]          = header[42];
1653   level->score[SC_DYNAMITE]     = header[43];
1654   level->score[SC_TIME_BONUS]   = header[44];
1655
1656   level->num_yamyam_contents = 4;
1657
1658   for(i = 0; i < level->num_yamyam_contents; i++)
1659     for(y = 0; y < 3; y++)
1660       for(x = 0; x < 3; x++)
1661         level->yamyam_content[i][x][y] =
1662           map_em_element_yam(header[i * 9 + y * 3 + x]);
1663
1664   level->amoeba_speed           = (header[52] * 256 + header[53]) % 256;
1665   level->time_magic_wall        = (header[54] * 256 + header[55]) * 16 / 100;
1666   level->time_wheel             = (header[56] * 256 + header[57]) * 16 / 100;
1667   level->amoeba_content         = EL_DIAMOND;
1668
1669   for (y = 0; y < level->fieldy; y++) for (x = 0; x < level->fieldx; x++)
1670   {
1671     int new_element = map_em_element_field(leveldata[y * EM_LEVEL_XSIZE + x]);
1672
1673     if (new_element == EL_AMOEBA_DEAD && level->amoeba_speed)
1674       new_element = EL_AMOEBA_WET;
1675
1676     level->field[x][y] = new_element;
1677   }
1678
1679   x = (header[48] * 256 + header[49]) % EM_LEVEL_XSIZE;
1680   y = (header[48] * 256 + header[49]) / EM_LEVEL_XSIZE;
1681   level->field[x][y] = EL_PLAYER_1;
1682
1683   x = (header[50] * 256 + header[51]) % EM_LEVEL_XSIZE;
1684   y = (header[50] * 256 + header[51]) / EM_LEVEL_XSIZE;
1685   level->field[x][y] = EL_PLAYER_2;
1686 }
1687
1688 /* ------------------------------------------------------------------------- */
1689 /* functions for loading SP level                                            */
1690 /* ------------------------------------------------------------------------- */
1691
1692 #define NUM_SUPAPLEX_LEVELS_PER_PACKAGE 111
1693 #define SP_LEVEL_SIZE                   1536
1694 #define SP_LEVEL_XSIZE                  60
1695 #define SP_LEVEL_YSIZE                  24
1696 #define SP_LEVEL_NAME_LEN               23
1697
1698 static void LoadLevelFromFileStream_SP(FILE *file, struct LevelInfo *level,
1699                                        int nr)
1700 {
1701   int i, x, y;
1702
1703   /* read level body (width * height == 60 * 24 tiles == 1440 bytes) */
1704   for (y = 0; y < SP_LEVEL_YSIZE; y++)
1705   {
1706     for (x = 0; x < SP_LEVEL_XSIZE; x++)
1707     {
1708       int element_old = fgetc(file);
1709       int element_new;
1710
1711       if (element_old <= 0x27)
1712         element_new = getMappedElement(EL_SP_START + element_old);
1713       else if (element_old == 0x28)
1714         element_new = EL_INVISIBLE_WALL;
1715       else
1716       {
1717         Error(ERR_WARN, "in level %d, at position %d, %d:", nr, x, y);
1718         Error(ERR_WARN, "invalid level element %d", element_old);
1719
1720         element_new = EL_UNKNOWN;
1721       }
1722
1723       level->field[x][y] = element_new;
1724     }
1725   }
1726
1727   ReadUnusedBytesFromFile(file, 4);
1728
1729   /* Initial gravitation: 1 == "on", anything else (0) == "off" */
1730   level->initial_gravity = (fgetc(file) == 1 ? TRUE : FALSE);
1731
1732   ReadUnusedBytesFromFile(file, 1);
1733
1734   /* level title in uppercase letters, padded with dashes ("-") (23 bytes) */
1735   for (i = 0; i < SP_LEVEL_NAME_LEN; i++)
1736     level->name[i] = fgetc(file);
1737   level->name[SP_LEVEL_NAME_LEN] = '\0';
1738
1739   /* initial "freeze zonks": 2 == "on", anything else (0) == "off" */
1740   ReadUnusedBytesFromFile(file, 1);     /* !!! NOT SUPPORTED YET !!! */
1741
1742   /* number of infotrons needed; 0 means that Supaplex will count the total
1743      amount of infotrons in the level and use the low byte of that number.
1744      (a multiple of 256 infotrons will result in "0 infotrons needed"!) */
1745   level->gems_needed = fgetc(file);
1746
1747   /* information about special gravity port entries */
1748   ReadUnusedBytesFromFile(file, 65);    /* !!! NOT SUPPORTED YET !!! */
1749
1750   level->fieldx = SP_LEVEL_XSIZE;
1751   level->fieldy = SP_LEVEL_YSIZE;
1752
1753   level->time = 0;                      /* no time limit */
1754   level->amoeba_speed = 0;
1755   level->time_magic_wall = 0;
1756   level->time_wheel = 0;
1757   level->amoeba_content = EL_EMPTY;
1758
1759   for(i = 0; i < LEVEL_SCORE_ELEMENTS; i++)
1760     level->score[i] = 0;                /* !!! CORRECT THIS !!! */
1761
1762   /* there are no yamyams in supaplex levels */
1763   for(i = 0; i < level->num_yamyam_contents; i++)
1764     for(y = 0; y < 3; y++)
1765       for(x = 0; x < 3; x++)
1766         level->yamyam_content[i][x][y] = EL_EMPTY;
1767 }
1768
1769 static void LoadLevelFromFileInfo_SP(struct LevelInfo *level,
1770                                      struct LevelFileInfo *level_file_info)
1771 {
1772   char *filename = level_file_info->filename;
1773   FILE *file;
1774   int nr = level_file_info->nr - leveldir_current->first_level;
1775   int i, l, x, y;
1776   char name_first, name_last;
1777   struct LevelInfo multipart_level;
1778   int multipart_xpos, multipart_ypos;
1779   boolean is_multipart_level;
1780   boolean is_first_part;
1781   boolean reading_multipart_level = FALSE;
1782   boolean use_empty_level = FALSE;
1783
1784   if (!(file = fopen(filename, MODE_READ)))
1785   {
1786     level->no_level_file = TRUE;
1787
1788     Error(ERR_WARN, "cannot read level '%s' -- using empty level", filename);
1789
1790     return;
1791   }
1792
1793   /* position file stream to the requested level inside the level package */
1794   if (fseek(file, nr * SP_LEVEL_SIZE, SEEK_SET) != 0)
1795   {
1796     level->no_level_file = TRUE;
1797
1798     Error(ERR_WARN, "cannot fseek level '%s' -- using empty level", filename);
1799
1800     return;
1801   }
1802
1803   /* there exist Supaplex level package files with multi-part levels which
1804      can be detected as follows: instead of leading and trailing dashes ('-')
1805      to pad the level name, they have leading and trailing numbers which are
1806      the x and y coordinations of the current part of the multi-part level;
1807      if there are '?' characters instead of numbers on the left or right side
1808      of the level name, the multi-part level consists of only horizontal or
1809      vertical parts */
1810
1811   for (l = nr; l < NUM_SUPAPLEX_LEVELS_PER_PACKAGE; l++)
1812   {
1813     LoadLevelFromFileStream_SP(file, level, l);
1814
1815     /* check if this level is a part of a bigger multi-part level */
1816
1817     name_first = level->name[0];
1818     name_last  = level->name[SP_LEVEL_NAME_LEN - 1];
1819
1820     is_multipart_level =
1821       ((name_first == '?' || (name_first >= '0' && name_first <= '9')) &&
1822        (name_last  == '?' || (name_last  >= '0' && name_last  <= '9')));
1823
1824     is_first_part =
1825       ((name_first == '?' || name_first == '1') &&
1826        (name_last  == '?' || name_last  == '1'));
1827
1828     /* correct leading multipart level meta information in level name */
1829     for (i = 0; i < SP_LEVEL_NAME_LEN && level->name[i] == name_first; i++)
1830       level->name[i] = '-';
1831
1832     /* correct trailing multipart level meta information in level name */
1833     for (i = SP_LEVEL_NAME_LEN - 1; i>=0 && level->name[i] == name_last; i--)
1834       level->name[i] = '-';
1835
1836     /* ---------- check for normal single level ---------- */
1837
1838     if (!reading_multipart_level && !is_multipart_level)
1839     {
1840       /* the current level is simply a normal single-part level, and we are
1841          not reading a multi-part level yet, so return the level as it is */
1842
1843       break;
1844     }
1845
1846     /* ---------- check for empty level (unused multi-part) ---------- */
1847
1848     if (!reading_multipart_level && is_multipart_level && !is_first_part)
1849     {
1850       /* this is a part of a multi-part level, but not the first part
1851          (and we are not already reading parts of a multi-part level);
1852          in this case, use an empty level instead of the single part */
1853
1854       use_empty_level = TRUE;
1855
1856       break;
1857     }
1858
1859     /* ---------- check for finished multi-part level ---------- */
1860
1861     if (reading_multipart_level &&
1862         (!is_multipart_level ||
1863          strcmp(level->name, multipart_level.name) != 0))
1864     {
1865       /* we are already reading parts of a multi-part level, but this level is
1866          either not a multi-part level, or a part of a different multi-part
1867          level; in both cases, the multi-part level seems to be complete */
1868
1869       break;
1870     }
1871
1872     /* ---------- here we have one part of a multi-part level ---------- */
1873
1874     reading_multipart_level = TRUE;
1875
1876     if (is_first_part)  /* start with first part of new multi-part level */
1877     {
1878       /* copy level info structure from first part */
1879       multipart_level = *level;
1880
1881       /* clear playfield of new multi-part level */
1882       for (y = 0; y < MAX_LEV_FIELDY; y++)
1883         for (x = 0; x < MAX_LEV_FIELDX; x++)
1884           multipart_level.field[x][y] = EL_EMPTY;
1885     }
1886
1887     if (name_first == '?')
1888       name_first = '1';
1889     if (name_last == '?')
1890       name_last = '1';
1891
1892     multipart_xpos = (int)(name_first - '0');
1893     multipart_ypos = (int)(name_last  - '0');
1894
1895 #if 0
1896     printf("----------> part (%d/%d) of multi-part level '%s'\n",
1897            multipart_xpos, multipart_ypos, multipart_level.name);
1898 #endif
1899
1900     if (multipart_xpos * SP_LEVEL_XSIZE > MAX_LEV_FIELDX ||
1901         multipart_ypos * SP_LEVEL_YSIZE > MAX_LEV_FIELDY)
1902     {
1903       Error(ERR_WARN, "multi-part level is too big -- ignoring part of it");
1904
1905       break;
1906     }
1907
1908     multipart_level.fieldx = MAX(multipart_level.fieldx,
1909                                  multipart_xpos * SP_LEVEL_XSIZE);
1910     multipart_level.fieldy = MAX(multipart_level.fieldy,
1911                                  multipart_ypos * SP_LEVEL_YSIZE);
1912
1913     /* copy level part at the right position of multi-part level */
1914     for (y = 0; y < SP_LEVEL_YSIZE; y++)
1915     {
1916       for (x = 0; x < SP_LEVEL_XSIZE; x++)
1917       {
1918         int start_x = (multipart_xpos - 1) * SP_LEVEL_XSIZE;
1919         int start_y = (multipart_ypos - 1) * SP_LEVEL_YSIZE;
1920
1921         multipart_level.field[start_x + x][start_y + y] = level->field[x][y];
1922       }
1923     }
1924   }
1925
1926   fclose(file);
1927
1928   if (use_empty_level)
1929   {
1930     setLevelInfoToDefaults(level);
1931
1932     level->fieldx = SP_LEVEL_XSIZE;
1933     level->fieldy = SP_LEVEL_YSIZE;
1934
1935     for (y = 0; y < SP_LEVEL_YSIZE; y++)
1936       for (x = 0; x < SP_LEVEL_XSIZE; x++)
1937         level->field[x][y] = EL_EMPTY;
1938
1939     strcpy(level->name, "-------- EMPTY --------");
1940
1941     Error(ERR_WARN, "single part of multi-part level -- using empty level");
1942   }
1943
1944   if (reading_multipart_level)
1945     *level = multipart_level;
1946 }
1947
1948 /* ------------------------------------------------------------------------- */
1949 /* functions for loading generic level                                       */
1950 /* ------------------------------------------------------------------------- */
1951
1952 void LoadLevelFromFileInfo(struct LevelInfo *level,
1953                            struct LevelFileInfo *level_file_info)
1954 {
1955   /* always start with reliable default values */
1956   setLevelInfoToDefaults(level);
1957
1958   switch (level_file_info->type)
1959   {
1960     case LEVEL_FILE_TYPE_RND:
1961       LoadLevelFromFileInfo_RND(level, level_file_info);
1962       break;
1963
1964     case LEVEL_FILE_TYPE_EM:
1965       LoadLevelFromFileInfo_EM(level, level_file_info);
1966       break;
1967
1968     case LEVEL_FILE_TYPE_SP:
1969       LoadLevelFromFileInfo_SP(level, level_file_info);
1970       break;
1971
1972     default:
1973       LoadLevelFromFileInfo_RND(level, level_file_info);
1974       break;
1975   }
1976 }
1977
1978 void LoadLevelFromFilename(struct LevelInfo *level, char *filename)
1979 {
1980   static struct LevelFileInfo level_file_info;
1981
1982   /* always start with reliable default values */
1983   setFileInfoToDefaults(&level_file_info);
1984
1985   level_file_info.nr = 0;                       /* unknown level number */
1986   level_file_info.type = LEVEL_FILE_TYPE_RND;   /* no others supported yet */
1987   level_file_info.filename = filename;
1988
1989   LoadLevelFromFileInfo(level, &level_file_info);
1990 }
1991
1992 static void LoadLevel_InitVersion(struct LevelInfo *level, char *filename)
1993 {
1994   if (leveldir_current == NULL)         /* only when dumping level */
1995     return;
1996
1997 #if 0
1998   printf("::: sort_priority: %d\n", leveldir_current->sort_priority);
1999 #endif
2000
2001   /* determine correct game engine version of current level */
2002 #if 1
2003   if (!leveldir_current->latest_engine)
2004 #else
2005   if (IS_LEVELCLASS_CONTRIB(leveldir_current) ||
2006       IS_LEVELCLASS_PRIVATE(leveldir_current) ||
2007       IS_LEVELCLASS_UNDEFINED(leveldir_current))
2008 #endif
2009   {
2010 #if 0
2011     printf("\n::: This level is private or contributed: '%s'\n", filename);
2012 #endif
2013
2014 #if 0
2015     printf("\n::: Use the stored game engine version for this level\n");
2016 #endif
2017
2018     /* For all levels which are not forced to use the latest game engine
2019        version (normally user contributed, private and undefined levels),
2020        use the version of the game engine the levels were created for.
2021
2022        Since 2.0.1, the game engine version is now directly stored
2023        in the level file (chunk "VERS"), so there is no need anymore
2024        to set the game version from the file version (except for old,
2025        pre-2.0 levels, where the game version is still taken from the
2026        file format version used to store the level -- see above). */
2027
2028     /* do some special adjustments to support older level versions */
2029     if (level->file_version == FILE_VERSION_1_0)
2030     {
2031       Error(ERR_WARN, "level file '%s' has version number 1.0", filename);
2032       Error(ERR_WARN, "using high speed movement for player");
2033
2034       /* player was faster than monsters in (pre-)1.0 levels */
2035       level->double_speed = TRUE;
2036     }
2037
2038     /* Default behaviour for EM style gems was "slippery" only in 2.0.1 */
2039     if (level->game_version == VERSION_IDENT(2,0,1,0))
2040       level->em_slippery_gems = TRUE;
2041
2042     if (level->game_version < VERSION_IDENT(2,2,0,0))
2043       level->use_spring_bug = TRUE;
2044
2045     if (level->game_version < VERSION_IDENT(3,0,9,0))
2046     {
2047       level->can_move_into_acid = 0;    /* nothing can move into acid */
2048
2049       setMoveIntoAcid(level, EL_ROBOT);
2050       setMoveIntoAcid(level, EL_SATELLITE);
2051       setMoveIntoAcid(level, EL_PENGUIN);
2052       setMoveIntoAcid(level, EL_BALLOON);
2053     }
2054   }
2055   else
2056   {
2057 #if 0
2058     printf("\n::: ALWAYS USE LATEST ENGINE FOR THIS LEVEL: [%d] '%s'\n",
2059            leveldir_current->sort_priority, filename);
2060 #endif
2061
2062 #if 0
2063     printf("\n::: Use latest game engine version for this level.\n");
2064 #endif
2065
2066     /* For all levels which are forced to use the latest game engine version
2067        (normally all but user contributed, private and undefined levels), set
2068        the game engine version to the actual version; this allows for actual
2069        corrections in the game engine to take effect for existing, converted
2070        levels (from "classic" or other existing games) to make the emulation
2071        of the corresponding game more accurate, while (hopefully) not breaking
2072        existing levels created from other players. */
2073
2074 #if 0
2075     printf("::: changing engine from %d to %d\n",
2076            level->game_version, GAME_VERSION_ACTUAL);
2077 #endif
2078
2079     level->game_version = GAME_VERSION_ACTUAL;
2080
2081     /* Set special EM style gems behaviour: EM style gems slip down from
2082        normal, steel and growing wall. As this is a more fundamental change,
2083        it seems better to set the default behaviour to "off" (as it is more
2084        natural) and make it configurable in the level editor (as a property
2085        of gem style elements). Already existing converted levels (neither
2086        private nor contributed levels) are changed to the new behaviour. */
2087
2088     if (level->file_version < FILE_VERSION_2_0)
2089       level->em_slippery_gems = TRUE;
2090   }
2091
2092 #if 0
2093   printf("::: => %d\n", level->game_version);
2094 #endif
2095 }
2096
2097 static void LoadLevel_InitElements(struct LevelInfo *level, char *filename)
2098 {
2099   int i, j;
2100
2101   /* map custom element change events that have changed in newer versions
2102      (these following values were accidentally changed in version 3.0.1) */
2103   if (level->game_version <= VERSION_IDENT(3,0,0,0))
2104   {
2105     for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2106     {
2107       int element = EL_CUSTOM_START + i;
2108
2109       /* order of checking and copying events to be mapped is important */
2110       for (j = CE_BY_OTHER_ACTION; j >= CE_BY_PLAYER_OBSOLETE; j--)
2111       {
2112         if (HAS_CHANGE_EVENT(element, j - 2))
2113         {
2114           SET_CHANGE_EVENT(element, j - 2, FALSE);
2115           SET_CHANGE_EVENT(element, j, TRUE);
2116         }
2117       }
2118
2119       /* order of checking and copying events to be mapped is important */
2120       for (j = CE_OTHER_GETS_COLLECTED; j >= CE_HITTING_SOMETHING; j--)
2121       {
2122         if (HAS_CHANGE_EVENT(element, j - 1))
2123         {
2124           SET_CHANGE_EVENT(element, j - 1, FALSE);
2125           SET_CHANGE_EVENT(element, j, TRUE);
2126         }
2127       }
2128     }
2129   }
2130
2131   /* some custom element change events get mapped since version 3.0.3 */
2132   for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2133   {
2134     int element = EL_CUSTOM_START + i;
2135
2136     if (HAS_CHANGE_EVENT(element, CE_BY_PLAYER_OBSOLETE) ||
2137         HAS_CHANGE_EVENT(element, CE_BY_COLLISION_OBSOLETE))
2138     {
2139       SET_CHANGE_EVENT(element, CE_BY_PLAYER_OBSOLETE, FALSE);
2140       SET_CHANGE_EVENT(element, CE_BY_COLLISION_OBSOLETE, FALSE);
2141
2142       SET_CHANGE_EVENT(element, CE_BY_DIRECT_ACTION, TRUE);
2143     }
2144   }
2145
2146   /* initialize "can_change" field for old levels with only one change page */
2147   if (level->game_version <= VERSION_IDENT(3,0,2,0))
2148   {
2149     for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2150     {
2151       int element = EL_CUSTOM_START + i;
2152
2153       if (CAN_CHANGE(element))
2154         element_info[element].change->can_change = TRUE;
2155     }
2156   }
2157
2158 #if 0
2159   /* set default push delay values (corrected since version 3.0.7-1) */
2160   if (level->game_version < VERSION_IDENT(3,0,7,1))
2161   {
2162     game.default_push_delay_fixed = 2;
2163     game.default_push_delay_random = 8;
2164   }
2165   else
2166   {
2167     game.default_push_delay_fixed = 8;
2168     game.default_push_delay_random = 8;
2169   }
2170
2171   /* set uninitialized push delay values of custom elements in older levels */
2172   for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2173   {
2174     int element = EL_CUSTOM_START + i;
2175
2176     if (element_info[element].push_delay_fixed == -1)
2177       element_info[element].push_delay_fixed = game.default_push_delay_fixed;
2178     if (element_info[element].push_delay_random == -1)
2179       element_info[element].push_delay_random = game.default_push_delay_random;
2180   }
2181 #endif
2182
2183   /* initialize element properties for level editor etc. */
2184   InitElementPropertiesEngine(level->game_version);
2185 }
2186
2187 static void LoadLevel_InitPlayfield(struct LevelInfo *level, char *filename)
2188 {
2189   int x, y;
2190
2191   /* map elements that have changed in newer versions */
2192   for (y = 0; y < level->fieldy; y++)
2193   {
2194     for (x = 0; x < level->fieldx; x++)
2195     {
2196       int element = level->field[x][y];
2197
2198       if (level->game_version <= VERSION_IDENT(2,2,0,0))
2199       {
2200         /* map game font elements */
2201         element = (element == EL_CHAR('[')  ? EL_CHAR_AUMLAUT :
2202                    element == EL_CHAR('\\') ? EL_CHAR_OUMLAUT :
2203                    element == EL_CHAR(']')  ? EL_CHAR_UUMLAUT :
2204                    element == EL_CHAR('^')  ? EL_CHAR_COPYRIGHT : element);
2205       }
2206
2207       if (level->game_version < VERSION_IDENT(3,0,0,0))
2208       {
2209         /* map Supaplex gravity tube elements */
2210         element = (element == EL_SP_GRAVITY_PORT_LEFT  ? EL_SP_PORT_LEFT  :
2211                    element == EL_SP_GRAVITY_PORT_RIGHT ? EL_SP_PORT_RIGHT :
2212                    element == EL_SP_GRAVITY_PORT_UP    ? EL_SP_PORT_UP    :
2213                    element == EL_SP_GRAVITY_PORT_DOWN  ? EL_SP_PORT_DOWN  :
2214                    element);
2215       }
2216
2217       level->field[x][y] = element;
2218     }
2219   }
2220
2221   /* copy elements to runtime playfield array */
2222   for (x = 0; x < MAX_LEV_FIELDX; x++)
2223     for (y = 0; y < MAX_LEV_FIELDY; y++)
2224       Feld[x][y] = level->field[x][y];
2225
2226   /* initialize level size variables for faster access */
2227   lev_fieldx = level->fieldx;
2228   lev_fieldy = level->fieldy;
2229
2230   /* determine border element for this level */
2231   SetBorderElement();
2232 }
2233
2234 void LoadLevelTemplate(int nr)
2235 {
2236 #if 1
2237   struct LevelFileInfo *level_file_info = getLevelFileInfo(nr);
2238   char *filename = level_file_info->filename;
2239
2240   LoadLevelFromFileInfo(&level_template, level_file_info);
2241 #else
2242   char *filename = getDefaultLevelFilename(nr);
2243
2244   LoadLevelFromFilename_RND(&level_template, filename);
2245 #endif
2246
2247   LoadLevel_InitVersion(&level, filename);
2248   LoadLevel_InitElements(&level, filename);
2249
2250   ActivateLevelTemplate();
2251 }
2252
2253 void LoadLevel(int nr)
2254 {
2255 #if 1
2256   struct LevelFileInfo *level_file_info = getLevelFileInfo(nr);
2257   char *filename = level_file_info->filename;
2258
2259   LoadLevelFromFileInfo(&level, level_file_info);
2260 #else
2261   char *filename = getLevelFilename(nr);
2262
2263   LoadLevelFromFilename_RND(&level, filename);
2264 #endif
2265
2266   if (level.use_custom_template)
2267     LoadLevelTemplate(-1);
2268
2269 #if 1
2270   LoadLevel_InitVersion(&level, filename);
2271   LoadLevel_InitElements(&level, filename);
2272   LoadLevel_InitPlayfield(&level, filename);
2273 #else
2274   LoadLevel_InitLevel(&level, filename);
2275 #endif
2276 }
2277
2278 static void SaveLevel_VERS(FILE *file, struct LevelInfo *level)
2279 {
2280   putFileVersion(file, level->file_version);
2281   putFileVersion(file, level->game_version);
2282 }
2283
2284 static void SaveLevel_HEAD(FILE *file, struct LevelInfo *level)
2285 {
2286   int i, x, y;
2287
2288   putFile8Bit(file, level->fieldx);
2289   putFile8Bit(file, level->fieldy);
2290
2291   putFile16BitBE(file, level->time);
2292   putFile16BitBE(file, level->gems_needed);
2293
2294   for (i = 0; i < MAX_LEVEL_NAME_LEN; i++)
2295     putFile8Bit(file, level->name[i]);
2296
2297   for (i = 0; i < LEVEL_SCORE_ELEMENTS; i++)
2298     putFile8Bit(file, level->score[i]);
2299
2300   for (i = 0; i < STD_ELEMENT_CONTENTS; i++)
2301     for (y = 0; y < 3; y++)
2302       for (x = 0; x < 3; x++)
2303         putFile8Bit(file, (level->encoding_16bit_yamyam ? EL_EMPTY :
2304                            level->yamyam_content[i][x][y]));
2305   putFile8Bit(file, level->amoeba_speed);
2306   putFile8Bit(file, level->time_magic_wall);
2307   putFile8Bit(file, level->time_wheel);
2308   putFile8Bit(file, (level->encoding_16bit_amoeba ? EL_EMPTY :
2309                      level->amoeba_content));
2310   putFile8Bit(file, (level->double_speed ? 1 : 0));
2311   putFile8Bit(file, (level->initial_gravity ? 1 : 0));
2312   putFile8Bit(file, (level->encoding_16bit_field ? 1 : 0));
2313   putFile8Bit(file, (level->em_slippery_gems ? 1 : 0));
2314
2315   putFile8Bit(file, (level->use_custom_template ? 1 : 0));
2316
2317   putFile8Bit(file, (level->block_last_field ? 1 : 0));
2318   putFile8Bit(file, (level->sp_block_last_field ? 1 : 0));
2319
2320   putFile8Bit(file, (level->use_spring_bug ? 1 : 0));
2321
2322   WriteUnusedBytesToFile(file, LEVEL_HEADER_UNUSED);
2323 }
2324
2325 static void SaveLevel_AUTH(FILE *file, struct LevelInfo *level)
2326 {
2327   int i;
2328
2329   for (i = 0; i < MAX_LEVEL_AUTHOR_LEN; i++)
2330     putFile8Bit(file, level->author[i]);
2331 }
2332
2333 static void SaveLevel_BODY(FILE *file, struct LevelInfo *level)
2334 {
2335   int x, y;
2336
2337   for (y = 0; y < level->fieldy; y++) 
2338     for (x = 0; x < level->fieldx; x++) 
2339       if (level->encoding_16bit_field)
2340         putFile16BitBE(file, level->field[x][y]);
2341       else
2342         putFile8Bit(file, level->field[x][y]);
2343 }
2344
2345 #if 0
2346 static void SaveLevel_CONT(FILE *file, struct LevelInfo *level)
2347 {
2348   int i, x, y;
2349
2350   putFile8Bit(file, EL_YAMYAM);
2351   putFile8Bit(file, level->num_yamyam_contents);
2352   putFile8Bit(file, 0);
2353   putFile8Bit(file, 0);
2354
2355   for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
2356     for (y = 0; y < 3; y++)
2357       for (x = 0; x < 3; x++)
2358         if (level->encoding_16bit_field)
2359           putFile16BitBE(file, level->yamyam_content[i][x][y]);
2360         else
2361           putFile8Bit(file, level->yamyam_content[i][x][y]);
2362 }
2363 #endif
2364
2365 static void SaveLevel_CNT2(FILE *file, struct LevelInfo *level, int element)
2366 {
2367   int i, x, y;
2368   int num_contents, content_xsize, content_ysize;
2369   int content_array[MAX_ELEMENT_CONTENTS][3][3];
2370
2371   if (element == EL_YAMYAM)
2372   {
2373     num_contents = level->num_yamyam_contents;
2374     content_xsize = 3;
2375     content_ysize = 3;
2376
2377     for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
2378       for (y = 0; y < 3; y++)
2379         for (x = 0; x < 3; x++)
2380           content_array[i][x][y] = level->yamyam_content[i][x][y];
2381   }
2382   else if (element == EL_BD_AMOEBA)
2383   {
2384     num_contents = 1;
2385     content_xsize = 1;
2386     content_ysize = 1;
2387
2388     for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
2389       for (y = 0; y < 3; y++)
2390         for (x = 0; x < 3; x++)
2391           content_array[i][x][y] = EL_EMPTY;
2392     content_array[0][0][0] = level->amoeba_content;
2393   }
2394   else
2395   {
2396     /* chunk header already written -- write empty chunk data */
2397     WriteUnusedBytesToFile(file, LEVEL_CHUNK_CNT2_SIZE);
2398
2399     Error(ERR_WARN, "cannot save content for element '%d'", element);
2400     return;
2401   }
2402
2403   putFile16BitBE(file, element);
2404   putFile8Bit(file, num_contents);
2405   putFile8Bit(file, content_xsize);
2406   putFile8Bit(file, content_ysize);
2407
2408   WriteUnusedBytesToFile(file, LEVEL_CHUNK_CNT2_UNUSED);
2409
2410   for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
2411     for (y = 0; y < 3; y++)
2412       for (x = 0; x < 3; x++)
2413         putFile16BitBE(file, content_array[i][x][y]);
2414 }
2415
2416 static void SaveLevel_CNT3(FILE *file, struct LevelInfo *level, int element)
2417 {
2418   int i;
2419   int envelope_nr = element - EL_ENVELOPE_1;
2420   int envelope_len = strlen(level->envelope_text[envelope_nr]) + 1;
2421
2422   putFile16BitBE(file, element);
2423   putFile16BitBE(file, envelope_len);
2424   putFile8Bit(file, level->envelope_xsize[envelope_nr]);
2425   putFile8Bit(file, level->envelope_ysize[envelope_nr]);
2426
2427   WriteUnusedBytesToFile(file, LEVEL_CHUNK_CNT3_UNUSED);
2428
2429   for (i = 0; i < envelope_len; i++)
2430     putFile8Bit(file, level->envelope_text[envelope_nr][i]);
2431 }
2432
2433 #if 0
2434 static void SaveLevel_CUS1(FILE *file, struct LevelInfo *level,
2435                            int num_changed_custom_elements)
2436 {
2437   int i, check = 0;
2438
2439   putFile16BitBE(file, num_changed_custom_elements);
2440
2441   for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2442   {
2443     int element = EL_CUSTOM_START + i;
2444
2445     if (Properties[element][EP_BITFIELD_BASE] != EP_BITMASK_DEFAULT)
2446     {
2447       if (check < num_changed_custom_elements)
2448       {
2449         putFile16BitBE(file, element);
2450         putFile32BitBE(file, Properties[element][EP_BITFIELD_BASE]);
2451       }
2452
2453       check++;
2454     }
2455   }
2456
2457   if (check != num_changed_custom_elements)     /* should not happen */
2458     Error(ERR_WARN, "inconsistent number of custom element properties");
2459 }
2460 #endif
2461
2462 #if 0
2463 static void SaveLevel_CUS2(FILE *file, struct LevelInfo *level,
2464                            int num_changed_custom_elements)
2465 {
2466   int i, check = 0;
2467
2468   putFile16BitBE(file, num_changed_custom_elements);
2469
2470   for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2471   {
2472     int element = EL_CUSTOM_START + i;
2473
2474     if (element_info[element].change->target_element != EL_EMPTY_SPACE)
2475     {
2476       if (check < num_changed_custom_elements)
2477       {
2478         putFile16BitBE(file, element);
2479         putFile16BitBE(file, element_info[element].change->target_element);
2480       }
2481
2482       check++;
2483     }
2484   }
2485
2486   if (check != num_changed_custom_elements)     /* should not happen */
2487     Error(ERR_WARN, "inconsistent number of custom target elements");
2488 }
2489 #endif
2490
2491 #if 0
2492 static void SaveLevel_CUS3(FILE *file, struct LevelInfo *level,
2493                            int num_changed_custom_elements)
2494 {
2495   int i, j, x, y, check = 0;
2496
2497   putFile16BitBE(file, num_changed_custom_elements);
2498
2499   for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2500   {
2501     int element = EL_CUSTOM_START + i;
2502
2503     if (element_info[element].modified_settings)
2504     {
2505       if (check < num_changed_custom_elements)
2506       {
2507         putFile16BitBE(file, element);
2508
2509         for (j = 0; j < MAX_ELEMENT_NAME_LEN; j++)
2510           putFile8Bit(file, element_info[element].description[j]);
2511
2512         putFile32BitBE(file, Properties[element][EP_BITFIELD_BASE]);
2513
2514         /* some free bytes for future properties and padding */
2515         WriteUnusedBytesToFile(file, 7);
2516
2517         putFile8Bit(file, element_info[element].use_gfx_element);
2518         putFile16BitBE(file, element_info[element].gfx_element);
2519
2520         putFile8Bit(file, element_info[element].collect_score);
2521         putFile8Bit(file, element_info[element].collect_count);
2522
2523         putFile16BitBE(file, element_info[element].push_delay_fixed);
2524         putFile16BitBE(file, element_info[element].push_delay_random);
2525         putFile16BitBE(file, element_info[element].move_delay_fixed);
2526         putFile16BitBE(file, element_info[element].move_delay_random);
2527
2528         putFile16BitBE(file, element_info[element].move_pattern);
2529         putFile8Bit(file, element_info[element].move_direction_initial);
2530         putFile8Bit(file, element_info[element].move_stepsize);
2531
2532         for (y = 0; y < 3; y++)
2533           for (x = 0; x < 3; x++)
2534             putFile16BitBE(file, element_info[element].content[x][y]);
2535
2536         putFile32BitBE(file, element_info[element].change->events);
2537
2538         putFile16BitBE(file, element_info[element].change->target_element);
2539
2540         putFile16BitBE(file, element_info[element].change->delay_fixed);
2541         putFile16BitBE(file, element_info[element].change->delay_random);
2542         putFile16BitBE(file, element_info[element].change->delay_frames);
2543
2544         putFile16BitBE(file, element_info[element].change->trigger_element);
2545
2546         putFile8Bit(file, element_info[element].change->explode);
2547         putFile8Bit(file, element_info[element].change->use_content);
2548         putFile8Bit(file, element_info[element].change->only_complete);
2549         putFile8Bit(file, element_info[element].change->use_random_change);
2550
2551         putFile8Bit(file, element_info[element].change->random);
2552         putFile8Bit(file, element_info[element].change->power);
2553
2554         for (y = 0; y < 3; y++)
2555           for (x = 0; x < 3; x++)
2556             putFile16BitBE(file, element_info[element].change->content[x][y]);
2557
2558         putFile8Bit(file, element_info[element].slippery_type);
2559
2560         /* some free bytes for future properties and padding */
2561         WriteUnusedBytesToFile(file, LEVEL_CPART_CUS3_UNUSED);
2562       }
2563
2564       check++;
2565     }
2566   }
2567
2568   if (check != num_changed_custom_elements)     /* should not happen */
2569     Error(ERR_WARN, "inconsistent number of custom element properties");
2570 }
2571 #endif
2572
2573 static void SaveLevel_CUS4(FILE *file, struct LevelInfo *level, int element)
2574 {
2575   struct ElementInfo *ei = &element_info[element];
2576   int i, x, y;
2577
2578   putFile16BitBE(file, element);
2579
2580   for (i = 0; i < MAX_ELEMENT_NAME_LEN; i++)
2581     putFile8Bit(file, ei->description[i]);
2582
2583   putFile32BitBE(file, Properties[element][EP_BITFIELD_BASE]);
2584   WriteUnusedBytesToFile(file, 4);      /* reserved for more base properties */
2585
2586   putFile8Bit(file, ei->num_change_pages);
2587
2588   /* some free bytes for future base property values and padding */
2589   WriteUnusedBytesToFile(file, 5);
2590
2591   /* write custom property values */
2592
2593   putFile8Bit(file, ei->use_gfx_element);
2594   putFile16BitBE(file, ei->gfx_element);
2595
2596   putFile8Bit(file, ei->collect_score);
2597   putFile8Bit(file, ei->collect_count);
2598
2599   putFile16BitBE(file, ei->push_delay_fixed);
2600   putFile16BitBE(file, ei->push_delay_random);
2601   putFile16BitBE(file, ei->move_delay_fixed);
2602   putFile16BitBE(file, ei->move_delay_random);
2603
2604   /* bits 0 - 15 of "move_pattern" ... */
2605   putFile16BitBE(file, ei->move_pattern & 0xffff);
2606   putFile8Bit(file, ei->move_direction_initial);
2607   putFile8Bit(file, ei->move_stepsize);
2608
2609   putFile8Bit(file, ei->slippery_type);
2610
2611   for (y = 0; y < 3; y++)
2612     for (x = 0; x < 3; x++)
2613       putFile16BitBE(file, ei->content[x][y]);
2614
2615   putFile16BitBE(file, ei->move_enter_element);
2616   putFile16BitBE(file, ei->move_leave_element);
2617   putFile8Bit(file, ei->move_leave_type);
2618
2619   /* ... bits 16 - 31 of "move_pattern" (not nice, but downward compatible) */
2620   putFile16BitBE(file, (ei->move_pattern >> 16) & 0xffff);
2621
2622   putFile8Bit(file, ei->access_direction);
2623
2624   putFile8Bit(file, ei->explosion_delay);
2625   putFile8Bit(file, ei->ignition_delay);
2626
2627   /* some free bytes for future custom property values and padding */
2628   WriteUnusedBytesToFile(file, 2);
2629
2630   /* write change property values */
2631
2632   for (i = 0; i < ei->num_change_pages; i++)
2633   {
2634     struct ElementChangeInfo *change = &ei->change_page[i];
2635
2636     putFile32BitBE(file, change->events);
2637
2638     putFile16BitBE(file, change->target_element);
2639
2640     putFile16BitBE(file, change->delay_fixed);
2641     putFile16BitBE(file, change->delay_random);
2642     putFile16BitBE(file, change->delay_frames);
2643
2644     putFile16BitBE(file, change->trigger_element);
2645
2646     putFile8Bit(file, change->explode);
2647     putFile8Bit(file, change->use_content);
2648     putFile8Bit(file, change->only_complete);
2649     putFile8Bit(file, change->use_random_change);
2650
2651     putFile8Bit(file, change->random);
2652     putFile8Bit(file, change->power);
2653
2654     for (y = 0; y < 3; y++)
2655       for (x = 0; x < 3; x++)
2656         putFile16BitBE(file, change->content[x][y]);
2657
2658     putFile8Bit(file, change->can_change);
2659
2660     putFile8Bit(file, change->sides);
2661
2662     /* some free bytes for future change property values and padding */
2663     WriteUnusedBytesToFile(file, 8);
2664   }
2665 }
2666
2667 static void SaveLevel_GRP1(FILE *file, struct LevelInfo *level, int element)
2668 {
2669   struct ElementInfo *ei = &element_info[element];
2670   struct ElementGroupInfo *group = ei->group;
2671   int i;
2672
2673   putFile16BitBE(file, element);
2674
2675   for (i = 0; i < MAX_ELEMENT_NAME_LEN; i++)
2676     putFile8Bit(file, ei->description[i]);
2677
2678   putFile8Bit(file, group->num_elements);
2679
2680   putFile8Bit(file, ei->use_gfx_element);
2681   putFile16BitBE(file, ei->gfx_element);
2682
2683   putFile8Bit(file, group->choice_mode);
2684
2685   /* some free bytes for future values and padding */
2686   WriteUnusedBytesToFile(file, 3);
2687
2688   for (i = 0; i < MAX_ELEMENTS_IN_GROUP; i++)
2689     putFile16BitBE(file, group->element[i]);
2690 }
2691
2692 static void SaveLevelFromFilename(struct LevelInfo *level, char *filename)
2693 {
2694   int body_chunk_size;
2695   int i, x, y;
2696   FILE *file;
2697
2698   if (!(file = fopen(filename, MODE_WRITE)))
2699   {
2700     Error(ERR_WARN, "cannot save level file '%s'", filename);
2701     return;
2702   }
2703
2704   level->file_version = FILE_VERSION_ACTUAL;
2705   level->game_version = GAME_VERSION_ACTUAL;
2706
2707   /* check level field for 16-bit elements */
2708   level->encoding_16bit_field = FALSE;
2709   for (y = 0; y < level->fieldy; y++) 
2710     for (x = 0; x < level->fieldx; x++) 
2711       if (level->field[x][y] > 255)
2712         level->encoding_16bit_field = TRUE;
2713
2714   /* check yamyam content for 16-bit elements */
2715   level->encoding_16bit_yamyam = FALSE;
2716   for (i = 0; i < level->num_yamyam_contents; i++)
2717     for (y = 0; y < 3; y++)
2718       for (x = 0; x < 3; x++)
2719         if (level->yamyam_content[i][x][y] > 255)
2720           level->encoding_16bit_yamyam = TRUE;
2721
2722   /* check amoeba content for 16-bit elements */
2723   level->encoding_16bit_amoeba = FALSE;
2724   if (level->amoeba_content > 255)
2725     level->encoding_16bit_amoeba = TRUE;
2726
2727   /* calculate size of "BODY" chunk */
2728   body_chunk_size =
2729     level->fieldx * level->fieldy * (level->encoding_16bit_field ? 2 : 1);
2730
2731   putFileChunkBE(file, "RND1", CHUNK_SIZE_UNDEFINED);
2732   putFileChunkBE(file, "CAVE", CHUNK_SIZE_NONE);
2733
2734   putFileChunkBE(file, "VERS", FILE_VERS_CHUNK_SIZE);
2735   SaveLevel_VERS(file, level);
2736
2737   putFileChunkBE(file, "HEAD", LEVEL_HEADER_SIZE);
2738   SaveLevel_HEAD(file, level);
2739
2740   putFileChunkBE(file, "AUTH", MAX_LEVEL_AUTHOR_LEN);
2741   SaveLevel_AUTH(file, level);
2742
2743   putFileChunkBE(file, "BODY", body_chunk_size);
2744   SaveLevel_BODY(file, level);
2745
2746   if (level->encoding_16bit_yamyam ||
2747       level->num_yamyam_contents != STD_ELEMENT_CONTENTS)
2748   {
2749     putFileChunkBE(file, "CNT2", LEVEL_CHUNK_CNT2_SIZE);
2750     SaveLevel_CNT2(file, level, EL_YAMYAM);
2751   }
2752
2753   if (level->encoding_16bit_amoeba)
2754   {
2755     putFileChunkBE(file, "CNT2", LEVEL_CHUNK_CNT2_SIZE);
2756     SaveLevel_CNT2(file, level, EL_BD_AMOEBA);
2757   }
2758
2759   /* check for envelope content */
2760   for (i = 0; i < 4; i++)
2761   {
2762     if (strlen(level->envelope_text[i]) > 0)
2763     {
2764       int envelope_len = strlen(level->envelope_text[i]) + 1;
2765
2766       putFileChunkBE(file, "CNT3", LEVEL_CHUNK_CNT3_SIZE(envelope_len));
2767       SaveLevel_CNT3(file, level, EL_ENVELOPE_1 + i);
2768     }
2769   }
2770
2771   /* check for non-default custom elements (unless using template level) */
2772   if (!level->use_custom_template)
2773   {
2774     for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2775     {
2776       int element = EL_CUSTOM_START + i;
2777
2778       if (element_info[element].modified_settings)
2779       {
2780         int num_change_pages = element_info[element].num_change_pages;
2781
2782         putFileChunkBE(file, "CUS4", LEVEL_CHUNK_CUS4_SIZE(num_change_pages));
2783         SaveLevel_CUS4(file, level, element);
2784       }
2785     }
2786   }
2787
2788   /* check for non-default group elements (unless using template level) */
2789   if (!level->use_custom_template)
2790   {
2791     for (i = 0; i < NUM_GROUP_ELEMENTS; i++)
2792     {
2793       int element = EL_GROUP_START + i;
2794
2795       if (element_info[element].modified_settings)
2796       {
2797         putFileChunkBE(file, "GRP1", LEVEL_CHUNK_GRP1_SIZE);
2798         SaveLevel_GRP1(file, level, element);
2799       }
2800     }
2801   }
2802
2803   fclose(file);
2804
2805   SetFilePermissions(filename, PERMS_PRIVATE);
2806 }
2807
2808 void SaveLevel(int nr)
2809 {
2810   char *filename = getDefaultLevelFilename(nr);
2811
2812   SaveLevelFromFilename(&level, filename);
2813 }
2814
2815 void SaveLevelTemplate()
2816 {
2817   char *filename = getDefaultLevelFilename(-1);
2818
2819   SaveLevelFromFilename(&level, filename);
2820 }
2821
2822 void DumpLevel(struct LevelInfo *level)
2823 {
2824   printf_line("-", 79);
2825   printf("Level xxx (file version %08d, game version %08d)\n",
2826          level->file_version, level->game_version);
2827   printf_line("-", 79);
2828
2829   printf("Level author: '%s'\n", level->author);
2830   printf("Level title:  '%s'\n", level->name);
2831   printf("\n");
2832   printf("Playfield size: %d x %d\n", level->fieldx, level->fieldy);
2833   printf("\n");
2834   printf("Level time:  %d seconds\n", level->time);
2835   printf("Gems needed: %d\n", level->gems_needed);
2836   printf("\n");
2837   printf("Time for magic wall: %d seconds\n", level->time_magic_wall);
2838   printf("Time for wheel:      %d seconds\n", level->time_wheel);
2839   printf("Time for light:      %d seconds\n", level->time_light);
2840   printf("Time for timegate:   %d seconds\n", level->time_timegate);
2841   printf("\n");
2842   printf("Amoeba speed: %d\n", level->amoeba_speed);
2843   printf("\n");
2844   printf("Initial gravity:             %s\n", (level->initial_gravity ? "yes" : "no"));
2845   printf("Double speed movement:       %s\n", (level->double_speed ? "yes" : "no"));
2846   printf("EM style slippery gems:      %s\n", (level->em_slippery_gems ? "yes" : "no"));
2847   printf("Player blocks last field:    %s\n", (level->block_last_field ? "yes" : "no"));
2848   printf("SP player blocks last field: %s\n", (level->sp_block_last_field ? "yes" : "no"));
2849   printf("use spring bug: %s\n", (level->use_spring_bug ? "yes" : "no"));
2850
2851   printf_line("-", 79);
2852 }
2853
2854
2855 /* ========================================================================= */
2856 /* tape file functions                                                       */
2857 /* ========================================================================= */
2858
2859 static void setTapeInfoToDefaults()
2860 {
2861   int i;
2862
2863   /* always start with reliable default values (empty tape) */
2864   TapeErase();
2865
2866   /* default values (also for pre-1.2 tapes) with only the first player */
2867   tape.player_participates[0] = TRUE;
2868   for (i = 1; i < MAX_PLAYERS; i++)
2869     tape.player_participates[i] = FALSE;
2870
2871   /* at least one (default: the first) player participates in every tape */
2872   tape.num_participating_players = 1;
2873
2874   tape.level_nr = level_nr;
2875   tape.counter = 0;
2876   tape.changed = FALSE;
2877
2878   tape.recording = FALSE;
2879   tape.playing = FALSE;
2880   tape.pausing = FALSE;
2881 }
2882
2883 static int LoadTape_VERS(FILE *file, int chunk_size, struct TapeInfo *tape)
2884 {
2885   tape->file_version = getFileVersion(file);
2886   tape->game_version = getFileVersion(file);
2887
2888   return chunk_size;
2889 }
2890
2891 static int LoadTape_HEAD(FILE *file, int chunk_size, struct TapeInfo *tape)
2892 {
2893   int i;
2894
2895   tape->random_seed = getFile32BitBE(file);
2896   tape->date        = getFile32BitBE(file);
2897   tape->length      = getFile32BitBE(file);
2898
2899   /* read header fields that are new since version 1.2 */
2900   if (tape->file_version >= FILE_VERSION_1_2)
2901   {
2902     byte store_participating_players = getFile8Bit(file);
2903     int engine_version;
2904
2905     /* since version 1.2, tapes store which players participate in the tape */
2906     tape->num_participating_players = 0;
2907     for (i = 0; i < MAX_PLAYERS; i++)
2908     {
2909       tape->player_participates[i] = FALSE;
2910
2911       if (store_participating_players & (1 << i))
2912       {
2913         tape->player_participates[i] = TRUE;
2914         tape->num_participating_players++;
2915       }
2916     }
2917
2918     ReadUnusedBytesFromFile(file, TAPE_HEADER_UNUSED);
2919
2920     engine_version = getFileVersion(file);
2921     if (engine_version > 0)
2922       tape->engine_version = engine_version;
2923     else
2924       tape->engine_version = tape->game_version;
2925   }
2926
2927   return chunk_size;
2928 }
2929
2930 static int LoadTape_INFO(FILE *file, int chunk_size, struct TapeInfo *tape)
2931 {
2932   int level_identifier_size;
2933   int i;
2934
2935   level_identifier_size = getFile16BitBE(file);
2936
2937   tape->level_identifier =
2938     checked_realloc(tape->level_identifier, level_identifier_size);
2939
2940   for (i = 0; i < level_identifier_size; i++)
2941     tape->level_identifier[i] = getFile8Bit(file);
2942
2943   tape->level_nr = getFile16BitBE(file);
2944
2945   chunk_size = 2 + level_identifier_size + 2;
2946
2947   return chunk_size;
2948 }
2949
2950 static int LoadTape_BODY(FILE *file, int chunk_size, struct TapeInfo *tape)
2951 {
2952   int i, j;
2953   int chunk_size_expected =
2954     (tape->num_participating_players + 1) * tape->length;
2955
2956   if (chunk_size_expected != chunk_size)
2957   {
2958     ReadUnusedBytesFromFile(file, chunk_size);
2959     return chunk_size_expected;
2960   }
2961
2962   for (i = 0; i < tape->length; i++)
2963   {
2964     if (i >= MAX_TAPELEN)
2965       break;
2966
2967     for (j = 0; j < MAX_PLAYERS; j++)
2968     {
2969       tape->pos[i].action[j] = MV_NO_MOVING;
2970
2971       if (tape->player_participates[j])
2972         tape->pos[i].action[j] = getFile8Bit(file);
2973     }
2974
2975     tape->pos[i].delay = getFile8Bit(file);
2976
2977     if (tape->file_version == FILE_VERSION_1_0)
2978     {
2979       /* eliminate possible diagonal moves in old tapes */
2980       /* this is only for backward compatibility */
2981
2982       byte joy_dir[4] = { JOY_LEFT, JOY_RIGHT, JOY_UP, JOY_DOWN };
2983       byte action = tape->pos[i].action[0];
2984       int k, num_moves = 0;
2985
2986       for (k = 0; k<4; k++)
2987       {
2988         if (action & joy_dir[k])
2989         {
2990           tape->pos[i + num_moves].action[0] = joy_dir[k];
2991           if (num_moves > 0)
2992             tape->pos[i + num_moves].delay = 0;
2993           num_moves++;
2994         }
2995       }
2996
2997       if (num_moves > 1)
2998       {
2999         num_moves--;
3000         i += num_moves;
3001         tape->length += num_moves;
3002       }
3003     }
3004     else if (tape->file_version < FILE_VERSION_2_0)
3005     {
3006       /* convert pre-2.0 tapes to new tape format */
3007
3008       if (tape->pos[i].delay > 1)
3009       {
3010         /* action part */
3011         tape->pos[i + 1] = tape->pos[i];
3012         tape->pos[i + 1].delay = 1;
3013
3014         /* delay part */
3015         for (j = 0; j < MAX_PLAYERS; j++)
3016           tape->pos[i].action[j] = MV_NO_MOVING;
3017         tape->pos[i].delay--;
3018
3019         i++;
3020         tape->length++;
3021       }
3022     }
3023
3024     if (feof(file))
3025       break;
3026   }
3027
3028   if (i != tape->length)
3029     chunk_size = (tape->num_participating_players + 1) * i;
3030
3031   return chunk_size;
3032 }
3033
3034 void LoadTapeFromFilename(char *filename)
3035 {
3036   char cookie[MAX_LINE_LEN];
3037   char chunk_name[CHUNK_ID_LEN + 1];
3038   FILE *file;
3039   int chunk_size;
3040
3041   /* always start with reliable default values */
3042   setTapeInfoToDefaults();
3043
3044   if (!(file = fopen(filename, MODE_READ)))
3045     return;
3046
3047   getFileChunkBE(file, chunk_name, NULL);
3048   if (strcmp(chunk_name, "RND1") == 0)
3049   {
3050     getFile32BitBE(file);               /* not used */
3051
3052     getFileChunkBE(file, chunk_name, NULL);
3053     if (strcmp(chunk_name, "TAPE") != 0)
3054     {
3055       Error(ERR_WARN, "unknown format of tape file '%s'", filename);
3056       fclose(file);
3057       return;
3058     }
3059   }
3060   else  /* check for pre-2.0 file format with cookie string */
3061   {
3062     strcpy(cookie, chunk_name);
3063     fgets(&cookie[4], MAX_LINE_LEN - 4, file);
3064     if (strlen(cookie) > 0 && cookie[strlen(cookie) - 1] == '\n')
3065       cookie[strlen(cookie) - 1] = '\0';
3066
3067     if (!checkCookieString(cookie, TAPE_COOKIE_TMPL))
3068     {
3069       Error(ERR_WARN, "unknown format of tape file '%s'", filename);
3070       fclose(file);
3071       return;
3072     }
3073
3074     if ((tape.file_version = getFileVersionFromCookieString(cookie)) == -1)
3075     {
3076       Error(ERR_WARN, "unsupported version of tape file '%s'", filename);
3077       fclose(file);
3078       return;
3079     }
3080
3081     /* pre-2.0 tape files have no game version, so use file version here */
3082     tape.game_version = tape.file_version;
3083   }
3084
3085   if (tape.file_version < FILE_VERSION_1_2)
3086   {
3087     /* tape files from versions before 1.2.0 without chunk structure */
3088     LoadTape_HEAD(file, TAPE_HEADER_SIZE, &tape);
3089     LoadTape_BODY(file, 2 * tape.length,  &tape);
3090   }
3091   else
3092   {
3093     static struct
3094     {
3095       char *name;
3096       int size;
3097       int (*loader)(FILE *, int, struct TapeInfo *);
3098     }
3099     chunk_info[] =
3100     {
3101       { "VERS", FILE_VERS_CHUNK_SIZE,   LoadTape_VERS },
3102       { "HEAD", TAPE_HEADER_SIZE,       LoadTape_HEAD },
3103       { "INFO", -1,                     LoadTape_INFO },
3104       { "BODY", -1,                     LoadTape_BODY },
3105       {  NULL,  0,                      NULL }
3106     };
3107
3108     while (getFileChunkBE(file, chunk_name, &chunk_size))
3109     {
3110       int i = 0;
3111
3112       while (chunk_info[i].name != NULL &&
3113              strcmp(chunk_name, chunk_info[i].name) != 0)
3114         i++;
3115
3116       if (chunk_info[i].name == NULL)
3117       {
3118         Error(ERR_WARN, "unknown chunk '%s' in tape file '%s'",
3119               chunk_name, filename);
3120         ReadUnusedBytesFromFile(file, chunk_size);
3121       }
3122       else if (chunk_info[i].size != -1 &&
3123                chunk_info[i].size != chunk_size)
3124       {
3125         Error(ERR_WARN, "wrong size (%d) of chunk '%s' in tape file '%s'",
3126               chunk_size, chunk_name, filename);
3127         ReadUnusedBytesFromFile(file, chunk_size);
3128       }
3129       else
3130       {
3131         /* call function to load this tape chunk */
3132         int chunk_size_expected =
3133           (chunk_info[i].loader)(file, chunk_size, &tape);
3134
3135         /* the size of some chunks cannot be checked before reading other
3136            chunks first (like "HEAD" and "BODY") that contain some header
3137            information, so check them here */
3138         if (chunk_size_expected != chunk_size)
3139         {
3140           Error(ERR_WARN, "wrong size (%d) of chunk '%s' in tape file '%s'",
3141                 chunk_size, chunk_name, filename);
3142         }
3143       }
3144     }
3145   }
3146
3147   fclose(file);
3148
3149   tape.length_seconds = GetTapeLength();
3150
3151 #if 0
3152   printf("::: tape game version: %d\n", tape.game_version);
3153   printf("::: tape engine version: %d\n", tape.engine_version);
3154 #endif
3155 }
3156
3157 void LoadTape(int nr)
3158 {
3159   char *filename = getTapeFilename(nr);
3160
3161   LoadTapeFromFilename(filename);
3162 }
3163
3164 void LoadSolutionTape(int nr)
3165 {
3166   char *filename = getSolutionTapeFilename(nr);
3167
3168   LoadTapeFromFilename(filename);
3169 }
3170
3171 static void SaveTape_VERS(FILE *file, struct TapeInfo *tape)
3172 {
3173   putFileVersion(file, tape->file_version);
3174   putFileVersion(file, tape->game_version);
3175 }
3176
3177 static void SaveTape_HEAD(FILE *file, struct TapeInfo *tape)
3178 {
3179   int i;
3180   byte store_participating_players = 0;
3181
3182   /* set bits for participating players for compact storage */
3183   for (i = 0; i < MAX_PLAYERS; i++)
3184     if (tape->player_participates[i])
3185       store_participating_players |= (1 << i);
3186
3187   putFile32BitBE(file, tape->random_seed);
3188   putFile32BitBE(file, tape->date);
3189   putFile32BitBE(file, tape->length);
3190
3191   putFile8Bit(file, store_participating_players);
3192
3193   /* unused bytes not at the end here for 4-byte alignment of engine_version */
3194   WriteUnusedBytesToFile(file, TAPE_HEADER_UNUSED);
3195
3196   putFileVersion(file, tape->engine_version);
3197 }
3198
3199 static void SaveTape_INFO(FILE *file, struct TapeInfo *tape)
3200 {
3201   int level_identifier_size = strlen(tape->level_identifier) + 1;
3202   int i;
3203
3204   putFile16BitBE(file, level_identifier_size);
3205
3206   for (i = 0; i < level_identifier_size; i++)
3207     putFile8Bit(file, tape->level_identifier[i]);
3208
3209   putFile16BitBE(file, tape->level_nr);
3210 }
3211
3212 static void SaveTape_BODY(FILE *file, struct TapeInfo *tape)
3213 {
3214   int i, j;
3215
3216   for (i = 0; i < tape->length; i++)
3217   {
3218     for (j = 0; j < MAX_PLAYERS; j++)
3219       if (tape->player_participates[j])
3220         putFile8Bit(file, tape->pos[i].action[j]);
3221
3222     putFile8Bit(file, tape->pos[i].delay);
3223   }
3224 }
3225
3226 void SaveTape(int nr)
3227 {
3228   char *filename = getTapeFilename(nr);
3229   FILE *file;
3230   boolean new_tape = TRUE;
3231   int num_participating_players = 0;
3232   int info_chunk_size;
3233   int body_chunk_size;
3234   int i;
3235
3236   InitTapeDirectory(leveldir_current->subdir);
3237
3238   /* if a tape still exists, ask to overwrite it */
3239   if (access(filename, F_OK) == 0)
3240   {
3241     new_tape = FALSE;
3242     if (!Request("Replace old tape ?", REQ_ASK))
3243       return;
3244   }
3245
3246   if (!(file = fopen(filename, MODE_WRITE)))
3247   {
3248     Error(ERR_WARN, "cannot save level recording file '%s'", filename);
3249     return;
3250   }
3251
3252   tape.file_version = FILE_VERSION_ACTUAL;
3253   tape.game_version = GAME_VERSION_ACTUAL;
3254
3255   /* count number of participating players  */
3256   for (i = 0; i < MAX_PLAYERS; i++)
3257     if (tape.player_participates[i])
3258       num_participating_players++;
3259
3260   info_chunk_size = 2 + (strlen(tape.level_identifier) + 1) + 2;
3261   body_chunk_size = (num_participating_players + 1) * tape.length;
3262
3263   putFileChunkBE(file, "RND1", CHUNK_SIZE_UNDEFINED);
3264   putFileChunkBE(file, "TAPE", CHUNK_SIZE_NONE);
3265
3266   putFileChunkBE(file, "VERS", FILE_VERS_CHUNK_SIZE);
3267   SaveTape_VERS(file, &tape);
3268
3269   putFileChunkBE(file, "HEAD", TAPE_HEADER_SIZE);
3270   SaveTape_HEAD(file, &tape);
3271
3272   putFileChunkBE(file, "INFO", info_chunk_size);
3273   SaveTape_INFO(file, &tape);
3274
3275   putFileChunkBE(file, "BODY", body_chunk_size);
3276   SaveTape_BODY(file, &tape);
3277
3278   fclose(file);
3279
3280   SetFilePermissions(filename, PERMS_PRIVATE);
3281
3282   tape.changed = FALSE;
3283
3284   if (new_tape)
3285     Request("tape saved !", REQ_CONFIRM);
3286 }
3287
3288 void DumpTape(struct TapeInfo *tape)
3289 {
3290   int i, j;
3291
3292   if (TAPE_IS_EMPTY(*tape))
3293   {
3294     Error(ERR_WARN, "no tape available for level %d", tape->level_nr);
3295     return;
3296   }
3297
3298   printf_line("-", 79);
3299   printf("Tape of Level %03d (file version %08d, game version %08d)\n",
3300          tape->level_nr, tape->file_version, tape->game_version);
3301   printf("Level series identifier: '%s'\n", tape->level_identifier);
3302   printf_line("-", 79);
3303
3304   for (i = 0; i < tape->length; i++)
3305   {
3306     if (i >= MAX_TAPELEN)
3307       break;
3308
3309     printf("%03d: ", i);
3310
3311     for (j = 0; j < MAX_PLAYERS; j++)
3312     {
3313       if (tape->player_participates[j])
3314       {
3315         int action = tape->pos[i].action[j];
3316
3317         printf("%d:%02x ", j, action);
3318         printf("[%c%c%c%c|%c%c] - ",
3319                (action & JOY_LEFT ? '<' : ' '),
3320                (action & JOY_RIGHT ? '>' : ' '),
3321                (action & JOY_UP ? '^' : ' '),
3322                (action & JOY_DOWN ? 'v' : ' '),
3323                (action & JOY_BUTTON_1 ? '1' : ' '),
3324                (action & JOY_BUTTON_2 ? '2' : ' '));
3325       }
3326     }
3327
3328     printf("(%03d)\n", tape->pos[i].delay);
3329   }
3330
3331   printf_line("-", 79);
3332 }
3333
3334
3335 /* ========================================================================= */
3336 /* score file functions                                                      */
3337 /* ========================================================================= */
3338
3339 void LoadScore(int nr)
3340 {
3341   int i;
3342   char *filename = getScoreFilename(nr);
3343   char cookie[MAX_LINE_LEN];
3344   char line[MAX_LINE_LEN];
3345   char *line_ptr;
3346   FILE *file;
3347
3348   /* always start with reliable default values */
3349   for (i = 0; i < MAX_SCORE_ENTRIES; i++)
3350   {
3351     strcpy(highscore[i].Name, EMPTY_PLAYER_NAME);
3352     highscore[i].Score = 0;
3353   }
3354
3355   if (!(file = fopen(filename, MODE_READ)))
3356     return;
3357
3358   /* check file identifier */
3359   fgets(cookie, MAX_LINE_LEN, file);
3360   if (strlen(cookie) > 0 && cookie[strlen(cookie) - 1] == '\n')
3361     cookie[strlen(cookie) - 1] = '\0';
3362
3363   if (!checkCookieString(cookie, SCORE_COOKIE))
3364   {
3365     Error(ERR_WARN, "unknown format of score file '%s'", filename);
3366     fclose(file);
3367     return;
3368   }
3369
3370   for (i = 0; i < MAX_SCORE_ENTRIES; i++)
3371   {
3372     fscanf(file, "%d", &highscore[i].Score);
3373     fgets(line, MAX_LINE_LEN, file);
3374
3375     if (line[strlen(line) - 1] == '\n')
3376       line[strlen(line) - 1] = '\0';
3377
3378     for (line_ptr = line; *line_ptr; line_ptr++)
3379     {
3380       if (*line_ptr != ' ' && *line_ptr != '\t' && *line_ptr != '\0')
3381       {
3382         strncpy(highscore[i].Name, line_ptr, MAX_PLAYER_NAME_LEN);
3383         highscore[i].Name[MAX_PLAYER_NAME_LEN] = '\0';
3384         break;
3385       }
3386     }
3387   }
3388
3389   fclose(file);
3390 }
3391
3392 void SaveScore(int nr)
3393 {
3394   int i;
3395   char *filename = getScoreFilename(nr);
3396   FILE *file;
3397
3398   InitScoreDirectory(leveldir_current->subdir);
3399
3400   if (!(file = fopen(filename, MODE_WRITE)))
3401   {
3402     Error(ERR_WARN, "cannot save score for level %d", nr);
3403     return;
3404   }
3405
3406   fprintf(file, "%s\n\n", SCORE_COOKIE);
3407
3408   for (i = 0; i < MAX_SCORE_ENTRIES; i++)
3409     fprintf(file, "%d %s\n", highscore[i].Score, highscore[i].Name);
3410
3411   fclose(file);
3412
3413   SetFilePermissions(filename, PERMS_PUBLIC);
3414 }
3415
3416
3417 /* ========================================================================= */
3418 /* setup file functions                                                      */
3419 /* ========================================================================= */
3420
3421 #define TOKEN_STR_PLAYER_PREFIX                 "player_"
3422
3423 /* global setup */
3424 #define SETUP_TOKEN_PLAYER_NAME                 0
3425 #define SETUP_TOKEN_SOUND                       1
3426 #define SETUP_TOKEN_SOUND_LOOPS                 2
3427 #define SETUP_TOKEN_SOUND_MUSIC                 3
3428 #define SETUP_TOKEN_SOUND_SIMPLE                4
3429 #define SETUP_TOKEN_TOONS                       5
3430 #define SETUP_TOKEN_SCROLL_DELAY                6
3431 #define SETUP_TOKEN_SOFT_SCROLLING              7
3432 #define SETUP_TOKEN_FADING                      8
3433 #define SETUP_TOKEN_AUTORECORD                  9
3434 #define SETUP_TOKEN_QUICK_DOORS                 10
3435 #define SETUP_TOKEN_TEAM_MODE                   11
3436 #define SETUP_TOKEN_HANDICAP                    12
3437 #define SETUP_TOKEN_TIME_LIMIT                  13
3438 #define SETUP_TOKEN_FULLSCREEN                  14
3439 #define SETUP_TOKEN_ASK_ON_ESCAPE               15
3440 #define SETUP_TOKEN_GRAPHICS_SET                16
3441 #define SETUP_TOKEN_SOUNDS_SET                  17
3442 #define SETUP_TOKEN_MUSIC_SET                   18
3443 #define SETUP_TOKEN_OVERRIDE_LEVEL_GRAPHICS     19
3444 #define SETUP_TOKEN_OVERRIDE_LEVEL_SOUNDS       20
3445 #define SETUP_TOKEN_OVERRIDE_LEVEL_MUSIC        21
3446
3447 #define NUM_GLOBAL_SETUP_TOKENS                 22
3448
3449 /* editor setup */
3450 #define SETUP_TOKEN_EDITOR_EL_BOULDERDASH       0
3451 #define SETUP_TOKEN_EDITOR_EL_EMERALD_MINE      1
3452 #define SETUP_TOKEN_EDITOR_EL_MORE              2
3453 #define SETUP_TOKEN_EDITOR_EL_SOKOBAN           3
3454 #define SETUP_TOKEN_EDITOR_EL_SUPAPLEX          4
3455 #define SETUP_TOKEN_EDITOR_EL_DIAMOND_CAVES     5
3456 #define SETUP_TOKEN_EDITOR_EL_DX_BOULDERDASH    6
3457 #define SETUP_TOKEN_EDITOR_EL_CHARS             7
3458 #define SETUP_TOKEN_EDITOR_EL_CUSTOM            8
3459 #define SETUP_TOKEN_EDITOR_EL_CUSTOM_MORE       9
3460 #define SETUP_TOKEN_EDITOR_EL_HEADLINES         10
3461 #define SETUP_TOKEN_EDITOR_EL_USER_DEFINED      11
3462
3463 #define NUM_EDITOR_SETUP_TOKENS                 12
3464
3465 /* shortcut setup */
3466 #define SETUP_TOKEN_SHORTCUT_SAVE_GAME          0
3467 #define SETUP_TOKEN_SHORTCUT_LOAD_GAME          1
3468 #define SETUP_TOKEN_SHORTCUT_TOGGLE_PAUSE       2
3469
3470 #define NUM_SHORTCUT_SETUP_TOKENS               3
3471
3472 /* player setup */
3473 #define SETUP_TOKEN_PLAYER_USE_JOYSTICK         0
3474 #define SETUP_TOKEN_PLAYER_JOY_DEVICE_NAME      1
3475 #define SETUP_TOKEN_PLAYER_JOY_XLEFT            2
3476 #define SETUP_TOKEN_PLAYER_JOY_XMIDDLE          3
3477 #define SETUP_TOKEN_PLAYER_JOY_XRIGHT           4
3478 #define SETUP_TOKEN_PLAYER_JOY_YUPPER           5
3479 #define SETUP_TOKEN_PLAYER_JOY_YMIDDLE          6
3480 #define SETUP_TOKEN_PLAYER_JOY_YLOWER           7
3481 #define SETUP_TOKEN_PLAYER_JOY_SNAP             8
3482 #define SETUP_TOKEN_PLAYER_JOY_DROP             9
3483 #define SETUP_TOKEN_PLAYER_KEY_LEFT             10
3484 #define SETUP_TOKEN_PLAYER_KEY_RIGHT            11
3485 #define SETUP_TOKEN_PLAYER_KEY_UP               12
3486 #define SETUP_TOKEN_PLAYER_KEY_DOWN             13
3487 #define SETUP_TOKEN_PLAYER_KEY_SNAP             14
3488 #define SETUP_TOKEN_PLAYER_KEY_DROP             15
3489
3490 #define NUM_PLAYER_SETUP_TOKENS                 16
3491
3492 /* system setup */
3493 #define SETUP_TOKEN_SYSTEM_SDL_AUDIODRIVER      0
3494 #define SETUP_TOKEN_SYSTEM_AUDIO_FRAGMENT_SIZE  1
3495
3496 #define NUM_SYSTEM_SETUP_TOKENS                 2
3497
3498 /* options setup */
3499 #define SETUP_TOKEN_OPTIONS_VERBOSE             0
3500
3501 #define NUM_OPTIONS_SETUP_TOKENS                1
3502
3503
3504 static struct SetupInfo si;
3505 static struct SetupEditorInfo sei;
3506 static struct SetupShortcutInfo ssi;
3507 static struct SetupInputInfo sii;
3508 static struct SetupSystemInfo syi;
3509 static struct OptionInfo soi;
3510
3511 static struct TokenInfo global_setup_tokens[] =
3512 {
3513   { TYPE_STRING, &si.player_name,       "player_name"                   },
3514   { TYPE_SWITCH, &si.sound,             "sound"                         },
3515   { TYPE_SWITCH, &si.sound_loops,       "repeating_sound_loops"         },
3516   { TYPE_SWITCH, &si.sound_music,       "background_music"              },
3517   { TYPE_SWITCH, &si.sound_simple,      "simple_sound_effects"          },
3518   { TYPE_SWITCH, &si.toons,             "toons"                         },
3519   { TYPE_SWITCH, &si.scroll_delay,      "scroll_delay"                  },
3520   { TYPE_SWITCH, &si.soft_scrolling,    "soft_scrolling"                },
3521   { TYPE_SWITCH, &si.fading,            "screen_fading"                 },
3522   { TYPE_SWITCH, &si.autorecord,        "automatic_tape_recording"      },
3523   { TYPE_SWITCH, &si.quick_doors,       "quick_doors"                   },
3524   { TYPE_SWITCH, &si.team_mode,         "team_mode"                     },
3525   { TYPE_SWITCH, &si.handicap,          "handicap"                      },
3526   { TYPE_SWITCH, &si.time_limit,        "time_limit"                    },
3527   { TYPE_SWITCH, &si.fullscreen,        "fullscreen"                    },
3528   { TYPE_SWITCH, &si.ask_on_escape,     "ask_on_escape"                 },
3529   { TYPE_STRING, &si.graphics_set,      "graphics_set"                  },
3530   { TYPE_STRING, &si.sounds_set,        "sounds_set"                    },
3531   { TYPE_STRING, &si.music_set,         "music_set"                     },
3532   { TYPE_SWITCH, &si.override_level_graphics, "override_level_graphics" },
3533   { TYPE_SWITCH, &si.override_level_sounds,   "override_level_sounds"   },
3534   { TYPE_SWITCH, &si.override_level_music,    "override_level_music"    },
3535 };
3536
3537 static struct TokenInfo editor_setup_tokens[] =
3538 {
3539   { TYPE_SWITCH, &sei.el_boulderdash,   "editor.el_boulderdash"         },
3540   { TYPE_SWITCH, &sei.el_emerald_mine,  "editor.el_emerald_mine"        },
3541   { TYPE_SWITCH, &sei.el_more,          "editor.el_more"                },
3542   { TYPE_SWITCH, &sei.el_sokoban,       "editor.el_sokoban"             },
3543   { TYPE_SWITCH, &sei.el_supaplex,      "editor.el_supaplex"            },
3544   { TYPE_SWITCH, &sei.el_diamond_caves, "editor.el_diamond_caves"       },
3545   { TYPE_SWITCH, &sei.el_dx_boulderdash,"editor.el_dx_boulderdash"      },
3546   { TYPE_SWITCH, &sei.el_chars,         "editor.el_chars"               },
3547   { TYPE_SWITCH, &sei.el_custom,        "editor.el_custom"              },
3548   { TYPE_SWITCH, &sei.el_custom_more,   "editor.el_custom_more"         },
3549   { TYPE_SWITCH, &sei.el_headlines,     "editor.el_headlines"           },
3550   { TYPE_SWITCH, &sei.el_user_defined,  "editor.el_user_defined"        },
3551 };
3552
3553 static struct TokenInfo shortcut_setup_tokens[] =
3554 {
3555   { TYPE_KEY_X11, &ssi.save_game,       "shortcut.save_game"            },
3556   { TYPE_KEY_X11, &ssi.load_game,       "shortcut.load_game"            },
3557   { TYPE_KEY_X11, &ssi.toggle_pause,    "shortcut.toggle_pause"         }
3558 };
3559
3560 static struct TokenInfo player_setup_tokens[] =
3561 {
3562   { TYPE_BOOLEAN, &sii.use_joystick,    ".use_joystick"                 },
3563   { TYPE_STRING,  &sii.joy.device_name, ".joy.device_name"              },
3564   { TYPE_INTEGER, &sii.joy.xleft,       ".joy.xleft"                    },
3565   { TYPE_INTEGER, &sii.joy.xmiddle,     ".joy.xmiddle"                  },
3566   { TYPE_INTEGER, &sii.joy.xright,      ".joy.xright"                   },
3567   { TYPE_INTEGER, &sii.joy.yupper,      ".joy.yupper"                   },
3568   { TYPE_INTEGER, &sii.joy.ymiddle,     ".joy.ymiddle"                  },
3569   { TYPE_INTEGER, &sii.joy.ylower,      ".joy.ylower"                   },
3570   { TYPE_INTEGER, &sii.joy.snap,        ".joy.snap_field"               },
3571   { TYPE_INTEGER, &sii.joy.drop,        ".joy.place_bomb"               },
3572   { TYPE_KEY_X11, &sii.key.left,        ".key.move_left"                },
3573   { TYPE_KEY_X11, &sii.key.right,       ".key.move_right"               },
3574   { TYPE_KEY_X11, &sii.key.up,          ".key.move_up"                  },
3575   { TYPE_KEY_X11, &sii.key.down,        ".key.move_down"                },
3576   { TYPE_KEY_X11, &sii.key.snap,        ".key.snap_field"               },
3577   { TYPE_KEY_X11, &sii.key.drop,        ".key.place_bomb"               }
3578 };
3579
3580 static struct TokenInfo system_setup_tokens[] =
3581 {
3582   { TYPE_STRING,  &syi.sdl_audiodriver, "system.sdl_audiodriver"        },
3583   { TYPE_INTEGER, &syi.audio_fragment_size,"system.audio_fragment_size" }
3584 };
3585
3586 static struct TokenInfo options_setup_tokens[] =
3587 {
3588   { TYPE_BOOLEAN, &soi.verbose,         "options.verbose"               }
3589 };
3590
3591 static char *get_corrected_login_name(char *login_name)
3592 {
3593   /* needed because player name must be a fixed length string */
3594   char *login_name_new = checked_malloc(MAX_PLAYER_NAME_LEN + 1);
3595
3596   strncpy(login_name_new, login_name, MAX_PLAYER_NAME_LEN);
3597   login_name_new[MAX_PLAYER_NAME_LEN] = '\0';
3598
3599   if (strlen(login_name) > MAX_PLAYER_NAME_LEN)         /* name has been cut */
3600     if (strchr(login_name_new, ' '))
3601       *strchr(login_name_new, ' ') = '\0';
3602
3603   return login_name_new;
3604 }
3605
3606 static void setSetupInfoToDefaults(struct SetupInfo *si)
3607 {
3608   int i;
3609
3610   si->player_name = get_corrected_login_name(getLoginName());
3611
3612   si->sound = TRUE;
3613   si->sound_loops = TRUE;
3614   si->sound_music = TRUE;
3615   si->sound_simple = TRUE;
3616   si->toons = TRUE;
3617   si->double_buffering = TRUE;
3618   si->direct_draw = !si->double_buffering;
3619   si->scroll_delay = TRUE;
3620   si->soft_scrolling = TRUE;
3621   si->fading = FALSE;
3622   si->autorecord = TRUE;
3623   si->quick_doors = FALSE;
3624   si->team_mode = FALSE;
3625   si->handicap = TRUE;
3626   si->time_limit = TRUE;
3627   si->fullscreen = FALSE;
3628   si->ask_on_escape = TRUE;
3629
3630   si->graphics_set = getStringCopy(GFX_CLASSIC_SUBDIR);
3631   si->sounds_set = getStringCopy(SND_CLASSIC_SUBDIR);
3632   si->music_set = getStringCopy(MUS_CLASSIC_SUBDIR);
3633   si->override_level_graphics = FALSE;
3634   si->override_level_sounds = FALSE;
3635   si->override_level_music = FALSE;
3636
3637   si->editor.el_boulderdash = TRUE;
3638   si->editor.el_emerald_mine = TRUE;
3639   si->editor.el_more = TRUE;
3640   si->editor.el_sokoban = TRUE;
3641   si->editor.el_supaplex = TRUE;
3642   si->editor.el_diamond_caves = TRUE;
3643   si->editor.el_dx_boulderdash = TRUE;
3644   si->editor.el_chars = TRUE;
3645   si->editor.el_custom = TRUE;
3646   si->editor.el_custom_more = FALSE;
3647
3648   si->editor.el_headlines = TRUE;
3649   si->editor.el_user_defined = FALSE;
3650
3651   si->shortcut.save_game = DEFAULT_KEY_SAVE_GAME;
3652   si->shortcut.load_game = DEFAULT_KEY_LOAD_GAME;
3653   si->shortcut.toggle_pause = DEFAULT_KEY_TOGGLE_PAUSE;
3654
3655   for (i = 0; i < MAX_PLAYERS; i++)
3656   {
3657     si->input[i].use_joystick = FALSE;
3658     si->input[i].joy.device_name=getStringCopy(getDeviceNameFromJoystickNr(i));
3659     si->input[i].joy.xleft   = JOYSTICK_XLEFT;
3660     si->input[i].joy.xmiddle = JOYSTICK_XMIDDLE;
3661     si->input[i].joy.xright  = JOYSTICK_XRIGHT;
3662     si->input[i].joy.yupper  = JOYSTICK_YUPPER;
3663     si->input[i].joy.ymiddle = JOYSTICK_YMIDDLE;
3664     si->input[i].joy.ylower  = JOYSTICK_YLOWER;
3665     si->input[i].joy.snap  = (i == 0 ? JOY_BUTTON_1 : 0);
3666     si->input[i].joy.drop  = (i == 0 ? JOY_BUTTON_2 : 0);
3667     si->input[i].key.left  = (i == 0 ? DEFAULT_KEY_LEFT  : KSYM_UNDEFINED);
3668     si->input[i].key.right = (i == 0 ? DEFAULT_KEY_RIGHT : KSYM_UNDEFINED);
3669     si->input[i].key.up    = (i == 0 ? DEFAULT_KEY_UP    : KSYM_UNDEFINED);
3670     si->input[i].key.down  = (i == 0 ? DEFAULT_KEY_DOWN  : KSYM_UNDEFINED);
3671     si->input[i].key.snap  = (i == 0 ? DEFAULT_KEY_SNAP  : KSYM_UNDEFINED);
3672     si->input[i].key.drop  = (i == 0 ? DEFAULT_KEY_DROP  : KSYM_UNDEFINED);
3673   }
3674
3675   si->system.sdl_audiodriver = getStringCopy(ARG_DEFAULT);
3676   si->system.audio_fragment_size = DEFAULT_AUDIO_FRAGMENT_SIZE;
3677
3678   si->options.verbose = FALSE;
3679 }
3680
3681 static void decodeSetupFileHash(SetupFileHash *setup_file_hash)
3682 {
3683   int i, pnr;
3684
3685   if (!setup_file_hash)
3686     return;
3687
3688   /* global setup */
3689   si = setup;
3690   for (i = 0; i < NUM_GLOBAL_SETUP_TOKENS; i++)
3691     setSetupInfo(global_setup_tokens, i,
3692                  getHashEntry(setup_file_hash, global_setup_tokens[i].text));
3693   setup = si;
3694
3695   /* editor setup */
3696   sei = setup.editor;
3697   for (i = 0; i < NUM_EDITOR_SETUP_TOKENS; i++)
3698     setSetupInfo(editor_setup_tokens, i,
3699                  getHashEntry(setup_file_hash,editor_setup_tokens[i].text));
3700   setup.editor = sei;
3701
3702   /* shortcut setup */
3703   ssi = setup.shortcut;
3704   for (i = 0; i < NUM_SHORTCUT_SETUP_TOKENS; i++)
3705     setSetupInfo(shortcut_setup_tokens, i,
3706                  getHashEntry(setup_file_hash,shortcut_setup_tokens[i].text));
3707   setup.shortcut = ssi;
3708
3709   /* player setup */
3710   for (pnr = 0; pnr < MAX_PLAYERS; pnr++)
3711   {
3712     char prefix[30];
3713
3714     sprintf(prefix, "%s%d", TOKEN_STR_PLAYER_PREFIX, pnr + 1);
3715
3716     sii = setup.input[pnr];
3717     for (i = 0; i < NUM_PLAYER_SETUP_TOKENS; i++)
3718     {
3719       char full_token[100];
3720
3721       sprintf(full_token, "%s%s", prefix, player_setup_tokens[i].text);
3722       setSetupInfo(player_setup_tokens, i,
3723                    getHashEntry(setup_file_hash, full_token));
3724     }
3725     setup.input[pnr] = sii;
3726   }
3727
3728   /* system setup */
3729   syi = setup.system;
3730   for (i = 0; i < NUM_SYSTEM_SETUP_TOKENS; i++)
3731     setSetupInfo(system_setup_tokens, i,
3732                  getHashEntry(setup_file_hash, system_setup_tokens[i].text));
3733   setup.system = syi;
3734
3735   /* options setup */
3736   soi = setup.options;
3737   for (i = 0; i < NUM_OPTIONS_SETUP_TOKENS; i++)
3738     setSetupInfo(options_setup_tokens, i,
3739                  getHashEntry(setup_file_hash, options_setup_tokens[i].text));
3740   setup.options = soi;
3741 }
3742
3743 void LoadSetup()
3744 {
3745   char *filename = getSetupFilename();
3746   SetupFileHash *setup_file_hash = NULL;
3747
3748   /* always start with reliable default values */
3749   setSetupInfoToDefaults(&setup);
3750
3751   setup_file_hash = loadSetupFileHash(filename);
3752
3753   if (setup_file_hash)
3754   {
3755     char *player_name_new;
3756
3757     checkSetupFileHashIdentifier(setup_file_hash, getCookie("SETUP"));
3758     decodeSetupFileHash(setup_file_hash);
3759
3760     setup.direct_draw = !setup.double_buffering;
3761
3762     freeSetupFileHash(setup_file_hash);
3763
3764     /* needed to work around problems with fixed length strings */
3765     player_name_new = get_corrected_login_name(setup.player_name);
3766     free(setup.player_name);
3767     setup.player_name = player_name_new;
3768   }
3769   else
3770     Error(ERR_WARN, "using default setup values");
3771 }
3772
3773 void SaveSetup()
3774 {
3775   char *filename = getSetupFilename();
3776   FILE *file;
3777   int i, pnr;
3778
3779   InitUserDataDirectory();
3780
3781   if (!(file = fopen(filename, MODE_WRITE)))
3782   {
3783     Error(ERR_WARN, "cannot write setup file '%s'", filename);
3784     return;
3785   }
3786
3787   fprintf(file, "%s\n", getFormattedSetupEntry(TOKEN_STR_FILE_IDENTIFIER,
3788                                                getCookie("SETUP")));
3789   fprintf(file, "\n");
3790
3791   /* global setup */
3792   si = setup;
3793   for (i = 0; i < NUM_GLOBAL_SETUP_TOKENS; i++)
3794   {
3795     /* just to make things nicer :) */
3796     if (i == SETUP_TOKEN_PLAYER_NAME + 1 ||
3797         i == SETUP_TOKEN_GRAPHICS_SET)
3798       fprintf(file, "\n");
3799
3800     fprintf(file, "%s\n", getSetupLine(global_setup_tokens, "", i));
3801   }
3802
3803   /* editor setup */
3804   sei = setup.editor;
3805   fprintf(file, "\n");
3806   for (i = 0; i < NUM_EDITOR_SETUP_TOKENS; i++)
3807     fprintf(file, "%s\n", getSetupLine(editor_setup_tokens, "", i));
3808
3809   /* shortcut setup */
3810   ssi = setup.shortcut;
3811   fprintf(file, "\n");
3812   for (i = 0; i < NUM_SHORTCUT_SETUP_TOKENS; i++)
3813     fprintf(file, "%s\n", getSetupLine(shortcut_setup_tokens, "", i));
3814
3815   /* player setup */
3816   for (pnr = 0; pnr < MAX_PLAYERS; pnr++)
3817   {
3818     char prefix[30];
3819
3820     sprintf(prefix, "%s%d", TOKEN_STR_PLAYER_PREFIX, pnr + 1);
3821     fprintf(file, "\n");
3822
3823     sii = setup.input[pnr];
3824     for (i = 0; i < NUM_PLAYER_SETUP_TOKENS; i++)
3825       fprintf(file, "%s\n", getSetupLine(player_setup_tokens, prefix, i));
3826   }
3827
3828   /* system setup */
3829   syi = setup.system;
3830   fprintf(file, "\n");
3831   for (i = 0; i < NUM_SYSTEM_SETUP_TOKENS; i++)
3832     fprintf(file, "%s\n", getSetupLine(system_setup_tokens, "", i));
3833
3834   /* options setup */
3835   soi = setup.options;
3836   fprintf(file, "\n");
3837   for (i = 0; i < NUM_OPTIONS_SETUP_TOKENS; i++)
3838     fprintf(file, "%s\n", getSetupLine(options_setup_tokens, "", i));
3839
3840   fclose(file);
3841
3842   SetFilePermissions(filename, PERMS_PRIVATE);
3843 }
3844
3845 void LoadCustomElementDescriptions()
3846 {
3847   char *filename = getCustomArtworkConfigFilename(ARTWORK_TYPE_GRAPHICS);
3848   SetupFileHash *setup_file_hash;
3849   int i;
3850
3851   for (i = 0; i < NUM_FILE_ELEMENTS; i++)
3852   {
3853     if (element_info[i].custom_description != NULL)
3854     {
3855       free(element_info[i].custom_description);
3856       element_info[i].custom_description = NULL;
3857     }
3858   }
3859
3860   if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
3861     return;
3862
3863   for (i = 0; i < NUM_FILE_ELEMENTS; i++)
3864   {
3865     char *token = getStringCat2(element_info[i].token_name, ".name");
3866     char *value = getHashEntry(setup_file_hash, token);
3867
3868     if (value != NULL)
3869       element_info[i].custom_description = getStringCopy(value);
3870
3871     free(token);
3872   }
3873
3874   freeSetupFileHash(setup_file_hash);
3875 }
3876
3877 void LoadSpecialMenuDesignSettings()
3878 {
3879   char *filename = getCustomArtworkConfigFilename(ARTWORK_TYPE_GRAPHICS);
3880   SetupFileHash *setup_file_hash;
3881   int i, j;
3882
3883   /* always start with reliable default values from default config */
3884   for (i = 0; image_config_vars[i].token != NULL; i++)
3885     for (j = 0; image_config[j].token != NULL; j++)
3886       if (strcmp(image_config_vars[i].token, image_config[j].token) == 0)
3887         *image_config_vars[i].value =
3888           get_auto_parameter_value(image_config_vars[i].token,
3889                                    image_config[j].value);
3890
3891   if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
3892     return;
3893
3894   /* special case: initialize with default values that may be overwritten */
3895   for (i = 0; i < NUM_SPECIAL_GFX_ARGS; i++)
3896   {
3897     char *value_x = getHashEntry(setup_file_hash, "menu.draw_xoffset");
3898     char *value_y = getHashEntry(setup_file_hash, "menu.draw_yoffset");
3899     char *list_size = getHashEntry(setup_file_hash, "menu.list_size");
3900
3901     if (value_x != NULL)
3902       menu.draw_xoffset[i] = get_integer_from_string(value_x);
3903     if (value_y != NULL)
3904       menu.draw_yoffset[i] = get_integer_from_string(value_y);
3905     if (list_size != NULL)
3906       menu.list_size[i] = get_integer_from_string(list_size);
3907   }
3908
3909   /* read (and overwrite with) values that may be specified in config file */
3910   for (i = 0; image_config_vars[i].token != NULL; i++)
3911   {
3912     char *value = getHashEntry(setup_file_hash, image_config_vars[i].token);
3913
3914     if (value != NULL)
3915       *image_config_vars[i].value =
3916         get_auto_parameter_value(image_config_vars[i].token, value);
3917   }
3918
3919   freeSetupFileHash(setup_file_hash);
3920 }
3921
3922 void LoadUserDefinedEditorElementList(int **elements, int *num_elements)
3923 {
3924   char *filename = getEditorSetupFilename();
3925   SetupFileList *setup_file_list, *list;
3926   SetupFileHash *element_hash;
3927   int num_unknown_tokens = 0;
3928   int i;
3929
3930   if ((setup_file_list = loadSetupFileList(filename)) == NULL)
3931     return;
3932
3933   element_hash = newSetupFileHash();
3934
3935   for (i = 0; i < NUM_FILE_ELEMENTS; i++)
3936     setHashEntry(element_hash, element_info[i].token_name, i_to_a(i));
3937
3938   /* determined size may be larger than needed (due to unknown elements) */
3939   *num_elements = 0;
3940   for (list = setup_file_list; list != NULL; list = list->next)
3941     (*num_elements)++;
3942
3943   /* add space for up to 3 more elements for padding that may be needed */
3944   *num_elements += 3;
3945
3946   *elements = checked_malloc(*num_elements * sizeof(int));
3947
3948   *num_elements = 0;
3949   for (list = setup_file_list; list != NULL; list = list->next)
3950   {
3951     char *value = getHashEntry(element_hash, list->token);
3952
3953     if (value)
3954     {
3955       (*elements)[(*num_elements)++] = atoi(value);
3956     }
3957     else
3958     {
3959       if (num_unknown_tokens == 0)
3960       {
3961         Error(ERR_RETURN_LINE, "-");
3962         Error(ERR_RETURN, "warning: unknown token(s) found in config file:");
3963         Error(ERR_RETURN, "- config file: '%s'", filename);
3964
3965         num_unknown_tokens++;
3966       }
3967
3968       Error(ERR_RETURN, "- token: '%s'", list->token);
3969     }
3970   }
3971
3972   if (num_unknown_tokens > 0)
3973     Error(ERR_RETURN_LINE, "-");
3974
3975   while (*num_elements % 4)     /* pad with empty elements, if needed */
3976     (*elements)[(*num_elements)++] = EL_EMPTY;
3977
3978   freeSetupFileList(setup_file_list);
3979   freeSetupFileHash(element_hash);
3980
3981 #if 0
3982   /* TEST-ONLY */
3983   for (i = 0; i < *num_elements; i++)
3984     printf("editor: element '%s' [%d]\n",
3985            element_info[(*elements)[i]].token_name, (*elements)[i]);
3986 #endif
3987 }
3988
3989 static struct MusicFileInfo *get_music_file_info_ext(char *basename, int music,
3990                                                      boolean is_sound)
3991 {
3992   SetupFileHash *setup_file_hash = NULL;
3993   struct MusicFileInfo tmp_music_file_info, *new_music_file_info;
3994   char *filename_music, *filename_prefix, *filename_info;
3995   struct
3996   {
3997     char *token;
3998     char **value_ptr;
3999   }
4000   token_to_value_ptr[] =
4001   {
4002     { "title_header",   &tmp_music_file_info.title_header       },
4003     { "artist_header",  &tmp_music_file_info.artist_header      },
4004     { "album_header",   &tmp_music_file_info.album_header       },
4005     { "year_header",    &tmp_music_file_info.year_header        },
4006
4007     { "title",          &tmp_music_file_info.title              },
4008     { "artist",         &tmp_music_file_info.artist             },
4009     { "album",          &tmp_music_file_info.album              },
4010     { "year",           &tmp_music_file_info.year               },
4011
4012     { NULL,             NULL                                    },
4013   };
4014   int i;
4015
4016   filename_music = (is_sound ? getCustomSoundFilename(basename) :
4017                     getCustomMusicFilename(basename));
4018
4019   if (filename_music == NULL)
4020     return NULL;
4021
4022   /* ---------- try to replace file extension ---------- */
4023
4024   filename_prefix = getStringCopy(filename_music);
4025   if (strrchr(filename_prefix, '.') != NULL)
4026     *strrchr(filename_prefix, '.') = '\0';
4027   filename_info = getStringCat2(filename_prefix, ".txt");
4028
4029 #if 0
4030   printf("trying to load file '%s'...\n", filename_info);
4031 #endif
4032
4033   if (fileExists(filename_info))
4034     setup_file_hash = loadSetupFileHash(filename_info);
4035
4036   free(filename_prefix);
4037   free(filename_info);
4038
4039   if (setup_file_hash == NULL)
4040   {
4041     /* ---------- try to add file extension ---------- */
4042
4043     filename_prefix = getStringCopy(filename_music);
4044     filename_info = getStringCat2(filename_prefix, ".txt");
4045
4046 #if 0
4047     printf("trying to load file '%s'...\n", filename_info);
4048 #endif
4049
4050     if (fileExists(filename_info))
4051       setup_file_hash = loadSetupFileHash(filename_info);
4052
4053     free(filename_prefix);
4054     free(filename_info);
4055   }
4056
4057   if (setup_file_hash == NULL)
4058     return NULL;
4059
4060   /* ---------- music file info found ---------- */
4061
4062   memset(&tmp_music_file_info, 0, sizeof(struct MusicFileInfo));
4063
4064   for (i = 0; token_to_value_ptr[i].token != NULL; i++)
4065   {
4066     char *value = getHashEntry(setup_file_hash, token_to_value_ptr[i].token);
4067
4068     *token_to_value_ptr[i].value_ptr =
4069       getStringCopy(value != NULL && *value != '\0' ? value : UNKNOWN_NAME);
4070   }
4071
4072   tmp_music_file_info.basename = getStringCopy(basename);
4073   tmp_music_file_info.music = music;
4074   tmp_music_file_info.is_sound = is_sound;
4075
4076   new_music_file_info = checked_malloc(sizeof(struct MusicFileInfo));
4077   *new_music_file_info = tmp_music_file_info;
4078
4079   return new_music_file_info;
4080 }
4081
4082 static struct MusicFileInfo *get_music_file_info(char *basename, int music)
4083 {
4084   return get_music_file_info_ext(basename, music, FALSE);
4085 }
4086
4087 static struct MusicFileInfo *get_sound_file_info(char *basename, int sound)
4088 {
4089   return get_music_file_info_ext(basename, sound, TRUE);
4090 }
4091
4092 static boolean music_info_listed_ext(struct MusicFileInfo *list,
4093                                      char *basename, boolean is_sound)
4094 {
4095   for (; list != NULL; list = list->next)
4096     if (list->is_sound == is_sound && strcmp(list->basename, basename) == 0)
4097       return TRUE;
4098
4099   return FALSE;
4100 }
4101
4102 static boolean music_info_listed(struct MusicFileInfo *list, char *basename)
4103 {
4104   return music_info_listed_ext(list, basename, FALSE);
4105 }
4106
4107 static boolean sound_info_listed(struct MusicFileInfo *list, char *basename)
4108 {
4109   return music_info_listed_ext(list, basename, TRUE);
4110 }
4111
4112 void LoadMusicInfo()
4113 {
4114   char *music_directory = getCustomMusicDirectory();
4115   int num_music = getMusicListSize();
4116   int num_music_noconf = 0;
4117   int num_sounds = getSoundListSize();
4118   DIR *dir;
4119   struct dirent *dir_entry;
4120   struct FileInfo *music, *sound;
4121   struct MusicFileInfo *next, **new;
4122   int i;
4123
4124   while (music_file_info != NULL)
4125   {
4126     next = music_file_info->next;
4127
4128     checked_free(music_file_info->basename);
4129
4130     checked_free(music_file_info->title_header);
4131     checked_free(music_file_info->artist_header);
4132     checked_free(music_file_info->album_header);
4133     checked_free(music_file_info->year_header);
4134
4135     checked_free(music_file_info->title);
4136     checked_free(music_file_info->artist);
4137     checked_free(music_file_info->album);
4138     checked_free(music_file_info->year);
4139
4140     free(music_file_info);
4141
4142     music_file_info = next;
4143   }
4144
4145   new = &music_file_info;
4146
4147 #if 0
4148   printf("::: num_music == %d\n", num_music);
4149 #endif
4150
4151   for (i = 0; i < num_music; i++)
4152   {
4153     music = getMusicListEntry(i);
4154
4155 #if 0
4156     printf("::: %d [%08x]\n", i, music->filename);
4157 #endif
4158
4159     if (music->filename == NULL)
4160       continue;
4161
4162     if (strcmp(music->filename, UNDEFINED_FILENAME) == 0)
4163       continue;
4164
4165     /* a configured file may be not recognized as music */
4166     if (!FileIsMusic(music->filename))
4167       continue;
4168
4169 #if 0
4170     printf("::: -> '%s' (configured)\n", music->filename);
4171 #endif
4172
4173     if (!music_info_listed(music_file_info, music->filename))
4174     {
4175       *new = get_music_file_info(music->filename, i);
4176       if (*new != NULL)
4177         new = &(*new)->next;
4178     }
4179   }
4180
4181   if ((dir = opendir(music_directory)) == NULL)
4182   {
4183     Error(ERR_WARN, "cannot read music directory '%s'", music_directory);
4184     return;
4185   }
4186
4187   while ((dir_entry = readdir(dir)) != NULL)    /* loop until last dir entry */
4188   {
4189     char *basename = dir_entry->d_name;
4190     boolean music_already_used = FALSE;
4191     int i;
4192
4193     /* skip all music files that are configured in music config file */
4194     for (i = 0; i < num_music; i++)
4195     {
4196       music = getMusicListEntry(i);
4197
4198       if (music->filename == NULL)
4199         continue;
4200
4201       if (strcmp(basename, music->filename) == 0)
4202       {
4203         music_already_used = TRUE;
4204         break;
4205       }
4206     }
4207
4208     if (music_already_used)
4209       continue;
4210
4211     if (!FileIsMusic(basename))
4212       continue;
4213
4214 #if 0
4215     printf("::: -> '%s' (found in directory)\n", basename);
4216 #endif
4217
4218     if (!music_info_listed(music_file_info, basename))
4219     {
4220       *new = get_music_file_info(basename, MAP_NOCONF_MUSIC(num_music_noconf));
4221       if (*new != NULL)
4222         new = &(*new)->next;
4223     }
4224
4225     num_music_noconf++;
4226   }
4227
4228   closedir(dir);
4229
4230   for (i = 0; i < num_sounds; i++)
4231   {
4232     sound = getSoundListEntry(i);
4233
4234     if (sound->filename == NULL)
4235       continue;
4236
4237     if (strcmp(sound->filename, UNDEFINED_FILENAME) == 0)
4238       continue;
4239
4240     /* a configured file may be not recognized as sound */
4241     if (!FileIsSound(sound->filename))
4242       continue;
4243
4244 #if 0
4245     printf("::: -> '%s' (configured)\n", sound->filename);
4246 #endif
4247
4248     if (!sound_info_listed(music_file_info, sound->filename))
4249     {
4250       *new = get_sound_file_info(sound->filename, i);
4251       if (*new != NULL)
4252         new = &(*new)->next;
4253     }
4254   }
4255
4256 #if 0
4257   /* TEST-ONLY */
4258   for (next = music_file_info; next != NULL; next = next->next)
4259     printf("::: title == '%s'\n", next->title);
4260 #endif
4261 }
4262
4263 void add_helpanim_entry(int element, int action, int direction, int delay,
4264                         int *num_list_entries)
4265 {
4266   struct HelpAnimInfo *new_list_entry;
4267   (*num_list_entries)++;
4268
4269   helpanim_info =
4270     checked_realloc(helpanim_info,
4271                     *num_list_entries * sizeof(struct HelpAnimInfo));
4272   new_list_entry = &helpanim_info[*num_list_entries - 1];
4273
4274   new_list_entry->element = element;
4275   new_list_entry->action = action;
4276   new_list_entry->direction = direction;
4277   new_list_entry->delay = delay;
4278 }
4279
4280 void print_unknown_token(char *filename, char *token, int token_nr)
4281 {
4282   if (token_nr == 0)
4283   {
4284     Error(ERR_RETURN_LINE, "-");
4285     Error(ERR_RETURN, "warning: unknown token(s) found in config file:");
4286     Error(ERR_RETURN, "- config file: '%s'", filename);
4287   }
4288
4289   Error(ERR_RETURN, "- token: '%s'", token);
4290 }
4291
4292 void print_unknown_token_end(int token_nr)
4293 {
4294   if (token_nr > 0)
4295     Error(ERR_RETURN_LINE, "-");
4296 }
4297
4298 void LoadHelpAnimInfo()
4299 {
4300   char *filename = getHelpAnimFilename();
4301   SetupFileList *setup_file_list = NULL, *list;
4302   SetupFileHash *element_hash, *action_hash, *direction_hash;
4303   int num_list_entries = 0;
4304   int num_unknown_tokens = 0;
4305   int i;
4306
4307   if (fileExists(filename))
4308     setup_file_list = loadSetupFileList(filename);
4309
4310   if (setup_file_list == NULL)
4311   {
4312     /* use reliable default values from static configuration */
4313     SetupFileList *insert_ptr;
4314
4315     insert_ptr = setup_file_list =
4316       newSetupFileList(helpanim_config[0].token,
4317                        helpanim_config[0].value);
4318
4319     for (i = 1; helpanim_config[i].token; i++)
4320       insert_ptr = addListEntry(insert_ptr,
4321                                 helpanim_config[i].token,
4322                                 helpanim_config[i].value);
4323   }
4324
4325   element_hash   = newSetupFileHash();
4326   action_hash    = newSetupFileHash();
4327   direction_hash = newSetupFileHash();
4328
4329   for (i = 0; i < MAX_NUM_ELEMENTS; i++)
4330     setHashEntry(element_hash, element_info[i].token_name, i_to_a(i));
4331
4332   for (i = 0; i < NUM_ACTIONS; i++)
4333     setHashEntry(action_hash, element_action_info[i].suffix,
4334                  i_to_a(element_action_info[i].value));
4335
4336   /* do not store direction index (bit) here, but direction value! */
4337   for (i = 0; i < NUM_DIRECTIONS; i++)
4338     setHashEntry(direction_hash, element_direction_info[i].suffix,
4339                  i_to_a(1 << element_direction_info[i].value));
4340
4341   for (list = setup_file_list; list != NULL; list = list->next)
4342   {
4343     char *element_token, *action_token, *direction_token;
4344     char *element_value, *action_value, *direction_value;
4345     int delay = atoi(list->value);
4346
4347     if (strcmp(list->token, "end") == 0)
4348     {
4349       add_helpanim_entry(HELPANIM_LIST_NEXT, -1, -1, -1, &num_list_entries);
4350
4351       continue;
4352     }
4353
4354     /* first try to break element into element/action/direction parts;
4355        if this does not work, also accept combined "element[.act][.dir]"
4356        elements (like "dynamite.active"), which are unique elements */
4357
4358     if (strchr(list->token, '.') == NULL)       /* token contains no '.' */
4359     {
4360       element_value = getHashEntry(element_hash, list->token);
4361       if (element_value != NULL)        /* element found */
4362         add_helpanim_entry(atoi(element_value), -1, -1, delay,
4363                            &num_list_entries);
4364       else
4365       {
4366         /* no further suffixes found -- this is not an element */
4367         print_unknown_token(filename, list->token, num_unknown_tokens++);
4368       }
4369
4370       continue;
4371     }
4372
4373     /* token has format "<prefix>.<something>" */
4374
4375     action_token = strchr(list->token, '.');    /* suffix may be action ... */
4376     direction_token = action_token;             /* ... or direction */
4377
4378     element_token = getStringCopy(list->token);
4379     *strchr(element_token, '.') = '\0';
4380
4381     element_value = getHashEntry(element_hash, element_token);
4382
4383     if (element_value == NULL)          /* this is no element */
4384     {
4385       element_value = getHashEntry(element_hash, list->token);
4386       if (element_value != NULL)        /* combined element found */
4387         add_helpanim_entry(atoi(element_value), -1, -1, delay,
4388                            &num_list_entries);
4389       else
4390         print_unknown_token(filename, list->token, num_unknown_tokens++);
4391
4392       free(element_token);
4393
4394       continue;
4395     }
4396
4397     action_value = getHashEntry(action_hash, action_token);
4398
4399     if (action_value != NULL)           /* action found */
4400     {
4401       add_helpanim_entry(atoi(element_value), atoi(action_value), -1, delay,
4402                     &num_list_entries);
4403
4404       free(element_token);
4405
4406       continue;
4407     }
4408
4409     direction_value = getHashEntry(direction_hash, direction_token);
4410
4411     if (direction_value != NULL)        /* direction found */
4412     {
4413       add_helpanim_entry(atoi(element_value), -1, atoi(direction_value), delay,
4414                          &num_list_entries);
4415
4416       free(element_token);
4417
4418       continue;
4419     }
4420
4421     if (strchr(action_token + 1, '.') == NULL)
4422     {
4423       /* no further suffixes found -- this is not an action nor direction */
4424
4425       element_value = getHashEntry(element_hash, list->token);
4426       if (element_value != NULL)        /* combined element found */
4427         add_helpanim_entry(atoi(element_value), -1, -1, delay,
4428                            &num_list_entries);
4429       else
4430         print_unknown_token(filename, list->token, num_unknown_tokens++);
4431
4432       free(element_token);
4433
4434       continue;
4435     }
4436
4437     /* token has format "<prefix>.<suffix>.<something>" */
4438
4439     direction_token = strchr(action_token + 1, '.');
4440
4441     action_token = getStringCopy(action_token);
4442     *strchr(action_token + 1, '.') = '\0';
4443
4444     action_value = getHashEntry(action_hash, action_token);
4445
4446     if (action_value == NULL)           /* this is no action */
4447     {
4448       element_value = getHashEntry(element_hash, list->token);
4449       if (element_value != NULL)        /* combined element found */
4450         add_helpanim_entry(atoi(element_value), -1, -1, delay,
4451                            &num_list_entries);
4452       else
4453         print_unknown_token(filename, list->token, num_unknown_tokens++);
4454
4455       free(element_token);
4456       free(action_token);
4457
4458       continue;
4459     }
4460
4461     direction_value = getHashEntry(direction_hash, direction_token);
4462
4463     if (direction_value != NULL)        /* direction found */
4464     {
4465       add_helpanim_entry(atoi(element_value), atoi(action_value),
4466                          atoi(direction_value), delay, &num_list_entries);
4467
4468       free(element_token);
4469       free(action_token);
4470
4471       continue;
4472     }
4473
4474     /* this is no direction */
4475
4476     element_value = getHashEntry(element_hash, list->token);
4477     if (element_value != NULL)          /* combined element found */
4478       add_helpanim_entry(atoi(element_value), -1, -1, delay,
4479                          &num_list_entries);
4480     else
4481       print_unknown_token(filename, list->token, num_unknown_tokens++);
4482
4483     free(element_token);
4484     free(action_token);
4485   }
4486
4487   print_unknown_token_end(num_unknown_tokens);
4488
4489   add_helpanim_entry(HELPANIM_LIST_NEXT, -1, -1, -1, &num_list_entries);
4490   add_helpanim_entry(HELPANIM_LIST_END,  -1, -1, -1, &num_list_entries);
4491
4492   freeSetupFileList(setup_file_list);
4493   freeSetupFileHash(element_hash);
4494   freeSetupFileHash(action_hash);
4495   freeSetupFileHash(direction_hash);
4496
4497 #if 0
4498   /* TEST ONLY */
4499   for (i = 0; i < num_list_entries; i++)
4500     printf("::: %d, %d, %d => %d\n",
4501            helpanim_info[i].element,
4502            helpanim_info[i].action,
4503            helpanim_info[i].direction,
4504            helpanim_info[i].delay);
4505 #endif
4506 }
4507
4508 void LoadHelpTextInfo()
4509 {
4510   char *filename = getHelpTextFilename();
4511   int i;
4512
4513   if (helptext_info != NULL)
4514   {
4515     freeSetupFileHash(helptext_info);
4516     helptext_info = NULL;
4517   }
4518
4519   if (fileExists(filename))
4520     helptext_info = loadSetupFileHash(filename);
4521
4522   if (helptext_info == NULL)
4523   {
4524     /* use reliable default values from static configuration */
4525     helptext_info = newSetupFileHash();
4526
4527     for (i = 0; helptext_config[i].token; i++)
4528       setHashEntry(helptext_info,
4529                    helptext_config[i].token,
4530                    helptext_config[i].value);
4531   }
4532
4533 #if 0
4534   /* TEST ONLY */
4535   BEGIN_HASH_ITERATION(helptext_info, itr)
4536   {
4537     printf("::: '%s' => '%s'\n",
4538            HASH_ITERATION_TOKEN(itr), HASH_ITERATION_VALUE(itr));
4539   }
4540   END_HASH_ITERATION(hash, itr)
4541 #endif
4542 }