X-Git-Url: https://git.artsoft.org/?a=blobdiff_plain;f=src%2Flibgame%2Fmisc.c;h=8bc457216de7448418ad5cebd885728e562b5b60;hb=refs%2Fheads%2Fmaster-next-major-release;hp=e4939b193db1d697d81d11b3ca64539397690346;hpb=30eb586d06bc4d1ee7388dced1c20e530292aa93;p=rocksndiamonds.git diff --git a/src/libgame/misc.c b/src/libgame/misc.c index e4939b19..ed4bd5d6 100644 --- a/src/libgame/misc.c +++ b/src/libgame/misc.c @@ -4,7 +4,7 @@ // (c) 1995-2014 by Artsoft Entertainment // Holger Schemel // info@artsoft.org -// http://www.artsoft.org/ +// https://www.artsoft.org/ // ---------------------------------------------------------------------------- // misc.c // ============================================================================ @@ -21,7 +21,7 @@ #include "platform.h" -#if !defined(PLATFORM_WIN32) +#if defined(PLATFORM_UNIX) #include #include #endif @@ -33,16 +33,15 @@ #include "image.h" -/* ========================================================================= */ -/* some generic helper functions */ -/* ========================================================================= */ +// ============================================================================ +// some generic helper functions +// ============================================================================ -/* ------------------------------------------------------------------------- */ -/* logging functions */ -/* ------------------------------------------------------------------------- */ +// ---------------------------------------------------------------------------- +// logging functions +// ---------------------------------------------------------------------------- -#define DUPLICATE_LOG_OUT_TO_STDOUT TRUE -#define DUPLICATE_LOG_ERR_TO_STDERR TRUE +#define DUPLICATE_LOGGING_TO_STDOUT TRUE #if defined(PLATFORM_ANDROID) @@ -94,15 +93,15 @@ static void vprintf_log(char *format, va_list ap) static void vprintf_log_nonewline(char *format, va_list ap) { - FILE *file = program.log_file[LOG_ERR_ID]; + FILE *file = program.log_file; -#if DUPLICATE_LOG_ERR_TO_STDERR - if (file != program.log_file_default[LOG_ERR_ID]) +#if DUPLICATE_LOGGING_TO_STDOUT + if (file != program.log_file_default) { va_list ap2; va_copy(ap2, ap); - vfprintf(program.log_file_default[LOG_ERR_ID], format, ap2); + vfprintf(program.log_file_default, format, ap2); va_end(ap2); } @@ -113,17 +112,17 @@ static void vprintf_log_nonewline(char *format, va_list ap) static void vprintf_log(char *format, va_list ap) { - FILE *file = program.log_file[LOG_ERR_ID]; + FILE *file = program.log_file; char *newline = STRING_NEWLINE; -#if DUPLICATE_LOG_ERR_TO_STDERR - if (file != program.log_file_default[LOG_ERR_ID]) +#if DUPLICATE_LOGGING_TO_STDOUT + if (file != program.log_file_default) { va_list ap2; va_copy(ap2, ap); - vfprintf(program.log_file_default[LOG_ERR_ID], format, ap2); - fprintf(program.log_file_default[LOG_ERR_ID], "%s", newline); + vfprintf(program.log_file_default, format, ap2); + fprintf(program.log_file_default, "%s", newline); va_end(ap2); } @@ -163,9 +162,9 @@ static void printf_log_line(char *line_chars, int line_length) } -/* ------------------------------------------------------------------------- */ -/* platform independent wrappers for printf() et al. */ -/* ------------------------------------------------------------------------- */ +// ---------------------------------------------------------------------------- +// platform independent wrappers for printf() et al. +// ---------------------------------------------------------------------------- void fprintf_line(FILE *file, char *line_chars, int line_length) { @@ -196,15 +195,15 @@ void printf_line_with_prefix(char *prefix, char *line_chars, int line_length) static void vPrint(char *format, va_list ap) { - FILE *file = program.log_file[LOG_OUT_ID]; + FILE *file = program.log_file; -#if DUPLICATE_LOG_OUT_TO_STDOUT - if (file != program.log_file_default[LOG_OUT_ID]) +#if DUPLICATE_LOGGING_TO_STDOUT + if (file != program.log_file_default) { va_list ap2; va_copy(ap2, ap); - vfprintf(program.log_file_default[LOG_OUT_ID], format, ap2); + vfprintf(program.log_file_default, format, ap2); va_end(ap2); } @@ -224,7 +223,7 @@ void Print(char *format, ...) void PrintNoLog(char *format, ...) { - FILE *file = program.log_file_default[LOG_OUT_ID]; + FILE *file = program.log_file_default; va_list ap; va_start(ap, format); @@ -251,16 +250,236 @@ void PrintLineWithPrefix(char *prefix, char *line_chars, int line_length) } -/* ------------------------------------------------------------------------- */ -/* string functions */ -/* ------------------------------------------------------------------------- */ +// ---------------------------------------------------------------------------- +// generic logging and error handling functions +// ---------------------------------------------------------------------------- + +enum log_levels +{ + LOG_UNKNOWN = 0, + LOG_DEBUG, + LOG_INFO, + LOG_WARN, + LOG_ERROR, + LOG_FATAL +}; + +static char *log_tokens[] = +{ + "UNKNOWN", + "DEBUG", + "INFO", + "WARN", + "ERROR", + "FATAL" +}; + +static void printf_log_prefix(int log_level, char *mode) +{ + if (log_level < 0 || log_level > LOG_FATAL) + return; + + char *log_token = log_tokens[log_level]; + + if (log_level == LOG_DEBUG) + printf_log_nonewline("[%s] [%s] ", log_token, mode); + else + printf_log_nonewline("[%s] ", log_token); +} + +static void vLog(int log_level, char *mode, char *format, va_list ap) +{ + if (log_level < 0 || log_level > LOG_FATAL) + return; + + if (log_level == LOG_DEBUG) + { + // only show debug messages when in debug mode + if (!options.debug) + return; + + // if optional debug mode specified, limit debug output accordingly + if (options.debug_mode != NULL && + strstr(mode, options.debug_mode) == NULL) + return; + } + else if (log_level == LOG_WARN) + { + // only show warning messages when in verbose mode + if (!options.verbose) + return; + } + +#if defined(PLATFORM_ANDROID) + android_log_prio = (log_level == LOG_DEBUG ? ANDROID_LOG_DEBUG : + log_level == LOG_INFO ? ANDROID_LOG_INFO : + log_level == LOG_WARN ? ANDROID_LOG_WARN : + log_level == LOG_ERROR ? ANDROID_LOG_ERROR : + log_level == LOG_FATAL ? ANDROID_LOG_FATAL : + ANDROID_LOG_UNKNOWN); +#endif + + static boolean last_line_was_separator = FALSE; + char *log_token = log_tokens[log_level]; + + if (strEqual(format, "===") || + strEqual(format, "---")) + { + static char *mode_last = NULL; + char line_char[2] = { format[0], '\0' }; + int line_length = 80 - strlen(log_token) - 3; + + if (log_level == LOG_DEBUG) + line_length -= strlen(mode) + 3; + + if (last_line_was_separator && strEqual(mode, mode_last)) + return; + + printf_log_prefix(log_level, mode); + printf_log_line(line_char, line_length); + + if (!strEqual(mode, mode_last)) + setString(&mode_last, mode); + + last_line_was_separator = TRUE; + + return; + } + + last_line_was_separator = FALSE; + + printf_log_prefix(log_level, mode); + + vprintf_log(format, ap); +} + +static void Log(int log_level, char *mode, char *format, ...) +{ + va_list ap; + + va_start(ap, format); + vLog(log_level, mode, format, ap); + va_end(ap); +} + +void DebugContinued(char *mode, char *format, ...) +{ + static char message[MAX_LINE_LEN] = { 0 }; + + // initialize message (optional) + if (strEqual(format, "")) + { + message[0] = '\0'; + + return; + } + + char *message_ptr = message + strlen(message); + int size_left = MAX_LINE_LEN - strlen(message); + va_list ap; + + // append message + va_start(ap, format); + vsnprintf(message_ptr, size_left, format, ap); + va_end(ap); + + // finalize message + if (strSuffix(format, "\n")) + { + message[strlen(message) - 1] = '\0'; + + Debug(mode, message); + + message[0] = '\0'; + } +} + +void Debug(char *mode, char *format, ...) +{ + va_list ap; + + va_start(ap, format); + vLog(LOG_DEBUG, mode, format, ap); + va_end(ap); +} + +void Info(char *format, ...) +{ + va_list ap; + + va_start(ap, format); + vLog(LOG_INFO, NULL, format, ap); + va_end(ap); +} + +void Warn(char *format, ...) +{ + va_list ap; + + va_start(ap, format); + vLog(LOG_WARN, NULL, format, ap); + va_end(ap); +} + +void Error(char *format, ...) +{ + va_list ap; + + va_start(ap, format); + vLog(LOG_ERROR, NULL, format, ap); + va_end(ap); +} + +void Fail(char *format, ...) +{ + va_list ap; + + va_start(ap, format); + vLog(LOG_FATAL, NULL, format, ap); + va_end(ap); + + if (!network.is_server_thread) + { + va_start(ap, format); + program.exit_message_function(format, ap); + va_end(ap); + } + + Log(LOG_FATAL, NULL, "aborting"); + + // network server thread: normal exit + if (network.is_server_thread) + exit(1); + + // main process: clean up stuff + program.exit_function(1); +} + +void FailWithHelp(char *format, ...) +{ + va_list ap; + + va_start(ap, format); + vLog(LOG_FATAL, NULL, format, ap); + va_end(ap); + + Log(LOG_FATAL, NULL, "try option '--help' for more information"); + Log(LOG_FATAL, NULL, "aborting"); + + // main process: clean up stuff + program.exit_function(1); +} + + +// ---------------------------------------------------------------------------- +// 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. -*/ + the 11th call will then destroy the result from the first call and so on. */ char *int2str(int number, int size) { @@ -286,9 +505,9 @@ char *int2str(int number, int size) } -/* something similar to "int2str()" above, but allocates its own memory - and has a different interface; we cannot use "itoa()", because this - seems to be already defined when cross-compiling to the win32 target */ +// 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) { @@ -296,7 +515,7 @@ char *i_to_a(unsigned int i) checked_free(a); - if (i > 2147483647) /* yes, this is a kludge */ + if (i > 2147483647) // yes, this is a kludge i = 2147483647; a = checked_malloc(10 + 1); @@ -307,8 +526,8 @@ char *i_to_a(unsigned int i) } -/* calculate base-2 logarithm of argument (rounded down to integer; - this function returns the number of the highest bit set in argument) */ +// 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) { @@ -316,7 +535,7 @@ int log_2(unsigned int x) while ((1 << e) < x) { - x -= (1 << e); /* for rounding down (rounding up: remove this line) */ + x -= (1 << e); // for rounding down (rounding up: remove this line) e++; } @@ -329,11 +548,55 @@ boolean getTokenValueFromString(char *string, char **token, char **value) } -/* ------------------------------------------------------------------------- */ -/* counter functions */ -/* ------------------------------------------------------------------------- */ +// ---------------------------------------------------------------------------- +// UUID functions +// ---------------------------------------------------------------------------- + +#define UUID_BYTES 16 +#define UUID_CHARS (UUID_BYTES * 2) +#define UUID_LENGTH (UUID_CHARS + 4) + +static unsigned int uuid_random_function(int max) +{ + return GetBetterRandom(max); +} + +char *getUUIDExt(unsigned int (*random_function)(int max)) +{ + static char uuid[UUID_LENGTH + 1]; + int data[UUID_BYTES]; + int count = 0; + int i; + + for (i = 0; i < UUID_BYTES; i++) + data[i] = random_function(256); + + data[6] = 0x40 | (data[6] & 0x0f); + data[8] = 0x80 | (data[8] & 0x3f); + + for (i = 0; i < UUID_BYTES; i++) + { + sprintf(&uuid[count], "%02x", data[i]); + count += 2; + + if (i == 3 || i == 5 || i == 7 || i == 9) + strcat(&uuid[count++], "-"); + } + + return uuid; +} + +char *getUUID(void) +{ + return getUUIDExt(uuid_random_function); +} + + +// ---------------------------------------------------------------------------- +// counter functions +// ---------------------------------------------------------------------------- -/* maximal allowed length of a command line option */ +// maximal allowed length of a command line option #define MAX_OPTION_LEN 256 static unsigned int getCurrentMS(void) @@ -346,23 +609,23 @@ static unsigned int mainCounter(int mode) static unsigned int base_ms = 0; unsigned int current_ms; - /* get current system milliseconds */ + // get current system milliseconds current_ms = getCurrentMS(); - /* reset base timestamp in case of counter reset or wrap-around */ + // 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 milliseconds since last counter reset return current_ms - base_ms; } -void InitCounter() /* set counter back to zero */ +void InitCounter(void) // set counter back to zero { mainCounter(INIT_COUNTER); } -unsigned int Counter() /* get milliseconds since last call of InitCounter() */ +unsigned int Counter(void) // get milliseconds since last call of InitCounter() { return mainCounter(READ_COUNTER); } @@ -372,13 +635,13 @@ static void sleep_milliseconds(unsigned int milliseconds_delay) SDL_Delay(milliseconds_delay); } -void Delay(unsigned int delay) /* Sleep specified number of milliseconds */ +void Delay(unsigned int delay) // Sleep specified number of milliseconds { sleep_milliseconds(delay); } -boolean DelayReachedExt(unsigned int *counter_var, unsigned int delay, - unsigned int actual_counter) +boolean DelayReachedExt2(unsigned int *counter_var, unsigned int delay, + unsigned int actual_counter) { if (actual_counter >= *counter_var && actual_counter < *counter_var + delay) @@ -389,34 +652,40 @@ boolean DelayReachedExt(unsigned int *counter_var, unsigned int delay, return TRUE; } -boolean FrameReached(unsigned int *frame_counter_var, unsigned int frame_delay) +boolean DelayReachedExt(DelayCounter *counter, unsigned int actual_counter) { - return DelayReachedExt(frame_counter_var, frame_delay, FrameCounter); + return DelayReachedExt2(&counter->count, counter->value, actual_counter); } -boolean DelayReached(unsigned int *counter_var, unsigned int delay) +boolean FrameReached(DelayCounter *counter) { - return DelayReachedExt(counter_var, delay, Counter()); + return DelayReachedExt(counter, FrameCounter); } -void ResetDelayCounterExt(unsigned int *counter_var, - unsigned int actual_counter) +boolean DelayReached(DelayCounter *counter) { - DelayReachedExt(counter_var, 0, actual_counter); + return DelayReachedExt(counter, Counter()); } -void ResetFrameCounter(unsigned int *frame_counter_var) +void ResetDelayCounterExt(DelayCounter *counter, unsigned int actual_counter) { - FrameReached(frame_counter_var, 0); + DelayReachedExt2(&counter->count, 0, actual_counter); } -void ResetDelayCounter(unsigned int *counter_var) +void ResetFrameCounter(DelayCounter *counter) { - DelayReached(counter_var, 0); + ResetDelayCounterExt(counter, FrameCounter); } -int WaitUntilDelayReached(unsigned int *counter_var, unsigned int delay) +void ResetDelayCounter(DelayCounter *counter) { + ResetDelayCounterExt(counter, Counter()); +} + +int WaitUntilDelayReached(DelayCounter *counter) +{ + unsigned int *counter_var = &counter->count; + unsigned int delay = counter->value; unsigned int actual_counter; int skip_frames = 0; @@ -447,17 +716,22 @@ int WaitUntilDelayReached(unsigned int *counter_var, unsigned int delay) return skip_frames; } -void SkipUntilDelayReached(unsigned int *counter_var, unsigned int delay, +void SkipUntilDelayReached(DelayCounter *counter, int *loop_var, int last_loop_value) { - int skip_frames = WaitUntilDelayReached(counter_var, delay); + int skip_frames = WaitUntilDelayReached(counter); #if 0 #if DEBUG - printf("::: %d: %d ms", *loop_var, delay); if (skip_frames) - printf(" -> SKIP %d FRAME(S) [%d ms]", skip_frames, skip_frames * delay); - printf("\n"); + Debug("internal:SkipUntilDelayReached", + "%d: %d ms -> SKIP %d FRAME(S) [%d ms]", + *loop_var, counter->value, + skip_frames, skip_frames * counter->value); + else + Debug("internal:SkipUntilDelayReached", + "%d: %d ms", + *loop_var, counter->value); #endif #endif @@ -483,19 +757,19 @@ void SkipUntilDelayReached(unsigned int *counter_var, unsigned int delay, } -/* ------------------------------------------------------------------------- */ -/* random generator functions */ -/* ------------------------------------------------------------------------- */ +// ---------------------------------------------------------------------------- +// random generator functions +// ---------------------------------------------------------------------------- -unsigned int init_random_number(int nr, int seed) +static unsigned int init_random_number_ext(int nr, int seed) { if (seed == NEW_RANDOMIZE) { - /* default random seed */ + // default random seed seed = (int)time(NULL); // seconds since the epoch -#if !defined(PLATFORM_WIN32) - /* add some more randomness */ +#if !defined(PLATFORM_WINDOWS) + // add some more randomness struct timeval current_time; gettimeofday(¤t_time, NULL); @@ -503,10 +777,10 @@ unsigned int init_random_number(int nr, int seed) seed += (int)current_time.tv_usec; // microseconds since the epoch #endif - /* add some more randomness */ + // add some more randomness seed += (int)SDL_GetTicks(); // milliseconds since SDL init - /* add some more randomness */ + // add some more randomness seed += GetSimpleRandom(1000000); } @@ -515,15 +789,38 @@ unsigned int init_random_number(int nr, int seed) return (unsigned int) seed; } +static unsigned int prng_seed_gettimeofday(void) +{ + struct timeval current_time; + + gettimeofday(¤t_time, NULL); + + prng_seed_bytes(¤t_time, sizeof(current_time)); + + return 0; +} + +unsigned int init_random_number(int nr, int seed) +{ + return (nr == RANDOM_BETTER ? prng_seed_gettimeofday() : + init_random_number_ext(nr, seed)); +} + +static unsigned int get_random_number_ext(int nr) +{ + return (nr == RANDOM_BETTER ? prng_get_uint() : + random_linux_libc(nr)); +} + unsigned int get_random_number(int nr, int max) { - return (max > 0 ? random_linux_libc(nr) % max : 0); + return (max > 0 ? get_random_number_ext(nr) % max : 0); } -/* ------------------------------------------------------------------------- */ -/* system info functions */ -/* ------------------------------------------------------------------------- */ +// ---------------------------------------------------------------------------- +// system info functions +// ---------------------------------------------------------------------------- #if !defined(PLATFORM_ANDROID) static char *get_corrected_real_name(char *real_name) @@ -532,16 +829,16 @@ static char *get_corrected_real_name(char *real_name) char *from_ptr = real_name; char *to_ptr = real_name_new; - /* copy the name string, but not more than MAX_USERNAME_LEN characters */ + // copy the name string, but not more than MAX_USERNAME_LEN characters while (*from_ptr && (int)(to_ptr - real_name_new) < MAX_USERNAME_LEN - 1) { - /* the name field read from "passwd" file may also contain additional - user information, separated by commas, which will be removed here */ + // 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; - /* the user's real name may contain 'german sharp s' characters, - which have no equivalent in upper case letters (used by our fonts) */ + // the user's real name may contain 'german sharp s' characters, + // which have no equivalent in upper case letters (used by our fonts) if (*from_ptr == CHAR_BYTE_SHARP_S) { from_ptr++; @@ -558,14 +855,57 @@ static char *get_corrected_real_name(char *real_name) } #endif +#if defined(PLATFORM_UNIX) +static struct passwd *getPasswdEntry(void) +{ +#if defined(PLATFORM_EMSCRIPTEN) + // currently not fully supported; force fallback to default values + return NULL; +#else + return getpwuid(getuid()); +#endif +} + +char *getUnixLoginName(void) +{ + struct passwd *pwd = getPasswdEntry(); + + if (pwd != NULL && strlen(pwd->pw_name) != 0) + return pwd->pw_name; + + return NULL; +} + +char *getUnixRealName(void) +{ + struct passwd *pwd = getPasswdEntry(); + + if (pwd != NULL && strlen(pwd->pw_gecos) != 0) + return pwd->pw_gecos; + + return NULL; +} + +char *getUnixHomeDir(void) +{ + struct passwd *pwd = getPasswdEntry(); + + if (pwd != NULL && strlen(pwd->pw_dir) != 0) + return pwd->pw_dir; + + return NULL; +} +#endif + char *getLoginName(void) { static char *login_name = NULL; -#if defined(PLATFORM_WIN32) +#if defined(PLATFORM_WINDOWS) if (login_name == NULL) { unsigned long buffer_size = MAX_USERNAME_LEN + 1; + login_name = checked_malloc(buffer_size); if (GetUserName(login_name, &buffer_size) == 0) @@ -574,12 +914,12 @@ char *getLoginName(void) #elif defined(PLATFORM_UNIX) && !defined(PLATFORM_ANDROID) if (login_name == NULL) { - struct passwd *pwd; + char *name = getUnixLoginName(); - if ((pwd = getpwuid(getuid())) == NULL) - login_name = ANONYMOUS_NAME; + if (name != NULL) + login_name = getStringCopy(name); else - login_name = getStringCopy(pwd->pw_name); + login_name = ANONYMOUS_NAME; } #else login_name = ANONYMOUS_NAME; @@ -592,7 +932,7 @@ char *getRealName(void) { static char *real_name = NULL; -#if defined(PLATFORM_WIN32) +#if defined(PLATFORM_WINDOWS) if (real_name == NULL) { static char buffer[MAX_USERNAME_LEN + 1]; @@ -606,10 +946,10 @@ char *getRealName(void) #elif defined(PLATFORM_UNIX) && !defined(PLATFORM_ANDROID) if (real_name == NULL) { - struct passwd *pwd; + char *name = getUnixRealName(); - if ((pwd = getpwuid(getuid())) != NULL && strlen(pwd->pw_gecos) != 0) - real_name = get_corrected_real_name(pwd->pw_gecos); + if (name != NULL) + real_name = get_corrected_real_name(name); else real_name = ANONYMOUS_NAME; } @@ -620,26 +960,73 @@ char *getRealName(void) return real_name; } +char *getFixedUserName(char *name) +{ + // needed because player name must be a fixed length string + char *name_new = checked_malloc(MAX_PLAYER_NAME_LEN + 1); + + strncpy(name_new, name, MAX_PLAYER_NAME_LEN); + name_new[MAX_PLAYER_NAME_LEN] = '\0'; + + if (strlen(name) > MAX_PLAYER_NAME_LEN) // name has been cut + if (strchr(name_new, ' ')) + *strchr(name_new, ' ') = '\0'; + + return name_new; +} + +char *getDefaultUserName(int nr) +{ + static char *user_name[MAX_PLAYER_NAMES] = { NULL }; + + nr = MIN(MAX(0, nr), MAX_PLAYER_NAMES - 1); + + if (user_name[nr] == NULL) + { + user_name[nr] = (nr == 0 ? getLoginName() : EMPTY_PLAYER_NAME); + user_name[nr] = getFixedUserName(user_name[nr]); + } + + return user_name[nr]; +} + +char *getTimestampFromEpoch(time_t epoch_seconds) +{ + struct tm *now = localtime(&epoch_seconds); + static char timestamp[20]; + + sprintf(timestamp, "%04d%02d%02d-%02d%02d%02d", + now->tm_year + 1900, now->tm_mon + 1, now->tm_mday, + now->tm_hour, now->tm_min, now->tm_sec); + + return timestamp; +} + +char *getCurrentTimestamp(void) +{ + return getTimestampFromEpoch(time(NULL)); +} + time_t getFileTimestampEpochSeconds(char *filename) { struct stat file_status; - if (stat(filename, &file_status) != 0) /* cannot stat file */ + if (stat(filename, &file_status) != 0) // cannot stat file return 0; return file_status.st_mtime; } -/* ------------------------------------------------------------------------- */ -/* path manipulation functions */ -/* ------------------------------------------------------------------------- */ +// ---------------------------------------------------------------------------- +// path manipulation functions +// ---------------------------------------------------------------------------- static char *getLastPathSeparatorPtr(char *filename) { char *last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_UNIX); - if (last_separator == NULL) /* also try DOS/Windows variant */ + if (last_separator == NULL) // also try DOS/Windows variant last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_DOS); return last_separator; @@ -650,9 +1037,9 @@ char *getBaseNamePtr(char *filename) char *last_separator = getLastPathSeparatorPtr(filename); if (last_separator != NULL) - return last_separator + 1; /* separator found: strip base path */ + return last_separator + 1; // separator found: strip base path else - return filename; /* no separator found: filename has no path */ + return filename; // no separator found: filename has no path } char *getBaseName(char *filename) @@ -682,7 +1069,7 @@ char *getBasePath(char *filename) char *basepath = getStringCopy(filename); char *last_separator = getLastPathSeparatorPtr(basepath); - /* if no separator was found, use current directory */ + // if no separator was found, use current directory if (last_separator == NULL) { free(basepath); @@ -690,18 +1077,20 @@ char *getBasePath(char *filename) return getStringCopy("."); } - /* separator found: strip basename */ + // separator found: strip basename *last_separator = '\0'; return basepath; } -/* ------------------------------------------------------------------------- */ -/* various string functions */ -/* ------------------------------------------------------------------------- */ +// ---------------------------------------------------------------------------- +// various string functions +// ---------------------------------------------------------------------------- -char *getStringCat2WithSeparator(char *s1, char *s2, char *sep) +char *getStringCat2WithSeparator(const char *s1, + const char *s2, + const char *sep) { if (s1 == NULL || s2 == NULL || sep == NULL) return NULL; @@ -714,7 +1103,10 @@ char *getStringCat2WithSeparator(char *s1, char *s2, char *sep) return complete_string; } -char *getStringCat3WithSeparator(char *s1, char *s2, char *s3, char *sep) +char *getStringCat3WithSeparator(const char *s1, + const char *s2, + const char *s3, + const char *sep) { if (s1 == NULL || s2 == NULL || s3 == NULL || sep == NULL) return NULL; @@ -728,17 +1120,17 @@ char *getStringCat3WithSeparator(char *s1, char *s2, char *s3, char *sep) return complete_string; } -char *getStringCat2(char *s1, char *s2) +char *getStringCat2(const char *s1, const char *s2) { return getStringCat2WithSeparator(s1, s2, ""); } -char *getStringCat3(char *s1, char *s2, char *s3) +char *getStringCat3(const char *s1, const char *s2, const char *s3) { return getStringCat3WithSeparator(s1, s2, s3, ""); } -char *getPath2(char *path1, char *path2) +char *getPath2(const char *path1, const char *path2) { #if defined(PLATFORM_ANDROID) // workaround for reading from assets directory -- skip "." subdirs in path @@ -751,7 +1143,7 @@ char *getPath2(char *path1, char *path2) return getStringCat2WithSeparator(path1, path2, STRING_PATH_SEPARATOR); } -char *getPath3(char *path1, char *path2, char *path3) +char *getPath3(const char *path1, const char *path2, const char *path3) { #if defined(PLATFORM_ANDROID) // workaround for reading from assets directory -- skip "." subdirs in path @@ -779,12 +1171,12 @@ static char *getPngOrPcxIfNotExists(char *filename) return filename; } -char *getImg2(char *path1, char *path2) +char *getImg2(const char *path1, const char *path2) { return getPngOrPcxIfNotExists(getPath2(path1, path2)); } -char *getImg3(char *path1, char *path2, char *path3) +char *getImg3(const char *path1, const char *path2, const char *path3) { return getPngOrPcxIfNotExists(getPath3(path1, path2, path3)); } @@ -828,6 +1220,18 @@ char *getStringCopyNStatic(const char *s, int n) return s_copy; } +char *getStringToUpper(const char *s) +{ + char *s_copy = checked_malloc(strlen(s) + 1); + char *s_ptr = s_copy; + + while (*s) + *s_ptr++ = toupper(*s++); + *s_ptr = '\0'; + + return s_copy; +} + char *getStringToLower(const char *s) { char *s_copy = checked_malloc(strlen(s) + 1); @@ -840,22 +1244,361 @@ char *getStringToLower(const char *s) return s_copy; } -void setString(char **old_value, char *new_value) +static char *getStringVPrint(char *format, va_list ap) { - checked_free(*old_value); + char s[MAX_LINE_LEN]; - *old_value = getStringCopy(new_value); + vsnprintf(s, MAX_LINE_LEN, format, ap); // may truncate output string + + return getStringCopy(s); } -boolean strEqual(char *s1, char *s2) +char *getStringPrint(char *format, ...) { - return (s1 == NULL && s2 == NULL ? TRUE : - s1 == NULL && s2 != NULL ? FALSE : - s1 != NULL && s2 == NULL ? FALSE : - strcmp(s1, s2) == 0); + va_list ap; + char *s; + + va_start(ap, format); + s = getStringVPrint(format, ap); + va_end(ap); + + return s; +} + +void setStringPrint(char **s, char *format, ...) +{ + va_list ap; + + checked_free(*s); + + va_start(ap, format); + *s = getStringVPrint(format, ap); + va_end(ap); +} + +void appendStringPrint(char **s_old, char *format, ...) +{ + va_list ap; + char *s_new; + + va_start(ap, format); + s_new = getStringVPrint(format, ap); + va_end(ap); + + char *s_combined = getStringCat2(*s_old, s_new); + + checked_free(*s_old); + checked_free(s_new); + + *s_old = s_combined; +} + +void setString(char **old_value, const char *new_value) +{ + checked_free(*old_value); + + *old_value = getStringCopy(new_value); +} + +char **getSplitStringArray(const char *s, const char *separators, int max_tokens) +{ + const char *s_ptr, *s_last = s; + byte separator_table[256] = { FALSE }; + int num_tokens; + char **tokens = NULL; + + if (s == NULL) + return NULL; + + if (separators == NULL) + return NULL; + + if (max_tokens < 1) + max_tokens = INT_MAX; + + // if string is empty, return empty array + if (*s == '\0') + { + tokens = checked_malloc(sizeof(char *)); + tokens[0] = NULL; + + return tokens; + } + + // initialize separator table for all characters in separators string + for (s_ptr = separators; *s_ptr != '\0'; s_ptr++) + separator_table[*(byte *)s_ptr] = TRUE; + + // count number of tokens in string + for (num_tokens = 1, s_ptr = s; *s_ptr != '\0'; s_ptr++) + if (separator_table[*(byte *)s_ptr] && num_tokens < max_tokens) + num_tokens++; + + // allocate array for determined number of tokens + tokens = checked_malloc((num_tokens + 1) * sizeof(char *)); + + // copy all but last separated sub-strings to array + for (num_tokens = 0, s_ptr = s; *s_ptr != '\0'; s_ptr++) + { + if (separator_table[*(byte *)s_ptr] && num_tokens + 1 < max_tokens) + { + tokens[num_tokens++] = getStringCopyN(s_last, s_ptr - s_last); + s_last = s_ptr + 1; + } + } + + // copy last separated sub-string to array + tokens[num_tokens++] = getStringCopyN(s_last, s_ptr - s_last); + + // terminate array + tokens[num_tokens] = NULL; + + return tokens; +} + +int getStringArrayLength(char **s_array) +{ + int num_strings = 0; + + if (s_array == NULL) + return 0; + + while (s_array[num_strings] != NULL) + num_strings++; + + return num_strings; +} + +void freeStringArray(char **s_array) +{ + int i; + + if (s_array == NULL) + return; + + for (i = 0; s_array[i] != NULL; i++) + checked_free(s_array[i]); + + checked_free(s_array); +} + +char *getEscapedString(const char *s) +{ + const unsigned char *s_ptr = (unsigned char *)s; + char *s_escaped; + char *s_escaped_ptr; + + if (s == NULL) + return NULL; + + /* Each source byte needs maximally four target chars (\777) */ + s_escaped = checked_malloc(strlen(s) * 4 + 1); + s_escaped_ptr = s_escaped; + + while (*s_ptr != '\0') + { + switch (*s_ptr) + { + case '\b': + *s_escaped_ptr++ = '\\'; + *s_escaped_ptr++ = 'b'; + break; + + case '\f': + *s_escaped_ptr++ = '\\'; + *s_escaped_ptr++ = 'f'; + break; + + case '\n': + *s_escaped_ptr++ = '\\'; + *s_escaped_ptr++ = 'n'; + break; + + case '\r': + *s_escaped_ptr++ = '\\'; + *s_escaped_ptr++ = 'r'; + break; + + case '\t': + *s_escaped_ptr++ = '\\'; + *s_escaped_ptr++ = 't'; + break; + + case '\v': + *s_escaped_ptr++ = '\\'; + *s_escaped_ptr++ = 'v'; + break; + + case '\\': + *s_escaped_ptr++ = '\\'; + *s_escaped_ptr++ = '\\'; + break; + + case '"': + *s_escaped_ptr++ = '\\'; + *s_escaped_ptr++ = '"'; + break; + + default: + if ((*s_ptr < ' ') || (*s_ptr >= 0177)) + { + *s_escaped_ptr++ = '\\'; + *s_escaped_ptr++ = '0' + (((*s_ptr) >> 6) & 07); + *s_escaped_ptr++ = '0' + (((*s_ptr) >> 3) & 07); + *s_escaped_ptr++ = '0' + ( (*s_ptr) & 07); + } + else + { + *s_escaped_ptr++ = *s_ptr; + } + break; + } + + s_ptr++; + } + + *s_escaped_ptr = '\0'; + + return s_escaped; +} + +char *getUnescapedString(const char *s) +{ + const char *s_ptr = s; + const char *octal_ptr; + char *s_unescaped; + char *s_unescaped_ptr; + + if (s == NULL) + return NULL; + + s_unescaped = checked_malloc(strlen(s) + 1); + s_unescaped_ptr = s_unescaped; + + while (*s_ptr != '\0') + { + if (*s_ptr == '\\') + { + s_ptr++; + + switch (*s_ptr) + { + case '\0': + Warn("getUnescapedString: trailing \\"); + goto out; + + case '0': + case '1': + case '2': + case '3': + case '4': + case '5': + case '6': + case '7': + *s_unescaped_ptr = 0; + octal_ptr = s_ptr; + + while (s_ptr < octal_ptr + 3 && *s_ptr >= '0' && *s_ptr <= '7') + { + *s_unescaped_ptr = (*s_unescaped_ptr * 8) + (*s_ptr - '0'); + s_ptr++; + } + + s_unescaped_ptr++; + s_ptr--; + break; + + case 'b': + *s_unescaped_ptr++ = '\b'; + break; + + case 'f': + *s_unescaped_ptr++ = '\f'; + break; + + case 'n': + *s_unescaped_ptr++ = '\n'; + break; + + case 'r': + *s_unescaped_ptr++ = '\r'; + break; + + case 't': + *s_unescaped_ptr++ = '\t'; + break; + + case 'v': + *s_unescaped_ptr++ = '\v'; + break; + + default: + /* also handles \" and \\ */ + *s_unescaped_ptr++ = *s_ptr; + break; + } + } + else + { + *s_unescaped_ptr++ = *s_ptr; + } + + s_ptr++; + } + + out: + *s_unescaped_ptr = '\0'; + + return s_unescaped; +} + +char *chugString(char *s) +{ + if (s == NULL) + return NULL; + + char *start; + + for (start = (char *)s; *start && isspace(*start); start++) + ; + + memmove(s, start, strlen(start) + 1); + + return s; +} + +char *chompString(char *s) +{ + if (s == NULL) + return NULL; + + int len = strlen(s); + + while (len--) + { + if (isspace(s[len])) + s[len] = '\0'; + else + break; + } + + return s; +} + +char *stripString(char *s) +{ + return chugString(chompString(s)); +} + +boolean strEqual(const char *s1, const 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) +boolean strEqualN(const char *s1, const char *s2, int n) { return (s1 == NULL && s2 == NULL ? TRUE : s1 == NULL && s2 != NULL ? FALSE : @@ -863,7 +1606,23 @@ boolean strEqualN(char *s1, char *s2, int n) strncmp(s1, s2, n) == 0); } -boolean strPrefix(char *s, char *prefix) +boolean strEqualCase(const char *s1, const char *s2) +{ + return (s1 == NULL && s2 == NULL ? TRUE : + s1 == NULL && s2 != NULL ? FALSE : + s1 != NULL && s2 == NULL ? FALSE : + strcasecmp(s1, s2) == 0); +} + +boolean strEqualCaseN(const char *s1, const char *s2, int n) +{ + return (s1 == NULL && s2 == NULL ? TRUE : + s1 == NULL && s2 != NULL ? FALSE : + s1 != NULL && s2 == NULL ? FALSE : + strncasecmp(s1, s2, n) == 0); +} + +boolean strPrefix(const char *s, const char *prefix) { return (s == NULL && prefix == NULL ? TRUE : s == NULL && prefix != NULL ? FALSE : @@ -871,16 +1630,16 @@ boolean strPrefix(char *s, char *prefix) strncmp(s, prefix, strlen(prefix)) == 0); } -boolean strSuffix(char *s, char *suffix) +boolean strSuffix(const char *s, const 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); + strcmp(&s[strlen(s) - strlen(suffix)], suffix) == 0); } -boolean strPrefixLower(char *s, char *prefix) +boolean strPrefixLower(const char *s, const char *prefix) { char *s_lower = getStringToLower(s); boolean match = strPrefix(s_lower, prefix); @@ -890,7 +1649,7 @@ boolean strPrefixLower(char *s, char *prefix) return match; } -boolean strSuffixLower(char *s, char *suffix) +boolean strSuffixLower(const char *s, const char *suffix) { char *s_lower = getStringToLower(s); boolean match = strSuffix(s_lower, suffix); @@ -900,39 +1659,54 @@ boolean strSuffixLower(char *s, char *suffix) return match; } +boolean isURL(const char *s) +{ + while (*s && *s >= 'a' && *s <= 'z') + s++; + + return strPrefix(s, "://"); +} -/* ------------------------------------------------------------------------- */ -/* command line option handling functions */ -/* ------------------------------------------------------------------------- */ + +// ---------------------------------------------------------------------------- +// command line option handling functions +// ---------------------------------------------------------------------------- void GetOptions(int argc, char *argv[], void (*print_usage_function)(void), void (*print_version_function)(void)) { - char *ro_base_path = getProgramMainDataPath(argv[0], RO_BASE_PATH); - char *rw_base_path = getProgramMainDataPath(argv[0], RW_BASE_PATH); + char *base_path = getProgramMainDataPath(argv[0], BASE_PATH); char **argvplus = checked_calloc((argc + 1) * sizeof(char **)); char **options_left = &argvplus[1]; - /* replace original "argv" with null-terminated array of string pointers */ + // replace original "argv" with null-terminated array of string pointers while (argc--) argvplus[argc] = argv[argc]; - /* initialize global program options */ + // initialize global program options options.server_host = NULL; options.server_port = 0; - options.ro_base_directory = ro_base_path; - options.rw_base_directory = rw_base_path; - options.level_directory = getPath2(ro_base_path, LEVELS_DIRECTORY); - options.graphics_directory = getPath2(ro_base_path, GRAPHICS_DIRECTORY); - options.sounds_directory = getPath2(ro_base_path, SOUNDS_DIRECTORY); - options.music_directory = getPath2(ro_base_path, MUSIC_DIRECTORY); - options.docs_directory = getPath2(ro_base_path, DOCS_DIRECTORY); - options.conf_directory = getPath2(ro_base_path, CONF_DIRECTORY); + options.base_directory = base_path; + + options.level_directory = getPath2(base_path, LEVELS_DIRECTORY); + options.graphics_directory = getPath2(base_path, GRAPHICS_DIRECTORY); + options.sounds_directory = getPath2(base_path, SOUNDS_DIRECTORY); + options.music_directory = getPath2(base_path, MUSIC_DIRECTORY); + options.docs_directory = getPath2(base_path, DOCS_DIRECTORY); + options.conf_directory = getPath2(base_path, CONF_DIRECTORY); options.execute_command = NULL; + options.tape_log_filename = NULL; options.special_flags = NULL; + options.debug_mode = NULL; + options.player_name = NULL; + options.identifier = NULL; + options.level_nr = NULL; + options.drop_file = NULL; + + options.display_nr = 0; options.mytapes = FALSE; options.serveronly = FALSE; @@ -944,7 +1718,7 @@ void GetOptions(int argc, char *argv[], options.verbose = TRUE; #else #if !defined(PLATFORM_UNIX) - if (*options_left == NULL) /* no options given -- enable verbose mode */ + if (*options_left == NULL) // no options given -- enable verbose mode options.verbose = TRUE; #endif #endif @@ -964,32 +1738,32 @@ void GetOptions(int argc, char *argv[], int option_len = strlen(option); if (option_len >= MAX_OPTION_LEN) - Error(ERR_EXIT_HELP, "unrecognized option '%s'", option); + FailWithHelp("unrecognized option '%s'", option); - strcpy(option_str, option); /* copy argument into buffer */ + strcpy(option_str, option); // copy argument into buffer option = option_str; - if (strEqual(option, "--")) /* stop scanning arguments */ + if (strEqual(option, "--")) // stop scanning arguments break; - if (strPrefix(option, "--")) /* treat '--' like '-' */ + if (strPrefix(option, "--")) // treat '--' like '-' option++; option_arg = strchr(option, '='); - if (option_arg == NULL) /* no '=' in option */ + if (option_arg == NULL) // no '=' in option option_arg = next_option; else { - *option_arg++ = '\0'; /* cut argument from option */ - if (*option_arg == '\0') /* no argument after '=' */ - Error(ERR_EXIT_HELP, "option '%s' has invalid argument", option_str); + *option_arg++ = '\0'; // cut argument from option + if (*option_arg == '\0') // no argument after '=' + FailWithHelp("option '%s' has invalid argument", option_str); } option_len = strlen(option); if (strEqual(option, "-")) { - Error(ERR_EXIT_HELP, "unrecognized option '%s'", option); + FailWithHelp("unrecognized option '%s'", option); } else if (strncmp(option, "-help", option_len) == 0) { @@ -1000,55 +1774,53 @@ void GetOptions(int argc, char *argv[], else if (strncmp(option, "-basepath", option_len) == 0) { if (option_arg == NULL) - Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str); + FailWithHelp("option '%s' requires an argument", option_str); - /* this should be extended to separate options for ro and rw data */ - options.ro_base_directory = ro_base_path = option_arg; - options.rw_base_directory = rw_base_path = option_arg; + options.base_directory = base_path = getStringCopy(option_arg); if (option_arg == next_option) options_left++; - /* adjust paths for sub-directories in base directory accordingly */ - options.level_directory = getPath2(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.conf_directory = getPath2(ro_base_path, CONF_DIRECTORY); + // adjust paths for sub-directories in base directory accordingly + options.level_directory = getPath2(base_path, LEVELS_DIRECTORY); + options.graphics_directory = getPath2(base_path, GRAPHICS_DIRECTORY); + options.sounds_directory = getPath2(base_path, SOUNDS_DIRECTORY); + options.music_directory = getPath2(base_path, MUSIC_DIRECTORY); + options.docs_directory = getPath2(base_path, DOCS_DIRECTORY); + options.conf_directory = getPath2(base_path, CONF_DIRECTORY); } else if (strncmp(option, "-levels", option_len) == 0) { if (option_arg == NULL) - Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str); + FailWithHelp("option '%s' requires an argument", option_str); - options.level_directory = option_arg; + options.level_directory = getStringCopy(option_arg); if (option_arg == next_option) options_left++; } else if (strncmp(option, "-graphics", option_len) == 0) { if (option_arg == NULL) - Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str); + FailWithHelp("option '%s' requires an argument", option_str); - options.graphics_directory = option_arg; + options.graphics_directory = getStringCopy(option_arg); if (option_arg == next_option) options_left++; } else if (strncmp(option, "-sounds", option_len) == 0) { if (option_arg == NULL) - Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str); + FailWithHelp("option '%s' requires an argument", option_str); - options.sounds_directory = option_arg; + options.sounds_directory = getStringCopy(option_arg); if (option_arg == next_option) options_left++; } else if (strncmp(option, "-music", option_len) == 0) { if (option_arg == NULL) - Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str); + FailWithHelp("option '%s' requires an argument", option_str); - options.music_directory = option_arg; + options.music_directory = getStringCopy(option_arg); if (option_arg == next_option) options_left++; } @@ -1067,6 +1839,46 @@ void GetOptions(int argc, char *argv[], else if (strncmp(option, "-debug", option_len) == 0) { options.debug = TRUE; + + // optionally, debug output can be limited to a specific debug mode + if (option_arg != next_option) + options.debug_mode = getStringCopy(option_arg); + } + else if (strncmp(option, "-player-name", option_len) == 0) + { + if (option_arg == NULL) + FailWithHelp("option '%s' requires an argument", option_str); + + options.player_name = getStringCopy(option_arg); + if (option_arg == next_option) + options_left++; + } + else if (strncmp(option, "-identifier", option_len) == 0) + { + if (option_arg == NULL) + FailWithHelp("option '%s' requires an argument", option_str); + + options.identifier = getStringCopy(option_arg); + if (option_arg == next_option) + options_left++; + } + else if (strncmp(option, "-level-nr", option_len) == 0) + { + if (option_arg == NULL) + FailWithHelp("option '%s' requires an argument", option_str); + + options.level_nr = getStringCopy(option_arg); + if (option_arg == next_option) + options_left++; + } + else if (strncmp(option, "-drop-file", option_len) == 0) + { + if (option_arg == NULL) + FailWithHelp("option '%s' requires an argument", option_str); + + options.drop_file = getStringCopy(option_arg); + if (option_arg == next_option) + options_left++; } else if (strncmp(option, "-verbose", option_len) == 0) { @@ -1086,24 +1898,55 @@ void GetOptions(int argc, char *argv[], else if (strncmp(option, "-execute", option_len) == 0) { if (option_arg == NULL) - Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str); + FailWithHelp("option '%s' requires an argument", option_str); - options.execute_command = option_arg; + options.execute_command = getStringCopy(option_arg); if (option_arg == next_option) options_left++; - /* when doing batch processing, always enable verbose mode (warnings) */ + // when doing batch processing, always enable verbose mode (warnings) options.verbose = TRUE; } -#if defined(PLATFORM_MACOSX) + else if (strncmp(option, "-tape_logfile", option_len) == 0) + { + if (option_arg == NULL) + FailWithHelp("option '%s' requires an argument", option_str); + + options.tape_log_filename = getStringCopy(option_arg); + if (option_arg == next_option) + options_left++; + } + else if (strncmp(option, "-display", option_len) == 0) + { + if (option_arg == NULL) + FailWithHelp("option '%s' requires an argument", option_str); + + if (option_arg == next_option) + options_left++; + + int display_nr = atoi(option_arg); + +#if 1 + // dirty hack: SDL_GetNumVideoDisplays() seems broken on some systems + options.display_nr = display_nr; +#else + options.display_nr = + MAX(0, MIN(display_nr, SDL_GetNumVideoDisplays() - 1)); + + if (display_nr != options.display_nr) + Warn("invalid display %d -- using display %d", + display_nr, options.display_nr); +#endif + } +#if defined(PLATFORM_MAC) else if (strPrefix(option, "-psn")) { - /* ignore process serial number when launched via GUI on Mac OS X */ + // ignore process serial number when launched via GUI on Mac OS X } #endif else if (*option == '-') { - Error(ERR_EXIT_HELP, "unrecognized option '%s'", option_str); + FailWithHelp("unrecognized option '%s'", option_str); } else if (options.server_host == NULL) { @@ -1113,128 +1956,19 @@ void GetOptions(int argc, char *argv[], { options.server_port = atoi(*options_left); if (options.server_port < 1024) - Error(ERR_EXIT_HELP, "bad port number '%d'", options.server_port); + FailWithHelp("bad port number '%d'", options.server_port); } else - Error(ERR_EXIT_HELP, "too many arguments"); + FailWithHelp("too many arguments"); options_left++; } } -/* ------------------------------------------------------------------------- */ -/* 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(void) -{ - return internal_error; -} - -void Error(int mode, char *format, ...) -{ - static boolean last_line_was_separator = FALSE; - char *process_name = ""; - - if (program.log_file[LOG_ERR_ID] == NULL) - return; - -#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 debug messages only when running in debug mode */ - if (mode & ERR_DEBUG && !options.debug) - return; - - /* display warnings only when running in verbose mode */ - if (mode & ERR_WARN && !options.verbose) - return; - - if (mode == ERR_INFO_LINE) - { - if (!last_line_was_separator) - printf_log_line(format, 79); - - last_line_was_separator = TRUE; - - return; - } - - last_line_was_separator = FALSE; - - if (mode & ERR_SOUND_SERVER) - process_name = " sound server"; - else if (mode & ERR_NETWORK_SERVER) - process_name = " network server"; - else if (mode & ERR_NETWORK_CLIENT) - process_name = " network client **"; - - if (format) - { -#if !defined(PLATFORM_ANDROID) - printf_log_nonewline("%s%s: ", program.command_basename, process_name); -#endif - - if (mode & ERR_WARN) - printf_log_nonewline("warning: "); - - if (mode & ERR_EXIT) - printf_log_nonewline("fatal error: "); - - va_list ap; - - va_start(ap, format); - vprintf_log(format, ap); - va_end(ap); - - 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) - printf_log("%s: Try option '--help' for more information.", - program.command_basename); - - if (mode & ERR_EXIT) - printf_log("%s%s: aborting", program.command_basename, process_name); - - if (mode & ERR_EXIT) - { - if (mode & ERR_FROM_SERVER) - exit(1); /* child process: normal exit */ - else - program.exit_function(1); /* main process: clean up stuff */ - } -} - - -/* ------------------------------------------------------------------------- */ -/* checked memory allocation and freeing functions */ -/* ------------------------------------------------------------------------- */ +// ---------------------------------------------------------------------------- +// checked memory allocation and freeing functions +// ---------------------------------------------------------------------------- void *checked_malloc(unsigned int size) { @@ -1243,7 +1977,7 @@ void *checked_malloc(unsigned int size) ptr = malloc(size); if (ptr == NULL) - Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size); + Fail("cannot allocate %d bytes -- out of memory", size); return ptr; } @@ -1255,7 +1989,7 @@ void *checked_calloc(unsigned int size) ptr = calloc(1, size); if (ptr == NULL) - Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size); + Fail("cannot allocate %d bytes -- out of memory", size); return ptr; } @@ -1265,21 +1999,21 @@ void *checked_realloc(void *ptr, unsigned int size) ptr = realloc(ptr, size); if (ptr == NULL) - Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size); + Fail("cannot allocate %d bytes -- out of memory", size); return ptr; } void checked_free(void *ptr) { - if (ptr != NULL) /* this check should be done by free() anyway */ + 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 */ +#if defined(PLATFORM_WINDOWS) + // for unknown reason, memset() sometimes crashes when compiled with MinGW char *cptr = (char *)ptr; while (size--) @@ -1289,10 +2023,23 @@ void clear_mem(void *ptr, unsigned int size) #endif } +void *get_memcpy(const void *m, size_t size) +{ + void *m_copy; -/* ------------------------------------------------------------------------- */ -/* various helper functions */ -/* ------------------------------------------------------------------------- */ + if (m == NULL) + return NULL; + + m_copy = checked_malloc(size); + memcpy(m_copy, m, size); + + return m_copy; +} + + +// ---------------------------------------------------------------------------- +// various helper functions +// ---------------------------------------------------------------------------- void swap_numbers(int *i1, int *i2) { @@ -1310,8 +2057,33 @@ void swap_number_pairs(int *x1, int *y1, int *x2, int *y2) *x1 = *x2; *x2 = help_x; - *y1 = *y2; - *y2 = help_y; + *y1 = *y2; + *y2 = help_y; +} + +int get_number_of_bits(int bits) +{ + /* + Counting bits set, Brian Kernighan's way + + Brian Kernighan's method goes through as many iterations as there are set + bits. So if we have a 32-bit word with only the high bit set, then it will + only go once through the loop. + + Published in 1988, the C Programming Language 2nd Ed. (by Brian W. Kernighan + and Dennis M. Ritchie) mentions this in exercise 2-9. + First published by Peter Wegner in CACM 3 (1960), 322. + */ + + int num_bits = 0; + + while (bits) + { + bits &= bits - 1; // clear the least significant bit set + num_bits++; + } + + return num_bits; } /* the "put" variants of the following file access functions check for the file @@ -1338,7 +2110,7 @@ int getFile16BitInteger(File *file, int byte_order) if (byte_order == BYTE_ORDER_BIG_ENDIAN) return ((getByteFromFile(file) << 8) | (getByteFromFile(file) << 0)); - else /* BYTE_ORDER_LITTLE_ENDIAN */ + else // BYTE_ORDER_LITTLE_ENDIAN return ((getByteFromFile(file) << 0) | (getByteFromFile(file) << 8)); } @@ -1352,7 +2124,7 @@ int putFile16BitInteger(FILE *file, int value, int byte_order) fputc((value >> 8) & 0xff, file); fputc((value >> 0) & 0xff, file); } - else /* BYTE_ORDER_LITTLE_ENDIAN */ + else // BYTE_ORDER_LITTLE_ENDIAN { fputc((value >> 0) & 0xff, file); fputc((value >> 8) & 0xff, file); @@ -1369,7 +2141,7 @@ int getFile32BitInteger(File *file, int byte_order) (getByteFromFile(file) << 16) | (getByteFromFile(file) << 8) | (getByteFromFile(file) << 0)); - else /* BYTE_ORDER_LITTLE_ENDIAN */ + else // BYTE_ORDER_LITTLE_ENDIAN return ((getByteFromFile(file) << 0) | (getByteFromFile(file) << 8) | (getByteFromFile(file) << 16) | @@ -1387,7 +2159,7 @@ int putFile32BitInteger(FILE *file, int value, int byte_order) fputc((value >> 8) & 0xff, file); fputc((value >> 0) & 0xff, file); } - else /* BYTE_ORDER_LITTLE_ENDIAN */ + else // BYTE_ORDER_LITTLE_ENDIAN { fputc((value >> 0) & 0xff, file); fputc((value >> 8) & 0xff, file); @@ -1404,13 +2176,13 @@ boolean getFileChunk(File *file, char *chunk_name, int *chunk_size, { const int chunk_name_length = 4; - /* read chunk name */ + // read chunk name if (getStringFromFile(file, chunk_name, chunk_name_length + 1) == NULL) return FALSE; if (chunk_size != NULL) { - /* read chunk size */ + // read chunk size *chunk_size = getFile32BitInteger(file, byte_order); } @@ -1422,7 +2194,7 @@ int putFileChunk(FILE *file, char *chunk_name, int chunk_size, { int num_bytes = 0; - /* write chunk name */ + // write chunk name if (file != NULL) fputs(chunk_name, file); @@ -1430,7 +2202,7 @@ int putFileChunk(FILE *file, char *chunk_name, int chunk_size, if (chunk_size >= 0) { - /* write chunk size */ + // write chunk size if (file != NULL) putFile32BitInteger(file, chunk_size, byte_order); @@ -1481,7 +2253,7 @@ void WriteBytesToFile(FILE *file, byte *buffer, unsigned int bytes) { int i; - for(i = 0; i < bytes; i++) + for (i = 0; i < bytes; i++) fputc(buffer[i], file); } @@ -1498,9 +2270,228 @@ void WriteUnusedBytesToFile(FILE *file, unsigned int bytes) } -/* ------------------------------------------------------------------------- */ -/* functions to translate key identifiers between different format */ -/* ------------------------------------------------------------------------- */ +// ---------------------------------------------------------------------------- +// functions to convert between ISO-8859-1 and UTF-8 +// ---------------------------------------------------------------------------- + +char *getUTF8FromLatin1(char *latin1) +{ + int max_utf8_size = 2 * strlen(latin1) + 1; + char *utf8 = checked_calloc(max_utf8_size); + unsigned char *src = (unsigned char *)latin1; + unsigned char *dst = (unsigned char *)utf8; + + while (*src) + { + if (*src < 128) // pure 7-bit ASCII + { + *dst++ = *src; + } + else if (*src >= 160) // non-ASCII characters + { + *dst++ = 194 + (*src >= 192); + *dst++ = 128 + (*src & 63); + } + else // undefined in ISO-8859-1 + { + *dst++ = '?'; + } + + src++; + } + + // only use the smallest possible string buffer size + utf8 = checked_realloc(utf8, strlen(utf8) + 1); + + return utf8; +} + +char *getLatin1FromUTF8(char *utf8) +{ + int max_latin1_size = strlen(utf8) + 1; + char *latin1 = checked_calloc(max_latin1_size); + unsigned char *src = (unsigned char *)utf8; + unsigned char *dst = (unsigned char *)latin1; + + while (*src) + { + if (*src < 128) // pure 7-bit ASCII + { + *dst++ = *src++; + } + else if (src[0] == 194 && + src[1] >= 128 && src[1] < 192) // non-ASCII characters + { + *dst++ = src[1]; + src += 2; + } + else if (src[0] == 195 && + src[1] >= 128 && src[1] < 192) // non-ASCII characters + { + *dst++ = src[1] + 64; + src += 2; + } + + // all other UTF-8 characters are undefined in ISO-8859-1 + + else if (src[0] >= 192 && src[0] < 224 && + src[1] >= 128 && src[1] < 192) + { + *dst++ = '?'; + src += 2; + } + else if (src[0] >= 224 && src[0] < 240 && + src[1] >= 128 && src[1] < 192 && + src[2] >= 128 && src[2] < 192) + { + *dst++ = '?'; + src += 3; + } + else if (src[0] >= 240 && src[0] < 248 && + src[1] >= 128 && src[1] < 192 && + src[2] >= 128 && src[2] < 192 && + src[3] >= 128 && src[3] < 192) + { + *dst++ = '?'; + src += 4; + } + else if (src[0] >= 248 && src[0] < 252 && + src[1] >= 128 && src[1] < 192 && + src[2] >= 128 && src[2] < 192 && + src[3] >= 128 && src[3] < 192 && + src[4] >= 128 && src[4] < 192) + { + *dst++ = '?'; + src += 5; + } + else if (src[0] >= 252 && src[0] < 254 && + src[1] >= 128 && src[1] < 192 && + src[2] >= 128 && src[2] < 192 && + src[3] >= 128 && src[3] < 192 && + src[4] >= 128 && src[4] < 192 && + src[5] >= 128 && src[5] < 192) + { + *dst++ = '?'; + src += 6; + } + else + { + *dst++ = '?'; + src++; + } + } + + // only use the smallest possible string buffer size + latin1 = checked_realloc(latin1, strlen(latin1) + 1); + + return latin1; +} + +int getTextEncoding(char *text) +{ + unsigned char *src = (unsigned char *)text; + int encoding = TEXT_ENCODING_ASCII; // default: assume encoding is ASCII + + while (*src) + { + if (*src >= 128) + encoding = TEXT_ENCODING_UTF_8; // non-ASCII character: assume UTF-8 + + if (*src < 128) + { + src++; + } + else if (src[0] >= 192 && src[0] < 224 && + src[1] >= 128 && src[1] < 192) + { + src += 2; + } + else if (src[0] >= 224 && src[0] < 240 && + src[1] >= 128 && src[1] < 192 && + src[2] >= 128 && src[2] < 192) + { + src += 3; + } + else if (src[0] >= 240 && src[0] < 248 && + src[1] >= 128 && src[1] < 192 && + src[2] >= 128 && src[2] < 192 && + src[3] >= 128 && src[3] < 192) + { + src += 4; + } + else if (src[0] >= 248 && src[0] < 252 && + src[1] >= 128 && src[1] < 192 && + src[2] >= 128 && src[2] < 192 && + src[3] >= 128 && src[3] < 192 && + src[4] >= 128 && src[4] < 192) + { + src += 5; + } + else if (src[0] >= 252 && src[0] < 254 && + src[1] >= 128 && src[1] < 192 && + src[2] >= 128 && src[2] < 192 && + src[3] >= 128 && src[3] < 192 && + src[4] >= 128 && src[4] < 192 && + src[5] >= 128 && src[5] < 192) + { + src += 6; + } + else + { + return TEXT_ENCODING_UNKNOWN; // non-UTF-8 character: unknown encoding + } + } + + return encoding; +} + + +// ---------------------------------------------------------------------------- +// functions for JSON handling +// ---------------------------------------------------------------------------- + +char *getEscapedJSON(char *s) +{ + int max_json_size = 2 * strlen(s) + 1; + char *json = checked_calloc(max_json_size); + unsigned char *src = (unsigned char *)s; + unsigned char *dst = (unsigned char *)json; + char *escaped[256] = + { + ['\b'] = "\\b", + ['\f'] = "\\f", + ['\n'] = "\\n", + ['\r'] = "\\r", + ['\t'] = "\\t", + ['\"'] = "\\\"", + ['\\'] = "\\\\", + }; + + while (*src) + { + if (escaped[*src] != NULL) + { + char *esc = escaped[*src++]; + + while (*esc) + *dst++ = *esc++; + } + else + { + *dst++ = *src++; + } + } + + // only use the smallest possible string buffer size + json = checked_realloc(json, strlen(json) + 1); + + return json; +} + + +// ---------------------------------------------------------------------------- +// functions to translate key identifiers between different format +// ---------------------------------------------------------------------------- #define TRANSLATE_KEYSYM_TO_KEYNAME 0 #define TRANSLATE_KEYSYM_TO_X11KEYNAME 1 @@ -1516,17 +2507,17 @@ static void translate_keyname(Key *keysym, char **x11name, char **name, int mode char *name; } translate_key[] = { - /* return and escape keys */ + // return and escape keys { KSYM_Return, "XK_Return", "return" }, { KSYM_Escape, "XK_Escape", "escape" }, - /* normal cursor keys */ + // normal cursor keys { KSYM_Left, "XK_Left", "cursor left" }, { KSYM_Right, "XK_Right", "cursor right" }, { KSYM_Up, "XK_Up", "cursor up" }, { KSYM_Down, "XK_Down", "cursor down" }, - /* keypad cursor keys */ + // keypad cursor keys #ifdef KSYM_KP_Left { KSYM_KP_Left, "XK_KP_Left", "keypad left" }, { KSYM_KP_Right, "XK_KP_Right", "keypad right" }, @@ -1534,7 +2525,7 @@ static void translate_keyname(Key *keysym, char **x11name, char **name, int mode { KSYM_KP_Down, "XK_KP_Down", "keypad down" }, #endif - /* other keypad keys */ + // other keypad keys #ifdef KSYM_KP_Enter { KSYM_KP_Enter, "XK_KP_Enter", "keypad enter" }, { KSYM_KP_Add, "XK_KP_Add", "keypad +" }, @@ -1544,7 +2535,7 @@ static void translate_keyname(Key *keysym, char **x11name, char **name, int mode { KSYM_KP_Separator,"XK_KP_Separator", "keypad ," }, #endif - /* modifier keys */ + // modifier keys { KSYM_Shift_L, "XK_Shift_L", "left shift" }, { KSYM_Shift_R, "XK_Shift_R", "right shift" }, { KSYM_Control_L, "XK_Control_L", "left control" }, @@ -1553,14 +2544,10 @@ static 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 */ + { KSYM_Mode_switch, "XK_Mode_switch", "mode switch" }, // Alt-R + { KSYM_Multi_key, "XK_Multi_key", "multi key" }, // Ctrl-R - /* some special keys */ + // some special keys { KSYM_BackSpace, "XK_BackSpace", "backspace" }, { KSYM_Delete, "XK_Delete", "delete" }, { KSYM_Insert, "XK_Insert", "insert" }, @@ -1570,18 +2557,16 @@ static void translate_keyname(Key *keysym, char **x11name, char **name, int mode { KSYM_Page_Up, "XK_Page_Up", "page up" }, { KSYM_Page_Down, "XK_Page_Down", "page down" }, -#if defined(TARGET_SDL2) { KSYM_Select, "XK_Select", "select" }, - { KSYM_Menu, "XK_Menu", "menu" }, /* menu key */ - { KSYM_Back, "XK_Back", "back" }, /* back key */ + { KSYM_Menu, "XK_Menu", "menu" }, // menu key + { KSYM_Back, "XK_Back", "back" }, // back key { KSYM_PlayPause, "XK_PlayPause", "play/pause" }, #if defined(PLATFORM_ANDROID) { KSYM_Rewind, "XK_Rewind", "rewind" }, { KSYM_FastForward, "XK_FastForward", "fast forward" }, -#endif #endif - /* ASCII 0x20 to 0x40 keys (except numbers) */ + // ASCII 0x20 to 0x40 keys (except numbers) { KSYM_space, "XK_space", "space" }, { KSYM_exclam, "XK_exclam", "!" }, { KSYM_quotedbl, "XK_quotedbl", "\"" }, @@ -1606,7 +2591,7 @@ static void translate_keyname(Key *keysym, char **x11name, char **name, int mode { KSYM_question, "XK_question", "?" }, { KSYM_at, "XK_at", "@" }, - /* more ASCII keys */ + // more ASCII keys { KSYM_bracketleft, "XK_bracketleft", "[" }, { KSYM_backslash, "XK_backslash", "\\" }, { KSYM_bracketright,"XK_bracketright", "]" }, @@ -1619,7 +2604,7 @@ static void translate_keyname(Key *keysym, char **x11name, char **name, int mode { KSYM_braceright, "XK_braceright", "brace right" }, { KSYM_asciitilde, "XK_asciitilde", "~" }, - /* special (non-ASCII) keys */ + // special (non-ASCII) keys { KSYM_degree, "XK_degree", "degree" }, { KSYM_Adiaeresis, "XK_Adiaeresis", "A umlaut" }, { KSYM_Odiaeresis, "XK_Odiaeresis", "O umlaut" }, @@ -1629,8 +2614,7 @@ static void translate_keyname(Key *keysym, char **x11name, char **name, int mode { KSYM_udiaeresis, "XK_udiaeresis", "u umlaut" }, { KSYM_ssharp, "XK_ssharp", "sharp s" }, -#if defined(TARGET_SDL2) - /* special (non-ASCII) keys (UTF-8, for reverse mapping only) */ + // 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" }, @@ -1640,12 +2624,10 @@ static void translate_keyname(Key *keysym, char **x11name, char **name, int mode { KSYM_udiaeresis, "XK_udiaeresis", "\xc3\xbc" }, { KSYM_ssharp, "XK_ssharp", "\xc3\x9f" }, - /* other keys (for reverse mapping only) */ + // other keys (for reverse mapping only) { KSYM_space, "XK_space", " " }, -#endif -#if defined(TARGET_SDL2) - /* keypad keys are not in numerical order in 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" }, @@ -1656,9 +2638,8 @@ static void translate_keyname(Key *keysym, char **x11name, char **name, int mode { 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 */ + // end-of-array identifier { 0, NULL, NULL } }; @@ -1675,10 +2656,6 @@ static 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)); -#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) @@ -1714,10 +2691,6 @@ static 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)); -#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) @@ -1775,7 +2748,7 @@ static void translate_keyname(Key *keysym, char **x11name, char **name, int mode } if (key == KSYM_UNDEFINED) - Error(ERR_WARN, "getKeyFromKeyName(): not completely implemented"); + Warn("getKeyFromKeyName(): not completely implemented"); *keysym = key; } @@ -1795,15 +2768,6 @@ static void translate_keyname(Key *keysym, char **x11name, char **name, int mode else if (c >= '0' && c <= '9') key = KSYM_0 + (Key)(c - '0'); } -#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_KP_0 + (Key)(c - '0'); - } -#endif else if (strPrefix(name_ptr, "XK_F") && strlen(name_ptr) <= 6) { char c1 = name_ptr[4]; @@ -1906,7 +2870,7 @@ char getCharFromKey(Key key) byte key_char; } translate_key_char[] = { - /* special (non-ASCII) keys (ISO-8859-1) */ + // special (non-ASCII) keys (ISO-8859-1) { KSYM_degree, CHAR_BYTE_DEGREE }, { KSYM_Adiaeresis, CHAR_BYTE_UMLAUT_A }, { KSYM_Odiaeresis, CHAR_BYTE_UMLAUT_O }, @@ -1916,7 +2880,7 @@ char getCharFromKey(Key key) { KSYM_udiaeresis, CHAR_BYTE_UMLAUT_u }, { KSYM_ssharp, CHAR_BYTE_SHARP_S }, - /* end-of-array identifier */ + // end-of-array identifier { 0, 0 } }; @@ -1948,61 +2912,37 @@ char getCharFromKey(Key key) char getValidConfigValueChar(char c) { - if (c == '#' || /* used to mark comments */ - c == '\\') /* used to mark continued lines */ + 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 */ -/* ------------------------------------------------------------------------- */ +// ---------------------------------------------------------------------------- +// 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 }, - }; + // check for the most common case first + if (s[0] >= '0' && s[0] <= '9') + return atoi(s); - int i, j; char *s_lower = getStringToLower(s); int result = -1; - for (i = 0; number_text[i][0] != NULL; i++) - for (j = 0; j < 3; j++) - if (strEqual(s_lower, number_text[i][j])) - result = i; - - if (result == -1) - { - 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); - } + 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); @@ -2025,7 +2965,7 @@ boolean get_boolean_from_string(char *s) return result; } -int get_switch3_from_string(char *s) +int get_switch_3_state_from_string(char *s) { char *s_lower = getStringToLower(s); int result = FALSE; @@ -2036,7 +2976,9 @@ int get_switch3_from_string(char *s) get_integer_from_string(s) == 1) result = TRUE; else if (strEqual(s_lower, "auto")) - result = AUTO; + result = STATE_AUTO; + else if (strEqual(s_lower, "ask")) + result = STATE_ASK; free(s_lower); @@ -2069,9 +3011,9 @@ int get_player_nr_from_string(char *s) } -/* ------------------------------------------------------------------------- */ -/* functions for generic lists */ -/* ------------------------------------------------------------------------- */ +// ---------------------------------------------------------------------------- +// functions for generic lists +// ---------------------------------------------------------------------------- ListNode *newListNode(void) { @@ -2152,23 +3094,23 @@ static void dumpList(ListNode *node_first) while (node) { - printf("['%s' (%d)]\n", node->key, - ((struct ListNodeInfo *)node->content)->num_references); + Debug("internal:dumpList", "['%s' (%d)]", node->key, + ((struct ListNodeInfo *)node->content)->num_references); node = node->next; } - printf("[%d nodes]\n", getNumNodes(node_first)); + Debug("internal:dumpList", "[%d nodes]", getNumNodes(node_first)); } #endif -/* ------------------------------------------------------------------------- */ -/* functions for file handling */ -/* ------------------------------------------------------------------------- */ +// ---------------------------------------------------------------------------- +// functions for file handling +// ---------------------------------------------------------------------------- #define MAX_BUFFER_SIZE 4096 -File *openFile(char *filename, char *mode) +File *openFile(const char *filename, const char *mode) { File *file = checked_calloc(sizeof(File)); @@ -2324,7 +3266,7 @@ char *getStringFromFile(File *file, char *line, int size) return fgets(line, size, file->file); } -int copyFile(char *filename_from, char *filename_to) +int copyFile(const char *filename_from, const char *filename_to) { File *file_from, *file_to; @@ -2354,10 +3296,26 @@ int copyFile(char *filename_from, char *filename_to) return 0; } +boolean touchFile(const char *filename) +{ + FILE *file; + + if (!(file = fopen(filename, MODE_WRITE))) + { + Warn("cannot touch file '%s'", filename); + + return FALSE; + } + + fclose(file); + + return TRUE; +} + -/* ------------------------------------------------------------------------- */ -/* functions for directory handling */ -/* ------------------------------------------------------------------------- */ +// ---------------------------------------------------------------------------- +// functions for directory handling +// ---------------------------------------------------------------------------- Directory *openDirectory(char *dir_name) { @@ -2491,11 +3449,11 @@ void freeDirectoryEntry(DirectoryEntry *dir_entry) } -/* ------------------------------------------------------------------------- */ -/* functions for checking files and filenames */ -/* ------------------------------------------------------------------------- */ +// ---------------------------------------------------------------------------- +// functions for checking files and filenames +// ---------------------------------------------------------------------------- -boolean directoryExists(char *dir_name) +boolean directoryExists(const char *dir_name) { if (dir_name == NULL) return FALSE; @@ -2523,7 +3481,7 @@ boolean directoryExists(char *dir_name) return success; } -boolean fileExists(char *filename) +boolean fileExists(const char *filename) { if (filename == NULL) return FALSE; @@ -2547,7 +3505,7 @@ boolean fileExists(char *filename) } #if 0 -static boolean fileHasPrefix(char *basename, char *prefix) +static boolean fileHasPrefix(const char *basename, const char *prefix) { static char *basename_lower = NULL; int basename_length, prefix_length; @@ -2570,7 +3528,7 @@ static boolean fileHasPrefix(char *basename, char *prefix) } #endif -static boolean fileHasSuffix(char *basename, char *suffix) +static boolean fileHasSuffix(const char *basename, const char *suffix) { static char *basename_lower = NULL; int basename_length, suffix_length; @@ -2628,17 +3586,28 @@ boolean FileIsArtworkType(char *filename, int type) return FALSE; } -/* ------------------------------------------------------------------------- */ -/* functions for loading artwork configuration information */ -/* ------------------------------------------------------------------------- */ +// ---------------------------------------------------------------------------- +// functions for loading artwork configuration information +// ---------------------------------------------------------------------------- char *get_mapped_token(char *token) { - /* !!! make this dynamically configurable (init.c:InitArtworkConfig) !!! */ + // !!! make this dynamically configurable (init.c:InitArtworkConfig) !!! static char *map_token_prefix[][2] = { - { "char_procent", "char_percent" }, - { NULL, } + { "char_procent", "char_percent" }, + { "bd_magic_wall_filling", "bd_magic_wall.filling" }, + { "bd_magic_wall_emptying", "bd_magic_wall.emptying" }, + { "bd_butterfly_left", "bd_butterfly.left" }, + { "bd_butterfly_right", "bd_butterfly.right" }, + { "bd_butterfly_up", "bd_butterfly.up" }, + { "bd_butterfly_down", "bd_butterfly.down" }, + { "bd_firefly_left", "bd_firefly.left" }, + { "bd_firefly_right", "bd_firefly.right" }, + { "bd_firefly_up", "bd_firefly.up" }, + { "bd_firefly_down", "bd_firefly.down" }, + + { NULL, } }; int i; @@ -2677,7 +3646,7 @@ char *get_mapped_token(char *token) static char *get_special_base_token(struct ArtworkListInfo *artwork_info, char *token) { - /* !!! make this dynamically configurable (init.c:InitArtworkConfig) !!! */ + // !!! make this dynamically configurable (init.c:InitArtworkConfig) !!! static struct ConfigTypeInfo prefix_list[] = { { "global.anim_1" }, @@ -2720,7 +3689,7 @@ static char *get_special_base_token(struct ArtworkListInfo *artwork_info, int len_suffix = 0; int i; - /* search for prefix to check if base token has to be created */ + // search for prefix to check if base token has to be created for (i = 0; prefix_list[i].token != NULL; i++) if (strPrefix(token, prefix_list[i].token)) prefix_found = TRUE; @@ -2728,7 +3697,7 @@ static char *get_special_base_token(struct ArtworkListInfo *artwork_info, if (!prefix_found) return NULL; - /* search for suffix (parameter) to determine base token length */ + // search for suffix (parameter) to determine base token length for (i = 0; suffix_list[i].token != NULL; i++) if (strSuffix(token, suffix_list[i].token)) len_suffix = strlen(suffix_list[i].token); @@ -2736,273 +3705,6 @@ static char *get_special_base_token(struct ArtworkListInfo *artwork_info, return getStringCopyN(token, strlen(token) - len_suffix); } -/* 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); -} - -static int get_anim_parameter_value(char *s) -{ - char *pattern_1 = "click:anim_"; - char *pattern_2 = ".part_"; - char *matching_char = NULL; - char *s_ptr = s; - int result = ANIM_EVENT_NONE; - - matching_char = strstr(s_ptr, pattern_1); - if (matching_char == NULL) - return ANIM_EVENT_NONE; - - s_ptr = matching_char + strlen(pattern_1); - - // check for main animation number ("anim_X" or "anim_XX") - if (*s_ptr >= '0' && *s_ptr <= '9') - { - int gic_anim_nr = (*s_ptr++ - '0'); - - if (*s_ptr >= '0' && *s_ptr <= '9') - gic_anim_nr = 10 * gic_anim_nr + (*s_ptr++ - '0'); - - if (gic_anim_nr < 1 || gic_anim_nr > MAX_GLOBAL_ANIMS) - return ANIM_EVENT_NONE; - - result |= gic_anim_nr << ANIM_EVENT_ANIM_BIT; - } - else - { - // invalid main animation number specified - - return ANIM_EVENT_NONE; - } - - // check for animation part number ("part_X" or "part_XX") (optional) - if (strPrefix(s_ptr, pattern_2)) - { - s_ptr += strlen(pattern_2); - - if (*s_ptr >= '0' && *s_ptr <= '9') - { - int gic_part_nr = (*s_ptr++ - '0'); - - if (*s_ptr >= '0' && *s_ptr <= '9') - gic_part_nr = 10 * gic_part_nr + (*s_ptr++ - '0'); - - if (gic_part_nr < 1 || gic_part_nr > MAX_GLOBAL_ANIM_PARTS) - return ANIM_EVENT_NONE; - - result |= gic_part_nr << ANIM_EVENT_PART_BIT; - } - else - { - // invalid animation part number specified - - return ANIM_EVENT_NONE; - } - } - - /* discard result if next character is neither delimiter nor whitespace */ - if (!(*s_ptr == ',' || *s_ptr == '\0' || - *s_ptr == ' ' || *s_ptr == '\t')) - return ANIM_EVENT_NONE; - - return result; -} - -static int get_anim_action_parameter_value(char *token) -{ - int result = getImageIDFromToken(token); - - if (result == -1) - { - char *gfx_token = getStringCat2("gfx.", token); - - result = getImageIDFromToken(gfx_token); - - checked_free(gfx_token); - } - - if (result == -1) - { - Key key = getKeyFromX11KeyName(token); - - if (key != KSYM_UNDEFINED) - result = -(int)key; - } - - if (result == -1) - result = ANIM_EVENT_ACTION_NONE; - - return result; -} - -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, ".position")) - { - result = (strEqual(value, "left") ? POS_LEFT : - strEqual(value, "right") ? POS_RIGHT : - strEqual(value, "top") ? POS_TOP : - strEqual(value, "upper") ? POS_UPPER : - strEqual(value, "middle") ? POS_MIDDLE : - strEqual(value, "lower") ? POS_LOWER : - strEqual(value, "bottom") ? POS_BOTTOM : - strEqual(value, "any") ? POS_ANY : - strEqual(value, "last") ? POS_LAST : POS_UNDEFINED); - } - 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 : - string_has_parameter(value, "all") ? ANIM_ALL : - ANIM_DEFAULT); - - if (string_has_parameter(value, "once")) - result |= ANIM_ONCE; - - 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, ".init_event") || - strEqual(suffix, ".anim_event")) - { - result = ANIM_EVENT_DEFAULT; - - if (string_has_parameter(value, "any")) - result |= ANIM_EVENT_ANY; - - if (string_has_parameter(value, "click")) - result |= ANIM_EVENT_SELF; - - // add optional "click:anim_X" or "click:anim_X.part_X" parameter - result |= get_anim_parameter_value(value); - } - else if (strEqual(suffix, ".init_event_action") || - strEqual(suffix, ".anim_event_action")) - { - result = get_anim_action_parameter_value(value_raw); - } - else if (strEqual(suffix, ".class")) - { - result = (strEqual(value, ARG_UNDEFINED) ? ARG_UNDEFINED_VALUE : - 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; - - if (string_has_parameter(value, "reverse")) - result |= STYLE_REVERSE; - - if (string_has_parameter(value, "passthrough_clicks")) - result |= STYLE_PASSTHROUGH; - - if (string_has_parameter(value, "multiple_actions")) - result |= STYLE_MULTIPLE_ACTIONS; - } - 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 : - string_has_parameter(value, "curtain") ? FADE_MODE_CURTAIN : - 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; -} - static void FreeCustomArtworkList(struct ArtworkListInfo *, struct ListNodeInfo ***, int *); @@ -3018,7 +3720,7 @@ struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list, int list_pos; int i, j; - /* create hash from list of tokens to be ignored (for quick access) */ + // create hash from list of tokens to be ignored (for quick access) ignore_tokens_hash = newSetupFileHash(); for (i = 0; ignore_tokens[i] != NULL; i++) setHashEntry(ignore_tokens_hash, ignore_tokens[i], ""); @@ -3028,7 +3730,7 @@ struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list, for (i = 0; suffix_list[i].token != NULL; i++) num_suffix_list_entries++; - /* always start with reliable default values */ + // always start with reliable default values for (i = 0; i < num_file_list_entries; i++) { file_list[i].token = NULL; @@ -3079,7 +3781,7 @@ struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list, } } - /* the following tokens are no file definitions, but other config tokens */ + // the following tokens are no file definitions, but other config tokens if (getHashEntry(ignore_tokens_hash, config_list[i].token) != NULL) is_file_entry = FALSE; @@ -3102,13 +3804,14 @@ struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list, 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')", + Error("---"); + Error("inconsistant config list information:"); + Error("- 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')", + Error("- found to be: %d (according to 'src/conf_xxx.c')", num_file_list_entries_found); - Error(ERR_EXIT, "please fix"); + + Fail("please fix"); } freeSetupFileHash(ignore_tokens_hash); @@ -3121,7 +3824,7 @@ static boolean token_suffix_match(char *token, char *suffix, int start_pos) int len_token = strlen(token); int len_suffix = strlen(suffix); - if (start_pos < 0) /* compare suffix from end of string */ + if (start_pos < 0) // compare suffix from end of string start_pos += len_token; if (start_pos < 0 || start_pos + len_suffix > len_token) @@ -3145,7 +3848,7 @@ static void read_token_parameters(SetupFileHash *setup_file_hash, struct ConfigTypeInfo *suffix_list, struct FileInfo *file_list_entry) { - /* check for config token that is the base token without any suffixes */ + // check for config token that is the base token without any suffixes char *filename = getHashEntry(setup_file_hash, file_list_entry->token); char *known_token_value = KNOWN_TOKEN_VALUE; int i; @@ -3154,17 +3857,17 @@ static void read_token_parameters(SetupFileHash *setup_file_hash, { setString(&file_list_entry->filename, filename); - /* when file definition found, set all parameters to default values */ + // when file definition found, set all parameters to default values for (i = 0; suffix_list[i].token != NULL; i++) setString(&file_list_entry->parameter[i], suffix_list[i].value); file_list_entry->redefined = TRUE; - /* mark config file token as well known from default config */ + // mark config file token as well known from default config setHashEntry(setup_file_hash, file_list_entry->token, known_token_value); } - /* check for config tokens that can be build by base token and suffixes */ + // check for config tokens that can be build by base token and suffixes for (i = 0; suffix_list[i].token != NULL; i++) { char *token = getStringCat2(file_list_entry->token, suffix_list[i].token); @@ -3174,7 +3877,7 @@ static void read_token_parameters(SetupFileHash *setup_file_hash, { setString(&file_list_entry->parameter[i], value); - /* mark config file token as well known from default config */ + // mark config file token as well known from default config setHashEntry(setup_file_hash, token, known_token_value); } @@ -3258,7 +3961,7 @@ static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info, if ((setup_file_hash = loadSetupFileHash(filename)) == NULL) return; - /* separate valid (defined) from empty (undefined) config token values */ + // separate valid (defined) from empty (undefined) config token values valid_file_hash = newSetupFileHash(); empty_file_hash = newSetupFileHash(); BEGIN_HASH_ITERATION(setup_file_hash, itr) @@ -3270,10 +3973,10 @@ static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info, } END_HASH_ITERATION(setup_file_hash, itr) - /* at this point, we do not need the setup file hash anymore -- free it */ + // at this point, we do not need the setup file hash anymore -- free it freeSetupFileHash(setup_file_hash); - /* prevent changing hash while iterating over it by using a temporary copy */ + // prevent changing hash while iterating over it by using a temporary copy valid_file_hash_tmp = newSetupFileHash(); BEGIN_HASH_ITERATION(valid_file_hash, itr) { @@ -3283,9 +3986,9 @@ static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info, } END_HASH_ITERATION(valid_file_hash, itr) - /* (iterate over same temporary hash, as modifications are independent) */ + // (iterate over same temporary hash, as modifications are independent) - /* map deprecated to current tokens (using prefix match and replace) */ + // map deprecated to current tokens (using prefix match and replace) BEGIN_HASH_ITERATION(valid_file_hash_tmp, itr) { char *token = HASH_ITERATION_TOKEN(itr); @@ -3295,10 +3998,10 @@ static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info, { char *value = HASH_ITERATION_VALUE(itr); - /* add mapped token */ + // add mapped token setHashEntry(valid_file_hash, mapped_token, value); - /* ignore old token (by setting it to "known" keyword) */ + // ignore old token (by setting it to "known" keyword) setHashEntry(valid_file_hash, token, known_token_value); free(mapped_token); @@ -3306,7 +4009,7 @@ static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info, } END_HASH_ITERATION(valid_file_hash_tmp, itr) - /* add special base tokens (using prefix match and replace) */ + // add special base tokens (using prefix match and replace) BEGIN_HASH_ITERATION(valid_file_hash_tmp, itr) { char *token = HASH_ITERATION_TOKEN(itr); @@ -3314,7 +4017,7 @@ static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info, if (base_token != NULL) { - /* add base token only if it does not already exist */ + // add base token only if it does not already exist if (getHashEntry(valid_file_hash, base_token) == NULL) setHashEntry(valid_file_hash, base_token, base_token_value); @@ -3323,18 +4026,18 @@ static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info, } END_HASH_ITERATION(valid_file_hash_tmp, itr) - /* free temporary hash used for iteration */ + // free temporary hash used for iteration freeSetupFileHash(valid_file_hash_tmp); - /* read parameters for all known config file tokens */ + // read parameters for all known config file tokens for (i = 0; i < num_file_list_entries; i++) read_token_parameters(valid_file_hash, suffix_list, &file_list[i]); - /* set all tokens that can be ignored here to "known" keyword */ + // set all tokens that can be ignored here to "known" keyword for (i = 0; i < num_ignore_tokens; i++) setHashEntry(valid_file_hash, ignore_tokens[i], known_token_value); - /* copy all unknown config file tokens to extra config hash */ + // copy all unknown config file tokens to extra config hash extra_file_hash = newSetupFileHash(); BEGIN_HASH_ITERATION(valid_file_hash, itr) { @@ -3345,10 +4048,10 @@ static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info, } END_HASH_ITERATION(valid_file_hash, itr) - /* at this point, we do not need the valid file hash anymore -- free it */ + // at this point, we do not need the valid file hash anymore -- free it freeSetupFileHash(valid_file_hash); - /* now try to determine valid, dynamically defined config tokens */ + // now try to determine valid, dynamically defined config tokens BEGIN_HASH_ITERATION(extra_file_hash, itr) { @@ -3369,7 +4072,7 @@ static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info, boolean base_prefix_found = FALSE; boolean parameter_suffix_found = FALSE; - /* skip all parameter definitions (handled by read_token_parameters()) */ + // skip all parameter definitions (handled by read_token_parameters()) for (i = 0; i < num_suffix_list_entries && !parameter_suffix_found; i++) { int len_suffix = strlen(suffix_list[i].token); @@ -3381,7 +4084,7 @@ static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info, if (parameter_suffix_found) continue; - /* ---------- step 0: search for matching base prefix ---------- */ + // ---------- step 0: search for matching base prefix ---------- start_pos = 0; for (i = 0; i < num_base_prefixes && !base_prefix_found; i++) @@ -3404,7 +4107,7 @@ static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info, base_index = i; - if (start_pos + len_base_prefix == len_token) /* exact match */ + if (start_pos + len_base_prefix == len_token) // exact match { exact_match = TRUE; @@ -3421,7 +4124,7 @@ static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info, continue; } - /* ---------- step 1: search for matching first suffix ---------- */ + // ---------- step 1: search for matching first suffix ---------- start_pos += len_base_prefix; for (j = 0; j < num_ext1_suffixes && !ext1_suffix_found; j++) @@ -3436,7 +4139,7 @@ static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info, ext1_index = j; - if (start_pos + len_ext1_suffix == len_token) /* exact match */ + if (start_pos + len_ext1_suffix == len_token) // exact match { exact_match = TRUE; @@ -3459,7 +4162,7 @@ static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info, if (exact_match) break; - /* ---------- step 2: search for matching second suffix ---------- */ + // ---------- step 2: search for matching second suffix ---------- for (k = 0; k < num_ext2_suffixes && !ext2_suffix_found; k++) { @@ -3473,7 +4176,7 @@ static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info, ext2_index = k; - if (start_pos + len_ext2_suffix == len_token) /* exact match */ + if (start_pos + len_ext2_suffix == len_token) // exact match { exact_match = TRUE; @@ -3496,7 +4199,7 @@ static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info, if (exact_match) break; - /* ---------- step 3: search for matching third suffix ---------- */ + // ---------- step 3: search for matching third suffix ---------- for (l = 0; l < num_ext3_suffixes && !ext3_suffix_found; l++) { @@ -3510,7 +4213,7 @@ static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info, ext3_index = l; - if (start_pos + len_ext3_suffix == len_token) /* exact match */ + if (start_pos + len_ext3_suffix == len_token) // exact match { exact_match = TRUE; @@ -3545,7 +4248,7 @@ static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info, boolean unknown_tokens_found = FALSE; boolean undefined_values_found = (hashtable_count(empty_file_hash) != 0); - /* list may be NULL for empty artwork config files */ + // list may be NULL for empty artwork config files setup_file_list = loadSetupFileList(filename); BEGIN_HASH_ITERATION(extra_file_hash, itr) @@ -3559,53 +4262,53 @@ static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info, 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); + Debug("config", "---"); + Debug("config", "dynamic token(s) found in config file:"); + Debug("config", "- config file: '%s'", filename); for (list = setup_file_list; list != NULL; list = list->next) { char *value = getHashEntry(extra_file_hash, list->token); if (value != NULL && strEqual(value, known_token_value)) - Error(ERR_INFO, "- dynamic token: '%s'", list->token); + Debug("config", "- dynamic token: '%s'", list->token); } - Error(ERR_INFO_LINE, "-"); + Debug("config", "---"); } 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); + Warn("---"); + Warn("unknown token(s) found in config file:"); + Warn("- config file: '%s'", filename); for (list = setup_file_list; list != NULL; list = list->next) { char *value = getHashEntry(extra_file_hash, list->token); if (value != NULL && !strEqual(value, known_token_value)) - Error(ERR_INFO, "- dynamic token: '%s'", list->token); + Warn("- dynamic token: '%s'", list->token); } - Error(ERR_INFO_LINE, "-"); + Warn("---"); } 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); + Warn("---"); + Warn("undefined values found in config file:"); + Warn("- config file: '%s'", filename); for (list = setup_file_list; list != NULL; list = list->next) { char *value = getHashEntry(empty_file_hash, list->token); if (value != NULL) - Error(ERR_INFO, "- undefined value for token: '%s'", list->token); + Warn("- undefined value for token: '%s'", list->token); } - Error(ERR_INFO_LINE, "-"); + Warn("---"); } freeSetupFileList(setup_file_list); @@ -3623,10 +4326,10 @@ void LoadArtworkConfig(struct ArtworkListInfo *artwork_info) char *filename_base = UNDEFINED_FILENAME, *filename_local; int i, j; - DrawInitText("Loading artwork config", 120, FC_GREEN); - DrawInitText(ARTWORKINFO_FILENAME(artwork_info->type), 150, FC_YELLOW); + DrawInitTextHead("Loading artwork config"); + DrawInitTextItem(ARTWORKINFO_FILENAME(artwork_info->type)); - /* always start with reliable default values */ + // always start with reliable default values for (i = 0; i < num_file_list_entries; i++) { setString(&file_list[i].filename, file_list[i].default_filename); @@ -3638,7 +4341,7 @@ void LoadArtworkConfig(struct ArtworkListInfo *artwork_info) file_list[i].fallback_to_default = FALSE; } - /* free previous dynamic artwork file array */ + // free previous dynamic artwork file array if (artwork_info->dynamic_file_list != NULL) { for (i = 0; i < artwork_info->num_dynamic_file_list_entries; i++) @@ -3655,7 +4358,7 @@ void LoadArtworkConfig(struct ArtworkListInfo *artwork_info) &artwork_info->num_dynamic_file_list_entries); } - /* free previous property mapping */ + // free previous property mapping if (artwork_info->property_mapping != NULL) { free(artwork_info->property_mapping); @@ -3666,7 +4369,7 @@ void LoadArtworkConfig(struct ArtworkListInfo *artwork_info) if (!GFX_OVERRIDE_ARTWORK(artwork_info->type)) { - /* first look for special artwork configured in level series config */ + // first look for special artwork configured in level series config filename_base = getCustomArtworkLevelConfigFilename(artwork_info->type); if (fileExists(filename_base)) @@ -3709,66 +4412,71 @@ static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info, char *basename = file_list_entry->filename; char *filename = getCustomArtworkFilename(basename, artwork_info->type); + // mark all images from non-default graphics directory as "redefined" + if (artwork_info->type == ARTWORK_TYPE_GRAPHICS && + !strPrefix(filename, options.graphics_directory)) + file_list_entry->redefined = TRUE; + if (filename == NULL) { - Error(ERR_WARN, "cannot find artwork file '%s'", basename); + Warn("cannot find artwork file '%s'", basename); basename = file_list_entry->default_filename; - /* fail for cloned default artwork that has no default filename defined */ + // 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; + void (*error_func)(char *, ...) = Warn; - /* we can get away without sounds and music, but not without graphics */ + // we can get away without sounds and music, but not without graphics if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS) - error_mode = ERR_EXIT; + error_func = Fail; - Error(error_mode, "token '%s' was cloned and has no default filename", - file_list_entry->token); + error_func("token '%s' was cloned and has no default filename", + file_list_entry->token); return; } - /* dynamic artwork has no default filename / skip empty default artwork */ + // dynamic artwork has no default filename / skip empty default artwork if (basename == NULL || strEqual(basename, UNDEFINED_FILENAME)) return; file_list_entry->fallback_to_default = TRUE; - Error(ERR_WARN, "trying default artwork file '%s'", basename); + Warn("trying default artwork file '%s'", basename); filename = getCustomArtworkFilename(basename, artwork_info->type); if (filename == NULL) { - int error_mode = ERR_WARN; + void (*error_func)(char *, ...) = Warn; - /* we can get away without sounds and music, but not without graphics */ + // we can get away without sounds and music, but not without graphics if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS) - error_mode = ERR_EXIT; + error_func = Fail; - Error(error_mode, "cannot find default artwork file '%s'", basename); + error_func("cannot find default artwork file '%s'", basename); return; } } - /* check if the old and the new artwork file are the same */ + // check if the old and the new artwork file are the same if (*listnode && strEqual((*listnode)->source_filename, filename)) { - /* The old and new artwork are the same (have the same filename and path). - This usually means that this artwork does not exist in this artwork set - and a fallback to the existing artwork is done. */ + // The old and new artwork are the same (have the same filename and path). + // This usually means that this artwork does not exist in this artwork set + // and a fallback to the existing artwork is done. return; } - /* delete existing artwork file entry */ + // delete existing artwork file entry deleteArtworkListEntry(artwork_info, listnode); - /* check if the new artwork file already exists in the list of artwork */ + // 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; @@ -3777,25 +4485,25 @@ static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info, return; } - DrawInitText(init_text[artwork_info->type], 120, FC_GREEN); - DrawInitText(basename, 150, FC_YELLOW); + DrawInitTextHead(init_text[artwork_info->type]); + DrawInitTextItem(basename); if ((*listnode = artwork_info->load_artwork(filename)) != NULL) { - /* add new artwork file entry to the list of artwork files */ + // add new artwork file entry to the list of artwork files (*listnode)->num_references = 1; addNodeToList(&artwork_info->content_list, (*listnode)->source_filename, *listnode); } else { - int error_mode = ERR_WARN; + void (*error_func)(char *, ...) = Warn; - /* we can get away without sounds and music, but not without graphics */ + // we can get away without sounds and music, but not without graphics if (artwork_info->type == ARTWORK_TYPE_GRAPHICS) - error_mode = ERR_EXIT; + error_func = Fail; - Error(error_mode, "cannot load artwork file '%s'", basename); + error_func("cannot load artwork file '%s'", basename); return; } @@ -3871,51 +4579,47 @@ void FreeCustomArtworkLists(struct ArtworkListInfo *artwork_info) } -/* ------------------------------------------------------------------------- */ -/* functions only needed for non-Unix (non-command-line) systems */ -/* (MS-DOS only; SDL/Windows creates files "stdout.txt" and "stderr.txt") */ -/* (now also added for Windows, to create files in user data directory) */ -/* ------------------------------------------------------------------------- */ +// ---------------------------------------------------------------------------- +// functions only needed for non-Unix (non-command-line) systems +// (MS-DOS only; SDL/Windows creates files "stdout.txt" and "stderr.txt") +// (now also added for Windows, to create files in user data directory) +// ---------------------------------------------------------------------------- -char *getLogFilename(char *basename) +char *getLogBasename(char *basename) { - return getPath2(getUserGameDataDir(), basename); + return getStringCat2(basename, ".log"); } -void OpenLogFiles(void) +char *getLogFilename(char *basename) { - int i; + return getPath2(getMainUserGameDataDir(), basename); +} - InitUserDataDirectory(); +void OpenLogFile(void) +{ + InitMainUserDataDirectory(); - for (i = 0; i < NUM_LOGS; i++) + if ((program.log_file = fopen(program.log_filename, MODE_WRITE)) == NULL) { - if ((program.log_file[i] = fopen(program.log_filename[i], MODE_WRITE)) - == NULL) - { - program.log_file[i] = program.log_file_default[i]; // reset to default - - Error(ERR_WARN, "cannot open file '%s' for writing: %s", - program.log_filename[i], strerror(errno)); - } + program.log_file = program.log_file_default; // reset to default - /* output should be unbuffered so it is not truncated in a crash */ - setbuf(program.log_file[i], NULL); + Warn("cannot open file '%s' for writing: %s", + program.log_filename, strerror(errno)); } + + // output should be unbuffered so it is not truncated in a crash + setbuf(program.log_file, NULL); } -void CloseLogFiles(void) +void CloseLogFile(void) { - int i; - - for (i = 0; i < NUM_LOGS; i++) - if (program.log_file[i] != program.log_file_default[i]) - fclose(program.log_file[i]); + if (program.log_file != program.log_file_default) + fclose(program.log_file); } -void DumpLogFile(int nr) +void DumpLogFile(void) { - FILE *log_file = fopen(program.log_filename[nr], MODE_READ); + FILE *log_file = fopen(program.log_filename, MODE_READ); if (log_file == NULL) return; @@ -3928,25 +4632,25 @@ void DumpLogFile(int nr) void NotifyUserAboutErrorFile(void) { -#if defined(PLATFORM_WIN32) +#if defined(PLATFORM_WINDOWS) 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.log_filename[LOG_ERR_ID]); + program.log_filename); MessageBox(NULL, error_text, title_text, MB_OK); #endif } -/* ------------------------------------------------------------------------- */ -/* the following is only for debugging purpose and normally not used */ -/* ------------------------------------------------------------------------- */ +// ---------------------------------------------------------------------------- +// the following is only for debugging purpose and normally not used +// ---------------------------------------------------------------------------- #if DEBUG -#define DEBUG_PRINT_INIT_TIMESTAMPS FALSE +#define DEBUG_PRINT_INIT_TIMESTAMPS TRUE #define DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH 10 #define DEBUG_NUM_TIMESTAMPS 10 @@ -3961,7 +4665,7 @@ static double Counter_Microseconds(void) gettimeofday(¤t_time, NULL); - /* reset base time in case of wrap-around */ + // reset base time in case of wrap-around if (current_time.tv_sec < base_time.tv_sec) base_time = current_time; @@ -3969,7 +4673,7 @@ static double Counter_Microseconds(void) ((double)(current_time.tv_sec - base_time.tv_sec)) * 1000000 + ((double)(current_time.tv_usec - base_time.tv_usec)); - return counter; /* return microseconds since last init */ + return counter; // return microseconds since last init } #endif @@ -3994,9 +4698,9 @@ void debug_print_timestamp(int counter_nr, char *message) float timestamp_interval; if (counter_nr < 0) - Error(ERR_EXIT, "debugging: invalid negative counter"); + Fail("debugging: invalid negative counter"); else if (counter_nr >= DEBUG_NUM_TIMESTAMPS) - Error(ERR_EXIT, "debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c"); + Fail("debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c"); #if DEBUG_TIME_IN_MICROSECONDS static double counter[DEBUG_NUM_TIMESTAMPS][2]; @@ -4014,12 +4718,12 @@ void debug_print_timestamp(int counter_nr, char *message) counter[counter_nr][1] = counter[counter_nr][0]; 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); + Debug("time:init", "%s%s%s %.3f %s", + debug_print_timestamp_get_padding(counter_nr * indent_size), + message, + debug_print_timestamp_get_padding(padding_size - strlen(message)), + timestamp_interval / 1000, + unit); } #if 0 @@ -4041,7 +4745,7 @@ static void debug_print_parent_only(char *format, ...) } #endif -#endif /* DEBUG */ +#endif // DEBUG static void print_timestamp_ext(char *message, char *mode) {