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