rnd-20020531-1-src
[rocksndiamonds.git] / src / libgame / setup.c
index 0f0221aa56caafefb11de21ca000b6e54499b5d7..6ad11351d1dca59eea56a49bb080f0dd5a7dd915 100644 (file)
@@ -79,10 +79,32 @@ static char *levelclass_desc[NUM_LEVELCLASS_DESC] =
                         IS_LEVELCLASS_USER(n) ?                7 : \
                         9)
 
-#define TOKEN_VALUE_POSITION           30
+#define TOKEN_VALUE_POSITION           40
+#define TOKEN_COMMENT_POSITION         60
 
 #define MAX_COOKIE_LEN                 256
 
+#define ARTWORKINFO_FILENAME(type)     ((type) == TREE_TYPE_GRAPHICS_DIR ? \
+                                        GRAPHICSINFO_FILENAME :            \
+                                        (type) == TREE_TYPE_SOUNDS_DIR ?   \
+                                        SOUNDSINFO_FILENAME :              \
+                                        (type) == TREE_TYPE_MUSIC_DIR ?    \
+                                        MUSICINFO_FILENAME : "")
+
+#define ARTWORK_DIRECTORY(type)                ((type) == TREE_TYPE_GRAPHICS_DIR ? \
+                                        GRAPHICS_DIRECTORY :               \
+                                        (type) == TREE_TYPE_SOUNDS_DIR ?   \
+                                        SOUNDS_DIRECTORY :                 \
+                                        (type) == TREE_TYPE_MUSIC_DIR ?    \
+                                        MUSIC_DIRECTORY : "")
+
+#define OPTIONS_ARTWORK_DIRECTORY(type)        ((type) == TREE_TYPE_GRAPHICS_DIR ? \
+                                        options.graphics_directory :       \
+                                        (type) == TREE_TYPE_SOUNDS_DIR ?   \
+                                        options.sounds_directory :         \
+                                        (type) == TREE_TYPE_MUSIC_DIR ?    \
+                                        options.music_directory : "")
+
 
 /* ------------------------------------------------------------------------- */
 /* file functions                                                            */
@@ -166,23 +188,27 @@ static char *getLevelSetupDir(char *level_subdir)
   return levelsetup_dir;
 }
 
-static char *getCurrentLevelDir()
+static char *getLevelDirFromTreeInfo(TreeInfo *node)
 {
   static char *level_dir = NULL;
 
+  if (node == NULL)
+    return options.level_directory;
+
   if (level_dir)
     free(level_dir);
 
-  if (leveldir_current == NULL)
-    return options.level_directory;
-
-  level_dir = getPath2((leveldir_current->user_defined ?
-                       getUserLevelDir(NULL) : options.level_directory),
-                      leveldir_current->fullpath);
+  level_dir = getPath2((node->user_defined ? getUserLevelDir(NULL) :
+                       options.level_directory), node->fullpath);
 
   return level_dir;
 }
 
+static char *getCurrentLevelDir()
+{
+  return getLevelDirFromTreeInfo(leveldir_current);
+}
+
 static char *getDefaultGraphicsDir(char *graphics_subdir)
 {
   static char *graphics_dir = NULL;
@@ -375,7 +401,7 @@ char *getCustomImageFilename(char *basename)
     return filename;
 
   /* 4th try: look for default artwork in new default artwork directory */
-  filename = getPath2(getDefaultGraphicsDir("gfx_classic"), basename);
+  filename = getPath2(getDefaultGraphicsDir(GRAPHICS_SUBDIR), basename);
   if (fileExists(filename))
     return filename;
 
@@ -387,6 +413,85 @@ char *getCustomImageFilename(char *basename)
   return NULL;                                 /* cannot find image file */
 }
 
