src/game_mm/mm_files.c

   1 // ============================================================================
   2 // Mirror Magic -- McDuffin's Revenge
   3 // ----------------------------------------------------------------------------
   4 // (c) 1994-2017 by Artsoft Entertainment
   5 //                  Holger Schemel
   6 //                  info@artsoft.org
   7 //                  http://www.artsoft.org/
   8 // ----------------------------------------------------------------------------
   9 // mm_files.c
  10 // ============================================================================
  11
  12 #include <sys/types.h>
  13 #include <sys/stat.h>
  14 #include <ctype.h>
  15 #include <dirent.h>
  16
  17 #include "main_mm.h"
  18
  19 #include "mm_main.h"
  20
  21 #define CHUNK_ID_LEN            4       // IFF style chunk id length
  22 #define CHUNK_SIZE_UNDEFINED    0       // undefined chunk size == 0
  23 #define CHUNK_SIZE_NONE         -1      // do not write chunk size
  24 #define FILE_VERS_CHUNK_SIZE    8       // size of file version chunk
  25 #define LEVEL_HEADER_SIZE       80      // size of level file header
  26 #define LEVEL_HEADER_UNUSED     19      // unused level header bytes
  27
  28 // file identifier strings
  29 #define LEVEL_COOKIE_TMPL       "MIRRORMAGIC_LEVEL_FILE_VERSION_x.x"
  30 #define SCORE_COOKIE            "MIRRORMAGIC_SCORE_FILE_VERSION_1.4"
  31
  32
  33 int default_score[LEVEL_SCORE_ELEMENTS] =
  34 {
  35   [SC_COLLECTIBLE]      = 10,
  36   [SC_PACMAN]           = 50,
  37   [SC_KEY]              = 10,
  38   [SC_TIME_BONUS]       = 1,
  39   [SC_LIGHTBALL]        = 10,
  40 };
  41
  42
  43 // ============================================================================
  44 // level file functions
  45 // ============================================================================
  46
  47 static void ReadChunk_MM_VERS(File *file, int *file_version, int *game_version)
  48 {
  49   int file_version_major, file_version_minor, file_version_patch;
  50   int game_version_major, game_version_minor, game_version_patch;
  51
  52   file_version_major = getFile8Bit(file);
  53   file_version_minor = getFile8Bit(file);
  54   file_version_patch = getFile8Bit(file);
  55   getFile8Bit(file);            // not used
  56
  57   game_version_major = getFile8Bit(file);
  58   game_version_minor = getFile8Bit(file);
  59   game_version_patch = getFile8Bit(file);
  60   getFile8Bit(file);            // not used
  61
  62   *file_version = MM_VERSION_IDENT(file_version_major,
  63                                    file_version_minor,
  64                                    file_version_patch);
  65
  66   *game_version = MM_VERSION_IDENT(game_version_major,
  67                                    game_version_minor,
  68                                    game_version_patch);
  69 }
  70
  71 static void WriteChunk_MM_VERS(FILE *file, int file_version, int game_version)
  72 {
  73   int file_version_major = MM_VERSION_MAJOR(file_version);
  74   int file_version_minor = MM_VERSION_MINOR(file_version);
  75   int file_version_patch = MM_VERSION_PATCH(file_version);
  76   int game_version_major = MM_VERSION_MAJOR(game_version);
  77   int game_version_minor = MM_VERSION_MINOR(game_version);
  78   int game_version_patch = MM_VERSION_PATCH(game_version);
  79
  80   fputc(file_version_major, file);
  81   fputc(file_version_minor, file);
  82   fputc(file_version_patch, file);
  83   fputc(0, file);       // not used
  84
  85   fputc(game_version_major, file);
  86   fputc(game_version_minor, file);
  87   fputc(game_version_patch, file);
  88   fputc(0, file);       // not used
  89 }
  90
  91 void setLevelInfoToDefaults_MM(void)
  92 {
  93   int i, x, y;
  94
  95   native_mm_level.file_version = MM_FILE_VERSION_ACTUAL;
  96   native_mm_level.game_version = MM_GAME_VERSION_ACTUAL;
  97
  98   native_mm_level.encoding_16bit_field = FALSE; // default: only 8-bit elements
  99
 100   native_mm_level.fieldx = STD_LEV_FIELDX;
 101   native_mm_level.fieldy = STD_LEV_FIELDY;
 102
 103   for (x = 0; x < MAX_LEV_FIELDX; x++)
 104     for (y = 0; y < MAX_LEV_FIELDY; y++)
 105       native_mm_level.field[x][y] = Ur[x][y] = EL_EMPTY;
 106
 107   native_mm_level.time = 100;
 108   native_mm_level.kettles_needed = 0;
 109   native_mm_level.auto_count_kettles = TRUE;
 110   native_mm_level.amoeba_speed = 0;
 111   native_mm_level.time_fuse = 25;
 112   native_mm_level.time_bomb = 75;
 113   native_mm_level.time_ball = 75;
 114   native_mm_level.time_block = 75;
 115   native_mm_level.laser_red = FALSE;
 116   native_mm_level.laser_green = FALSE;
 117   native_mm_level.laser_blue = TRUE;
 118
 119   for (i = 0; i < MAX_LEVEL_NAME_LEN; i++)
 120     native_mm_level.name[i] = '\0';
 121   for (i = 0; i < MAX_LEVEL_AUTHOR_LEN; i++)
 122     native_mm_level.author[i] = '\0';
 123
 124   strcpy(native_mm_level.name, NAMELESS_LEVEL_NAME);
 125   strcpy(native_mm_level.author, ANONYMOUS_NAME);
 126
 127   for (i = 0; i < LEVEL_SCORE_ELEMENTS; i++)
 128     native_mm_level.score[i] = 10;
 129
 130   native_mm_level.field[0][0] = Ur[0][0] = EL_MCDUFFIN_RIGHT;
 131   native_mm_level.field[STD_LEV_FIELDX-1][STD_LEV_FIELDY-1] =
 132     Ur[STD_LEV_FIELDX-1][STD_LEV_FIELDY-1] = EL_EXIT_CLOSED;
 133 }
 134
 135 static int checkLevelElement(int element)
 136 {
 137   if (element >= EL_FIRST_RUNTIME_EL)
 138   {
 139     Error(ERR_WARN, "invalid level element %d", element);
 140     element = EL_CHAR_FRAGE;
 141   }
 142
 143   return element;
 144 }
 145
 146 static int LoadLevel_MM_VERS(File *file, int chunk_size,
 147                              struct LevelInfo_MM *level)
 148 {
 149   ReadChunk_MM_VERS(file, &level->file_version, &level->game_version);
 150
 151   return chunk_size;
 152 }
 153
 154 static int LoadLevel_MM_HEAD(File *file, int chunk_size,
 155                              struct LevelInfo_MM *level)
 156 {
 157   int i;
 158   int laser_color;
 159
 160   level->fieldx = getFile8Bit(file);
 161   level->fieldy = getFile8Bit(file);
 162
 163   level->time           = getFile16BitInteger(file, BYTE_ORDER_BIG_ENDIAN);
 164   level->kettles_needed = getFile16BitInteger(file, BYTE_ORDER_BIG_ENDIAN);
 165
 166   // one time unit was equivalent to four seconds in level files up to 2.0.x
 167   if (level->file_version <= MM_FILE_VERSION_2_0)
 168     level->time *= 4;
 169
 170   for (i = 0; i < MAX_LEVEL_NAME_LEN; i++)
 171     level->name[i] = getFile8Bit(file);
 172   level->name[MAX_LEVEL_NAME_LEN] = 0;
 173
 174   for (i = 0; i < LEVEL_SCORE_ELEMENTS; i++)
 175     level->score[i] = getFile8Bit(file);
 176
 177   // scores were 0 and hardcoded in game engine in level files up to 2.0.x
 178   if (level->file_version <= MM_FILE_VERSION_2_0)
 179     for (i = 0; i < LEVEL_SCORE_ELEMENTS; i++)
 180       if (level->score[i] == 0)
 181         level->score[i] = default_score[i];
 182
 183   level->auto_count_kettles     = (getFile8Bit(file) == 1 ? TRUE : FALSE);
 184   level->amoeba_speed           = getFile8Bit(file);
 185   level->time_fuse              = getFile8Bit(file);
 186
 187   // fuse time was 0 and hardcoded in game engine in level files up to 2.0.x
 188   if (level->file_version <= MM_FILE_VERSION_2_0)
 189     level->time_fuse = 25;
 190
 191   laser_color                   = getFile8Bit(file);
 192   level->laser_red              = (laser_color >> 2) & 0x01;
 193   level->laser_green            = (laser_color >> 1) & 0x01;
 194   level->laser_blue             = (laser_color >> 0) & 0x01;
 195
 196   level->encoding_16bit_field   = (getFile8Bit(file) == 1 ? TRUE : FALSE);
 197
 198   ReadUnusedBytesFromFile(file, LEVEL_HEADER_UNUSED);
 199
 200   return chunk_size;
 201 }
 202
 203 static int LoadLevel_MM_AUTH(File *file, int chunk_size,
 204                              struct LevelInfo_MM *level)
 205 {
 206   int i;
 207
 208   for (i = 0; i < MAX_LEVEL_AUTHOR_LEN; i++)
 209     level->author[i] = getFile8Bit(file);
 210   level->author[MAX_LEVEL_NAME_LEN] = 0;
 211
 212   return chunk_size;
 213 }
 214
 215 static int LoadLevel_MM_BODY(File *file, int chunk_size,
 216                              struct LevelInfo_MM *level)
 217 {
 218   int x, y;
 219   int chunk_size_expected = level->fieldx * level->fieldy;
 220
 221   /* Note: "chunk_size" was wrong before version 2.0 when elements are
 222      stored with 16-bit encoding (and should be twice as big then).
 223      Even worse, playfield data was stored 16-bit when only yamyam content
 224      contained 16-bit elements and vice versa. */
 225
 226   if (level->encoding_16bit_field && level->file_version >= MM_FILE_VERSION_2_0)
 227     chunk_size_expected *= 2;
 228
 229   if (chunk_size_expected != chunk_size)
 230   {
 231     ReadUnusedBytesFromFile(file, chunk_size);
 232
 233     return chunk_size_expected;
 234   }
 235
 236   for (y = 0; y < level->fieldy; y++)
 237     for (x = 0; x < level->fieldx; x++)
 238       native_mm_level.field[x][y] = Ur[x][y] =
 239         checkLevelElement(level->encoding_16bit_field ?
 240                           getFile16BitInteger(file, BYTE_ORDER_BIG_ENDIAN) :
 241                           getFile8Bit(file));
 242   return chunk_size;
 243 }
 244
 245 boolean LoadNativeLevel_MM(char *filename, boolean level_info_only)
 246 {
 247   char cookie[MAX_LINE_LEN];
 248   char chunk_name[CHUNK_ID_LEN + 1];
 249   int chunk_size;
 250   File *file;
 251
 252   static struct
 253   {
 254     char *name;
 255     int size;
 256     int (*loader)(File *, int, struct LevelInfo_MM *);
 257   }
 258   chunk_info[] =
 259   {
 260     { "VERS", FILE_VERS_CHUNK_SIZE,     LoadLevel_MM_VERS },
 261     { "HEAD", LEVEL_HEADER_SIZE,        LoadLevel_MM_HEAD },
 262     { "AUTH", MAX_LEVEL_AUTHOR_LEN,     LoadLevel_MM_AUTH },
 263     { "BODY", -1,                       LoadLevel_MM_BODY },
 264     {  NULL,  0,                        NULL }
 265   };
 266
 267   // always start with reliable default values
 268   setLevelInfoToDefaults_MM();
 269
 270   if (!(file = openFile(filename, MODE_READ)))
 271   {
 272     if (!level_info_only)
 273       Error(ERR_WARN, "cannot read level '%s' - creating new level", filename);
 274
 275     return FALSE;
 276   }
 277
 278   getFileChunk(file, chunk_name, NULL, BYTE_ORDER_BIG_ENDIAN);
 279   if (strcmp(chunk_name, "MMII") == 0)
 280   {
 281     getFile32BitInteger(file, BYTE_ORDER_BIG_ENDIAN);   // not used
 282
 283     getFileChunk(file, chunk_name, NULL, BYTE_ORDER_BIG_ENDIAN);
 284     if (strcmp(chunk_name, "CAVE") != 0)
 285     {
 286       Error(ERR_WARN, "unknown format of level file '%s'", filename);
 287
 288       closeFile(file);
 289
 290       return FALSE;
 291     }
 292   }
 293   else  // check for pre-2.0 file format with cookie string
 294   {
 295     strcpy(cookie, chunk_name);
 296     getStringFromFile(file, &cookie[4], MAX_LINE_LEN - 4);
 297     if (strlen(cookie) > 0 && cookie[strlen(cookie) - 1] == '\n')
 298       cookie[strlen(cookie) - 1] = '\0';
 299
 300     if (!checkCookieString(cookie, LEVEL_COOKIE_TMPL))
 301     {
 302       Error(ERR_WARN, "unknown format of level file '%s'", filename);
 303
 304       closeFile(file);
 305
 306       return FALSE;
 307     }
 308
 309     if ((native_mm_level.file_version = getFileVersionFromCookieString(cookie))
 310         == -1)
 311     {
 312       Error(ERR_WARN, "unsupported version of level file '%s'", filename);
 313
 314       closeFile(file);
 315
 316       return FALSE;
 317     }
 318   }
 319
 320   while (getFileChunk(file, chunk_name, &chunk_size, BYTE_ORDER_BIG_ENDIAN))
 321   {
 322     int i = 0;
 323
 324     while (chunk_info[i].name != NULL &&
 325            strcmp(chunk_name, chunk_info[i].name) != 0)
 326       i++;
 327
 328     if (chunk_info[i].name == NULL)
 329     {
 330       Error(ERR_WARN, "unknown chunk '%s' in level file '%s'",
 331             chunk_name, filename);
 332
 333       ReadUnusedBytesFromFile(file, chunk_size);
 334     }
 335     else if (chunk_info[i].size != -1 &&
 336              chunk_info[i].size != chunk_size)
 337     {
 338       Error(ERR_WARN, "wrong size (%d) of chunk '%s' in level file '%s'",
 339             chunk_size, chunk_name, filename);
 340
 341       ReadUnusedBytesFromFile(file, chunk_size);
 342     }
 343     else
 344     {
 345       // call function to load this level chunk
 346       int chunk_size_expected =
 347         (chunk_info[i].loader)(file, chunk_size, &native_mm_level);
 348
 349       /* the size of some chunks cannot be checked before reading other
 350          chunks first (like "HEAD" and "BODY") that contain some header
 351          information, so check them here */
 352       if (chunk_size_expected != chunk_size)
 353         Error(ERR_WARN, "wrong size (%d) of chunk '%s' in level file '%s'",
 354               chunk_size, chunk_name, filename);
 355     }
 356   }
 357
 358   closeFile(file);
 359
 360   return TRUE;
 361 }
 362
 363 static void SaveLevel_MM_HEAD(FILE *file, struct LevelInfo_MM *level)
 364 {
 365   int i;
 366   int laser_color;
 367
 368   fputc(level->fieldx, file);
 369   fputc(level->fieldy, file);
 370
 371   putFile16BitInteger(file, level->time,           BYTE_ORDER_BIG_ENDIAN);
 372   putFile16BitInteger(file, level->kettles_needed, BYTE_ORDER_BIG_ENDIAN);
 373
 374   for (i = 0; i < MAX_LEVEL_NAME_LEN; i++)
 375     fputc(level->name[i], file);
 376
 377   for (i = 0; i < LEVEL_SCORE_ELEMENTS; i++)
 378     fputc(level->score[i], file);
 379
 380   fputc((level->auto_count_kettles ? 1 : 0), file);
 381   fputc(level->amoeba_speed, file);
 382   fputc(level->time_fuse, file);
 383
 384   laser_color = ((level->laser_red   << 2) |
 385                  (level->laser_green << 1) |
 386                  (level->laser_blue  << 0));
 387   fputc(laser_color, file);
 388
 389   fputc((level->encoding_16bit_field ? 1 : 0), file);
 390
 391   WriteUnusedBytesToFile(file, LEVEL_HEADER_UNUSED);
 392 }
 393
 394 static void SaveLevel_MM_AUTH(FILE *file, struct LevelInfo_MM *level)
 395 {
 396   int i;
 397
 398   for (i = 0; i < MAX_LEVEL_AUTHOR_LEN; i++)
 399     fputc(level->author[i], file);
 400 }
 401
 402 static void SaveLevel_MM_BODY(FILE *file, struct LevelInfo_MM *level)
 403 {
 404   int x, y;
 405
 406   for (y = 0; y < level->fieldy; y++)
 407     for (x = 0; x < level->fieldx; x++)
 408       if (level->encoding_16bit_field)
 409         putFile16BitInteger(file, Ur[x][y], BYTE_ORDER_BIG_ENDIAN);
 410       else
 411         fputc(Ur[x][y], file);
 412 }
 413
 414 void SaveNativeLevel_MM(char *filename)
 415 {
 416   int x, y;
 417   int body_chunk_size;
 418   FILE *file;
 419
 420   if (!(file = fopen(filename, MODE_WRITE)))
 421   {
 422     Error(ERR_WARN, "cannot save level file '%s'", filename);
 423
 424     return;
 425   }
 426
 427   // check level field for 16-bit elements
 428   native_mm_level.encoding_16bit_field = FALSE;
 429
 430   for (y = 0; y < native_mm_level.fieldy; y++)
 431     for (x = 0; x < native_mm_level.fieldx; x++)
 432       if (Ur[x][y] > 255)
 433         native_mm_level.encoding_16bit_field = TRUE;
 434
 435   body_chunk_size =
 436     native_mm_level.fieldx * native_mm_level.fieldy *
 437     (native_mm_level.encoding_16bit_field ? 2 : 1);
 438
 439   putFileChunk(file, "MMII", CHUNK_SIZE_UNDEFINED, BYTE_ORDER_BIG_ENDIAN);
 440   putFileChunk(file, "CAVE", CHUNK_SIZE_NONE,      BYTE_ORDER_BIG_ENDIAN);
 441
 442   putFileChunk(file, "VERS", FILE_VERS_CHUNK_SIZE, BYTE_ORDER_BIG_ENDIAN);
 443   WriteChunk_MM_VERS(file, MM_FILE_VERSION_ACTUAL, MM_GAME_VERSION_ACTUAL);
 444
 445   putFileChunk(file, "HEAD", LEVEL_HEADER_SIZE, BYTE_ORDER_BIG_ENDIAN);
 446   SaveLevel_MM_HEAD(file, &native_mm_level);
 447
 448   putFileChunk(file, "AUTH", MAX_LEVEL_AUTHOR_LEN, BYTE_ORDER_BIG_ENDIAN);
 449   SaveLevel_MM_AUTH(file, &native_mm_level);
 450
 451   putFileChunk(file, "BODY", body_chunk_size, BYTE_ORDER_BIG_ENDIAN);
 452   SaveLevel_MM_BODY(file, &native_mm_level);
 453
 454   fclose(file);
 455
 456   SetFilePermissions(filename, PERMS_PRIVATE);
 457 }