added options to use artwork and to copy template when creating level set
[rocksndiamonds.git] / src / libgame / setup.c
index d857883730534d1ce66596dbc418270bbf603380..f28df34f30713cc103e0ce83b88a854fb85fd243 100644 (file)
@@ -114,22 +114,6 @@ static char *getLevelClassDescription(TreeInfo *ti)
     return "Unknown Level Class";
 }
 
-static char *getUserLevelDir(char *level_subdir)
-{
-  static char *userlevel_dir = NULL;
-  char *data_dir = getUserGameDataDir();
-  char *userlevel_subdir = LEVELS_DIRECTORY;
-
-  checked_free(userlevel_dir);
-
-  if (level_subdir != NULL)
-    userlevel_dir = getPath3(data_dir, userlevel_subdir, level_subdir);
-  else
-    userlevel_dir = getPath2(data_dir, userlevel_subdir);
-
-  return userlevel_dir;
-}
-
 static char *getScoreDir(char *level_subdir)
 {
   static char *score_dir = NULL;
@@ -197,6 +181,22 @@ static char *getLevelDirFromTreeInfo(TreeInfo *node)
   return level_dir;
 }
 
+char *getUserLevelDir(char *level_subdir)
+{
+  static char *userlevel_dir = NULL;
+  char *data_dir = getUserGameDataDir();
+  char *userlevel_subdir = LEVELS_DIRECTORY;
+
+  checked_free(userlevel_dir);
+
+  if (level_subdir != NULL)
+    userlevel_dir = getPath3(data_dir, userlevel_subdir, level_subdir);
+  else
+    userlevel_dir = getPath2(data_dir, userlevel_subdir);
+
+  return userlevel_dir;
+}
+
 char *getCurrentLevelDir()
 {
   return getLevelDirFromTreeInfo(leveldir_current);
@@ -425,27 +425,74 @@ inline static char *getLevelArtworkDir(int type)
   return LEVELDIR_ARTWORK_PATH(leveldir_current, type);
 }
 
-char *getProgramConfigFilename(char *command_filename_ptr)
+char *getProgramMainDataPath(char *command_filename, char *base_path)
 {
-  char *command_filename_1 = getStringCopy(command_filename_ptr);
+  /* check if the program's main data base directory is configured */
+  if (!strEqual(base_path, "."))
+    return base_path;
+
+  /* if the program is configured to start from current directory (default),
+     determine program package directory from program binary (some versions
+     of KDE/Konqueror and Mac OS X (especially "Mavericks") apparently do not
+     set the current working directory to the program package directory) */
+  char *main_data_path = getBasePath(command_filename);
+
+#if defined(PLATFORM_MACOSX)
+  if (strSuffix(main_data_path, MAC_APP_BINARY_SUBDIR))
+  {
+    char *main_data_path_old = main_data_path;
+
+    // cut relative path to Mac OS X application binary directory from path
+    main_data_path[strlen(main_data_path) -
+                  strlen(MAC_APP_BINARY_SUBDIR)] = '\0';
+
+    // cut trailing path separator from path (but not if path is root directory)
+    if (strSuffix(main_data_path, "/") && !strEqual(main_data_path, "/"))
+      main_data_path[strlen(main_data_path) - 1] = '\0';
+
+    // replace empty path with current directory
+    if (strEqual(main_data_path, ""))
+      main_data_path = ".";
+
+    // add relative path to Mac OS X application resources directory to path
+    main_data_path = getPath2(main_data_path, MAC_APP_FILES_SUBDIR);
+
+    free(main_data_path_old);
+  }
+#endif
+
+  return main_data_path;
+}
+
+char *getProgramConfigFilename(char *command_filename)
+{
+  char *command_filename_1 = getStringCopy(command_filename);
 
   // strip trailing executable suffix from command filename
   if (strSuffix(command_filename_1, ".exe"))
     command_filename_1[strlen(command_filename_1) - 4] = '\0';
 
-  char *command_basepath = getBasePath(command_filename_ptr);
-  char *command_basename = getBaseNameNoSuffix(command_filename_ptr);
+  char *ro_base_path = getProgramMainDataPath(command_filename, RO_BASE_PATH);
+  char *conf_directory = getPath2(ro_base_path, CONF_DIRECTORY);
+
+  char *command_basepath = getBasePath(command_filename);
+  char *command_basename = getBaseNameNoSuffix(command_filename);
   char *command_filename_2 = getPath2(command_basepath, command_basename);
 
   char *config_filename_1 = getStringCat2(command_filename_1, ".conf");
   char *config_filename_2 = getStringCat2(command_filename_2, ".conf");
+  char *config_filename_3 = getPath2(conf_directory, SETUP_FILENAME);
 
   // 1st try: look for config file that exactly matches the binary filename
   if (fileExists(config_filename_1))
     return config_filename_1;
 
-  // 2nd try: return config filename that matches binary filename without suffix
-  return config_filename_2;
+  // 2nd try: look for config file that matches binary filename without suffix
+  if (fileExists(config_filename_2))
+    return config_filename_2;
+
+  // 3rd try: return setup config filename in global program config directory
+  return config_filename_3;
 }
 
 char *getTapeFilename(int nr)