+char *getCustomSoundFilename(char *basename)
+{
+  static char *filename = NULL;
+
+  if (filename != NULL)
+    free(filename);
+
+#if 0
+  /* 1st try: look for special artwork in current level series directory */
+  filename = getPath3(getCurrentLevelDir(), SOUNDS_DIRECTORY, basename);
+  if (fileExists(filename))
+    return filename;
+#endif
+
+#if 0
+  /* 2nd try: look for special artwork in private artwork directory */
+  filename = getPath2(getUserSoundsDir(), basename);
+  if (fileExists(filename))
+    return filename;
+#endif
+
+  /* 3rd try: look for special artwork in configured artwork directory */
+  filename = getPath2(getSetupArtworkDir(artwork.snd_current), basename);
+  if (fileExists(filename))
+    return filename;
+
+  /* 4th try: look for default artwork in new default artwork directory */
+  filename = getPath2(getDefaultSoundsDir(SOUNDS_SUBDIR), basename);
+  if (fileExists(filename))
+    return filename;
+
+  /* 5th try: look for default artwork in old default artwork directory */
+  filename = getPath2(options.sounds_directory, basename);
+  if (fileExists(filename))
+    return filename;
+
+  return NULL;                                 /* cannot find image file */
+}
+
+char *getCustomSoundConfigFilename()
+{
+  return getCustomSoundFilename(SOUNDSINFO_FILENAME);
+}
+
+char *getCustomMusicDirectory(void)
+{
+  static char *directory = NULL;
+
+  if (directory != NULL)
+    free(directory);
+
+  /* 1st try: look for special artwork in current level series directory */
+  directory = getPath2(getCurrentLevelDir(), MUSIC_DIRECTORY);
+  if (fileExists(directory))
+    return directory;
+
+  /* 2nd try: look for special artwork in private artwork directory */
+  directory = getStringCopy(getUserMusicDir());
+  if (fileExists(directory))
+    return directory;
+
+  /* 3rd try: look for special artwork in configured artwork directory */
+  directory = getStringCopy(getSetupArtworkDir(artwork.mus_current));
+  if (fileExists(directory))
+    return directory;
+
+  /* 4th try: look for default artwork in new default artwork directory */
+  directory = getStringCopy(getDefaultMusicDir(MUSIC_SUBDIR));
+  if (fileExists(directory))
+    return directory;
+
+  /* 5th try: look for default artwork in old default artwork directory */
+  directory = getStringCopy(options.music_directory);
+  if (fileExists(directory))
+    return directory;
+
+  return NULL;                                 /* cannot find image file */
+}
+
 void InitTapeDirectory(char *level_subdir)
 {
   createDirectory(getUserDataDir(), "user data", PERMS_PRIVATE);
@@ -499,23 +604,23 @@ boolean validLevelSeries(TreeInfo *node)
   return (node != NULL && !node->node_group && !node->parent_link);
 }
 
