rnd-20030118-1-src
[rocksndiamonds.git] / src / libgame / misc.c
index 811ef07e576484826ea0ebdc07889848cac8cbee..d0bc9fa9401067173c21224ceedbb687af35015d 100644 (file)
@@ -436,6 +436,35 @@ char *getStringToLower(char *s)
   return s_copy;
 }
 
+static void printUsage()
+{
+  printf("\n"
+        "Usage: %s [OPTION]... [HOSTNAME [PORT]]\n"
+        "\n"
+        "Options:\n"
+        "  -d, --display HOSTNAME[:SCREEN]  specify X server display\n"
+        "  -b, --basepath DIRECTORY         alternative base DIRECTORY\n"
+        "  -l, --level DIRECTORY            alternative level DIRECTORY\n"
+        "  -g, --graphics DIRECTORY         alternative graphics DIRECTORY\n"
+        "  -s, --sounds DIRECTORY           alternative sounds DIRECTORY\n"
+        "  -m, --music DIRECTORY            alternative music DIRECTORY\n"
+        "  -n, --network                    network multiplayer game\n"
+        "      --serveronly                 only start network server\n"
+        "  -v, --verbose                    verbose mode\n"
+        "      --debug                      display debugging information\n"
+        "  -e, --execute COMMAND            execute batch COMMAND:\n"
+        "\n"
+        "Valid commands for '--execute' option:\n"
+        "  \"print graphicsinfo.conf\"        print default graphics config\n"
+        "  \"print soundsinfo.conf\"          print default sounds config\n"
+        "  \"print musicinfo.conf\"           print default music config\n"
+        "  \"dump level FILE\"                dump level data from FILE\n"
+        "  \"dump tape FILE\"                 dump tape data from FILE\n"
+        "  \"autoplay LEVELDIR\"              play level tapes for LEVELDIR\n"
+        "\n",
+        program.command_basename);
+}
+
 void GetOptions(char *argv[])
 {
   char **options_left = &argv[1];
@@ -450,11 +479,11 @@ void GetOptions(char *argv[])
   options.graphics_directory = RO_BASE_PATH "/" GRAPHICS_DIRECTORY;
   options.sounds_directory = RO_BASE_PATH "/" SOUNDS_DIRECTORY;
   options.music_directory = RO_BASE_PATH "/" MUSIC_DIRECTORY;
+  options.execute_command = NULL;
   options.serveronly = FALSE;
   options.network = FALSE;
   options.verbose = FALSE;
   options.debug = FALSE;
-  options.debug_command = NULL;
 
   while (*options_left)
   {
@@ -492,22 +521,7 @@ void GetOptions(char *argv[])
       Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
     else if (strncmp(option, "-help", option_len) == 0)
     {
-      printf("Usage: %s [options] [<server host> [<server port>]]\n"
-            "Options:\n"
-            "  -d, --display <host>[:<scr>]  X server display\n"
-            "  -b, --basepath <directory>    alternative base directory\n"
-            "  -l, --level <directory>       alternative level directory\n"
-            "  -g, --graphics <directory>    alternative graphics directory\n"
-            "  -s, --sounds <directory>      alternative sounds directory\n"
-            "  -m, --music <directory>       alternative music directory\n"
-            "  -n, --network                 network multiplayer game\n"
-            "      --serveronly              only start network server\n"
-            "  -v, --verbose                 verbose mode\n"
-            "      --debug                   display debugging information\n",
-            program.command_basename);
-
-      if (options.debug)
-       printf("      --debug-command <command> execute special command\n");
+      printUsage();
 
       exit(0);
     }
@@ -587,12 +601,12 @@ void GetOptions(char *argv[])
     {
       options.debug = TRUE;
     }
-    else if (strncmp(option, "-debug-command", option_len) == 0)
+    else if (strncmp(option, "-execute", option_len) == 0)
     {
       if (option_arg == NULL)
        Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
 
-      options.debug_command = option_arg;
+      options.execute_command = option_arg;
       if (option_arg == next_option)
        options_left++;
     }
@@ -1221,6 +1235,63 @@ char getCharFromKey(Key key)
 }
 
 
+/* ------------------------------------------------------------------------- */
+/* functions to translate string identifiers to integer or boolean value     */
+/* ------------------------------------------------------------------------- */
+
+int get_integer_from_string(char *s)
+{
+  static char *number_text[][3] =
+  {
+    { "0", "zero", "null", },
+    { "1", "one", "first" },
+    { "2", "two", "second" },
+    { "3", "three", "third" },
+    { "4", "four", "fourth" },
+    { "5", "five", "fifth" },
+    { "6", "six", "sixth" },
+    { "7", "seven", "seventh" },
+    { "8", "eight", "eighth" },
+    { "9", "nine", "ninth" },
+    { "10", "ten", "tenth" },
+    { "11", "eleven", "eleventh" },
+    { "12", "twelve", "twelfth" },
+  };
+
+  int i, j;
+  char *s_lower = getStringToLower(s);
+  int result = -1;
+
+  for (i=0; i<13; i++)
+    for (j=0; j<3; j++)
+      if (strcmp(s_lower, number_text[i][j]) == 0)
+       result = i;
+
+  if (result == -1)
+    result = atoi(s);
+
+  free(s_lower);
+
+  return result;
+}
+
+boolean get_boolean_from_string(char *s)
+{
+  char *s_lower = getStringToLower(s);
+  boolean result = FALSE;
+
+  if (strcmp(s_lower, "true") == 0 ||
+      strcmp(s_lower, "yes") == 0 ||
+      strcmp(s_lower, "on") == 0 ||
+      get_integer_from_string(s) == 1)
+    result = TRUE;
+
+  free(s_lower);
+
+  return result;
+}
+
+
 /* ========================================================================= */
 /* functions for generic lists                                               */
 /* ========================================================================= */
@@ -1356,11 +1427,19 @@ boolean FileIsArtworkType(char *basename, int type)
 /* functions for loading artwork configuration information                   */
 /* ========================================================================= */
 
+static int get_parameter_value(int type, char *value)
+{
+  return (type == TYPE_INTEGER ? get_integer_from_string(value) :
+         type == TYPE_BOOLEAN ? get_boolean_from_string(value) :
+         -1);
+}
+
 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list,
                                           struct ConfigInfo *suffix_list,
                                           int num_file_list_entries)
 {
   struct FileInfo *file_list;
+  int num_file_list_entries_found = 0;
   int num_suffix_list_entries = 0;
   int list_pos = 0;
   int i, j;
@@ -1386,7 +1465,8 @@ struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list,
 
       for (j=0; j<num_suffix_list_entries; j++)
       {
-       int default_parameter = atoi(suffix_list[j].value);
+       int default_parameter =
+         get_parameter_value(suffix_list[j].type, suffix_list[j].value);
 
        file_list[i].default_parameter[j] = default_parameter;
        file_list[i].parameter[j] = default_parameter;
@@ -1408,7 +1488,8 @@ struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list,
          strcmp(&config_list[i].token[len_config_token - len_suffix],
                 suffix_list[j].token) == 0)
       {
-       file_list[list_pos].default_parameter[j] = atoi(config_list[i].value);
+       file_list[list_pos].default_parameter[j] =
+         get_parameter_value(suffix_list[j].type, config_list[i].value);
 
        is_file_entry = FALSE;
        break;
@@ -1420,7 +1501,7 @@ struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list,
       if (i > 0)
        list_pos++;
 
-      if (list_pos > num_file_list_entries - 1)
+      if (list_pos >= num_file_list_entries)
        break;
 
       /* simple sanity check if this is really a file definition */
@@ -1438,12 +1519,87 @@ struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list,
     }
   }
 
