X-Git-Url: https://git.artsoft.org/?a=blobdiff_plain;f=src%2Flibgame%2Fmisc.c;h=f90b2c23b7b23f1bfb28420f4aac8784a9a31447;hb=3ff2e8a0b5c27b99a9920bdf5ed82bc41bf40181;hp=a78429b7c40c50cf3a65279150304c7e00f97c2d;hpb=8932f698c0831ab0e4ae2e03d64a48be1aeee82a;p=rocksndiamonds.git diff --git a/src/libgame/misc.c b/src/libgame/misc.c index a78429b7..78dddf8a 100644 --- a/src/libgame/misc.c +++ b/src/libgame/misc.c @@ -1,15 +1,13 @@ -/*********************************************************** -* Artsoft Retro-Game Library * -*----------------------------------------------------------* -* (c) 1994-2001 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 +// http://www.artsoft.org/ +// ---------------------------------------------------------------------------- +// misc.c +// ============================================================================ #include #include @@ -19,6 +17,7 @@ #include #include #include +#include #include "platform.h" @@ -28,95 +27,238 @@ #endif #include "misc.h" +#include "setup.h" #include "random.h" +#include "text.h" +#include "image.h" -#if defined(PLATFORM_MSDOS) -volatile unsigned long counter = 0; +/* ========================================================================= */ +/* some generic helper functions */ +/* ========================================================================= */ + +/* ------------------------------------------------------------------------- */ +/* platform independent wrappers for printf() et al. (newline aware) */ +/* ------------------------------------------------------------------------- */ + +#if defined(PLATFORM_ANDROID) +static int android_log_prio = ANDROID_LOG_INFO; +#endif + +#if 0 +static void vfPrintLog(FILE *stream, char *format, va_list ap) +{ +} + +static void vfPrintLog(FILE *stream, char *format, va_list ap) +{ +} -void increment_counter() +static void fPrintLog(FILE *stream, char *format, va_list ap) { - counter++; } -END_OF_FUNCTION(increment_counter); +static void fPrintLog(FILE *stream, char *format, va_list ap) +{ +} #endif +static void vfprintf_nonewline(FILE *stream, char *format, va_list ap) +{ +#if defined(PLATFORM_ANDROID) + // (prefix text of logging output is currently skipped on Android) + //__android_log_vprint(android_log_prio, program.program_title, format, ap); +#else + va_list ap2; + va_copy(ap2, ap); + + vfprintf(stream, format, ap); + vfprintf(stderr, format, ap2); -/* maximal allowed length of a command line option */ -#define MAX_OPTION_LEN 256 + va_end(ap2); +#endif +} -#ifdef TARGET_SDL -static unsigned long mainCounter(int mode) +static void vfprintf_newline(FILE *stream, char *format, va_list ap) { - static unsigned long base_ms = 0; - unsigned long current_ms; - unsigned long counter_ms; +#if defined(PLATFORM_ANDROID) + __android_log_vprint(android_log_prio, program.program_title, format, ap); +#else + char *newline = STRING_NEWLINE; - current_ms = SDL_GetTicks(); + va_list ap2; + va_copy(ap2, ap); - /* reset base time in case of counter initializing or wrap-around */ - if (mode == INIT_COUNTER || current_ms < base_ms) - base_ms = current_ms; + vfprintf(stream, format, ap); + fprintf(stream, "%s", newline); - counter_ms = current_ms - base_ms; + vfprintf(stderr, format, ap2); + fprintf(stderr, "%s", newline); - return counter_ms; /* return milliseconds since last init */ + va_end(ap2); +#endif } -#else /* !TARGET_SDL */ +static void fprintf_nonewline(FILE *stream, char *format, ...) +{ + va_list ap; + + va_start(ap, format); + vfprintf_nonewline(stream, format, ap); + va_end(ap); +} -#if defined(PLATFORM_UNIX) -static unsigned long mainCounter(int mode) +static void fprintf_newline(FILE *stream, char *format, ...) { - static struct timeval base_time = { 0, 0 }; - struct timeval current_time; - unsigned long counter_ms; + va_list ap; - gettimeofday(¤t_time, NULL); + va_start(ap, format); + vfprintf_newline(stream, format, ap); + va_end(ap); +} - /* 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; +void fprintf_line(FILE *stream, char *line_chars, int line_length) +{ + int i; + + for (i = 0; i < line_length; i++) + fprintf_nonewline(stream, "%s", line_chars); + + fprintf_newline(stream, ""); +} + +void printf_line(char *line_chars, int line_length) +{ + fprintf_line(stdout, line_chars, line_length); +} + +void printf_line_with_prefix(char *prefix, char *line_chars, int line_length) +{ + fprintf(stdout, "%s", prefix); + fprintf_line(stdout, line_chars, line_length); +} + + +/* ------------------------------------------------------------------------- */ +/* string functions */ +/* ------------------------------------------------------------------------- */ + +/* 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 *int2str(int number, int size) +{ + static char shift_array[10][40]; + static int shift_counter = 0; + char *s = shift_array[shift_counter]; + + shift_counter = (shift_counter + 1) % 10; - counter_ms = (current_time.tv_sec - base_time.tv_sec) * 1000 - + (current_time.tv_usec - base_time.tv_usec) / 1000; + if (size > 20) + size = 20; + + if (size > 0) + { + sprintf(s, " %09d", number); + return &s[strlen(s) - size]; + } + else + { + sprintf(s, "%d", number); + return 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) +{ + static char *a = NULL; + + checked_free(a); + + if (i > 2147483647) /* yes, this is a kludge */ + i = 2147483647; + + a = checked_malloc(10 + 1); + + sprintf(a, "%d", i); + + return a; +} + + +/* calculate base-2 logarithm of argument (rounded down to integer; + this function returns the number of the highest bit set in argument) */ + +int log_2(unsigned int x) +{ + int e = 0; + + while ((1 << e) < x) + { + x -= (1 << e); /* for rounding down (rounding up: remove this line) */ + e++; + } + + return e; +} - return counter_ms; /* return milliseconds since last init */ +boolean getTokenValueFromString(char *string, char **token, char **value) +{ + return getTokenValueFromSetupLine(string, token, value); +} + + +/* ------------------------------------------------------------------------- */ +/* counter functions */ +/* ------------------------------------------------------------------------- */ + +/* maximal allowed length of a command line option */ +#define MAX_OPTION_LEN 256 + +static unsigned int getCurrentMS() +{ + return SDL_GetTicks(); +} + +static unsigned int mainCounter(int mode) +{ + static unsigned int base_ms = 0; + unsigned int current_ms; + + /* get current system milliseconds */ + current_ms = getCurrentMS(); + + /* reset base timestamp in case of counter reset or wrap-around */ + if (mode == INIT_COUNTER || current_ms < base_ms) + base_ms = current_ms; + + /* return milliseconds since last counter reset */ + return current_ms - base_ms; } -#endif /* PLATFORM_UNIX */ -#endif /* !TARGET_SDL */ void InitCounter() /* set counter back to zero */ { -#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 } -unsigned long Counter() /* get milliseconds since last call of InitCounter() */ +unsigned int Counter() /* get milliseconds since last call of InitCounter() */ { -#if !defined(PLATFORM_MSDOS) return mainCounter(READ_COUNTER); -#else - return (counter * 10); -#endif } -static void sleep_milliseconds(unsigned long milliseconds_delay) +static void sleep_milliseconds(unsigned int milliseconds_delay) { boolean do_busy_waiting = (milliseconds_delay < 5 ? TRUE : FALSE); -#if defined(PLATFORM_MSDOS) - /* don't use select() to perform waiting operations under DOS/Windows - environment; always use a busy loop for waiting instead */ - do_busy_waiting = TRUE; -#endif - if (do_busy_waiting) { /* we want to wait only a few ms -- if we assume that we have a @@ -124,7 +266,7 @@ static void sleep_milliseconds(unsigned long milliseconds_delay) therefore it's better to do a short interval of busy waiting to get our sleeping time more accurate */ - unsigned long base_counter = Counter(), actual_counter = Counter(); + unsigned int base_counter = Counter(), actual_counter = Counter(); while (actual_counter < base_counter + milliseconds_delay && actual_counter >= base_counter) @@ -132,61 +274,53 @@ static void sleep_milliseconds(unsigned long milliseconds_delay) } else { -#if defined(TARGET_SDL) SDL_Delay(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 } } -void Delay(unsigned long delay) /* Sleep specified number of milliseconds */ +void Delay(unsigned int delay) /* Sleep specified number of milliseconds */ { sleep_milliseconds(delay); } -boolean FrameReached(unsigned long *frame_counter_var, - unsigned long frame_delay) +boolean FrameReached(unsigned int *frame_counter_var, + unsigned int frame_delay) { - unsigned long actual_frame_counter = FrameCounter; + unsigned int actual_frame_counter = FrameCounter; - if (actual_frame_counter < *frame_counter_var+frame_delay && - actual_frame_counter >= *frame_counter_var) - return(FALSE); + if (actual_frame_counter >= *frame_counter_var && + actual_frame_counter < *frame_counter_var + frame_delay) + return FALSE; *frame_counter_var = actual_frame_counter; - return(TRUE); + + return TRUE; } -boolean DelayReached(unsigned long *counter_var, - unsigned long delay) +boolean DelayReached(unsigned int *counter_var, + unsigned int delay) { - unsigned long actual_counter = Counter(); + unsigned int actual_counter = Counter(); - if (actual_counter < *counter_var + delay && - actual_counter >= *counter_var) - return(FALSE); + if (actual_counter >= *counter_var && + actual_counter < *counter_var + delay) + return FALSE; *counter_var = actual_counter; - return(TRUE); + + return TRUE; } -void WaitUntilDelayReached(unsigned long *counter_var, unsigned long delay) +void WaitUntilDelayReached(unsigned int *counter_var, unsigned int delay) { - unsigned long actual_counter; + unsigned int actual_counter; - while(1) + while (1) { actual_counter = Counter(); - if (actual_counter < *counter_var + delay && - actual_counter >= *counter_var) + if (actual_counter >= *counter_var && + actual_counter < *counter_var + delay) sleep_milliseconds((*counter_var + delay - actual_counter) / 2); else break; @@ -195,243 +329,447 @@ void WaitUntilDelayReached(unsigned long *counter_var, unsigned long delay) *counter_var = actual_counter; } -/* 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 *int2str(int number, int size) -{ - static char shift_array[10][40]; - static int shift_counter = 0; - char *s = shift_array[shift_counter]; - - shift_counter = (shift_counter + 1) % 10; - if (size > 20) - size = 20; +/* ------------------------------------------------------------------------- */ +/* random generator functions */ +/* ------------------------------------------------------------------------- */ - if (size) - { - sprintf(s, " %09d", number); - return &s[strlen(s) - size]; - } - else +unsigned int init_random_number(int nr, int seed) +{ + if (seed == NEW_RANDOMIZE) { - sprintf(s, "%d", number); - return s; - } -} + /* default random seed */ + seed = (int)time(NULL); // seconds since the epoch -unsigned int SimpleRND(unsigned int max) -{ -#if defined(TARGET_SDL) - static unsigned long root = 654321; - unsigned long current_ms; +#if !defined(PLATFORM_WIN32) + /* add some more randomness */ + struct timeval current_time; - current_ms = SDL_GetTicks(); - root = root * 4253261 + current_ms; - return (root % max); -#else - static unsigned long root = 654321; - struct timeval current_time; + gettimeofday(¤t_time, NULL); - gettimeofday(¤t_time, NULL); - root = root * 4253261 + current_time.tv_sec + current_time.tv_usec; - return (root % max); + seed += (int)current_time.tv_usec; // microseconds since the epoch #endif -} -#ifdef DEBUG -static unsigned int last_RND_value = 0; + /* add some more randomness */ + seed += (int)SDL_GetTicks(); // milliseconds since SDL init -unsigned int last_RND() -{ - return last_RND_value; + /* add some more randomness */ + seed += GetSimpleRandom(1000000); + } + + srandom_linux_libc(nr, (unsigned int) seed); + + return (unsigned int) seed; } -#endif -unsigned int RND(unsigned int max) +unsigned int get_random_number(int nr, int max) { -#ifdef DEBUG - return (last_RND_value = random_linux_libc() % max); -#else - return (random_linux_libc() % max); -#endif + return (max > 0 ? random_linux_libc(nr) % max : 0); } -unsigned int InitRND(long seed) + +/* ------------------------------------------------------------------------- */ +/* system info functions */ +/* ------------------------------------------------------------------------- */ + +#if !defined(PLATFORM_ANDROID) +static char *get_corrected_real_name(char *real_name) { -#if defined(TARGET_SDL) - unsigned long current_ms; + char *real_name_new = checked_malloc(MAX_USERNAME_LEN + 1); + char *from_ptr = real_name; + char *to_ptr = real_name_new; - if (seed == NEW_RANDOMIZE) - { - current_ms = SDL_GetTicks(); - srandom_linux_libc((unsigned int) current_ms); - return (unsigned int) current_ms; - } - else + /* 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) { - srandom_linux_libc((unsigned int) seed); - return (unsigned int) seed; - } -#else - struct timeval current_time; + /* 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 (seed == NEW_RANDOMIZE) - { - gettimeofday(¤t_time, NULL); - srandom_linux_libc((unsigned int) current_time.tv_usec); - return (unsigned int) current_time.tv_usec; - } - else - { - srandom_linux_libc((unsigned int) seed); - return (unsigned int) seed; + /* 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++; } -#endif -} -char *getLoginName() -{ -#if defined(PLATFORM_WIN32) - return ANONYMOUS_NAME; -#else - struct passwd *pwd; + *to_ptr = '\0'; - if ((pwd = getpwuid(getuid())) == NULL) - return ANONYMOUS_NAME; - else - return pwd->pw_name; -#endif + return real_name_new; } +#endif -char *getRealName() +char *getLoginName() { -#if defined(PLATFORM_UNIX) - struct passwd *pwd; + static char *login_name = NULL; - if ((pwd = getpwuid(getuid())) == NULL || strlen(pwd->pw_gecos) == 0) - return ANONYMOUS_NAME; - else +#if defined(PLATFORM_WIN32) + if (login_name == NULL) { - static char real_name[1024]; - char *from_ptr = pwd->pw_gecos, *to_ptr = real_name; + unsigned long buffer_size = MAX_USERNAME_LEN + 1; + login_name = checked_malloc(buffer_size); - if (strchr(pwd->pw_gecos, 'ß') == NULL) - return pwd->pw_gecos; - - /* the user's real name contains a 'ß' character (german sharp s), - which has no equivalent in upper case letters (which our fonts use) */ - while (*from_ptr != '\0' && (long)(to_ptr - real_name) < 1024 - 2) - { - if (*from_ptr != 'ß') - *to_ptr++ = *from_ptr++; - else - { - from_ptr++; - *to_ptr++ = 's'; - *to_ptr++ = 's'; - } - } - *to_ptr = '\0'; + if (GetUserName(login_name, &buffer_size) == 0) + strcpy(login_name, ANONYMOUS_NAME); + } +#else + if (login_name == NULL) + { + struct passwd *pwd; - return real_name; + if ((pwd = getpwuid(getuid())) == NULL) + login_name = ANONYMOUS_NAME; + else + login_name = getStringCopy(pwd->pw_name); } -#else /* !PLATFORM_UNIX */ - return ANONYMOUS_NAME; #endif + + return login_name; } -char *getHomeDir() +char *getRealName() { -#if defined(PLATFORM_UNIX) - static char *home_dir = NULL; + static char *real_name = NULL; - if (!home_dir) +#if defined(PLATFORM_WIN32) + if (real_name == NULL) { - if (!(home_dir = getenv("HOME"))) - { - struct passwd *pwd; + static char buffer[MAX_USERNAME_LEN + 1]; + unsigned long buffer_size = MAX_USERNAME_LEN + 1; - if ((pwd = getpwuid(getuid()))) - home_dir = pwd->pw_dir; - else - home_dir = "."; - } + 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) + { + struct passwd *pwd; - return home_dir; + if ((pwd = getpwuid(getuid())) != NULL && strlen(pwd->pw_gecos) != 0) + real_name = get_corrected_real_name(pwd->pw_gecos); + else + real_name = ANONYMOUS_NAME; + } #else - return "."; + real_name = ANONYMOUS_NAME; #endif + + return real_name; } -char *getPath2(char *path1, char *path2) +time_t getFileTimestampEpochSeconds(char *filename) { - char *complete_path = checked_malloc(strlen(path1) + 1 + - strlen(path2) + 1); + struct stat file_status; - sprintf(complete_path, "%s/%s", path1, path2); - return complete_path; + if (stat(filename, &file_status) != 0) /* cannot stat file */ + return 0; + + return file_status.st_mtime; } -char *getPath3(char *path1, char *path2, char *path3) + +/* ------------------------------------------------------------------------- */ +/* path manipulation functions */ +/* ------------------------------------------------------------------------- */ + +static char *getLastPathSeparatorPtr(char *filename) { - char *complete_path = checked_malloc(strlen(path1) + 1 + - strlen(path2) + 1 + - strlen(path3) + 1); + char *last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_UNIX); - sprintf(complete_path, "%s/%s/%s", path1, path2, path3); - return complete_path; + if (last_separator == NULL) /* also try DOS/Windows variant */ + last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_DOS); + + return last_separator; } -char *getStringCopy(char *s) +char *getBaseNamePtr(char *filename) { - char *s_copy; - - if (s == NULL) - return NULL; + char *last_separator = getLastPathSeparatorPtr(filename); - s_copy = checked_malloc(strlen(s) + 1); + if (last_separator != NULL) + return last_separator + 1; /* separator found: strip base path */ + else + return filename; /* no separator found: filename has no path */ +} - strcpy(s_copy, s); - return s_copy; +char *getBaseName(char *filename) +{ + return getStringCopy(getBaseNamePtr(filename)); } -char *getStringToLower(char *s) +char *getBasePath(char *filename) { - char *s_copy = checked_malloc(strlen(s) + 1); - char *s_ptr = s_copy; + char *basepath = getStringCopy(filename); + char *last_separator = getLastPathSeparatorPtr(basepath); - while (*s) - *s_ptr++ = tolower(*s++); - *s_ptr = '\0'; + if (last_separator != NULL) + *last_separator = '\0'; /* separator found: strip basename */ + else + basepath = "."; /* no separator found: use current path */ - return s_copy; + return basepath; } -void GetOptions(char *argv[]) +static char *getProgramMainDataPath() { - char **options_left = &argv[1]; + char *main_data_path = getStringCopy(program.command_basepath); - /* initialize global program options */ +#if defined(PLATFORM_MACOSX) + static char *main_data_binary_subdir = NULL; + + if (main_data_binary_subdir == NULL) + { + main_data_binary_subdir = checked_malloc(strlen(program.program_title) + 1 + + strlen("app") + 1 + + strlen(MAC_APP_BINARY_SUBDIR) + 1); + + sprintf(main_data_binary_subdir, "%s.app/%s", + program.program_title, MAC_APP_BINARY_SUBDIR); + } + + // cut relative path to Mac OS X application binary directory from path + if (strSuffix(main_data_path, main_data_binary_subdir)) + main_data_path[strlen(main_data_path) - + strlen(main_data_binary_subdir)] = '\0'; + + // cut trailing path separator from path (but not if path is root directory) + if (strSuffix(main_data_path, "/") && !strEqual(main_data_path, "/")) + main_data_path[strlen(main_data_path) - 1] = '\0'; +#endif + + return main_data_path; +} + + +/* ------------------------------------------------------------------------- */ +/* various string functions */ +/* ------------------------------------------------------------------------- */ + +char *getStringCat2WithSeparator(char *s1, char *s2, char *sep) +{ + 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) +{ + 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 APK assets directory -- skip leading "./" + if (strEqual(path1, ".")) + return getStringCopy(path2); +#endif + + return getStringCat2WithSeparator(path1, path2, STRING_PATH_SEPARATOR); +} + +char *getPath3(char *path1, char *path2, char *path3) +{ +#if defined(PLATFORM_ANDROID) + // workaround for reading from APK assets directory -- skip leading "./" + if (strEqual(path1, ".")) + return getStringCat2WithSeparator(path2, path3, STRING_PATH_SEPARATOR); +#endif + + return getStringCat3WithSeparator(path1, path2, path3, STRING_PATH_SEPARATOR); +} + +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 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 : + strncmp(&s[strlen(s) - strlen(suffix)], suffix, strlen(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(char *argv[], + void (*print_usage_function)(void), + void (*print_version_function)(void)) +{ + char *ro_base_path = RO_BASE_PATH; + char *rw_base_path = RW_BASE_PATH; + char **options_left = &argv[1]; + + /* if the program is configured to start from current directory (default), + determine program package directory from program binary (some versions + of KDE/Konqueror and Mac OS X (especially "Mavericks") apparently do not + set the current working directory to the program package directory) */ + + if (strEqual(ro_base_path, ".")) + ro_base_path = getProgramMainDataPath(); + if (strEqual(rw_base_path, ".")) + rw_base_path = getProgramMainDataPath(); + + /* 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 = RO_BASE_PATH "/" LEVELS_DIRECTORY; - options.graphics_directory = RO_BASE_PATH "/" GRAPHICS_DIRECTORY; - options.sounds_directory = RO_BASE_PATH "/" SOUNDS_DIRECTORY; - options.music_directory = RO_BASE_PATH "/" MUSIC_DIRECTORY; + + options.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.special_flags = NULL; + options.serveronly = FALSE; options.network = FALSE; options.verbose = FALSE; options.debug = FALSE; + options.debug_x11_sync = 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 while (*options_left) { @@ -447,10 +785,10 @@ void GetOptions(char *argv[]) strcpy(option_str, option); /* copy argument into buffer */ option = option_str; - if (strcmp(option, "--") == 0) /* stop scanning arguments */ + if (strEqual(option, "--")) /* stop scanning arguments */ break; - if (strncmp(option, "--", 2) == 0) /* treat '--' like '-' */ + if (strPrefix(option, "--")) /* treat '--' like '-' */ option++; option_arg = strchr(option, '='); @@ -465,23 +803,14 @@ void GetOptions(char *argv[]) option_len = strlen(option); - if (strcmp(option, "-") == 0) + if (strEqual(option, "-")) + { Error(ERR_EXIT_HELP, "unrecognized option '%s'", option); + } else if (strncmp(option, "-help", option_len) == 0) { - printf("Usage: %s [options] [server.name [port]]\n" - "Options:\n" - " -d, --display [:] X server display\n" - " -b, --basepath alternative base directory\n" - " -l, --level alternative level directory\n" - " -g, --graphics alternative graphics directory\n" - " -s, --sounds alternative graphics directory\n" - " -m, --music alternative graphics directory\n" - " -n, --network network multiplayer game\n" - " --serveronly only start network server\n" - " -v, --verbose verbose mode\n" - " --debug display debugging information\n", - program.command_basename); + print_usage_function(); + exit(0); } else if (strncmp(option, "-display", option_len) == 0) @@ -499,14 +828,17 @@ void GetOptions(char *argv[]) Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str); /* this should be extended to separate options for ro and rw data */ - options.ro_base_directory = option_arg; - options.rw_base_directory = option_arg; + 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 path for level directory accordingly */ - options.level_directory = - getPath2(options.ro_base_directory, LEVELS_DIRECTORY); + /* 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) { @@ -552,13 +884,40 @@ void GetOptions(char *argv[]) { options.serveronly = TRUE; } + else if (strncmp(option, "-debug", option_len) == 0) + { + options.debug = TRUE; + } + else if (strncmp(option, "-debug-x11-sync", option_len) == 0) + { + options.debug_x11_sync = TRUE; + } else if (strncmp(option, "-verbose", option_len) == 0) { options.verbose = TRUE; } - else if (strncmp(option, "-debug", option_len) == 0) + else if (strncmp(option, "-version", option_len) == 0 || + strncmp(option, "-V", option_len) == 0) { - options.debug = TRUE; + 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) + Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str); + + options.execute_command = option_arg; + if (option_arg == next_option) + options_left++; + + /* when doing batch processing, always enable verbose mode (warnings) */ + options.verbose = TRUE; } else if (*option == '-') { @@ -581,25 +940,58 @@ void GetOptions(char *argv[]) } } + +/* ------------------------------------------------------------------------- */ +/* error handling functions */ +/* ------------------------------------------------------------------------- */ + +#define MAX_INTERNAL_ERROR_SIZE 1024 + +/* used by SetError() and GetError() to store internal error messages */ +static char internal_error[MAX_INTERNAL_ERROR_SIZE]; + +void SetError(char *format, ...) +{ + va_list ap; + + va_start(ap, format); + vsnprintf(internal_error, MAX_INTERNAL_ERROR_SIZE, format, ap); + va_end(ap); +} + +char *GetError() +{ + return internal_error; +} + void Error(int mode, char *format, ...) { + static boolean last_line_was_separator = FALSE; char *process_name = ""; - FILE *error = stderr; - char *newline = "\n"; + +#if defined(PLATFORM_ANDROID) + android_log_prio = (mode & ERR_DEBUG ? ANDROID_LOG_DEBUG : + mode & ERR_INFO ? ANDROID_LOG_INFO : + mode & ERR_WARN ? ANDROID_LOG_WARN : + mode & ERR_EXIT ? ANDROID_LOG_FATAL : + ANDROID_LOG_UNKNOWN); +#endif /* display warnings only when running in verbose mode */ if (mode & ERR_WARN && !options.verbose) return; -#if !defined(PLATFORM_UNIX) - newline = "\r\n"; - - if ((error = openErrorFile()) == NULL) + if (mode == ERR_INFO_LINE) { - printf("Cannot write to error output file!%s", newline); - program.exit_function(1); + if (!last_line_was_separator) + fprintf_line(program.error_file, format, 79); + + last_line_was_separator = TRUE; + + return; } -#endif + + last_line_was_separator = FALSE; if (mode & ERR_SOUND_SERVER) process_name = " sound server"; @@ -612,28 +1004,32 @@ void Error(int mode, char *format, ...) { va_list ap; - fprintf(error, "%s%s: ", program.command_basename, process_name); + fprintf_nonewline(program.error_file, "%s%s: ", program.command_basename, + process_name); if (mode & ERR_WARN) - fprintf(error, "warning: "); + fprintf_nonewline(program.error_file, "warning: "); va_start(ap, format); - vfprintf(error, format, ap); + vfprintf_newline(program.error_file, format, ap); va_end(ap); - - fprintf(error, "%s", newline); + + if ((mode & ERR_EXIT) && !(mode & ERR_FROM_SERVER)) + { + va_start(ap, format); + program.exit_message_function(format, ap); + va_end(ap); + } } if (mode & ERR_HELP) - fprintf(error, "%s: Try option '--help' for more information.%s", - program.command_basename, newline); + fprintf_newline(program.error_file, + "%s: Try option '--help' for more information.", + program.command_basename); if (mode & ERR_EXIT) - fprintf(error, "%s%s: aborting%s", - program.command_basename, process_name, newline); - - if (error != stderr) - fclose(error); + fprintf_newline(program.error_file, "%s%s: aborting", + program.command_basename, process_name); if (mode & ERR_EXIT) { @@ -644,7 +1040,12 @@ void Error(int mode, char *format, ...) } } -void *checked_malloc(unsigned long size) + +/* ------------------------------------------------------------------------- */ +/* checked memory allocation and freeing functions */ +/* ------------------------------------------------------------------------- */ + +void *checked_malloc(unsigned int size) { void *ptr; @@ -656,7 +1057,7 @@ void *checked_malloc(unsigned long size) return ptr; } -void *checked_calloc(unsigned long size) +void *checked_calloc(unsigned int size) { void *ptr; @@ -668,7 +1069,7 @@ void *checked_calloc(unsigned long size) return ptr; } -void *checked_realloc(void *ptr, unsigned long size) +void *checked_realloc(void *ptr, unsigned int size) { ptr = realloc(ptr, size); @@ -678,69 +1079,143 @@ void *checked_realloc(void *ptr, unsigned long size) return ptr; } -short getFile16BitInteger(FILE *file, int byte_order) +void checked_free(void *ptr) { - 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)); + 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 */ +/* ------------------------------------------------------------------------- */ + +inline void swap_numbers(int *i1, int *i2) +{ + int help = *i1; + + *i1 = *i2; + *i2 = help; +} + +inline 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; } -void putFile16BitInteger(FILE *file, short value, int byte_order) +int getFile16BitInteger(File *file, int byte_order) { if (byte_order == BYTE_ORDER_BIG_ENDIAN) - { - fputc((value >> 8) & 0xff, file); - fputc((value >> 0) & 0xff, file); - } + 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) { - fputc((value >> 0) & 0xff, file); - fputc((value >> 8) & 0xff, file); + 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) +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)); + return ((getByteFromFile(file) << 24) | + (getByteFromFile(file) << 16) | + (getByteFromFile(file) << 8) | + (getByteFromFile(file) << 0)); else /* BYTE_ORDER_LITTLE_ENDIAN */ - return ((fgetc(file) << 0) | - (fgetc(file) << 8) | - (fgetc(file) << 16) | - (fgetc(file) << 24)); + return ((getByteFromFile(file) << 0) | + (getByteFromFile(file) << 8) | + (getByteFromFile(file) << 16) | + (getByteFromFile(file) << 24)); } -void putFile32BitInteger(FILE *file, int value, int byte_order) +int putFile32BitInteger(FILE *file, int value, int byte_order) { - 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 */ + if (file != NULL) { - fputc((value >> 0) & 0xff, file); - fputc((value >> 8) & 0xff, file); - fputc((value >> 16) & 0xff, file); - fputc((value >> 24) & 0xff, file); + 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, +boolean getFileChunk(File *file, char *chunk_name, int *chunk_size, int byte_order) { const int chunk_name_length = 4; /* read chunk name */ - fgets(chunk_name, chunk_name_length + 1, file); + if (getStringFromFile(file, chunk_name, chunk_name_length + 1) == NULL) + return FALSE; if (chunk_size != NULL) { @@ -748,41 +1223,102 @@ boolean getFileChunk(FILE *file, char *chunk_name, int *chunk_size, *chunk_size = getFile32BitInteger(file, byte_order); } - return (feof(file) || ferror(file) ? FALSE : TRUE); + return (checkEndOfFile(file) ? FALSE : TRUE); } -void putFileChunk(FILE *file, char *chunk_name, int chunk_size, - int byte_order) +int putFileChunk(FILE *file, char *chunk_name, int chunk_size, + int byte_order) { + int num_bytes = 0; + /* write chunk name */ - fputs(chunk_name, file); + if (file != NULL) + fputs(chunk_name, file); + + num_bytes += strlen(chunk_name); if (chunk_size >= 0) { /* write chunk size */ - putFile32BitInteger(file, chunk_size, byte_order); + if (file != NULL) + putFile32BitInteger(file, chunk_size, byte_order); + + num_bytes += 4; } -} -void ReadUnusedBytesFromFile(FILE *file, unsigned long bytes) -{ - while (bytes--) - fgetc(file); + return num_bytes; } -void WriteUnusedBytesToFile(FILE *file, unsigned long bytes) +int getFileVersion(File *file) { - while (bytes--) - fputc(0, file); -} + int version_major = getByteFromFile(file); + int version_minor = getByteFromFile(file); + int version_patch = getByteFromFile(file); + int version_build = getByteFromFile(file); -#define TRANSLATE_KEYSYM_TO_KEYNAME 0 -#define TRANSLATE_KEYSYM_TO_X11KEYNAME 1 -#define TRANSLATE_X11KEYNAME_TO_KEYSYM 2 + return VERSION_IDENT(version_major, version_minor, version_patch, + version_build); +} -void translate_keyname(Key *keysym, char **x11name, char **name, int mode) +int putFileVersion(FILE *file, int version) { - static struct + 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); + + fputc(version_major, file); + fputc(version_minor, file); + fputc(version_patch, file); + fputc(version_build, 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 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 + +void translate_keyname(Key *keysym, char **x11name, char **name, int mode) +{ + static struct { Key key; char *x11name; @@ -822,8 +1358,10 @@ void translate_keyname(Key *keysym, char **x11name, char **name, int mode) { KSYM_Meta_R, "XK_Meta_R", "right meta" }, { KSYM_Alt_L, "XK_Alt_L", "left alt" }, { KSYM_Alt_R, "XK_Alt_R", "right alt" }, +#if !defined(TARGET_SDL2) { KSYM_Super_L, "XK_Super_L", "left super" }, /* Win-L */ { KSYM_Super_R, "XK_Super_R", "right super" }, /* Win-R */ +#endif { KSYM_Mode_switch, "XK_Mode_switch", "mode switch" }, /* Alt-R */ { KSYM_Multi_key, "XK_Multi_key", "multi key" }, /* Ctrl-R */ @@ -836,7 +1374,11 @@ void translate_keyname(Key *keysym, char **x11name, char **name, int mode) { 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 defined(TARGET_SDL2) + { KSYM_Menu, "XK_Menu", "menu" }, /* menu key */ + { KSYM_Back, "XK_Back", "back" }, /* back key */ +#endif /* ASCII 0x20 to 0x40 keys (except numbers) */ { KSYM_space, "XK_space", "space" }, @@ -865,18 +1407,19 @@ void translate_keyname(Key *keysym, char **x11name, char **name, int mode) /* more ASCII keys */ { KSYM_bracketleft, "XK_bracketleft", "[" }, - { KSYM_backslash, "XK_backslash", "backslash" }, + { KSYM_backslash, "XK_backslash", "\\" }, { KSYM_bracketright,"XK_bracketright", "]" }, - { KSYM_asciicircum, "XK_asciicircum", "circumflex" }, + { 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", "ascii tilde" }, + { KSYM_asciitilde, "XK_asciitilde", "~" }, - /* special (non-ASCII) keys */ + /* special (non-ASCII) keys (ISO-Latin-1) */ + { KSYM_degree, "XK_degree", "°" }, { KSYM_Adiaeresis, "XK_Adiaeresis", "Ä" }, { KSYM_Odiaeresis, "XK_Odiaeresis", "Ö" }, { KSYM_Udiaeresis, "XK_Udiaeresis", "Ü" }, @@ -885,6 +1428,35 @@ void translate_keyname(Key *keysym, char **x11name, char **name, int mode) { KSYM_udiaeresis, "XK_udiaeresis", "ü" }, { KSYM_ssharp, "XK_ssharp", "sharp s" }, +#if defined(TARGET_SDL2) + /* 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", " " }, +#endif + +#if defined(TARGET_SDL2) + /* 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" }, +#endif + /* end-of-array identifier */ { 0, NULL, NULL } }; @@ -902,10 +1474,12 @@ void translate_keyname(Key *keysym, char **x11name, char **name, int mode) 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)); +#if !defined(TARGET_SDL2) else if (key >= KSYM_KP_0 && key <= KSYM_KP_9) sprintf(name_buffer, "keypad %c", '0' + (char)(key - KSYM_KP_0)); - else if (key >= KSYM_F1 && key <= KSYM_F24) - sprintf(name_buffer, "function F%d", (int)(key - KSYM_F1 + 1)); +#endif + 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 @@ -939,10 +1513,12 @@ void translate_keyname(Key *keysym, char **x11name, char **name, int mode) 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)); +#if !defined(TARGET_SDL2) 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_F1 && key <= KSYM_F24) - sprintf(name_buffer, "XK_F%d", (int)(key - KSYM_F1 + 1)); +#endif + 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 @@ -960,17 +1536,54 @@ void translate_keyname(Key *keysym, char **x11name, char **name, int mode) while (translate_key[++i].x11name); if (!translate_key[i].x11name) - sprintf(name_buffer, "0x%04lx", (unsigned long)key); + 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) + Error(ERR_WARN, "getKeyFromKeyName(): not completely implemented"); + + *keysym = key; + } else if (mode == TRANSLATE_X11KEYNAME_TO_KEYSYM) { Key key = KSYM_UNDEFINED; char *name_ptr = *x11name; - if (strncmp(name_ptr, "XK_", 3) == 0 && strlen(name_ptr) == 4) + if (strPrefix(name_ptr, "XK_") && strlen(name_ptr) == 4) { char c = name_ptr[3]; @@ -981,14 +1594,16 @@ void translate_keyname(Key *keysym, char **x11name, char **name, int mode) 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) +#if !defined(TARGET_SDL2) + else if (strPrefix(name_ptr, "XK_KP_") && strlen(name_ptr) == 7) { char c = name_ptr[6]; if (c >= '0' && c <= '9') - key = KSYM_0 + (Key)(c - '0'); + key = KSYM_KP_0 + (Key)(c - '0'); } - else if (strncmp(name_ptr, "XK_F", 4) == 0 && strlen(name_ptr) <= 6) +#endif + else if (strPrefix(name_ptr, "XK_F") && strlen(name_ptr) <= 6) { char c1 = name_ptr[4]; char c2 = name_ptr[5]; @@ -998,16 +1613,16 @@ void translate_keyname(Key *keysym, char **x11name, char **name, int mode) ((c2 >= '0' && c1 <= '9') || c2 == '\0')) d = atoi(&name_ptr[4]); - if (d >=1 && d <= 24) + if (d >= 1 && d <= KSYM_NUM_FKEYS) key = KSYM_F1 + (Key)(d - 1); } - else if (strncmp(name_ptr, "XK_", 3) == 0) + else if (strPrefix(name_ptr, "XK_")) { i = 0; do { - if (strcmp(name_ptr, translate_key[i].x11name) == 0) + if (strEqual(name_ptr, translate_key[i].x11name)) { key = translate_key[i].key; break; @@ -1015,9 +1630,9 @@ void translate_keyname(Key *keysym, char **x11name, char **name, int mode) } while (translate_key[++i].x11name); } - else if (strncmp(name_ptr, "0x", 2) == 0) + else if (strPrefix(name_ptr, "0x")) { - unsigned long value = 0; + unsigned int value = 0; name_ptr += 2; @@ -1066,6 +1681,14 @@ char *getX11KeyNameFromKey(Key key) 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; @@ -1077,732 +1700,1851 @@ Key getKeyFromX11KeyName(char *x11name) char getCharFromKey(Key key) { char *keyname = getKeyNameFromKey(key); - char letter = 0; + char c = 0; if (strlen(keyname) == 1) - letter = keyname[0]; - else if (strcmp(keyname, "space") == 0) - letter = ' '; - else if (strcmp(keyname, "circumflex") == 0) - letter = '^'; + c = keyname[0]; + else if (strEqual(keyname, "space")) + c = ' '; + + 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] = + { + { "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; - return letter; + 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) + { + 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); + } + + free(s_lower); + + return result; +} + +boolean get_boolean_from_string(char *s) +{ + char *s_lower = getStringToLower(s); + boolean result = FALSE; + + if (strEqual(s_lower, "true") || + strEqual(s_lower, "yes") || + strEqual(s_lower, "on") || + get_integer_from_string(s) == 1) + result = TRUE; + + free(s_lower); + + return result; +} + +int get_switch3_from_string(char *s) +{ + char *s_lower = getStringToLower(s); + int result = FALSE; + + 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; } + /* ------------------------------------------------------------------------- */ -/* some functions to handle lists of level directories */ +/* functions for generic lists */ /* ------------------------------------------------------------------------- */ -struct LevelDirInfo *newLevelDirInfo() +ListNode *newListNode() { - return checked_calloc(sizeof(struct LevelDirInfo)); + return checked_calloc(sizeof(ListNode)); } -void pushLevelDirInfo(struct LevelDirInfo **node_first, - struct LevelDirInfo *node_new) +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; *node_first = node_new; } -int numLevelDirInfo(struct LevelDirInfo *node) +void deleteNodeFromList(ListNode **node_first, char *key, + void (*destructor_function)(void *)) { - int num = 0; + if (node_first == NULL || *node_first == NULL) + return; - while (node) + if (strEqual((*node_first)->key, key)) { - num++; - node = node->next; + checked_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); +} + +ListNode *getNodeFromKey(ListNode *node_first, char *key) +{ + if (node_first == NULL) + return NULL; - return num; + if (strEqual(node_first->key, key)) + return node_first; + else + return getNodeFromKey(node_first->next, key); } -boolean validLevelSeries(struct LevelDirInfo *node) +int getNumNodes(ListNode *node_first) { - return (node != NULL && !node->node_group && !node->parent_link); + return (node_first ? 1 + getNumNodes(node_first->next) : 0); } -struct LevelDirInfo *getFirstValidLevelSeries(struct LevelDirInfo *node) +void dumpList(ListNode *node_first) { - if (node == NULL) + ListNode *node = node_first; + + while (node) { - if (leveldir_first) /* start with first level directory entry */ - return getFirstValidLevelSeries(leveldir_first); - else - return NULL; + printf("['%s' (%d)]\n", node->key, + ((struct ListNodeInfo *)node->content)->num_references); + node = node->next; + } + + printf("[%d nodes]\n", getNumNodes(node_first)); +} + + +/* ------------------------------------------------------------------------- */ +/* functions for file handling */ +/* ------------------------------------------------------------------------- */ + +File *openFile(char *filename, char *mode) +{ + File *file = checked_calloc(sizeof(File)); + + file->file = fopen(filename, mode); + + if (file->file != NULL) + { + file->filename = getStringCopy(filename); + + return file; } - else if (node->node_group) /* enter level group (step down into tree) */ - return getFirstValidLevelSeries(node->node_group); - else if (node->parent_link) /* skip start entry of level group */ + +#if defined(PLATFORM_ANDROID) + file->asset_file = SDL_RWFromFile(filename, mode); + + if (file->asset_file != NULL) { - if (node->next) /* get first real level series entry */ - return getFirstValidLevelSeries(node->next); - else /* leave empty level group and go on */ - return getFirstValidLevelSeries(node->node_parent->next); + file->file_is_asset = TRUE; + file->filename = getStringCopy(filename); + + return file; } - else /* this seems to be a regular level series */ - return node; +#endif + + checked_free(file); + + return NULL; } -struct LevelDirInfo *getLevelDirInfoFirstGroupEntry(struct LevelDirInfo *node) +int closeFile(File *file) { - if (node == NULL) - return NULL; + if (file == NULL) + return -1; - if (node->node_parent == NULL) /* top level group */ - return leveldir_first; - else /* sub level group */ - return node->node_parent->node_group; + int result = 0; + +#if defined(PLATFORM_ANDROID) + if (file->asset_file) + result = SDL_RWclose(file->asset_file); +#endif + + if (file->file) + result = fclose(file->file); + + checked_free(file->filename); + checked_free(file); + + return result; } -int numLevelDirInfoInGroup(struct LevelDirInfo *node) +int checkEndOfFile(File *file) { - return numLevelDirInfo(getLevelDirInfoFirstGroupEntry(node)); +#if defined(PLATFORM_ANDROID) + if (file->file_is_asset) + return file->end_of_file; +#endif + + return feof(file->file); } -int posLevelDirInfo(struct LevelDirInfo *node) +size_t readFile(File *file, void *buffer, size_t item_size, size_t num_items) { - struct LevelDirInfo *node_cmp = getLevelDirInfoFirstGroupEntry(node); - int pos = 0; +#if defined(PLATFORM_ANDROID) + if (file->file_is_asset) + { + if (file->end_of_file) + return 0; - while (node_cmp) + 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); +} + +int seekFile(File *file, long offset, int whence) +{ +#if defined(PLATFORM_ANDROID) + if (file->file_is_asset) { - if (node_cmp == node) - return pos; + int sdl_whence = (whence == SEEK_SET ? RW_SEEK_SET : + whence == SEEK_CUR ? RW_SEEK_CUR : + whence == SEEK_END ? RW_SEEK_END : 0); - pos++; - node_cmp = node_cmp->next; + return (SDL_RWseek(file->asset_file, offset, sdl_whence) == -1 ? -1 : 0); } +#endif - return 0; + return fseek(file->file, offset, whence); } -struct LevelDirInfo *getLevelDirInfoFromPos(struct LevelDirInfo *node, int pos) +int getByteFromFile(File *file) { - struct LevelDirInfo *node_default = node; - int pos_cmp = 0; +#if defined(PLATFORM_ANDROID) + if (file->file_is_asset) + { + if (file->end_of_file) + return EOF; - while (node) + 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); +} + +char *getStringFromFile(File *file, char *line, int size) +{ +#if defined(PLATFORM_ANDROID) + if (file->file_is_asset) { - if (pos_cmp == pos) - return node; + if (file->end_of_file) + return NULL; - pos_cmp++; - node = node->next; + 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); +} + + +/* ------------------------------------------------------------------------- */ +/* functions for directory handling */ +/* ------------------------------------------------------------------------- */ + +Directory *openDirectory(char *dir_name) +{ + Directory *dir = checked_calloc(sizeof(Directory)); + + dir->dir = opendir(dir_name); + + if (dir->dir != NULL) + { + dir->filename = getStringCopy(dir_name); + + return dir; + } + +#if defined(PLATFORM_ANDROID) + char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME); + + dir->asset_toc_file = SDL_RWFromFile(asset_toc_filename, MODE_READ); + + checked_free(asset_toc_filename); + + if (dir->asset_toc_file != NULL) + { + dir->directory_is_asset = TRUE; + dir->filename = getStringCopy(dir_name); + + return dir; } +#endif + + checked_free(dir); - return node_default; + return NULL; } -struct LevelDirInfo *getLevelDirInfoFromFilenameExt(struct LevelDirInfo *node, - char *filename) +int closeDirectory(Directory *dir) { - if (filename == NULL) - return NULL; + if (dir == NULL) + return -1; - while (node) + int result = 0; + +#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) { - if (node->node_group) + 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] == '/') { - struct LevelDirInfo *node_group; + 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)); + + dir->dir_entry->basename = getStringCopy(dir_entry->d_name); + dir->dir_entry->filename = getPath2(dir->filename, dir_entry->d_name); + + struct stat file_status; + + dir->dir_entry->is_directory = + (stat(dir->dir_entry->filename, &file_status) == 0 && + (file_status.st_mode & S_IFMT) == S_IFDIR); + + return dir->dir_entry; +} + +void freeDirectoryEntry(DirectoryEntry *dir_entry) +{ + if (dir_entry == NULL) + return; + + checked_free(dir_entry->basename); + checked_free(dir_entry->filename); + checked_free(dir_entry); +} + + +/* ------------------------------------------------------------------------- */ +/* functions for checking files and filenames */ +/* ------------------------------------------------------------------------- */ + +boolean directoryExists(char *dir_name) +{ + if (dir_name == NULL) + return FALSE; + + boolean success = (access(dir_name, F_OK) == 0); + +#if defined(PLATFORM_ANDROID) + if (!success) + { + // 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); + + checked_free(asset_toc_filename); + + success = (file != NULL); + + if (success) + SDL_RWclose(file); + } +#endif + + return success; +} + +boolean fileExists(char *filename) +{ + if (filename == NULL) + return FALSE; + + 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) +{ + static char *basename_lower = NULL; + int basename_length, prefix_length; + + checked_free(basename_lower); + + if (basename == NULL || prefix == NULL) + return FALSE; + + basename_lower = getStringToLower(basename); + basename_length = strlen(basename_lower); + prefix_length = strlen(prefix); + + if (basename_length > prefix_length + 1 && + basename_lower[prefix_length] == '.' && + strncmp(basename_lower, prefix, prefix_length) == 0) + return TRUE; + + return FALSE; +} + +boolean fileHasSuffix(char *basename, char *suffix) +{ + static char *basename_lower = NULL; + int basename_length, suffix_length; + + checked_free(basename_lower); + + if (basename == NULL || suffix == NULL) + return FALSE; + + basename_lower = getStringToLower(basename); + basename_length = strlen(basename_lower); + suffix_length = strlen(suffix); + + if (basename_length > suffix_length + 1 && + basename_lower[basename_length - suffix_length - 1] == '.' && + strEqual(&basename_lower[basename_length - suffix_length], suffix)) + return TRUE; + + return FALSE; +} + +static boolean FileCouldBeArtwork(char *basename) +{ + return (!strEqual(basename, ".") && + !strEqual(basename, "..") && + !fileHasSuffix(basename, "txt") && + !fileHasSuffix(basename, "conf")); +} + +boolean FileIsGraphic(char *filename) +{ + char *basename = getBaseNamePtr(filename); + + return FileCouldBeArtwork(basename); +} + +boolean FileIsSound(char *filename) +{ + char *basename = getBaseNamePtr(filename); + + return FileCouldBeArtwork(basename); +} + +boolean FileIsMusic(char *filename) +{ + char *basename = getBaseNamePtr(filename); + + return FileCouldBeArtwork(basename); +} + +boolean FileIsArtworkType(char *basename, int type) +{ + if ((type == TREE_TYPE_GRAPHICS_DIR && FileIsGraphic(basename)) || + (type == TREE_TYPE_SOUNDS_DIR && FileIsSound(basename)) || + (type == TREE_TYPE_MUSIC_DIR && FileIsMusic(basename))) + return TRUE; + + return FALSE; +} + +/* ------------------------------------------------------------------------- */ +/* functions for loading artwork configuration information */ +/* ------------------------------------------------------------------------- */ + +char *get_mapped_token(char *token) +{ + /* !!! make this dynamically configurable (init.c:InitArtworkConfig) !!! */ + static char *map_token_prefix[][2] = + { + { "char_procent", "char_percent" }, + { NULL, } + }; + int i; + + for (i = 0; map_token_prefix[i][0] != NULL; i++) + { + int len_token_prefix = strlen(map_token_prefix[i][0]); + + if (strncmp(token, map_token_prefix[i][0], len_token_prefix) == 0) + 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) + { + 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 */ + + 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, ".align")) + { + result = (strEqual(value, "left") ? ALIGN_LEFT : + strEqual(value, "right") ? ALIGN_RIGHT : + strEqual(value, "center") ? ALIGN_CENTER : + strEqual(value, "middle") ? ALIGN_CENTER : ALIGN_DEFAULT); + } + else if (strEqual(suffix, ".valign")) + { + result = (strEqual(value, "top") ? VALIGN_TOP : + strEqual(value, "bottom") ? VALIGN_BOTTOM : + strEqual(value, "middle") ? VALIGN_MIDDLE : + strEqual(value, "center") ? VALIGN_MIDDLE : VALIGN_DEFAULT); + } + 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 : + string_has_parameter(value, "centered") ? ANIM_CENTERED : + ANIM_DEFAULT); + + if (string_has_parameter(value, "reverse")) + result |= ANIM_REVERSE; + + if (string_has_parameter(value, "opaque_player")) + result |= ANIM_OPAQUE_PLAYER; + + if (string_has_parameter(value, "static_panel")) + result |= ANIM_STATIC_PANEL; + } + else if (strEqual(suffix, ".class")) + { + result = get_hash_from_key(value); + } + else if (strEqual(suffix, ".style")) + { + result = STYLE_DEFAULT; + + if (string_has_parameter(value, "accurate_borders")) + result |= STYLE_ACCURATE_BORDERS; + + if (string_has_parameter(value, "inner_corners")) + result |= STYLE_INNER_CORNERS; + } + else if (strEqual(suffix, ".fade_mode")) + { + result = (string_has_parameter(value, "none") ? FADE_MODE_NONE : + string_has_parameter(value, "fade") ? FADE_MODE_FADE : + string_has_parameter(value, "crossfade") ? FADE_MODE_CROSSFADE : + string_has_parameter(value, "melt") ? FADE_MODE_MELT : + FADE_MODE_DEFAULT); + } + else if (strPrefix(suffix, ".font")) /* (may also be ".font_xyz") */ + { + result = gfx.get_font_from_token_function(value); + } + 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); + } + + free(value); + + return result; +} + +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; + + if (screen_mode_string_x == NULL) /* invalid screen mode format */ + 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); + + return &screen_mode; +} + +void get_aspect_ratio_from_screen_mode(struct ScreenModeInfo *screen_mode, + int *x, int *y) +{ + float aspect_ratio = (float)screen_mode->width / (float)screen_mode->height; + float aspect_ratio_new; + int i = 1; + + do + { + *x = i * aspect_ratio + 0.000001; + *y = i; + + aspect_ratio_new = (float)*x / (float)*y; + + i++; + } + while (aspect_ratio_new != aspect_ratio && *y < screen_mode->height); +} + +static void FreeCustomArtworkList(struct ArtworkListInfo *, + struct ListNodeInfo ***, int *); + +struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list, + struct ConfigTypeInfo *suffix_list, + char **ignore_tokens, + int num_file_list_entries) +{ + struct FileInfo *file_list; + int num_file_list_entries_found = 0; + int num_suffix_list_entries = 0; + int list_pos; + int i, j; + + 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 */ + for (i = 0; i < num_file_list_entries; i++) + { + file_list[i].token = NULL; + + file_list[i].default_filename = NULL; + file_list[i].filename = NULL; + + if (num_suffix_list_entries > 0) + { + int parameter_array_size = num_suffix_list_entries * sizeof(char *); + + file_list[i].default_parameter = checked_calloc(parameter_array_size); + file_list[i].parameter = checked_calloc(parameter_array_size); + + for (j = 0; j < num_suffix_list_entries; j++) + { + setString(&file_list[i].default_parameter[j], suffix_list[j].value); + setString(&file_list[i].parameter[j], suffix_list[j].value); + } + + 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); + boolean is_file_entry = TRUE; + + for (j = 0; suffix_list[j].token != NULL; j++) + { + int len_suffix = strlen(suffix_list[j].token); + + if (len_suffix < len_config_token && + strEqual(&config_list[i].token[len_config_token - len_suffix], + suffix_list[j].token)) + { + setString(&file_list[list_pos].default_parameter[j], + 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; + + if (is_file_entry) + { + if (i > 0) + list_pos++; + + if (list_pos >= num_file_list_entries) + break; + + 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_INFO_LINE, "-"); + Error(ERR_INFO, "inconsistant config list information:"); + Error(ERR_INFO, "- should be: %d (according to 'src/conf_xxx.h')", + num_file_list_entries); + Error(ERR_INFO, "- found to be: %d (according to 'src/conf_xxx.c')", + num_file_list_entries_found); + Error(ERR_EXIT, "please fix"); + } + + return file_list; +} + +static boolean token_suffix_match(char *token, char *suffix, int start_pos) +{ + int len_token = strlen(token); + int len_suffix = strlen(suffix); + + if (start_pos < 0) /* compare suffix from end of string */ + start_pos += len_token; + + if (start_pos < 0 || start_pos + len_suffix > len_token) + return FALSE; + + if (strncmp(&token[start_pos], suffix, len_suffix) != 0) + return FALSE; + + if (token[start_pos + len_suffix] == '\0') + return TRUE; + + if (token[start_pos + len_suffix] == '.') + return TRUE; + + return FALSE; +} + +#define KNOWN_TOKEN_VALUE "[KNOWN_TOKEN_VALUE]" + +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 */ + char *filename = getHashEntry(setup_file_hash, file_list_entry->token); + char *known_token_value = KNOWN_TOKEN_VALUE; + int i; + + if (filename != NULL) + { + setString(&file_list_entry->filename, filename); + + /* when file definition found, set all parameters to default values */ + for (i = 0; suffix_list[i].token != NULL; i++) + 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 */ + setHashEntry(setup_file_hash, file_list_entry->token, known_token_value); + } + + /* check for config tokens that can be build by base token and suffixes */ + for (i = 0; suffix_list[i].token != NULL; i++) + { + char *token = getStringCat2(file_list_entry->token, suffix_list[i].token); + char *value = getHashEntry(setup_file_hash, token); + + if (value != NULL) + { + setString(&file_list_entry->parameter[i], value); + + /* mark config file token as well known from default config */ + setHashEntry(setup_file_hash, token, known_token_value); + } + + free(token); + } +} + +static void add_dynamic_file_list_entry(struct FileInfo **list, + int *num_list_entries, + SetupFileHash *extra_file_hash, + struct ConfigTypeInfo *suffix_list, + int num_suffix_list_entries, + char *token) +{ + struct FileInfo *new_list_entry; + int parameter_array_size = num_suffix_list_entries * sizeof(char *); + + (*num_list_entries)++; + *list = checked_realloc(*list, *num_list_entries * sizeof(struct FileInfo)); + new_list_entry = &(*list)[*num_list_entries - 1]; + + new_list_entry->token = getStringCopy(token); + new_list_entry->default_filename = NULL; + new_list_entry->filename = NULL; + new_list_entry->parameter = checked_calloc(parameter_array_size); + + 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); +} + +static void add_property_mapping(struct PropertyMapping **list, + int *num_list_entries, + int base_index, int ext1_index, + int ext2_index, int ext3_index, + int artwork_index) +{ + struct PropertyMapping *new_list_entry; + + (*num_list_entries)++; + *list = checked_realloc(*list, + *num_list_entries * sizeof(struct PropertyMapping)); + new_list_entry = &(*list)[*num_list_entries - 1]; + + new_list_entry->base_index = base_index; + new_list_entry->ext1_index = ext1_index; + new_list_entry->ext2_index = ext2_index; + new_list_entry->ext3_index = ext3_index; + + new_list_entry->artwork_index = artwork_index; +} + +static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info, + char *filename) +{ + struct FileInfo *file_list = artwork_info->file_list; + struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list; + char **base_prefixes = artwork_info->base_prefixes; + char **ext1_suffixes = artwork_info->ext1_suffixes; + char **ext2_suffixes = artwork_info->ext2_suffixes; + char **ext3_suffixes = artwork_info->ext3_suffixes; + char **ignore_tokens = artwork_info->ignore_tokens; + int num_file_list_entries = artwork_info->num_file_list_entries; + int num_suffix_list_entries = artwork_info->num_suffix_list_entries; + int num_base_prefixes = artwork_info->num_base_prefixes; + int num_ext1_suffixes = artwork_info->num_ext1_suffixes; + int num_ext2_suffixes = artwork_info->num_ext2_suffixes; + 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 *extra_file_hash, *empty_file_hash; + char *known_token_value = KNOWN_TOKEN_VALUE; + int i, j, k, l; + + if (filename == NULL) + return; + + if ((setup_file_hash = loadSetupFileHash(filename)) == NULL) + return; + + /* separate valid (defined) from empty (undefined) config token values */ + valid_file_hash = newSetupFileHash(); + empty_file_hash = newSetupFileHash(); + BEGIN_HASH_ITERATION(setup_file_hash, itr) + { + char *value = HASH_ITERATION_VALUE(itr); + + setHashEntry(*value ? valid_file_hash : empty_file_hash, + HASH_ITERATION_TOKEN(itr), value); + } + END_HASH_ITERATION(setup_file_hash, itr) + + /* at this point, we do not need the setup file hash anymore -- free it */ + freeSetupFileHash(setup_file_hash); + + /* map deprecated to current tokens (using prefix match and replace) */ + BEGIN_HASH_ITERATION(valid_file_hash, itr) + { + char *token = HASH_ITERATION_TOKEN(itr); + char *mapped_token = get_mapped_token(token); + + if (mapped_token != NULL) + { + char *value = HASH_ITERATION_VALUE(itr); + + /* add mapped token */ + setHashEntry(valid_file_hash, mapped_token, value); + + /* 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) + + /* 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 */ + 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 */ + extra_file_hash = newSetupFileHash(); + BEGIN_HASH_ITERATION(valid_file_hash, itr) + { + char *value = HASH_ITERATION_VALUE(itr); + + if (!strEqual(value, known_token_value)) + setHashEntry(extra_file_hash, HASH_ITERATION_TOKEN(itr), value); + } + END_HASH_ITERATION(valid_file_hash, itr) + + /* 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 */ + + BEGIN_HASH_ITERATION(extra_file_hash, itr) + { + struct FileInfo **dynamic_file_list = + &artwork_info->dynamic_file_list; + int *num_dynamic_file_list_entries = + &artwork_info->num_dynamic_file_list_entries; + struct PropertyMapping **property_mapping = + &artwork_info->property_mapping; + int *num_property_mapping_entries = + &artwork_info->num_property_mapping_entries; + int current_summarized_file_list_entry = + artwork_info->num_file_list_entries + + artwork_info->num_dynamic_file_list_entries; + char *token = HASH_ITERATION_TOKEN(itr); + int len_token = strlen(token); + int start_pos; + boolean base_prefix_found = FALSE; + boolean parameter_suffix_found = FALSE; + + /* skip all parameter definitions (handled by read_token_parameters()) */ + for (i = 0; i < num_suffix_list_entries && !parameter_suffix_found; i++) + { + int len_suffix = strlen(suffix_list[i].token); + + if (token_suffix_match(token, suffix_list[i].token, -len_suffix)) + parameter_suffix_found = TRUE; + } + + if (parameter_suffix_found) + continue; + + /* ---------- step 0: search for matching base prefix ---------- */ + + start_pos = 0; + for (i = 0; i < num_base_prefixes && !base_prefix_found; i++) + { + char *base_prefix = base_prefixes[i]; + int len_base_prefix = strlen(base_prefix); + boolean ext1_suffix_found = FALSE; + boolean ext2_suffix_found = FALSE; + boolean ext3_suffix_found = FALSE; + boolean exact_match = FALSE; + int base_index = -1; + int ext1_index = -1; + int ext2_index = -1; + int ext3_index = -1; + + base_prefix_found = token_suffix_match(token, base_prefix, start_pos); + + if (!base_prefix_found) + continue; + + base_index = i; + + if (start_pos + len_base_prefix == len_token) /* exact match */ + { + exact_match = TRUE; + + add_dynamic_file_list_entry(dynamic_file_list, + num_dynamic_file_list_entries, + extra_file_hash, + suffix_list, + num_suffix_list_entries, + token); + add_property_mapping(property_mapping, + num_property_mapping_entries, + base_index, -1, -1, -1, + current_summarized_file_list_entry); + continue; + } + + /* ---------- step 1: search for matching first suffix ---------- */ + + start_pos += len_base_prefix; + for (j = 0; j < num_ext1_suffixes && !ext1_suffix_found; j++) + { + char *ext1_suffix = ext1_suffixes[j]; + int len_ext1_suffix = strlen(ext1_suffix); + + ext1_suffix_found = token_suffix_match(token, ext1_suffix, start_pos); + + if (!ext1_suffix_found) + continue; + + ext1_index = j; + + if (start_pos + len_ext1_suffix == len_token) /* exact match */ + { + exact_match = TRUE; + + add_dynamic_file_list_entry(dynamic_file_list, + num_dynamic_file_list_entries, + extra_file_hash, + suffix_list, + num_suffix_list_entries, + token); + add_property_mapping(property_mapping, + num_property_mapping_entries, + base_index, ext1_index, -1, -1, + current_summarized_file_list_entry); + continue; + } + + start_pos += len_ext1_suffix; + } + + if (exact_match) + break; + + /* ---------- step 2: search for matching second suffix ---------- */ + + for (k = 0; k < num_ext2_suffixes && !ext2_suffix_found; k++) + { + char *ext2_suffix = ext2_suffixes[k]; + int len_ext2_suffix = strlen(ext2_suffix); + + ext2_suffix_found = token_suffix_match(token, ext2_suffix, start_pos); + + if (!ext2_suffix_found) + continue; + + ext2_index = k; + + if (start_pos + len_ext2_suffix == len_token) /* exact match */ + { + exact_match = TRUE; + + add_dynamic_file_list_entry(dynamic_file_list, + num_dynamic_file_list_entries, + extra_file_hash, + suffix_list, + num_suffix_list_entries, + token); + add_property_mapping(property_mapping, + num_property_mapping_entries, + base_index, ext1_index, ext2_index, -1, + current_summarized_file_list_entry); + continue; + } + + start_pos += len_ext2_suffix; + } + + if (exact_match) + break; + + /* ---------- step 3: search for matching third suffix ---------- */ + + for (l = 0; l < num_ext3_suffixes && !ext3_suffix_found; l++) + { + char *ext3_suffix = ext3_suffixes[l]; + int len_ext3_suffix = strlen(ext3_suffix); + + ext3_suffix_found = token_suffix_match(token, ext3_suffix, start_pos); + + if (!ext3_suffix_found) + continue; + + ext3_index = l; + + if (start_pos + len_ext3_suffix == len_token) /* exact match */ + { + exact_match = TRUE; + + add_dynamic_file_list_entry(dynamic_file_list, + num_dynamic_file_list_entries, + extra_file_hash, + suffix_list, + num_suffix_list_entries, + token); + add_property_mapping(property_mapping, + num_property_mapping_entries, + base_index, ext1_index, ext2_index, ext3_index, + current_summarized_file_list_entry); + continue; + } + } + } + } + END_HASH_ITERATION(extra_file_hash, itr) + + if (artwork_info->num_dynamic_file_list_entries > 0) + { + artwork_info->dynamic_artwork_list = + checked_calloc(artwork_info->num_dynamic_file_list_entries * + artwork_info->sizeof_artwork_list_entry); + } + + if (options.verbose && IS_PARENT_PROCESS()) + { + SetupFileList *setup_file_list, *list; + boolean dynamic_tokens_found = FALSE; + boolean unknown_tokens_found = FALSE; + boolean undefined_values_found = (hashtable_count(empty_file_hash) != 0); + + if ((setup_file_list = loadSetupFileList(filename)) == NULL) + Error(ERR_EXIT, "loadSetupFileHash works, but loadSetupFileList fails"); + + BEGIN_HASH_ITERATION(extra_file_hash, itr) + { + if (strEqual(HASH_ITERATION_VALUE(itr), known_token_value)) + dynamic_tokens_found = TRUE; + else + unknown_tokens_found = TRUE; + } + END_HASH_ITERATION(extra_file_hash, itr) + + if (options.debug && dynamic_tokens_found) + { + Error(ERR_INFO_LINE, "-"); + Error(ERR_INFO, "dynamic token(s) found in config file:"); + Error(ERR_INFO, "- 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_INFO, "- dynamic token: '%s'", list->token); + } + + Error(ERR_INFO_LINE, "-"); + } + + if (unknown_tokens_found) + { + Error(ERR_INFO_LINE, "-"); + Error(ERR_INFO, "warning: unknown token(s) found in config file:"); + Error(ERR_INFO, "- 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_INFO, "- dynamic token: '%s'", list->token); + } + + Error(ERR_INFO_LINE, "-"); + } + + if (undefined_values_found) + { + Error(ERR_INFO_LINE, "-"); + Error(ERR_INFO, "warning: undefined values found in config file:"); + Error(ERR_INFO, "- config file: '%s'", filename); + + for (list = setup_file_list; list != NULL; list = list->next) + { + char *value = getHashEntry(empty_file_hash, list->token); - node_group = getLevelDirInfoFromFilenameExt(node->node_group, filename); + if (value != NULL) + Error(ERR_INFO, "- undefined value for token: '%s'", list->token); + } - if (node_group) - return node_group; - } - else if (!node->parent_link) - { - if (strcmp(filename, node->filename) == 0) - return node; + Error(ERR_INFO_LINE, "-"); } - node = node->next; + freeSetupFileList(setup_file_list); } - return NULL; + freeSetupFileHash(extra_file_hash); + freeSetupFileHash(empty_file_hash); } -struct LevelDirInfo *getLevelDirInfoFromFilename(char *filename) +void LoadArtworkConfig(struct ArtworkListInfo *artwork_info) { - return getLevelDirInfoFromFilenameExt(leveldir_first, filename); -} + struct FileInfo *file_list = artwork_info->file_list; + int num_file_list_entries = artwork_info->num_file_list_entries; + int num_suffix_list_entries = artwork_info->num_suffix_list_entries; + char *filename_base = UNDEFINED_FILENAME, *filename_local; + int i, j; -void dumpLevelDirInfo(struct LevelDirInfo *node, int depth) -{ - int i; + DrawInitText("Loading artwork config", 120, FC_GREEN); + DrawInitText(ARTWORKINFO_FILENAME(artwork_info->type), 150, FC_YELLOW); - while (node) + /* always start with reliable default values */ + for (i = 0; i < num_file_list_entries; i++) { - for (i=0; ifilename); + for (j = 0; j < num_suffix_list_entries; j++) + setString(&file_list[i].parameter[j], file_list[i].default_parameter[j]); - if (node->node_group != NULL) - dumpLevelDirInfo(node->node_group, depth + 1); - - node = node->next; + file_list[i].redefined = FALSE; + file_list[i].fallback_to_default = FALSE; } -} -void sortLevelDirInfo(struct LevelDirInfo **node_first, - int (*compare_function)(const void *, const void *)) -{ - int num_nodes = numLevelDirInfo(*node_first); - struct LevelDirInfo **sort_array; - struct LevelDirInfo *node = *node_first; - int i = 0; + /* free previous dynamic artwork file array */ + if (artwork_info->dynamic_file_list != NULL) + { + for (i = 0; i < artwork_info->num_dynamic_file_list_entries; i++) + { + free(artwork_info->dynamic_file_list[i].token); + free(artwork_info->dynamic_file_list[i].filename); + free(artwork_info->dynamic_file_list[i].parameter); + } - if (num_nodes == 0) - return; + free(artwork_info->dynamic_file_list); + artwork_info->dynamic_file_list = NULL; - /* allocate array for sorting structure pointers */ - sort_array = checked_calloc(num_nodes * sizeof(struct LevelDirInfo *)); + FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list, + &artwork_info->num_dynamic_file_list_entries); + } - /* writing structure pointers to sorting array */ - while (i < num_nodes && node) /* double boundary check... */ + /* free previous property mapping */ + if (artwork_info->property_mapping != NULL) { - sort_array[i] = node; + free(artwork_info->property_mapping); - i++; - node = node->next; + artwork_info->property_mapping = NULL; + artwork_info->num_property_mapping_entries = 0; } - /* sorting the structure pointers in the sorting array */ - qsort(sort_array, num_nodes, sizeof(struct LevelDirInfo *), - compare_function); - - /* update the linkage of list elements with the sorted node array */ - for (i=0; inext = sort_array[i + 1]; - sort_array[num_nodes - 1]->next = NULL; - - /* update the linkage of the main list anchor pointer */ - *node_first = sort_array[0]; - - free(sort_array); - - /* now recursively sort the level group structures */ - node = *node_first; - while (node) + if (!GFX_OVERRIDE_ARTWORK(artwork_info->type)) { - if (node->node_group != NULL) - sortLevelDirInfo(&node->node_group, compare_function); + /* first look for special artwork configured in level series config */ + filename_base = getCustomArtworkLevelConfigFilename(artwork_info->type); - node = node->next; + if (fileExists(filename_base)) + LoadArtworkConfigFromFilename(artwork_info, filename_base); } -} -inline void swap_numbers(int *i1, int *i2) -{ - int help = *i1; + filename_local = getCustomArtworkConfigFilename(artwork_info->type); - *i1 = *i2; - *i2 = help; + if (filename_local != NULL && !strEqual(filename_base, filename_local)) + LoadArtworkConfigFromFilename(artwork_info, filename_local); } -inline void swap_number_pairs(int *x1, int *y1, int *x2, int *y2) +static void deleteArtworkListEntry(struct ArtworkListInfo *artwork_info, + struct ListNodeInfo **listnode) { - int help_x = *x1; - int help_y = *y1; + if (*listnode) + { + char *filename = (*listnode)->source_filename; - *x1 = *x2; - *x2 = help_x; + if (--(*listnode)->num_references <= 0) + deleteNodeFromList(&artwork_info->content_list, filename, + artwork_info->free_artwork); - *y1 = *y2; - *y2 = help_y; + *listnode = NULL; + } } +static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info, + struct ListNodeInfo **listnode, + struct FileInfo *file_list_entry) +{ + char *init_text[] = + { + "Loading graphics", + "Loading sounds", + "Loading music" + }; -/* ========================================================================= */ -/* some stuff from "files.c" */ -/* ========================================================================= */ + ListNode *node; + char *basename = file_list_entry->filename; + char *filename = getCustomArtworkFilename(basename, artwork_info->type); -#if defined(PLATFORM_WIN32) -#ifndef S_IRGRP -#define S_IRGRP S_IRUSR -#endif -#ifndef S_IROTH -#define S_IROTH S_IRUSR -#endif -#ifndef S_IWGRP -#define S_IWGRP S_IWUSR -#endif -#ifndef S_IWOTH -#define S_IWOTH S_IWUSR -#endif -#ifndef S_IXGRP -#define S_IXGRP S_IXUSR -#endif -#ifndef S_IXOTH -#define S_IXOTH S_IXUSR -#endif -#ifndef S_IRWXG -#define S_IRWXG (S_IRGRP | S_IWGRP | S_IXGRP) -#endif -#ifndef S_ISGID -#define S_ISGID 0 -#endif -#endif /* PLATFORM_WIN32 */ + if (filename == NULL) + { + Error(ERR_WARN, "cannot find artwork file '%s'", basename); -/* file permissions for newly written files */ -#define MODE_R_ALL (S_IRUSR | S_IRGRP | S_IROTH) -#define MODE_W_ALL (S_IWUSR | S_IWGRP | S_IWOTH) -#define MODE_X_ALL (S_IXUSR | S_IXGRP | S_IXOTH) + basename = file_list_entry->default_filename; -#define MODE_W_PRIVATE (S_IWUSR) -#define MODE_W_PUBLIC (S_IWUSR | S_IWGRP) -#define MODE_W_PUBLIC_DIR (S_IWUSR | S_IWGRP | S_ISGID) + /* fail for cloned default artwork that has no default filename defined */ + if (file_list_entry->default_is_cloned && + strEqual(basename, UNDEFINED_FILENAME)) + { + int error_mode = ERR_WARN; -#define DIR_PERMS_PRIVATE (MODE_R_ALL | MODE_X_ALL | MODE_W_PRIVATE) -#define DIR_PERMS_PUBLIC (MODE_R_ALL | MODE_X_ALL | MODE_W_PUBLIC_DIR) + /* 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; -#define FILE_PERMS_PRIVATE (MODE_R_ALL | MODE_W_PRIVATE) -#define FILE_PERMS_PUBLIC (MODE_R_ALL | MODE_W_PUBLIC) + Error(error_mode, "token '%s' was cloned and has no default filename", + file_list_entry->token); -char *getUserDataDir(void) -{ - static char *userdata_dir = NULL; + return; + } - if (!userdata_dir) - { - char *home_dir = getHomeDir(); - char *data_dir = program.userdata_directory; + /* dynamic artwork has no default filename / skip empty default artwork */ + if (basename == NULL || strEqual(basename, UNDEFINED_FILENAME)) + return; - userdata_dir = getPath2(home_dir, data_dir); - } + file_list_entry->fallback_to_default = TRUE; - return userdata_dir; -} + Error(ERR_WARN, "trying default artwork file '%s'", basename); -char *getSetupDir() -{ - return getUserDataDir(); -} + filename = getCustomArtworkFilename(basename, artwork_info->type); -static mode_t posix_umask(mode_t mask) -{ -#if defined(PLATFORM_UNIX) - return umask(mask); -#else - return 0; -#endif -} + if (filename == NULL) + { + int error_mode = ERR_WARN; -static int posix_mkdir(const char *pathname, mode_t mode) -{ -#if defined(PLATFORM_WIN32) - return mkdir(pathname); -#else - return mkdir(pathname, mode); -#endif -} + /* 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; -void createDirectory(char *dir, char *text, int permission_class) -{ - /* leave "other" permissions in umask untouched, but ensure group parts - of USERDATA_DIR_MODE are not masked */ - mode_t dir_mode = (permission_class == PERMS_PRIVATE ? - DIR_PERMS_PRIVATE : DIR_PERMS_PUBLIC); - mode_t normal_umask = posix_umask(0); - mode_t group_umask = ~(dir_mode & S_IRWXG); - posix_umask(normal_umask & group_umask); + Error(error_mode, "cannot find default artwork file '%s'", basename); - if (access(dir, F_OK) != 0) - if (posix_mkdir(dir, dir_mode) != 0) - Error(ERR_WARN, "cannot create %s directory '%s'", text, dir); + return; + } + } - posix_umask(normal_umask); /* reset normal umask */ -} + /* 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. */ -void InitUserDataDirectory() -{ - createDirectory(getUserDataDir(), "user data", PERMS_PRIVATE); -} + return; + } -void SetFilePermissions(char *filename, int permission_class) -{ - chmod(filename, (permission_class == PERMS_PRIVATE ? - FILE_PERMS_PRIVATE : FILE_PERMS_PUBLIC)); -} + /* delete existing artwork file entry */ + deleteArtworkListEntry(artwork_info, listnode); -int getFileVersionFromCookieString(const char *cookie) -{ - const char *ptr_cookie1, *ptr_cookie2; - const char *pattern1 = "_FILE_VERSION_"; - const char *pattern2 = "?.?"; - const int len_cookie = strlen(cookie); - const int len_pattern1 = strlen(pattern1); - const int len_pattern2 = strlen(pattern2); - const int len_pattern = len_pattern1 + len_pattern2; - int version_major, version_minor; + /* check if the new artwork file already exists in the list of artwork */ + if ((node = getNodeFromKey(artwork_info->content_list, filename)) != NULL) + { + *listnode = (struct ListNodeInfo *)node->content; + (*listnode)->num_references++; - if (len_cookie <= len_pattern) - return -1; + return; + } - ptr_cookie1 = &cookie[len_cookie - len_pattern]; - ptr_cookie2 = &cookie[len_cookie - len_pattern2]; + DrawInitText(init_text[artwork_info->type], 120, FC_GREEN); + DrawInitText(basename, 150, FC_YELLOW); - if (strncmp(ptr_cookie1, pattern1, len_pattern1) != 0) - return -1; + if ((*listnode = artwork_info->load_artwork(filename)) != NULL) + { + /* 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; - if (ptr_cookie2[0] < '0' || ptr_cookie2[0] > '9' || - ptr_cookie2[1] != '.' || - ptr_cookie2[2] < '0' || ptr_cookie2[2] > '9') - return -1; + /* we can get away without sounds and music, but not without graphics */ + if (artwork_info->type == ARTWORK_TYPE_GRAPHICS) + error_mode = ERR_EXIT; - version_major = ptr_cookie2[0] - '0'; - version_minor = ptr_cookie2[2] - '0'; + Error(error_mode, "cannot load artwork file '%s'", basename); - return VERSION_IDENT(version_major, version_minor, 0); + return; + } } -boolean checkCookieString(const char *cookie, const char *template) +static void LoadCustomArtwork(struct ArtworkListInfo *artwork_info, + struct ListNodeInfo **listnode, + struct FileInfo *file_list_entry) { - const char *pattern = "_FILE_VERSION_?.?"; - const int len_cookie = strlen(cookie); - const int len_template = strlen(template); - const int len_pattern = strlen(pattern); - - if (len_cookie != len_template) - return FALSE; + if (strEqual(file_list_entry->filename, UNDEFINED_FILENAME)) + { + deleteArtworkListEntry(artwork_info, listnode); - if (strncmp(cookie, template, len_cookie - len_pattern) != 0) - return FALSE; + return; + } - return TRUE; + replaceArtworkListEntry(artwork_info, listnode, file_list_entry); } -/* ------------------------------------------------------------------------- */ -/* setup file stuff */ -/* ------------------------------------------------------------------------- */ - -static char *string_tolower(char *s) +void ReloadCustomArtworkList(struct ArtworkListInfo *artwork_info) { - static char s_lower[100]; + struct FileInfo *file_list = artwork_info->file_list; + struct FileInfo *dynamic_file_list = artwork_info->dynamic_file_list; + int num_file_list_entries = artwork_info->num_file_list_entries; + int num_dynamic_file_list_entries = + artwork_info->num_dynamic_file_list_entries; int i; - if (strlen(s) >= 100) - return s; - - strcpy(s_lower, s); - - for (i=0; iartwork_list[i], + &file_list[i]); - for (i=0; i<13; i++) - for (j=0; j<3; j++) - if (strcmp(string_tolower(s), number_text[i][j]) == 0) - return i; + for (i = 0; i < num_dynamic_file_list_entries; i++) + LoadCustomArtwork(artwork_info, &artwork_info->dynamic_artwork_list[i], + &dynamic_file_list[i]); - return atoi(s); -} + print_timestamp_done("ReloadCustomArtworkList"); -boolean get_string_boolean_value(char *s) -{ - if (strcmp(string_tolower(s), "true") == 0 || - strcmp(string_tolower(s), "yes") == 0 || - strcmp(string_tolower(s), "on") == 0 || - get_string_integer_value(s) == 1) - return TRUE; - else - return FALSE; +#if 0 + dumpList(artwork_info->content_list); +#endif } -char *getFormattedSetupEntry(char *token, char *value) +static void FreeCustomArtworkList(struct ArtworkListInfo *artwork_info, + struct ListNodeInfo ***list, + int *num_list_entries) { int i; - static char entry[MAX_LINE_LEN]; - sprintf(entry, "%s:", token); - for (i=strlen(entry); itoken) - free(setup_file_list->token); - if (setup_file_list->value) - free(setup_file_list->value); - if (setup_file_list->next) - freeSetupFileList(setup_file_list->next); - free(setup_file_list); -} - -static struct SetupFileList *newSetupFileList(char *token, char *value) -{ - struct SetupFileList *new = checked_malloc(sizeof(struct SetupFileList)); - - new->token = checked_malloc(strlen(token) + 1); - strcpy(new->token, token); + FreeCustomArtworkList(artwork_info, &artwork_info->artwork_list, + &artwork_info->num_file_list_entries); - new->value = checked_malloc(strlen(value) + 1); - strcpy(new->value, value); + FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list, + &artwork_info->num_dynamic_file_list_entries); +} - new->next = NULL; - return new; -} +/* ------------------------------------------------------------------------- */ +/* 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 *getTokenValue(struct SetupFileList *setup_file_list, char *token) +char *getErrorFilename(char *basename) { - if (!setup_file_list) - return NULL; - - if (strcmp(setup_file_list->token, token) == 0) - return setup_file_list->value; - else - return getTokenValue(setup_file_list->next, token); + return getPath2(getUserGameDataDir(), basename); } -static void setTokenValue(struct SetupFileList *setup_file_list, - char *token, char *value) +void openErrorFile() { - if (!setup_file_list) - return; + InitUserDataDirectory(); - if (strcmp(setup_file_list->token, token) == 0) + if ((program.error_file = fopen(program.error_filename, MODE_WRITE)) == NULL) { - free(setup_file_list->value); - setup_file_list->value = checked_malloc(strlen(value) + 1); - strcpy(setup_file_list->value, value); + program.error_file = stderr; + + Error(ERR_WARN, "cannot open file '%s' for writing: %s", + program.error_filename, strerror(errno)); } - else if (setup_file_list->next == NULL) - setup_file_list->next = newSetupFileList(token, value); - else - setTokenValue(setup_file_list->next, token, value); + + /* error output should be unbuffered so it is not truncated in a crash */ + setbuf(program.error_file, NULL); } -#ifdef DEBUG -static void printSetupFileList(struct SetupFileList *setup_file_list) +void closeErrorFile() { - if (!setup_file_list) - return; - - printf("token: '%s'\n", setup_file_list->token); - printf("value: '%s'\n", setup_file_list->value); - - printSetupFileList(setup_file_list->next); + if (program.error_file != stderr) /* do not close stream 'stderr' */ + fclose(program.error_file); } -#endif -struct SetupFileList *loadSetupFileList(char *filename) +void dumpErrorFile() { - int line_len; - char line[MAX_LINE_LEN]; - char *token, *value, *line_ptr; - struct SetupFileList *setup_file_list = newSetupFileList("", ""); - struct SetupFileList *first_valid_list_entry; + FILE *error_file = fopen(program.error_filename, MODE_READ); - FILE *file; - - if (!(file = fopen(filename, MODE_READ))) - { - Error(ERR_WARN, "cannot open configuration file '%s'", filename); - return NULL; - } - - while(!feof(file)) + if (error_file != NULL) { - /* read next line of input file */ - if (!fgets(line, MAX_LINE_LEN, file)) - break; - - /* cut trailing comment or whitespace from input line */ - for (line_ptr = line; *line_ptr; line_ptr++) - { - if (*line_ptr == '#' || *line_ptr == '\n' || *line_ptr == '\r') - { - *line_ptr = '\0'; - break; - } - } + while (!feof(error_file)) + fputc(fgetc(error_file), stderr); - /* cut trailing whitespaces from input line */ - for (line_ptr = &line[strlen(line)]; line_ptr > line; line_ptr--) - if ((*line_ptr == ' ' || *line_ptr == '\t') && line_ptr[1] == '\0') - *line_ptr = '\0'; + fclose(error_file); + } +} - /* ignore empty lines */ - if (*line == '\0') - continue; +void NotifyUserAboutErrorFile() +{ +#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); - line_len = strlen(line); + MessageBox(NULL, error_text, title_text, MB_OK); +#endif +} - /* cut leading whitespaces from token */ - for (token = line; *token; token++) - if (*token != ' ' && *token != '\t') - break; - /* find end of token */ - for (line_ptr = token; *line_ptr; line_ptr++) - { - if (*line_ptr == ' ' || *line_ptr == '\t' || *line_ptr == ':') - { - *line_ptr = '\0'; - break; - } - } +/* ------------------------------------------------------------------------- */ +/* the following is only for debugging purpose and normally not used */ +/* ------------------------------------------------------------------------- */ - if (line_ptr < line + line_len) - value = line_ptr + 1; - else - value = "\0"; +#if DEBUG - /* cut leading whitespaces from value */ - for (; *value; value++) - if (*value != ' ' && *value != '\t') - break; +#define DEBUG_PRINT_INIT_TIMESTAMPS FALSE +#define DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH 10 - if (*token && *value) - setTokenValue(setup_file_list, token, value); - } +#define DEBUG_NUM_TIMESTAMPS 10 +#define DEBUG_TIME_IN_MICROSECONDS 0 - fclose(file); +#if DEBUG_TIME_IN_MICROSECONDS +static double Counter_Microseconds() +{ + static struct timeval base_time = { 0, 0 }; + struct timeval current_time; + double counter; - first_valid_list_entry = setup_file_list->next; + gettimeofday(¤t_time, NULL); - /* free empty list header */ - setup_file_list->next = NULL; - freeSetupFileList(setup_file_list); + /* reset base time in case of wrap-around */ + if (current_time.tv_sec < base_time.tv_sec) + base_time = current_time; - if (first_valid_list_entry == NULL) - Error(ERR_WARN, "configuration file '%s' is empty", filename); + counter = + ((double)(current_time.tv_sec - base_time.tv_sec)) * 1000000 + + ((double)(current_time.tv_usec - base_time.tv_usec)); - return first_valid_list_entry; + return counter; /* return microseconds since last init */ } +#endif -void checkSetupFileListIdentifier(struct SetupFileList *setup_file_list, - char *identifier) +char *debug_print_timestamp_get_padding(int padding_size) { - if (!setup_file_list) - return; + static char *padding = NULL; + int max_padding_size = 100; - if (strcmp(setup_file_list->token, TOKEN_STR_FILE_IDENTIFIER) == 0) + if (padding == NULL) { - if (strcmp(setup_file_list->value, identifier) != 0) - { - Error(ERR_WARN, "configuration file has wrong version"); - return; - } - else - return; + padding = checked_calloc(max_padding_size + 1); + memset(padding, ' ', max_padding_size); } - if (setup_file_list->next) - checkSetupFileListIdentifier(setup_file_list->next, identifier); - else - { - Error(ERR_WARN, "configuration file has no version information"); - return; - } + return &padding[MAX(0, max_padding_size - padding_size)]; } +void debug_print_timestamp(int counter_nr, char *message) +{ + int indent_size = 8; + int padding_size = 40; + float timestamp_interval; -/* ========================================================================= */ -/* functions only needed for non-Unix (non-command-line) systems */ -/* ========================================================================= */ + if (counter_nr < 0) + Error(ERR_EXIT, "debugging: invalid negative counter"); + else if (counter_nr >= DEBUG_NUM_TIMESTAMPS) + Error(ERR_EXIT, "debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c"); -#if !defined(PLATFORM_UNIX) +#if DEBUG_TIME_IN_MICROSECONDS + static double counter[DEBUG_NUM_TIMESTAMPS][2]; + char *unit = "ms"; -#define ERROR_FILENAME "error.out" + counter[counter_nr][0] = Counter_Microseconds(); +#else + static int counter[DEBUG_NUM_TIMESTAMPS][2]; + char *unit = "s"; -void initErrorFile() -{ - char *filename; + counter[counter_nr][0] = Counter(); +#endif - InitUserDataDirectory(); + timestamp_interval = counter[counter_nr][0] - counter[counter_nr][1]; + counter[counter_nr][1] = counter[counter_nr][0]; - filename = getPath2(getUserDataDir(), ERROR_FILENAME); - unlink(filename); - free(filename); + if (message) + Error(ERR_DEBUG, "%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); } -FILE *openErrorFile() +void debug_print_parent_only(char *format, ...) { - char *filename; - FILE *error_file; + if (!IS_PARENT_PROCESS()) + return; - filename = getPath2(getUserDataDir(), ERROR_FILENAME); - error_file = fopen(filename, MODE_APPEND); - free(filename); + if (format) + { + va_list ap; + + va_start(ap, format); + vprintf(format, ap); + va_end(ap); - return error_file; + printf("\n"); + } } -void dumpErrorFile() +#endif /* DEBUG */ + +void print_timestamp_ext(char *message, char *mode) { - char *filename; - FILE *error_file; +#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; - filename = getPath2(getUserDataDir(), ERROR_FILENAME); - error_file = fopen(filename, MODE_READ); - free(filename); + checked_free(debug_message); + debug_message = getStringCat3(mode, " ", message); - if (error_file != NULL) + if (strEqual(mode, "INIT")) { - while (!feof(error_file)) - fputc(fgetc(error_file), stderr); + debug_print_timestamp(counter_nr, NULL); - fclose(error_file); - } -} -#endif + if (counter_nr + 1 < max_depth) + debug_print_timestamp(counter_nr, debug_message); + counter_nr++; -/* ========================================================================= */ -/* the following is only for debugging purpose and normally not used */ -/* ========================================================================= */ + debug_print_timestamp(counter_nr, NULL); + } + else if (strEqual(mode, "DONE")) + { + counter_nr--; -#define DEBUG_NUM_TIMESTAMPS 3 + if (counter_nr + 1 < max_depth || + (counter_nr == 0 && max_depth == 1)) + { + last_message = message; -void debug_print_timestamp(int counter_nr, char *message) -{ - static long counter[DEBUG_NUM_TIMESTAMPS][2]; + if (counter_nr == 0 && max_depth == 1) + { + checked_free(debug_message); + debug_message = getStringCat3("TIME", " ", message); + } - if (counter_nr >= DEBUG_NUM_TIMESTAMPS) - Error(ERR_EXIT, "debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c"); + 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 +} - counter[counter_nr][0] = Counter(); +void print_timestamp_init(char *message) +{ + print_timestamp_ext(message, "INIT"); +} - if (message) - printf("%s %.2f seconds\n", message, - (float)(counter[counter_nr][0] - counter[counter_nr][1]) / 1000); +void print_timestamp_time(char *message) +{ + print_timestamp_ext(message, "TIME"); +} - counter[counter_nr][1] = Counter(); +void print_timestamp_done(char *message) +{ + print_timestamp_ext(message, "DONE"); }