@@ -2649,7 +2696,7 @@ static TreeInfo *createTopTreeInfoNode(TreeInfo *node_first)
   setString(&ti_new->name_sorting, ti_new->name);
 
   setString(&ti_new->subdir, STRING_TOP_DIRECTORY);
-  setString(&ti_new->fullpath, node_first->fullpath);
+  setString(&ti_new->fullpath, ".");
 
   ti_new->sort_priority = node_first->sort_priority;;
   ti_new->latest_engine = node_first->latest_engine;
@@ -3516,9 +3563,88 @@ void LoadLevelArtworkInfo()
   print_timestamp_done("LoadLevelArtworkInfo");
 }
 
-boolean UpdateUserLevelSet(char *level_subdir,
-                          char *level_name, char *level_author,
-                          int num_levels, int first_level_nr)
+static boolean AddUserLevelSetToLevelInfoExt(char *level_subdir_new)
+{
+  // get level info tree node of first (original) user level set
+  char *level_subdir_old = getLoginName();
+  LevelDirTree *leveldir_old = getTreeInfoFromIdentifier(leveldir_first,
+                                                        level_subdir_old);
+  if (leveldir_old == NULL)            // should not happen
+    return FALSE;
+
+  int draw_deactivation_mask = GetDrawDeactivationMask();
+
+  // override draw deactivation mask (temporarily disable drawing)
+  SetDrawDeactivationMask(REDRAW_ALL);
+
+  // load new level set config and add it next to first user level set
+  LoadLevelInfoFromLevelConf(&leveldir_old->next, NULL,
+                            leveldir_old->basepath, level_subdir_new);
+
+  // set draw deactivation mask to previous value
+  SetDrawDeactivationMask(draw_deactivation_mask);
+
+  // get level info tree node of newly added user level set
+  LevelDirTree *leveldir_new = getTreeInfoFromIdentifier(leveldir_first,
+                                                        level_subdir_new);
+  if (leveldir_new == NULL)            // should not happen
+    return FALSE;
+
+  // correct top link and parent node link of newly created tree node
+  leveldir_new->node_top    = leveldir_old->node_top;
+  leveldir_new->node_parent = leveldir_old->node_parent;
+
+  // sort level info tree to adjust position of newly added level set
+  sortTreeInfo(&leveldir_first);
+
+  return TRUE;
+}
+
+void AddUserLevelSetToLevelInfo(char *level_subdir_new)
+{
+  if (!AddUserLevelSetToLevelInfoExt(level_subdir_new))
+    Error(ERR_EXIT, "internal level set structure corrupted -- aborting");
+}
+
+char *getArtworkIdentifierForUserLevelSet(int type)
+{
+  char *classic_artwork_set = getClassicArtworkSet(type);
+
+  /* check for custom artwork configured in "levelinfo.conf" */
+  char *leveldir_artwork_set =
+    *LEVELDIR_ARTWORK_SET_PTR(leveldir_current, type);
+  boolean has_leveldir_artwork_set =
+    (leveldir_artwork_set != NULL && !strEqual(leveldir_artwork_set,
+                                              classic_artwork_set));
+
+  /* check for custom artwork in sub-directory "graphics" etc. */
+  TreeInfo *artwork_first_node = ARTWORK_FIRST_NODE(artwork, type);
+  char *leveldir_identifier = leveldir_current->identifier;
+  boolean has_artwork_subdir =
+    (getTreeInfoFromIdentifier(artwork_first_node,
+                              leveldir_identifier) != NULL);
+
+  return (has_leveldir_artwork_set ? leveldir_artwork_set :
+         has_artwork_subdir       ? leveldir_identifier :
+         classic_artwork_set);
+}
+
+boolean checkIfCustomArtworkExistsForCurrentLevelSet()
+{
+  char *graphics_set =
+    getArtworkIdentifierForUserLevelSet(ARTWORK_TYPE_GRAPHICS);
+  char *sounds_set =
+    getArtworkIdentifierForUserLevelSet(ARTWORK_TYPE_SOUNDS);
+  char *music_set =
+    getArtworkIdentifierForUserLevelSet(ARTWORK_TYPE_MUSIC);
+
+  return (!strEqual(graphics_set, GFX_CLASSIC_SUBDIR) ||
+         !strEqual(sounds_set,   SND_CLASSIC_SUBDIR) ||
+         !strEqual(music_set,    MUS_CLASSIC_SUBDIR));
+}
+
+boolean UpdateUserLevelSet(char *level_subdir, char *level_name,
+                          char *level_author, int num_levels)
 {
   char *filename = getPath2(getUserLevelDir(level_subdir), LEVELINFO_FILENAME);
   char *filename_tmp = getStringCat2(filename, ".tmp");
@@ -3526,6 +3652,27 @@ boolean UpdateUserLevelSet(char *level_subdir,
   FILE *file_tmp = NULL;
   char line[MAX_LINE_LEN];
   boolean success = FALSE;
+  LevelDirTree *leveldir = getTreeInfoFromIdentifier(leveldir_first,
+                                                    level_subdir);
+  // update values in level directory tree
+
+  if (level_name != NULL)
+    setString(&leveldir->name, level_name);
+
+  if (level_author != NULL)
+    setString(&leveldir->author, level_author);
+
+  if (num_levels != -1)
+    leveldir->levels = num_levels;
+
+  // update values that depend on other values
+
+  setString(&leveldir->name_sorting, leveldir->name);
+
+  leveldir->last_level = leveldir->first_level + leveldir->levels - 1;
+
+  // sort order of level sets may have changed
+  sortTreeInfo(&leveldir_first);
 
   if ((file     = fopen(filename,     MODE_READ)) &&
       (file_tmp = fopen(filename_tmp, MODE_WRITE)))
@@ -3538,8 +3685,6 @@ boolean UpdateUserLevelSet(char *level_subdir,
        fprintf(file_tmp, "%-32s%s\n", "author:", level_author);
       else if (strPrefix(line, "levels:") && num_levels != -1)
        fprintf(file_tmp, "%-32s%d\n", "levels:", num_levels);
-      else if (strPrefix(line, "first_level:") && first_level_nr != -1)
-       fprintf(file_tmp, "%-32s%d\n", "first_level:", first_level_nr);
       else
        fputs(line, file_tmp);
     }
@@ -3562,9 +3707,9 @@ boolean UpdateUserLevelSet(char *level_subdir,
   return success;
 }
 
-boolean CreateUserLevelSet(char *level_subdir,
-                          char *level_name, char *level_author,
-                          int num_levels, int first_level_nr)
+boolean CreateUserLevelSet(char *level_subdir, char *level_name,
+                          char *level_author, int num_levels,
+                          boolean use_artwork_set)
 {
   LevelDirTree *level_info;
   char *filename;
@@ -3592,10 +3737,20 @@ boolean CreateUserLevelSet(char *level_subdir,
   setString(&level_info->name, level_name);
   setString(&level_info->author, level_author);
   level_info->levels = num_levels;
-  level_info->first_level = first_level_nr;
+  level_info->first_level = 1;
   level_info->sort_priority = LEVELCLASS_PRIVATE_START;
   level_info->readonly = FALSE;
 
+  if (use_artwork_set)
+  {
+    level_info->graphics_set =
+      getStringCopy(getArtworkIdentifierForUserLevelSet(ARTWORK_TYPE_GRAPHICS));
+    level_info->sounds_set =
+      getStringCopy(getArtworkIdentifierForUserLevelSet(ARTWORK_TYPE_SOUNDS));
+    level_info->music_set =
+      getStringCopy(getArtworkIdentifierForUserLevelSet(ARTWORK_TYPE_MUSIC));
+  }
+
   token_value_position = TOKEN_VALUE_POSITION_SHORT;
 
   fprintFileHeader(file, LEVELINFO_FILENAME);
@@ -3608,12 +3763,16 @@ boolean CreateUserLevelSet(char *level_subdir,
        i == LEVELINFO_TOKEN_LEVELS ||
        i == LEVELINFO_TOKEN_FIRST_LEVEL ||
        i == LEVELINFO_TOKEN_SORT_PRIORITY ||
-       i == LEVELINFO_TOKEN_READONLY)
+       i == LEVELINFO_TOKEN_READONLY ||
+       (use_artwork_set && (i == LEVELINFO_TOKEN_GRAPHICS_SET ||
+                            i == LEVELINFO_TOKEN_SOUNDS_SET ||
+                            i == LEVELINFO_TOKEN_MUSIC_SET)))
       fprintf(file, "%s\n", getSetupLine(levelinfo_tokens, "", i));
 
     /* just to make things nicer :) */
     if (i == LEVELINFO_TOKEN_AUTHOR ||
-       i == LEVELINFO_TOKEN_FIRST_LEVEL)
+       i == LEVELINFO_TOKEN_FIRST_LEVEL ||
+       (use_artwork_set && i == LEVELINFO_TOKEN_READONLY))
       fprintf(file, "\n");     
   }
 
@@ -3631,7 +3790,7 @@ boolean CreateUserLevelSet(char *level_subdir,
 
 static void SaveUserLevelInfo()
 {
-  CreateUserLevelSet(getLoginName(), getLoginName(), getRealName(), 100, 1);
+  CreateUserLevelSet(getLoginName(), getLoginName(), getRealName(), 100, FALSE);
 }
 
 char *getSetupValue(int type, void *value)