rnd-20030120-3-src
[rocksndiamonds.git] / src / libgame / misc.c
index abea627781cfebb3d2a20b09351055ccc69177e4..31138a682a1f68677556bac20fdedf814af3a79d 100644 (file)
@@ -1499,6 +1499,9 @@ boolean FileIsArtworkType(char *basename, int type)
 /* functions for loading artwork configuration information                   */
 /* ------------------------------------------------------------------------- */
 
+static void FreeCustomArtworkList(struct ArtworkListInfo *,
+                                 struct ListNodeInfo ***, int *);
+
 static int get_parameter_value(int type, char *value)
 {
   return (strcmp(value, ARG_UNDEFINED) == 0 ? ARG_UNDEFINED_VALUE :
@@ -1595,6 +1598,7 @@ struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list,
   num_file_list_entries_found = list_pos + 1;
   if (num_file_list_entries_found != num_file_list_entries)
   {
+    Error(ERR_RETURN_LINE, "-");
     Error(ERR_RETURN, "inconsistant config list information:");
     Error(ERR_RETURN, "- should be:   %d (according to 'src/conf_gfx.h')",
          num_file_list_entries);
@@ -1606,16 +1610,123 @@ struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list,
   return file_list;
 }
 
+static boolean token_suffix_match(char *token, char *suffix, int start_pos)
+{
+  int len_token = strlen(token);
+  int len_suffix = strlen(suffix);
+
+#if 0
+  if (IS_PARENT_PROCESS(audio.mixer_pid))
+    printf(":::::::::: check '%s' for '%s' ::::::::::\n", token, suffix);
+#endif
+
+  if (start_pos < 0)   /* compare suffix from end of string */
+    start_pos += len_token;
+
+  if (start_pos < 0 || start_pos + len_suffix > len_token)
+    return FALSE;
+
+  if (strncmp(&token[start_pos], suffix, len_suffix) != 0)
+    return FALSE;
+
+  if (token[start_pos + len_suffix] == '\0')
+    return TRUE;
+
+  if (token[start_pos + len_suffix] == '.')
+    return TRUE;
+
+  return FALSE;
+}
+
+#define KNOWN_TOKEN_VALUE      "[KNOWN_TOKEN]"
+
+static void read_token_parameters(struct SetupFileList *setup_file_list,
+                                 struct ConfigInfo *suffix_list,
+                                 struct FileInfo *file_list_entry)
+{
+  /* check for config token that is the base token without any suffixes */
+  char *filename = getTokenValue(setup_file_list, file_list_entry->token);
+  char *known_token_value = KNOWN_TOKEN_VALUE;
+  int i;
+
+  if (filename != NULL)
+  {
+    /* when file definition found, set all parameters to default values */
+    for (i=0; suffix_list[i].token != NULL; i++)
+      file_list_entry->parameter[i] =
+       get_parameter_value(suffix_list[i].type, suffix_list[i].value);
+
+    file_list_entry->filename = getStringCopy(filename);
+
+    /* mark config file token as well known from default config */
+    setTokenValue(setup_file_list, file_list_entry->token, known_token_value);
+  }
+  else
+    file_list_entry->filename =
+      getStringCopy(file_list_entry->default_filename);
+
+  /* check for config tokens that can be build by base token and suffixes */
+  for (i=0; suffix_list[i].token != NULL; i++)
+  {
+    char *token = getStringCat2(file_list_entry->token, suffix_list[i].token);
+    char *value = getTokenValue(setup_file_list, token);
+
+    if (value != NULL)
+    {
+      file_list_entry->parameter[i] =
+       get_parameter_value(suffix_list[i].type, value);
+
+      /* mark config file token as well known from default config */
+      setTokenValue(setup_file_list, token, known_token_value);
+    }
+
+    free(token);
+  }
+}
+
+static void add_dynamic_file_list_entry(struct FileInfo **list,
+                                       int *num_list_entries,
+                                       struct SetupFileList *extra_file_list,
+                                       struct ConfigInfo *suffix_list,
+                                       int num_suffix_list_entries,
+                                       char *token)
+{
+  struct FileInfo *new_list_entry;
+  int parameter_array_size = num_suffix_list_entries * sizeof(int);
+
+#if 0
+  if (IS_PARENT_PROCESS(audio.mixer_pid))
+    printf("===> found dynamic definition '%s'\n", token);
+#endif
+
+  (*num_list_entries)++;
+  *list = checked_realloc(*list, *num_list_entries * sizeof(struct FileInfo));
+  new_list_entry = &(*list)[*num_list_entries - 1];
+
+  new_list_entry->token = getStringCopy(token);
+  new_list_entry->parameter = checked_calloc(parameter_array_size);
+
+  read_token_parameters(extra_file_list, suffix_list, new_list_entry);
+}
+
 void LoadArtworkConfig(struct ArtworkListInfo *artwork_info)
 {
   struct FileInfo *file_list = artwork_info->file_list;
   struct ConfigInfo *suffix_list = artwork_info->suffix_list;
+  char **base_prefixes = artwork_info->base_prefixes;
+  char **ext1_suffixes = artwork_info->ext1_suffixes;
+  char **ext2_suffixes = artwork_info->ext2_suffixes;
   int num_file_list_entries = artwork_info->num_file_list_entries;
   int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
+  int num_base_prefixes = artwork_info->num_base_prefixes;
+  int num_ext1_suffixes = artwork_info->num_ext1_suffixes;
+  int num_ext2_suffixes = artwork_info->num_ext2_suffixes;
   char *filename = getCustomArtworkConfigFilename(artwork_info->type);
   struct SetupFileList *setup_file_list;
-  char *known_token_value = "[KNOWN_TOKEN]";
-  int i, j;
+  struct SetupFileList *extra_file_list = NULL;
+  struct SetupFileList *list;
+  char *known_token_value = KNOWN_TOKEN_VALUE;
+  int i, j, k;
 
 #if 0
   printf("GOT CUSTOM ARTWORK CONFIG FILE '%s'\n", filename);
@@ -1632,83 +1743,227 @@ void LoadArtworkConfig(struct ArtworkListInfo *artwork_info)
       file_list[i].parameter[j] = file_list[i].default_parameter[j];
   }
 
+  /* free previous dynamic artwork file array */
+  if (artwork_info->dynamic_file_list != NULL)
+  {
+    for (i=0; i<artwork_info->num_dynamic_file_list_entries; i++)
+    {
+      free(artwork_info->dynamic_file_list[i].token);
+      free(artwork_info->dynamic_file_list[i].filename);
+      free(artwork_info->dynamic_file_list[i].parameter);
+    }
+
+    free(artwork_info->dynamic_file_list);
+
+    artwork_info->dynamic_file_list = NULL;
+    artwork_info->num_dynamic_file_list_entries = 0;
+
+    FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
+                         &artwork_info->num_dynamic_file_list_entries);
+  }
+
   if (filename == NULL)
     return;
 
   if ((setup_file_list = loadSetupFileList(filename)) == NULL)
     return;
 
+  /* read parameters for all known config file tokens */
   for (i=0; i<num_file_list_entries; i++)
+    read_token_parameters(setup_file_list, suffix_list, &file_list[i]);
+
+  /* set some additional tokens to "known" */
+  setTokenValue(setup_file_list, "name", known_token_value);
+  setTokenValue(setup_file_list, "sort_priority", known_token_value);
+
+  /* copy all unknown config file tokens to extra config list */
+  for (list = setup_file_list; list != NULL; list = list->next)
   {
-    /* check for config token that is the base token without any suffixes */
-    char *filename = getTokenValue(setup_file_list, file_list[i].token);
+    if (strcmp(list->value, known_token_value) != 0)
+    {
+      if (extra_file_list == NULL)
+       extra_file_list = newSetupFileList(list->token, list->value);
+      else
+       setTokenValue(extra_file_list, list->token, list->value);
+    }
+  }
+
+  /* at this point, we do not need the config file list anymore -- free it */
+  freeSetupFileList(setup_file_list);
+
+  /* now try to determine valid, dynamically defined config tokens */
 
-    if (filename != NULL)
+  for (list = extra_file_list; list != NULL; list = list->next)
+  {
+    struct FileInfo **dynamic_file_list = &artwork_info->dynamic_file_list;
+    int *num_dynamic_file_list_entries =
+      &artwork_info->num_dynamic_file_list_entries;
+    char *token = list->token;
+    int len_token = strlen(token);
+    int start_pos;
+    boolean base_prefix_found = FALSE;
+    boolean parameter_suffix_found = FALSE;
+
+    /* skip all parameter definitions (handled by read_token_parameters()) */
+    for (i=0; i < num_suffix_list_entries && !parameter_suffix_found; i++)
     {
-      for (j=0; j<num_suffix_list_entries; j++)
-       file_list[i].parameter[j] =
-         get_parameter_value(suffix_list[j].type, suffix_list[j].value);
+      int len_suffix = strlen(suffix_list[i].token);
 
-      file_list[i].filename = getStringCopy(filename);
+      if (token_suffix_match(token, suffix_list[i].token, -len_suffix))
+       parameter_suffix_found = TRUE;
+    }
 
-      /* mark token as well known from default config */
-      setTokenValue(setup_file_list, file_list[i].token, known_token_value);
+#if 0
+    if (IS_PARENT_PROCESS(audio.mixer_pid))
+    {
+      if (parameter_suffix_found)
+       printf("---> skipping token '%s' (parameter token)\n", token);
+      else
+       printf("---> examining token '%s': search prefix ...\n", token);
     }
-    else
-      file_list[i].filename = getStringCopy(file_list[i].default_filename);
+#endif
 
-    /* check for config tokens that can be build by base token and suffixes */
-    for (j=0; j<num_suffix_list_entries; j++)
+    if (parameter_suffix_found)
+      continue;
+
+    /* ---------- step 1: search for matching base prefix ---------- */
+
+    start_pos = 0;
+    for (i=0; i<num_base_prefixes && !base_prefix_found; i++)
     {
-      char *token = getStringCat2(file_list[i].token, suffix_list[j].token);
-      char *value = getTokenValue(setup_file_list, token);
+      char *base_prefix = base_prefixes[i];
+      int len_base_prefix = strlen(base_prefix);
+      boolean ext1_suffix_found = FALSE;
 
-      if (value != NULL)
-      {
-       file_list[i].parameter[j] =
-         get_parameter_value(suffix_list[j].type, value);
+      base_prefix_found = token_suffix_match(token, base_prefix, start_pos);
+
+      if (!base_prefix_found)
+       continue;
 
-       /* mark token as well known from default config */
-       setTokenValue(setup_file_list, token, known_token_value);
+      if (start_pos + len_base_prefix == len_token)    /* exact match */
+      {
+       add_dynamic_file_list_entry(dynamic_file_list,
+                                   num_dynamic_file_list_entries,
+                                   extra_file_list,
+                                   suffix_list,
+                                   num_suffix_list_entries,
+                                   token);
+       continue;
       }
 
-      free(token);
+#if 0
+      if (IS_PARENT_PROCESS(audio.mixer_pid))
+       printf("---> examining token '%s': search 1st suffix ...\n", token);
+#endif
+
+      /* ---------- step 2: search for matching first suffix ---------- */
+
+      start_pos += len_base_prefix;
+      for (j=0; j<num_ext1_suffixes && !ext1_suffix_found; j++)
+      {
+       char *ext1_suffix = ext1_suffixes[j];
+       int len_ext1_suffix = strlen(ext1_suffix);
+       boolean ext2_suffix_found = FALSE;
+
+       ext1_suffix_found = token_suffix_match(token, ext1_suffix, start_pos);
+
+       if (!ext1_suffix_found)
+         continue;
+
+       if (start_pos + len_ext1_suffix == len_token)   /* exact match */
+       {
+         add_dynamic_file_list_entry(dynamic_file_list,
+                                     num_dynamic_file_list_entries,
+                                     extra_file_list,
+                                     suffix_list,
+                                     num_suffix_list_entries,
+                                     token);
+         continue;
+       }
+
+#if 0
+       if (IS_PARENT_PROCESS(audio.mixer_pid))
+         printf("---> examining token '%s': search 2nd suffix ...\n", token);
+#endif
+
+       /* ---------- step 3: search for matching second suffix ---------- */
+
+       start_pos += len_ext1_suffix;
+       for (k=0; k<num_ext2_suffixes && !ext2_suffix_found; k++)
+       {
+         char *ext2_suffix = ext2_suffixes[k];
+         int len_ext2_suffix = strlen(ext2_suffix);
+
+         ext2_suffix_found = token_suffix_match(token, ext2_suffix,start_pos);
+
+         if (!ext2_suffix_found)
+           continue;
+
+         if (start_pos + len_ext2_suffix == len_token) /* exact match */
+         {
+           add_dynamic_file_list_entry(dynamic_file_list,
+                                       num_dynamic_file_list_entries,
+                                       extra_file_list,
+                                       suffix_list,
+                                       num_suffix_list_entries,
+                                       token);
+           continue;
+         }
+       }
+      }
     }
   }
 
-  /* set some additional tokens to "known" */
-  setTokenValue(setup_file_list, "name", known_token_value);
-  setTokenValue(setup_file_list, "sort_priority", known_token_value);
+  if (artwork_info->num_dynamic_file_list_entries > 0)
+  {
+    artwork_info->dynamic_artwork_list =
+      checked_calloc(artwork_info->num_dynamic_file_list_entries *
+                    artwork_info->sizeof_artwork_list_entry);
+  }
 
-  if (options.verbose && !IS_CHILD_PROCESS(audio.mixer_pid))
+  if (extra_file_list != NULL &&
+      options.verbose && IS_PARENT_PROCESS(audio.mixer_pid))
   {
+    boolean dynamic_tokens_found = FALSE;
     boolean unknown_tokens_found = FALSE;
 
-    /* check each token in config file if it is defined in default config */
-    while (setup_file_list != NULL)
+    for (list = extra_file_list; list != NULL; list = list->next)
     {
-      if (strcmp(setup_file_list->value, known_token_value) != 0)
-      {
-       if (!unknown_tokens_found)
-       {
-         Error(ERR_RETURN_LINE, "-");
-         Error(ERR_RETURN, "warning: unknown token(s) found in config file:");
-         Error(ERR_RETURN, "- config file: '%s'", filename);
+      if (strcmp(list->value, known_token_value) == 0)
+       dynamic_tokens_found = TRUE;
+      else
+       unknown_tokens_found = TRUE;
+    }
 
-         unknown_tokens_found = TRUE;
-       }
+#if DEBUG
+    if (dynamic_tokens_found)
+    {
+      Error(ERR_RETURN_LINE, "-");
+      Error(ERR_RETURN, "dynamic token(s) found:");
 
-       Error(ERR_RETURN, "- unknown token: '%s'", setup_file_list->token);
-      }
+      for (list = extra_file_list; list != NULL; list = list->next)
+       if (strcmp(list->value, known_token_value) == 0)
+         Error(ERR_RETURN, "- dynamic token: '%s'", list->token);
 
-      setup_file_list = setup_file_list->next;
+      Error(ERR_RETURN_LINE, "-");
     }
+#endif
 
     if (unknown_tokens_found)
+    {
       Error(ERR_RETURN_LINE, "-");
+      Error(ERR_RETURN, "warning: unknown token(s) found in config file:");
+      Error(ERR_RETURN, "- config file: '%s'", filename);
+
+      for (list = extra_file_list; list != NULL; list = list->next)
+       if (strcmp(list->value, known_token_value) != 0)
+         Error(ERR_RETURN, "- unknown token: '%s'", list->token);
+
+      Error(ERR_RETURN_LINE, "-");
+    }
   }
 
-  freeSetupFileList(setup_file_list);
+  freeSetupFileList(extra_file_list);
 
 #if 0
   for (i=0; i<num_file_list_entries; i++)
@@ -1833,10 +2088,6 @@ static void LoadCustomArtwork(struct ArtworkListInfo *artwork_info,
                              struct ListNodeInfo **listnode,
                              char *basename)
 {
-#if 0
-  char *filename = getCustomArtworkFilename(basename, artwork_info->type);
-#endif
-
 #if 0
   printf("GOT CUSTOM ARTWORK FILE '%s'\n", filename);
 #endif
@@ -1847,33 +2098,30 @@ static void LoadCustomArtwork(struct ArtworkListInfo *artwork_info,
     return;
   }
 
-#if 0
-  if (filename == NULL)
-  {
-    Error(ERR_WARN, "cannot find artwork file '%s'", basename);
-    return;
-  }
-
-  replaceArtworkListEntry(artwork_info, listnode, filename);
-#else
   replaceArtworkListEntry(artwork_info, listnode, basename);
-#endif
 }
 
 static void LoadArtworkToList(struct ArtworkListInfo *artwork_info,
+                             struct ListNodeInfo **listnode,
                              char *basename, int list_pos)
 {
+#if 0
   if (artwork_info->artwork_list == NULL ||
       list_pos >= artwork_info->num_file_list_entries)
     return;
+#endif
 
 #if 0
   printf("loading artwork '%s' ...  [%d]\n",
         basename, getNumNodes(artwork_info->content_list));
 #endif
 
+#if 1
+  LoadCustomArtwork(artwork_info, listnode, basename);
+#else
   LoadCustomArtwork(artwork_info, &artwork_info->artwork_list[list_pos],
                    basename);
+#endif
 
 #if 0
   printf("loading artwork '%s' done [%d]\n",
@@ -1883,70 +2131,53 @@ static void LoadArtworkToList(struct ArtworkListInfo *artwork_info,
 
 void ReloadCustomArtworkList(struct ArtworkListInfo *artwork_info)
 {
-#if 0
-  static struct
-  {
-    char *text;
-    boolean do_it;
-  }
-  draw_init[] =
-  {
-    { "",                      FALSE },
-    { "Loading graphics:",     TRUE },
-    { "Loading sounds:",       TRUE },
-    { "Loading music:",                TRUE }
-  };
-#endif
-
-  int num_file_list_entries = artwork_info->num_file_list_entries;
   struct FileInfo *file_list = artwork_info->file_list;
+  struct FileInfo *dynamic_file_list = artwork_info->dynamic_file_list;
+  int num_file_list_entries = artwork_info->num_file_list_entries;
+  int num_dynamic_file_list_entries =
+    artwork_info->num_dynamic_file_list_entries;
   int i;
 
 #if 0
-  LoadArtworkConfig(artwork_info);
-#endif
-
-#if 0
-  if (draw_init[artwork_info->type].do_it)
-    DrawInitText(draw_init[artwork_info->type].text, 120, FC_GREEN);
-#endif
-
-#if 0
-  printf("DEBUG: reloading %d artwork files ...\n", num_file_list_entries);
+  printf("DEBUG: reloading %d static artwork files ...\n",
+        num_file_list_entries);
+  printf("DEBUG: reloading %d dynamic artwork files ...\n",
+        num_dynamic_file_list_entries);
 #endif
 
   for(i=0; i<num_file_list_entries; i++)
-  {
-#if 0
-    if (draw_init[artwork_info->type].do_it)
-      DrawInitText(file_list[i].token, 150, FC_YELLOW);
-#endif
+    LoadArtworkToList(artwork_info, &artwork_info->artwork_list[i],
+                     file_list[i].filename, i);
 
-    LoadArtworkToList(artwork_info, file_list[i].filename, i);
-
-#if 0
-    printf("DEBUG:   loading artwork file '%s'...\n", file_list[i].filename);
-#endif
-  }
-
-#if 0
-  draw_init[artwork_info->type].do_it = FALSE;
-#endif
-
-  /*
-  printf("list size == %d\n", getNumNodes(artwork_info->content_list));
-  */
+  for(i=0; i<num_dynamic_file_list_entries; i++)
+    LoadArtworkToList(artwork_info, &artwork_info->dynamic_artwork_list[i],
+                     dynamic_file_list[i].filename, i);
 
 #if 0
   dumpList(artwork_info->content_list);
 #endif
 }
 
-void FreeCustomArtworkList(struct ArtworkListInfo *artwork_info)
+static void FreeCustomArtworkList(struct ArtworkListInfo *artwork_info,
+                                 struct ListNodeInfo ***list,
+                                 int *num_list_entries)
 {
   int i;
 
-  if (artwork_info == NULL || artwork_info->artwork_list == NULL)
+  if (*list == NULL)
+    return;
+
+  for(i=0; i<*num_list_entries; i++)
+    deleteArtworkListEntry(artwork_info, &(*list)[i]);
+  free(*list);
+
+  *list = NULL;
+  *num_list_entries = 0;
+}
+
+void FreeCustomArtworkLists(struct ArtworkListInfo *artwork_info)
+{
+  if (artwork_info == NULL)
     return;
 
 #if 0
@@ -1954,18 +2185,16 @@ void FreeCustomArtworkList(struct ArtworkListInfo *artwork_info)
         IS_CHILD_PROCESS(audio.mixer_pid) ? "CHILD" : "PARENT");
 #endif
 
-  for(i=0; i<artwork_info->num_file_list_entries; i++)
-    deleteArtworkListEntry(artwork_info, &artwork_info->artwork_list[i]);
+  FreeCustomArtworkList(artwork_info, &artwork_info->artwork_list,
+                       &artwork_info->num_file_list_entries);
+
+  FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
+                       &artwork_info->num_dynamic_file_list_entries);
 
 #if 0
   printf("%s: FREEING ARTWORK -- DONE\n",
         IS_CHILD_PROCESS(audio.mixer_pid) ? "CHILD" : "PARENT");
 #endif
-
-  free(artwork_info->artwork_list);
-
-  artwork_info->artwork_list = NULL;
-  artwork_info->num_file_list_entries = 0;
 }