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