rocksndiamonds-3.0.8
[rocksndiamonds.git] / src / libgame / misc.c
index 50a713f456be8c011b279044121e088516d57042..06ca9357c65f87d792349e44d0fcacaf074098c7 100644 (file)
@@ -41,7 +41,7 @@ void fprintf_line(FILE *stream, char *line_string, int line_length)
 {
   int i;
 
-  for (i=0; i<line_length; i++)
+  for (i = 0; i < line_length; i++)
     fprintf(stream, "%s", line_string);
 
   fprintf(stream, "\n");
@@ -82,6 +82,26 @@ char *int2str(int number, int size)
   }
 }
 
+/* something similar to "int2str()" above, but allocates its own memory
+   and has a different interface; we cannot use "itoa()", because this
+   seems to be already defined when cross-compiling to the win32 target */
+
+char *i_to_a(unsigned int i)
+{
+  static char *a = NULL;
+
+  checked_free(a);
+
+  if (i > 2147483647)  /* yes, this is a kludge */
+    i = 2147483647;
+
+  a = checked_malloc(10 + 1);
+
+  sprintf(a, "%d", i);
+
+  return a;
+}
+
 
 /* ------------------------------------------------------------------------- */
 /* counter functions                                                         */
@@ -243,7 +263,7 @@ void WaitUntilDelayReached(unsigned long *counter_var, unsigned long delay)
 {
   unsigned long actual_counter;
 
-  while(1)
+  while (1)
   {
     actual_counter = Counter();
 
@@ -262,48 +282,6 @@ void WaitUntilDelayReached(unsigned long *counter_var, unsigned long delay)
 /* random generator functions                                                */
 /* ------------------------------------------------------------------------- */
 
-#if 0
-unsigned int SimpleRND(unsigned int max)
-{
-  return (random_linux_libc(RND_FREE) % max);
-}
-
-unsigned int InitSimpleRND(long seed)
-{
-  if (seed == NEW_RANDOMIZE)
-  {
-    struct timeval current_time;
-
-    gettimeofday(&current_time, NULL);
-    seed = (long)current_time.tv_usec;
-  }
-
-  srandom_linux_libc(RND_FREE, (unsigned int) seed);
-
-  return (unsigned int) seed;
-}
-
-unsigned int RND(unsigned int max)
-{
-  return (random_linux_libc(RND_GAME) % max);
-}
-
-unsigned int InitRND(long seed)
-{
-  if (seed == NEW_RANDOMIZE)
-  {
-    struct timeval current_time;
-
-    gettimeofday(&current_time, NULL);
-    seed = (long)current_time.tv_usec;
-  }
-
-  srandom_linux_libc(RND_GAME, (unsigned int) seed);
-
-  return (unsigned int) seed;
-}
-#endif
-
 unsigned int init_random_number(int nr, long seed)
 {
   if (seed == NEW_RANDOMIZE)
@@ -323,7 +301,7 @@ unsigned int init_random_number(int nr, long seed)
   return (unsigned int) seed;
 }
 
-unsigned int get_random_number(int nr, unsigned int max)
+unsigned int get_random_number(int nr, int max)
 {
   return (max > 0 ? random_linux_libc(nr) % max : 0);
 }
@@ -522,8 +500,7 @@ char *getStringToLower(char *s)
 
 void setString(char **old_value, char *new_value)
 {
-  if (*old_value != NULL)
-    free(*old_value);
+  checked_free(*old_value);
 
   *old_value = getStringCopy(new_value);
 }
@@ -533,36 +510,7 @@ void setString(char **old_value, char *new_value)
 /* command line option handling functions                                    */
 /* ------------------------------------------------------------------------- */
 
-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[])
+void GetOptions(char *argv[], void (*print_usage_function)(void))
 {
   char **options_left = &argv[1];
 
@@ -624,7 +572,7 @@ void GetOptions(char *argv[])
       Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
     else if (strncmp(option, "-help", option_len) == 0)
     {
-      printUsage();
+      print_usage_function();
 
       exit(0);
     }
@@ -834,7 +782,7 @@ void Error(int mode, char *format, ...)
 
 
 /* ------------------------------------------------------------------------- */
-/* memory allocation functions                                               */
+/* checked memory allocation and freeing functions                           */
 /* ------------------------------------------------------------------------- */
 
 void *checked_malloc(unsigned long size)
@@ -871,6 +819,12 @@ void *checked_realloc(void *ptr, unsigned long size)
   return ptr;
 }
 
+void checked_free(void *ptr)
+{
+  if (ptr != NULL)     /* this check should be done by free() anyway */
+    free(ptr);
+}
+
 
 /* ------------------------------------------------------------------------- */
 /* various helper functions                                                  */
@@ -984,28 +938,26 @@ void putFileChunk(FILE *file, char *chunk_name, int chunk_size,
 
 int getFileVersion(FILE *file)
 {
-  int version_major, version_minor, version_patch, version_release;
-
-  version_major   = fgetc(file);
-  version_minor   = fgetc(file);
-  version_patch   = fgetc(file);
-  version_release = fgetc(file);
+  int version_major = fgetc(file);
+  int version_minor = fgetc(file);
+  int version_patch = fgetc(file);
+  int version_build = fgetc(file);
 
-  return RELEASE_IDENT(version_major, version_minor, version_patch,
-                      version_release);
+  return VERSION_IDENT(version_major, version_minor, version_patch,
+                      version_build);
 }
 
 void putFileVersion(FILE *file, int version)
 {
-  int version_major   = VERSION_MAJOR(version);
-  int version_minor   = VERSION_MINOR(version);
-  int version_patch   = VERSION_PATCH(version);
-  int version_release = VERSION_RELEASE(version);
+  int version_major = VERSION_MAJOR(version);
+  int version_minor = VERSION_MINOR(version);
+  int version_patch = VERSION_PATCH(version);
+  int version_build = VERSION_BUILD(version);
 
-  fputc(version_major,   file);
-  fputc(version_minor,   file);
-  fputc(version_patch,   file);
-  fputc(version_release, file);
+  fputc(version_major, file);
+  fputc(version_minor, file);
+  fputc(version_patch, file);
+  fputc(version_build, file);
 }
 
 void ReadUnusedBytesFromFile(FILE *file, unsigned long bytes)
@@ -1397,8 +1349,8 @@ int get_integer_from_string(char *s)
   char *s_lower = getStringToLower(s);
   int result = -1;
 
-  for (i=0; number_text[i][0] != NULL; i++)
-    for (j=0; j < 3; j++)
+  for (i = 0; number_text[i][0] != NULL; i++)
+    for (j = 0; j < 3; j++)
       if (strcmp(s_lower, number_text[i][j]) == 0)
        result = i;
 
@@ -1532,8 +1484,7 @@ boolean fileHasPrefix(char *basename, char *prefix)
   static char *basename_lower = NULL;
   int basename_length, prefix_length;
 
-  if (basename_lower != NULL)
-    free(basename_lower);
+  checked_free(basename_lower);
 
   if (basename == NULL || prefix == NULL)
     return FALSE;
@@ -1555,8 +1506,7 @@ boolean fileHasSuffix(char *basename, char *suffix)
   static char *basename_lower = NULL;
   int basename_length, suffix_length;
 
-  if (basename_lower != NULL)
-    free(basename_lower);
+  checked_free(basename_lower);
 
   if (basename == NULL || suffix == NULL)
     return FALSE;
@@ -1573,18 +1523,30 @@ boolean fileHasSuffix(char *basename, char *suffix)
   return FALSE;
 }
 
-boolean FileIsGraphic(char *basename)
+boolean FileIsGraphic(char *filename)
 {
+  char *basename = strrchr(filename, '/');
+
+  basename = (basename != NULL ? basename + 1 : filename);
+
   return fileHasSuffix(basename, "pcx");
 }
 
-boolean FileIsSound(char *basename)
+boolean FileIsSound(char *filename)
 {
+  char *basename = strrchr(filename, '/');
+
+  basename = (basename != NULL ? basename + 1 : filename);
+
   return fileHasSuffix(basename, "wav");
 }
 
-boolean FileIsMusic(char *basename)
+boolean FileIsMusic(char *filename)
 {
+  char *basename = strrchr(filename, '/');
+
+  basename = (basename != NULL ? basename + 1 : filename);
+
   if (FileIsSound(basename))
     return TRUE;
 
@@ -1725,11 +1687,11 @@ struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list,
 
   file_list = checked_calloc(num_file_list_entries * sizeof(struct FileInfo));
 
-  for (i=0; suffix_list[i].token != NULL; i++)
+  for (i = 0; suffix_list[i].token != NULL; i++)
     num_suffix_list_entries++;
 
   /* always start with reliable default values */
-  for (i=0; i<num_file_list_entries; i++)
+  for (i = 0; i < num_file_list_entries; i++)
   {
     file_list[i].token = NULL;
 
@@ -1743,7 +1705,7 @@ struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list,
       file_list[i].default_parameter = checked_calloc(parameter_array_size);
       file_list[i].parameter = checked_calloc(parameter_array_size);
 
-      for (j=0; j<num_suffix_list_entries; j++)
+      for (j = 0; j < num_suffix_list_entries; j++)
       {
        setString(&file_list[i].default_parameter[j], suffix_list[j].value);
        setString(&file_list[i].parameter[j], suffix_list[j].value);
@@ -1752,13 +1714,13 @@ struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list,
   }
 
   list_pos = 0;
-  for (i=0; config_list[i].token != NULL; i++)
+  for (i = 0; config_list[i].token != NULL; i++)
   {
     int len_config_token = strlen(config_list[i].token);
     int len_config_value = strlen(config_list[i].value);
     boolean is_file_entry = TRUE;
 
-    for (j=0; suffix_list[j].token != NULL; j++)
+    for (j = 0; suffix_list[j].token != NULL; j++)
     {
       int len_suffix = strlen(suffix_list[j].token);
 
@@ -1775,7 +1737,7 @@ struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list,
     }
 
     /* the following tokens are no file definitions, but other config tokens */
-    for (j=0; ignore_tokens[j] != NULL; j++)
+    for (j = 0; ignore_tokens[j] != NULL; j++)
       if (strcmp(config_list[i].token, ignore_tokens[j]) == 0)
        is_file_entry = FALSE;
 
@@ -1845,7 +1807,7 @@ static boolean token_suffix_match(char *token, char *suffix, int start_pos)
   return FALSE;
 }
 
-#define KNOWN_TOKEN_VALUE      "[KNOWN_TOKEN]"
+#define KNOWN_TOKEN_VALUE      "[KNOWN_TOKEN_VALUE]"
 
 static void read_token_parameters(SetupFileHash *setup_file_hash,
                                  struct ConfigInfo *suffix_list,
@@ -1861,7 +1823,7 @@ static void read_token_parameters(SetupFileHash *setup_file_hash,
     setString(&file_list_entry->filename, filename);
 
     /* when file definition found, set all parameters to default values */
-    for (i=0; suffix_list[i].token != NULL; i++)
+    for (i = 0; suffix_list[i].token != NULL; i++)
       setString(&file_list_entry->parameter[i], suffix_list[i].value);
 
     file_list_entry->redefined = TRUE;
@@ -1881,7 +1843,7 @@ static void read_token_parameters(SetupFileHash *setup_file_hash,
 #endif
 
   /* check for config tokens that can be build by base token and suffixes */
-  for (i=0; suffix_list[i].token != NULL; i++)
+  for (i = 0; suffix_list[i].token != NULL; i++)
   {
     char *token = getStringCat2(file_list_entry->token, suffix_list[i].token);
     char *value = getHashEntry(setup_file_hash, token);
@@ -1962,7 +1924,8 @@ static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info,
   int num_ext2_suffixes = artwork_info->num_ext2_suffixes;
   int num_ext3_suffixes = artwork_info->num_ext3_suffixes;
   int num_ignore_tokens = artwork_info->num_ignore_tokens;
-  SetupFileHash *setup_file_hash, *extra_file_hash;
+  SetupFileHash *setup_file_hash, *valid_file_hash;
+  SetupFileHash *extra_file_hash, *empty_file_hash;
   char *known_token_value = KNOWN_TOKEN_VALUE;
   int i, j, k, l;
 
@@ -1976,26 +1939,42 @@ static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info,
   if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
     return;
 
+  /* separate valid (defined) from empty (undefined) config token values */
+  valid_file_hash = newSetupFileHash();
+  empty_file_hash = newSetupFileHash();
+  BEGIN_HASH_ITERATION(setup_file_hash, itr)
+  {
+    char *value = HASH_ITERATION_VALUE(itr);
+
+    setHashEntry(*value ? valid_file_hash : empty_file_hash,
+                HASH_ITERATION_TOKEN(itr), value);
+  }
+  END_HASH_ITERATION(setup_file_hash, itr)
+
+  /* at this point, we do not need the setup file hash anymore -- free it */
+  freeSetupFileHash(setup_file_hash);
+
   /* read parameters for all known config file tokens */
-  for (i=0; i<num_file_list_entries; i++)
-    read_token_parameters(setup_file_hash, suffix_list, &file_list[i]);
+  for (i = 0; i < num_file_list_entries; i++)
+    read_token_parameters(valid_file_hash, suffix_list, &file_list[i]);
 
   /* set all tokens that can be ignored here to "known" keyword */
-  for (i=0; i < num_ignore_tokens; i++)
-    setHashEntry(setup_file_hash, ignore_tokens[i], known_token_value);
+  for (i = 0; i < num_ignore_tokens; i++)
+    setHashEntry(valid_file_hash, ignore_tokens[i], known_token_value);
 
-  /* copy all unknown config file tokens to extra config list */
+  /* copy all unknown config file tokens to extra config hash */
   extra_file_hash = newSetupFileHash();
-  BEGIN_HASH_ITERATION(setup_file_hash, itr)
+  BEGIN_HASH_ITERATION(valid_file_hash, itr)
   {
-    if (strcmp(HASH_ITERATION_VALUE(itr), known_token_value) != 0)
-      setHashEntry(extra_file_hash,
-                  HASH_ITERATION_TOKEN(itr), HASH_ITERATION_VALUE(itr));
+    char *value = HASH_ITERATION_VALUE(itr);
+
+    if (strcmp(value, known_token_value) != 0)
+      setHashEntry(extra_file_hash, HASH_ITERATION_TOKEN(itr), value);
   }
-  END_HASH_ITERATION(setup_file_hash, itr)
+  END_HASH_ITERATION(valid_file_hash, itr)
 
-  /* at this point, we do not need the config file hash anymore -- free it */
-  freeSetupFileHash(setup_file_hash);
+  /* at this point, we do not need the valid file hash anymore -- free it */
+  freeSetupFileHash(valid_file_hash);
 
   /* now try to determine valid, dynamically defined config tokens */
 
@@ -2019,7 +1998,7 @@ static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info,
     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 (i = 0; i < num_suffix_list_entries && !parameter_suffix_found; i++)
     {
       int len_suffix = strlen(suffix_list[i].token);
 
@@ -2043,7 +2022,7 @@ static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info,
     /* ---------- step 0: search for matching base prefix ---------- */
 
     start_pos = 0;
-    for (i=0; i<num_base_prefixes && !base_prefix_found; i++)
+    for (i = 0; i < num_base_prefixes && !base_prefix_found; i++)
     {
       char *base_prefix = base_prefixes[i];
       int len_base_prefix = strlen(base_prefix);
@@ -2088,7 +2067,7 @@ static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info,
       /* ---------- step 1: search for matching first suffix ---------- */
 
       start_pos += len_base_prefix;
-      for (j=0; j<num_ext1_suffixes && !ext1_suffix_found; j++)
+      for (j = 0; j < num_ext1_suffixes && !ext1_suffix_found; j++)
       {
        char *ext1_suffix = ext1_suffixes[j];
        int len_ext1_suffix = strlen(ext1_suffix);
@@ -2130,12 +2109,12 @@ static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info,
 
       /* ---------- step 2: search for matching second suffix ---------- */
 
-      for (k=0; k<num_ext2_suffixes && !ext2_suffix_found; k++)
+      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);
+       ext2_suffix_found = token_suffix_match(token, ext2_suffix, start_pos);
 
        if (!ext2_suffix_found)
          continue;
@@ -2172,12 +2151,12 @@ static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info,
 
       /* ---------- step 3: search for matching third suffix ---------- */
 
-      for (l=0; l<num_ext3_suffixes && !ext3_suffix_found; l++)
+      for (l = 0; l < num_ext3_suffixes && !ext3_suffix_found; l++)
       {
        char *ext3_suffix = ext3_suffixes[l];
        int len_ext3_suffix = strlen(ext3_suffix);
 
-       ext3_suffix_found =token_suffix_match(token,ext3_suffix,start_pos);
+       ext3_suffix_found = token_suffix_match(token, ext3_suffix, start_pos);
 
        if (!ext3_suffix_found)
          continue;
@@ -2212,11 +2191,12 @@ static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info,
                     artwork_info->sizeof_artwork_list_entry);
   }
 
-  if (extra_file_hash != NULL && options.verbose && IS_PARENT_PROCESS())
+  if (options.verbose && IS_PARENT_PROCESS())
   {
     SetupFileList *setup_file_list, *list;
     boolean dynamic_tokens_found = FALSE;
     boolean unknown_tokens_found = FALSE;
+    boolean undefined_values_found = (hashtable_count(empty_file_hash) != 0);
 
     if ((setup_file_list = loadSetupFileList(filename)) == NULL)
       Error(ERR_EXIT, "loadSetupFileHash works, but loadSetupFileList fails");
@@ -2264,13 +2244,31 @@ static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info,
       Error(ERR_RETURN_LINE, "-");
     }
 
+    if (undefined_values_found)
+    {
+      Error(ERR_RETURN_LINE, "-");
+      Error(ERR_RETURN, "warning: undefined values found in config file:");
+      Error(ERR_RETURN, "- config file: '%s'", filename);
+
+      for (list = setup_file_list; list != NULL; list = list->next)
+      {
+       char *value = getHashEntry(empty_file_hash, list->token);
+
+       if (value != NULL)
+         Error(ERR_RETURN, "- undefined value for token: '%s'", list->token);
+      }
+
+      Error(ERR_RETURN_LINE, "-");
+    }
+
     freeSetupFileList(setup_file_list);
   }
 
   freeSetupFileHash(extra_file_hash);
+  freeSetupFileHash(empty_file_hash);
 
 #if 0
-  for (i=0; i<num_file_list_entries; i++)
+  for (i = 0; i < num_file_list_entries; i++)
   {
     printf("'%s' ", file_list[i].token);
     if (file_list[i].filename)
@@ -2293,12 +2291,15 @@ void LoadArtworkConfig(struct ArtworkListInfo *artwork_info)
   printf("GOT CUSTOM ARTWORK CONFIG FILE '%s'\n", filename);
 #endif
 
+  DrawInitText("Loading artwork config:", 120, FC_GREEN);
+  DrawInitText(ARTWORKINFO_FILENAME(artwork_info->type), 150, FC_YELLOW);
+
   /* always start with reliable default values */
-  for (i=0; i<num_file_list_entries; i++)
+  for (i = 0; i < num_file_list_entries; i++)
   {
     setString(&file_list[i].filename, file_list[i].default_filename);
 
-    for (j=0; j<num_suffix_list_entries; j++)
+    for (j = 0; j < num_suffix_list_entries; j++)
       setString(&file_list[i].parameter[j], file_list[i].default_parameter[j]);
 
     file_list[i].redefined = FALSE;
@@ -2307,7 +2308,7 @@ void LoadArtworkConfig(struct ArtworkListInfo *artwork_info)
   /* 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++)
+    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);
@@ -2519,7 +2520,7 @@ void ReloadCustomArtworkList(struct ArtworkListInfo *artwork_info)
         num_file_list_entries);
 #endif
 
-  for(i=0; i<num_file_list_entries; i++)
+  for (i = 0; i < num_file_list_entries; i++)
   {
 #if 0
     if (strcmp(file_list[i].token, "background") == 0)
@@ -2547,7 +2548,7 @@ void ReloadCustomArtworkList(struct ArtworkListInfo *artwork_info)
         num_dynamic_file_list_entries);
 #endif
 
-  for(i=0; i<num_dynamic_file_list_entries; i++)
+  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);
 
@@ -2565,7 +2566,7 @@ static void FreeCustomArtworkList(struct ArtworkListInfo *artwork_info,
   if (*list == NULL)
     return;
 
-  for(i=0; i<*num_list_entries; i++)
+  for (i = 0; i < *num_list_entries; i++)
     deleteArtworkListEntry(artwork_info, &(*list)[i]);
   free(*list);