-  if (list_pos != num_file_list_entries - 1)
-    Error(ERR_EXIT, "inconsistant config list information -- please fix");
+  num_file_list_entries_found = list_pos + 1;
+  if (num_file_list_entries_found != num_file_list_entries)
+  {
+    Error(ERR_RETURN, "inconsistant config list information:");
+    Error(ERR_RETURN, "- should be:   %d (according to 'src/conf_gfx.h')",
+         num_file_list_entries);
+    Error(ERR_RETURN, "- found to be: %d (according to 'src/conf_gfx.c')",
+         num_file_list_entries_found);
+    Error(ERR_EXIT,   "please fix");
+  }
 
   return file_list;
 }
 
+#if 0
+static void CheckArtworkConfig(struct ArtworkListInfo *artwork_info)
+{
+  struct FileInfo *file_list = artwork_info->file_list;
+  struct ConfigInfo *suffix_list = artwork_info->suffix_list;
+  int num_file_list_entries = artwork_info->num_file_list_entries;
+  int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
+  char *filename = getCustomArtworkConfigFilename(artwork_info->type);
+  struct SetupFileList *setup_file_list;
+  char *known_token_value = "[KNOWN_TOKEN]";
+  int i, j;
+
+  if (!options.verbose)
+    return;
+
+  if (filename == NULL)
+    return;
+
+  if ((setup_file_list = loadSetupFileList(filename)) == NULL)
+    return;
+
+  for (i=0; i<num_file_list_entries; i++)
+  {
+    /* check for config token that is the base token without any suffixes */
+    if (getTokenValue(setup_file_list, file_list[i].token) != NULL)
+    {
+      /* mark token as well known from default config */
+      setTokenValue(setup_file_list, file_list[i].token, known_token_value);
+    }
+
+    /* check for config tokens that can be build by base token and suffixes */
+    for (j=0; j<num_suffix_list_entries; j++)
+    {
+      char *token = getStringCat2(file_list[i].token, suffix_list[j].token);
+
+      if (getTokenValue(setup_file_list, token) != NULL)
+      {
+       /* mark token as well known from default config */
+       setTokenValue(setup_file_list, token, known_token_value);
+      }
+
+      free(token);
+    }
+  }
+
+  /* set some additional tokens to "known" */
+  setTokenValue(setup_file_list, "name", known_token_value);
+  setTokenValue(setup_file_list, "sort_priority", known_token_value);
+
+  /* check for each token in config file if it is defined in default config */
+  while (setup_file_list != NULL)
+  {
+    if (strcmp(setup_file_list->value, known_token_value) != 0)
+    {
+      Error(ERR_RETURN, "custom artwork configuration warning:");
+      Error(ERR_RETURN, "- config file: '%s'", filename);
+      Error(ERR_RETURN, "- config token: '%s'", setup_file_list->token);
+      Error(ERR_WARN, "token not recognized");
+    }
+
+    setup_file_list = setup_file_list->next;
+  }
+
+  freeSetupFileList(setup_file_list);
+}
+#endif
+
 static void LoadArtworkConfig(struct ArtworkListInfo *artwork_info)
 {
   struct FileInfo *file_list = artwork_info->file_list;
@@ -1452,6 +1608,7 @@ static void LoadArtworkConfig(struct ArtworkListInfo *artwork_info)
   int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
   char *filename = getCustomArtworkConfigFilename(artwork_info->type);
   struct SetupFileList *setup_file_list;
+  char *known_token_value = "[KNOWN_TOKEN]";
   int i, j;
 
 #if 0
@@ -1472,41 +1629,80 @@ static void LoadArtworkConfig(struct ArtworkListInfo *artwork_info)
   if (filename == NULL)
     return;
 
-  if ((setup_file_list = loadSetupFileList(filename)))
+  if ((setup_file_list = loadSetupFileList(filename)) == NULL)
+    return;
+
+  for (i=0; i<num_file_list_entries; i++)
   {
-    for (i=0; i<num_file_list_entries; i++)
+    /* check for config token that is the base token without any suffixes */
+    char *filename = getTokenValue(setup_file_list, file_list[i].token);
+
+    if (filename != NULL)
     {
-      char *filename = getTokenValue(setup_file_list, file_list[i].token);
+      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);
 
-      if (filename == NULL)
-       filename = file_list[i].default_filename;
       file_list[i].filename = getStringCopy(filename);
 
-      for (j=0; j<num_suffix_list_entries; j++)
-      {
-       char *token = getStringCat2(file_list[i].token, suffix_list[j].token);
-       char *value = getTokenValue(setup_file_list, token);
+      /* mark token as well known from default config */
+      setTokenValue(setup_file_list, file_list[i].token, known_token_value);
+    }
+    else
+      file_list[i].filename = getStringCopy(file_list[i].default_filename);
+
+    /* check for config tokens that can be build by base token and suffixes */
+    for (j=0; j<num_suffix_list_entries; j++)
+    {
+      char *token = getStringCat2(file_list[i].token, suffix_list[j].token);
+      char *value = getTokenValue(setup_file_list, token);
 
-       if (value != NULL)
-         file_list[i].parameter[j] = atoi(value);
+      if (value != NULL)
+      {
+       file_list[i].parameter[j] =
+         get_parameter_value(suffix_list[j].type, value);
 
-       free(token);
+       /* mark token as well known from default config */
+       setTokenValue(setup_file_list, token, known_token_value);
       }
+
+      free(token);
     }
+  }
 
-    freeSetupFileList(setup_file_list);
+  /* set some additional tokens to "known" */
+  setTokenValue(setup_file_list, "name", known_token_value);
+  setTokenValue(setup_file_list, "sort_priority", known_token_value);
 
-#if 0
-    for (i=0; i<num_file_list_entries; i++)
+  if (options.verbose)
+  {
+    /* check each token in config file if it is defined in default config */
+    while (setup_file_list != NULL)
     {
-      printf("'%s' ", file_list[i].token);
-      if (file_list[i].filename)
-       printf("-> '%s'\n", file_list[i].filename);
-      else
-       printf("-> UNDEFINED [-> '%s']\n", file_list[i].default_filename);
+      if (strcmp(setup_file_list->value, known_token_value) != 0)
+      {
+       Error(ERR_RETURN, "custom artwork configuration warning:");
+       Error(ERR_RETURN, "- config file: '%s'", filename);
+       Error(ERR_RETURN, "- config token: '%s'", setup_file_list->token);
+       Error(ERR_WARN, "token not recognized");
+      }
+
+      setup_file_list = setup_file_list->next;
     }
-#endif
   }
+
+  freeSetupFileList(setup_file_list);
+
+#if 0
+  for (i=0; i<num_file_list_entries; i++)
+  {
+    printf("'%s' ", file_list[i].token);
+    if (file_list[i].filename)
+      printf("-> '%s'\n", file_list[i].filename);
+    else
+      printf("-> UNDEFINED [-> '%s']\n", file_list[i].default_filename);
+  }
+#endif
 }
 
 static void deleteArtworkListEntry(struct ArtworkListInfo *artwork_info,
@@ -1536,9 +1732,29 @@ static void deleteArtworkListEntry(struct ArtworkListInfo *artwork_info,
 
 static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info,
                                    struct ListNodeInfo **listnode,
-                                   char *filename)
+                                   char *basename)
 {
+  char *init_text[] =
+  { "",
+    "Loading graphics:",
+    "Loading sounds:",
+    "Loading music:"
+  };
+
   ListNode *node;
+  char *filename = getCustomArtworkFilename(basename, artwork_info->type);
+
+  if (filename == NULL)
+  {
+    int error_mode = ERR_WARN;
+
+    /* we can get away without sounds and music, but not without graphics */
+    if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
+      error_mode = ERR_EXIT;
+
+    Error(error_mode, "cannot find artwork file '%s'", basename);
+    return;
+  }
 
   /* check if the old and the new artwork file are the same */
   if (*listnode && strcmp((*listnode)->source_filename, filename) == 0)
@@ -1566,20 +1782,43 @@ static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info,
 
       *listnode = (struct ListNodeInfo *)node->content;
       (*listnode)->num_references++;
+
+      return;
   }
