1 // ============================================================================
2 // Artsoft Retro-Game Library
3 // ----------------------------------------------------------------------------
4 // (c) 1995-2014 by Artsoft Entertainment
7 // http://www.artsoft.org/
8 // ----------------------------------------------------------------------------
10 // ============================================================================
14 #include <sys/types.h>
24 #if !defined(PLATFORM_WIN32)
26 #include <sys/param.h>
36 /* ========================================================================= */
37 /* some generic helper functions */
38 /* ========================================================================= */
40 /* ------------------------------------------------------------------------- */
41 /* platform independent wrappers for printf() et al. (newline aware) */
42 /* ------------------------------------------------------------------------- */
44 #if defined(PLATFORM_ANDROID)
45 static int android_log_prio = ANDROID_LOG_INFO;
49 static void vfPrintLog(FILE *stream, char *format, va_list ap)
53 static void vfPrintLog(FILE *stream, char *format, va_list ap)
57 static void fPrintLog(FILE *stream, char *format, va_list ap)
61 static void fPrintLog(FILE *stream, char *format, va_list ap)
66 static void vfprintf_nonewline(FILE *stream, char *format, va_list ap)
68 #if defined(PLATFORM_ANDROID)
69 // (prefix text of logging output is currently skipped on Android)
70 //__android_log_vprint(android_log_prio, program.program_title, format, ap);
75 vfprintf(stream, format, ap);
76 vfprintf(stderr, format, ap2);
82 static void vfprintf_newline(FILE *stream, char *format, va_list ap)
84 #if defined(PLATFORM_ANDROID)
85 __android_log_vprint(android_log_prio, program.program_title, format, ap);
87 char *newline = STRING_NEWLINE;
92 vfprintf(stream, format, ap);
93 fprintf(stream, "%s", newline);
95 vfprintf(stderr, format, ap2);
96 fprintf(stderr, "%s", newline);
102 static void fprintf_nonewline(FILE *stream, char *format, ...)
106 va_start(ap, format);
107 vfprintf_nonewline(stream, format, ap);
111 static void fprintf_newline(FILE *stream, char *format, ...)
115 va_start(ap, format);
116 vfprintf_newline(stream, format, ap);
120 void fprintf_line(FILE *stream, char *line_chars, int line_length)
124 for (i = 0; i < line_length; i++)
125 fprintf_nonewline(stream, "%s", line_chars);
127 fprintf_newline(stream, "");
130 void printf_line(char *line_chars, int line_length)
132 fprintf_line(stdout, line_chars, line_length);
135 void printf_line_with_prefix(char *prefix, char *line_chars, int line_length)
137 fprintf(stdout, "%s", prefix);
138 fprintf_line(stdout, line_chars, line_length);
142 /* ------------------------------------------------------------------------- */
143 /* string functions */
144 /* ------------------------------------------------------------------------- */
146 /* int2str() returns a number converted to a string;
147 the used memory is static, but will be overwritten by later calls,
148 so if you want to save the result, copy it to a private string buffer;
149 there can be 10 local calls of int2str() without buffering the result --
150 the 11th call will then destroy the result from the first call and so on.
153 char *int2str(int number, int size)
155 static char shift_array[10][40];
156 static int shift_counter = 0;
157 char *s = shift_array[shift_counter];
159 shift_counter = (shift_counter + 1) % 10;
166 sprintf(s, " %09d", number);
167 return &s[strlen(s) - size];
171 sprintf(s, "%d", number);
177 /* something similar to "int2str()" above, but allocates its own memory
178 and has a different interface; we cannot use "itoa()", because this
179 seems to be already defined when cross-compiling to the win32 target */
181 char *i_to_a(unsigned int i)
183 static char *a = NULL;
187 if (i > 2147483647) /* yes, this is a kludge */
190 a = checked_malloc(10 + 1);
198 /* calculate base-2 logarithm of argument (rounded down to integer;
199 this function returns the number of the highest bit set in argument) */
201 int log_2(unsigned int x)
207 x -= (1 << e); /* for rounding down (rounding up: remove this line) */
214 boolean getTokenValueFromString(char *string, char **token, char **value)
216 return getTokenValueFromSetupLine(string, token, value);
220 /* ------------------------------------------------------------------------- */
221 /* counter functions */
222 /* ------------------------------------------------------------------------- */
224 /* maximal allowed length of a command line option */
225 #define MAX_OPTION_LEN 256
227 static unsigned int getCurrentMS()
229 return SDL_GetTicks();
232 static unsigned int mainCounter(int mode)
234 static unsigned int base_ms = 0;
235 unsigned int current_ms;
237 /* get current system milliseconds */
238 current_ms = getCurrentMS();
240 /* reset base timestamp in case of counter reset or wrap-around */
241 if (mode == INIT_COUNTER || current_ms < base_ms)
242 base_ms = current_ms;
244 /* return milliseconds since last counter reset */
245 return current_ms - base_ms;
248 void InitCounter() /* set counter back to zero */
250 mainCounter(INIT_COUNTER);
253 unsigned int Counter() /* get milliseconds since last call of InitCounter() */
255 return mainCounter(READ_COUNTER);
258 static void sleep_milliseconds(unsigned int milliseconds_delay)
260 boolean do_busy_waiting = (milliseconds_delay < 5 ? TRUE : FALSE);
264 /* we want to wait only a few ms -- if we assume that we have a
265 kernel timer resolution of 10 ms, we would wait far to long;
266 therefore it's better to do a short interval of busy waiting
267 to get our sleeping time more accurate */
269 unsigned int base_counter = Counter(), actual_counter = Counter();
271 while (actual_counter < base_counter + milliseconds_delay &&
272 actual_counter >= base_counter)
273 actual_counter = Counter();
277 SDL_Delay(milliseconds_delay);
281 void Delay(unsigned int delay) /* Sleep specified number of milliseconds */
283 sleep_milliseconds(delay);
286 boolean FrameReached(unsigned int *frame_counter_var,
287 unsigned int frame_delay)
289 unsigned int actual_frame_counter = FrameCounter;
291 if (actual_frame_counter >= *frame_counter_var &&
292 actual_frame_counter < *frame_counter_var + frame_delay)
295 *frame_counter_var = actual_frame_counter;
300 boolean DelayReached(unsigned int *counter_var,
303 unsigned int actual_counter = Counter();
305 if (actual_counter >= *counter_var &&
306 actual_counter < *counter_var + delay)
309 *counter_var = actual_counter;
314 void WaitUntilDelayReached(unsigned int *counter_var, unsigned int delay)
316 unsigned int actual_counter;
320 actual_counter = Counter();
322 if (actual_counter >= *counter_var &&
323 actual_counter < *counter_var + delay)
324 sleep_milliseconds((*counter_var + delay - actual_counter) / 2);
329 *counter_var = actual_counter;
333 /* ------------------------------------------------------------------------- */
334 /* random generator functions */
335 /* ------------------------------------------------------------------------- */
337 unsigned int init_random_number(int nr, int seed)
339 if (seed == NEW_RANDOMIZE)
341 /* default random seed */
342 seed = (int)time(NULL); // seconds since the epoch
344 #if !defined(PLATFORM_WIN32)
345 /* add some more randomness */
346 struct timeval current_time;
348 gettimeofday(¤t_time, NULL);
350 seed += (int)current_time.tv_usec; // microseconds since the epoch
353 /* add some more randomness */
354 seed += (int)SDL_GetTicks(); // milliseconds since SDL init
356 /* add some more randomness */
357 seed += GetSimpleRandom(1000000);
360 srandom_linux_libc(nr, (unsigned int) seed);
362 return (unsigned int) seed;
365 unsigned int get_random_number(int nr, int max)
367 return (max > 0 ? random_linux_libc(nr) % max : 0);
371 /* ------------------------------------------------------------------------- */
372 /* system info functions */
373 /* ------------------------------------------------------------------------- */
375 #if !defined(PLATFORM_ANDROID)
376 static char *get_corrected_real_name(char *real_name)
378 char *real_name_new = checked_malloc(MAX_USERNAME_LEN + 1);
379 char *from_ptr = real_name;
380 char *to_ptr = real_name_new;
382 /* copy the name string, but not more than MAX_USERNAME_LEN characters */
383 while (*from_ptr && (int)(to_ptr - real_name_new) < MAX_USERNAME_LEN - 1)
385 /* the name field read from "passwd" file may also contain additional
386 user information, separated by commas, which will be removed here */
387 if (*from_ptr == ',')
390 /* the user's real name may contain 'ß' characters (german sharp s),
391 which have no equivalent in upper case letters (used by our fonts) */
392 if (*from_ptr == 'ß')
399 *to_ptr++ = *from_ptr++;
404 return real_name_new;
410 static char *login_name = NULL;
412 #if defined(PLATFORM_WIN32)
413 if (login_name == NULL)
415 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
416 login_name = checked_malloc(buffer_size);
418 if (GetUserName(login_name, &buffer_size) == 0)
419 strcpy(login_name, ANONYMOUS_NAME);
422 if (login_name == NULL)
426 if ((pwd = getpwuid(getuid())) == NULL)
427 login_name = ANONYMOUS_NAME;
429 login_name = getStringCopy(pwd->pw_name);
438 static char *real_name = NULL;
440 #if defined(PLATFORM_WIN32)
441 if (real_name == NULL)
443 static char buffer[MAX_USERNAME_LEN + 1];
444 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
446 if (GetUserName(buffer, &buffer_size) != 0)
447 real_name = get_corrected_real_name(buffer);
449 real_name = ANONYMOUS_NAME;
451 #elif defined(PLATFORM_UNIX) && !defined(PLATFORM_ANDROID)
452 if (real_name == NULL)
456 if ((pwd = getpwuid(getuid())) != NULL && strlen(pwd->pw_gecos) != 0)
457 real_name = get_corrected_real_name(pwd->pw_gecos);
459 real_name = ANONYMOUS_NAME;
462 real_name = ANONYMOUS_NAME;
468 time_t getFileTimestampEpochSeconds(char *filename)
470 struct stat file_status;
472 if (stat(filename, &file_status) != 0) /* cannot stat file */
475 return file_status.st_mtime;
479 /* ------------------------------------------------------------------------- */
480 /* path manipulation functions */
481 /* ------------------------------------------------------------------------- */
483 static char *getLastPathSeparatorPtr(char *filename)
485 char *last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_UNIX);
487 if (last_separator == NULL) /* also try DOS/Windows variant */
488 last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_DOS);
490 return last_separator;
493 char *getBaseNamePtr(char *filename)
495 char *last_separator = getLastPathSeparatorPtr(filename);
497 if (last_separator != NULL)
498 return last_separator + 1; /* separator found: strip base path */
500 return filename; /* no separator found: filename has no path */
503 char *getBaseName(char *filename)
505 return getStringCopy(getBaseNamePtr(filename));
508 char *getBasePath(char *filename)
510 char *basepath = getStringCopy(filename);
511 char *last_separator = getLastPathSeparatorPtr(basepath);
513 if (last_separator != NULL)
514 *last_separator = '\0'; /* separator found: strip basename */
516 basepath = "."; /* no separator found: use current path */
521 static char *getProgramMainDataPath()
523 char *main_data_path = getStringCopy(program.command_basepath);
525 #if defined(PLATFORM_MACOSX)
526 static char *main_data_binary_subdir = NULL;
528 if (main_data_binary_subdir == NULL)
530 main_data_binary_subdir = checked_malloc(strlen(program.program_title) + 1 +
532 strlen(MAC_APP_BINARY_SUBDIR) + 1);
534 sprintf(main_data_binary_subdir, "%s.app/%s",
535 program.program_title, MAC_APP_BINARY_SUBDIR);
538 // cut relative path to Mac OS X application binary directory from path
539 if (strSuffix(main_data_path, main_data_binary_subdir))
540 main_data_path[strlen(main_data_path) -
541 strlen(main_data_binary_subdir)] = '\0';
543 // cut trailing path separator from path (but not if path is root directory)
544 if (strSuffix(main_data_path, "/") && !strEqual(main_data_path, "/"))
545 main_data_path[strlen(main_data_path) - 1] = '\0';
548 return main_data_path;
552 /* ------------------------------------------------------------------------- */
553 /* various string functions */
554 /* ------------------------------------------------------------------------- */
556 char *getStringCat2WithSeparator(char *s1, char *s2, char *sep)
558 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
561 sprintf(complete_string, "%s%s%s", s1, sep, s2);
563 return complete_string;
566 char *getStringCat3WithSeparator(char *s1, char *s2, char *s3, char *sep)
568 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
569 strlen(s2) + strlen(sep) +
572 sprintf(complete_string, "%s%s%s%s%s", s1, sep, s2, sep, s3);
574 return complete_string;
577 char *getStringCat2(char *s1, char *s2)
579 return getStringCat2WithSeparator(s1, s2, "");
582 char *getStringCat3(char *s1, char *s2, char *s3)
584 return getStringCat3WithSeparator(s1, s2, s3, "");
587 char *getPath2(char *path1, char *path2)
589 #if defined(PLATFORM_ANDROID)
590 // workaround for reading from APK assets directory -- skip leading "./"
591 if (strEqual(path1, "."))
592 return getStringCopy(path2);
595 return getStringCat2WithSeparator(path1, path2, STRING_PATH_SEPARATOR);
598 char *getPath3(char *path1, char *path2, char *path3)
600 #if defined(PLATFORM_ANDROID)
601 // workaround for reading from APK assets directory -- skip leading "./"
602 if (strEqual(path1, "."))
603 return getStringCat2WithSeparator(path2, path3, STRING_PATH_SEPARATOR);
606 return getStringCat3WithSeparator(path1, path2, path3, STRING_PATH_SEPARATOR);
609 char *getStringCopy(const char *s)
616 s_copy = checked_malloc(strlen(s) + 1);
622 char *getStringCopyN(const char *s, int n)
625 int s_len = MAX(0, n);
630 s_copy = checked_malloc(s_len + 1);
631 strncpy(s_copy, s, s_len);
632 s_copy[s_len] = '\0';
637 char *getStringCopyNStatic(const char *s, int n)
639 static char *s_copy = NULL;
641 checked_free(s_copy);
643 s_copy = getStringCopyN(s, n);
648 char *getStringToLower(const char *s)
650 char *s_copy = checked_malloc(strlen(s) + 1);
651 char *s_ptr = s_copy;
654 *s_ptr++ = tolower(*s++);
660 void setString(char **old_value, char *new_value)
662 checked_free(*old_value);
664 *old_value = getStringCopy(new_value);
667 boolean strEqual(char *s1, char *s2)
669 return (s1 == NULL && s2 == NULL ? TRUE :
670 s1 == NULL && s2 != NULL ? FALSE :
671 s1 != NULL && s2 == NULL ? FALSE :
672 strcmp(s1, s2) == 0);
675 boolean strEqualN(char *s1, char *s2, int n)
677 return (s1 == NULL && s2 == NULL ? TRUE :
678 s1 == NULL && s2 != NULL ? FALSE :
679 s1 != NULL && s2 == NULL ? FALSE :
680 strncmp(s1, s2, n) == 0);
683 boolean strPrefix(char *s, char *prefix)
685 return (s == NULL && prefix == NULL ? TRUE :
686 s == NULL && prefix != NULL ? FALSE :
687 s != NULL && prefix == NULL ? FALSE :
688 strncmp(s, prefix, strlen(prefix)) == 0);
691 boolean strSuffix(char *s, char *suffix)
693 return (s == NULL && suffix == NULL ? TRUE :
694 s == NULL && suffix != NULL ? FALSE :
695 s != NULL && suffix == NULL ? FALSE :
696 strlen(s) < strlen(suffix) ? FALSE :
697 strncmp(&s[strlen(s) - strlen(suffix)], suffix, strlen(suffix)) == 0);
700 boolean strPrefixLower(char *s, char *prefix)
702 char *s_lower = getStringToLower(s);
703 boolean match = strPrefix(s_lower, prefix);
710 boolean strSuffixLower(char *s, char *suffix)
712 char *s_lower = getStringToLower(s);
713 boolean match = strSuffix(s_lower, suffix);
721 /* ------------------------------------------------------------------------- */
722 /* command line option handling functions */
723 /* ------------------------------------------------------------------------- */
725 void GetOptions(char *argv[],
726 void (*print_usage_function)(void),
727 void (*print_version_function)(void))
729 char *ro_base_path = RO_BASE_PATH;
730 char *rw_base_path = RW_BASE_PATH;
731 char **options_left = &argv[1];
733 /* if the program is configured to start from current directory (default),
734 determine program package directory from program binary (some versions
735 of KDE/Konqueror and Mac OS X (especially "Mavericks") apparently do not
736 set the current working directory to the program package directory) */
738 if (strEqual(ro_base_path, "."))
739 ro_base_path = getProgramMainDataPath();
740 if (strEqual(rw_base_path, "."))
741 rw_base_path = getProgramMainDataPath();
743 /* initialize global program options */
744 options.display_name = NULL;
745 options.server_host = NULL;
746 options.server_port = 0;
748 options.ro_base_directory = ro_base_path;
749 options.rw_base_directory = rw_base_path;
750 options.level_directory = getPath2(ro_base_path, LEVELS_DIRECTORY);
751 options.graphics_directory = getPath2(ro_base_path, GRAPHICS_DIRECTORY);
752 options.sounds_directory = getPath2(ro_base_path, SOUNDS_DIRECTORY);
753 options.music_directory = getPath2(ro_base_path, MUSIC_DIRECTORY);
754 options.docs_directory = getPath2(ro_base_path, DOCS_DIRECTORY);
756 options.execute_command = NULL;
757 options.special_flags = NULL;
759 options.serveronly = FALSE;
760 options.network = FALSE;
761 options.verbose = FALSE;
762 options.debug = FALSE;
763 options.debug_x11_sync = FALSE;
766 options.verbose = TRUE;
768 #if !defined(PLATFORM_UNIX)
769 if (*options_left == NULL) /* no options given -- enable verbose mode */
770 options.verbose = TRUE;
774 while (*options_left)
776 char option_str[MAX_OPTION_LEN];
777 char *option = options_left[0];
778 char *next_option = options_left[1];
779 char *option_arg = NULL;
780 int option_len = strlen(option);
782 if (option_len >= MAX_OPTION_LEN)
783 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
785 strcpy(option_str, option); /* copy argument into buffer */
788 if (strEqual(option, "--")) /* stop scanning arguments */
791 if (strPrefix(option, "--")) /* treat '--' like '-' */
794 option_arg = strchr(option, '=');
795 if (option_arg == NULL) /* no '=' in option */
796 option_arg = next_option;
799 *option_arg++ = '\0'; /* cut argument from option */
800 if (*option_arg == '\0') /* no argument after '=' */
801 Error(ERR_EXIT_HELP, "option '%s' has invalid argument", option_str);
804 option_len = strlen(option);
806 if (strEqual(option, "-"))
808 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
810 else if (strncmp(option, "-help", option_len) == 0)
812 print_usage_function();
816 else if (strncmp(option, "-display", option_len) == 0)
818 if (option_arg == NULL)
819 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
821 options.display_name = option_arg;
822 if (option_arg == next_option)
825 else if (strncmp(option, "-basepath", option_len) == 0)
827 if (option_arg == NULL)
828 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
830 /* this should be extended to separate options for ro and rw data */
831 options.ro_base_directory = ro_base_path = option_arg;
832 options.rw_base_directory = rw_base_path = option_arg;
833 if (option_arg == next_option)
836 /* adjust paths for sub-directories in base directory accordingly */
837 options.level_directory = getPath2(ro_base_path, LEVELS_DIRECTORY);
838 options.graphics_directory = getPath2(ro_base_path, GRAPHICS_DIRECTORY);
839 options.sounds_directory = getPath2(ro_base_path, SOUNDS_DIRECTORY);
840 options.music_directory = getPath2(ro_base_path, MUSIC_DIRECTORY);
841 options.docs_directory = getPath2(ro_base_path, DOCS_DIRECTORY);
843 else if (strncmp(option, "-levels", option_len) == 0)
845 if (option_arg == NULL)
846 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
848 options.level_directory = option_arg;
849 if (option_arg == next_option)
852 else if (strncmp(option, "-graphics", option_len) == 0)
854 if (option_arg == NULL)
855 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
857 options.graphics_directory = option_arg;
858 if (option_arg == next_option)
861 else if (strncmp(option, "-sounds", option_len) == 0)
863 if (option_arg == NULL)
864 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
866 options.sounds_directory = option_arg;
867 if (option_arg == next_option)
870 else if (strncmp(option, "-music", option_len) == 0)
872 if (option_arg == NULL)
873 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
875 options.music_directory = option_arg;
876 if (option_arg == next_option)
879 else if (strncmp(option, "-network", option_len) == 0)
881 options.network = TRUE;
883 else if (strncmp(option, "-serveronly", option_len) == 0)
885 options.serveronly = TRUE;
887 else if (strncmp(option, "-debug", option_len) == 0)
889 options.debug = TRUE;
891 else if (strncmp(option, "-debug-x11-sync", option_len) == 0)
893 options.debug_x11_sync = TRUE;
895 else if (strncmp(option, "-verbose", option_len) == 0)
897 options.verbose = TRUE;
899 else if (strncmp(option, "-version", option_len) == 0 ||
900 strncmp(option, "-V", option_len) == 0)
902 print_version_function();
906 else if (strPrefix(option, "-D"))
908 options.special_flags = getStringCopy(&option[2]);
910 else if (strncmp(option, "-execute", option_len) == 0)
912 if (option_arg == NULL)
913 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
915 options.execute_command = option_arg;
916 if (option_arg == next_option)
919 /* when doing batch processing, always enable verbose mode (warnings) */
920 options.verbose = TRUE;
922 else if (*option == '-')
924 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option_str);
926 else if (options.server_host == NULL)
928 options.server_host = *options_left;
930 else if (options.server_port == 0)
932 options.server_port = atoi(*options_left);
933 if (options.server_port < 1024)
934 Error(ERR_EXIT_HELP, "bad port number '%d'", options.server_port);
937 Error(ERR_EXIT_HELP, "too many arguments");
944 /* ------------------------------------------------------------------------- */
945 /* error handling functions */
946 /* ------------------------------------------------------------------------- */
948 #define MAX_INTERNAL_ERROR_SIZE 1024
950 /* used by SetError() and GetError() to store internal error messages */
951 static char internal_error[MAX_INTERNAL_ERROR_SIZE];
953 void SetError(char *format, ...)
957 va_start(ap, format);
958 vsnprintf(internal_error, MAX_INTERNAL_ERROR_SIZE, format, ap);
964 return internal_error;
967 void Error(int mode, char *format, ...)
969 static boolean last_line_was_separator = FALSE;
970 char *process_name = "";
972 #if defined(PLATFORM_ANDROID)
973 android_log_prio = (mode & ERR_DEBUG ? ANDROID_LOG_DEBUG :
974 mode & ERR_INFO ? ANDROID_LOG_INFO :
975 mode & ERR_WARN ? ANDROID_LOG_WARN :
976 mode & ERR_EXIT ? ANDROID_LOG_FATAL :
977 ANDROID_LOG_UNKNOWN);
980 /* display warnings only when running in verbose mode */
981 if (mode & ERR_WARN && !options.verbose)
984 if (mode == ERR_INFO_LINE)
986 if (!last_line_was_separator)
987 fprintf_line(program.error_file, format, 79);
989 last_line_was_separator = TRUE;
994 last_line_was_separator = FALSE;
996 if (mode & ERR_SOUND_SERVER)
997 process_name = " sound server";
998 else if (mode & ERR_NETWORK_SERVER)
999 process_name = " network server";
1000 else if (mode & ERR_NETWORK_CLIENT)
1001 process_name = " network client **";
1007 fprintf_nonewline(program.error_file, "%s%s: ", program.command_basename,
1010 if (mode & ERR_WARN)
1011 fprintf_nonewline(program.error_file, "warning: ");
1013 va_start(ap, format);
1014 vfprintf_newline(program.error_file, format, ap);
1017 if ((mode & ERR_EXIT) && !(mode & ERR_FROM_SERVER))
1019 va_start(ap, format);
1020 program.exit_message_function(format, ap);
1025 if (mode & ERR_HELP)
1026 fprintf_newline(program.error_file,
1027 "%s: Try option '--help' for more information.",
1028 program.command_basename);
1030 if (mode & ERR_EXIT)
1031 fprintf_newline(program.error_file, "%s%s: aborting",
1032 program.command_basename, process_name);
1034 if (mode & ERR_EXIT)
1036 if (mode & ERR_FROM_SERVER)
1037 exit(1); /* child process: normal exit */
1039 program.exit_function(1); /* main process: clean up stuff */
1044 /* ------------------------------------------------------------------------- */
1045 /* checked memory allocation and freeing functions */
1046 /* ------------------------------------------------------------------------- */
1048 void *checked_malloc(unsigned int size)
1055 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
1060 void *checked_calloc(unsigned int size)
1064 ptr = calloc(1, size);
1067 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
1072 void *checked_realloc(void *ptr, unsigned int size)
1074 ptr = realloc(ptr, size);
1077 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
1082 void checked_free(void *ptr)
1084 if (ptr != NULL) /* this check should be done by free() anyway */
1088 void clear_mem(void *ptr, unsigned int size)
1090 #if defined(PLATFORM_WIN32)
1091 /* for unknown reason, memset() sometimes crashes when compiled with MinGW */
1092 char *cptr = (char *)ptr;
1097 memset(ptr, 0, size);
1102 /* ------------------------------------------------------------------------- */
1103 /* various helper functions */
1104 /* ------------------------------------------------------------------------- */
1106 inline void swap_numbers(int *i1, int *i2)
1114 inline void swap_number_pairs(int *x1, int *y1, int *x2, int *y2)
1126 /* the "put" variants of the following file access functions check for the file
1127 pointer being != NULL and return the number of bytes they have or would have
1128 written; this allows for chunk writing functions to first determine the size
1129 of the (not yet written) chunk, write the correct chunk size and finally
1130 write the chunk itself */
1132 int getFile8BitInteger(File *file)
1134 return getByteFromFile(file);
1137 int putFile8BitInteger(FILE *file, int value)
1145 int getFile16BitInteger(File *file, int byte_order)
1147 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1148 return ((getByteFromFile(file) << 8) |
1149 (getByteFromFile(file) << 0));
1150 else /* BYTE_ORDER_LITTLE_ENDIAN */
1151 return ((getByteFromFile(file) << 0) |
1152 (getByteFromFile(file) << 8));
1155 int putFile16BitInteger(FILE *file, int value, int byte_order)
1159 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1161 fputc((value >> 8) & 0xff, file);
1162 fputc((value >> 0) & 0xff, file);
1164 else /* BYTE_ORDER_LITTLE_ENDIAN */
1166 fputc((value >> 0) & 0xff, file);
1167 fputc((value >> 8) & 0xff, file);
1174 int getFile32BitInteger(File *file, int byte_order)
1176 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1177 return ((getByteFromFile(file) << 24) |
1178 (getByteFromFile(file) << 16) |
1179 (getByteFromFile(file) << 8) |
1180 (getByteFromFile(file) << 0));
1181 else /* BYTE_ORDER_LITTLE_ENDIAN */
1182 return ((getByteFromFile(file) << 0) |
1183 (getByteFromFile(file) << 8) |
1184 (getByteFromFile(file) << 16) |
1185 (getByteFromFile(file) << 24));
1188 int putFile32BitInteger(FILE *file, int value, int byte_order)
1192 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1194 fputc((value >> 24) & 0xff, file);
1195 fputc((value >> 16) & 0xff, file);
1196 fputc((value >> 8) & 0xff, file);
1197 fputc((value >> 0) & 0xff, file);
1199 else /* BYTE_ORDER_LITTLE_ENDIAN */
1201 fputc((value >> 0) & 0xff, file);
1202 fputc((value >> 8) & 0xff, file);
1203 fputc((value >> 16) & 0xff, file);
1204 fputc((value >> 24) & 0xff, file);
1211 boolean getFileChunk(File *file, char *chunk_name, int *chunk_size,
1214 const int chunk_name_length = 4;
1216 /* read chunk name */
1217 if (getStringFromFile(file, chunk_name, chunk_name_length + 1) == NULL)
1220 if (chunk_size != NULL)
1222 /* read chunk size */
1223 *chunk_size = getFile32BitInteger(file, byte_order);
1226 return (checkEndOfFile(file) ? FALSE : TRUE);
1229 int putFileChunk(FILE *file, char *chunk_name, int chunk_size,
1234 /* write chunk name */
1236 fputs(chunk_name, file);
1238 num_bytes += strlen(chunk_name);
1240 if (chunk_size >= 0)
1242 /* write chunk size */
1244 putFile32BitInteger(file, chunk_size, byte_order);
1252 int getFileVersion(File *file)
1254 int version_major = getByteFromFile(file);
1255 int version_minor = getByteFromFile(file);
1256 int version_patch = getByteFromFile(file);
1257 int version_build = getByteFromFile(file);
1259 return VERSION_IDENT(version_major, version_minor, version_patch,
1263 int putFileVersion(FILE *file, int version)
1267 int version_major = VERSION_MAJOR(version);
1268 int version_minor = VERSION_MINOR(version);
1269 int version_patch = VERSION_PATCH(version);
1270 int version_build = VERSION_BUILD(version);
1272 fputc(version_major, file);
1273 fputc(version_minor, file);
1274 fputc(version_patch, file);
1275 fputc(version_build, file);
1281 void ReadBytesFromFile(File *file, byte *buffer, unsigned int bytes)
1285 for (i = 0; i < bytes && !checkEndOfFile(file); i++)
1286 buffer[i] = getByteFromFile(file);
1289 void WriteBytesToFile(FILE *file, byte *buffer, unsigned int bytes)
1293 for(i = 0; i < bytes; i++)
1294 fputc(buffer[i], file);
1297 void ReadUnusedBytesFromFile(File *file, unsigned int bytes)
1299 while (bytes-- && !checkEndOfFile(file))
1300 getByteFromFile(file);
1303 void WriteUnusedBytesToFile(FILE *file, unsigned int bytes)
1310 /* ------------------------------------------------------------------------- */
1311 /* functions to translate key identifiers between different format */
1312 /* ------------------------------------------------------------------------- */
1314 #define TRANSLATE_KEYSYM_TO_KEYNAME 0
1315 #define TRANSLATE_KEYSYM_TO_X11KEYNAME 1
1316 #define TRANSLATE_KEYNAME_TO_KEYSYM 2
1317 #define TRANSLATE_X11KEYNAME_TO_KEYSYM 3
1319 void translate_keyname(Key *keysym, char **x11name, char **name, int mode)
1328 /* normal cursor keys */
1329 { KSYM_Left, "XK_Left", "cursor left" },
1330 { KSYM_Right, "XK_Right", "cursor right" },
1331 { KSYM_Up, "XK_Up", "cursor up" },
1332 { KSYM_Down, "XK_Down", "cursor down" },
1334 /* keypad cursor keys */
1336 { KSYM_KP_Left, "XK_KP_Left", "keypad left" },
1337 { KSYM_KP_Right, "XK_KP_Right", "keypad right" },
1338 { KSYM_KP_Up, "XK_KP_Up", "keypad up" },
1339 { KSYM_KP_Down, "XK_KP_Down", "keypad down" },
1342 /* other keypad keys */
1343 #ifdef KSYM_KP_Enter
1344 { KSYM_KP_Enter, "XK_KP_Enter", "keypad enter" },
1345 { KSYM_KP_Add, "XK_KP_Add", "keypad +" },
1346 { KSYM_KP_Subtract, "XK_KP_Subtract", "keypad -" },
1347 { KSYM_KP_Multiply, "XK_KP_Multiply", "keypad mltply" },
1348 { KSYM_KP_Divide, "XK_KP_Divide", "keypad /" },
1349 { KSYM_KP_Separator,"XK_KP_Separator", "keypad ," },
1353 { KSYM_Shift_L, "XK_Shift_L", "left shift" },
1354 { KSYM_Shift_R, "XK_Shift_R", "right shift" },
1355 { KSYM_Control_L, "XK_Control_L", "left control" },
1356 { KSYM_Control_R, "XK_Control_R", "right control" },
1357 { KSYM_Meta_L, "XK_Meta_L", "left meta" },
1358 { KSYM_Meta_R, "XK_Meta_R", "right meta" },
1359 { KSYM_Alt_L, "XK_Alt_L", "left alt" },
1360 { KSYM_Alt_R, "XK_Alt_R", "right alt" },
1361 #if !defined(TARGET_SDL2)
1362 { KSYM_Super_L, "XK_Super_L", "left super" }, /* Win-L */
1363 { KSYM_Super_R, "XK_Super_R", "right super" }, /* Win-R */
1365 { KSYM_Mode_switch, "XK_Mode_switch", "mode switch" }, /* Alt-R */
1366 { KSYM_Multi_key, "XK_Multi_key", "multi key" }, /* Ctrl-R */
1368 /* some special keys */
1369 { KSYM_BackSpace, "XK_BackSpace", "backspace" },
1370 { KSYM_Delete, "XK_Delete", "delete" },
1371 { KSYM_Insert, "XK_Insert", "insert" },
1372 { KSYM_Tab, "XK_Tab", "tab" },
1373 { KSYM_Home, "XK_Home", "home" },
1374 { KSYM_End, "XK_End", "end" },
1375 { KSYM_Page_Up, "XK_Page_Up", "page up" },
1376 { KSYM_Page_Down, "XK_Page_Down", "page down" },
1378 #if defined(TARGET_SDL2)
1379 { KSYM_Menu, "XK_Menu", "menu" }, /* menu key */
1380 { KSYM_Back, "XK_Back", "back" }, /* back key */
1383 /* ASCII 0x20 to 0x40 keys (except numbers) */
1384 { KSYM_space, "XK_space", "space" },
1385 { KSYM_exclam, "XK_exclam", "!" },
1386 { KSYM_quotedbl, "XK_quotedbl", "\"" },
1387 { KSYM_numbersign, "XK_numbersign", "#" },
1388 { KSYM_dollar, "XK_dollar", "$" },
1389 { KSYM_percent, "XK_percent", "%" },
1390 { KSYM_ampersand, "XK_ampersand", "&" },
1391 { KSYM_apostrophe, "XK_apostrophe", "'" },
1392 { KSYM_parenleft, "XK_parenleft", "(" },
1393 { KSYM_parenright, "XK_parenright", ")" },
1394 { KSYM_asterisk, "XK_asterisk", "*" },
1395 { KSYM_plus, "XK_plus", "+" },
1396 { KSYM_comma, "XK_comma", "," },
1397 { KSYM_minus, "XK_minus", "-" },
1398 { KSYM_period, "XK_period", "." },
1399 { KSYM_slash, "XK_slash", "/" },
1400 { KSYM_colon, "XK_colon", ":" },
1401 { KSYM_semicolon, "XK_semicolon", ";" },
1402 { KSYM_less, "XK_less", "<" },
1403 { KSYM_equal, "XK_equal", "=" },
1404 { KSYM_greater, "XK_greater", ">" },
1405 { KSYM_question, "XK_question", "?" },
1406 { KSYM_at, "XK_at", "@" },
1408 /* more ASCII keys */
1409 { KSYM_bracketleft, "XK_bracketleft", "[" },
1410 { KSYM_backslash, "XK_backslash", "\\" },
1411 { KSYM_bracketright,"XK_bracketright", "]" },
1412 { KSYM_asciicircum, "XK_asciicircum", "^" },
1413 { KSYM_underscore, "XK_underscore", "_" },
1414 { KSYM_grave, "XK_grave", "grave" },
1415 { KSYM_quoteleft, "XK_quoteleft", "quote left" },
1416 { KSYM_braceleft, "XK_braceleft", "brace left" },
1417 { KSYM_bar, "XK_bar", "bar" },
1418 { KSYM_braceright, "XK_braceright", "brace right" },
1419 { KSYM_asciitilde, "XK_asciitilde", "~" },
1421 /* special (non-ASCII) keys (ISO-Latin-1) */
1422 { KSYM_degree, "XK_degree", "°" },
1423 { KSYM_Adiaeresis, "XK_Adiaeresis", "Ä" },
1424 { KSYM_Odiaeresis, "XK_Odiaeresis", "Ö" },
1425 { KSYM_Udiaeresis, "XK_Udiaeresis", "Ü" },
1426 { KSYM_adiaeresis, "XK_adiaeresis", "ä" },
1427 { KSYM_odiaeresis, "XK_odiaeresis", "ö" },
1428 { KSYM_udiaeresis, "XK_udiaeresis", "ü" },
1429 { KSYM_ssharp, "XK_ssharp", "sharp s" },
1431 #if defined(TARGET_SDL2)
1432 /* special (non-ASCII) keys (UTF-8, for reverse mapping only) */
1433 { KSYM_degree, "XK_degree", "\xc2\xb0" },
1434 { KSYM_Adiaeresis, "XK_Adiaeresis", "\xc3\x84" },
1435 { KSYM_Odiaeresis, "XK_Odiaeresis", "\xc3\x96" },
1436 { KSYM_Udiaeresis, "XK_Udiaeresis", "\xc3\x9c" },
1437 { KSYM_adiaeresis, "XK_adiaeresis", "\xc3\xa4" },
1438 { KSYM_odiaeresis, "XK_odiaeresis", "\xc3\xb6" },
1439 { KSYM_udiaeresis, "XK_udiaeresis", "\xc3\xbc" },
1440 { KSYM_ssharp, "XK_ssharp", "\xc3\x9f" },
1442 /* other keys (for reverse mapping only) */
1443 { KSYM_space, "XK_space", " " },
1446 #if defined(TARGET_SDL2)
1447 /* keypad keys are not in numerical order in SDL2 */
1448 { KSYM_KP_0, "XK_KP_0", "keypad 0" },
1449 { KSYM_KP_1, "XK_KP_1", "keypad 1" },
1450 { KSYM_KP_2, "XK_KP_2", "keypad 2" },
1451 { KSYM_KP_3, "XK_KP_3", "keypad 3" },
1452 { KSYM_KP_4, "XK_KP_4", "keypad 4" },
1453 { KSYM_KP_5, "XK_KP_5", "keypad 5" },
1454 { KSYM_KP_6, "XK_KP_6", "keypad 6" },
1455 { KSYM_KP_7, "XK_KP_7", "keypad 7" },
1456 { KSYM_KP_8, "XK_KP_8", "keypad 8" },
1457 { KSYM_KP_9, "XK_KP_9", "keypad 9" },
1460 /* end-of-array identifier */
1466 if (mode == TRANSLATE_KEYSYM_TO_KEYNAME)
1468 static char name_buffer[30];
1471 if (key >= KSYM_A && key <= KSYM_Z)
1472 sprintf(name_buffer, "%c", 'A' + (char)(key - KSYM_A));
1473 else if (key >= KSYM_a && key <= KSYM_z)
1474 sprintf(name_buffer, "%c", 'a' + (char)(key - KSYM_a));
1475 else if (key >= KSYM_0 && key <= KSYM_9)
1476 sprintf(name_buffer, "%c", '0' + (char)(key - KSYM_0));
1477 #if !defined(TARGET_SDL2)
1478 else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
1479 sprintf(name_buffer, "keypad %c", '0' + (char)(key - KSYM_KP_0));
1481 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1482 sprintf(name_buffer, "F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1483 else if (key == KSYM_UNDEFINED)
1484 strcpy(name_buffer, "(undefined)");
1491 if (key == translate_key[i].key)
1493 strcpy(name_buffer, translate_key[i].name);
1497 while (translate_key[++i].name);
1499 if (!translate_key[i].name)
1500 strcpy(name_buffer, "(unknown)");
1503 *name = name_buffer;
1505 else if (mode == TRANSLATE_KEYSYM_TO_X11KEYNAME)
1507 static char name_buffer[30];
1510 if (key >= KSYM_A && key <= KSYM_Z)
1511 sprintf(name_buffer, "XK_%c", 'A' + (char)(key - KSYM_A));
1512 else if (key >= KSYM_a && key <= KSYM_z)
1513 sprintf(name_buffer, "XK_%c", 'a' + (char)(key - KSYM_a));
1514 else if (key >= KSYM_0 && key <= KSYM_9)
1515 sprintf(name_buffer, "XK_%c", '0' + (char)(key - KSYM_0));
1516 #if !defined(TARGET_SDL2)
1517 else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
1518 sprintf(name_buffer, "XK_KP_%c", '0' + (char)(key - KSYM_KP_0));
1520 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1521 sprintf(name_buffer, "XK_F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1522 else if (key == KSYM_UNDEFINED)
1523 strcpy(name_buffer, "[undefined]");
1530 if (key == translate_key[i].key)
1532 strcpy(name_buffer, translate_key[i].x11name);
1536 while (translate_key[++i].x11name);
1538 if (!translate_key[i].x11name)
1539 sprintf(name_buffer, "0x%04x", (unsigned int)key);
1542 *x11name = name_buffer;
1544 else if (mode == TRANSLATE_KEYNAME_TO_KEYSYM)
1546 Key key = KSYM_UNDEFINED;
1547 char *name_ptr = *name;
1549 if (strlen(*name) == 1)
1551 char c = name_ptr[0];
1553 if (c >= 'A' && c <= 'Z')
1554 key = KSYM_A + (Key)(c - 'A');
1555 else if (c >= 'a' && c <= 'z')
1556 key = KSYM_a + (Key)(c - 'a');
1557 else if (c >= '0' && c <= '9')
1558 key = KSYM_0 + (Key)(c - '0');
1561 if (key == KSYM_UNDEFINED)
1567 if (strEqual(translate_key[i].name, *name))
1569 key = translate_key[i].key;
1573 while (translate_key[++i].x11name);
1576 if (key == KSYM_UNDEFINED)
1577 Error(ERR_WARN, "getKeyFromKeyName(): not completely implemented");
1581 else if (mode == TRANSLATE_X11KEYNAME_TO_KEYSYM)
1583 Key key = KSYM_UNDEFINED;
1584 char *name_ptr = *x11name;
1586 if (strPrefix(name_ptr, "XK_") && strlen(name_ptr) == 4)
1588 char c = name_ptr[3];
1590 if (c >= 'A' && c <= 'Z')
1591 key = KSYM_A + (Key)(c - 'A');
1592 else if (c >= 'a' && c <= 'z')
1593 key = KSYM_a + (Key)(c - 'a');
1594 else if (c >= '0' && c <= '9')
1595 key = KSYM_0 + (Key)(c - '0');
1597 #if !defined(TARGET_SDL2)
1598 else if (strPrefix(name_ptr, "XK_KP_") && strlen(name_ptr) == 7)
1600 char c = name_ptr[6];
1602 if (c >= '0' && c <= '9')
1603 key = KSYM_KP_0 + (Key)(c - '0');
1606 else if (strPrefix(name_ptr, "XK_F") && strlen(name_ptr) <= 6)
1608 char c1 = name_ptr[4];
1609 char c2 = name_ptr[5];
1612 if ((c1 >= '0' && c1 <= '9') &&
1613 ((c2 >= '0' && c1 <= '9') || c2 == '\0'))
1614 d = atoi(&name_ptr[4]);
1616 if (d >= 1 && d <= KSYM_NUM_FKEYS)
1617 key = KSYM_F1 + (Key)(d - 1);
1619 else if (strPrefix(name_ptr, "XK_"))
1625 if (strEqual(name_ptr, translate_key[i].x11name))
1627 key = translate_key[i].key;
1631 while (translate_key[++i].x11name);
1633 else if (strPrefix(name_ptr, "0x"))
1635 unsigned int value = 0;
1641 char c = *name_ptr++;
1644 if (c >= '0' && c <= '9')
1646 else if (c >= 'a' && c <= 'f')
1647 d = (int)(c - 'a' + 10);
1648 else if (c >= 'A' && c <= 'F')
1649 d = (int)(c - 'A' + 10);
1657 value = value * 16 + d;
1668 char *getKeyNameFromKey(Key key)
1672 translate_keyname(&key, NULL, &name, TRANSLATE_KEYSYM_TO_KEYNAME);
1676 char *getX11KeyNameFromKey(Key key)
1680 translate_keyname(&key, &x11name, NULL, TRANSLATE_KEYSYM_TO_X11KEYNAME);
1684 Key getKeyFromKeyName(char *name)
1688 translate_keyname(&key, NULL, &name, TRANSLATE_KEYNAME_TO_KEYSYM);
1692 Key getKeyFromX11KeyName(char *x11name)
1696 translate_keyname(&key, &x11name, NULL, TRANSLATE_X11KEYNAME_TO_KEYSYM);
1700 char getCharFromKey(Key key)
1702 char *keyname = getKeyNameFromKey(key);
1705 if (strlen(keyname) == 1)
1707 else if (strEqual(keyname, "space"))
1713 char getValidConfigValueChar(char c)
1715 if (c == '#' || /* used to mark comments */
1716 c == '\\') /* used to mark continued lines */
1723 /* ------------------------------------------------------------------------- */
1724 /* functions to translate string identifiers to integer or boolean value */
1725 /* ------------------------------------------------------------------------- */
1727 int get_integer_from_string(char *s)
1729 static char *number_text[][3] =
1731 { "0", "zero", "null", },
1732 { "1", "one", "first" },
1733 { "2", "two", "second" },
1734 { "3", "three", "third" },
1735 { "4", "four", "fourth" },
1736 { "5", "five", "fifth" },
1737 { "6", "six", "sixth" },
1738 { "7", "seven", "seventh" },
1739 { "8", "eight", "eighth" },
1740 { "9", "nine", "ninth" },
1741 { "10", "ten", "tenth" },
1742 { "11", "eleven", "eleventh" },
1743 { "12", "twelve", "twelfth" },
1745 { NULL, NULL, NULL },
1749 char *s_lower = getStringToLower(s);
1752 for (i = 0; number_text[i][0] != NULL; i++)
1753 for (j = 0; j < 3; j++)
1754 if (strEqual(s_lower, number_text[i][j]))
1759 if (strEqual(s_lower, "false") ||
1760 strEqual(s_lower, "no") ||
1761 strEqual(s_lower, "off"))
1763 else if (strEqual(s_lower, "true") ||
1764 strEqual(s_lower, "yes") ||
1765 strEqual(s_lower, "on"))
1776 boolean get_boolean_from_string(char *s)
1778 char *s_lower = getStringToLower(s);
1779 boolean result = FALSE;
1781 if (strEqual(s_lower, "true") ||
1782 strEqual(s_lower, "yes") ||
1783 strEqual(s_lower, "on") ||
1784 get_integer_from_string(s) == 1)
1792 int get_switch3_from_string(char *s)
1794 char *s_lower = getStringToLower(s);
1797 if (strEqual(s_lower, "true") ||
1798 strEqual(s_lower, "yes") ||
1799 strEqual(s_lower, "on") ||
1800 get_integer_from_string(s) == 1)
1802 else if (strEqual(s_lower, "auto"))
1811 /* ------------------------------------------------------------------------- */
1812 /* functions for generic lists */
1813 /* ------------------------------------------------------------------------- */
1815 ListNode *newListNode()
1817 return checked_calloc(sizeof(ListNode));
1820 void addNodeToList(ListNode **node_first, char *key, void *content)
1822 ListNode *node_new = newListNode();
1824 node_new->key = getStringCopy(key);
1825 node_new->content = content;
1826 node_new->next = *node_first;
1827 *node_first = node_new;
1830 void deleteNodeFromList(ListNode **node_first, char *key,
1831 void (*destructor_function)(void *))
1833 if (node_first == NULL || *node_first == NULL)
1836 if (strEqual((*node_first)->key, key))
1838 checked_free((*node_first)->key);
1839 if (destructor_function)
1840 destructor_function((*node_first)->content);
1841 *node_first = (*node_first)->next;
1844 deleteNodeFromList(&(*node_first)->next, key, destructor_function);
1847 ListNode *getNodeFromKey(ListNode *node_first, char *key)
1849 if (node_first == NULL)
1852 if (strEqual(node_first->key, key))
1855 return getNodeFromKey(node_first->next, key);
1858 int getNumNodes(ListNode *node_first)
1860 return (node_first ? 1 + getNumNodes(node_first->next) : 0);
1863 void dumpList(ListNode *node_first)
1865 ListNode *node = node_first;
1869 printf("['%s' (%d)]\n", node->key,
1870 ((struct ListNodeInfo *)node->content)->num_references);
1874 printf("[%d nodes]\n", getNumNodes(node_first));
1878 /* ------------------------------------------------------------------------- */
1879 /* functions for file handling */
1880 /* ------------------------------------------------------------------------- */
1882 File *openFile(char *filename, char *mode)
1884 File *file = checked_calloc(sizeof(File));
1886 file->file = fopen(filename, mode);
1888 if (file->file != NULL)
1890 file->filename = getStringCopy(filename);
1895 #if defined(PLATFORM_ANDROID)
1896 file->asset_file = SDL_RWFromFile(filename, mode);
1898 if (file->asset_file != NULL)
1900 file->file_is_asset = TRUE;
1901 file->filename = getStringCopy(filename);
1912 int closeFile(File *file)
1919 #if defined(PLATFORM_ANDROID)
1920 if (file->asset_file)
1921 result = SDL_RWclose(file->asset_file);
1925 result = fclose(file->file);
1927 checked_free(file->filename);
1933 int checkEndOfFile(File *file)
1935 #if defined(PLATFORM_ANDROID)
1936 if (file->file_is_asset)
1937 return file->end_of_file;
1940 return feof(file->file);
1943 size_t readFile(File *file, void *buffer, size_t item_size, size_t num_items)
1945 #if defined(PLATFORM_ANDROID)
1946 if (file->file_is_asset)
1948 if (file->end_of_file)
1951 size_t num_items_read =
1952 SDL_RWread(file->asset_file, buffer, item_size, num_items);
1954 if (num_items_read < num_items)
1955 file->end_of_file = TRUE;
1957 return num_items_read;
1961 return fread(buffer, item_size, num_items, file->file);
1964 int seekFile(File *file, long offset, int whence)
1966 #if defined(PLATFORM_ANDROID)
1967 if (file->file_is_asset)
1969 int sdl_whence = (whence == SEEK_SET ? RW_SEEK_SET :
1970 whence == SEEK_CUR ? RW_SEEK_CUR :
1971 whence == SEEK_END ? RW_SEEK_END : 0);
1973 return (SDL_RWseek(file->asset_file, offset, sdl_whence) == -1 ? -1 : 0);
1977 return fseek(file->file, offset, whence);
1980 int getByteFromFile(File *file)
1982 #if defined(PLATFORM_ANDROID)
1983 if (file->file_is_asset)
1985 if (file->end_of_file)
1989 size_t num_bytes_read = SDL_RWread(file->asset_file, &c, 1, 1);
1991 if (num_bytes_read < 1)
1992 file->end_of_file = TRUE;
1994 return (file->end_of_file ? EOF : (int)c);
1998 return fgetc(file->file);
2001 char *getStringFromFile(File *file, char *line, int size)
2003 #if defined(PLATFORM_ANDROID)
2004 if (file->file_is_asset)
2006 if (file->end_of_file)
2009 char *line_ptr = line;
2010 int num_bytes_read = 0;
2012 while (num_bytes_read < size - 1 &&
2013 SDL_RWread(file->asset_file, line_ptr, 1, 1) == 1 &&
2014 *line_ptr++ != '\n')
2019 if (strlen(line) == 0)
2021 file->end_of_file = TRUE;
2030 return fgets(line, size, file->file);
2034 /* ------------------------------------------------------------------------- */
2035 /* functions for directory handling */
2036 /* ------------------------------------------------------------------------- */
2038 Directory *openDirectory(char *dir_name)
2040 Directory *dir = checked_calloc(sizeof(Directory));
2042 dir->dir = opendir(dir_name);
2044 if (dir->dir != NULL)
2046 dir->filename = getStringCopy(dir_name);
2051 #if defined(PLATFORM_ANDROID)
2052 char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
2054 dir->asset_toc_file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
2056 checked_free(asset_toc_filename);
2058 if (dir->asset_toc_file != NULL)
2060 dir->directory_is_asset = TRUE;
2061 dir->filename = getStringCopy(dir_name);
2072 int closeDirectory(Directory *dir)
2079 #if defined(PLATFORM_ANDROID)
2080 if (dir->asset_toc_file)
2081 result = SDL_RWclose(dir->asset_toc_file);
2085 result = closedir(dir->dir);
2088 freeDirectoryEntry(dir->dir_entry);
2090 checked_free(dir->filename);
2096 DirectoryEntry *readDirectory(Directory *dir)
2099 freeDirectoryEntry(dir->dir_entry);
2101 dir->dir_entry = NULL;
2103 #if defined(PLATFORM_ANDROID)
2104 if (dir->directory_is_asset)
2106 char line[MAX_LINE_LEN];
2107 char *line_ptr = line;
2108 int num_bytes_read = 0;
2110 while (num_bytes_read < MAX_LINE_LEN - 1 &&
2111 SDL_RWread(dir->asset_toc_file, line_ptr, 1, 1) == 1 &&
2120 if (strlen(line) == 0)
2123 dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
2125 dir->dir_entry->is_directory = FALSE;
2126 if (line[strlen(line) - 1] == '/')
2128 dir->dir_entry->is_directory = TRUE;
2130 line[strlen(line) - 1] = '\0';
2133 dir->dir_entry->basename = getStringCopy(line);
2134 dir->dir_entry->filename = getPath2(dir->filename, line);
2136 return dir->dir_entry;
2140 struct dirent *dir_entry = readdir(dir->dir);
2142 if (dir_entry == NULL)
2145 dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
2147 dir->dir_entry->basename = getStringCopy(dir_entry->d_name);
2148 dir->dir_entry->filename = getPath2(dir->filename, dir_entry->d_name);
2150 struct stat file_status;
2152 dir->dir_entry->is_directory =
2153 (stat(dir->dir_entry->filename, &file_status) == 0 &&
2154 (file_status.st_mode & S_IFMT) == S_IFDIR);
2156 return dir->dir_entry;
2159 void freeDirectoryEntry(DirectoryEntry *dir_entry)
2161 if (dir_entry == NULL)
2164 checked_free(dir_entry->basename);
2165 checked_free(dir_entry->filename);
2166 checked_free(dir_entry);
2170 /* ------------------------------------------------------------------------- */
2171 /* functions for checking files and filenames */
2172 /* ------------------------------------------------------------------------- */
2174 boolean directoryExists(char *dir_name)
2176 if (dir_name == NULL)
2179 boolean success = (access(dir_name, F_OK) == 0);
2181 #if defined(PLATFORM_ANDROID)
2184 // this might be an asset directory; check by trying to open toc file
2185 char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
2186 SDL_RWops *file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
2188 checked_free(asset_toc_filename);
2190 success = (file != NULL);
2200 boolean fileExists(char *filename)
2202 if (filename == NULL)
2205 boolean success = (access(filename, F_OK) == 0);
2207 #if defined(PLATFORM_ANDROID)
2210 // this might be an asset file; check by trying to open it
2211 SDL_RWops *file = SDL_RWFromFile(filename, MODE_READ);
2213 success = (file != NULL);
2223 boolean fileHasPrefix(char *basename, char *prefix)
2225 static char *basename_lower = NULL;
2226 int basename_length, prefix_length;
2228 checked_free(basename_lower);
2230 if (basename == NULL || prefix == NULL)
2233 basename_lower = getStringToLower(basename);
2234 basename_length = strlen(basename_lower);
2235 prefix_length = strlen(prefix);
2237 if (basename_length > prefix_length + 1 &&
2238 basename_lower[prefix_length] == '.' &&
2239 strncmp(basename_lower, prefix, prefix_length) == 0)
2245 boolean fileHasSuffix(char *basename, char *suffix)
2247 static char *basename_lower = NULL;
2248 int basename_length, suffix_length;
2250 checked_free(basename_lower);
2252 if (basename == NULL || suffix == NULL)
2255 basename_lower = getStringToLower(basename);
2256 basename_length = strlen(basename_lower);
2257 suffix_length = strlen(suffix);
2259 if (basename_length > suffix_length + 1 &&
2260 basename_lower[basename_length - suffix_length - 1] == '.' &&
2261 strEqual(&basename_lower[basename_length - suffix_length], suffix))
2267 static boolean FileCouldBeArtwork(char *basename)
2269 return (!strEqual(basename, ".") &&
2270 !strEqual(basename, "..") &&
2271 !fileHasSuffix(basename, "txt") &&
2272 !fileHasSuffix(basename, "conf"));
2275 boolean FileIsGraphic(char *filename)
2277 char *basename = getBaseNamePtr(filename);
2279 return FileCouldBeArtwork(basename);
2282 boolean FileIsSound(char *filename)
2284 char *basename = getBaseNamePtr(filename);
2286 return FileCouldBeArtwork(basename);
2289 boolean FileIsMusic(char *filename)
2291 char *basename = getBaseNamePtr(filename);
2293 return FileCouldBeArtwork(basename);
2296 boolean FileIsArtworkType(char *basename, int type)
2298 if ((type == TREE_TYPE_GRAPHICS_DIR && FileIsGraphic(basename)) ||
2299 (type == TREE_TYPE_SOUNDS_DIR && FileIsSound(basename)) ||
2300 (type == TREE_TYPE_MUSIC_DIR && FileIsMusic(basename)))
2306 /* ------------------------------------------------------------------------- */
2307 /* functions for loading artwork configuration information */
2308 /* ------------------------------------------------------------------------- */
2310 char *get_mapped_token(char *token)
2312 /* !!! make this dynamically configurable (init.c:InitArtworkConfig) !!! */
2313 static char *map_token_prefix[][2] =
2315 { "char_procent", "char_percent" },
2320 for (i = 0; map_token_prefix[i][0] != NULL; i++)
2322 int len_token_prefix = strlen(map_token_prefix[i][0]);
2324 if (strncmp(token, map_token_prefix[i][0], len_token_prefix) == 0)
2325 return getStringCat2(map_token_prefix[i][1], &token[len_token_prefix]);
2331 /* This function checks if a string <s> of the format "string1, string2, ..."
2332 exactly contains a string <s_contained>. */
2334 static boolean string_has_parameter(char *s, char *s_contained)
2338 if (s == NULL || s_contained == NULL)
2341 if (strlen(s_contained) > strlen(s))
2344 if (strncmp(s, s_contained, strlen(s_contained)) == 0)
2346 char next_char = s[strlen(s_contained)];
2348 /* check if next character is delimiter or whitespace */
2349 return (next_char == ',' || next_char == '\0' ||
2350 next_char == ' ' || next_char == '\t' ? TRUE : FALSE);
2353 /* check if string contains another parameter string after a comma */
2354 substring = strchr(s, ',');
2355 if (substring == NULL) /* string does not contain a comma */
2358 /* advance string pointer to next character after the comma */
2361 /* skip potential whitespaces after the comma */
2362 while (*substring == ' ' || *substring == '\t')
2365 return string_has_parameter(substring, s_contained);
2368 int get_parameter_value(char *value_raw, char *suffix, int type)
2370 char *value = getStringToLower(value_raw);
2371 int result = 0; /* probably a save default value */
2373 if (strEqual(suffix, ".direction"))
2375 result = (strEqual(value, "left") ? MV_LEFT :
2376 strEqual(value, "right") ? MV_RIGHT :
2377 strEqual(value, "up") ? MV_UP :
2378 strEqual(value, "down") ? MV_DOWN : MV_NONE);
2380 else if (strEqual(suffix, ".align"))
2382 result = (strEqual(value, "left") ? ALIGN_LEFT :
2383 strEqual(value, "right") ? ALIGN_RIGHT :
2384 strEqual(value, "center") ? ALIGN_CENTER :
2385 strEqual(value, "middle") ? ALIGN_CENTER : ALIGN_DEFAULT);
2387 else if (strEqual(suffix, ".valign"))
2389 result = (strEqual(value, "top") ? VALIGN_TOP :
2390 strEqual(value, "bottom") ? VALIGN_BOTTOM :
2391 strEqual(value, "middle") ? VALIGN_MIDDLE :
2392 strEqual(value, "center") ? VALIGN_MIDDLE : VALIGN_DEFAULT);
2394 else if (strEqual(suffix, ".anim_mode"))
2396 result = (string_has_parameter(value, "none") ? ANIM_NONE :
2397 string_has_parameter(value, "loop") ? ANIM_LOOP :
2398 string_has_parameter(value, "linear") ? ANIM_LINEAR :
2399 string_has_parameter(value, "pingpong") ? ANIM_PINGPONG :
2400 string_has_parameter(value, "pingpong2") ? ANIM_PINGPONG2 :
2401 string_has_parameter(value, "random") ? ANIM_RANDOM :
2402 string_has_parameter(value, "ce_value") ? ANIM_CE_VALUE :
2403 string_has_parameter(value, "ce_score") ? ANIM_CE_SCORE :
2404 string_has_parameter(value, "ce_delay") ? ANIM_CE_DELAY :
2405 string_has_parameter(value, "horizontal") ? ANIM_HORIZONTAL :
2406 string_has_parameter(value, "vertical") ? ANIM_VERTICAL :
2407 string_has_parameter(value, "centered") ? ANIM_CENTERED :
2410 if (string_has_parameter(value, "reverse"))
2411 result |= ANIM_REVERSE;
2413 if (string_has_parameter(value, "opaque_player"))
2414 result |= ANIM_OPAQUE_PLAYER;
2416 if (string_has_parameter(value, "static_panel"))
2417 result |= ANIM_STATIC_PANEL;
2419 else if (strEqual(suffix, ".class"))
2421 result = get_hash_from_key(value);
2423 else if (strEqual(suffix, ".style"))
2425 result = STYLE_DEFAULT;
2427 if (string_has_parameter(value, "accurate_borders"))
2428 result |= STYLE_ACCURATE_BORDERS;
2430 if (string_has_parameter(value, "inner_corners"))
2431 result |= STYLE_INNER_CORNERS;
2433 else if (strEqual(suffix, ".fade_mode"))
2435 result = (string_has_parameter(value, "none") ? FADE_MODE_NONE :
2436 string_has_parameter(value, "fade") ? FADE_MODE_FADE :
2437 string_has_parameter(value, "crossfade") ? FADE_MODE_CROSSFADE :
2438 string_has_parameter(value, "melt") ? FADE_MODE_MELT :
2441 else if (strPrefix(suffix, ".font")) /* (may also be ".font_xyz") */
2443 result = gfx.get_font_from_token_function(value);
2445 else /* generic parameter of type integer or boolean */
2447 result = (strEqual(value, ARG_UNDEFINED) ? ARG_UNDEFINED_VALUE :
2448 type == TYPE_INTEGER ? get_integer_from_string(value) :
2449 type == TYPE_BOOLEAN ? get_boolean_from_string(value) :
2450 ARG_UNDEFINED_VALUE);
2458 struct ScreenModeInfo *get_screen_mode_from_string(char *screen_mode_string)
2460 static struct ScreenModeInfo screen_mode;
2461 char *screen_mode_string_x = strchr(screen_mode_string, 'x');
2462 char *screen_mode_string_copy;
2463 char *screen_mode_string_pos_w;
2464 char *screen_mode_string_pos_h;
2466 if (screen_mode_string_x == NULL) /* invalid screen mode format */
2469 screen_mode_string_copy = getStringCopy(screen_mode_string);
2471 screen_mode_string_pos_w = screen_mode_string_copy;
2472 screen_mode_string_pos_h = strchr(screen_mode_string_copy, 'x');
2473 *screen_mode_string_pos_h++ = '\0';
2475 screen_mode.width = atoi(screen_mode_string_pos_w);
2476 screen_mode.height = atoi(screen_mode_string_pos_h);
2478 return &screen_mode;
2481 void get_aspect_ratio_from_screen_mode(struct ScreenModeInfo *screen_mode,
2484 float aspect_ratio = (float)screen_mode->width / (float)screen_mode->height;
2485 float aspect_ratio_new;
2490 *x = i * aspect_ratio + 0.000001;
2493 aspect_ratio_new = (float)*x / (float)*y;
2497 while (aspect_ratio_new != aspect_ratio && *y < screen_mode->height);
2500 static void FreeCustomArtworkList(struct ArtworkListInfo *,
2501 struct ListNodeInfo ***, int *);
2503 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list,
2504 struct ConfigTypeInfo *suffix_list,
2505 char **ignore_tokens,
2506 int num_file_list_entries)
2508 struct FileInfo *file_list;
2509 int num_file_list_entries_found = 0;
2510 int num_suffix_list_entries = 0;
2514 file_list = checked_calloc(num_file_list_entries * sizeof(struct FileInfo));
2516 for (i = 0; suffix_list[i].token != NULL; i++)
2517 num_suffix_list_entries++;
2519 /* always start with reliable default values */
2520 for (i = 0; i < num_file_list_entries; i++)
2522 file_list[i].token = NULL;
2524 file_list[i].default_filename = NULL;
2525 file_list[i].filename = NULL;
2527 if (num_suffix_list_entries > 0)
2529 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
2531 file_list[i].default_parameter = checked_calloc(parameter_array_size);
2532 file_list[i].parameter = checked_calloc(parameter_array_size);
2534 for (j = 0; j < num_suffix_list_entries; j++)
2536 setString(&file_list[i].default_parameter[j], suffix_list[j].value);
2537 setString(&file_list[i].parameter[j], suffix_list[j].value);
2540 file_list[i].redefined = FALSE;
2541 file_list[i].fallback_to_default = FALSE;
2542 file_list[i].default_is_cloned = FALSE;
2548 for (i = 0; config_list[i].token != NULL; i++)
2550 int len_config_token = strlen(config_list[i].token);
2551 boolean is_file_entry = TRUE;
2553 for (j = 0; suffix_list[j].token != NULL; j++)
2555 int len_suffix = strlen(suffix_list[j].token);
2557 if (len_suffix < len_config_token &&
2558 strEqual(&config_list[i].token[len_config_token - len_suffix],
2559 suffix_list[j].token))
2561 setString(&file_list[list_pos].default_parameter[j],
2562 config_list[i].value);
2564 is_file_entry = FALSE;
2570 /* the following tokens are no file definitions, but other config tokens */
2571 for (j = 0; ignore_tokens[j] != NULL; j++)
2572 if (strEqual(config_list[i].token, ignore_tokens[j]))
2573 is_file_entry = FALSE;
2580 if (list_pos >= num_file_list_entries)
2583 file_list[list_pos].token = config_list[i].token;
2584 file_list[list_pos].default_filename = config_list[i].value;
2587 if (strSuffix(config_list[i].token, ".clone_from"))
2588 file_list[list_pos].default_is_cloned = TRUE;
2591 num_file_list_entries_found = list_pos + 1;
2592 if (num_file_list_entries_found != num_file_list_entries)
2594 Error(ERR_INFO_LINE, "-");
2595 Error(ERR_INFO, "inconsistant config list information:");
2596 Error(ERR_INFO, "- should be: %d (according to 'src/conf_xxx.h')",
2597 num_file_list_entries);
2598 Error(ERR_INFO, "- found to be: %d (according to 'src/conf_xxx.c')",
2599 num_file_list_entries_found);
2600 Error(ERR_EXIT, "please fix");
2606 static boolean token_suffix_match(char *token, char *suffix, int start_pos)
2608 int len_token = strlen(token);
2609 int len_suffix = strlen(suffix);
2611 if (start_pos < 0) /* compare suffix from end of string */
2612 start_pos += len_token;
2614 if (start_pos < 0 || start_pos + len_suffix > len_token)
2617 if (strncmp(&token[start_pos], suffix, len_suffix) != 0)
2620 if (token[start_pos + len_suffix] == '\0')
2623 if (token[start_pos + len_suffix] == '.')
2629 #define KNOWN_TOKEN_VALUE "[KNOWN_TOKEN_VALUE]"
2631 static void read_token_parameters(SetupFileHash *setup_file_hash,
2632 struct ConfigTypeInfo *suffix_list,
2633 struct FileInfo *file_list_entry)
2635 /* check for config token that is the base token without any suffixes */
2636 char *filename = getHashEntry(setup_file_hash, file_list_entry->token);
2637 char *known_token_value = KNOWN_TOKEN_VALUE;
2640 if (filename != NULL)
2642 setString(&file_list_entry->filename, filename);
2644 /* when file definition found, set all parameters to default values */
2645 for (i = 0; suffix_list[i].token != NULL; i++)
2646 setString(&file_list_entry->parameter[i], suffix_list[i].value);
2648 file_list_entry->redefined = TRUE;
2650 /* mark config file token as well known from default config */
2651 setHashEntry(setup_file_hash, file_list_entry->token, known_token_value);
2654 /* check for config tokens that can be build by base token and suffixes */
2655 for (i = 0; suffix_list[i].token != NULL; i++)
2657 char *token = getStringCat2(file_list_entry->token, suffix_list[i].token);
2658 char *value = getHashEntry(setup_file_hash, token);
2662 setString(&file_list_entry->parameter[i], value);
2664 /* mark config file token as well known from default config */
2665 setHashEntry(setup_file_hash, token, known_token_value);
2672 static void add_dynamic_file_list_entry(struct FileInfo **list,
2673 int *num_list_entries,
2674 SetupFileHash *extra_file_hash,
2675 struct ConfigTypeInfo *suffix_list,
2676 int num_suffix_list_entries,
2679 struct FileInfo *new_list_entry;
2680 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
2682 (*num_list_entries)++;
2683 *list = checked_realloc(*list, *num_list_entries * sizeof(struct FileInfo));
2684 new_list_entry = &(*list)[*num_list_entries - 1];
2686 new_list_entry->token = getStringCopy(token);
2687 new_list_entry->default_filename = NULL;
2688 new_list_entry->filename = NULL;
2689 new_list_entry->parameter = checked_calloc(parameter_array_size);
2691 new_list_entry->redefined = FALSE;
2692 new_list_entry->fallback_to_default = FALSE;
2693 new_list_entry->default_is_cloned = FALSE;
2695 read_token_parameters(extra_file_hash, suffix_list, new_list_entry);
2698 static void add_property_mapping(struct PropertyMapping **list,
2699 int *num_list_entries,
2700 int base_index, int ext1_index,
2701 int ext2_index, int ext3_index,
2704 struct PropertyMapping *new_list_entry;
2706 (*num_list_entries)++;
2707 *list = checked_realloc(*list,
2708 *num_list_entries * sizeof(struct PropertyMapping));
2709 new_list_entry = &(*list)[*num_list_entries - 1];
2711 new_list_entry->base_index = base_index;
2712 new_list_entry->ext1_index = ext1_index;
2713 new_list_entry->ext2_index = ext2_index;
2714 new_list_entry->ext3_index = ext3_index;
2716 new_list_entry->artwork_index = artwork_index;
2719 static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info,
2722 struct FileInfo *file_list = artwork_info->file_list;
2723 struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
2724 char **base_prefixes = artwork_info->base_prefixes;
2725 char **ext1_suffixes = artwork_info->ext1_suffixes;
2726 char **ext2_suffixes = artwork_info->ext2_suffixes;
2727 char **ext3_suffixes = artwork_info->ext3_suffixes;
2728 char **ignore_tokens = artwork_info->ignore_tokens;
2729 int num_file_list_entries = artwork_info->num_file_list_entries;
2730 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
2731 int num_base_prefixes = artwork_info->num_base_prefixes;
2732 int num_ext1_suffixes = artwork_info->num_ext1_suffixes;
2733 int num_ext2_suffixes = artwork_info->num_ext2_suffixes;
2734 int num_ext3_suffixes = artwork_info->num_ext3_suffixes;
2735 int num_ignore_tokens = artwork_info->num_ignore_tokens;
2736 SetupFileHash *setup_file_hash, *valid_file_hash;
2737 SetupFileHash *extra_file_hash, *empty_file_hash;
2738 char *known_token_value = KNOWN_TOKEN_VALUE;
2741 if (filename == NULL)
2744 if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
2747 /* separate valid (defined) from empty (undefined) config token values */
2748 valid_file_hash = newSetupFileHash();
2749 empty_file_hash = newSetupFileHash();
2750 BEGIN_HASH_ITERATION(setup_file_hash, itr)
2752 char *value = HASH_ITERATION_VALUE(itr);
2754 setHashEntry(*value ? valid_file_hash : empty_file_hash,
2755 HASH_ITERATION_TOKEN(itr), value);
2757 END_HASH_ITERATION(setup_file_hash, itr)
2759 /* at this point, we do not need the setup file hash anymore -- free it */
2760 freeSetupFileHash(setup_file_hash);
2762 /* map deprecated to current tokens (using prefix match and replace) */
2763 BEGIN_HASH_ITERATION(valid_file_hash, itr)
2765 char *token = HASH_ITERATION_TOKEN(itr);
2766 char *mapped_token = get_mapped_token(token);
2768 if (mapped_token != NULL)
2770 char *value = HASH_ITERATION_VALUE(itr);
2772 /* add mapped token */
2773 setHashEntry(valid_file_hash, mapped_token, value);
2775 /* ignore old token (by setting it to "known" keyword) */
2776 setHashEntry(valid_file_hash, token, known_token_value);
2781 END_HASH_ITERATION(valid_file_hash, itr)
2783 /* read parameters for all known config file tokens */
2784 for (i = 0; i < num_file_list_entries; i++)
2785 read_token_parameters(valid_file_hash, suffix_list, &file_list[i]);
2787 /* set all tokens that can be ignored here to "known" keyword */
2788 for (i = 0; i < num_ignore_tokens; i++)
2789 setHashEntry(valid_file_hash, ignore_tokens[i], known_token_value);
2791 /* copy all unknown config file tokens to extra config hash */
2792 extra_file_hash = newSetupFileHash();
2793 BEGIN_HASH_ITERATION(valid_file_hash, itr)
2795 char *value = HASH_ITERATION_VALUE(itr);
2797 if (!strEqual(value, known_token_value))
2798 setHashEntry(extra_file_hash, HASH_ITERATION_TOKEN(itr), value);
2800 END_HASH_ITERATION(valid_file_hash, itr)
2802 /* at this point, we do not need the valid file hash anymore -- free it */
2803 freeSetupFileHash(valid_file_hash);
2805 /* now try to determine valid, dynamically defined config tokens */
2807 BEGIN_HASH_ITERATION(extra_file_hash, itr)
2809 struct FileInfo **dynamic_file_list =
2810 &artwork_info->dynamic_file_list;
2811 int *num_dynamic_file_list_entries =
2812 &artwork_info->num_dynamic_file_list_entries;
2813 struct PropertyMapping **property_mapping =
2814 &artwork_info->property_mapping;
2815 int *num_property_mapping_entries =
2816 &artwork_info->num_property_mapping_entries;
2817 int current_summarized_file_list_entry =
2818 artwork_info->num_file_list_entries +
2819 artwork_info->num_dynamic_file_list_entries;
2820 char *token = HASH_ITERATION_TOKEN(itr);
2821 int len_token = strlen(token);
2823 boolean base_prefix_found = FALSE;
2824 boolean parameter_suffix_found = FALSE;
2826 /* skip all parameter definitions (handled by read_token_parameters()) */
2827 for (i = 0; i < num_suffix_list_entries && !parameter_suffix_found; i++)
2829 int len_suffix = strlen(suffix_list[i].token);
2831 if (token_suffix_match(token, suffix_list[i].token, -len_suffix))
2832 parameter_suffix_found = TRUE;
2835 if (parameter_suffix_found)
2838 /* ---------- step 0: search for matching base prefix ---------- */
2841 for (i = 0; i < num_base_prefixes && !base_prefix_found; i++)
2843 char *base_prefix = base_prefixes[i];
2844 int len_base_prefix = strlen(base_prefix);
2845 boolean ext1_suffix_found = FALSE;
2846 boolean ext2_suffix_found = FALSE;
2847 boolean ext3_suffix_found = FALSE;
2848 boolean exact_match = FALSE;
2849 int base_index = -1;
2850 int ext1_index = -1;
2851 int ext2_index = -1;
2852 int ext3_index = -1;
2854 base_prefix_found = token_suffix_match(token, base_prefix, start_pos);
2856 if (!base_prefix_found)
2861 if (start_pos + len_base_prefix == len_token) /* exact match */
2865 add_dynamic_file_list_entry(dynamic_file_list,
2866 num_dynamic_file_list_entries,
2869 num_suffix_list_entries,
2871 add_property_mapping(property_mapping,
2872 num_property_mapping_entries,
2873 base_index, -1, -1, -1,
2874 current_summarized_file_list_entry);
2878 /* ---------- step 1: search for matching first suffix ---------- */
2880 start_pos += len_base_prefix;
2881 for (j = 0; j < num_ext1_suffixes && !ext1_suffix_found; j++)
2883 char *ext1_suffix = ext1_suffixes[j];
2884 int len_ext1_suffix = strlen(ext1_suffix);
2886 ext1_suffix_found = token_suffix_match(token, ext1_suffix, start_pos);
2888 if (!ext1_suffix_found)
2893 if (start_pos + len_ext1_suffix == len_token) /* exact match */
2897 add_dynamic_file_list_entry(dynamic_file_list,
2898 num_dynamic_file_list_entries,
2901 num_suffix_list_entries,
2903 add_property_mapping(property_mapping,
2904 num_property_mapping_entries,
2905 base_index, ext1_index, -1, -1,
2906 current_summarized_file_list_entry);
2910 start_pos += len_ext1_suffix;
2916 /* ---------- step 2: search for matching second suffix ---------- */
2918 for (k = 0; k < num_ext2_suffixes && !ext2_suffix_found; k++)
2920 char *ext2_suffix = ext2_suffixes[k];
2921 int len_ext2_suffix = strlen(ext2_suffix);
2923 ext2_suffix_found = token_suffix_match(token, ext2_suffix, start_pos);
2925 if (!ext2_suffix_found)
2930 if (start_pos + len_ext2_suffix == len_token) /* exact match */
2934 add_dynamic_file_list_entry(dynamic_file_list,
2935 num_dynamic_file_list_entries,
2938 num_suffix_list_entries,
2940 add_property_mapping(property_mapping,
2941 num_property_mapping_entries,
2942 base_index, ext1_index, ext2_index, -1,
2943 current_summarized_file_list_entry);
2947 start_pos += len_ext2_suffix;
2953 /* ---------- step 3: search for matching third suffix ---------- */
2955 for (l = 0; l < num_ext3_suffixes && !ext3_suffix_found; l++)
2957 char *ext3_suffix = ext3_suffixes[l];
2958 int len_ext3_suffix = strlen(ext3_suffix);
2960 ext3_suffix_found = token_suffix_match(token, ext3_suffix, start_pos);
2962 if (!ext3_suffix_found)
2967 if (start_pos + len_ext3_suffix == len_token) /* exact match */
2971 add_dynamic_file_list_entry(dynamic_file_list,
2972 num_dynamic_file_list_entries,
2975 num_suffix_list_entries,
2977 add_property_mapping(property_mapping,
2978 num_property_mapping_entries,
2979 base_index, ext1_index, ext2_index, ext3_index,
2980 current_summarized_file_list_entry);
2986 END_HASH_ITERATION(extra_file_hash, itr)
2988 if (artwork_info->num_dynamic_file_list_entries > 0)
2990 artwork_info->dynamic_artwork_list =
2991 checked_calloc(artwork_info->num_dynamic_file_list_entries *
2992 artwork_info->sizeof_artwork_list_entry);
2995 if (options.verbose && IS_PARENT_PROCESS())
2997 SetupFileList *setup_file_list, *list;
2998 boolean dynamic_tokens_found = FALSE;
2999 boolean unknown_tokens_found = FALSE;
3000 boolean undefined_values_found = (hashtable_count(empty_file_hash) != 0);
3002 if ((setup_file_list = loadSetupFileList(filename)) == NULL)
3003 Error(ERR_EXIT, "loadSetupFileHash works, but loadSetupFileList fails");
3005 BEGIN_HASH_ITERATION(extra_file_hash, itr)
3007 if (strEqual(HASH_ITERATION_VALUE(itr), known_token_value))
3008 dynamic_tokens_found = TRUE;
3010 unknown_tokens_found = TRUE;
3012 END_HASH_ITERATION(extra_file_hash, itr)
3014 if (options.debug && dynamic_tokens_found)
3016 Error(ERR_INFO_LINE, "-");
3017 Error(ERR_INFO, "dynamic token(s) found in config file:");
3018 Error(ERR_INFO, "- config file: '%s'", filename);
3020 for (list = setup_file_list; list != NULL; list = list->next)
3022 char *value = getHashEntry(extra_file_hash, list->token);
3024 if (value != NULL && strEqual(value, known_token_value))
3025 Error(ERR_INFO, "- dynamic token: '%s'", list->token);
3028 Error(ERR_INFO_LINE, "-");
3031 if (unknown_tokens_found)
3033 Error(ERR_INFO_LINE, "-");
3034 Error(ERR_INFO, "warning: unknown token(s) found in config file:");
3035 Error(ERR_INFO, "- config file: '%s'", filename);
3037 for (list = setup_file_list; list != NULL; list = list->next)
3039 char *value = getHashEntry(extra_file_hash, list->token);
3041 if (value != NULL && !strEqual(value, known_token_value))
3042 Error(ERR_INFO, "- dynamic token: '%s'", list->token);
3045 Error(ERR_INFO_LINE, "-");
3048 if (undefined_values_found)
3050 Error(ERR_INFO_LINE, "-");
3051 Error(ERR_INFO, "warning: undefined values found in config file:");
3052 Error(ERR_INFO, "- config file: '%s'", filename);
3054 for (list = setup_file_list; list != NULL; list = list->next)
3056 char *value = getHashEntry(empty_file_hash, list->token);
3059 Error(ERR_INFO, "- undefined value for token: '%s'", list->token);
3062 Error(ERR_INFO_LINE, "-");
3065 freeSetupFileList(setup_file_list);
3068 freeSetupFileHash(extra_file_hash);
3069 freeSetupFileHash(empty_file_hash);
3072 void LoadArtworkConfig(struct ArtworkListInfo *artwork_info)
3074 struct FileInfo *file_list = artwork_info->file_list;
3075 int num_file_list_entries = artwork_info->num_file_list_entries;
3076 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
3077 char *filename_base = UNDEFINED_FILENAME, *filename_local;
3080 DrawInitText("Loading artwork config", 120, FC_GREEN);
3081 DrawInitText(ARTWORKINFO_FILENAME(artwork_info->type), 150, FC_YELLOW);
3083 /* always start with reliable default values */
3084 for (i = 0; i < num_file_list_entries; i++)
3086 setString(&file_list[i].filename, file_list[i].default_filename);
3088 for (j = 0; j < num_suffix_list_entries; j++)
3089 setString(&file_list[i].parameter[j], file_list[i].default_parameter[j]);
3091 file_list[i].redefined = FALSE;
3092 file_list[i].fallback_to_default = FALSE;
3095 /* free previous dynamic artwork file array */
3096 if (artwork_info->dynamic_file_list != NULL)
3098 for (i = 0; i < artwork_info->num_dynamic_file_list_entries; i++)
3100 free(artwork_info->dynamic_file_list[i].token);
3101 free(artwork_info->dynamic_file_list[i].filename);
3102 free(artwork_info->dynamic_file_list[i].parameter);
3105 free(artwork_info->dynamic_file_list);
3106 artwork_info->dynamic_file_list = NULL;
3108 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
3109 &artwork_info->num_dynamic_file_list_entries);
3112 /* free previous property mapping */
3113 if (artwork_info->property_mapping != NULL)
3115 free(artwork_info->property_mapping);
3117 artwork_info->property_mapping = NULL;
3118 artwork_info->num_property_mapping_entries = 0;
3121 if (!GFX_OVERRIDE_ARTWORK(artwork_info->type))
3123 /* first look for special artwork configured in level series config */
3124 filename_base = getCustomArtworkLevelConfigFilename(artwork_info->type);
3126 if (fileExists(filename_base))
3127 LoadArtworkConfigFromFilename(artwork_info, filename_base);
3130 filename_local = getCustomArtworkConfigFilename(artwork_info->type);
3132 if (filename_local != NULL && !strEqual(filename_base, filename_local))
3133 LoadArtworkConfigFromFilename(artwork_info, filename_local);
3136 static void deleteArtworkListEntry(struct ArtworkListInfo *artwork_info,
3137 struct ListNodeInfo **listnode)
3141 char *filename = (*listnode)->source_filename;
3143 if (--(*listnode)->num_references <= 0)
3144 deleteNodeFromList(&artwork_info->content_list, filename,
3145 artwork_info->free_artwork);
3151 static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info,
3152 struct ListNodeInfo **listnode,
3153 struct FileInfo *file_list_entry)
3163 char *basename = file_list_entry->filename;
3164 char *filename = getCustomArtworkFilename(basename, artwork_info->type);
3166 if (filename == NULL)
3168 Error(ERR_WARN, "cannot find artwork file '%s'", basename);
3170 basename = file_list_entry->default_filename;
3172 /* fail for cloned default artwork that has no default filename defined */
3173 if (file_list_entry->default_is_cloned &&
3174 strEqual(basename, UNDEFINED_FILENAME))
3176 int error_mode = ERR_WARN;
3178 /* we can get away without sounds and music, but not without graphics */
3179 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3180 error_mode = ERR_EXIT;
3182 Error(error_mode, "token '%s' was cloned and has no default filename",
3183 file_list_entry->token);
3188 /* dynamic artwork has no default filename / skip empty default artwork */
3189 if (basename == NULL || strEqual(basename, UNDEFINED_FILENAME))
3192 file_list_entry->fallback_to_default = TRUE;
3194 Error(ERR_WARN, "trying default artwork file '%s'", basename);
3196 filename = getCustomArtworkFilename(basename, artwork_info->type);
3198 if (filename == NULL)
3200 int error_mode = ERR_WARN;
3202 /* we can get away without sounds and music, but not without graphics */
3203 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3204 error_mode = ERR_EXIT;
3206 Error(error_mode, "cannot find default artwork file '%s'", basename);
3212 /* check if the old and the new artwork file are the same */
3213 if (*listnode && strEqual((*listnode)->source_filename, filename))
3215 /* The old and new artwork are the same (have the same filename and path).
3216 This usually means that this artwork does not exist in this artwork set
3217 and a fallback to the existing artwork is done. */
3222 /* delete existing artwork file entry */
3223 deleteArtworkListEntry(artwork_info, listnode);
3225 /* check if the new artwork file already exists in the list of artwork */
3226 if ((node = getNodeFromKey(artwork_info->content_list, filename)) != NULL)
3228 *listnode = (struct ListNodeInfo *)node->content;
3229 (*listnode)->num_references++;
3234 DrawInitText(init_text[artwork_info->type], 120, FC_GREEN);
3235 DrawInitText(basename, 150, FC_YELLOW);
3237 if ((*listnode = artwork_info->load_artwork(filename)) != NULL)
3239 /* add new artwork file entry to the list of artwork files */
3240 (*listnode)->num_references = 1;
3241 addNodeToList(&artwork_info->content_list, (*listnode)->source_filename,
3246 int error_mode = ERR_WARN;
3248 /* we can get away without sounds and music, but not without graphics */
3249 if (artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3250 error_mode = ERR_EXIT;
3252 Error(error_mode, "cannot load artwork file '%s'", basename);
3258 static void LoadCustomArtwork(struct ArtworkListInfo *artwork_info,
3259 struct ListNodeInfo **listnode,
3260 struct FileInfo *file_list_entry)
3262 if (strEqual(file_list_entry->filename, UNDEFINED_FILENAME))
3264 deleteArtworkListEntry(artwork_info, listnode);
3269 replaceArtworkListEntry(artwork_info, listnode, file_list_entry);
3272 void ReloadCustomArtworkList(struct ArtworkListInfo *artwork_info)
3274 struct FileInfo *file_list = artwork_info->file_list;
3275 struct FileInfo *dynamic_file_list = artwork_info->dynamic_file_list;
3276 int num_file_list_entries = artwork_info->num_file_list_entries;
3277 int num_dynamic_file_list_entries =
3278 artwork_info->num_dynamic_file_list_entries;
3281 print_timestamp_init("ReloadCustomArtworkList");
3283 for (i = 0; i < num_file_list_entries; i++)
3284 LoadCustomArtwork(artwork_info, &artwork_info->artwork_list[i],
3287 for (i = 0; i < num_dynamic_file_list_entries; i++)
3288 LoadCustomArtwork(artwork_info, &artwork_info->dynamic_artwork_list[i],
3289 &dynamic_file_list[i]);
3291 print_timestamp_done("ReloadCustomArtworkList");
3294 dumpList(artwork_info->content_list);
3298 static void FreeCustomArtworkList(struct ArtworkListInfo *artwork_info,
3299 struct ListNodeInfo ***list,
3300 int *num_list_entries)
3307 for (i = 0; i < *num_list_entries; i++)
3308 deleteArtworkListEntry(artwork_info, &(*list)[i]);
3312 *num_list_entries = 0;
3315 void FreeCustomArtworkLists(struct ArtworkListInfo *artwork_info)
3317 if (artwork_info == NULL)
3320 FreeCustomArtworkList(artwork_info, &artwork_info->artwork_list,
3321 &artwork_info->num_file_list_entries);
3323 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
3324 &artwork_info->num_dynamic_file_list_entries);
3328 /* ------------------------------------------------------------------------- */
3329 /* functions only needed for non-Unix (non-command-line) systems */
3330 /* (MS-DOS only; SDL/Windows creates files "stdout.txt" and "stderr.txt") */
3331 /* (now also added for Windows, to create files in user data directory) */
3332 /* ------------------------------------------------------------------------- */
3334 char *getErrorFilename(char *basename)
3336 return getPath2(getUserGameDataDir(), basename);
3339 void openErrorFile()
3341 InitUserDataDirectory();
3343 if ((program.error_file = fopen(program.error_filename, MODE_WRITE)) == NULL)
3345 program.error_file = stderr;
3347 Error(ERR_WARN, "cannot open file '%s' for writing: %s",
3348 program.error_filename, strerror(errno));
3351 /* error output should be unbuffered so it is not truncated in a crash */
3352 setbuf(program.error_file, NULL);
3355 void closeErrorFile()
3357 if (program.error_file != stderr) /* do not close stream 'stderr' */
3358 fclose(program.error_file);
3361 void dumpErrorFile()
3363 FILE *error_file = fopen(program.error_filename, MODE_READ);
3365 if (error_file != NULL)
3367 while (!feof(error_file))
3368 fputc(fgetc(error_file), stderr);
3374 void NotifyUserAboutErrorFile()
3376 #if defined(PLATFORM_WIN32)
3377 char *title_text = getStringCat2(program.program_title, " Error Message");
3378 char *error_text = getStringCat2("The program was aborted due to an error; "
3379 "for details, see the following error file:"
3380 STRING_NEWLINE, program.error_filename);
3382 MessageBox(NULL, error_text, title_text, MB_OK);
3387 /* ------------------------------------------------------------------------- */
3388 /* the following is only for debugging purpose and normally not used */
3389 /* ------------------------------------------------------------------------- */
3393 #define DEBUG_PRINT_INIT_TIMESTAMPS FALSE
3394 #define DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH 10
3396 #define DEBUG_NUM_TIMESTAMPS 10
3397 #define DEBUG_TIME_IN_MICROSECONDS 0
3399 #if DEBUG_TIME_IN_MICROSECONDS
3400 static double Counter_Microseconds()
3402 static struct timeval base_time = { 0, 0 };
3403 struct timeval current_time;
3406 gettimeofday(¤t_time, NULL);
3408 /* reset base time in case of wrap-around */
3409 if (current_time.tv_sec < base_time.tv_sec)
3410 base_time = current_time;
3413 ((double)(current_time.tv_sec - base_time.tv_sec)) * 1000000 +
3414 ((double)(current_time.tv_usec - base_time.tv_usec));
3416 return counter; /* return microseconds since last init */
3420 char *debug_print_timestamp_get_padding(int padding_size)
3422 static char *padding = NULL;
3423 int max_padding_size = 100;
3425 if (padding == NULL)
3427 padding = checked_calloc(max_padding_size + 1);
3428 memset(padding, ' ', max_padding_size);
3431 return &padding[MAX(0, max_padding_size - padding_size)];
3434 void debug_print_timestamp(int counter_nr, char *message)
3436 int indent_size = 8;
3437 int padding_size = 40;
3438 float timestamp_interval;
3441 Error(ERR_EXIT, "debugging: invalid negative counter");
3442 else if (counter_nr >= DEBUG_NUM_TIMESTAMPS)
3443 Error(ERR_EXIT, "debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c");
3445 #if DEBUG_TIME_IN_MICROSECONDS
3446 static double counter[DEBUG_NUM_TIMESTAMPS][2];
3449 counter[counter_nr][0] = Counter_Microseconds();
3451 static int counter[DEBUG_NUM_TIMESTAMPS][2];
3454 counter[counter_nr][0] = Counter();
3457 timestamp_interval = counter[counter_nr][0] - counter[counter_nr][1];
3458 counter[counter_nr][1] = counter[counter_nr][0];
3461 Error(ERR_DEBUG, "%s%s%s %.3f %s",
3462 debug_print_timestamp_get_padding(counter_nr * indent_size),
3464 debug_print_timestamp_get_padding(padding_size - strlen(message)),
3465 timestamp_interval / 1000,
3469 void debug_print_parent_only(char *format, ...)
3471 if (!IS_PARENT_PROCESS())
3478 va_start(ap, format);
3479 vprintf(format, ap);
3488 void print_timestamp_ext(char *message, char *mode)
3490 #if DEBUG_PRINT_INIT_TIMESTAMPS
3491 static char *debug_message = NULL;
3492 static char *last_message = NULL;
3493 static int counter_nr = 0;
3494 int max_depth = DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH;
3496 checked_free(debug_message);
3497 debug_message = getStringCat3(mode, " ", message);
3499 if (strEqual(mode, "INIT"))
3501 debug_print_timestamp(counter_nr, NULL);
3503 if (counter_nr + 1 < max_depth)
3504 debug_print_timestamp(counter_nr, debug_message);
3508 debug_print_timestamp(counter_nr, NULL);
3510 else if (strEqual(mode, "DONE"))
3514 if (counter_nr + 1 < max_depth ||
3515 (counter_nr == 0 && max_depth == 1))
3517 last_message = message;
3519 if (counter_nr == 0 && max_depth == 1)
3521 checked_free(debug_message);
3522 debug_message = getStringCat3("TIME", " ", message);
3525 debug_print_timestamp(counter_nr, debug_message);
3528 else if (!strEqual(mode, "TIME") ||
3529 !strEqual(message, last_message))
3531 if (counter_nr < max_depth)
3532 debug_print_timestamp(counter_nr, debug_message);
3537 void print_timestamp_init(char *message)
3539 print_timestamp_ext(message, "INIT");
3542 void print_timestamp_time(char *message)
3544 print_timestamp_ext(message, "TIME");
3547 void print_timestamp_done(char *message)
3549 print_timestamp_ext(message, "DONE");