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