rnd-20020421-1-src
[rocksndiamonds.git] / src / libgame / setup.c
index d9b62634ec488e870a60ef8b0e0af699da91e493..32c8f265dfdd84961a1762cfd72f8a7fa7f26962 100644 (file)
@@ -166,53 +166,94 @@ static char *getLevelSetupDir(char *level_subdir)
   return levelsetup_dir;
 }
 
-static char *getUserGraphicsDir(char *graphics_subdir)
+static char *getCurrentLevelDir()
 {
-  static char *usergraphics_dir = NULL;
-  char *data_dir = getUserDataDir();
-  char *usergraphics_subdir = GRAPHICS_DIRECTORY;
+  static char *level_dir = NULL;
 
-  if (usergraphics_dir)
-    free(usergraphics_dir);
+  if (level_dir)
+    free(level_dir);
 
-  if (graphics_subdir != NULL)
-    usergraphics_dir = getPath3(data_dir, usergraphics_subdir,graphics_subdir);
-  else
-    usergraphics_dir = getPath2(data_dir, usergraphics_subdir);
+  if (leveldir_current == NULL)
+    return options.level_directory;
+
+  level_dir = getPath2((leveldir_current->user_defined ?
+                       getUserLevelDir(NULL) : options.level_directory),
+                      leveldir_current->fullpath);
+
+  return level_dir;
+}
+
+static char *getDefaultGraphicsDir(char *graphics_subdir)
+{
+  static char *graphics_dir = NULL;
+
+  if (graphics_subdir == NULL)
+    return options.graphics_directory;
+
+  if (graphics_dir)
+    free(graphics_dir);
+
+  graphics_dir = getPath2(options.graphics_directory, graphics_subdir);
+
+  return graphics_dir;
+}
+
+static char *getDefaultSoundsDir(char *sounds_subdir)
+{
+  static char *sounds_dir = NULL;
+
+  if (sounds_subdir == NULL)
+    return options.sounds_directory;
+
+  if (sounds_dir)
+    free(sounds_dir);
+
+  sounds_dir = getPath2(options.sounds_directory, sounds_subdir);
+
+  return sounds_dir;
+}
+
+static char *getDefaultMusicDir(char *music_subdir)
+{
+  static char *music_dir = NULL;
+
+  if (music_subdir == NULL)
+    return options.music_directory;
+
+  if (music_dir)
+    free(music_dir);
+
+  music_dir = getPath2(options.music_directory, music_subdir);
+
+  return music_dir;
+}
+
+static char *getUserGraphicsDir()
+{
+  static char *usergraphics_dir = NULL;
+
+  if (usergraphics_dir == NULL)
+    usergraphics_dir = getPath2(getUserDataDir(), GRAPHICS_DIRECTORY);
 
   return usergraphics_dir;
 }
 
-static char *getUserSoundsDir(char *sounds_subdir)
+static char *getUserSoundsDir()
 {
   static char *usersounds_dir = NULL;
-  char *data_dir = getUserDataDir();
-  char *usersounds_subdir = SOUNDS_DIRECTORY;
-
-  if (usersounds_dir)
-    free(usersounds_dir);
 
-  if (sounds_subdir != NULL)
-    usersounds_dir = getPath3(data_dir, usersounds_subdir,sounds_subdir);
-  else
-    usersounds_dir = getPath2(data_dir, usersounds_subdir);
+  if (usersounds_dir == NULL)
+    usersounds_dir = getPath2(getUserDataDir(), SOUNDS_DIRECTORY);
 
   return usersounds_dir;
 }
 
-static char *getUserMusicDir(char *music_subdir)
+static char *getUserMusicDir()
 {
   static char *usermusic_dir = NULL;
-  char *data_dir = getUserDataDir();
-  char *usermusic_subdir = MUSIC_DIRECTORY;
-
-  if (usermusic_dir)
-    free(usermusic_dir);
 
-  if (music_subdir != NULL)
-    usermusic_dir = getPath3(data_dir, usermusic_subdir,music_subdir);
-  else
-    usermusic_dir = getPath2(data_dir, usermusic_subdir);
+  if (usermusic_dir == NULL)
+    usermusic_dir = getPath2(getUserDataDir(), MUSIC_DIRECTORY);
 
   return usermusic_dir;
 }