-  else if ((*listnode = artwork_info->load_artwork(filename)) != NULL)
+
+  DrawInitText(init_text[artwork_info->type], 120, FC_GREEN);
+  DrawInitText(basename, 150, FC_YELLOW);
+
+  if ((*listnode = artwork_info->load_artwork(filename)) != NULL)
   {
+#if 0
+      printf("[adding new artwork '%s']\n", filename);
+#endif
+
     (*listnode)->num_references = 1;
     addNodeToList(&artwork_info->content_list, (*listnode)->source_filename,
                  *listnode);
   }
+  else
+  {
+    int error_mode = ERR_WARN;
+
+    /* we can get away without sounds and music, but not without graphics */
+    if (artwork_info->type == ARTWORK_TYPE_GRAPHICS)
+      error_mode = ERR_EXIT;
+
+    Error(error_mode, "cannot load artwork file '%s'", basename);
+    return;
+  }
 }
 
 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);
@@ -1591,6 +1830,7 @@ static void LoadCustomArtwork(struct ArtworkListInfo *artwork_info,
     return;
   }
 
+#if 0
   if (filename == NULL)
   {
     Error(ERR_WARN, "cannot find artwork file '%s'", basename);
@@ -1598,6 +1838,9 @@ static void LoadCustomArtwork(struct ArtworkListInfo *artwork_info,
   }
 
   replaceArtworkListEntry(artwork_info, listnode, filename);
+#else
+  replaceArtworkListEntry(artwork_info, listnode, basename);
+#endif
 }
 
 static void LoadArtworkToList(struct ArtworkListInfo *artwork_info,
@@ -1623,6 +1866,7 @@ static void LoadArtworkToList(struct ArtworkListInfo *artwork_info,
 
 void ReloadCustomArtworkList(struct ArtworkListInfo *artwork_info)
 {
+#if 0
   static struct
   {
     char *text;
@@ -1635,15 +1879,21 @@ void ReloadCustomArtworkList(struct ArtworkListInfo *artwork_info)
     { "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;
   int i;
 
+#if 0
+  CheckArtworkConfig(artwork_info);
+#endif
   LoadArtworkConfig(artwork_info);
 
+#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);
@@ -1651,13 +1901,21 @@ void ReloadCustomArtworkList(struct ArtworkListInfo *artwork_info)
 
   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, 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));
@@ -1672,7 +1930,7 @@ void FreeCustomArtworkList(struct ArtworkListInfo *artwork_info)
 {
   int i;
 
-  if (artwork_info->artwork_list == NULL)
+  if (artwork_info == NULL || artwork_info->artwork_list == NULL)
     return;
 
 #if 0
@@ -1729,6 +1987,21 @@ void dumpErrorFile()
 #endif
 
 
+/* ========================================================================= */
+/* some generic helper functions                                             */
+/* ========================================================================= */
+
+void printf_line(char line_char, int line_length)
+{
+  int i;
+
+  for (i=0; i<line_length; i++)
+    printf("%c", line_char);
+
+  printf("\n");
+}
+
+
 /* ========================================================================= */
 /* the following is only for debugging purpose and normally not used         */
 /* ========================================================================= */