rnd-20091211-1-src
[rocksndiamonds.git] / src / files.c
index 329e4e931187c1eb55abe3cf08d88708a5162c6c..b16bc6ca5162f709f799680056cdc331ca62ba17 100644 (file)
@@ -1792,6 +1792,11 @@ static int getFileTypeFromBasename(char *basename)
       strSuffixLower(basename, ".dc2"))
     return LEVEL_FILE_TYPE_DC;
 
+  /* check for typical filename of a Sokoban level package file */
+  if (strSuffixLower(basename, ".xsb") &&
+      strchr(basename, '%') == NULL)
+    return LEVEL_FILE_TYPE_SB;
+
   /* ---------- try to determine file type from filesize ---------- */
 
   checked_free(filename);
@@ -6322,6 +6327,350 @@ static void LoadLevelFromFileInfo_DC(struct LevelInfo *level,
 #endif
 
 
+/* ------------------------------------------------------------------------- */
+/* functions for loading SB level                                            */
+/* ------------------------------------------------------------------------- */
+
+#if 1
+
+static boolean check_special_flags(char *flag)
+{
+#if 0
+  printf("::: '%s', '%s', '%s'\n",
+        flag,
+        options.special_flags,
+        leveldir_current->special_flags);
+#endif
+
+  if (strEqual(options.special_flags, flag) ||
+      strEqual(leveldir_current->special_flags, flag))
+    return TRUE;
+
+  return FALSE;
+}
+
+#else
+
+#define SPECIAL_FLAG_LOAD_XSB_TO_CES   (1 << 0)
+
+static unsigned long get_special_flags(char *flags_string)
+{
+  unsigned long flags_value = 0;
+
+  if (strEqual(flags_string, "load_xsb_to_ces"))
+    flags_value = SPECIAL_FLAG_LOAD_XSB_TO_CES;
+
+  return flags_value;
+}
+
+#endif
+
+int getMappedElement_SB(int element_ascii, boolean use_ces)
+{
+  static struct
+  {
+    int ascii;
+    int sb;
+    int ce;
+  }
+  sb_element_mapping[] =
+  {
+    { ' ', EL_EMPTY,                EL_CUSTOM_1 },  /* floor (space) */
+    { '#', EL_STEELWALL,            EL_CUSTOM_2 },  /* wall */
+    { '@', EL_PLAYER_1,             EL_CUSTOM_3 },  /* player */
+    { '$', EL_SOKOBAN_OBJECT,       EL_CUSTOM_4 },  /* box */
+    { '.', EL_SOKOBAN_FIELD_EMPTY,  EL_CUSTOM_5 },  /* goal square */
+    { '*', EL_SOKOBAN_FIELD_FULL,   EL_CUSTOM_6 },  /* box on goal square */
+    { '+', EL_SOKOBAN_FIELD_PLAYER, EL_CUSTOM_7 },  /* player on goal square */
+    { '_', EL_INVISIBLE_STEELWALL,  EL_CUSTOM_8 },  /* floor beyond border */
+
+    { 0,   -1,                      -1          },
+  };
+
+  int i;
+
+  for (i = 0; sb_element_mapping[i].ascii != 0; i++)
+    if (element_ascii == sb_element_mapping[i].ascii)
+      return (use_ces ? sb_element_mapping[i].ce : sb_element_mapping[i].sb);
+
+  return EL_UNDEFINED;
+}
+
+static void LoadLevelFromFileInfo_SB(struct LevelInfo *level,
+                                    struct LevelFileInfo *level_file_info)
+{
+  char *filename = level_file_info->filename;
+  char line[MAX_LINE_LEN], line_raw[MAX_LINE_LEN], previous_line[MAX_LINE_LEN];
+  char last_comment[MAX_LINE_LEN];
+  char level_name[MAX_LINE_LEN];
+  char *line_ptr;
+  FILE *file;
+  int num_levels_to_skip = level_file_info->nr - leveldir_current->first_level;
+  boolean read_continued_line = FALSE;
+  boolean reading_playfield = FALSE;
+  boolean got_valid_playfield_line = FALSE;
+  boolean invalid_playfield_char = FALSE;
+#if 1
+  boolean load_xsb_to_ces = check_special_flags("load_xsb_to_ces");
+#else
+  boolean load_xsb_to_ces = options.special_flags & SPECIAL_FLAG_LOAD_XSB_TO_CES;
+#endif
+  int file_level_nr = 0;
+  int line_nr = 0;
+  int x, y;
+
+#if 0
+  printf("::: looking for level number %d [%d]\n",
+        level_file_info->nr, num_levels_to_skip);
+#endif
+
+  last_comment[0] = '\0';
+  level_name[0] = '\0';
+
+  if (!(file = fopen(filename, MODE_READ)))
+  {
+    level->no_valid_file = TRUE;
+
+    Error(ERR_WARN, "cannot read level '%s' -- using empty level", filename);
+
+    return;
+  }
+
+  while (!feof(file))
+  {
+    /* level successfully read, but next level may follow here */
+    if (!got_valid_playfield_line && reading_playfield)
+    {
+#if 0
+      printf("::: read complete playfield\n");
+#endif
+
+      /* read playfield from single level file -- skip remaining file */
+      if (!level_file_info->packed)
+       break;
+
+      if (file_level_nr >= num_levels_to_skip)
+       break;
+
+      file_level_nr++;
+
+      last_comment[0] = '\0';
+      level_name[0] = '\0';
+
+      reading_playfield = FALSE;
+    }
+
+    got_valid_playfield_line = FALSE;
+
+    /* read next line of input file */
+    if (!fgets(line, MAX_LINE_LEN, file))
+      break;
+
+    /* check if line was completely read and is terminated by line break */
+    if (strlen(line) > 0 && line[strlen(line) - 1] == '\n')
+      line_nr++;
+
+    /* cut trailing line break (this can be newline and/or carriage return) */
+    for (line_ptr = &line[strlen(line)]; line_ptr >= line; line_ptr--)
+      if ((*line_ptr == '\n' || *line_ptr == '\r') && *(line_ptr + 1) == '\0')
+        *line_ptr = '\0';
+
+    /* copy raw input line for later use (mainly debugging output) */
+    strcpy(line_raw, line);
+
+    if (read_continued_line)
+    {
+      /* append new line to existing line, if there is enough space */
+      if (strlen(previous_line) + strlen(line_ptr) < MAX_LINE_LEN)
+        strcat(previous_line, line_ptr);
+
+      strcpy(line, previous_line);      /* copy storage buffer to line */
+
+      read_continued_line = FALSE;
+    }
+
+    /* if the last character is '\', continue at next line */
+    if (strlen(line) > 0 && line[strlen(line) - 1] == '\\')
+    {
+      line[strlen(line) - 1] = '\0';    /* cut off trailing backslash */
+      strcpy(previous_line, line);      /* copy line to storage buffer */
+
+      read_continued_line = TRUE;
+
+      continue;
+    }
+
+    /* skip empty lines */
+    if (line[0] == '\0')
+      continue;
+
+    /* extract comment text from comment line */
+    if (line[0] == ';')
+    {
+      for (line_ptr = line; *line_ptr; line_ptr++)
+        if (*line_ptr != ' ' && *line_ptr != '\t' && *line_ptr != ';')
+          break;
+
+      strcpy(last_comment, line_ptr);
+
+#if 0
+      printf("::: found comment '%s' in line %d\n", last_comment, line_nr);
+#endif
+
+      continue;
+    }
+
+    /* extract level title text from line containing level title */
+    if (line[0] == '\'')
+    {
+      strcpy(level_name, &line[1]);
+
+      if (strlen(level_name) > 0 && level_name[strlen(level_name) - 1] == '\'')
+       level_name[strlen(level_name) - 1] = '\0';
+
+#if 0
+      printf("::: found level name '%s' in line %d\n", level_name, line_nr);
+#endif
+
+      continue;
+    }
+
+    /* skip lines containing only spaces (or empty lines) */
+    for (line_ptr = line; *line_ptr; line_ptr++)
+      if (*line_ptr != ' ')
+       break;
+    if (*line_ptr == '\0')
+      continue;
+
+    /* at this point, we have found a line containing part of a playfield */
+
+#if 0
+    printf("::: found playfield row in line %d\n", line_nr);
+#endif
+
+    got_valid_playfield_line = TRUE;
+
+    if (!reading_playfield)
+    {
+      reading_playfield = TRUE;
+      invalid_playfield_char = FALSE;
+
+      for (x = 0; x < MAX_LEV_FIELDX; x++)
+       for (y = 0; y < MAX_LEV_FIELDY; y++)
+         level->field[x][y] = getMappedElement_SB(' ', load_xsb_to_ces);
+
+      level->fieldx = 0;
+      level->fieldy = 0;
+
+      /* start with topmost tile row */
+      y = 0;
+    }
+
+    /* skip playfield line if larger row than allowed */
+    if (y >= MAX_LEV_FIELDY)
+      continue;
+
+    /* start with leftmost tile column */
+    x = 0;
+
+    /* read playfield elements from line */
+    for (line_ptr = line; *line_ptr; line_ptr++)
+    {
+      int mapped_sb_element = getMappedElement_SB(*line_ptr, load_xsb_to_ces);
+
+      /* stop parsing playfield line if larger column than allowed */
+      if (x >= MAX_LEV_FIELDX)
+       break;
+
+      if (mapped_sb_element == EL_UNDEFINED)
+      {
+       invalid_playfield_char = TRUE;
+
+       break;
+      }
+
+      level->field[x][y] = mapped_sb_element;
+
+      /* continue with next tile column */
+      x++;
+
+      level->fieldx = MAX(x, level->fieldx);
+    }
+
+    if (invalid_playfield_char)
+    {
+      /* if first playfield line, treat invalid lines as comment lines */
+      if (y == 0)
+       reading_playfield = FALSE;
+
+      continue;
+    }
+
+    /* continue with next tile row */
+    y++;
+  }
+
+  fclose(file);
+
+  level->fieldy = y;
+
+  level->fieldx = MIN(MAX(MIN_LEV_FIELDX, level->fieldx), MAX_LEV_FIELDX);
+  level->fieldy = MIN(MAX(MIN_LEV_FIELDY, level->fieldy), MAX_LEV_FIELDY);
+
+  if (!reading_playfield)
+  {
+    level->no_valid_file = TRUE;
+
+    Error(ERR_WARN, "cannot read level '%s' -- using empty level", filename);
+
+    return;
+  }
+
+  if (*level_name != '\0')
+  {
+    strncpy(level->name, level_name, MAX_LEVEL_NAME_LEN);
+    level->name[MAX_LEVEL_NAME_LEN] = '\0';
+
+#if 0
+    printf(":1: level name: '%s'\n", level->name);
+#endif
+  }
+  else if (*last_comment != '\0')
+  {
+    strncpy(level->name, last_comment, MAX_LEVEL_NAME_LEN);
+    level->name[MAX_LEVEL_NAME_LEN] = '\0';
+
+#if 0
+    printf(":2: level name: '%s'\n", level->name);
+#endif
+  }
+  else
+  {
+    sprintf(level->name, "--> Level %d <--", level_file_info->nr);
+  }
+
+  /* set all empty fields beyond the border walls to invisible steel wall */
+  for (y = 0; y < level->fieldy; y++) for (x = 0; x < level->fieldx; x++)
+  {
+    if ((x == 0 || x == level->fieldx - 1 ||
+        y == 0 || y == level->fieldy - 1) &&
+       level->field[x][y] == getMappedElement_SB(' ', load_xsb_to_ces))
+      FloodFillLevel(x, y, getMappedElement_SB('_', load_xsb_to_ces),
+                    level->field, level->fieldx, level->fieldy);
+  }
+
+  if (load_xsb_to_ces)
+  {
+    level->time = 0;
+    level->use_step_counter = TRUE;
+
+    level->initial_player_stepsize[0] = STEPSIZE_SLOW;
+
+    level->use_custom_template = TRUE;
+  }
+}
+
+
 /* ------------------------------------------------------------------------- */
 /* functions for handling native levels                                      */
 /* ------------------------------------------------------------------------- */
@@ -6393,6 +6742,10 @@ void LoadLevelFromFileInfo(struct LevelInfo *level,
       LoadLevelFromFileInfo_DC(level, level_file_info);
       break;
 
+    case LEVEL_FILE_TYPE_SB:
+      LoadLevelFromFileInfo_SB(level, level_file_info);
+      break;
+
     default:
       LoadLevelFromFileInfo_RND(level, level_file_info);
       break;
@@ -8386,14 +8739,15 @@ void SaveScore(int nr)
 #define SETUP_TOKEN_INPUT_ON_FOCUS             22
 #define SETUP_TOKEN_PREFER_AGA_GRAPHICS                23
 #define SETUP_TOKEN_GAME_FRAME_DELAY           24
-#define SETUP_TOKEN_GRAPHICS_SET               25
-#define SETUP_TOKEN_SOUNDS_SET                 26
-#define SETUP_TOKEN_MUSIC_SET                  27
-#define SETUP_TOKEN_OVERRIDE_LEVEL_GRAPHICS    28
-#define SETUP_TOKEN_OVERRIDE_LEVEL_SOUNDS      29
-#define SETUP_TOKEN_OVERRIDE_LEVEL_MUSIC       30
+#define SETUP_TOKEN_SP_SHOW_BORDER_ELEMENTS    25
+#define SETUP_TOKEN_GRAPHICS_SET               26
+#define SETUP_TOKEN_SOUNDS_SET                 27
+#define SETUP_TOKEN_MUSIC_SET                  28
+#define SETUP_TOKEN_OVERRIDE_LEVEL_GRAPHICS    29
+#define SETUP_TOKEN_OVERRIDE_LEVEL_SOUNDS      30
+#define SETUP_TOKEN_OVERRIDE_LEVEL_MUSIC       31
 
-#define NUM_GLOBAL_SETUP_TOKENS                        31
+#define NUM_GLOBAL_SETUP_TOKENS                        32
 
 /* editor setup */
 #define SETUP_TOKEN_EDITOR_EL_BOULDERDASH      0
@@ -8490,34 +8844,35 @@ static struct OptionInfo soi;
 
 static struct TokenInfo global_setup_tokens[] =
 {
-  { TYPE_STRING, &si.player_name,      "player_name"                   },
-  { TYPE_SWITCH, &si.sound,            "sound"                         },
-  { TYPE_SWITCH, &si.sound_loops,      "repeating_sound_loops"         },
-  { TYPE_SWITCH, &si.sound_music,      "background_music"              },
-  { TYPE_SWITCH, &si.sound_simple,     "simple_sound_effects"          },
-  { TYPE_SWITCH, &si.toons,            "toons"                         },
-  { TYPE_SWITCH, &si.scroll_delay,     "scroll_delay"                  },
-  { TYPE_INTEGER,&si.scroll_delay_value,"scroll_delay_value"           },
-  { TYPE_SWITCH, &si.soft_scrolling,   "soft_scrolling"                },
-  { TYPE_SWITCH, &si.fade_screens,     "fade_screens"                  },
-  { TYPE_SWITCH, &si.autorecord,       "automatic_tape_recording"      },
-  { TYPE_SWITCH, &si.show_titlescreen, "show_titlescreen"              },
-  { TYPE_SWITCH, &si.quick_doors,      "quick_doors"                   },
-  { TYPE_SWITCH, &si.team_mode,                "team_mode"                     },
-  { TYPE_SWITCH, &si.handicap,         "handicap"                      },
-  { TYPE_SWITCH, &si.skip_levels,      "skip_levels"                   },
-  { TYPE_SWITCH, &si.time_limit,       "time_limit"                    },
-  { TYPE_SWITCH, &si.fullscreen,       "fullscreen"                    },
-  { TYPE_STRING, &si.fullscreen_mode,  "fullscreen_mode"               },
-  { TYPE_SWITCH, &si.ask_on_escape,    "ask_on_escape"                 },
-  { TYPE_SWITCH, &si.ask_on_escape_editor, "ask_on_escape_editor"      },
-  { TYPE_SWITCH, &si.quick_switch,     "quick_player_switch"           },
-  { TYPE_SWITCH, &si.input_on_focus,   "input_on_focus"                },
-  { TYPE_SWITCH, &si.prefer_aga_graphics, "prefer_aga_graphics"                },
-  { TYPE_INTEGER,&si.game_frame_delay, "game_frame_delay"              },
-  { TYPE_STRING, &si.graphics_set,     "graphics_set"                  },
-  { TYPE_STRING, &si.sounds_set,       "sounds_set"                    },
-  { TYPE_STRING, &si.music_set,                "music_set"                     },
+  { TYPE_STRING, &si.player_name,             "player_name"            },
+  { TYPE_SWITCH, &si.sound,                   "sound"                  },
+  { TYPE_SWITCH, &si.sound_loops,             "repeating_sound_loops"  },
+  { TYPE_SWITCH, &si.sound_music,             "background_music"       },
+  { TYPE_SWITCH, &si.sound_simple,            "simple_sound_effects"   },
+  { TYPE_SWITCH, &si.toons,                   "toons"                  },
+  { TYPE_SWITCH, &si.scroll_delay,            "scroll_delay"           },
+  { TYPE_INTEGER,&si.scroll_delay_value,      "scroll_delay_value"     },
+  { TYPE_SWITCH, &si.soft_scrolling,          "soft_scrolling"         },
+  { TYPE_SWITCH, &si.fade_screens,            "fade_screens"           },
+  { TYPE_SWITCH, &si.autorecord,              "automatic_tape_recording"},
+  { TYPE_SWITCH, &si.show_titlescreen,        "show_titlescreen"       },
+  { TYPE_SWITCH, &si.quick_doors,             "quick_doors"            },
+  { TYPE_SWITCH, &si.team_mode,               "team_mode"              },
+  { TYPE_SWITCH, &si.handicap,                "handicap"               },
+  { TYPE_SWITCH, &si.skip_levels,             "skip_levels"            },
+  { TYPE_SWITCH, &si.time_limit,              "time_limit"             },
+  { TYPE_SWITCH, &si.fullscreen,              "fullscreen"             },
+  { TYPE_STRING, &si.fullscreen_mode,         "fullscreen_mode"                },
+  { TYPE_SWITCH, &si.ask_on_escape,           "ask_on_escape"          },
+  { TYPE_SWITCH, &si.ask_on_escape_editor,    "ask_on_escape_editor"   },
+  { TYPE_SWITCH, &si.quick_switch,            "quick_player_switch"    },
+  { TYPE_SWITCH, &si.input_on_focus,          "input_on_focus"         },
+  { TYPE_SWITCH, &si.prefer_aga_graphics,     "prefer_aga_graphics"    },
+  { TYPE_INTEGER,&si.game_frame_delay,        "game_frame_delay"       },
+  { TYPE_SWITCH, &si.sp_show_border_elements, "sp_show_border_elements"        },
+  { TYPE_STRING, &si.graphics_set,            "graphics_set"           },
+  { TYPE_STRING, &si.sounds_set,              "sounds_set"             },
+  { TYPE_STRING, &si.music_set,               "music_set"              },
   { TYPE_SWITCH3,&si.override_level_graphics, "override_level_graphics"        },
   { TYPE_SWITCH3,&si.override_level_sounds,   "override_level_sounds"  },
   { TYPE_SWITCH3,&si.override_level_music,    "override_level_music"   },
@@ -8668,6 +9023,7 @@ static void setSetupInfoToDefaults(struct SetupInfo *si)
   si->input_on_focus = FALSE;
   si->prefer_aga_graphics = TRUE;
   si->game_frame_delay = GAME_FRAME_DELAY;
+  si->sp_show_border_elements = FALSE;
 
   si->graphics_set = getStringCopy(GFX_DEFAULT_SUBDIR);
   si->sounds_set = getStringCopy(SND_DEFAULT_SUBDIR);