@@ -226,11 +267,7 @@ char *getLevelFilename(int nr)
     free(filename);
 
   sprintf(basename, "%03d.%s", nr, LEVELFILE_EXTENSION);
-  filename = getPath3((leveldir_current->user_defined ?
-                      getUserLevelDir(NULL) :
-                      options.level_directory),
-                     leveldir_current->fullpath,
-                     basename);
+  filename = getPath2(getCurrentLevelDir(), basename);
 
   return filename;
 }
@@ -275,7 +312,19 @@ char *getSetupFilename()
   return filename;
 }
 
-static char *getImageBasename(char *basename)
+static char *getSetupArtworkDir(TreeInfo *ti)
+{
+  static char *artwork_dir = NULL;
+
+  if (artwork_dir != NULL)
+    free(artwork_dir);
+
+  artwork_dir = getPath2(ti->basepath, ti->fullpath);
+
+  return artwork_dir;
+}
+
+static char *getCorrectedImageBasename(char *basename)
 {
   char *result = basename;
 
@@ -292,34 +341,85 @@ static char *getImageBasename(char *basename)
   return result;
 }
 
-char *getImageFilename(char *basename)
+static boolean fileExists(char *filename)
+{
+#if 0
+  printf("checking file '%s'\n", filename);
+#endif
+
+  return (access(filename, F_OK) == 0);
+}
+
+char *getCustomImageFilename(char *basename)
 {
   static char *filename = NULL;
 
   if (filename != NULL)
     free(filename);
 
-  filename = getPath2(options.graphics_directory, getImageBasename(basename));
+  basename = getCorrectedImageBasename(basename);
 
-  return filename;
+  /* 1st try: look for special artwork in current level series directory */
+  filename = getPath3(getCurrentLevelDir(), GRAPHICS_DIRECTORY, basename);
+  if (fileExists(filename))
+    return filename;
+
+  /* 2nd try: look for special artwork in private artwork directory */
+  filename = getPath2(getUserGraphicsDir(), basename);
+  if (fileExists(filename))
+    return filename;
+
+  /* 3rd try: look for special artwork in configured artwork directory */
+  filename = getPath2(getSetupArtworkDir(artwork.gfx_current), basename);
+  if (fileExists(filename))
+    return filename;
+
+  /* 4th try: look for default artwork in new default artwork directory */
+  filename = getPath2(getDefaultGraphicsDir(GRAPHICS_SUBDIR), basename);
+  if (fileExists(filename))
+    return filename;
+
+  /* 5th try: look for default artwork in old default artwork directory */
+  filename = getPath2(options.graphics_directory, basename);
+  if (fileExists(filename))
+    return filename;
+
+  return NULL;                                 /* cannot find image file */
 }
 
-char *getCustomImageFilename(char *basename)
+char *getCustomSoundFilename(char *basename)
 {
-#if 0
-  if (strcmp(basename, "RocksFont.pcx") == 0)
-  {
-    char *dir = options.graphics_directory;
+  static char *filename = NULL;
 
-    printf("checking directory '%s' ...\n", dir);
+  if (filename != NULL)
+    free(filename);
 
-    /*
-    dir = getPath2(options.graphics_directory);
-    */
-  }
-#endif
+  /* 1st try: look for special artwork in current level series directory */
+  filename = getPath3(getCurrentLevelDir(), SOUNDS_DIRECTORY, basename);
+  if (fileExists(filename))
+    return filename;
+
+  /* 2nd try: look for special artwork in private artwork directory */
+  filename = getPath2(getUserSoundsDir(), basename);
+  if (fileExists(filename))
+    return filename;
+
+  /* 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;
 
-  return getImageFilename(basename);
+  /* 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 */
 }
 
 void InitTapeDirectory(char *level_subdir)
