X-Git-Url: https://git.artsoft.org/?a=blobdiff_plain;f=src%2Flibgame%2Fmisc.c;h=c568159d41d4adf5c43781c4d2afa40f9f62ba19;hb=5e195517fdcbad3043eff72d91399f6a5e604d8b;hp=1ea2a2edb823e909267815575b6eb3121ddb6dba;hpb=8cea50fbd1b74a2bc164a79cbd26bdbb3abd6689;p=rocksndiamonds.git diff --git a/src/libgame/misc.c b/src/libgame/misc.c index 1ea2a2ed..2692e69c 100644 --- a/src/libgame/misc.c +++ b/src/libgame/misc.c @@ -1,27 +1,27 @@ -/*********************************************************** -* Artsoft Retro-Game Library * -*----------------------------------------------------------* -* (c) 1994-2002 Artsoft Entertainment * -* Holger Schemel * -* Detmolder Strasse 189 * -* 33604 Bielefeld * -* Germany * -* e-mail: info@artsoft.org * -*----------------------------------------------------------* -* misc.c * -***********************************************************/ +// ============================================================================ +// Artsoft Retro-Game Library +// ---------------------------------------------------------------------------- +// (c) 1995-2014 by Artsoft Entertainment +// Holger Schemel +// info@artsoft.org +// https://www.artsoft.org/ +// ---------------------------------------------------------------------------- +// misc.c +// ============================================================================ #include #include #include +#include #include #include #include #include +#include #include "platform.h" -#if !defined(PLATFORM_WIN32) +#if defined(PLATFORM_UNIX) #include #include #endif @@ -33,1658 +33,3002 @@ #include "image.h" -/* ========================================================================= */ -/* some generic helper functions */ -/* ========================================================================= */ +// ============================================================================ +// some generic helper functions +// ============================================================================ -/* ------------------------------------------------------------------------- */ -/* platform independent wrappers for printf() et al. (newline aware) */ -/* ------------------------------------------------------------------------- */ +// ---------------------------------------------------------------------------- +// logging functions +// ---------------------------------------------------------------------------- -static void vfprintf_newline(FILE *stream, char *format, va_list ap) -{ - char *newline = STRING_NEWLINE; +#define DUPLICATE_LOG_OUT_TO_STDOUT TRUE +#define DUPLICATE_LOG_ERR_TO_STDERR TRUE - vfprintf(stream, format, ap); - fprintf(stream, "%s", newline); -} +#if defined(PLATFORM_ANDROID) +static int android_log_prio = ANDROID_LOG_INFO; +static char *android_log_buffer = NULL; -static void fprintf_newline(FILE *stream, char *format, ...) +static void append_to_android_log_buffer(char *format, va_list ap) { - if (format) - { - va_list ap; + char text_new[MAX_OUTPUT_LINESIZE]; - va_start(ap, format); - vfprintf_newline(stream, format, ap); - va_end(ap); - } -} + // print text to temporary string + vsnprintf(text_new, MAX_OUTPUT_LINESIZE, format, ap); -void fprintf_line(FILE *stream, char *line_chars, int line_length) -{ - int i; + if (android_log_buffer == NULL) + { + android_log_buffer = getStringCopy(text_new); + } + else + { + char *android_log_buffer_old = android_log_buffer; - for (i = 0; i < line_length; i++) - fprintf(stream, "%s", line_chars); + // append new text to existing text + android_log_buffer = getStringCat2(android_log_buffer, text_new); - fprintf_newline(stream, ""); + checked_free(android_log_buffer_old); + } } -void printf_line(char *line_chars, int line_length) +static void vprintf_log_nonewline(char *format, va_list ap) { - fprintf_line(stdout, line_chars, line_length); + // add log output to buffer until text with newline is printed + append_to_android_log_buffer(format, ap); } -void printf_line_with_prefix(char *prefix, char *line_chars, int line_length) +static void vprintf_log(char *format, va_list ap) { - fprintf(stdout, "%s", prefix); - fprintf_line(stdout, line_chars, line_length); -} + // add log output to buffer + append_to_android_log_buffer(format, ap); + // __android_log_vprint(android_log_prio, program.program_title, format, ap); + __android_log_write(android_log_prio, program.program_title, + android_log_buffer); -/* ------------------------------------------------------------------------- */ -/* string functions */ -/* ------------------------------------------------------------------------- */ + checked_free(android_log_buffer); + android_log_buffer = NULL; +} -/* int2str() returns a number converted to a string; - the used memory is static, but will be overwritten by later calls, - so if you want to save the result, copy it to a private string buffer; - there can be 10 local calls of int2str() without buffering the result -- - the 11th call will then destroy the result from the first call and so on. -*/ +#else -char *int2str(int number, int size) +static void vprintf_log_nonewline(char *format, va_list ap) { - static char shift_array[10][40]; - static int shift_counter = 0; - char *s = shift_array[shift_counter]; + FILE *file = program.log_file[LOG_ERR_ID]; - shift_counter = (shift_counter + 1) % 10; +#if DUPLICATE_LOG_ERR_TO_STDERR + if (file != program.log_file_default[LOG_ERR_ID]) + { + va_list ap2; + va_copy(ap2, ap); - if (size > 20) - size = 20; + vfprintf(program.log_file_default[LOG_ERR_ID], format, ap2); - if (size) - { - sprintf(s, " %09d", number); - return &s[strlen(s) - size]; - } - else - { - sprintf(s, "%d", number); - return s; + va_end(ap2); } -} - +#endif -/* 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 */ + vfprintf(file, format, ap); +} -char *i_to_a(unsigned int i) +static void vprintf_log(char *format, va_list ap) { - static char *a = NULL; - - checked_free(a); + FILE *file = program.log_file[LOG_ERR_ID]; + char *newline = STRING_NEWLINE; - if (i > 2147483647) /* yes, this is a kludge */ - i = 2147483647; +#if DUPLICATE_LOG_ERR_TO_STDERR + if (file != program.log_file_default[LOG_ERR_ID]) + { + va_list ap2; + va_copy(ap2, ap); - a = checked_malloc(10 + 1); + vfprintf(program.log_file_default[LOG_ERR_ID], format, ap2); + fprintf(program.log_file_default[LOG_ERR_ID], "%s", newline); - sprintf(a, "%d", i); + va_end(ap2); + } +#endif - return a; + vfprintf(file, format, ap); + fprintf(file, "%s", newline); } +#endif +static void printf_log_nonewline(char *format, ...) +{ + va_list ap; -/* calculate base-2 logarithm of argument (rounded down to integer; - this function returns the number of the highest bit set in argument) */ + va_start(ap, format); + vprintf_log_nonewline(format, ap); + va_end(ap); +} -int log_2(unsigned int x) +static void printf_log(char *format, ...) { - int e = 0; - - while ((1 << e) < x) - { - x -= (1 << e); /* for rounding down (rounding up: remove this line) */ - e++; - } + va_list ap; - return e; + va_start(ap, format); + vprintf_log(format, ap); + va_end(ap); } +static void printf_log_line(char *line_chars, int line_length) +{ + int i; -/* ------------------------------------------------------------------------- */ -/* counter functions */ -/* ------------------------------------------------------------------------- */ - -#if defined(PLATFORM_MSDOS) -volatile unsigned long counter = 0; + for (i = 0; i < line_length; i++) + printf_log_nonewline("%s", line_chars); -void increment_counter() -{ - counter++; + printf_log(""); } -END_OF_FUNCTION(increment_counter); -#endif - -/* maximal allowed length of a command line option */ -#define MAX_OPTION_LEN 256 +// ---------------------------------------------------------------------------- +// platform independent wrappers for printf() et al. +// ---------------------------------------------------------------------------- -#ifdef TARGET_SDL -static unsigned long mainCounter(int mode) +void fprintf_line(FILE *file, char *line_chars, int line_length) { - static unsigned long base_ms = 0; - unsigned long current_ms; - unsigned long counter_ms; - - current_ms = SDL_GetTicks(); - - /* reset base time in case of counter initializing or wrap-around */ - if (mode == INIT_COUNTER || current_ms < base_ms) - base_ms = current_ms; + int i; - counter_ms = current_ms - base_ms; + for (i = 0; i < line_length; i++) + fprintf(file, "%s", line_chars); - return counter_ms; /* return milliseconds since last init */ + fprintf(file, "\n"); } -#else /* !TARGET_SDL */ - -#if defined(PLATFORM_UNIX) -static unsigned long mainCounter(int mode) +void fprintf_line_with_prefix(FILE *file, char *prefix, char *line_chars, + int line_length) { - static struct timeval base_time = { 0, 0 }; - struct timeval current_time; - unsigned long counter_ms; - - gettimeofday(¤t_time, NULL); - - /* reset base time in case of counter initializing or wrap-around */ - if (mode == INIT_COUNTER || current_time.tv_sec < base_time.tv_sec) - base_time = current_time; - - counter_ms = (current_time.tv_sec - base_time.tv_sec) * 1000 - + (current_time.tv_usec - base_time.tv_usec) / 1000; - - return counter_ms; /* return milliseconds since last init */ + fprintf(file, "%s", prefix); + fprintf_line(file, line_chars, line_length); } -#endif /* PLATFORM_UNIX */ -#endif /* !TARGET_SDL */ -void InitCounter() /* set counter back to zero */ +void printf_line(char *line_chars, int line_length) { -#if !defined(PLATFORM_MSDOS) - mainCounter(INIT_COUNTER); -#else - LOCK_VARIABLE(counter); - LOCK_FUNCTION(increment_counter); - install_int_ex(increment_counter, BPS_TO_TIMER(100)); -#endif + fprintf_line(stdout, line_chars, line_length); } -unsigned long Counter() /* get milliseconds since last call of InitCounter() */ +void printf_line_with_prefix(char *prefix, char *line_chars, int line_length) { -#if !defined(PLATFORM_MSDOS) - return mainCounter(READ_COUNTER); -#else - return (counter * 10); -#endif + fprintf_line_with_prefix(stdout, prefix, line_chars, line_length); } -static void sleep_milliseconds(unsigned long milliseconds_delay) +static void vPrint(char *format, va_list ap) { - boolean do_busy_waiting = (milliseconds_delay < 5 ? TRUE : FALSE); + FILE *file = program.log_file[LOG_OUT_ID]; - if (do_busy_waiting) +#if DUPLICATE_LOG_OUT_TO_STDOUT + if (file != program.log_file_default[LOG_OUT_ID]) { - /* we want to wait only a few ms -- if we assume that we have a - kernel timer resolution of 10 ms, we would wait far to long; - therefore it's better to do a short interval of busy waiting - to get our sleeping time more accurate */ + va_list ap2; + va_copy(ap2, ap); - unsigned long base_counter = Counter(), actual_counter = Counter(); + vfprintf(program.log_file_default[LOG_OUT_ID], format, ap2); - while (actual_counter < base_counter + milliseconds_delay && - actual_counter >= base_counter) - actual_counter = Counter(); + va_end(ap2); } - else - { -#if defined(TARGET_SDL) - SDL_Delay(milliseconds_delay); -#elif defined(TARGET_ALLEGRO) - rest(milliseconds_delay); -#else - struct timeval delay; - - delay.tv_sec = milliseconds_delay / 1000; - delay.tv_usec = 1000 * (milliseconds_delay % 1000); - - if (select(0, NULL, NULL, NULL, &delay) != 0) - Error(ERR_WARN, "sleep_milliseconds(): select() failed"); #endif - } + + vfprintf(file, format, ap); } -void Delay(unsigned long delay) /* Sleep specified number of milliseconds */ +void Print(char *format, ...) { - sleep_milliseconds(delay); + va_list ap; + + va_start(ap, format); + vPrint(format, ap); + va_end(ap); } -boolean FrameReached(unsigned long *frame_counter_var, - unsigned long frame_delay) +void PrintNoLog(char *format, ...) { - unsigned long actual_frame_counter = FrameCounter; - - if (actual_frame_counter >= *frame_counter_var && - actual_frame_counter < *frame_counter_var + frame_delay) - return FALSE; + FILE *file = program.log_file_default[LOG_OUT_ID]; + va_list ap; - *frame_counter_var = actual_frame_counter; + va_start(ap, format); + vfprintf(file, format, ap); + va_end(ap); - return TRUE; + fflush(file); } -boolean DelayReached(unsigned long *counter_var, - unsigned long delay) +void PrintLine(char *line_chars, int line_length) { - unsigned long actual_counter = Counter(); - - if (actual_counter >= *counter_var && - actual_counter < *counter_var + delay) - return FALSE; + int i; - *counter_var = actual_counter; + for (i = 0; i < line_length; i++) + Print(line_chars); - return TRUE; + Print("\n"); } -void WaitUntilDelayReached(unsigned long *counter_var, unsigned long delay) +void PrintLineWithPrefix(char *prefix, char *line_chars, int line_length) { - unsigned long actual_counter; + Print(prefix); + PrintLine(line_chars, line_length); +} - while (1) - { - actual_counter = Counter(); - if (actual_counter >= *counter_var && - actual_counter < *counter_var + delay) - sleep_milliseconds((*counter_var + delay - actual_counter) / 2); - else - break; - } +// ---------------------------------------------------------------------------- +// generic logging and error handling functions +// ---------------------------------------------------------------------------- - *counter_var = actual_counter; -} +enum log_levels +{ + LOG_UNKNOWN = 0, + LOG_DEBUG, + LOG_INFO, + LOG_WARN, + LOG_ERROR, + LOG_FATAL +}; + +static char *log_tokens[] = +{ + "UNKNOWN", + "DEBUG", + "INFO", + "WARN", + "ERROR", + "FATAL" +}; + +static void printf_log_prefix(int log_level, char *mode) +{ + if (log_level < 0 || log_level > LOG_FATAL) + return; + char *log_token = log_tokens[log_level]; -/* ------------------------------------------------------------------------- */ -/* random generator functions */ -/* ------------------------------------------------------------------------- */ + if (log_level == LOG_DEBUG) + printf_log_nonewline("[%s] [%s] ", log_token, mode); + else + printf_log_nonewline("[%s] ", log_token); +} -unsigned int init_random_number(int nr, long seed) +static void vLog(int log_level, char *mode, char *format, va_list ap) { - if (seed == NEW_RANDOMIZE) + if (log_level < 0 || log_level > LOG_FATAL) + return; + + if (log_level == LOG_DEBUG) { -#if defined(TARGET_SDL) - seed = (long)SDL_GetTicks(); -#else - struct timeval current_time; + // only show debug messages when in debug mode + if (!options.debug) + return; - gettimeofday(¤t_time, NULL); - seed = (long)current_time.tv_usec; -#endif + // if optional debug mode specified, limit debug output accordingly + if (options.debug_mode != NULL && + strstr(mode, options.debug_mode) == NULL) + return; + } + else if (log_level == LOG_WARN) + { + // only show warning messages when in verbose mode + if (!options.verbose) + return; } - srandom_linux_libc(nr, (unsigned int) seed); +#if defined(PLATFORM_ANDROID) + android_log_prio = (log_level == LOG_DEBUG ? ANDROID_LOG_DEBUG : + log_level == LOG_INFO ? ANDROID_LOG_INFO : + log_level == LOG_WARN ? ANDROID_LOG_WARN : + log_level == LOG_ERROR ? ANDROID_LOG_ERROR : + log_level == LOG_FATAL ? ANDROID_LOG_FATAL : + ANDROID_LOG_UNKNOWN); +#endif - return (unsigned int) seed; -} + static boolean last_line_was_separator = FALSE; + char *log_token = log_tokens[log_level]; -unsigned int get_random_number(int nr, int max) -{ - return (max > 0 ? random_linux_libc(nr) % max : 0); -} + if (strEqual(format, "===") || + strEqual(format, "---")) + { + static char *mode_last = NULL; + char line_char[2] = { format[0], '\0' }; + int line_length = 80 - strlen(log_token) - 3; + if (log_level == LOG_DEBUG) + line_length -= strlen(mode) + 3; -/* ------------------------------------------------------------------------- */ -/* system info functions */ -/* ------------------------------------------------------------------------- */ + if (last_line_was_separator && strEqual(mode, mode_last)) + return; -#if !defined(PLATFORM_MSDOS) -static char *get_corrected_real_name(char *real_name) -{ - char *real_name_new = checked_malloc(MAX_USERNAME_LEN + 1); - char *from_ptr = real_name; - char *to_ptr = real_name_new; + printf_log_prefix(log_level, mode); + printf_log_line(line_char, line_length); - /* copy the name string, but not more than MAX_USERNAME_LEN characters */ - while (*from_ptr && (long)(to_ptr - real_name_new) < MAX_USERNAME_LEN - 1) - { - /* the name field read from "passwd" file may also contain additional - user information, separated by commas, which will be removed here */ - if (*from_ptr == ',') - break; + if (!strEqual(mode, mode_last)) + setString(&mode_last, mode); - /* the user's real name may contain 'ß' characters (german sharp s), - which have no equivalent in upper case letters (used by our fonts) */ - if (*from_ptr == 'ß') - { - from_ptr++; - *to_ptr++ = 's'; - *to_ptr++ = 's'; - } - else - *to_ptr++ = *from_ptr++; + last_line_was_separator = TRUE; + + return; } - *to_ptr = '\0'; + last_line_was_separator = FALSE; - return real_name_new; + printf_log_prefix(log_level, mode); + + vprintf_log(format, ap); } -#endif -char *getLoginName() +static void Log(int log_level, char *mode, char *format, ...) { - static char *login_name = NULL; + va_list ap; -#if defined(PLATFORM_WIN32) - if (login_name == NULL) - { - unsigned long buffer_size = MAX_USERNAME_LEN + 1; - login_name = checked_malloc(buffer_size); + va_start(ap, format); + vLog(log_level, mode, format, ap); + va_end(ap); +} - if (GetUserName(login_name, &buffer_size) == 0) - strcpy(login_name, ANONYMOUS_NAME); - } -#else - if (login_name == NULL) +void DebugContinued(char *mode, char *format, ...) +{ + static char message[MAX_LINE_LEN] = { 0 }; + + // initialize message (optional) + if (strEqual(format, "")) { - struct passwd *pwd; + message[0] = '\0'; - if ((pwd = getpwuid(getuid())) == NULL) - login_name = ANONYMOUS_NAME; - else - login_name = getStringCopy(pwd->pw_name); + return; } -#endif - return login_name; -} + char *message_ptr = message + strlen(message); + int size_left = MAX_LINE_LEN - strlen(message); + va_list ap; -char *getRealName() -{ - static char *real_name = NULL; + // append message + va_start(ap, format); + vsnprintf(message_ptr, size_left, format, ap); + va_end(ap); -#if defined(PLATFORM_WIN32) - if (real_name == NULL) + // finalize message + if (strSuffix(format, "\n")) { - static char buffer[MAX_USERNAME_LEN + 1]; - unsigned long buffer_size = MAX_USERNAME_LEN + 1; + message[strlen(message) - 1] = '\0'; - if (GetUserName(buffer, &buffer_size) != 0) - real_name = get_corrected_real_name(buffer); - else - real_name = ANONYMOUS_NAME; - } -#elif defined(PLATFORM_UNIX) - if (real_name == NULL) - { - struct passwd *pwd; + Debug(mode, message); - if ((pwd = getpwuid(getuid())) != NULL && strlen(pwd->pw_gecos) != 0) - real_name = get_corrected_real_name(pwd->pw_gecos); - else - real_name = ANONYMOUS_NAME; + message[0] = '\0'; } -#else - real_name = ANONYMOUS_NAME; -#endif - - return real_name; } +void Debug(char *mode, char *format, ...) +{ + va_list ap; -/* ------------------------------------------------------------------------- */ -/* path manipulation functions */ -/* ------------------------------------------------------------------------- */ + va_start(ap, format); + vLog(LOG_DEBUG, mode, format, ap); + va_end(ap); +} -static char *getLastPathSeparatorPtr(char *filename) +void Info(char *format, ...) { - char *last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_UNIX); + va_list ap; - if (last_separator == NULL) /* also try DOS/Windows variant */ - last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_DOS); - - return last_separator; + va_start(ap, format); + vLog(LOG_INFO, NULL, format, ap); + va_end(ap); } -char *getBaseNamePtr(char *filename) +void Warn(char *format, ...) { - char *last_separator = getLastPathSeparatorPtr(filename); + va_list ap; - if (last_separator != NULL) - return last_separator + 1; /* separator found: strip base path */ - else - return filename; /* no separator found: filename has no path */ + va_start(ap, format); + vLog(LOG_WARN, NULL, format, ap); + va_end(ap); } -char *getBaseName(char *filename) +void Error(char *format, ...) { - return getStringCopy(getBaseNamePtr(filename)); + va_list ap; + + va_start(ap, format); + vLog(LOG_ERROR, NULL, format, ap); + va_end(ap); } -char *getBasePath(char *filename) +void Fail(char *format, ...) { - char *basepath = getStringCopy(filename); - char *last_separator = getLastPathSeparatorPtr(basepath); - - if (last_separator != NULL) - *last_separator = '\0'; /* separator found: strip basename */ - else - basepath = "."; /* no separator found: use current path */ - - return basepath; -} + va_list ap; + va_start(ap, format); + vLog(LOG_FATAL, NULL, format, ap); + va_end(ap); -/* ------------------------------------------------------------------------- */ -/* various string functions */ -/* ------------------------------------------------------------------------- */ + if (!network.is_server_thread) + { + va_start(ap, format); + program.exit_message_function(format, ap); + va_end(ap); + } -char *getPath2(char *path1, char *path2) -{ - char *sep = STRING_PATH_SEPARATOR; - char *complete_path = checked_malloc(strlen(path1) + 1 + - strlen(path2) + 1); + Log(LOG_FATAL, NULL, "aborting"); - sprintf(complete_path, "%s%s%s", path1, sep, path2); + // network server thread: normal exit + if (network.is_server_thread) + exit(1); - return complete_path; + // main process: clean up stuff + program.exit_function(1); } -char *getPath3(char *path1, char *path2, char *path3) +void FailWithHelp(char *format, ...) { - char *sep = STRING_PATH_SEPARATOR; - char *complete_path = checked_malloc(strlen(path1) + 1 + - strlen(path2) + 1 + - strlen(path3) + 1); + va_list ap; + + va_start(ap, format); + vLog(LOG_FATAL, NULL, format, ap); + va_end(ap); - sprintf(complete_path, "%s%s%s%s%s", path1, sep, path2, sep, path3); + Log(LOG_FATAL, NULL, "try option '--help' for more information"); + Log(LOG_FATAL, NULL, "aborting"); - return complete_path; + // main process: clean up stuff + program.exit_function(1); } -char *getStringCat2(char *s1, char *s2) -{ - char *complete_string = checked_malloc(strlen(s1) + strlen(s2) + 1); - sprintf(complete_string, "%s%s", s1, s2); +// ---------------------------------------------------------------------------- +// string functions +// ---------------------------------------------------------------------------- - return complete_string; -} +/* int2str() returns a number converted to a string; + the used memory is static, but will be overwritten by later calls, + so if you want to save the result, copy it to a private string buffer; + there can be 10 local calls of int2str() without buffering the result -- + the 11th call will then destroy the result from the first call and so on. */ -char *getStringCopy(char *s) +char *int2str(int number, int size) { - char *s_copy; + static char shift_array[10][40]; + static int shift_counter = 0; + char *s = shift_array[shift_counter]; - if (s == NULL) - return NULL; + shift_counter = (shift_counter + 1) % 10; - s_copy = checked_malloc(strlen(s) + 1); - strcpy(s_copy, s); + if (size > 20) + size = 20; - return s_copy; + if (size > 0) + { + sprintf(s, " %09d", number); + return &s[strlen(s) - size]; + } + else + { + sprintf(s, "%d", number); + return s; + } } -char *getStringToLower(char *s) + +// 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) { - char *s_copy = checked_malloc(strlen(s) + 1); - char *s_ptr = s_copy; + static char *a = NULL; - while (*s) - *s_ptr++ = tolower(*s++); - *s_ptr = '\0'; + checked_free(a); - return s_copy; -} + if (i > 2147483647) // yes, this is a kludge + i = 2147483647; -void setString(char **old_value, char *new_value) -{ - checked_free(*old_value); + a = checked_malloc(10 + 1); - *old_value = getStringCopy(new_value); -} + sprintf(a, "%d", i); -boolean strEqual(char *s1, char *s2) -{ - return (s1 == NULL && s2 == NULL ? TRUE : - s1 == NULL && s2 != NULL ? FALSE : - s1 != NULL && s2 == NULL ? FALSE : - strcmp(s1, s2) == 0); + return a; } -/* ------------------------------------------------------------------------- */ -/* command line option handling functions */ -/* ------------------------------------------------------------------------- */ +// calculate base-2 logarithm of argument (rounded down to integer; +// this function returns the number of the highest bit set in argument) -void GetOptions(char *argv[], void (*print_usage_function)(void)) +int log_2(unsigned int x) { - char *ro_base_path = RO_BASE_PATH; - char *rw_base_path = RW_BASE_PATH; - char **options_left = &argv[1]; + int e = 0; -#if !defined(PLATFORM_MACOSX) - /* if the program is configured to start from current directory (default), - determine program package directory (KDE/Konqueror does not do this by - itself and fails otherwise); on Mac OS X, the program binary is stored - in an application package directory -- do not try to use this directory - as the program data directory (Mac OS X handles this correctly anyway) */ + while ((1 << e) < x) + { + x -= (1 << e); // for rounding down (rounding up: remove this line) + e++; + } - if (strEqual(ro_base_path, ".")) - ro_base_path = program.command_basepath; - if (strEqual(rw_base_path, ".")) - rw_base_path = program.command_basepath; -#endif + return e; +} - /* initialize global program options */ - options.display_name = NULL; - options.server_host = NULL; - options.server_port = 0; - options.ro_base_directory = ro_base_path; - options.rw_base_directory = rw_base_path; - options.level_directory = getPath2(ro_base_path, LEVELS_DIRECTORY); - options.graphics_directory = getPath2(ro_base_path, GRAPHICS_DIRECTORY); - options.sounds_directory = getPath2(ro_base_path, SOUNDS_DIRECTORY); - options.music_directory = getPath2(ro_base_path, MUSIC_DIRECTORY); - options.docs_directory = getPath2(ro_base_path, DOCS_DIRECTORY); - options.execute_command = NULL; - options.serveronly = FALSE; - options.network = FALSE; - options.verbose = FALSE; - options.debug = FALSE; +boolean getTokenValueFromString(char *string, char **token, char **value) +{ + return getTokenValueFromSetupLine(string, token, value); +} -#if !defined(PLATFORM_UNIX) - if (*options_left == NULL) /* no options given -- enable verbose mode */ - options.verbose = TRUE; -#endif - while (*options_left) - { - char option_str[MAX_OPTION_LEN]; - char *option = options_left[0]; - char *next_option = options_left[1]; - char *option_arg = NULL; - int option_len = strlen(option); +// ---------------------------------------------------------------------------- +// UUID functions +// ---------------------------------------------------------------------------- - if (option_len >= MAX_OPTION_LEN) - Error(ERR_EXIT_HELP, "unrecognized option '%s'", option); +#define UUID_BYTES 16 +#define UUID_CHARS (UUID_BYTES * 2) +#define UUID_LENGTH (UUID_CHARS + 4) - strcpy(option_str, option); /* copy argument into buffer */ - option = option_str; +static unsigned int uuid_random_function(int max) +{ + return GetBetterRandom(max); +} - if (strEqual(option, "--")) /* stop scanning arguments */ - break; +char *getUUIDExt(unsigned int (*random_function)(int max)) +{ + static char uuid[UUID_LENGTH + 1]; + int data[UUID_BYTES]; + int count = 0; + int i; - if (strncmp(option, "--", 2) == 0) /* treat '--' like '-' */ - option++; + for (i = 0; i < UUID_BYTES; i++) + data[i] = random_function(256); - option_arg = strchr(option, '='); - if (option_arg == NULL) /* no '=' in option */ - option_arg = next_option; - else - { - *option_arg++ = '\0'; /* cut argument from option */ - if (*option_arg == '\0') /* no argument after '=' */ - Error(ERR_EXIT_HELP, "option '%s' has invalid argument", option_str); - } + data[6] = 0x40 | (data[6] & 0x0f); + data[8] = 0x80 | (data[8] & 0x3f); - option_len = strlen(option); + for (i = 0; i < UUID_BYTES; i++) + { + sprintf(&uuid[count], "%02x", data[i]); + count += 2; - if (strEqual(option, "-")) - Error(ERR_EXIT_HELP, "unrecognized option '%s'", option); - else if (strncmp(option, "-help", option_len) == 0) - { - print_usage_function(); + if (i == 3 || i == 5 || i == 7 || i == 9) + strcat(&uuid[count++], "-"); + } - exit(0); - } - else if (strncmp(option, "-display", option_len) == 0) - { - if (option_arg == NULL) - Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str); + return uuid; +} - options.display_name = option_arg; - if (option_arg == next_option) - options_left++; - } - else if (strncmp(option, "-basepath", option_len) == 0) - { - if (option_arg == NULL) - Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str); +char *getUUID(void) +{ + return getUUIDExt(uuid_random_function); +} - /* this should be extended to separate options for ro and rw data */ - options.ro_base_directory = ro_base_path = option_arg; - options.rw_base_directory = rw_base_path = option_arg; - if (option_arg == next_option) - options_left++; - /* adjust paths for sub-directories in base directory accordingly */ - options.level_directory = getPath2(ro_base_path, LEVELS_DIRECTORY); - options.graphics_directory = getPath2(ro_base_path, GRAPHICS_DIRECTORY); - options.sounds_directory = getPath2(ro_base_path, SOUNDS_DIRECTORY); - options.music_directory = getPath2(ro_base_path, MUSIC_DIRECTORY); - options.docs_directory = getPath2(ro_base_path, DOCS_DIRECTORY); - } - else if (strncmp(option, "-levels", option_len) == 0) - { - if (option_arg == NULL) - Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str); +// ---------------------------------------------------------------------------- +// counter functions +// ---------------------------------------------------------------------------- - options.level_directory = option_arg; - if (option_arg == next_option) - options_left++; - } - else if (strncmp(option, "-graphics", option_len) == 0) - { - if (option_arg == NULL) - Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str); +// maximal allowed length of a command line option +#define MAX_OPTION_LEN 256 - options.graphics_directory = option_arg; - if (option_arg == next_option) - options_left++; - } - else if (strncmp(option, "-sounds", option_len) == 0) - { - if (option_arg == NULL) - Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str); +static unsigned int getCurrentMS(void) +{ + return SDL_GetTicks(); +} - options.sounds_directory = option_arg; - if (option_arg == next_option) - options_left++; - } - else if (strncmp(option, "-music", option_len) == 0) - { - if (option_arg == NULL) - Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str); +static unsigned int mainCounter(int mode) +{ + static unsigned int base_ms = 0; + unsigned int current_ms; - options.music_directory = option_arg; - if (option_arg == next_option) - options_left++; - } - else if (strncmp(option, "-network", option_len) == 0) - { - options.network = TRUE; - } - else if (strncmp(option, "-serveronly", option_len) == 0) - { - options.serveronly = TRUE; - } - else if (strncmp(option, "-verbose", option_len) == 0) - { - options.verbose = TRUE; - } - else if (strncmp(option, "-debug", option_len) == 0) - { - options.debug = TRUE; - } - else if (strncmp(option, "-execute", option_len) == 0) - { - if (option_arg == NULL) - Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str); + // get current system milliseconds + current_ms = getCurrentMS(); - options.execute_command = option_arg; - if (option_arg == next_option) - options_left++; + // reset base timestamp in case of counter reset or wrap-around + if (mode == INIT_COUNTER || current_ms < base_ms) + base_ms = current_ms; - /* when doing batch processing, always enable verbose mode (warnings) */ - options.verbose = TRUE; - } - else if (*option == '-') - { - Error(ERR_EXIT_HELP, "unrecognized option '%s'", option_str); - } - else if (options.server_host == NULL) - { - options.server_host = *options_left; - } - else if (options.server_port == 0) - { - options.server_port = atoi(*options_left); - if (options.server_port < 1024) - Error(ERR_EXIT_HELP, "bad port number '%d'", options.server_port); - } - else - Error(ERR_EXIT_HELP, "too many arguments"); + // return milliseconds since last counter reset + return current_ms - base_ms; +} - options_left++; - } +void InitCounter() // set counter back to zero +{ + mainCounter(INIT_COUNTER); } +unsigned int Counter() // get milliseconds since last call of InitCounter() +{ + return mainCounter(READ_COUNTER); +} -/* ------------------------------------------------------------------------- */ -/* error handling functions */ -/* ------------------------------------------------------------------------- */ +static void sleep_milliseconds(unsigned int milliseconds_delay) +{ + SDL_Delay(milliseconds_delay); +} -/* used by SetError() and GetError() to store internal error messages */ -static char internal_error[1024]; /* this is bad */ +void Delay(unsigned int delay) // Sleep specified number of milliseconds +{ + sleep_milliseconds(delay); +} -void SetError(char *format, ...) +boolean DelayReachedExt(unsigned int *counter_var, unsigned int delay, + unsigned int actual_counter) { - va_list ap; + if (actual_counter >= *counter_var && + actual_counter < *counter_var + delay) + return FALSE; - va_start(ap, format); - vsprintf(internal_error, format, ap); - va_end(ap); + *counter_var = actual_counter; + + return TRUE; } -char *GetError() +boolean FrameReached(unsigned int *frame_counter_var, unsigned int frame_delay) { - return internal_error; + return DelayReachedExt(frame_counter_var, frame_delay, FrameCounter); } -#if 1 +boolean DelayReached(unsigned int *counter_var, unsigned int delay) +{ + return DelayReachedExt(counter_var, delay, Counter()); +} -void Error(int mode, char *format, ...) +void ResetDelayCounterExt(unsigned int *counter_var, + unsigned int actual_counter) { - static boolean last_line_was_separator = FALSE; - char *process_name = ""; + DelayReachedExt(counter_var, 0, actual_counter); +} - /* display warnings only when running in verbose mode */ - if (mode & ERR_WARN && !options.verbose) - return; - - if (mode == ERR_RETURN_LINE) - { - if (!last_line_was_separator) - fprintf_line(program.error_file, format, 79); - - last_line_was_separator = TRUE; - - return; - } +void ResetFrameCounter(unsigned int *frame_counter_var) +{ + FrameReached(frame_counter_var, 0); +} - last_line_was_separator = FALSE; +void ResetDelayCounter(unsigned int *counter_var) +{ + DelayReached(counter_var, 0); +} - if (mode & ERR_SOUND_SERVER) - process_name = " sound server"; - else if (mode & ERR_NETWORK_SERVER) - process_name = " network server"; - else if (mode & ERR_NETWORK_CLIENT) - process_name = " network client **"; +int WaitUntilDelayReached(unsigned int *counter_var, unsigned int delay) +{ + unsigned int actual_counter; + int skip_frames = 0; - if (format) + while (1) { - va_list ap; + actual_counter = Counter(); - fprintf(program.error_file, "%s%s: ", program.command_basename, - process_name); + if (actual_counter >= *counter_var && + actual_counter < *counter_var + delay) + sleep_milliseconds((*counter_var + delay - actual_counter) / 2); + else + break; + } - if (mode & ERR_WARN) - fprintf(program.error_file, "warning: "); + if (*counter_var != 0 && + delay != 0 && + actual_counter >= *counter_var + delay) + { + int lag = actual_counter - (*counter_var + delay); + int delay2 = (delay + 1) / 2; - va_start(ap, format); - vfprintf_newline(program.error_file, format, ap); - va_end(ap); + if (lag >= delay2) + skip_frames = (lag + delay2) / delay; } - - if (mode & ERR_HELP) - fprintf_newline(program.error_file, - "%s: Try option '--help' for more information.", - program.command_basename); - if (mode & ERR_EXIT) - fprintf_newline(program.error_file, "%s%s: aborting", - program.command_basename, process_name); + *counter_var = actual_counter; - if (mode & ERR_EXIT) - { - if (mode & ERR_FROM_SERVER) - exit(1); /* child process: normal exit */ - else - program.exit_function(1); /* main process: clean up stuff */ - } + return skip_frames; } -#else - -void Error(int mode, char *format, ...) +void SkipUntilDelayReached(unsigned int *counter_var, unsigned int delay, + int *loop_var, int last_loop_value) { - static boolean last_line_was_separator = FALSE; - char *process_name = ""; - FILE *error = stderr; - char *newline = "\n"; - - /* display warnings only when running in verbose mode */ - if (mode & ERR_WARN && !options.verbose) - return; - - if (mode == ERR_RETURN_LINE) - { - if (!last_line_was_separator) - fprintf_line(error, format, 79); + int skip_frames = WaitUntilDelayReached(counter_var, delay); - last_line_was_separator = TRUE; +#if 0 +#if DEBUG + if (skip_frames) + Debug("internal:SkipUntilDelayReached", + "%d: %d ms -> SKIP %d FRAME(S) [%d ms]", + *loop_var, delay, + skip_frames, skip_frames * delay); + else + Debug("internal:SkipUntilDelayReached", + "%d: %d ms", + *loop_var, delay); +#endif +#endif + if (skip_frames == 0) return; - } - last_line_was_separator = FALSE; + // when skipping frames, make sure to never skip the last frame, as + // this may be needed for animations to reach a defined end state; + // furthermore, we assume that this function is called at the end + // of a "for" loop, which continues by incrementing the loop variable + // by one before checking the loop condition again; therefore we have + // to check against the last loop value minus one here -#if defined(PLATFORM_WIN32) || defined(PLATFORM_MSDOS) - newline = "\r\n"; + last_loop_value--; - if ((error = openErrorFile()) == NULL) + if (*loop_var < last_loop_value) // never skip the last frame { - printf("Cannot write to error output file!%s", newline); + *loop_var += skip_frames; - program.exit_function(1); + if (*loop_var > last_loop_value) // never skip the last frame + *loop_var = last_loop_value; } -#endif +} - if (mode & ERR_SOUND_SERVER) - process_name = " sound server"; - else if (mode & ERR_NETWORK_SERVER) - process_name = " network server"; - else if (mode & ERR_NETWORK_CLIENT) - process_name = " network client **"; - if (format) - { - va_list ap; +// ---------------------------------------------------------------------------- +// random generator functions +// ---------------------------------------------------------------------------- - fprintf(error, "%s%s: ", program.command_basename, process_name); +static unsigned int init_random_number_ext(int nr, int seed) +{ + if (seed == NEW_RANDOMIZE) + { + // default random seed + seed = (int)time(NULL); // seconds since the epoch - if (mode & ERR_WARN) - fprintf(error, "warning: "); +#if !defined(PLATFORM_WIN32) + // add some more randomness + struct timeval current_time; - va_start(ap, format); - vfprintf(error, format, ap); - va_end(ap); - - fprintf(error, "%s", newline); - } - - if (mode & ERR_HELP) - fprintf(error, "%s: Try option '--help' for more information.%s", - program.command_basename, newline); + gettimeofday(¤t_time, NULL); - if (mode & ERR_EXIT) - fprintf(error, "%s%s: aborting%s", - program.command_basename, process_name, newline); + seed += (int)current_time.tv_usec; // microseconds since the epoch +#endif - if (error != stderr) - fclose(error); + // add some more randomness + seed += (int)SDL_GetTicks(); // milliseconds since SDL init - if (mode & ERR_EXIT) - { - if (mode & ERR_FROM_SERVER) - exit(1); /* child process: normal exit */ - else - program.exit_function(1); /* main process: clean up stuff */ + // add some more randomness + seed += GetSimpleRandom(1000000); } -} - -#endif + srandom_linux_libc(nr, (unsigned int) seed); -/* ------------------------------------------------------------------------- */ -/* checked memory allocation and freeing functions */ -/* ------------------------------------------------------------------------- */ + return (unsigned int) seed; +} -void *checked_malloc(unsigned long size) +static unsigned int prng_seed_gettimeofday(void) { - void *ptr; + struct timeval current_time; - ptr = malloc(size); + gettimeofday(¤t_time, NULL); - if (ptr == NULL) - Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size); + prng_seed_bytes(¤t_time, sizeof(current_time)); - return ptr; + return 0; } -void *checked_calloc(unsigned long size) +unsigned int init_random_number(int nr, int seed) { - void *ptr; - - ptr = calloc(1, size); - - if (ptr == NULL) - Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size); - - return ptr; + return (nr == RANDOM_BETTER ? prng_seed_gettimeofday() : + init_random_number_ext(nr, seed)); } -void *checked_realloc(void *ptr, unsigned long size) +static unsigned int get_random_number_ext(int nr) { - ptr = realloc(ptr, size); - - if (ptr == NULL) - Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size); - - return ptr; + return (nr == RANDOM_BETTER ? prng_get_uint() : + random_linux_libc(nr)); } -void checked_free(void *ptr) +unsigned int get_random_number(int nr, int max) { - if (ptr != NULL) /* this check should be done by free() anyway */ - free(ptr); + return (max > 0 ? get_random_number_ext(nr) % max : 0); } -/* ------------------------------------------------------------------------- */ -/* various helper functions */ -/* ------------------------------------------------------------------------- */ +// ---------------------------------------------------------------------------- +// system info functions +// ---------------------------------------------------------------------------- -inline void swap_numbers(int *i1, int *i2) +#if !defined(PLATFORM_ANDROID) +static char *get_corrected_real_name(char *real_name) { - int help = *i1; + char *real_name_new = checked_malloc(MAX_USERNAME_LEN + 1); + char *from_ptr = real_name; + char *to_ptr = real_name_new; - *i1 = *i2; - *i2 = help; -} + // copy the name string, but not more than MAX_USERNAME_LEN characters + while (*from_ptr && (int)(to_ptr - real_name_new) < MAX_USERNAME_LEN - 1) + { + // the name field read from "passwd" file may also contain additional + // user information, separated by commas, which will be removed here + if (*from_ptr == ',') + break; -inline void swap_number_pairs(int *x1, int *y1, int *x2, int *y2) -{ - int help_x = *x1; - int help_y = *y1; + // the user's real name may contain 'german sharp s' characters, + // which have no equivalent in upper case letters (used by our fonts) + if (*from_ptr == CHAR_BYTE_SHARP_S) + { + from_ptr++; + *to_ptr++ = 's'; + *to_ptr++ = 's'; + } + else + *to_ptr++ = *from_ptr++; + } - *x1 = *x2; - *x2 = help_x; + *to_ptr = '\0'; - *y1 = *y2; - *y2 = help_y; + return real_name_new; } +#endif -/* the "put" variants of the following file access functions check for the file - pointer being != NULL and return the number of bytes they have or would have - written; this allows for chunk writing functions to first determine the size - of the (not yet written) chunk, write the correct chunk size and finally - write the chunk itself */ - -int getFile8BitInteger(FILE *file) +#if defined(PLATFORM_UNIX) +static struct passwd *getPasswdEntry(void) { - return fgetc(file); +#if defined(PLATFORM_EMSCRIPTEN) + // currently not fully supported; force fallback to default values + return NULL; +#else + return getpwuid(getuid()); +#endif } -int putFile8BitInteger(FILE *file, int value) +char *getUnixLoginName(void) { - if (file != NULL) - fputc(value, file); + struct passwd *pwd = getPasswdEntry(); - return 1; -} + if (pwd != NULL && strlen(pwd->pw_name) != 0) + return pwd->pw_name; -int getFile16BitInteger(FILE *file, int byte_order) -{ - if (byte_order == BYTE_ORDER_BIG_ENDIAN) - return ((fgetc(file) << 8) | - (fgetc(file) << 0)); - else /* BYTE_ORDER_LITTLE_ENDIAN */ - return ((fgetc(file) << 0) | - (fgetc(file) << 8)); + return NULL; } -int putFile16BitInteger(FILE *file, int value, int byte_order) +char *getUnixRealName(void) { - if (file != NULL) - { - if (byte_order == BYTE_ORDER_BIG_ENDIAN) - { - fputc((value >> 8) & 0xff, file); - fputc((value >> 0) & 0xff, file); - } - else /* BYTE_ORDER_LITTLE_ENDIAN */ - { - fputc((value >> 0) & 0xff, file); - fputc((value >> 8) & 0xff, file); - } - } + struct passwd *pwd = getPasswdEntry(); - return 2; -} + if (pwd != NULL && strlen(pwd->pw_gecos) != 0) + return pwd->pw_gecos; -int getFile32BitInteger(FILE *file, int byte_order) -{ - if (byte_order == BYTE_ORDER_BIG_ENDIAN) - return ((fgetc(file) << 24) | - (fgetc(file) << 16) | - (fgetc(file) << 8) | - (fgetc(file) << 0)); - else /* BYTE_ORDER_LITTLE_ENDIAN */ - return ((fgetc(file) << 0) | - (fgetc(file) << 8) | - (fgetc(file) << 16) | - (fgetc(file) << 24)); + return NULL; } -int putFile32BitInteger(FILE *file, int value, int byte_order) +char *getUnixHomeDir(void) { - if (file != NULL) - { - if (byte_order == BYTE_ORDER_BIG_ENDIAN) - { - fputc((value >> 24) & 0xff, file); - fputc((value >> 16) & 0xff, file); - fputc((value >> 8) & 0xff, file); - fputc((value >> 0) & 0xff, file); - } - else /* BYTE_ORDER_LITTLE_ENDIAN */ - { - fputc((value >> 0) & 0xff, file); - fputc((value >> 8) & 0xff, file); - fputc((value >> 16) & 0xff, file); - fputc((value >> 24) & 0xff, file); - } - } + struct passwd *pwd = getPasswdEntry(); - return 4; + if (pwd != NULL && strlen(pwd->pw_dir) != 0) + return pwd->pw_dir; + + return NULL; } +#endif -boolean getFileChunk(FILE *file, char *chunk_name, int *chunk_size, - int byte_order) +char *getLoginName(void) { - const int chunk_name_length = 4; + static char *login_name = NULL; + +#if defined(PLATFORM_WIN32) + if (login_name == NULL) + { + unsigned long buffer_size = MAX_USERNAME_LEN + 1; - /* read chunk name */ - fgets(chunk_name, chunk_name_length + 1, file); + login_name = checked_malloc(buffer_size); - if (chunk_size != NULL) + if (GetUserName(login_name, &buffer_size) == 0) + strcpy(login_name, ANONYMOUS_NAME); + } +#elif defined(PLATFORM_UNIX) && !defined(PLATFORM_ANDROID) + if (login_name == NULL) { - /* read chunk size */ - *chunk_size = getFile32BitInteger(file, byte_order); + char *name = getUnixLoginName(); + + if (name != NULL) + login_name = getStringCopy(name); + else + login_name = ANONYMOUS_NAME; } +#else + login_name = ANONYMOUS_NAME; +#endif - return (feof(file) || ferror(file) ? FALSE : TRUE); + return login_name; } -int putFileChunk(FILE *file, char *chunk_name, int chunk_size, - int byte_order) +char *getRealName(void) { - int num_bytes = 0; - - /* write chunk name */ - if (file != NULL) - fputs(chunk_name, file); + static char *real_name = NULL; - num_bytes += strlen(chunk_name); +#if defined(PLATFORM_WIN32) + if (real_name == NULL) + { + static char buffer[MAX_USERNAME_LEN + 1]; + unsigned long buffer_size = MAX_USERNAME_LEN + 1; - if (chunk_size >= 0) + if (GetUserName(buffer, &buffer_size) != 0) + real_name = get_corrected_real_name(buffer); + else + real_name = ANONYMOUS_NAME; + } +#elif defined(PLATFORM_UNIX) && !defined(PLATFORM_ANDROID) + if (real_name == NULL) { - /* write chunk size */ - if (file != NULL) - putFile32BitInteger(file, chunk_size, byte_order); + char *name = getUnixRealName(); - num_bytes += 4; + if (name != NULL) + real_name = get_corrected_real_name(name); + else + real_name = ANONYMOUS_NAME; } +#else + real_name = ANONYMOUS_NAME; +#endif - return num_bytes; + return real_name; } -int getFileVersion(FILE *file) +char *getFixedUserName(char *name) { - int version_major = fgetc(file); - int version_minor = fgetc(file); - int version_patch = fgetc(file); - int version_build = fgetc(file); + // needed because player name must be a fixed length string + char *name_new = checked_malloc(MAX_PLAYER_NAME_LEN + 1); + + strncpy(name_new, name, MAX_PLAYER_NAME_LEN); + name_new[MAX_PLAYER_NAME_LEN] = '\0'; - return VERSION_IDENT(version_major, version_minor, version_patch, - version_build); + if (strlen(name) > MAX_PLAYER_NAME_LEN) // name has been cut + if (strchr(name_new, ' ')) + *strchr(name_new, ' ') = '\0'; + + return name_new; } -int putFileVersion(FILE *file, int version) +char *getDefaultUserName(int nr) { - if (file != NULL) - { - int version_major = VERSION_MAJOR(version); - int version_minor = VERSION_MINOR(version); - int version_patch = VERSION_PATCH(version); - int version_build = VERSION_BUILD(version); + static char *user_name[MAX_PLAYER_NAMES] = { NULL }; - fputc(version_major, file); - fputc(version_minor, file); - fputc(version_patch, file); - fputc(version_build, file); + nr = MIN(MAX(0, nr), MAX_PLAYER_NAMES - 1); + + if (user_name[nr] == NULL) + { + user_name[nr] = (nr == 0 ? getLoginName() : EMPTY_PLAYER_NAME); + user_name[nr] = getFixedUserName(user_name[nr]); } - return 4; + return user_name[nr]; } -void ReadBytesFromFile(FILE *file, byte *buffer, unsigned long bytes) +char *getTimestampFromEpoch(time_t epoch_seconds) { - int i; + struct tm *now = localtime(&epoch_seconds); + static char timestamp[20]; - for(i = 0; i < bytes && !feof(file); i++) - buffer[i] = fgetc(file); -} - -void WriteBytesToFile(FILE *file, byte *buffer, unsigned long bytes) -{ - int i; + sprintf(timestamp, "%04d%02d%02d-%02d%02d%02d", + now->tm_year + 1900, now->tm_mon + 1, now->tm_mday, + now->tm_hour, now->tm_min, now->tm_sec); - for(i = 0; i < bytes; i++) - fputc(buffer[i], file); + return timestamp; } -void ReadUnusedBytesFromFile(FILE *file, unsigned long bytes) +char *getCurrentTimestamp(void) { - while (bytes-- && !feof(file)) - fgetc(file); + return getTimestampFromEpoch(time(NULL)); } -void WriteUnusedBytesToFile(FILE *file, unsigned long bytes) +time_t getFileTimestampEpochSeconds(char *filename) { - while (bytes--) - fputc(0, file); -} + struct stat file_status; + if (stat(filename, &file_status) != 0) // cannot stat file + return 0; -/* ------------------------------------------------------------------------- */ -/* functions to translate key identifiers between different format */ -/* ------------------------------------------------------------------------- */ + return file_status.st_mtime; +} -#define TRANSLATE_KEYSYM_TO_KEYNAME 0 -#define TRANSLATE_KEYSYM_TO_X11KEYNAME 1 -#define TRANSLATE_KEYNAME_TO_KEYSYM 2 -#define TRANSLATE_X11KEYNAME_TO_KEYSYM 3 -void translate_keyname(Key *keysym, char **x11name, char **name, int mode) +// ---------------------------------------------------------------------------- +// path manipulation functions +// ---------------------------------------------------------------------------- + +static char *getLastPathSeparatorPtr(char *filename) { - static struct + char *last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_UNIX); + + if (last_separator == NULL) // also try DOS/Windows variant + last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_DOS); + + return last_separator; +} + +char *getBaseNamePtr(char *filename) +{ + char *last_separator = getLastPathSeparatorPtr(filename); + + if (last_separator != NULL) + return last_separator + 1; // separator found: strip base path + else + return filename; // no separator found: filename has no path +} + +char *getBaseName(char *filename) +{ + return getStringCopy(getBaseNamePtr(filename)); +} + +char *getBaseNameNoSuffix(char *filename) +{ + char *basename = getStringCopy(getBaseNamePtr(filename)); + + // remove trailing suffix (separated by dot or hyphen) + if (basename[0] != '.' && basename[0] != '-') + { + if (strchr(basename, '.') != NULL) + *strchr(basename, '.') = '\0'; + + if (strchr(basename, '-') != NULL) + *strchr(basename, '-') = '\0'; + } + + return basename; +} + +char *getBasePath(char *filename) +{ + char *basepath = getStringCopy(filename); + char *last_separator = getLastPathSeparatorPtr(basepath); + + // if no separator was found, use current directory + if (last_separator == NULL) + { + free(basepath); + + return getStringCopy("."); + } + + // separator found: strip basename + *last_separator = '\0'; + + return basepath; +} + + +// ---------------------------------------------------------------------------- +// various string functions +// ---------------------------------------------------------------------------- + +char *getStringCat2WithSeparator(char *s1, char *s2, char *sep) +{ + if (s1 == NULL || s2 == NULL || sep == NULL) + return NULL; + + char *complete_string = checked_malloc(strlen(s1) + strlen(sep) + + strlen(s2) + 1); + + sprintf(complete_string, "%s%s%s", s1, sep, s2); + + return complete_string; +} + +char *getStringCat3WithSeparator(char *s1, char *s2, char *s3, char *sep) +{ + if (s1 == NULL || s2 == NULL || s3 == NULL || sep == NULL) + return NULL; + + char *complete_string = checked_malloc(strlen(s1) + strlen(sep) + + strlen(s2) + strlen(sep) + + strlen(s3) + 1); + + sprintf(complete_string, "%s%s%s%s%s", s1, sep, s2, sep, s3); + + return complete_string; +} + +char *getStringCat2(char *s1, char *s2) +{ + return getStringCat2WithSeparator(s1, s2, ""); +} + +char *getStringCat3(char *s1, char *s2, char *s3) +{ + return getStringCat3WithSeparator(s1, s2, s3, ""); +} + +char *getPath2(char *path1, char *path2) +{ +#if defined(PLATFORM_ANDROID) + // workaround for reading from assets directory -- skip "." subdirs in path + if (strEqual(path1, ".")) + return getStringCopy(path2); + else if (strEqual(path2, ".")) + return getStringCopy(path1); +#endif + + return getStringCat2WithSeparator(path1, path2, STRING_PATH_SEPARATOR); +} + +char *getPath3(char *path1, char *path2, char *path3) +{ +#if defined(PLATFORM_ANDROID) + // workaround for reading from assets directory -- skip "." subdirs in path + if (strEqual(path1, ".")) + return getStringCat2WithSeparator(path2, path3, STRING_PATH_SEPARATOR); + else if (strEqual(path2, ".")) + return getStringCat2WithSeparator(path1, path3, STRING_PATH_SEPARATOR); + else if (strEqual(path3, ".")) + return getStringCat2WithSeparator(path1, path2, STRING_PATH_SEPARATOR); +#endif + + return getStringCat3WithSeparator(path1, path2, path3, STRING_PATH_SEPARATOR); +} + +static char *getPngOrPcxIfNotExists(char *filename) +{ + // switch from PNG to PCX file and vice versa, if file does not exist + // (backwards compatibility with PCX files used in previous versions) + + if (!fileExists(filename) && strSuffix(filename, ".png")) + strcpy(&filename[strlen(filename) - 3], "pcx"); + else if (!fileExists(filename) && strSuffix(filename, ".pcx")) + strcpy(&filename[strlen(filename) - 3], "png"); + + return filename; +} + +char *getImg2(char *path1, char *path2) +{ + return getPngOrPcxIfNotExists(getPath2(path1, path2)); +} + +char *getImg3(char *path1, char *path2, char *path3) +{ + return getPngOrPcxIfNotExists(getPath3(path1, path2, path3)); +} + +char *getStringCopy(const char *s) +{ + char *s_copy; + + if (s == NULL) + return NULL; + + s_copy = checked_malloc(strlen(s) + 1); + strcpy(s_copy, s); + + return s_copy; +} + +char *getStringCopyN(const char *s, int n) +{ + char *s_copy; + int s_len = MAX(0, n); + + if (s == NULL) + return NULL; + + s_copy = checked_malloc(s_len + 1); + strncpy(s_copy, s, s_len); + s_copy[s_len] = '\0'; + + return s_copy; +} + +char *getStringCopyNStatic(const char *s, int n) +{ + static char *s_copy = NULL; + + checked_free(s_copy); + + s_copy = getStringCopyN(s, n); + + return s_copy; +} + +char *getStringToLower(const char *s) +{ + char *s_copy = checked_malloc(strlen(s) + 1); + char *s_ptr = s_copy; + + while (*s) + *s_ptr++ = tolower(*s++); + *s_ptr = '\0'; + + return s_copy; +} + +void setString(char **old_value, char *new_value) +{ + checked_free(*old_value); + + *old_value = getStringCopy(new_value); +} + +boolean strEqual(char *s1, char *s2) +{ + return (s1 == NULL && s2 == NULL ? TRUE : + s1 == NULL && s2 != NULL ? FALSE : + s1 != NULL && s2 == NULL ? FALSE : + strcmp(s1, s2) == 0); +} + +boolean strEqualN(char *s1, char *s2, int n) +{ + return (s1 == NULL && s2 == NULL ? TRUE : + s1 == NULL && s2 != NULL ? FALSE : + s1 != NULL && s2 == NULL ? FALSE : + strncmp(s1, s2, n) == 0); +} + +boolean strEqualCase(char *s1, char *s2) +{ + return (s1 == NULL && s2 == NULL ? TRUE : + s1 == NULL && s2 != NULL ? FALSE : + s1 != NULL && s2 == NULL ? FALSE : + strcasecmp(s1, s2) == 0); +} + +boolean strEqualCaseN(char *s1, char *s2, int n) +{ + return (s1 == NULL && s2 == NULL ? TRUE : + s1 == NULL && s2 != NULL ? FALSE : + s1 != NULL && s2 == NULL ? FALSE : + strncasecmp(s1, s2, n) == 0); +} + +boolean strPrefix(char *s, char *prefix) +{ + return (s == NULL && prefix == NULL ? TRUE : + s == NULL && prefix != NULL ? FALSE : + s != NULL && prefix == NULL ? FALSE : + strncmp(s, prefix, strlen(prefix)) == 0); +} + +boolean strSuffix(char *s, char *suffix) +{ + return (s == NULL && suffix == NULL ? TRUE : + s == NULL && suffix != NULL ? FALSE : + s != NULL && suffix == NULL ? FALSE : + strlen(s) < strlen(suffix) ? FALSE : + strcmp(&s[strlen(s) - strlen(suffix)], suffix) == 0); +} + +boolean strPrefixLower(char *s, char *prefix) +{ + char *s_lower = getStringToLower(s); + boolean match = strPrefix(s_lower, prefix); + + free(s_lower); + + return match; +} + +boolean strSuffixLower(char *s, char *suffix) +{ + char *s_lower = getStringToLower(s); + boolean match = strSuffix(s_lower, suffix); + + free(s_lower); + + return match; +} + + +// ---------------------------------------------------------------------------- +// command line option handling functions +// ---------------------------------------------------------------------------- + +void GetOptions(int argc, char *argv[], + void (*print_usage_function)(void), + void (*print_version_function)(void)) +{ + char *base_path = getProgramMainDataPath(argv[0], BASE_PATH); + char **argvplus = checked_calloc((argc + 1) * sizeof(char **)); + char **options_left = &argvplus[1]; + + // replace original "argv" with null-terminated array of string pointers + while (argc--) + argvplus[argc] = argv[argc]; + + // initialize global program options + options.server_host = NULL; + options.server_port = 0; + + options.base_directory = base_path; + + options.level_directory = getPath2(base_path, LEVELS_DIRECTORY); + options.graphics_directory = getPath2(base_path, GRAPHICS_DIRECTORY); + options.sounds_directory = getPath2(base_path, SOUNDS_DIRECTORY); + options.music_directory = getPath2(base_path, MUSIC_DIRECTORY); + options.docs_directory = getPath2(base_path, DOCS_DIRECTORY); + options.conf_directory = getPath2(base_path, CONF_DIRECTORY); + + options.execute_command = NULL; + options.tape_log_filename = NULL; + options.special_flags = NULL; + options.debug_mode = NULL; + options.player_name = NULL; + options.identifier = NULL; + options.level_nr = NULL; + + options.mytapes = FALSE; + options.serveronly = FALSE; + options.network = FALSE; + options.verbose = FALSE; + options.debug = FALSE; + +#if 1 + options.verbose = TRUE; +#else +#if !defined(PLATFORM_UNIX) + if (*options_left == NULL) // no options given -- enable verbose mode + options.verbose = TRUE; +#endif +#endif + +#if DEBUG +#if defined(PLATFORM_ANDROID) + options.debug = TRUE; +#endif +#endif + + while (*options_left) + { + char option_str[MAX_OPTION_LEN]; + char *option = options_left[0]; + char *next_option = options_left[1]; + char *option_arg = NULL; + int option_len = strlen(option); + + if (option_len >= MAX_OPTION_LEN) + FailWithHelp("unrecognized option '%s'", option); + + strcpy(option_str, option); // copy argument into buffer + option = option_str; + + if (strEqual(option, "--")) // stop scanning arguments + break; + + if (strPrefix(option, "--")) // treat '--' like '-' + option++; + + option_arg = strchr(option, '='); + if (option_arg == NULL) // no '=' in option + option_arg = next_option; + else + { + *option_arg++ = '\0'; // cut argument from option + if (*option_arg == '\0') // no argument after '=' + FailWithHelp("option '%s' has invalid argument", option_str); + } + + option_len = strlen(option); + + if (strEqual(option, "-")) + { + FailWithHelp("unrecognized option '%s'", option); + } + else if (strncmp(option, "-help", option_len) == 0) + { + print_usage_function(); + + exit(0); + } + else if (strncmp(option, "-basepath", option_len) == 0) + { + if (option_arg == NULL) + FailWithHelp("option '%s' requires an argument", option_str); + + options.base_directory = base_path = getStringCopy(option_arg); + if (option_arg == next_option) + options_left++; + + // adjust paths for sub-directories in base directory accordingly + options.level_directory = getPath2(base_path, LEVELS_DIRECTORY); + options.graphics_directory = getPath2(base_path, GRAPHICS_DIRECTORY); + options.sounds_directory = getPath2(base_path, SOUNDS_DIRECTORY); + options.music_directory = getPath2(base_path, MUSIC_DIRECTORY); + options.docs_directory = getPath2(base_path, DOCS_DIRECTORY); + options.conf_directory = getPath2(base_path, CONF_DIRECTORY); + } + else if (strncmp(option, "-levels", option_len) == 0) + { + if (option_arg == NULL) + FailWithHelp("option '%s' requires an argument", option_str); + + options.level_directory = getStringCopy(option_arg); + if (option_arg == next_option) + options_left++; + } + else if (strncmp(option, "-graphics", option_len) == 0) + { + if (option_arg == NULL) + FailWithHelp("option '%s' requires an argument", option_str); + + options.graphics_directory = getStringCopy(option_arg); + if (option_arg == next_option) + options_left++; + } + else if (strncmp(option, "-sounds", option_len) == 0) + { + if (option_arg == NULL) + FailWithHelp("option '%s' requires an argument", option_str); + + options.sounds_directory = getStringCopy(option_arg); + if (option_arg == next_option) + options_left++; + } + else if (strncmp(option, "-music", option_len) == 0) + { + if (option_arg == NULL) + FailWithHelp("option '%s' requires an argument", option_str); + + options.music_directory = getStringCopy(option_arg); + if (option_arg == next_option) + options_left++; + } + else if (strncmp(option, "-mytapes", option_len) == 0) + { + options.mytapes = TRUE; + } + else if (strncmp(option, "-network", option_len) == 0) + { + options.network = TRUE; + } + else if (strncmp(option, "-serveronly", option_len) == 0) + { + options.serveronly = TRUE; + } + else if (strncmp(option, "-debug", option_len) == 0) + { + options.debug = TRUE; + + // optionally, debug output can be limited to a specific debug mode + if (option_arg != next_option) + options.debug_mode = getStringCopy(option_arg); + } + else if (strncmp(option, "-player-name", option_len) == 0) + { + if (option_arg == NULL) + FailWithHelp("option '%s' requires an argument", option_str); + + options.player_name = getStringCopy(option_arg); + if (option_arg == next_option) + options_left++; + } + else if (strncmp(option, "-identifier", option_len) == 0) + { + if (option_arg == NULL) + FailWithHelp("option '%s' requires an argument", option_str); + + options.identifier = getStringCopy(option_arg); + if (option_arg == next_option) + options_left++; + } + else if (strncmp(option, "-level-nr", option_len) == 0) + { + if (option_arg == NULL) + FailWithHelp("option '%s' requires an argument", option_str); + + options.level_nr = getStringCopy(option_arg); + if (option_arg == next_option) + options_left++; + } + else if (strncmp(option, "-verbose", option_len) == 0) + { + options.verbose = TRUE; + } + else if (strncmp(option, "-version", option_len) == 0 || + strncmp(option, "-V", option_len) == 0) + { + print_version_function(); + + exit(0); + } + else if (strPrefix(option, "-D")) + { + options.special_flags = getStringCopy(&option[2]); + } + else if (strncmp(option, "-execute", option_len) == 0) + { + if (option_arg == NULL) + FailWithHelp("option '%s' requires an argument", option_str); + + options.execute_command = getStringCopy(option_arg); + if (option_arg == next_option) + options_left++; + + // when doing batch processing, always enable verbose mode (warnings) + options.verbose = TRUE; + } + else if (strncmp(option, "-tape_logfile", option_len) == 0) + { + if (option_arg == NULL) + FailWithHelp("option '%s' requires an argument", option_str); + + options.tape_log_filename = getStringCopy(option_arg); + if (option_arg == next_option) + options_left++; + } +#if defined(PLATFORM_MACOSX) + else if (strPrefix(option, "-psn")) + { + // ignore process serial number when launched via GUI on Mac OS X + } +#endif + else if (*option == '-') + { + FailWithHelp("unrecognized option '%s'", option_str); + } + else if (options.server_host == NULL) + { + options.server_host = *options_left; + } + else if (options.server_port == 0) + { + options.server_port = atoi(*options_left); + if (options.server_port < 1024) + FailWithHelp("bad port number '%d'", options.server_port); + } + else + FailWithHelp("too many arguments"); + + options_left++; + } +} + + +// ---------------------------------------------------------------------------- +// checked memory allocation and freeing functions +// ---------------------------------------------------------------------------- + +void *checked_malloc(unsigned int size) +{ + void *ptr; + + ptr = malloc(size); + + if (ptr == NULL) + Fail("cannot allocate %d bytes -- out of memory", size); + + return ptr; +} + +void *checked_calloc(unsigned int size) +{ + void *ptr; + + ptr = calloc(1, size); + + if (ptr == NULL) + Fail("cannot allocate %d bytes -- out of memory", size); + + return ptr; +} + +void *checked_realloc(void *ptr, unsigned int size) +{ + ptr = realloc(ptr, size); + + if (ptr == NULL) + Fail("cannot allocate %d bytes -- out of memory", size); + + return ptr; +} + +void checked_free(void *ptr) +{ + if (ptr != NULL) // this check should be done by free() anyway + free(ptr); +} + +void clear_mem(void *ptr, unsigned int size) +{ +#if defined(PLATFORM_WIN32) + // for unknown reason, memset() sometimes crashes when compiled with MinGW + char *cptr = (char *)ptr; + + while (size--) + *cptr++ = 0; +#else + memset(ptr, 0, size); +#endif +} + + +// ---------------------------------------------------------------------------- +// various helper functions +// ---------------------------------------------------------------------------- + +void swap_numbers(int *i1, int *i2) +{ + int help = *i1; + + *i1 = *i2; + *i2 = help; +} + +void swap_number_pairs(int *x1, int *y1, int *x2, int *y2) +{ + int help_x = *x1; + int help_y = *y1; + + *x1 = *x2; + *x2 = help_x; + + *y1 = *y2; + *y2 = help_y; +} + +/* the "put" variants of the following file access functions check for the file + pointer being != NULL and return the number of bytes they have or would have + written; this allows for chunk writing functions to first determine the size + of the (not yet written) chunk, write the correct chunk size and finally + write the chunk itself */ + +int getFile8BitInteger(File *file) +{ + return getByteFromFile(file); +} + +int putFile8BitInteger(FILE *file, int value) +{ + if (file != NULL) + fputc(value, file); + + return 1; +} + +int getFile16BitInteger(File *file, int byte_order) +{ + if (byte_order == BYTE_ORDER_BIG_ENDIAN) + return ((getByteFromFile(file) << 8) | + (getByteFromFile(file) << 0)); + else // BYTE_ORDER_LITTLE_ENDIAN + return ((getByteFromFile(file) << 0) | + (getByteFromFile(file) << 8)); +} + +int putFile16BitInteger(FILE *file, int value, int byte_order) +{ + if (file != NULL) + { + if (byte_order == BYTE_ORDER_BIG_ENDIAN) + { + fputc((value >> 8) & 0xff, file); + fputc((value >> 0) & 0xff, file); + } + else // BYTE_ORDER_LITTLE_ENDIAN + { + fputc((value >> 0) & 0xff, file); + fputc((value >> 8) & 0xff, file); + } + } + + return 2; +} + +int getFile32BitInteger(File *file, int byte_order) +{ + if (byte_order == BYTE_ORDER_BIG_ENDIAN) + return ((getByteFromFile(file) << 24) | + (getByteFromFile(file) << 16) | + (getByteFromFile(file) << 8) | + (getByteFromFile(file) << 0)); + else // BYTE_ORDER_LITTLE_ENDIAN + return ((getByteFromFile(file) << 0) | + (getByteFromFile(file) << 8) | + (getByteFromFile(file) << 16) | + (getByteFromFile(file) << 24)); +} + +int putFile32BitInteger(FILE *file, int value, int byte_order) +{ + if (file != NULL) + { + if (byte_order == BYTE_ORDER_BIG_ENDIAN) + { + fputc((value >> 24) & 0xff, file); + fputc((value >> 16) & 0xff, file); + fputc((value >> 8) & 0xff, file); + fputc((value >> 0) & 0xff, file); + } + else // BYTE_ORDER_LITTLE_ENDIAN + { + fputc((value >> 0) & 0xff, file); + fputc((value >> 8) & 0xff, file); + fputc((value >> 16) & 0xff, file); + fputc((value >> 24) & 0xff, file); + } + } + + return 4; +} + +boolean getFileChunk(File *file, char *chunk_name, int *chunk_size, + int byte_order) +{ + const int chunk_name_length = 4; + + // read chunk name + if (getStringFromFile(file, chunk_name, chunk_name_length + 1) == NULL) + return FALSE; + + if (chunk_size != NULL) + { + // read chunk size + *chunk_size = getFile32BitInteger(file, byte_order); + } + + return (checkEndOfFile(file) ? FALSE : TRUE); +} + +int putFileChunk(FILE *file, char *chunk_name, int chunk_size, + int byte_order) +{ + int num_bytes = 0; + + // write chunk name + if (file != NULL) + fputs(chunk_name, file); + + num_bytes += strlen(chunk_name); + + if (chunk_size >= 0) + { + // write chunk size + if (file != NULL) + putFile32BitInteger(file, chunk_size, byte_order); + + num_bytes += 4; + } + + return num_bytes; +} + +int getFileVersion(File *file) +{ + int version_super = getByteFromFile(file); + int version_major = getByteFromFile(file); + int version_minor = getByteFromFile(file); + int version_patch = getByteFromFile(file); + + return VERSION_IDENT(version_super, version_major, version_minor, + version_patch); +} + +int putFileVersion(FILE *file, int version) +{ + if (file != NULL) + { + int version_super = VERSION_SUPER(version); + int version_major = VERSION_MAJOR(version); + int version_minor = VERSION_MINOR(version); + int version_patch = VERSION_PATCH(version); + + fputc(version_super, file); + fputc(version_major, file); + fputc(version_minor, file); + fputc(version_patch, file); + } + + return 4; +} + +void ReadBytesFromFile(File *file, byte *buffer, unsigned int bytes) +{ + int i; + + for (i = 0; i < bytes && !checkEndOfFile(file); i++) + buffer[i] = getByteFromFile(file); +} + +void WriteBytesToFile(FILE *file, byte *buffer, unsigned int bytes) +{ + int i; + + for (i = 0; i < bytes; i++) + fputc(buffer[i], file); +} + +void ReadUnusedBytesFromFile(File *file, unsigned int bytes) +{ + while (bytes-- && !checkEndOfFile(file)) + getByteFromFile(file); +} + +void WriteUnusedBytesToFile(FILE *file, unsigned int bytes) +{ + while (bytes--) + fputc(0, file); +} + + +// ---------------------------------------------------------------------------- +// functions to convert between ISO-8859-1 and UTF-8 +// ---------------------------------------------------------------------------- + +char *getUTF8FromLatin1(char *latin1) +{ + int max_utf8_size = 2 * strlen(latin1) + 1; + char *utf8 = checked_calloc(max_utf8_size); + unsigned char *src = (unsigned char *)latin1; + unsigned char *dst = (unsigned char *)utf8; + + while (*src) + { + if (*src < 128) // pure 7-bit ASCII + { + *dst++ = *src; + } + else if (*src >= 160) // non-ASCII characters + { + *dst++ = 194 + (*src >= 192); + *dst++ = 128 + (*src & 63); + } + else // undefined in ISO-8859-1 + { + *dst++ = '?'; + } + + src++; + } + + // only use the smallest possible string buffer size + utf8 = checked_realloc(utf8, strlen(utf8) + 1); + + return utf8; +} + +char *getLatin1FromUTF8(char *utf8) +{ + int max_latin1_size = strlen(utf8) + 1; + char *latin1 = checked_calloc(max_latin1_size); + unsigned char *src = (unsigned char *)utf8; + unsigned char *dst = (unsigned char *)latin1; + + while (*src) + { + if (*src < 128) // pure 7-bit ASCII + { + *dst++ = *src++; + } + else if (src[0] == 194 && + src[1] >= 128 && src[1] < 192) // non-ASCII characters + { + *dst++ = src[1]; + src += 2; + } + else if (src[0] == 195 && + src[1] >= 128 && src[1] < 192) // non-ASCII characters + { + *dst++ = src[1] + 64; + src += 2; + } + + // all other UTF-8 characters are undefined in ISO-8859-1 + + else if (src[0] >= 192 && src[0] < 224 && + src[1] >= 128 && src[1] < 192) + { + *dst++ = '?'; + src += 2; + } + else if (src[0] >= 224 && src[0] < 240 && + src[1] >= 128 && src[1] < 192 && + src[2] >= 128 && src[2] < 192) + { + *dst++ = '?'; + src += 3; + } + else if (src[0] >= 240 && src[0] < 248 && + src[1] >= 128 && src[1] < 192 && + src[2] >= 128 && src[2] < 192 && + src[3] >= 128 && src[3] < 192) + { + *dst++ = '?'; + src += 4; + } + else if (src[0] >= 248 && src[0] < 252 && + src[1] >= 128 && src[1] < 192 && + src[2] >= 128 && src[2] < 192 && + src[3] >= 128 && src[3] < 192 && + src[4] >= 128 && src[4] < 192) + { + *dst++ = '?'; + src += 5; + } + else if (src[0] >= 252 && src[0] < 254 && + src[1] >= 128 && src[1] < 192 && + src[2] >= 128 && src[2] < 192 && + src[3] >= 128 && src[3] < 192 && + src[4] >= 128 && src[4] < 192 && + src[5] >= 128 && src[5] < 192) + { + *dst++ = '?'; + src += 6; + } + else + { + *dst++ = '?'; + src++; + } + } + + // only use the smallest possible string buffer size + latin1 = checked_realloc(latin1, strlen(latin1) + 1); + + return latin1; +} + + +// ---------------------------------------------------------------------------- +// functions for JSON handling +// ---------------------------------------------------------------------------- + +char *getEscapedJSON(char *s) +{ + int max_json_size = 2 * strlen(s) + 1; + char *json = checked_calloc(max_json_size); + unsigned char *src = (unsigned char *)s; + unsigned char *dst = (unsigned char *)json; + char *escaped[256] = + { + ['\b'] = "\\b", + ['\f'] = "\\f", + ['\n'] = "\\n", + ['\r'] = "\\r", + ['\t'] = "\\t", + ['\"'] = "\\\"", + ['\\'] = "\\\\", + }; + + while (*src) + { + if (escaped[*src] != NULL) + { + char *esc = escaped[*src++]; + + while (*esc) + *dst++ = *esc++; + } + else + { + *dst++ = *src++; + } + } + + // only use the smallest possible string buffer size + json = checked_realloc(json, strlen(json) + 1); + + return json; +} + + +// ---------------------------------------------------------------------------- +// functions to translate key identifiers between different format +// ---------------------------------------------------------------------------- + +#define TRANSLATE_KEYSYM_TO_KEYNAME 0 +#define TRANSLATE_KEYSYM_TO_X11KEYNAME 1 +#define TRANSLATE_KEYNAME_TO_KEYSYM 2 +#define TRANSLATE_X11KEYNAME_TO_KEYSYM 3 + +static void translate_keyname(Key *keysym, char **x11name, char **name, int mode) +{ + static struct + { + Key key; + char *x11name; + char *name; + } translate_key[] = + { + // return and escape keys + { KSYM_Return, "XK_Return", "return" }, + { KSYM_Escape, "XK_Escape", "escape" }, + + // normal cursor keys + { KSYM_Left, "XK_Left", "cursor left" }, + { KSYM_Right, "XK_Right", "cursor right" }, + { KSYM_Up, "XK_Up", "cursor up" }, + { KSYM_Down, "XK_Down", "cursor down" }, + + // keypad cursor keys +#ifdef KSYM_KP_Left + { KSYM_KP_Left, "XK_KP_Left", "keypad left" }, + { KSYM_KP_Right, "XK_KP_Right", "keypad right" }, + { KSYM_KP_Up, "XK_KP_Up", "keypad up" }, + { KSYM_KP_Down, "XK_KP_Down", "keypad down" }, +#endif + + // other keypad keys +#ifdef KSYM_KP_Enter + { KSYM_KP_Enter, "XK_KP_Enter", "keypad enter" }, + { KSYM_KP_Add, "XK_KP_Add", "keypad +" }, + { KSYM_KP_Subtract, "XK_KP_Subtract", "keypad -" }, + { KSYM_KP_Multiply, "XK_KP_Multiply", "keypad mltply" }, + { KSYM_KP_Divide, "XK_KP_Divide", "keypad /" }, + { KSYM_KP_Separator,"XK_KP_Separator", "keypad ," }, +#endif + + // modifier keys + { KSYM_Shift_L, "XK_Shift_L", "left shift" }, + { KSYM_Shift_R, "XK_Shift_R", "right shift" }, + { KSYM_Control_L, "XK_Control_L", "left control" }, + { KSYM_Control_R, "XK_Control_R", "right control" }, + { KSYM_Meta_L, "XK_Meta_L", "left meta" }, + { KSYM_Meta_R, "XK_Meta_R", "right meta" }, + { KSYM_Alt_L, "XK_Alt_L", "left alt" }, + { KSYM_Alt_R, "XK_Alt_R", "right alt" }, + { KSYM_Mode_switch, "XK_Mode_switch", "mode switch" }, // Alt-R + { KSYM_Multi_key, "XK_Multi_key", "multi key" }, // Ctrl-R + + // some special keys + { KSYM_BackSpace, "XK_BackSpace", "backspace" }, + { KSYM_Delete, "XK_Delete", "delete" }, + { KSYM_Insert, "XK_Insert", "insert" }, + { KSYM_Tab, "XK_Tab", "tab" }, + { KSYM_Home, "XK_Home", "home" }, + { KSYM_End, "XK_End", "end" }, + { KSYM_Page_Up, "XK_Page_Up", "page up" }, + { KSYM_Page_Down, "XK_Page_Down", "page down" }, + + { KSYM_Select, "XK_Select", "select" }, + { KSYM_Menu, "XK_Menu", "menu" }, // menu key + { KSYM_Back, "XK_Back", "back" }, // back key + { KSYM_PlayPause, "XK_PlayPause", "play/pause" }, +#if defined(PLATFORM_ANDROID) + { KSYM_Rewind, "XK_Rewind", "rewind" }, + { KSYM_FastForward, "XK_FastForward", "fast forward" }, +#endif + + // ASCII 0x20 to 0x40 keys (except numbers) + { KSYM_space, "XK_space", "space" }, + { KSYM_exclam, "XK_exclam", "!" }, + { KSYM_quotedbl, "XK_quotedbl", "\"" }, + { KSYM_numbersign, "XK_numbersign", "#" }, + { KSYM_dollar, "XK_dollar", "$" }, + { KSYM_percent, "XK_percent", "%" }, + { KSYM_ampersand, "XK_ampersand", "&" }, + { KSYM_apostrophe, "XK_apostrophe", "'" }, + { KSYM_parenleft, "XK_parenleft", "(" }, + { KSYM_parenright, "XK_parenright", ")" }, + { KSYM_asterisk, "XK_asterisk", "*" }, + { KSYM_plus, "XK_plus", "+" }, + { KSYM_comma, "XK_comma", "," }, + { KSYM_minus, "XK_minus", "-" }, + { KSYM_period, "XK_period", "." }, + { KSYM_slash, "XK_slash", "/" }, + { KSYM_colon, "XK_colon", ":" }, + { KSYM_semicolon, "XK_semicolon", ";" }, + { KSYM_less, "XK_less", "<" }, + { KSYM_equal, "XK_equal", "=" }, + { KSYM_greater, "XK_greater", ">" }, + { KSYM_question, "XK_question", "?" }, + { KSYM_at, "XK_at", "@" }, + + // more ASCII keys + { KSYM_bracketleft, "XK_bracketleft", "[" }, + { KSYM_backslash, "XK_backslash", "\\" }, + { KSYM_bracketright,"XK_bracketright", "]" }, + { KSYM_asciicircum, "XK_asciicircum", "^" }, + { KSYM_underscore, "XK_underscore", "_" }, + { KSYM_grave, "XK_grave", "grave" }, + { KSYM_quoteleft, "XK_quoteleft", "quote left" }, + { KSYM_braceleft, "XK_braceleft", "brace left" }, + { KSYM_bar, "XK_bar", "bar" }, + { KSYM_braceright, "XK_braceright", "brace right" }, + { KSYM_asciitilde, "XK_asciitilde", "~" }, + + // special (non-ASCII) keys + { KSYM_degree, "XK_degree", "degree" }, + { KSYM_Adiaeresis, "XK_Adiaeresis", "A umlaut" }, + { KSYM_Odiaeresis, "XK_Odiaeresis", "O umlaut" }, + { KSYM_Udiaeresis, "XK_Udiaeresis", "U umlaut" }, + { KSYM_adiaeresis, "XK_adiaeresis", "a umlaut" }, + { KSYM_odiaeresis, "XK_odiaeresis", "o umlaut" }, + { KSYM_udiaeresis, "XK_udiaeresis", "u umlaut" }, + { KSYM_ssharp, "XK_ssharp", "sharp s" }, + + // special (non-ASCII) keys (UTF-8, for reverse mapping only) + { KSYM_degree, "XK_degree", "\xc2\xb0" }, + { KSYM_Adiaeresis, "XK_Adiaeresis", "\xc3\x84" }, + { KSYM_Odiaeresis, "XK_Odiaeresis", "\xc3\x96" }, + { KSYM_Udiaeresis, "XK_Udiaeresis", "\xc3\x9c" }, + { KSYM_adiaeresis, "XK_adiaeresis", "\xc3\xa4" }, + { KSYM_odiaeresis, "XK_odiaeresis", "\xc3\xb6" }, + { KSYM_udiaeresis, "XK_udiaeresis", "\xc3\xbc" }, + { KSYM_ssharp, "XK_ssharp", "\xc3\x9f" }, + + // other keys (for reverse mapping only) + { KSYM_space, "XK_space", " " }, + + // keypad keys are not in numerical order in SDL2 + { KSYM_KP_0, "XK_KP_0", "keypad 0" }, + { KSYM_KP_1, "XK_KP_1", "keypad 1" }, + { KSYM_KP_2, "XK_KP_2", "keypad 2" }, + { KSYM_KP_3, "XK_KP_3", "keypad 3" }, + { KSYM_KP_4, "XK_KP_4", "keypad 4" }, + { KSYM_KP_5, "XK_KP_5", "keypad 5" }, + { KSYM_KP_6, "XK_KP_6", "keypad 6" }, + { KSYM_KP_7, "XK_KP_7", "keypad 7" }, + { KSYM_KP_8, "XK_KP_8", "keypad 8" }, + { KSYM_KP_9, "XK_KP_9", "keypad 9" }, + + // end-of-array identifier + { 0, NULL, NULL } + }; + + int i; + + if (mode == TRANSLATE_KEYSYM_TO_KEYNAME) + { + static char name_buffer[30]; + Key key = *keysym; + + if (key >= KSYM_A && key <= KSYM_Z) + sprintf(name_buffer, "%c", 'A' + (char)(key - KSYM_A)); + else if (key >= KSYM_a && key <= KSYM_z) + sprintf(name_buffer, "%c", 'a' + (char)(key - KSYM_a)); + else if (key >= KSYM_0 && key <= KSYM_9) + sprintf(name_buffer, "%c", '0' + (char)(key - KSYM_0)); + else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST) + sprintf(name_buffer, "F%d", (int)(key - KSYM_FKEY_FIRST + 1)); + else if (key == KSYM_UNDEFINED) + strcpy(name_buffer, "(undefined)"); + else + { + i = 0; + + do + { + if (key == translate_key[i].key) + { + strcpy(name_buffer, translate_key[i].name); + break; + } + } + while (translate_key[++i].name); + + if (!translate_key[i].name) + strcpy(name_buffer, "(unknown)"); + } + + *name = name_buffer; + } + else if (mode == TRANSLATE_KEYSYM_TO_X11KEYNAME) + { + static char name_buffer[30]; + Key key = *keysym; + + if (key >= KSYM_A && key <= KSYM_Z) + sprintf(name_buffer, "XK_%c", 'A' + (char)(key - KSYM_A)); + else if (key >= KSYM_a && key <= KSYM_z) + sprintf(name_buffer, "XK_%c", 'a' + (char)(key - KSYM_a)); + else if (key >= KSYM_0 && key <= KSYM_9) + sprintf(name_buffer, "XK_%c", '0' + (char)(key - KSYM_0)); + else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST) + sprintf(name_buffer, "XK_F%d", (int)(key - KSYM_FKEY_FIRST + 1)); + else if (key == KSYM_UNDEFINED) + strcpy(name_buffer, "[undefined]"); + else + { + i = 0; + + do + { + if (key == translate_key[i].key) + { + strcpy(name_buffer, translate_key[i].x11name); + break; + } + } + while (translate_key[++i].x11name); + + if (!translate_key[i].x11name) + sprintf(name_buffer, "0x%04x", (unsigned int)key); + } + + *x11name = name_buffer; + } + else if (mode == TRANSLATE_KEYNAME_TO_KEYSYM) + { + Key key = KSYM_UNDEFINED; + char *name_ptr = *name; + + if (strlen(*name) == 1) + { + char c = name_ptr[0]; + + if (c >= 'A' && c <= 'Z') + key = KSYM_A + (Key)(c - 'A'); + else if (c >= 'a' && c <= 'z') + key = KSYM_a + (Key)(c - 'a'); + else if (c >= '0' && c <= '9') + key = KSYM_0 + (Key)(c - '0'); + } + + if (key == KSYM_UNDEFINED) + { + i = 0; + + do + { + if (strEqual(translate_key[i].name, *name)) + { + key = translate_key[i].key; + break; + } + } + while (translate_key[++i].x11name); + } + + if (key == KSYM_UNDEFINED) + Warn("getKeyFromKeyName(): not completely implemented"); + + *keysym = key; + } + else if (mode == TRANSLATE_X11KEYNAME_TO_KEYSYM) + { + Key key = KSYM_UNDEFINED; + char *name_ptr = *x11name; + + if (strPrefix(name_ptr, "XK_") && strlen(name_ptr) == 4) + { + char c = name_ptr[3]; + + if (c >= 'A' && c <= 'Z') + key = KSYM_A + (Key)(c - 'A'); + else if (c >= 'a' && c <= 'z') + key = KSYM_a + (Key)(c - 'a'); + else if (c >= '0' && c <= '9') + key = KSYM_0 + (Key)(c - '0'); + } + else if (strPrefix(name_ptr, "XK_F") && strlen(name_ptr) <= 6) + { + char c1 = name_ptr[4]; + char c2 = name_ptr[5]; + int d = 0; + + if ((c1 >= '0' && c1 <= '9') && + ((c2 >= '0' && c1 <= '9') || c2 == '\0')) + d = atoi(&name_ptr[4]); + + if (d >= 1 && d <= KSYM_NUM_FKEYS) + key = KSYM_F1 + (Key)(d - 1); + } + else if (strPrefix(name_ptr, "XK_")) + { + i = 0; + + do + { + if (strEqual(name_ptr, translate_key[i].x11name)) + { + key = translate_key[i].key; + break; + } + } + while (translate_key[++i].x11name); + } + else if (strPrefix(name_ptr, "0x")) + { + unsigned int value = 0; + + name_ptr += 2; + + while (name_ptr) + { + char c = *name_ptr++; + int d = -1; + + if (c >= '0' && c <= '9') + d = (int)(c - '0'); + else if (c >= 'a' && c <= 'f') + d = (int)(c - 'a' + 10); + else if (c >= 'A' && c <= 'F') + d = (int)(c - 'A' + 10); + + if (d == -1) + { + value = -1; + break; + } + + value = value * 16 + d; + } + + if (value != -1) + key = (Key)value; + } + + *keysym = key; + } +} + +char *getKeyNameFromKey(Key key) +{ + char *name; + + translate_keyname(&key, NULL, &name, TRANSLATE_KEYSYM_TO_KEYNAME); + return name; +} + +char *getX11KeyNameFromKey(Key key) +{ + char *x11name; + + translate_keyname(&key, &x11name, NULL, TRANSLATE_KEYSYM_TO_X11KEYNAME); + return x11name; +} + +Key getKeyFromKeyName(char *name) +{ + Key key; + + translate_keyname(&key, NULL, &name, TRANSLATE_KEYNAME_TO_KEYSYM); + return key; +} + +Key getKeyFromX11KeyName(char *x11name) +{ + Key key; + + translate_keyname(&key, &x11name, NULL, TRANSLATE_X11KEYNAME_TO_KEYSYM); + return key; +} + +char getCharFromKey(Key key) +{ + static struct + { + Key key; + byte key_char; + } translate_key_char[] = + { + // special (non-ASCII) keys (ISO-8859-1) + { KSYM_degree, CHAR_BYTE_DEGREE }, + { KSYM_Adiaeresis, CHAR_BYTE_UMLAUT_A }, + { KSYM_Odiaeresis, CHAR_BYTE_UMLAUT_O }, + { KSYM_Udiaeresis, CHAR_BYTE_UMLAUT_U }, + { KSYM_adiaeresis, CHAR_BYTE_UMLAUT_a }, + { KSYM_odiaeresis, CHAR_BYTE_UMLAUT_o }, + { KSYM_udiaeresis, CHAR_BYTE_UMLAUT_u }, + { KSYM_ssharp, CHAR_BYTE_SHARP_S }, + + // end-of-array identifier + { 0, 0 } + }; + + char *keyname = getKeyNameFromKey(key); + char c = 0; + + if (strlen(keyname) == 1) + c = keyname[0]; + else if (strEqual(keyname, "space")) + c = ' '; + else + { + int i = 0; + + do + { + if (key == translate_key_char[i].key) + { + c = translate_key_char[i].key_char; + + break; + } + } + while (translate_key_char[++i].key_char); + } + + return c; +} + +char getValidConfigValueChar(char c) +{ + if (c == '#' || // used to mark comments + c == '\\') // used to mark continued lines + c = 0; + + return c; +} + + +// ---------------------------------------------------------------------------- +// functions to translate string identifiers to integer or boolean value +// ---------------------------------------------------------------------------- + +int get_integer_from_string(char *s) +{ + static char *number_text[][3] = { - Key key; - char *x11name; - char *name; - } translate_key[] = + { "0", "zero", "null", }, + { "1", "one", "first" }, + { "2", "two", "second" }, + { "3", "three", "third" }, + { "4", "four", "fourth" }, + { "5", "five", "fifth" }, + { "6", "six", "sixth" }, + { "7", "seven", "seventh" }, + { "8", "eight", "eighth" }, + { "9", "nine", "ninth" }, + { "10", "ten", "tenth" }, + { "11", "eleven", "eleventh" }, + { "12", "twelve", "twelfth" }, + + { NULL, NULL, NULL }, + }; + + int i, j; + char *s_lower = getStringToLower(s); + int result = -1; + + for (i = 0; number_text[i][0] != NULL; i++) + for (j = 0; j < 3; j++) + if (strEqual(s_lower, number_text[i][j])) + result = i; + + if (result == -1) { - /* normal cursor keys */ - { KSYM_Left, "XK_Left", "cursor left" }, - { KSYM_Right, "XK_Right", "cursor right" }, - { KSYM_Up, "XK_Up", "cursor up" }, - { KSYM_Down, "XK_Down", "cursor down" }, + if (strEqual(s_lower, "false") || + strEqual(s_lower, "no") || + strEqual(s_lower, "off")) + result = 0; + else if (strEqual(s_lower, "true") || + strEqual(s_lower, "yes") || + strEqual(s_lower, "on")) + result = 1; + else + result = atoi(s); + } - /* keypad cursor keys */ -#ifdef KSYM_KP_Left - { KSYM_KP_Left, "XK_KP_Left", "keypad left" }, - { KSYM_KP_Right, "XK_KP_Right", "keypad right" }, - { KSYM_KP_Up, "XK_KP_Up", "keypad up" }, - { KSYM_KP_Down, "XK_KP_Down", "keypad down" }, -#endif + free(s_lower); - /* other keypad keys */ -#ifdef KSYM_KP_Enter - { KSYM_KP_Enter, "XK_KP_Enter", "keypad enter" }, - { KSYM_KP_Add, "XK_KP_Add", "keypad +" }, - { KSYM_KP_Subtract, "XK_KP_Subtract", "keypad -" }, - { KSYM_KP_Multiply, "XK_KP_Multiply", "keypad mltply" }, - { KSYM_KP_Divide, "XK_KP_Divide", "keypad /" }, - { KSYM_KP_Separator,"XK_KP_Separator", "keypad ," }, -#endif + return result; +} - /* modifier keys */ - { KSYM_Shift_L, "XK_Shift_L", "left shift" }, - { KSYM_Shift_R, "XK_Shift_R", "right shift" }, - { KSYM_Control_L, "XK_Control_L", "left control" }, - { KSYM_Control_R, "XK_Control_R", "right control" }, - { KSYM_Meta_L, "XK_Meta_L", "left meta" }, - { KSYM_Meta_R, "XK_Meta_R", "right meta" }, - { KSYM_Alt_L, "XK_Alt_L", "left alt" }, - { KSYM_Alt_R, "XK_Alt_R", "right alt" }, - { KSYM_Super_L, "XK_Super_L", "left super" }, /* Win-L */ - { KSYM_Super_R, "XK_Super_R", "right super" }, /* Win-R */ - { KSYM_Mode_switch, "XK_Mode_switch", "mode switch" }, /* Alt-R */ - { KSYM_Multi_key, "XK_Multi_key", "multi key" }, /* Ctrl-R */ +boolean get_boolean_from_string(char *s) +{ + char *s_lower = getStringToLower(s); + boolean result = FALSE; - /* some special keys */ - { KSYM_BackSpace, "XK_BackSpace", "backspace" }, - { KSYM_Delete, "XK_Delete", "delete" }, - { KSYM_Insert, "XK_Insert", "insert" }, - { KSYM_Tab, "XK_Tab", "tab" }, - { KSYM_Home, "XK_Home", "home" }, - { KSYM_End, "XK_End", "end" }, - { KSYM_Page_Up, "XK_Page_Up", "page up" }, - { KSYM_Page_Down, "XK_Page_Down", "page down" }, - { KSYM_Menu, "XK_Menu", "menu" }, /* Win-Menu */ + if (strEqual(s_lower, "true") || + strEqual(s_lower, "yes") || + strEqual(s_lower, "on") || + get_integer_from_string(s) == 1) + result = TRUE; - /* ASCII 0x20 to 0x40 keys (except numbers) */ - { KSYM_space, "XK_space", "space" }, - { KSYM_exclam, "XK_exclam", "!" }, - { KSYM_quotedbl, "XK_quotedbl", "\"" }, - { KSYM_numbersign, "XK_numbersign", "#" }, - { KSYM_dollar, "XK_dollar", "$" }, - { KSYM_percent, "XK_percent", "%" }, - { KSYM_ampersand, "XK_ampersand", "&" }, - { KSYM_apostrophe, "XK_apostrophe", "'" }, - { KSYM_parenleft, "XK_parenleft", "(" }, - { KSYM_parenright, "XK_parenright", ")" }, - { KSYM_asterisk, "XK_asterisk", "*" }, - { KSYM_plus, "XK_plus", "+" }, - { KSYM_comma, "XK_comma", "," }, - { KSYM_minus, "XK_minus", "-" }, - { KSYM_period, "XK_period", "." }, - { KSYM_slash, "XK_slash", "/" }, - { KSYM_colon, "XK_colon", ":" }, - { KSYM_semicolon, "XK_semicolon", ";" }, - { KSYM_less, "XK_less", "<" }, - { KSYM_equal, "XK_equal", "=" }, - { KSYM_greater, "XK_greater", ">" }, - { KSYM_question, "XK_question", "?" }, - { KSYM_at, "XK_at", "@" }, + free(s_lower); - /* more ASCII keys */ - { KSYM_bracketleft, "XK_bracketleft", "[" }, - { KSYM_backslash, "XK_backslash", "\\" }, - { KSYM_bracketright,"XK_bracketright", "]" }, - { KSYM_asciicircum, "XK_asciicircum", "^" }, - { KSYM_underscore, "XK_underscore", "_" }, - { KSYM_grave, "XK_grave", "grave" }, - { KSYM_quoteleft, "XK_quoteleft", "quote left" }, - { KSYM_braceleft, "XK_braceleft", "brace left" }, - { KSYM_bar, "XK_bar", "bar" }, - { KSYM_braceright, "XK_braceright", "brace right" }, - { KSYM_asciitilde, "XK_asciitilde", "~" }, + return result; +} - /* special (non-ASCII) keys */ - { KSYM_Adiaeresis, "XK_Adiaeresis", "Ä" }, - { KSYM_Odiaeresis, "XK_Odiaeresis", "Ö" }, - { KSYM_Udiaeresis, "XK_Udiaeresis", "Ü" }, - { KSYM_adiaeresis, "XK_adiaeresis", "ä" }, - { KSYM_odiaeresis, "XK_odiaeresis", "ö" }, - { KSYM_udiaeresis, "XK_udiaeresis", "ü" }, - { KSYM_ssharp, "XK_ssharp", "sharp s" }, +int get_switch3_from_string(char *s) +{ + char *s_lower = getStringToLower(s); + int result = FALSE; - /* end-of-array identifier */ - { 0, NULL, NULL } + if (strEqual(s_lower, "true") || + strEqual(s_lower, "yes") || + strEqual(s_lower, "on") || + get_integer_from_string(s) == 1) + result = TRUE; + else if (strEqual(s_lower, "auto")) + result = AUTO; + + free(s_lower); + + return result; +} + +int get_player_nr_from_string(char *s) +{ + static char *player_text[] = + { + "player_1", + "player_2", + "player_3", + "player_4", + + NULL }; + char *s_lower = getStringToLower(s); + int result = 0; int i; - if (mode == TRANSLATE_KEYSYM_TO_KEYNAME) + for (i = 0; player_text[i] != NULL; i++) + if (strEqual(s_lower, player_text[i])) + result = i; + + free(s_lower); + + return result; +} + + +// ---------------------------------------------------------------------------- +// functions for generic lists +// ---------------------------------------------------------------------------- + +ListNode *newListNode(void) +{ + return checked_calloc(sizeof(ListNode)); +} + +void addNodeToList(ListNode **node_first, char *key, void *content) +{ + ListNode *node_new = newListNode(); + + node_new->key = getStringCopy(key); + node_new->content = content; + node_new->next = *node_first; + + if (*node_first) + (*node_first)->prev = node_new; + + *node_first = node_new; +} + +void deleteNodeFromList(ListNode **node_first, char *key, + void (*destructor_function)(void *)) +{ + if (node_first == NULL || *node_first == NULL) + return; + + if (strEqual((*node_first)->key, key)) { - static char name_buffer[30]; - Key key = *keysym; + // after first recursion, (*node_first)->prev->next == *node_first, + // so *node_first would be overwritten with (*node_first)->next + // => use a copy of *node_first (and later of (*node_first)->next) + ListNode *node = *node_first; + ListNode *node_next = node->next; - if (key >= KSYM_A && key <= KSYM_Z) - sprintf(name_buffer, "%c", 'A' + (char)(key - KSYM_A)); - else if (key >= KSYM_a && key <= KSYM_z) - sprintf(name_buffer, "%c", 'a' + (char)(key - KSYM_a)); - else if (key >= KSYM_0 && key <= KSYM_9) - sprintf(name_buffer, "%c", '0' + (char)(key - KSYM_0)); - else if (key >= KSYM_KP_0 && key <= KSYM_KP_9) - sprintf(name_buffer, "keypad %c", '0' + (char)(key - KSYM_KP_0)); -#if 1 - else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST) - sprintf(name_buffer, "F%d", (int)(key - KSYM_FKEY_FIRST + 1)); -#else - else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST) - sprintf(name_buffer, "function F%d", (int)(key - KSYM_FKEY_FIRST + 1)); -#endif - else if (key == KSYM_UNDEFINED) - strcpy(name_buffer, "(undefined)"); - else - { - i = 0; + checked_free(node->key); - do - { - if (key == translate_key[i].key) - { - strcpy(name_buffer, translate_key[i].name); - break; - } - } - while (translate_key[++i].name); + if (destructor_function) + destructor_function(node->content); - if (!translate_key[i].name) - strcpy(name_buffer, "(unknown)"); - } + if (node->prev) + node->prev->next = node->next; + + if (node->next) + node->next->prev = node->prev; + + checked_free(node); + + // after removing node, set list pointer to next valid list node + // (this is important if the first node of the list was deleted) + *node_first = node_next; + } + else + { + deleteNodeFromList(&(*node_first)->next, key, destructor_function); + } +} + +ListNode *getNodeFromKey(ListNode *node_first, char *key) +{ + if (node_first == NULL) + return NULL; + + if (strEqual(node_first->key, key)) + return node_first; + else + return getNodeFromKey(node_first->next, key); +} + +int getNumNodes(ListNode *node_first) +{ + return (node_first ? 1 + getNumNodes(node_first->next) : 0); +} + +#if 0 +static void dumpList(ListNode *node_first) +{ + ListNode *node = node_first; + + while (node) + { + Debug("internal:dumpList", "['%s' (%d)]", node->key, + ((struct ListNodeInfo *)node->content)->num_references); + node = node->next; + } + + Debug("internal:dumpList", "[%d nodes]", getNumNodes(node_first)); +} +#endif - *name = name_buffer; - } - else if (mode == TRANSLATE_KEYSYM_TO_X11KEYNAME) - { - static char name_buffer[30]; - Key key = *keysym; - if (key >= KSYM_A && key <= KSYM_Z) - sprintf(name_buffer, "XK_%c", 'A' + (char)(key - KSYM_A)); - else if (key >= KSYM_a && key <= KSYM_z) - sprintf(name_buffer, "XK_%c", 'a' + (char)(key - KSYM_a)); - else if (key >= KSYM_0 && key <= KSYM_9) - sprintf(name_buffer, "XK_%c", '0' + (char)(key - KSYM_0)); - else if (key >= KSYM_KP_0 && key <= KSYM_KP_9) - sprintf(name_buffer, "XK_KP_%c", '0' + (char)(key - KSYM_KP_0)); - else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST) - sprintf(name_buffer, "XK_F%d", (int)(key - KSYM_FKEY_FIRST + 1)); - else if (key == KSYM_UNDEFINED) - strcpy(name_buffer, "[undefined]"); - else - { - i = 0; +// ---------------------------------------------------------------------------- +// functions for file handling +// ---------------------------------------------------------------------------- - do - { - if (key == translate_key[i].key) - { - strcpy(name_buffer, translate_key[i].x11name); - break; - } - } - while (translate_key[++i].x11name); +#define MAX_BUFFER_SIZE 4096 - if (!translate_key[i].x11name) - sprintf(name_buffer, "0x%04lx", (unsigned long)key); - } +File *openFile(char *filename, char *mode) +{ + File *file = checked_calloc(sizeof(File)); - *x11name = name_buffer; - } - else if (mode == TRANSLATE_KEYNAME_TO_KEYSYM) + file->file = fopen(filename, mode); + + if (file->file != NULL) { - Key key = KSYM_UNDEFINED; + file->filename = getStringCopy(filename); - i = 0; - do - { - if (strEqual(translate_key[i].name, *name)) - { - key = translate_key[i].key; - break; - } - } - while (translate_key[++i].x11name); + return file; + } - if (key == KSYM_UNDEFINED) - Error(ERR_WARN, "getKeyFromKeyName(): not completely implemented"); +#if defined(PLATFORM_ANDROID) + file->asset_file = SDL_RWFromFile(filename, mode); - *keysym = key; - } - else if (mode == TRANSLATE_X11KEYNAME_TO_KEYSYM) + if (file->asset_file != NULL) { - Key key = KSYM_UNDEFINED; - char *name_ptr = *x11name; + file->file_is_asset = TRUE; + file->filename = getStringCopy(filename); - if (strncmp(name_ptr, "XK_", 3) == 0 && strlen(name_ptr) == 4) - { - char c = name_ptr[3]; + return file; + } +#endif - if (c >= 'A' && c <= 'Z') - key = KSYM_A + (Key)(c - 'A'); - else if (c >= 'a' && c <= 'z') - key = KSYM_a + (Key)(c - 'a'); - else if (c >= '0' && c <= '9') - key = KSYM_0 + (Key)(c - '0'); - } - else if (strncmp(name_ptr, "XK_KP_", 6) == 0 && strlen(name_ptr) == 7) - { - char c = name_ptr[6]; + checked_free(file); - if (c >= '0' && c <= '9') - key = KSYM_KP_0 + (Key)(c - '0'); - } - else if (strncmp(name_ptr, "XK_F", 4) == 0 && strlen(name_ptr) <= 6) - { - char c1 = name_ptr[4]; - char c2 = name_ptr[5]; - int d = 0; + return NULL; +} - if ((c1 >= '0' && c1 <= '9') && - ((c2 >= '0' && c1 <= '9') || c2 == '\0')) - d = atoi(&name_ptr[4]); +int closeFile(File *file) +{ + if (file == NULL) + return -1; - if (d >= 1 && d <= KSYM_NUM_FKEYS) - key = KSYM_F1 + (Key)(d - 1); - } - else if (strncmp(name_ptr, "XK_", 3) == 0) - { - i = 0; + int result = 0; - do - { - if (strEqual(name_ptr, translate_key[i].x11name)) - { - key = translate_key[i].key; - break; - } - } - while (translate_key[++i].x11name); - } - else if (strncmp(name_ptr, "0x", 2) == 0) - { - unsigned long value = 0; +#if defined(PLATFORM_ANDROID) + if (file->asset_file) + result = SDL_RWclose(file->asset_file); +#endif - name_ptr += 2; + if (file->file) + result = fclose(file->file); - while (name_ptr) - { - char c = *name_ptr++; - int d = -1; + checked_free(file->filename); + checked_free(file); - if (c >= '0' && c <= '9') - d = (int)(c - '0'); - else if (c >= 'a' && c <= 'f') - d = (int)(c - 'a' + 10); - else if (c >= 'A' && c <= 'F') - d = (int)(c - 'A' + 10); + return result; +} - if (d == -1) - { - value = -1; - break; - } +int checkEndOfFile(File *file) +{ +#if defined(PLATFORM_ANDROID) + if (file->file_is_asset) + return file->end_of_file; +#endif - value = value * 16 + d; - } + return feof(file->file); +} - if (value != -1) - key = (Key)value; - } +size_t readFile(File *file, void *buffer, size_t item_size, size_t num_items) +{ +#if defined(PLATFORM_ANDROID) + if (file->file_is_asset) + { + if (file->end_of_file) + return 0; - *keysym = key; + size_t num_items_read = + SDL_RWread(file->asset_file, buffer, item_size, num_items); + + if (num_items_read < num_items) + file->end_of_file = TRUE; + + return num_items_read; } +#endif + + return fread(buffer, item_size, num_items, file->file); } -char *getKeyNameFromKey(Key key) +size_t writeFile(File *file, void *buffer, size_t item_size, size_t num_items) { - char *name; + return fwrite(buffer, item_size, num_items, file->file); +} - translate_keyname(&key, NULL, &name, TRANSLATE_KEYSYM_TO_KEYNAME); - return name; +int seekFile(File *file, long offset, int whence) +{ +#if defined(PLATFORM_ANDROID) + if (file->file_is_asset) + { + int sdl_whence = (whence == SEEK_SET ? RW_SEEK_SET : + whence == SEEK_CUR ? RW_SEEK_CUR : + whence == SEEK_END ? RW_SEEK_END : 0); + + return (SDL_RWseek(file->asset_file, offset, sdl_whence) == -1 ? -1 : 0); + } +#endif + + return fseek(file->file, offset, whence); } -char *getX11KeyNameFromKey(Key key) +int getByteFromFile(File *file) { - char *x11name; +#if defined(PLATFORM_ANDROID) + if (file->file_is_asset) + { + if (file->end_of_file) + return EOF; - translate_keyname(&key, &x11name, NULL, TRANSLATE_KEYSYM_TO_X11KEYNAME); - return x11name; + byte c; + size_t num_bytes_read = SDL_RWread(file->asset_file, &c, 1, 1); + + if (num_bytes_read < 1) + file->end_of_file = TRUE; + + return (file->end_of_file ? EOF : (int)c); + } +#endif + + return fgetc(file->file); } -Key getKeyFromKeyName(char *name) +char *getStringFromFile(File *file, char *line, int size) { - Key key; +#if defined(PLATFORM_ANDROID) + if (file->file_is_asset) + { + if (file->end_of_file) + return NULL; - translate_keyname(&key, NULL, &name, TRANSLATE_KEYNAME_TO_KEYSYM); - return key; + char *line_ptr = line; + int num_bytes_read = 0; + + while (num_bytes_read < size - 1 && + SDL_RWread(file->asset_file, line_ptr, 1, 1) == 1 && + *line_ptr++ != '\n') + num_bytes_read++; + + *line_ptr = '\0'; + + if (strlen(line) == 0) + { + file->end_of_file = TRUE; + + return NULL; + } + + return line; + } +#endif + + return fgets(line, size, file->file); } -Key getKeyFromX11KeyName(char *x11name) +int copyFile(char *filename_from, char *filename_to) { - Key key; + File *file_from, *file_to; - translate_keyname(&key, &x11name, NULL, TRANSLATE_X11KEYNAME_TO_KEYSYM); - return key; + if ((file_from = openFile(filename_from, MODE_READ)) == NULL) + { + return -1; + } + + if ((file_to = openFile(filename_to, MODE_WRITE)) == NULL) + { + closeFile(file_from); + + return -1; + } + + while (!checkEndOfFile(file_from)) + { + byte buffer[MAX_BUFFER_SIZE]; + size_t bytes_read = readFile(file_from, buffer, 1, MAX_BUFFER_SIZE); + + writeFile(file_to, buffer, 1, bytes_read); + } + + closeFile(file_from); + closeFile(file_to); + + return 0; } -char getCharFromKey(Key key) +boolean touchFile(char *filename) { - char *keyname = getKeyNameFromKey(key); - char letter = 0; + FILE *file; - if (strlen(keyname) == 1) - letter = keyname[0]; - else if (strEqual(keyname, "space")) - letter = ' '; - else if (strEqual(keyname, "circumflex")) - letter = '^'; + if (!(file = fopen(filename, MODE_WRITE))) + { + Warn("cannot touch file '%s'", filename); + + return FALSE; + } - return letter; + fclose(file); + + return TRUE; } -/* ------------------------------------------------------------------------- */ -/* functions to translate string identifiers to integer or boolean value */ -/* ------------------------------------------------------------------------- */ +// ---------------------------------------------------------------------------- +// functions for directory handling +// ---------------------------------------------------------------------------- -int get_integer_from_string(char *s) +Directory *openDirectory(char *dir_name) { - static char *number_text[][3] = + Directory *dir = checked_calloc(sizeof(Directory)); + + dir->dir = opendir(dir_name); + + if (dir->dir != NULL) { - { "0", "zero", "null", }, - { "1", "one", "first" }, - { "2", "two", "second" }, - { "3", "three", "third" }, - { "4", "four", "fourth" }, - { "5", "five", "fifth" }, - { "6", "six", "sixth" }, - { "7", "seven", "seventh" }, - { "8", "eight", "eighth" }, - { "9", "nine", "ninth" }, - { "10", "ten", "tenth" }, - { "11", "eleven", "eleventh" }, - { "12", "twelve", "twelfth" }, + dir->filename = getStringCopy(dir_name); - { NULL, NULL, NULL }, - }; + return dir; + } - int i, j; - char *s_lower = getStringToLower(s); - int result = -1; +#if defined(PLATFORM_ANDROID) + char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME); - for (i = 0; number_text[i][0] != NULL; i++) - for (j = 0; j < 3; j++) - if (strEqual(s_lower, number_text[i][j])) - result = i; + dir->asset_toc_file = SDL_RWFromFile(asset_toc_filename, MODE_READ); - if (result == -1) + checked_free(asset_toc_filename); + + if (dir->asset_toc_file != NULL) { - if (strEqual(s_lower, "false")) - result = 0; - else if (strEqual(s_lower, "true")) - result = 1; - else - result = atoi(s); + dir->directory_is_asset = TRUE; + dir->filename = getStringCopy(dir_name); + + return dir; } +#endif - free(s_lower); + checked_free(dir); - return result; + return NULL; } -boolean get_boolean_from_string(char *s) +int closeDirectory(Directory *dir) { - char *s_lower = getStringToLower(s); - boolean result = FALSE; + if (dir == NULL) + return -1; - if (strEqual(s_lower, "true") || - strEqual(s_lower, "yes") || - strEqual(s_lower, "on") || - get_integer_from_string(s) == 1) - result = TRUE; + int result = 0; - free(s_lower); +#if defined(PLATFORM_ANDROID) + if (dir->asset_toc_file) + result = SDL_RWclose(dir->asset_toc_file); +#endif + + if (dir->dir) + result = closedir(dir->dir); + + if (dir->dir_entry) + freeDirectoryEntry(dir->dir_entry); + + checked_free(dir->filename); + checked_free(dir); return result; } +DirectoryEntry *readDirectory(Directory *dir) +{ + if (dir->dir_entry) + freeDirectoryEntry(dir->dir_entry); + + dir->dir_entry = NULL; + +#if defined(PLATFORM_ANDROID) + if (dir->directory_is_asset) + { + char line[MAX_LINE_LEN]; + char *line_ptr = line; + int num_bytes_read = 0; + + while (num_bytes_read < MAX_LINE_LEN - 1 && + SDL_RWread(dir->asset_toc_file, line_ptr, 1, 1) == 1 && + *line_ptr != '\n') + { + line_ptr++; + num_bytes_read++; + } + + *line_ptr = '\0'; + + if (strlen(line) == 0) + return NULL; + + dir->dir_entry = checked_calloc(sizeof(DirectoryEntry)); + + dir->dir_entry->is_directory = FALSE; + if (line[strlen(line) - 1] == '/') + { + dir->dir_entry->is_directory = TRUE; + + line[strlen(line) - 1] = '\0'; + } + + dir->dir_entry->basename = getStringCopy(line); + dir->dir_entry->filename = getPath2(dir->filename, line); + + return dir->dir_entry; + } +#endif + + struct dirent *dir_entry = readdir(dir->dir); + + if (dir_entry == NULL) + return NULL; + + dir->dir_entry = checked_calloc(sizeof(DirectoryEntry)); -/* ------------------------------------------------------------------------- */ -/* functions for generic lists */ -/* ------------------------------------------------------------------------- */ + dir->dir_entry->basename = getStringCopy(dir_entry->d_name); + dir->dir_entry->filename = getPath2(dir->filename, dir_entry->d_name); -ListNode *newListNode() -{ - return checked_calloc(sizeof(ListNode)); -} + struct stat file_status; -void addNodeToList(ListNode **node_first, char *key, void *content) -{ - ListNode *node_new = newListNode(); + dir->dir_entry->is_directory = + (stat(dir->dir_entry->filename, &file_status) == 0 && + S_ISDIR(file_status.st_mode)); - node_new->key = getStringCopy(key); - node_new->content = content; - node_new->next = *node_first; - *node_first = node_new; + return dir->dir_entry; } -void deleteNodeFromList(ListNode **node_first, char *key, - void (*destructor_function)(void *)) +void freeDirectoryEntry(DirectoryEntry *dir_entry) { - if (node_first == NULL || *node_first == NULL) + if (dir_entry == NULL) return; - if (strEqual((*node_first)->key, key)) - { - free((*node_first)->key); - if (destructor_function) - destructor_function((*node_first)->content); - *node_first = (*node_first)->next; - } - else - deleteNodeFromList(&(*node_first)->next, key, destructor_function); + checked_free(dir_entry->basename); + checked_free(dir_entry->filename); + checked_free(dir_entry); } -ListNode *getNodeFromKey(ListNode *node_first, char *key) -{ - if (node_first == NULL) - return NULL; - if (strEqual(node_first->key, key)) - return node_first; - else - return getNodeFromKey(node_first->next, key); -} +// ---------------------------------------------------------------------------- +// functions for checking files and filenames +// ---------------------------------------------------------------------------- -int getNumNodes(ListNode *node_first) +boolean directoryExists(char *dir_name) { - return (node_first ? 1 + getNumNodes(node_first->next) : 0); -} + if (dir_name == NULL) + return FALSE; -void dumpList(ListNode *node_first) -{ - ListNode *node = node_first; + struct stat file_status; + boolean success = (stat(dir_name, &file_status) == 0 && + S_ISDIR(file_status.st_mode)); - while (node) +#if defined(PLATFORM_ANDROID) + if (!success) { - printf("['%s' (%d)]\n", node->key, - ((struct ListNodeInfo *)node->content)->num_references); - node = node->next; - } + // this might be an asset directory; check by trying to open toc file + char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME); + SDL_RWops *file = SDL_RWFromFile(asset_toc_filename, MODE_READ); - printf("[%d nodes]\n", getNumNodes(node_first)); -} + checked_free(asset_toc_filename); + + success = (file != NULL); + if (success) + SDL_RWclose(file); + } +#endif -/* ------------------------------------------------------------------------- */ -/* functions for checking files and filenames */ -/* ------------------------------------------------------------------------- */ + return success; +} boolean fileExists(char *filename) { if (filename == NULL) return FALSE; - return (access(filename, F_OK) == 0); + boolean success = (access(filename, F_OK) == 0); + +#if defined(PLATFORM_ANDROID) + if (!success) + { + // this might be an asset file; check by trying to open it + SDL_RWops *file = SDL_RWFromFile(filename, MODE_READ); + + success = (file != NULL); + + if (success) + SDL_RWclose(file); + } +#endif + + return success; } -boolean fileHasPrefix(char *basename, char *prefix) +#if 0 +static boolean fileHasPrefix(char *basename, char *prefix) { static char *basename_lower = NULL; int basename_length, prefix_length; @@ -1705,8 +3049,9 @@ boolean fileHasPrefix(char *basename, char *prefix) return FALSE; } +#endif -boolean fileHasSuffix(char *basename, char *suffix) +static boolean fileHasSuffix(char *basename, char *suffix) { static char *basename_lower = NULL; int basename_length, suffix_length; @@ -1728,64 +3073,64 @@ boolean fileHasSuffix(char *basename, char *suffix) return FALSE; } -boolean FileIsGraphic(char *filename) +static boolean FileCouldBeArtwork(char *filename) { char *basename = getBaseNamePtr(filename); - return fileHasSuffix(basename, "pcx"); + return (!strEqual(basename, ".") && + !strEqual(basename, "..") && + !fileHasSuffix(basename, "txt") && + !fileHasSuffix(basename, "conf") && + !directoryExists(filename)); } -boolean FileIsSound(char *filename) +boolean FileIsGraphic(char *filename) { - char *basename = getBaseNamePtr(filename); + return FileCouldBeArtwork(filename); +} - return fileHasSuffix(basename, "wav"); +boolean FileIsSound(char *filename) +{ + return FileCouldBeArtwork(filename); } boolean FileIsMusic(char *filename) { - char *basename = getBaseNamePtr(filename); - - if (FileIsSound(basename)) - return TRUE; - -#if defined(TARGET_SDL) - if (fileHasPrefix(basename, "mod") || - fileHasSuffix(basename, "mod") || - fileHasSuffix(basename, "s3m") || - fileHasSuffix(basename, "it") || - fileHasSuffix(basename, "xm") || - fileHasSuffix(basename, "midi") || - fileHasSuffix(basename, "mid") || - fileHasSuffix(basename, "mp3") || - fileHasSuffix(basename, "ogg")) - return TRUE; -#endif - - return FALSE; + return FileCouldBeArtwork(filename); } -boolean FileIsArtworkType(char *basename, int type) +boolean FileIsArtworkType(char *filename, int type) { - if ((type == TREE_TYPE_GRAPHICS_DIR && FileIsGraphic(basename)) || - (type == TREE_TYPE_SOUNDS_DIR && FileIsSound(basename)) || - (type == TREE_TYPE_MUSIC_DIR && FileIsMusic(basename))) + if ((type == TREE_TYPE_GRAPHICS_DIR && FileIsGraphic(filename)) || + (type == TREE_TYPE_SOUNDS_DIR && FileIsSound(filename)) || + (type == TREE_TYPE_MUSIC_DIR && FileIsMusic(filename))) return TRUE; return FALSE; } -/* ------------------------------------------------------------------------- */ -/* functions for loading artwork configuration information */ -/* ------------------------------------------------------------------------- */ +// ---------------------------------------------------------------------------- +// functions for loading artwork configuration information +// ---------------------------------------------------------------------------- char *get_mapped_token(char *token) { - /* !!! make this dynamically configurable (init.c:InitArtworkConfig) !!! */ + // !!! make this dynamically configurable (init.c:InitArtworkConfig) !!! static char *map_token_prefix[][2] = { - { "char_procent", "char_percent" }, - { NULL, } + { "char_procent", "char_percent" }, + { "bd_magic_wall_filling", "bd_magic_wall.filling" }, + { "bd_magic_wall_emptying", "bd_magic_wall.emptying" }, + { "bd_butterfly_left", "bd_butterfly.left" }, + { "bd_butterfly_right", "bd_butterfly.right" }, + { "bd_butterfly_up", "bd_butterfly.up" }, + { "bd_butterfly_down", "bd_butterfly.down" }, + { "bd_firefly_left", "bd_firefly.left" }, + { "bd_firefly_right", "bd_firefly.right" }, + { "bd_firefly_up", "bd_firefly.up" }, + { "bd_firefly_down", "bd_firefly.down" }, + + { NULL, } }; int i; @@ -1797,130 +3142,90 @@ char *get_mapped_token(char *token) return getStringCat2(map_token_prefix[i][1], &token[len_token_prefix]); } - return NULL; -} - -/* This function checks if a string of the format "string1, string2, ..." - exactly contains a string . */ - -static boolean string_has_parameter(char *s, char *s_contained) -{ - char *substring; - - if (s == NULL || s_contained == NULL) - return FALSE; - - if (strlen(s_contained) > strlen(s)) - return FALSE; - - if (strncmp(s, s_contained, strlen(s_contained)) == 0) + // change tokens containing ".gfx" by moving the "gfx" part to the very left + char *gfx_substring = ".gfx"; + char *gfx_prefix = "gfx."; + if (strstr(token, gfx_substring) != NULL) { - char next_char = s[strlen(s_contained)]; - - /* check if next character is delimiter or whitespace */ - return (next_char == ',' || next_char == '\0' || - next_char == ' ' || next_char == '\t' ? TRUE : FALSE); - } - - /* check if string contains another parameter string after a comma */ - substring = strchr(s, ','); - if (substring == NULL) /* string does not contain a comma */ - return FALSE; - - /* advance string pointer to next character after the comma */ - substring++; - - /* skip potential whitespaces after the comma */ - while (*substring == ' ' || *substring == '\t') - substring++; - - return string_has_parameter(substring, s_contained); -} - -int get_parameter_value(char *value_raw, char *suffix, int type) -{ - char *value = getStringToLower(value_raw); - int result = 0; /* probably a save default value */ + char *token_prefix = getStringCopy(token); + char *token_gfx_pos = strstr(token_prefix, gfx_substring); + char *token_suffix = &token_gfx_pos[strlen(gfx_substring)]; + char *mapped_token; - if (strEqual(suffix, ".direction")) - { - result = (strEqual(value, "left") ? MV_LEFT : - strEqual(value, "right") ? MV_RIGHT : - strEqual(value, "up") ? MV_UP : - strEqual(value, "down") ? MV_DOWN : MV_NONE); - } - else if (strEqual(suffix, ".anim_mode")) - { - result = (string_has_parameter(value, "none") ? ANIM_NONE : - string_has_parameter(value, "loop") ? ANIM_LOOP : - string_has_parameter(value, "linear") ? ANIM_LINEAR : - string_has_parameter(value, "pingpong") ? ANIM_PINGPONG : - string_has_parameter(value, "pingpong2") ? ANIM_PINGPONG2 : - string_has_parameter(value, "random") ? ANIM_RANDOM : - string_has_parameter(value, "ce_value") ? ANIM_CE_VALUE : - string_has_parameter(value, "ce_score") ? ANIM_CE_SCORE : - string_has_parameter(value, "ce_delay") ? ANIM_CE_DELAY : - string_has_parameter(value, "horizontal") ? ANIM_HORIZONTAL : - string_has_parameter(value, "vertical") ? ANIM_VERTICAL : - ANIM_DEFAULT); + // cut off token string at ".gfx" substring position + *token_gfx_pos = '\0'; - if (string_has_parameter(value, "reverse")) - result |= ANIM_REVERSE; + // put together prefix "gfx." and token prefix and suffix without ".gfx" + mapped_token = getStringCat3(gfx_prefix, token_prefix, token_suffix); - if (string_has_parameter(value, "opaque_player")) - result |= ANIM_OPAQUE_PLAYER; + free(token_prefix); - if (string_has_parameter(value, "static_panel")) - result |= ANIM_STATIC_PANEL; - } - else /* generic parameter of type integer or boolean */ - { - result = (strEqual(value, ARG_UNDEFINED) ? ARG_UNDEFINED_VALUE : - type == TYPE_INTEGER ? get_integer_from_string(value) : - type == TYPE_BOOLEAN ? get_boolean_from_string(value) : - ARG_UNDEFINED_VALUE); + return mapped_token; } - free(value); - - return result; + return NULL; } -int get_auto_parameter_value(char *token, char *value_raw) +static char *get_special_base_token(struct ArtworkListInfo *artwork_info, + char *token) { - char *suffix; - - if (token == NULL || value_raw == NULL) - return ARG_UNDEFINED_VALUE; - - suffix = strrchr(token, '.'); - if (suffix == NULL) - suffix = token; - - return get_parameter_value(value_raw, suffix, TYPE_INTEGER); -} + // !!! make this dynamically configurable (init.c:InitArtworkConfig) !!! + static struct ConfigTypeInfo prefix_list[] = + { + { "global.anim_1" }, + { "global.anim_2" }, + { "global.anim_3" }, + { "global.anim_4" }, + { "global.anim_5" }, + { "global.anim_6" }, + { "global.anim_7" }, + { "global.anim_8" }, + { "global.anim_9" }, + { "global.anim_10" }, + { "global.anim_11" }, + { "global.anim_12" }, + { "global.anim_13" }, + { "global.anim_14" }, + { "global.anim_15" }, + { "global.anim_16" }, + { "global.anim_17" }, + { "global.anim_18" }, + { "global.anim_19" }, + { "global.anim_20" }, + { "global.anim_21" }, + { "global.anim_22" }, + { "global.anim_23" }, + { "global.anim_24" }, + { "global.anim_25" }, + { "global.anim_26" }, + { "global.anim_27" }, + { "global.anim_28" }, + { "global.anim_29" }, + { "global.anim_30" }, + { "global.anim_31" }, + { "global.anim_32" }, + + { NULL } + }; + struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list; + boolean prefix_found = FALSE; + int len_suffix = 0; + int i; -struct ScreenModeInfo *get_screen_mode_from_string(char *screen_mode_string) -{ - static struct ScreenModeInfo screen_mode; - char *screen_mode_string_x = strchr(screen_mode_string, 'x'); - char *screen_mode_string_copy; - char *screen_mode_string_pos_w; - char *screen_mode_string_pos_h; + // search for prefix to check if base token has to be created + for (i = 0; prefix_list[i].token != NULL; i++) + if (strPrefix(token, prefix_list[i].token)) + prefix_found = TRUE; - if (screen_mode_string_x == NULL) /* invalid screen mode format */ + if (!prefix_found) return NULL; - screen_mode_string_copy = getStringCopy(screen_mode_string); - - screen_mode_string_pos_w = screen_mode_string_copy; - screen_mode_string_pos_h = strchr(screen_mode_string_copy, 'x'); - *screen_mode_string_pos_h++ = '\0'; - - screen_mode.width = atoi(screen_mode_string_pos_w); - screen_mode.height = atoi(screen_mode_string_pos_h); + // search for suffix (parameter) to determine base token length + for (i = 0; suffix_list[i].token != NULL; i++) + if (strSuffix(token, suffix_list[i].token)) + len_suffix = strlen(suffix_list[i].token); - return &screen_mode; + return getStringCopyN(token, strlen(token) - len_suffix); } static void FreeCustomArtworkList(struct ArtworkListInfo *, @@ -1931,18 +3236,24 @@ struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list, char **ignore_tokens, int num_file_list_entries) { + SetupFileHash *ignore_tokens_hash; struct FileInfo *file_list; int num_file_list_entries_found = 0; int num_suffix_list_entries = 0; int list_pos; int i, j; + // create hash from list of tokens to be ignored (for quick access) + ignore_tokens_hash = newSetupFileHash(); + for (i = 0; ignore_tokens[i] != NULL; i++) + setHashEntry(ignore_tokens_hash, ignore_tokens[i], ""); + file_list = checked_calloc(num_file_list_entries * sizeof(struct FileInfo)); for (i = 0; suffix_list[i].token != NULL; i++) num_suffix_list_entries++; - /* always start with reliable default values */ + // always start with reliable default values for (i = 0; i < num_file_list_entries; i++) { file_list[i].token = NULL; @@ -1965,14 +3276,15 @@ struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list, file_list[i].redefined = FALSE; file_list[i].fallback_to_default = FALSE; + file_list[i].default_is_cloned = FALSE; } } list_pos = 0; + 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++) @@ -1987,14 +3299,14 @@ struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list, config_list[i].value); is_file_entry = FALSE; + break; } } - /* the following tokens are no file definitions, but other config tokens */ - for (j = 0; ignore_tokens[j] != NULL; j++) - if (strEqual(config_list[i].token, ignore_tokens[j])) - is_file_entry = FALSE; + // the following tokens are no file definitions, but other config tokens + if (getHashEntry(ignore_tokens_hash, config_list[i].token) != NULL) + is_file_entry = FALSE; if (is_file_entry) { @@ -2004,33 +3316,29 @@ struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list, if (list_pos >= num_file_list_entries) break; - /* simple sanity check if this is really a file definition */ - if (!strEqual(&config_list[i].value[len_config_value - 4], ".pcx") && - !strEqual(&config_list[i].value[len_config_value - 4], ".wav") && - !strEqual(config_list[i].value, UNDEFINED_FILENAME)) - { - Error(ERR_RETURN, "Configuration directive '%s' -> '%s':", - config_list[i].token, config_list[i].value); - Error(ERR_EXIT, "This seems to be no valid definition -- please fix"); - } - file_list[list_pos].token = config_list[i].token; file_list[list_pos].default_filename = config_list[i].value; } + + if (strSuffix(config_list[i].token, ".clone_from")) + file_list[list_pos].default_is_cloned = TRUE; } num_file_list_entries_found = list_pos + 1; if (num_file_list_entries_found != num_file_list_entries) { - Error(ERR_RETURN_LINE, "-"); - Error(ERR_RETURN, "inconsistant config list information:"); - Error(ERR_RETURN, "- should be: %d (according to 'src/conf_gfx.h')", + Error("---"); + Error("inconsistant config list information:"); + Error("- should be: %d (according to 'src/conf_xxx.h')", num_file_list_entries); - Error(ERR_RETURN, "- found to be: %d (according to 'src/conf_gfx.c')", + Error("- found to be: %d (according to 'src/conf_xxx.c')", num_file_list_entries_found); - Error(ERR_EXIT, "please fix"); + + Fail("please fix"); } + freeSetupFileHash(ignore_tokens_hash); + return file_list; } @@ -2039,7 +3347,7 @@ static boolean token_suffix_match(char *token, char *suffix, int start_pos) int len_token = strlen(token); int len_suffix = strlen(suffix); - if (start_pos < 0) /* compare suffix from end of string */ + if (start_pos < 0) // compare suffix from end of string start_pos += len_token; if (start_pos < 0 || start_pos + len_suffix > len_token) @@ -2063,7 +3371,7 @@ static void read_token_parameters(SetupFileHash *setup_file_hash, struct ConfigTypeInfo *suffix_list, struct FileInfo *file_list_entry) { - /* check for config token that is the base token without any suffixes */ + // check for config token that is the base token without any suffixes char *filename = getHashEntry(setup_file_hash, file_list_entry->token); char *known_token_value = KNOWN_TOKEN_VALUE; int i; @@ -2072,17 +3380,17 @@ 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 */ + // when file definition found, set all parameters to default values for (i = 0; suffix_list[i].token != NULL; i++) setString(&file_list_entry->parameter[i], suffix_list[i].value); file_list_entry->redefined = TRUE; - /* mark config file token as well known from default config */ + // mark config file token as well known from default config setHashEntry(setup_file_hash, file_list_entry->token, known_token_value); } - /* check for config tokens that can be build by base token and suffixes */ + // check for config tokens that can be build by base token and suffixes for (i = 0; suffix_list[i].token != NULL; i++) { char *token = getStringCat2(file_list_entry->token, suffix_list[i].token); @@ -2092,7 +3400,7 @@ static void read_token_parameters(SetupFileHash *setup_file_hash, { setString(&file_list_entry->parameter[i], value); - /* mark config file token as well known from default config */ + // mark config file token as well known from default config setHashEntry(setup_file_hash, token, known_token_value); } @@ -2121,6 +3429,7 @@ static void add_dynamic_file_list_entry(struct FileInfo **list, new_list_entry->redefined = FALSE; new_list_entry->fallback_to_default = FALSE; + new_list_entry->default_is_cloned = FALSE; read_token_parameters(extra_file_hash, suffix_list, new_list_entry); } @@ -2163,22 +3472,19 @@ 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, *valid_file_hash; + SetupFileHash *setup_file_hash, *valid_file_hash, *valid_file_hash_tmp; SetupFileHash *extra_file_hash, *empty_file_hash; char *known_token_value = KNOWN_TOKEN_VALUE; + char *base_token_value = UNDEFINED_FILENAME; int i, j, k, l; if (filename == NULL) return; -#if 0 - printf("LoadArtworkConfigFromFilename '%s' ...\n", filename); -#endif - if ((setup_file_hash = loadSetupFileHash(filename)) == NULL) return; - /* separate valid (defined) from empty (undefined) config token values */ + // separate valid (defined) from empty (undefined) config token values valid_file_hash = newSetupFileHash(); empty_file_hash = newSetupFileHash(); BEGIN_HASH_ITERATION(setup_file_hash, itr) @@ -2190,11 +3496,23 @@ static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info, } END_HASH_ITERATION(setup_file_hash, itr) - /* at this point, we do not need the setup file hash anymore -- free it */ + // at this point, we do not need the setup file hash anymore -- free it freeSetupFileHash(setup_file_hash); - /* map deprecated to current tokens (using prefix match and replace) */ + // prevent changing hash while iterating over it by using a temporary copy + valid_file_hash_tmp = newSetupFileHash(); BEGIN_HASH_ITERATION(valid_file_hash, itr) + { + setHashEntry(valid_file_hash_tmp, + HASH_ITERATION_TOKEN(itr), + HASH_ITERATION_VALUE(itr)); + } + END_HASH_ITERATION(valid_file_hash, itr) + + // (iterate over same temporary hash, as modifications are independent) + + // map deprecated to current tokens (using prefix match and replace) + BEGIN_HASH_ITERATION(valid_file_hash_tmp, itr) { char *token = HASH_ITERATION_TOKEN(itr); char *mapped_token = get_mapped_token(token); @@ -2203,26 +3521,46 @@ static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info, { char *value = HASH_ITERATION_VALUE(itr); - /* add mapped token */ + // add mapped token setHashEntry(valid_file_hash, mapped_token, value); - /* ignore old token (by setting it to "known" keyword) */ + // ignore old token (by setting it to "known" keyword) setHashEntry(valid_file_hash, token, known_token_value); free(mapped_token); } } - END_HASH_ITERATION(valid_file_hash, itr) + END_HASH_ITERATION(valid_file_hash_tmp, itr) + + // add special base tokens (using prefix match and replace) + BEGIN_HASH_ITERATION(valid_file_hash_tmp, itr) + { + char *token = HASH_ITERATION_TOKEN(itr); + char *base_token = get_special_base_token(artwork_info, token); + + if (base_token != NULL) + { + // add base token only if it does not already exist + if (getHashEntry(valid_file_hash, base_token) == NULL) + setHashEntry(valid_file_hash, base_token, base_token_value); + + free(base_token); + } + } + END_HASH_ITERATION(valid_file_hash_tmp, itr) - /* read parameters for all known config file tokens */ + // free temporary hash used for iteration + freeSetupFileHash(valid_file_hash_tmp); + + // read parameters for all known config file tokens 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 */ + // set all tokens that can be ignored here to "known" keyword 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 hash */ + // copy all unknown config file tokens to extra config hash extra_file_hash = newSetupFileHash(); BEGIN_HASH_ITERATION(valid_file_hash, itr) { @@ -2233,10 +3571,10 @@ static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info, } END_HASH_ITERATION(valid_file_hash, itr) - /* at this point, we do not need the valid file hash anymore -- free it */ + // 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 */ + // now try to determine valid, dynamically defined config tokens BEGIN_HASH_ITERATION(extra_file_hash, itr) { @@ -2257,11 +3595,7 @@ static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info, boolean base_prefix_found = FALSE; boolean parameter_suffix_found = FALSE; -#if 0 - printf("::: examining '%s' -> '%s'\n", token, HASH_ITERATION_VALUE(itr)); -#endif - - /* skip all parameter definitions (handled by read_token_parameters()) */ + // skip all parameter definitions (handled by read_token_parameters()) for (i = 0; i < num_suffix_list_entries && !parameter_suffix_found; i++) { int len_suffix = strlen(suffix_list[i].token); @@ -2273,7 +3607,7 @@ static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info, if (parameter_suffix_found) continue; - /* ---------- step 0: search for matching base prefix ---------- */ + // ---------- step 0: search for matching base prefix ---------- start_pos = 0; for (i = 0; i < num_base_prefixes && !base_prefix_found; i++) @@ -2296,7 +3630,7 @@ static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info, base_index = i; - if (start_pos + len_base_prefix == len_token) /* exact match */ + if (start_pos + len_base_prefix == len_token) // exact match { exact_match = TRUE; @@ -2313,12 +3647,7 @@ static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info, continue; } -#if 0 - if (IS_PARENT_PROCESS()) - printf("---> examining token '%s': search 1st suffix ...\n", token); -#endif - - /* ---------- step 1: search for matching first suffix ---------- */ + // ---------- step 1: search for matching first suffix ---------- start_pos += len_base_prefix; for (j = 0; j < num_ext1_suffixes && !ext1_suffix_found; j++) @@ -2333,7 +3662,7 @@ static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info, ext1_index = j; - if (start_pos + len_ext1_suffix == len_token) /* exact match */ + if (start_pos + len_ext1_suffix == len_token) // exact match { exact_match = TRUE; @@ -2356,12 +3685,7 @@ static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info, if (exact_match) break; -#if 0 - if (IS_PARENT_PROCESS()) - printf("---> examining token '%s': search 2nd suffix ...\n", token); -#endif - - /* ---------- step 2: search for matching second suffix ---------- */ + // ---------- step 2: search for matching second suffix ---------- for (k = 0; k < num_ext2_suffixes && !ext2_suffix_found; k++) { @@ -2375,7 +3699,7 @@ static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info, ext2_index = k; - if (start_pos + len_ext2_suffix == len_token) /* exact match */ + if (start_pos + len_ext2_suffix == len_token) // exact match { exact_match = TRUE; @@ -2398,12 +3722,7 @@ static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info, if (exact_match) break; -#if 0 - if (IS_PARENT_PROCESS()) - printf("---> examining token '%s': search 3rd suffix ...\n",token); -#endif - - /* ---------- step 3: search for matching third suffix ---------- */ + // ---------- step 3: search for matching third suffix ---------- for (l = 0; l < num_ext3_suffixes && !ext3_suffix_found; l++) { @@ -2417,7 +3736,7 @@ static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info, ext3_index = l; - if (start_pos + len_ext3_suffix == len_token) /* exact match */ + if (start_pos + len_ext3_suffix == len_token) // exact match { exact_match = TRUE; @@ -2452,8 +3771,8 @@ static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info, 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"); + // list may be NULL for empty artwork config files + setup_file_list = loadSetupFileList(filename); BEGIN_HASH_ITERATION(extra_file_hash, itr) { @@ -2466,53 +3785,53 @@ static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info, if (options.debug && dynamic_tokens_found) { - Error(ERR_RETURN_LINE, "-"); - Error(ERR_RETURN, "dynamic token(s) found in config file:"); - Error(ERR_RETURN, "- config file: '%s'", filename); + Debug("config", "---"); + Debug("config", "dynamic token(s) found in config file:"); + Debug("config", "- config file: '%s'", filename); for (list = setup_file_list; list != NULL; list = list->next) { char *value = getHashEntry(extra_file_hash, list->token); if (value != NULL && strEqual(value, known_token_value)) - Error(ERR_RETURN, "- dynamic token: '%s'", list->token); + Debug("config", "- dynamic token: '%s'", list->token); } - Error(ERR_RETURN_LINE, "-"); + Debug("config", "---"); } if (unknown_tokens_found) { - Error(ERR_RETURN_LINE, "-"); - Error(ERR_RETURN, "warning: unknown token(s) found in config file:"); - Error(ERR_RETURN, "- config file: '%s'", filename); + Warn("---"); + Warn("unknown token(s) found in config file:"); + Warn("- config file: '%s'", filename); for (list = setup_file_list; list != NULL; list = list->next) { char *value = getHashEntry(extra_file_hash, list->token); if (value != NULL && !strEqual(value, known_token_value)) - Error(ERR_RETURN, "- dynamic token: '%s'", list->token); + Warn("- dynamic token: '%s'", list->token); } - Error(ERR_RETURN_LINE, "-"); + Warn("---"); } 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); + Warn("---"); + Warn("undefined values found in config file:"); + Warn("- 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); + Warn("- undefined value for token: '%s'", list->token); } - Error(ERR_RETURN_LINE, "-"); + Warn("---"); } freeSetupFileList(setup_file_list); @@ -2520,17 +3839,6 @@ static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info, freeSetupFileHash(extra_file_hash); freeSetupFileHash(empty_file_hash); - -#if 0 - for (i = 0; i < num_file_list_entries; i++) - { - printf("'%s' ", file_list[i].token); - if (file_list[i].filename) - printf("-> '%s'\n", file_list[i].filename); - else - printf("-> UNDEFINED [-> '%s']\n", file_list[i].default_filename); - } -#endif } void LoadArtworkConfig(struct ArtworkListInfo *artwork_info) @@ -2541,10 +3849,10 @@ void LoadArtworkConfig(struct ArtworkListInfo *artwork_info) char *filename_base = UNDEFINED_FILENAME, *filename_local; int i, j; - DrawInitText("Loading artwork config:", 120, FC_GREEN); - DrawInitText(ARTWORKINFO_FILENAME(artwork_info->type), 150, FC_YELLOW); + DrawInitTextHead("Loading artwork config"); + DrawInitTextItem(ARTWORKINFO_FILENAME(artwork_info->type)); - /* always start with reliable default values */ + // always start with reliable default values for (i = 0; i < num_file_list_entries; i++) { setString(&file_list[i].filename, file_list[i].default_filename); @@ -2556,7 +3864,7 @@ void LoadArtworkConfig(struct ArtworkListInfo *artwork_info) file_list[i].fallback_to_default = FALSE; } - /* free previous dynamic artwork file array */ + // 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++) @@ -2573,7 +3881,7 @@ void LoadArtworkConfig(struct ArtworkListInfo *artwork_info) &artwork_info->num_dynamic_file_list_entries); } - /* free previous property mapping */ + // free previous property mapping if (artwork_info->property_mapping != NULL) { free(artwork_info->property_mapping); @@ -2582,9 +3890,9 @@ void LoadArtworkConfig(struct ArtworkListInfo *artwork_info) artwork_info->num_property_mapping_entries = 0; } - if (!SETUP_OVERRIDE_ARTWORK(setup, artwork_info->type)) + if (!GFX_OVERRIDE_ARTWORK(artwork_info->type)) { - /* first look for special artwork configured in level series config */ + // first look for special artwork configured in level series config filename_base = getCustomArtworkLevelConfigFilename(artwork_info->type); if (fileExists(filename_base)) @@ -2618,97 +3926,108 @@ static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info, { char *init_text[] = { - "Loading graphics:", - "Loading sounds:", - "Loading music:" + "Loading graphics", + "Loading sounds", + "Loading music" }; ListNode *node; char *basename = file_list_entry->filename; char *filename = getCustomArtworkFilename(basename, artwork_info->type); + // mark all images from non-default graphics directory as "redefined" + if (artwork_info->type == ARTWORK_TYPE_GRAPHICS && + !strPrefix(filename, options.graphics_directory)) + file_list_entry->redefined = TRUE; + if (filename == NULL) { - Error(ERR_WARN, "cannot find artwork file '%s'", basename); + Warn("cannot find artwork file '%s'", basename); basename = file_list_entry->default_filename; - /* dynamic artwork has no default filename / skip empty default artwork */ + // fail for cloned default artwork that has no default filename defined + if (file_list_entry->default_is_cloned && + strEqual(basename, UNDEFINED_FILENAME)) + { + void (*error_func)(char *, ...) = Warn; + + // we can get away without sounds and music, but not without graphics + if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS) + error_func = Fail; + + error_func("token '%s' was cloned and has no default filename", + file_list_entry->token); + + return; + } + + // dynamic artwork has no default filename / skip empty default artwork if (basename == NULL || strEqual(basename, UNDEFINED_FILENAME)) return; file_list_entry->fallback_to_default = TRUE; - Error(ERR_WARN, "trying default artwork file '%s'", basename); + Warn("trying default artwork file '%s'", basename); filename = getCustomArtworkFilename(basename, artwork_info->type); if (filename == NULL) { - int error_mode = ERR_WARN; + void (*error_func)(char *, ...) = Warn; - /* we can get away without sounds and music, but not without graphics */ + // we can get away without sounds and music, but not without graphics if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS) - error_mode = ERR_EXIT; + error_func = Fail; - Error(error_mode, "cannot find default artwork file '%s'", basename); + error_func("cannot find default artwork file '%s'", basename); return; } } - /* check if the old and the new artwork file are the same */ + // check if the old and the new artwork file are the same if (*listnode && strEqual((*listnode)->source_filename, filename)) { - /* The old and new artwork are the same (have the same filename and path). - This usually means that this artwork does not exist in this artwork set - and a fallback to the existing artwork is done. */ - -#if 0 - printf("[artwork '%s' already exists (same list entry)]\n", filename); -#endif + // The old and new artwork are the same (have the same filename and path). + // This usually means that this artwork does not exist in this artwork set + // and a fallback to the existing artwork is done. return; } - /* delete existing artwork file entry */ + // delete existing artwork file entry deleteArtworkListEntry(artwork_info, listnode); - /* check if the new artwork file already exists in the list of artworks */ + // check if the new artwork file already exists in the list of artwork if ((node = getNodeFromKey(artwork_info->content_list, filename)) != NULL) { -#if 0 - printf("[artwork '%s' already exists (other list entry)]\n", filename); -#endif - *listnode = (struct ListNodeInfo *)node->content; (*listnode)->num_references++; return; } - DrawInitText(init_text[artwork_info->type], 120, FC_GREEN); - DrawInitText(basename, 150, FC_YELLOW); + DrawInitTextHead(init_text[artwork_info->type]); + DrawInitTextItem(basename); if ((*listnode = artwork_info->load_artwork(filename)) != NULL) { -#if 0 - printf("[adding new artwork '%s']\n", filename); -#endif - + // add new artwork file entry to the list of artwork files (*listnode)->num_references = 1; addNodeToList(&artwork_info->content_list, (*listnode)->source_filename, *listnode); } else { - int error_mode = ERR_WARN; + void (*error_func)(char *, ...) = Warn; - /* we can get away without sounds and music, but not without graphics */ + // we can get away without sounds and music, but not without graphics if (artwork_info->type == ARTWORK_TYPE_GRAPHICS) - error_mode = ERR_EXIT; + error_func = Fail; + + error_func("cannot load artwork file '%s'", basename); - Error(error_mode, "cannot load artwork file '%s'", basename); return; } } @@ -2717,13 +4036,10 @@ static void LoadCustomArtwork(struct ArtworkListInfo *artwork_info, struct ListNodeInfo **listnode, struct FileInfo *file_list_entry) { -#if 0 - printf("GOT CUSTOM ARTWORK FILE '%s'\n", filename); -#endif - if (strEqual(file_list_entry->filename, UNDEFINED_FILENAME)) { deleteArtworkListEntry(artwork_info, listnode); + return; } @@ -2739,6 +4055,8 @@ void ReloadCustomArtworkList(struct ArtworkListInfo *artwork_info) artwork_info->num_dynamic_file_list_entries; int i; + print_timestamp_init("ReloadCustomArtworkList"); + for (i = 0; i < num_file_list_entries; i++) LoadCustomArtwork(artwork_info, &artwork_info->artwork_list[i], &file_list[i]); @@ -2747,6 +4065,8 @@ void ReloadCustomArtworkList(struct ArtworkListInfo *artwork_info) LoadCustomArtwork(artwork_info, &artwork_info->dynamic_artwork_list[i], &dynamic_file_list[i]); + print_timestamp_done("ReloadCustomArtworkList"); + #if 0 dumpList(artwork_info->content_list); #endif @@ -2782,84 +4102,159 @@ void FreeCustomArtworkLists(struct ArtworkListInfo *artwork_info) } -/* ------------------------------------------------------------------------- */ -/* functions only needed for non-Unix (non-command-line) systems */ -/* (MS-DOS only; SDL/Windows creates files "stdout.txt" and "stderr.txt") */ -/* (now also added for Windows, to create files in user data directory) */ -/* ------------------------------------------------------------------------- */ +// ---------------------------------------------------------------------------- +// functions only needed for non-Unix (non-command-line) systems +// (MS-DOS only; SDL/Windows creates files "stdout.txt" and "stderr.txt") +// (now also added for Windows, to create files in user data directory) +// ---------------------------------------------------------------------------- -char *getErrorFilename(char *basename) +char *getLogFilename(char *basename) { - return getPath2(getUserGameDataDir(), basename); + return getPath2(getMainUserGameDataDir(), basename); } -void openErrorFile() +void OpenLogFiles(void) { - /* always start with reliable default values */ - program.error_file = stderr; + int i; -#if defined(PLATFORM_WIN32) || defined(PLATFORM_MSDOS) - if ((program.error_file = fopen(program.error_filename, MODE_WRITE)) == NULL) - fprintf_newline(stderr, "ERROR: cannot open file '%s' for writing!", - program.error_filename); -#endif + InitMainUserDataDirectory(); + + for (i = 0; i < NUM_LOGS; i++) + { + if ((program.log_file[i] = fopen(program.log_filename[i], MODE_WRITE)) + == NULL) + { + program.log_file[i] = program.log_file_default[i]; // reset to default + + Warn("cannot open file '%s' for writing: %s", + program.log_filename[i], strerror(errno)); + } + + // output should be unbuffered so it is not truncated in a crash + setbuf(program.log_file[i], NULL); + } } -void closeErrorFile() +void CloseLogFiles(void) { - if (program.error_file != stderr) /* do not close stream 'stderr' */ - fclose(program.error_file); + int i; + + for (i = 0; i < NUM_LOGS; i++) + if (program.log_file[i] != program.log_file_default[i]) + fclose(program.log_file[i]); } -void dumpErrorFile() +void DumpLogFile(int nr) { - FILE *error_file = fopen(program.error_filename, MODE_READ); + FILE *log_file = fopen(program.log_filename[nr], MODE_READ); - if (error_file != NULL) - { - while (!feof(error_file)) - fputc(fgetc(error_file), stderr); + if (log_file == NULL) + return; - fclose(error_file); - } + while (!feof(log_file)) + fputc(fgetc(log_file), stdout); + + fclose(log_file); } -void NotifyUserAboutErrorFile() +void NotifyUserAboutErrorFile(void) { #if defined(PLATFORM_WIN32) char *title_text = getStringCat2(program.program_title, " Error Message"); char *error_text = getStringCat2("The program was aborted due to an error; " "for details, see the following error file:" - STRING_NEWLINE, program.error_filename); + STRING_NEWLINE, + program.log_filename[LOG_ERR_ID]); MessageBox(NULL, error_text, title_text, MB_OK); #endif } -/* ------------------------------------------------------------------------- */ -/* the following is only for debugging purpose and normally not used */ -/* ------------------------------------------------------------------------- */ +// ---------------------------------------------------------------------------- +// the following is only for debugging purpose and normally not used +// ---------------------------------------------------------------------------- + +#if DEBUG + +#define DEBUG_PRINT_INIT_TIMESTAMPS TRUE +#define DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH 10 + +#define DEBUG_NUM_TIMESTAMPS 10 +#define DEBUG_TIME_IN_MICROSECONDS 0 + +#if DEBUG_TIME_IN_MICROSECONDS +static double Counter_Microseconds(void) +{ + static struct timeval base_time = { 0, 0 }; + struct timeval current_time; + double counter; + + gettimeofday(¤t_time, NULL); + + // reset base time in case of wrap-around + if (current_time.tv_sec < base_time.tv_sec) + base_time = current_time; + + counter = + ((double)(current_time.tv_sec - base_time.tv_sec)) * 1000000 + + ((double)(current_time.tv_usec - base_time.tv_usec)); + + return counter; // return microseconds since last init +} +#endif + +static char *debug_print_timestamp_get_padding(int padding_size) +{ + static char *padding = NULL; + int max_padding_size = 100; + + if (padding == NULL) + { + padding = checked_calloc(max_padding_size + 1); + memset(padding, ' ', max_padding_size); + } -#define DEBUG_NUM_TIMESTAMPS 3 + return &padding[MAX(0, max_padding_size - padding_size)]; +} void debug_print_timestamp(int counter_nr, char *message) { - static long counter[DEBUG_NUM_TIMESTAMPS][2]; + int indent_size = 8; + int padding_size = 40; + float timestamp_interval; - if (counter_nr >= DEBUG_NUM_TIMESTAMPS) - Error(ERR_EXIT, "debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c"); + if (counter_nr < 0) + Fail("debugging: invalid negative counter"); + else if (counter_nr >= DEBUG_NUM_TIMESTAMPS) + Fail("debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c"); + +#if DEBUG_TIME_IN_MICROSECONDS + static double counter[DEBUG_NUM_TIMESTAMPS][2]; + char *unit = "ms"; + + counter[counter_nr][0] = Counter_Microseconds(); +#else + static int counter[DEBUG_NUM_TIMESTAMPS][2]; + char *unit = "s"; counter[counter_nr][0] = Counter(); +#endif - if (message) - printf("%s %.2f seconds\n", message, - (float)(counter[counter_nr][0] - counter[counter_nr][1]) / 1000); + timestamp_interval = counter[counter_nr][0] - counter[counter_nr][1]; + counter[counter_nr][1] = counter[counter_nr][0]; - counter[counter_nr][1] = Counter(); + if (message) + Debug("time:init", "%s%s%s %.3f %s", + debug_print_timestamp_get_padding(counter_nr * indent_size), + message, + debug_print_timestamp_get_padding(padding_size - strlen(message)), + timestamp_interval / 1000, + unit); } -void debug_print_parent_only(char *format, ...) +#if 0 +static void debug_print_parent_only(char *format, ...) { if (!IS_PARENT_PROCESS()) return; @@ -2875,3 +4270,70 @@ void debug_print_parent_only(char *format, ...) printf("\n"); } } +#endif + +#endif // DEBUG + +static void print_timestamp_ext(char *message, char *mode) +{ +#if DEBUG_PRINT_INIT_TIMESTAMPS + static char *debug_message = NULL; + static char *last_message = NULL; + static int counter_nr = 0; + int max_depth = DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH; + + checked_free(debug_message); + debug_message = getStringCat3(mode, " ", message); + + if (strEqual(mode, "INIT")) + { + debug_print_timestamp(counter_nr, NULL); + + if (counter_nr + 1 < max_depth) + debug_print_timestamp(counter_nr, debug_message); + + counter_nr++; + + debug_print_timestamp(counter_nr, NULL); + } + else if (strEqual(mode, "DONE")) + { + counter_nr--; + + if (counter_nr + 1 < max_depth || + (counter_nr == 0 && max_depth == 1)) + { + last_message = message; + + if (counter_nr == 0 && max_depth == 1) + { + checked_free(debug_message); + debug_message = getStringCat3("TIME", " ", message); + } + + debug_print_timestamp(counter_nr, debug_message); + } + } + else if (!strEqual(mode, "TIME") || + !strEqual(message, last_message)) + { + if (counter_nr < max_depth) + debug_print_timestamp(counter_nr, debug_message); + } +#endif +} + +void print_timestamp_init(char *message) +{ + print_timestamp_ext(message, "INIT"); +} + +void print_timestamp_time(char *message) +{ + print_timestamp_ext(message, "TIME"); +} + +void print_timestamp_done(char *message) +{ + print_timestamp_ext(message, "DONE"); +}