-TreeInfo *getFirstValidLevelSeries(TreeInfo *node)
+TreeInfo *getFirstValidTreeInfoEntry(TreeInfo *node)
 {
   if (node == NULL)
   {
-    if (leveldir_first)                /* start with first level directory entry */
-      return getFirstValidLevelSeries(leveldir_first);
+    if (node->node_top)                /* start with first tree entry */
+      return getFirstValidTreeInfoEntry(*node->node_top);
     else
       return NULL;
   }
   else if (node->node_group)   /* enter level group (step down into tree) */
-    return getFirstValidLevelSeries(node->node_group);
+    return getFirstValidTreeInfoEntry(node->node_group);
   else if (node->parent_link)  /* skip start entry of level group */
   {
     if (node->next)            /* get first real level series entry */
-      return getFirstValidLevelSeries(node->next);
+      return getFirstValidTreeInfoEntry(node->next);
     else                       /* leave empty level group and go on */
-      return getFirstValidLevelSeries(node->node_parent->next);
+      return getFirstValidTreeInfoEntry(node->node_parent->next);
   }
   else                         /* this seems to be a regular level series */
     return node;
@@ -615,7 +720,8 @@ void dumpTreeInfo(TreeInfo *node, int depth)
     for (i=0; i<(depth + 1) * 3; i++)
       printf(" ");
 
-    printf("filename == '%s' [%s]\n", node->filename, node->name);
+    printf("filename == '%s' (%s) [%s]\n",
+          node->filename, node->name, node->name_short);
 
     if (node->node_group != NULL)
       dumpTreeInfo(node->node_group, depth + 1);
@@ -908,11 +1014,12 @@ char *getFormattedSetupEntry(char *token, char *value)
   int i;
   static char entry[MAX_LINE_LEN];
 
+  /* start with the token and some spaces to format output line */
   sprintf(entry, "%s:", token);
   for (i=strlen(entry); i<TOKEN_VALUE_POSITION; i++)
-    entry[i] = ' ';
-  entry[i] = '\0';
+    strcat(entry, " ");
 
+  /* continue with the token's value */
   strcat(entry, value);
 
   return entry;
@@ -1330,7 +1437,7 @@ static boolean LoadLevelInfoFromLevelConf(TreeInfo **node_first,
 
   if (setup_file_list == NULL)
   {
-    Error(ERR_WARN, "ignoring level directory '%s'", level_directory);
+    Error(ERR_WARN, "ignoring level directory '%s'", directory_path);
 
     free(directory_path);
     free(filename);
@@ -1354,6 +1461,12 @@ static boolean LoadLevelInfoFromLevelConf(TreeInfo **node_first,
                 getTokenValue(setup_file_list, levelinfo_tokens[i].text));
   *leveldir_new = ldi;
 
+  if (strcmp(leveldir_new->name, ANONYMOUS_NAME) == 0)
+  {
+    free(leveldir_new->name);
+    leveldir_new->name = getStringCopy(leveldir_new->filename);
+  }
+
   DrawInitText(leveldir_new->name, 150, FC_YELLOW);
 
   if (leveldir_new->name_short == NULL)
@@ -1450,6 +1563,11 @@ static void LoadLevelInfoFromLevelDir(TreeInfo **node_first,
 
     free(directory_path);
 
+    if (strcmp(directory_name, GRAPHICS_DIRECTORY) == 0 ||
+       strcmp(directory_name, SOUNDS_DIRECTORY) == 0 ||
+       strcmp(directory_name, MUSIC_DIRECTORY) == 0)
+      continue;
+
     valid_entry_found |= LoadLevelInfoFromLevelConf(node_first, node_parent,
                                                    level_directory,
                                                    directory_name);
@@ -1478,7 +1596,8 @@ void LoadLevelInfo()
   LoadLevelInfoFromLevelDir(&leveldir_first, NULL, options.level_directory);
   LoadLevelInfoFromLevelDir(&leveldir_first, NULL, getUserLevelDir(NULL));
 
-  leveldir_current = getFirstValidLevelSeries(leveldir_first);
+  /* before sorting, the first entries will be from the user directory */
+  leveldir_current = getFirstValidTreeInfoEntry(leveldir_first);
 
   if (leveldir_first == NULL)
     Error(ERR_EXIT, "cannot find any valid level series in any directory");
@@ -1496,18 +1615,13 @@ static boolean LoadArtworkInfoFromArtworkConf(TreeInfo **node_first,
                                              char *directory_name, int type)
 {
   char *directory_path = getPath2(base_directory, directory_name);
-  char *filename =
-    getPath2(directory_path,
-            (type == TREE_TYPE_GRAPHICS_DIR ? GRAPHICSINFO_FILENAME :
-             type == TREE_TYPE_SOUNDS_DIR ? SOUNDSINFO_FILENAME :
-             type == TREE_TYPE_MUSIC_DIR ? MUSICINFO_FILENAME : ""));
+  char *filename = getPath2(directory_path, ARTWORKINFO_FILENAME(type));
   struct SetupFileList *setup_file_list = NULL;
   TreeInfo *artwork_new = NULL;
-  char *check_dir = NULL;
   int i;
 
-  if (access(getUserLevelDir(filename), F_OK) == 0)    /* file exists */
-    loadSetupFileList(filename);
+  if (access(filename, F_OK) == 0)             /* file exists */
+    setup_file_list = loadSetupFileList(filename);
 
   if (setup_file_list == NULL) /* no config file -- look for artwork files */
   {
@@ -1515,15 +1629,13 @@ static boolean LoadArtworkInfoFromArtworkConf(TreeInfo **node_first,
     struct dirent *dir_entry;
     boolean valid_file_found = FALSE;
 
-    if ((dir = opendir(base_directory)) != NULL)
+    if ((dir = opendir(directory_path)) != NULL)
     {
       while ((dir_entry = readdir(dir)) != NULL)
       {
        char *entry_name = dir_entry->d_name;
 
-       if ((type == TREE_TYPE_GRAPHICS_DIR && FileIsGraphic(entry_name)) ||
-           (type == TREE_TYPE_SOUNDS_DIR && FileIsSound(entry_name)) ||
-           (type == TREE_TYPE_MUSIC_DIR && FileIsMusic(entry_name)))
+       if (FileIsArtworkType(entry_name, type))
        {
          valid_file_found = TRUE;
          break;
@@ -1535,7 +1647,8 @@ static boolean LoadArtworkInfoFromArtworkConf(TreeInfo **node_first,
 
     if (!valid_file_found)
     {
-      Error(ERR_WARN, "ignoring artwork directory '%s'", base_directory);
+      if (strcmp(directory_name, ".") != 0)
+       Error(ERR_WARN, "ignoring artwork directory '%s'", directory_path);
 
       free(directory_path);
       free(filename);
@@ -1566,6 +1679,12 @@ static boolean LoadArtworkInfoFromArtworkConf(TreeInfo **node_first,
                   getTokenValue(setup_file_list, levelinfo_tokens[i].text));
     *artwork_new = ldi;
 
+    if (strcmp(artwork_new->name, ANONYMOUS_NAME) == 0)
+    {
+      free(artwork_new->name);
+      artwork_new->name = getStringCopy(artwork_new->filename);
+    }
+
     DrawInitText(artwork_new->name, 150, FC_YELLOW);
 
     if (artwork_new->name_short == NULL)
@@ -1577,20 +1696,17 @@ static boolean LoadArtworkInfoFromArtworkConf(TreeInfo **node_first,
 
   if (node_parent == NULL)             /* top level group */
   {
-    artwork_new->basepath = base_directory;
-    artwork_new->fullpath = artwork_new->filename;
+    artwork_new->basepath = getStringCopy(base_directory);
+    artwork_new->fullpath = getStringCopy(artwork_new->filename);
   }
   else                                 /* sub level group */
   {
-    artwork_new->basepath = node_parent->basepath;
+    artwork_new->basepath = getStringCopy(node_parent->basepath);
     artwork_new->fullpath = getPath2(node_parent->fullpath, directory_name);
   }
 
-  check_dir = (type == TREE_TYPE_GRAPHICS_DIR ? options.graphics_directory :
-              type == TREE_TYPE_SOUNDS_DIR ? options.sounds_directory :
-              type == TREE_TYPE_MUSIC_DIR ? options.music_directory : "");
   artwork_new->user_defined =
-    (artwork_new->basepath == check_dir ? FALSE : TRUE);
+    (artwork_new->basepath == OPTIONS_ARTWORK_DIRECTORY(type) ? FALSE : TRUE);
 
   /* (may use ".sort_priority" from "setup_file_list" above) */
   artwork_new->color = LEVELCOLOR(artwork_new);
@@ -1604,9 +1720,18 @@ static boolean LoadArtworkInfoFromArtworkConf(TreeInfo **node_first,
     if (strcmp(artwork_new->filename, ".") == 0)
     {
       if (artwork_new->user_defined)
+      {
        artwork_new->name = getStringCopy("private");
+       artwork_new->sort_priority = LEVELCLASS_USER;
+      }
       else
-       artwork_new->name = getStringCopy("default");
+      {
+       artwork_new->name = getStringCopy("classic");
+       artwork_new->sort_priority = LEVELCLASS_CLASSICS;
+      }
+
+      artwork_new->color = LEVELCOLOR(artwork_new);
+      artwork_new->class_desc = getLevelClassDescription(artwork_new);
     }
     else
       artwork_new->name = getStringCopy(artwork_new->filename);
@@ -1635,12 +1760,7 @@ static void LoadArtworkInfoFromArtworkDir(TreeInfo **node_first,
 
   if ((dir = opendir(base_directory)) == NULL)
   {
-    if ((type == TREE_TYPE_GRAPHICS_DIR &&
-        base_directory == options.graphics_directory) ||
-       (type == TREE_TYPE_SOUNDS_DIR &&
-        base_directory == options.sounds_directory) ||
-       (type == TREE_TYPE_MUSIC_DIR &&
-        base_directory == options.music_directory))
+    if (base_directory == OPTIONS_ARTWORK_DIRECTORY(type))
       Error(ERR_WARN, "cannot read directory '%s'", base_directory);
     return;
   }
@@ -1712,9 +1832,30 @@ void LoadArtworkInfo()
                                TREE_TYPE_MUSIC_DIR);
 
   /* before sorting, the first entries will be from the user directory */
-  artwork.gfx_current = artwork.gfx_first;
-  artwork.snd_current = artwork.snd_first;
-  artwork.mus_current = artwork.mus_first;
+  artwork.gfx_current =
+    getTreeInfoFromFilename(artwork.gfx_first, setup.graphics_set);
+  if (artwork.gfx_current == NULL)
+    artwork.gfx_current = getFirstValidTreeInfoEntry(artwork.gfx_first);
+
+  artwork.snd_current =
+    getTreeInfoFromFilename(artwork.snd_first, setup.sounds_set);
+  if (artwork.snd_current == NULL)
+  artwork.snd_current = getFirstValidTreeInfoEntry(artwork.snd_first);
+
+  artwork.mus_current =
+    getTreeInfoFromFilename(artwork.mus_first, setup.music_set);
+  if (artwork.mus_current == NULL)
+  artwork.mus_current = getFirstValidTreeInfoEntry(artwork.mus_first);
+
+  artwork.graphics_set_current = artwork.gfx_current->name;
+  artwork.sounds_set_current = artwork.snd_current->name;
+  artwork.music_set_current = artwork.mus_current->name;
+
+#if 0
+  printf("graphics set == %s\n\n", artwork.graphics_set_current);
+  printf("sounds set == %s\n\n", artwork.sounds_set_current);
+  printf("music set == %s\n\n", artwork.music_set_current);
+#endif
 
   sortTreeInfo(&artwork.gfx_first, compareTreeInfoEntries);
   sortTreeInfo(&artwork.snd_first, compareTreeInfoEntries);
@@ -1727,6 +1868,72 @@ void LoadArtworkInfo()
 #endif
 }
 
+void LoadArtworkInfoFromLevelInfo(ArtworkDirTree **artwork_node,
+                                 LevelDirTree *level_node)
+{
+  /* recursively check all level directories for artwork sub-directories */
+
+  while (level_node)
+  {
+    char *path = getPath2(getLevelDirFromTreeInfo(level_node),
+                         ARTWORK_DIRECTORY((*artwork_node)->type));
+
+#if 0
+    if (!level_node->parent_link)
+      printf("CHECKING '%s' ['%s', '%s'] ...\n", path,
+            level_node->filename, level_node->name);
+#endif
+
+    if (!level_node->parent_link)
+    {
+      TreeInfo *topnode_last = *artwork_node;
+
+      LoadArtworkInfoFromArtworkDir(artwork_node, NULL, path,
+                                   (*artwork_node)->type);
+
+      if (topnode_last != *artwork_node)
+      {
+       free((*artwork_node)->name);
+       free((*artwork_node)->name_sorting);
+       free((*artwork_node)->name_short);
+
+       (*artwork_node)->name         = getStringCopy(level_node->name);
+       (*artwork_node)->name_sorting = getStringCopy(level_node->name);
+       (*artwork_node)->name_short   = getStringCopy(level_node->filename);
+
+       (*artwork_node)->sort_priority = level_node->sort_priority;
+       (*artwork_node)->color = LEVELCOLOR((*artwork_node));
+      }
+    }
+
+    free(path);
+
+    if (level_node->node_group != NULL)
+      LoadArtworkInfoFromLevelInfo(artwork_node, level_node->node_group);
+
+    level_node = level_node->next;
+  }
+}
+
+void LoadLevelArtworkInfo()
+{
+  DrawInitText("Looking for custom level artwork:", 120, FC_GREEN);
+
+  LoadArtworkInfoFromLevelInfo(&artwork.gfx_first, leveldir_first);
+  LoadArtworkInfoFromLevelInfo(&artwork.snd_first, leveldir_first);
+  LoadArtworkInfoFromLevelInfo(&artwork.mus_first, leveldir_first);
+
+  sortTreeInfo(&artwork.gfx_first, compareTreeInfoEntries);
+  sortTreeInfo(&artwork.snd_first, compareTreeInfoEntries);
+  sortTreeInfo(&artwork.mus_first, compareTreeInfoEntries);
+
+#if 1
+  dumpTreeInfo(artwork.gfx_first, 0);
+  dumpTreeInfo(artwork.snd_first, 0);
+  dumpTreeInfo(artwork.mus_first, 0);
+#endif
+}
+
 static void SaveUserLevelInfo()
 {
   char *filename;
@@ -1812,19 +2019,18 @@ char *getSetupValue(int type, void *value)
 char *getSetupLine(struct TokenInfo *token_info, char *prefix, int token_nr)
 {
   int i;
-  static char entry[MAX_LINE_LEN];
+  char *line;
+  static char token_string[MAX_LINE_LEN];
   int token_type = token_info[token_nr].type;
   void *setup_value = token_info[token_nr].value;
   char *token_text = token_info[token_nr].text;
   char *value_string = getSetupValue(token_type, setup_value);
 
-  /* start with the prefix, token and some spaces to format output line */
-  sprintf(entry, "%s%s:", prefix, token_text);
-  for (i=strlen(entry); i<TOKEN_VALUE_POSITION; i++)
-    strcat(entry, " ");
+  /* build complete token string */
+  sprintf(token_string, "%s%s", prefix, token_text);
 
-  /* continue with the token's value (which can have different types) */
-  strcat(entry, value_string);
+  /* build setup entry line */
+  line = getFormattedSetupEntry(token_string, value_string);
 
   if (token_type == TYPE_KEY_X11)
   {
@@ -1835,15 +2041,17 @@ char *getSetupLine(struct TokenInfo *token_info, char *prefix, int token_nr)
     if (strcmp(keyname, "(undefined)") != 0 &&
        strcmp(keyname, "(unknown)") != 0)
     {
-      for (i=strlen(entry); i<50; i++)
-       strcat(entry, " ");
+      /* add at least one whitespace */
+      strcat(line, " ");
+      for (i=strlen(line); i<TOKEN_COMMENT_POSITION; i++)
+       strcat(line, " ");
 
-      strcat(entry, "# ");
-      strcat(entry, keyname);
+      strcat(line, "# ");
+      strcat(line, keyname);
     }
   }
 
-  return entry;
+  return line;
 }
 
 void LoadLevelSetup_LastSeries()
@@ -1852,7 +2060,7 @@ void LoadLevelSetup_LastSeries()
   struct SetupFileList *level_setup_list = NULL;
 
   /* always start with reliable default values */
-  leveldir_current = getFirstValidLevelSeries(leveldir_first);
+  leveldir_current = getFirstValidTreeInfoEntry(leveldir_first);
 
   /* ----------------------------------------------------------------------- */
   /* ~/.<program>/levelsetup.conf                                            */
@@ -1868,7 +2076,7 @@ void LoadLevelSetup_LastSeries()
     leveldir_current = getTreeInfoFromFilename(leveldir_first,
                                               last_level_series);
     if (leveldir_current == NULL)
-      leveldir_current = leveldir_first;
+      leveldir_current = getFirstValidTreeInfoEntry(leveldir_first);
 
     checkSetupFileListIdentifier(level_setup_list, getCookie("LEVELSETUP"));