@@ -434,23 +534,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;
@@ -543,9 +643,11 @@ void dumpTreeInfo(TreeInfo *node, int depth)
 {
   int i;
 
+  printf("Dumping TreeInfo:\n");
+
   while (node)
   {
-    for (i=0; i<depth * 3; i++)
+    for (i=0; i<(depth + 1) * 3; i++)
       printf(" ");
 
     printf("filename == '%s' [%s]\n", node->filename, node->name);
@@ -1074,12 +1176,9 @@ static struct TokenInfo levelinfo_tokens[] =
   { TYPE_BOOLEAN, &ldi.readonly,       "readonly"      }
 };
 
-static void setTreeInfoToDefaults(TreeInfo *ldi)
+static void setTreeInfoToDefaults(TreeInfo *ldi, int type)
 {
-  /* ldi->type is expected to be already set! */
-
-  if (ldi->type == 0)
-    Error(ERR_EXIT, "ldi->type == 0");
+  ldi->type = type;
 
   ldi->node_top = (ldi->type == TREE_TYPE_LEVEL_DIR ? &leveldir_first :
                   ldi->type == TREE_TYPE_GRAPHICS_DIR ? &artwork.gfx_first :
@@ -1124,7 +1223,9 @@ static void setTreeInfoToDefaultsFromParent(TreeInfo *ldi, TreeInfo *parent)
 {
   if (parent == NULL)
   {
-    setTreeInfoToDefaults(ldi);
+    Error(ERR_WARN, "setTreeInfoToDefaultsFromParent(): parent == NULL");
+
+    setTreeInfoToDefaults(ldi, TREE_TYPE_GENERIC);
     return;
   }
 
@@ -1230,9 +1331,7 @@ static void createParentTreeInfoNode(TreeInfo *node_parent)
     return;
 
   ti_new = newTreeInfo();
-  ti_new->type = node_parent->type;
-
-  setTreeInfoToDefaults(ti_new);
+  setTreeInfoToDefaults(ti_new, node_parent->type);
 
   ti_new->node_parent = node_parent;
   ti_new->parent_link = TRUE;
@@ -1275,10 +1374,13 @@ static boolean LoadLevelInfoFromLevelConf(TreeInfo **node_first,
   }
 
   leveldir_new = newTreeInfo();
-  leveldir_new->type = TREE_TYPE_LEVEL_DIR;
+
+  if (node_parent)
+    setTreeInfoToDefaultsFromParent(leveldir_new, node_parent);
+  else
+    setTreeInfoToDefaults(leveldir_new, TREE_TYPE_LEVEL_DIR);
 
   checkSetupFileListIdentifier(setup_file_list, getCookie("LEVELINFO"));
-  setTreeInfoToDefaultsFromParent(leveldir_new, node_parent);
 
   /* set all structure fields according to the token/value pairs */
   ldi = *leveldir_new;
@@ -1411,7 +1513,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");
@@ -1439,7 +1542,7 @@ static boolean LoadArtworkInfoFromArtworkConf(TreeInfo **node_first,
   char *check_dir = NULL;
   int i;
 
-  if (access(getUserLevelDir(filename), F_OK) == 0)    /* file exists */
+  if (access(filename, F_OK) == 0)             /* file exists */
     loadSetupFileList(filename);
 
   if (setup_file_list == NULL) /* no config file -- look for artwork files */
@@ -1448,7 +1551,7 @@ 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)
       {
@@ -1468,7 +1571,8 @@ static boolean LoadArtworkInfoFromArtworkConf(TreeInfo **node_first,
 
     if (!valid_file_found)
     {
-      Error(ERR_WARN, "ignoring artwork directory '%s'", base_directory);
+      if (options.debug)
+       Error(ERR_WARN, "ignoring artwork directory '%s'", base_directory);
 
       free(directory_path);
       free(filename);
@@ -1478,13 +1582,15 @@ static boolean LoadArtworkInfoFromArtworkConf(TreeInfo **node_first,
   }
 
   artwork_new = newTreeInfo();
-  artwork_new->type = type;
 
-  setTreeInfoToDefaultsFromParent(artwork_new, node_parent);
+  if (node_parent)
+    setTreeInfoToDefaultsFromParent(artwork_new, node_parent);
+  else
+    setTreeInfoToDefaults(artwork_new, type);
 
   artwork_new->filename = getStringCopy(directory_name);
 
-  if (setup_file_list)
+  if (setup_file_list) /* (before defining ".color" and ".class_desc") */
   {
 #if 0
     checkSetupFileListIdentifier(setup_file_list, getCookie("..."));
@@ -1505,19 +1611,6 @@ static boolean LoadArtworkInfoFromArtworkConf(TreeInfo **node_first,
     if (artwork_new->name_sorting == NULL)
       artwork_new->name_sorting = getStringCopy(artwork_new->name);
   }
-  else
-  {
-    if (artwork_new->name != NULL)
-      free(artwork_new->name);
-
-    if (strcmp(artwork_new->filename, ".") == 0)
-      artwork_new->name = getStringCopy("default");
-    else
-      artwork_new->name = getStringCopy(artwork_new->filename);
-
-    artwork_new->name_short = getStringCopy(artwork_new->name);
-    artwork_new->name_sorting = getStringCopy(artwork_new->name);
-  }
 
   if (node_parent == NULL)             /* top level group */
   {
@@ -1536,10 +1629,28 @@ static boolean LoadArtworkInfoFromArtworkConf(TreeInfo **node_first,
   artwork_new->user_defined =
     (artwork_new->basepath == check_dir ? FALSE : TRUE);
 
-#if 0
+  /* (may use ".sort_priority" from "setup_file_list" above) */
   artwork_new->color = LEVELCOLOR(artwork_new);
   artwork_new->class_desc = getLevelClassDescription(artwork_new);
-#endif
+
+  if (setup_file_list == NULL) /* (after determining ".user_defined") */
+  {
+    if (artwork_new->name != NULL)
+      free(artwork_new->name);
+
+    if (strcmp(artwork_new->filename, ".") == 0)
+    {
+      if (artwork_new->user_defined)
+       artwork_new->name = getStringCopy("private");
+      else
+       artwork_new->name = getStringCopy("default");
+    }
+    else
+      artwork_new->name = getStringCopy(artwork_new->filename);
+
+    artwork_new->name_short = getStringCopy(artwork_new->name);
+    artwork_new->name_sorting = getStringCopy(artwork_new->name);
+  }
 
   pushTreeInfo(node_first, artwork_new);
 
@@ -1620,26 +1731,42 @@ void LoadArtworkInfo()
                                options.graphics_directory,
                                TREE_TYPE_GRAPHICS_DIR);
   LoadArtworkInfoFromArtworkDir(&artwork.gfx_first, NULL,
-                               getUserGraphicsDir(NULL),
+                               getUserGraphicsDir(),
                                TREE_TYPE_GRAPHICS_DIR);
 
   LoadArtworkInfoFromArtworkDir(&artwork.snd_first, NULL,
                                options.sounds_directory,
                                TREE_TYPE_SOUNDS_DIR);
   LoadArtworkInfoFromArtworkDir(&artwork.snd_first, NULL,
-                               getUserSoundsDir(NULL),
+                               getUserSoundsDir(),
                                TREE_TYPE_SOUNDS_DIR);
 
   LoadArtworkInfoFromArtworkDir(&artwork.mus_first, NULL,
                                options.music_directory,
                                TREE_TYPE_MUSIC_DIR);
   LoadArtworkInfoFromArtworkDir(&artwork.mus_first, NULL,
-                               getUserMusicDir(NULL),
+                               getUserMusicDir(),
                                TREE_TYPE_MUSIC_DIR);
 
-  artwork.gfx_current = artwork.gfx_first;
-  artwork.snd_current = artwork.snd_first;
-  artwork.mus_current = artwork.mus_first;
+  /* before sorting, the first entries will be from the user directory */
+  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;
 
   sortTreeInfo(&artwork.gfx_first, compareTreeInfoEntries);
   sortTreeInfo(&artwork.snd_first, compareTreeInfoEntries);
@@ -1668,7 +1795,7 @@ static void SaveUserLevelInfo()
   }
 
   /* always start with reliable default values */
-  setTreeInfoToDefaults(&ldi);
+  setTreeInfoToDefaults(&ldi, TREE_TYPE_LEVEL_DIR);
 
   ldi.name = getLoginName();
   ldi.author = getRealName();
@@ -1777,7 +1904,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                                            */
@@ -1793,7 +1920,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"));