-/***********************************************************
-* Artsoft Retro-Game Library *
-*----------------------------------------------------------*
-* (c) 1994-2002 Artsoft Entertainment *
-* Holger Schemel *
-* Detmolder Strasse 189 *
-* 33604 Bielefeld *
-* Germany *
-* e-mail: info@artsoft.org *
-*----------------------------------------------------------*
-* misc.c *
-***********************************************************/
+// ============================================================================
+// Artsoft Retro-Game Library
+// ----------------------------------------------------------------------------
+// (c) 1995-2014 by Artsoft Entertainment
+// Holger Schemel
+// info@artsoft.org
+// http://www.artsoft.org/
+// ----------------------------------------------------------------------------
+// misc.c
+// ============================================================================
#include <time.h>
#include <sys/time.h>
#include <sys/types.h>
+#include <sys/stat.h>
#include <stdarg.h>
#include <ctype.h>
#include <string.h>
#include <unistd.h>
+#include <errno.h>
#include "platform.h"
#include "setup.h"
#include "random.h"
#include "text.h"
+#include "image.h"
-/* ------------------------------------------------------------------------- */
+/* ========================================================================= */
/* some generic helper functions */
+/* ========================================================================= */
+
+/* ------------------------------------------------------------------------- */
+/* logging functions */
+/* ------------------------------------------------------------------------- */
+
+#define DUPLICATE_LOG_OUT_TO_STDOUT TRUE
+#define DUPLICATE_LOG_ERR_TO_STDERR TRUE
+
+
+#if defined(PLATFORM_ANDROID)
+static int android_log_prio = ANDROID_LOG_INFO;
+static char *android_log_buffer = NULL;
+
+static void append_to_android_log_buffer(char *format, va_list ap)
+{
+ char text_new[MAX_OUTPUT_LINESIZE];
+
+ // print text to temporary string
+ vsnprintf(text_new, MAX_OUTPUT_LINESIZE, format, ap);
+
+ if (android_log_buffer == NULL)
+ {
+ android_log_buffer = getStringCopy(text_new);
+ }
+ else
+ {
+ char *android_log_buffer_old = android_log_buffer;
+
+ // append new text to existing text
+ android_log_buffer = getStringCat2(android_log_buffer, text_new);
+
+ checked_free(android_log_buffer_old);
+ }
+}
+
+static void vprintf_log_nonewline(char *format, va_list ap)
+{
+ // add log output to buffer until text with newline is printed
+ append_to_android_log_buffer(format, ap);
+}
+
+static void vprintf_log(char *format, va_list ap)
+{
+ // add log output to buffer
+ append_to_android_log_buffer(format, ap);
+
+ // __android_log_vprint(android_log_prio, program.program_title, format, ap);
+ __android_log_write(android_log_prio, program.program_title,
+ android_log_buffer);
+
+ checked_free(android_log_buffer);
+ android_log_buffer = NULL;
+}
+
+#else
+
+static void vprintf_log_nonewline(char *format, va_list ap)
+{
+ FILE *file = program.log_file[LOG_ERR_ID];
+
+#if DUPLICATE_LOG_ERR_TO_STDERR
+ if (file != program.log_file_default[LOG_ERR_ID])
+ {
+ va_list ap2;
+ va_copy(ap2, ap);
+
+ vfprintf(program.log_file_default[LOG_ERR_ID], format, ap2);
+
+ va_end(ap2);
+ }
+#endif
+
+ vfprintf(file, format, ap);
+}
+
+static void vprintf_log(char *format, va_list ap)
+{
+ FILE *file = program.log_file[LOG_ERR_ID];
+ char *newline = STRING_NEWLINE;
+
+#if DUPLICATE_LOG_ERR_TO_STDERR
+ if (file != program.log_file_default[LOG_ERR_ID])
+ {
+ 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);
+
+ va_end(ap2);
+ }
+#endif
+
+ vfprintf(file, format, ap);
+ fprintf(file, "%s", newline);
+}
+#endif
+
+static void printf_log_nonewline(char *format, ...)
+{
+ va_list ap;
+
+ va_start(ap, format);
+ vprintf_log_nonewline(format, ap);
+ va_end(ap);
+}
+
+static void printf_log(char *format, ...)
+{
+ va_list ap;
+
+ va_start(ap, format);
+ vprintf_log(format, ap);
+ va_end(ap);
+}
+
+static void printf_log_line(char *line_chars, int line_length)
+{
+ int i;
+
+ for (i = 0; i < line_length; i++)
+ printf_log_nonewline("%s", line_chars);
+
+ printf_log("");
+}
+
+
/* ------------------------------------------------------------------------- */
+/* platform independent wrappers for printf() et al. */
+/* ------------------------------------------------------------------------- */
+
+void fprintf_line(FILE *file, char *line_chars, int line_length)
+{
+ int i;
+
+ for (i = 0; i < line_length; i++)
+ fprintf(file, "%s", line_chars);
+
+ fprintf(file, "\n");
+}
+
+void fprintf_line_with_prefix(FILE *file, char *prefix, char *line_chars,
+ int line_length)
+{
+ fprintf(file, "%s", prefix);
+ fprintf_line(file, line_chars, line_length);
+}
+
+void printf_line(char *line_chars, int line_length)
+{
+ fprintf_line(stdout, line_chars, line_length);
+}
+
+void printf_line_with_prefix(char *prefix, char *line_chars, int line_length)
+{
+ fprintf_line_with_prefix(stdout, prefix, line_chars, line_length);
+}
+
+static void vPrint(char *format, va_list ap)
+{
+ FILE *file = program.log_file[LOG_OUT_ID];
+
+#if DUPLICATE_LOG_OUT_TO_STDOUT
+ if (file != program.log_file_default[LOG_OUT_ID])
+ {
+ va_list ap2;
+ va_copy(ap2, ap);
+
+ vfprintf(program.log_file_default[LOG_OUT_ID], format, ap2);
+
+ va_end(ap2);
+ }
+#endif
-void fprintf_line(FILE *stream, char *line_string, int line_length)
+ vfprintf(file, format, ap);
+}
+
+void Print(char *format, ...)
+{
+ va_list ap;
+
+ va_start(ap, format);
+ vPrint(format, ap);
+ va_end(ap);
+}
+
+void PrintLine(char *line_chars, int line_length)
{
int i;
- for (i=0; i<line_length; i++)
- fprintf(stream, "%s", line_string);
+ for (i = 0; i < line_length; i++)
+ Print(line_chars);
- fprintf(stream, "\n");
+ Print("\n");
}
-void printf_line(char *line_string, int line_length)
+void PrintLineWithPrefix(char *prefix, char *line_chars, int line_length)
{
- fprintf_line(stdout, line_string, line_length);
+ Print(prefix);
+ PrintLine(line_chars, line_length);
}
+
+/* ------------------------------------------------------------------------- */
+/* string functions */
+/* ------------------------------------------------------------------------- */
+
/* int2str() returns a number converted to a string;
the used memory is static, but will be overwritten by later calls,
so if you want to save the result, copy it to a private string buffer;
if (size > 20)
size = 20;
- if (size)
+ if (size > 0)
{
sprintf(s, " %09d", number);
return &s[strlen(s) - size];
}
-/* ------------------------------------------------------------------------- */
-/* counter functions */
-/* ------------------------------------------------------------------------- */
-
-#if defined(PLATFORM_MSDOS)
-volatile unsigned long counter = 0;
+/* 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 */
-void increment_counter()
+char *i_to_a(unsigned int i)
{
- counter++;
-}
+ static char *a = NULL;
-END_OF_FUNCTION(increment_counter);
-#endif
+ checked_free(a);
+ if (i > 2147483647) /* yes, this is a kludge */
+ i = 2147483647;
-/* maximal allowed length of a command line option */
-#define MAX_OPTION_LEN 256
+ a = checked_malloc(10 + 1);
-#ifdef TARGET_SDL
-static unsigned long mainCounter(int mode)
-{
- static unsigned long base_ms = 0;
- unsigned long current_ms;
- unsigned long counter_ms;
+ sprintf(a, "%d", i);
- current_ms = SDL_GetTicks();
+ return a;
+}
- /* reset base time in case of counter initializing or wrap-around */
- if (mode == INIT_COUNTER || current_ms < base_ms)
- base_ms = current_ms;
- counter_ms = current_ms - base_ms;
+/* calculate base-2 logarithm of argument (rounded down to integer;
+ this function returns the number of the highest bit set in argument) */
+
+int log_2(unsigned int x)
+{
+ int e = 0;
+
+ while ((1 << e) < x)
+ {
+ x -= (1 << e); /* for rounding down (rounding up: remove this line) */
+ e++;
+ }
+
+ return e;
+}
- return counter_ms; /* return milliseconds since last init */
+boolean getTokenValueFromString(char *string, char **token, char **value)
+{
+ return getTokenValueFromSetupLine(string, token, value);
}
-#else /* !TARGET_SDL */
-#if defined(PLATFORM_UNIX)
-static unsigned long mainCounter(int mode)
+/* ------------------------------------------------------------------------- */
+/* counter functions */
+/* ------------------------------------------------------------------------- */
+
+/* maximal allowed length of a command line option */
+#define MAX_OPTION_LEN 256
+
+static unsigned int getCurrentMS()
{
- static struct timeval base_time = { 0, 0 };
- struct timeval current_time;
- unsigned long counter_ms;
+ return SDL_GetTicks();
+}
- gettimeofday(¤t_time, NULL);
+static unsigned int mainCounter(int mode)
+{
+ static unsigned int base_ms = 0;
+ unsigned int current_ms;
- /* reset base time in case of counter initializing or wrap-around */
- if (mode == INIT_COUNTER || current_time.tv_sec < base_time.tv_sec)
- base_time = current_time;
+ /* get current system milliseconds */
+ current_ms = getCurrentMS();
- counter_ms = (current_time.tv_sec - base_time.tv_sec) * 1000
- + (current_time.tv_usec - base_time.tv_usec) / 1000;
+ /* reset base timestamp in case of counter reset or wrap-around */
+ if (mode == INIT_COUNTER || current_ms < base_ms)
+ base_ms = current_ms;
- return counter_ms; /* return milliseconds since last init */
+ /* return milliseconds since last counter reset */
+ return current_ms - base_ms;
}
-#endif /* PLATFORM_UNIX */
-#endif /* !TARGET_SDL */
void InitCounter() /* set counter back to zero */
{
-#if !defined(PLATFORM_MSDOS)
mainCounter(INIT_COUNTER);
-#else
- LOCK_VARIABLE(counter);
- LOCK_FUNCTION(increment_counter);
- install_int_ex(increment_counter, BPS_TO_TIMER(100));
-#endif
}
-unsigned long Counter() /* get milliseconds since last call of InitCounter() */
+unsigned int Counter() /* get milliseconds since last call of InitCounter() */
{
-#if !defined(PLATFORM_MSDOS)
return mainCounter(READ_COUNTER);
-#else
- return (counter * 10);
-#endif
}
-static void sleep_milliseconds(unsigned long milliseconds_delay)
+static void sleep_milliseconds(unsigned int milliseconds_delay)
{
boolean do_busy_waiting = (milliseconds_delay < 5 ? TRUE : FALSE);
-#if 0
-#if defined(PLATFORM_MSDOS)
- /* don't use select() to perform waiting operations under DOS
- environment; always use a busy loop for waiting instead */
- do_busy_waiting = TRUE;
-#endif
-#endif
-
if (do_busy_waiting)
{
/* we want to wait only a few ms -- if we assume that we have a
- kernel timer resolution of 10 ms, we would wait far to long;
+ kernel timer resolution of 10 ms, we would wait far too long;
therefore it's better to do a short interval of busy waiting
to get our sleeping time more accurate */
- unsigned long base_counter = Counter(), actual_counter = Counter();
+ unsigned int base_counter = Counter(), actual_counter = Counter();
while (actual_counter < base_counter + milliseconds_delay &&
actual_counter >= base_counter)
}
else
{
-#if defined(TARGET_SDL)
SDL_Delay(milliseconds_delay);
-#elif defined(TARGET_ALLEGRO)
- rest(milliseconds_delay);
-#else
- struct timeval delay;
-
- delay.tv_sec = milliseconds_delay / 1000;
- delay.tv_usec = 1000 * (milliseconds_delay % 1000);
-
- if (select(0, NULL, NULL, NULL, &delay) != 0)
- Error(ERR_WARN, "sleep_milliseconds(): select() failed");
-#endif
}
}
-void Delay(unsigned long delay) /* Sleep specified number of milliseconds */
+void Delay(unsigned int delay) /* Sleep specified number of milliseconds */
{
sleep_milliseconds(delay);
}
-boolean FrameReached(unsigned long *frame_counter_var,
- unsigned long frame_delay)
+boolean FrameReached(unsigned int *frame_counter_var,
+ unsigned int frame_delay)
{
- unsigned long actual_frame_counter = FrameCounter;
+ unsigned int actual_frame_counter = FrameCounter;
- if (actual_frame_counter < *frame_counter_var + frame_delay &&
- actual_frame_counter >= *frame_counter_var)
+ if (actual_frame_counter >= *frame_counter_var &&
+ actual_frame_counter < *frame_counter_var + frame_delay)
return FALSE;
*frame_counter_var = actual_frame_counter;
return TRUE;
}
-boolean DelayReached(unsigned long *counter_var,
- unsigned long delay)
+boolean DelayReached(unsigned int *counter_var,
+ unsigned int delay)
{
- unsigned long actual_counter = Counter();
+ unsigned int actual_counter = Counter();
- if (actual_counter < *counter_var + delay &&
- actual_counter >= *counter_var)
+ if (actual_counter >= *counter_var &&
+ actual_counter < *counter_var + delay)
return FALSE;
*counter_var = actual_counter;
return TRUE;
}
-void WaitUntilDelayReached(unsigned long *counter_var, unsigned long delay)
+int WaitUntilDelayReached(unsigned int *counter_var, unsigned int delay)
{
- unsigned long actual_counter;
+ unsigned int actual_counter;
+ int skip_frames = 0;
- while(1)
+ while (1)
{
actual_counter = Counter();
- if (actual_counter < *counter_var + delay &&
- actual_counter >= *counter_var)
+ if (actual_counter >= *counter_var &&
+ actual_counter < *counter_var + delay)
sleep_milliseconds((*counter_var + delay - actual_counter) / 2);
else
break;
}
+ if (*counter_var != 0 &&
+ delay != 0 &&
+ actual_counter >= *counter_var + delay)
+ {
+ int lag = actual_counter - (*counter_var + delay);
+ int delay2 = (delay + 1) / 2;
+
+ if (lag >= delay2)
+ skip_frames = (lag + delay2) / delay;
+ }
+
*counter_var = actual_counter;
+
+ return skip_frames;
+}
+
+void SkipUntilDelayReached(unsigned int *counter_var, unsigned int delay,
+ int *loop_var, int last_loop_value)
+{
+ int skip_frames = WaitUntilDelayReached(counter_var, delay);
+
+#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");
+#endif
+#endif
+
+ if (skip_frames == 0)
+ return;
+
+ // when skipping frames, make sure to never skip the last frame, as
+ // this may be needed for animations to reach a defined end state;
+ // furthermore, we assume that this function is called at the end
+ // of a "for" loop, which continues by incrementing the loop variable
+ // by one before checking the loop condition again; therefore we have
+ // to check against the last loop value minus one here
+
+ last_loop_value--;
+
+ if (*loop_var < last_loop_value) // never skip the last frame
+ {
+ *loop_var += skip_frames;
+
+ if (*loop_var > last_loop_value) // never skip the last frame
+ *loop_var = last_loop_value;
+ }
}
/* random generator functions */
/* ------------------------------------------------------------------------- */
-unsigned int SimpleRND(unsigned int max)
+unsigned int init_random_number(int nr, int seed)
{
-#if defined(TARGET_SDL)
- static unsigned long root = 654321;
- unsigned long current_ms;
+ if (seed == NEW_RANDOMIZE)
+ {
+ /* default random seed */
+ seed = (int)time(NULL); // seconds since the epoch
- current_ms = SDL_GetTicks();
- root = root * 4253261 + current_ms;
- return (root % max);
-#else
- static unsigned long root = 654321;
- struct timeval current_time;
+#if !defined(PLATFORM_WIN32)
+ /* add some more randomness */
+ struct timeval current_time;
- gettimeofday(¤t_time, NULL);
- root = root * 4253261 + current_time.tv_sec + current_time.tv_usec;
- return (root % max);
+ gettimeofday(¤t_time, NULL);
+
+ seed += (int)current_time.tv_usec; // microseconds since the epoch
#endif
-}
-#ifdef DEBUG
-static unsigned int last_RND_value = 0;
+ /* add some more randomness */
+ seed += (int)SDL_GetTicks(); // milliseconds since SDL init
-unsigned int last_RND()
-{
- return last_RND_value;
+ /* add some more randomness */
+ seed += GetSimpleRandom(1000000);
+ }
+
+ srandom_linux_libc(nr, (unsigned int) seed);
+
+ return (unsigned int) seed;
}
-#endif
-unsigned int RND(unsigned int max)
+unsigned int get_random_number(int nr, int max)
{
-#ifdef DEBUG
- return (last_RND_value = random_linux_libc() % max);
-#else
- return (random_linux_libc() % max);
-#endif
+ return (max > 0 ? random_linux_libc(nr) % max : 0);
}
-unsigned int InitRND(long seed)
+
+/* ------------------------------------------------------------------------- */
+/* system info functions */
+/* ------------------------------------------------------------------------- */
+
+#if !defined(PLATFORM_ANDROID)
+static char *get_corrected_real_name(char *real_name)
{
-#if defined(TARGET_SDL)
- unsigned long current_ms;
+ char *real_name_new = checked_malloc(MAX_USERNAME_LEN + 1);
+ char *from_ptr = real_name;
+ char *to_ptr = real_name_new;
- if (seed == NEW_RANDOMIZE)
- {
- current_ms = SDL_GetTicks();
- srandom_linux_libc((unsigned int) current_ms);
- return (unsigned int) current_ms;
- }
- else
+ /* copy the name string, but not more than MAX_USERNAME_LEN characters */
+ while (*from_ptr && (int)(to_ptr - real_name_new) < MAX_USERNAME_LEN - 1)
{
- srandom_linux_libc((unsigned int) seed);
- return (unsigned int) seed;
- }
-#else
- struct timeval current_time;
+ /* the name field read from "passwd" file may also contain additional
+ user information, separated by commas, which will be removed here */
+ if (*from_ptr == ',')
+ break;
- if (seed == NEW_RANDOMIZE)
- {
- gettimeofday(¤t_time, NULL);
- srandom_linux_libc((unsigned int) current_time.tv_usec);
- return (unsigned int) current_time.tv_usec;
- }
- else
- {
- srandom_linux_libc((unsigned int) seed);
- return (unsigned int) seed;
+ /* the user's real name may contain 'german sharp s' characters,
+ which have no equivalent in upper case letters (used by our fonts) */
+ if (*from_ptr == CHAR_BYTE_SHARP_S)
+ {
+ from_ptr++;
+ *to_ptr++ = 's';
+ *to_ptr++ = 's';
+ }
+ else
+ *to_ptr++ = *from_ptr++;
}
-#endif
-}
+ *to_ptr = '\0';
-/* ------------------------------------------------------------------------- */
-/* system info functions */
-/* ------------------------------------------------------------------------- */
+ return real_name_new;
+}
+#endif
char *getLoginName()
{
-#if defined(PLATFORM_WIN32)
- return ANONYMOUS_NAME;
-#else
static char *login_name = NULL;
+#if defined(PLATFORM_WIN32)
+ 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)
+ strcpy(login_name, ANONYMOUS_NAME);
+ }
+#else
if (login_name == NULL)
{
struct passwd *pwd;
else
login_name = getStringCopy(pwd->pw_name);
}
+#endif
return login_name;
-#endif
}
char *getRealName()
{
-#if defined(PLATFORM_UNIX)
- struct passwd *pwd;
+ static char *real_name = NULL;
- if ((pwd = getpwuid(getuid())) == NULL || strlen(pwd->pw_gecos) == 0)
- return ANONYMOUS_NAME;
- else
+#if defined(PLATFORM_WIN32)
+ if (real_name == NULL)
{
- static char real_name[1024];
- char *from_ptr = pwd->pw_gecos, *to_ptr = real_name;
-
- if (strchr(pwd->pw_gecos, 'ß') == NULL)
- return pwd->pw_gecos;
+ static char buffer[MAX_USERNAME_LEN + 1];
+ unsigned long buffer_size = MAX_USERNAME_LEN + 1;
- /* the user's real name contains a 'ß' character (german sharp s),
- which has no equivalent in upper case letters (which our fonts use) */
- while (*from_ptr != '\0' && (long)(to_ptr - real_name) < 1024 - 2)
- {
- if (*from_ptr != 'ß')
- *to_ptr++ = *from_ptr++;
- else
- {
- from_ptr++;
- *to_ptr++ = 's';
- *to_ptr++ = 's';
- }
- }
- *to_ptr = '\0';
+ if (GetUserName(buffer, &buffer_size) != 0)
+ real_name = get_corrected_real_name(buffer);
+ else
+ real_name = ANONYMOUS_NAME;
+ }
+#elif defined(PLATFORM_UNIX) && !defined(PLATFORM_ANDROID)
+ if (real_name == NULL)
+ {
+ struct passwd *pwd;
- return real_name;
+ if ((pwd = getpwuid(getuid())) != NULL && strlen(pwd->pw_gecos) != 0)
+ real_name = get_corrected_real_name(pwd->pw_gecos);
+ else
+ real_name = ANONYMOUS_NAME;
}
-#else /* !PLATFORM_UNIX */
- return ANONYMOUS_NAME;
+#else
+ real_name = ANONYMOUS_NAME;
#endif
+
+ return real_name;
}
-char *getHomeDir()
+time_t getFileTimestampEpochSeconds(char *filename)
{
-#if defined(PLATFORM_UNIX)
- static char *home_dir = NULL;
-
- if (home_dir == NULL)
- {
- if ((home_dir = getenv("HOME")) == NULL)
- {
- struct passwd *pwd;
+ struct stat file_status;
- if ((pwd = getpwuid(getuid())) == NULL)
- home_dir = ".";
- else
- home_dir = getStringCopy(pwd->pw_dir);
- }
- }
+ if (stat(filename, &file_status) != 0) /* cannot stat file */
+ return 0;
- return home_dir;
-#else
- return ".";
-#endif
+ return file_status.st_mtime;
}
/* ------------------------------------------------------------------------- */
-/* various string functions */
+/* path manipulation functions */
/* ------------------------------------------------------------------------- */
-char *getPath2(char *path1, char *path2)
+static char *getLastPathSeparatorPtr(char *filename)
{
- char *complete_path = checked_malloc(strlen(path1) + 1 +
- strlen(path2) + 1);
+ char *last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_UNIX);
- sprintf(complete_path, "%s/%s", path1, path2);
- return complete_path;
+ if (last_separator == NULL) /* also try DOS/Windows variant */
+ last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_DOS);
+
+ return last_separator;
}
-char *getPath3(char *path1, char *path2, char *path3)
+char *getBaseNamePtr(char *filename)
+{
+ char *last_separator = getLastPathSeparatorPtr(filename);
+
+ if (last_separator != NULL)
+ return last_separator + 1; /* separator found: strip base path */
+ else
+ return filename; /* no separator found: filename has no path */
+}
+
+char *getBaseName(char *filename)
+{
+ return getStringCopy(getBaseNamePtr(filename));
+}
+
+char *getBaseNameNoSuffix(char *filename)
+{
+ char *basename = getStringCopy(getBaseNamePtr(filename));
+
+ // remove trailing suffix (separated by dot or hyphen)
+ if (basename[0] != '.' && basename[0] != '-')
+ {
+ if (strchr(basename, '.') != NULL)
+ *strchr(basename, '.') = '\0';
+
+ if (strchr(basename, '-') != NULL)
+ *strchr(basename, '-') = '\0';
+ }
+
+ return basename;
+}
+
+char *getBasePath(char *filename)
+{
+ char *basepath = getStringCopy(filename);
+ char *last_separator = getLastPathSeparatorPtr(basepath);
+
+ if (last_separator != NULL)
+ *last_separator = '\0'; /* separator found: strip basename */
+ else
+ basepath = "."; /* no separator found: use current path */
+
+ return basepath;
+}
+
+static char *getProgramMainDataPath()
+{
+ char *main_data_path = getStringCopy(program.command_basepath);
+
+#if defined(PLATFORM_MACOSX)
+ static char *main_data_binary_subdir = NULL;
+
+ if (main_data_binary_subdir == NULL)
+ {
+ main_data_binary_subdir = checked_malloc(strlen(program.program_title) + 1 +
+ strlen("app") + 1 +
+ strlen(MAC_APP_BINARY_SUBDIR) + 1);
+
+ sprintf(main_data_binary_subdir, "%s.app/%s",
+ program.program_title, MAC_APP_BINARY_SUBDIR);
+ }
+
+ // cut relative path to Mac OS X application binary directory from path
+ if (strSuffix(main_data_path, main_data_binary_subdir))
+ main_data_path[strlen(main_data_path) -
+ strlen(main_data_binary_subdir)] = '\0';
+
+ // cut trailing path separator from path (but not if path is root directory)
+ if (strSuffix(main_data_path, "/") && !strEqual(main_data_path, "/"))
+ main_data_path[strlen(main_data_path) - 1] = '\0';
+#endif
+
+ return main_data_path;
+}
+
+
+/* ------------------------------------------------------------------------- */
+/* various string functions */
+/* ------------------------------------------------------------------------- */
+
+char *getStringCat2WithSeparator(char *s1, char *s2, char *sep)
{
- char *complete_path = checked_malloc(strlen(path1) + 1 +
- strlen(path2) + 1 +
- strlen(path3) + 1);
+ if (s1 == NULL || s2 == NULL || sep == NULL)
+ return NULL;
+
+ char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
+ strlen(s2) + 1);
+
+ sprintf(complete_string, "%s%s%s", s1, sep, s2);
- sprintf(complete_path, "%s/%s/%s", path1, path2, path3);
- return complete_path;
+ return complete_string;
}
-static char *getStringCat2(char *s1, char *s2)
+char *getStringCat3WithSeparator(char *s1, char *s2, char *s3, char *sep)
{
- char *complete_string = checked_malloc(strlen(s1) + strlen(s2) + 1);
+ if (s1 == NULL || s2 == NULL || s3 == NULL || sep == NULL)
+ return NULL;
+
+ char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
+ strlen(s2) + strlen(sep) +
+ strlen(s3) + 1);
+
+ sprintf(complete_string, "%s%s%s%s%s", s1, sep, s2, sep, s3);
- sprintf(complete_string, "%s%s", s1, s2);
return complete_string;
}
-char *getStringCopy(char *s)
+char *getStringCat2(char *s1, char *s2)
+{
+ return getStringCat2WithSeparator(s1, s2, "");
+}
+
+char *getStringCat3(char *s1, char *s2, char *s3)
+{
+ return getStringCat3WithSeparator(s1, s2, s3, "");
+}
+
+char *getPath2(char *path1, char *path2)
+{
+#if defined(PLATFORM_ANDROID)
+ // workaround for reading from assets directory -- skip "." subdirs in path
+ if (strEqual(path1, "."))
+ return getStringCopy(path2);
+ else if (strEqual(path2, "."))
+ return getStringCopy(path1);
+#endif
+
+ return getStringCat2WithSeparator(path1, path2, STRING_PATH_SEPARATOR);
+}
+
+char *getPath3(char *path1, char *path2, char *path3)
+{
+#if defined(PLATFORM_ANDROID)
+ // workaround for reading from assets directory -- skip "." subdirs in path
+ if (strEqual(path1, "."))
+ return getStringCat2WithSeparator(path2, path3, STRING_PATH_SEPARATOR);
+ else if (strEqual(path2, "."))
+ return getStringCat2WithSeparator(path1, path3, STRING_PATH_SEPARATOR);
+ else if (strEqual(path3, "."))
+ return getStringCat2WithSeparator(path1, path2, STRING_PATH_SEPARATOR);
+#endif
+
+ return getStringCat3WithSeparator(path1, path2, path3, STRING_PATH_SEPARATOR);
+}
+
+char *getImg2(char *path1, char *path2)
+{
+ char *filename = getPath2(path1, path2);
+
+ if (!fileExists(filename) && strSuffix(path2, ".png"))
+ {
+ // backward compatibility: if PNG file not found, check for PCX file
+ char *path2pcx = getStringCopy(path2);
+
+ strcpy(&path2pcx[strlen(path2pcx) - 3], "pcx");
+
+ free(filename);
+
+ filename = getPath2(path1, path2pcx);
+
+ free(path2pcx);
+ }
+
+ return filename;
+}
+
+char *getImg3(char *path1, char *path2, char *path3)
+{
+ char *filename = getPath3(path1, path2, path3);
+
+ if (!fileExists(filename) && strSuffix(path3, ".png"))
+ {
+ // backward compatibility: if PNG file not found, check for PCX file
+ char *path3pcx = getStringCopy(path3);
+
+ strcpy(&path3pcx[strlen(path3pcx) - 3], "pcx");
+
+ free(filename);
+
+ filename = getPath3(path1, path2, path3pcx);
+
+ free(path3pcx);
+ }
+
+ return filename;
+}
+
+char *getStringCopy(const char *s)
{
char *s_copy;
return NULL;
s_copy = checked_malloc(strlen(s) + 1);
-
strcpy(s_copy, s);
+
+ return s_copy;
+}
+
+char *getStringCopyN(const char *s, int n)
+{
+ char *s_copy;
+ int s_len = MAX(0, n);
+
+ if (s == NULL)
+ return NULL;
+
+ s_copy = checked_malloc(s_len + 1);
+ strncpy(s_copy, s, s_len);
+ s_copy[s_len] = '\0';
+
+ return s_copy;
+}
+
+char *getStringCopyNStatic(const char *s, int n)
+{
+ static char *s_copy = NULL;
+
+ checked_free(s_copy);
+
+ s_copy = getStringCopyN(s, n);
+
return s_copy;
}
-char *getStringToLower(char *s)
+char *getStringToLower(const char *s)
{
char *s_copy = checked_malloc(strlen(s) + 1);
char *s_ptr = s_copy;
return s_copy;
}
+void setString(char **old_value, char *new_value)
+{
+ checked_free(*old_value);
+
+ *old_value = getStringCopy(new_value);
+}
+
+boolean strEqual(char *s1, char *s2)
+{
+ return (s1 == NULL && s2 == NULL ? TRUE :
+ s1 == NULL && s2 != NULL ? FALSE :
+ s1 != NULL && s2 == NULL ? FALSE :
+ strcmp(s1, s2) == 0);
+}
+
+boolean strEqualN(char *s1, char *s2, int n)
+{
+ return (s1 == NULL && s2 == NULL ? TRUE :
+ s1 == NULL && s2 != NULL ? FALSE :
+ s1 != NULL && s2 == NULL ? FALSE :
+ strncmp(s1, s2, n) == 0);
+}
+
+boolean strPrefix(char *s, char *prefix)
+{
+ return (s == NULL && prefix == NULL ? TRUE :
+ s == NULL && prefix != NULL ? FALSE :
+ s != NULL && prefix == NULL ? FALSE :
+ strncmp(s, prefix, strlen(prefix)) == 0);
+}
+
+boolean strSuffix(char *s, char *suffix)
+{
+ return (s == NULL && suffix == NULL ? TRUE :
+ s == NULL && suffix != NULL ? FALSE :
+ s != NULL && suffix == NULL ? FALSE :
+ strlen(s) < strlen(suffix) ? FALSE :
+ strncmp(&s[strlen(s) - strlen(suffix)], suffix, strlen(suffix)) == 0);
+}
+
+boolean strPrefixLower(char *s, char *prefix)
+{
+ char *s_lower = getStringToLower(s);
+ boolean match = strPrefix(s_lower, prefix);
+
+ free(s_lower);
+
+ return match;
+}
+
+boolean strSuffixLower(char *s, char *suffix)
+{
+ char *s_lower = getStringToLower(s);
+ boolean match = strSuffix(s_lower, suffix);
+
+ free(s_lower);
+
+ return match;
+}
+
/* ------------------------------------------------------------------------- */
/* command line option handling functions */
/* ------------------------------------------------------------------------- */
-static void printUsage()
-{
- printf("\n"
- "Usage: %s [OPTION]... [HOSTNAME [PORT]]\n"
- "\n"
- "Options:\n"
- " -d, --display HOSTNAME[:SCREEN] specify X server display\n"
- " -b, --basepath DIRECTORY alternative base DIRECTORY\n"
- " -l, --level DIRECTORY alternative level DIRECTORY\n"
- " -g, --graphics DIRECTORY alternative graphics DIRECTORY\n"
- " -s, --sounds DIRECTORY alternative sounds DIRECTORY\n"
- " -m, --music DIRECTORY alternative music DIRECTORY\n"
- " -n, --network network multiplayer game\n"
- " --serveronly only start network server\n"
- " -v, --verbose verbose mode\n"
- " --debug display debugging information\n"
- " -e, --execute COMMAND execute batch COMMAND:\n"
- "\n"
- "Valid commands for '--execute' option:\n"
- " \"print graphicsinfo.conf\" print default graphics config\n"
- " \"print soundsinfo.conf\" print default sounds config\n"
- " \"print musicinfo.conf\" print default music config\n"
- " \"dump level FILE\" dump level data from FILE\n"
- " \"dump tape FILE\" dump tape data from FILE\n"
- " \"autoplay LEVELDIR\" play level tapes for LEVELDIR\n"
- "\n",
- program.command_basename);
-}
-
-void GetOptions(char *argv[])
-{
- char **options_left = &argv[1];
+void GetOptions(int argc, char *argv[],
+ void (*print_usage_function)(void),
+ void (*print_version_function)(void))
+{
+ char *ro_base_path = RO_BASE_PATH;
+ char *rw_base_path = RW_BASE_PATH;
+ char **argvplus = checked_calloc((argc + 1) * sizeof(char **));
+ char **options_left = &argvplus[1];
+
+ /* replace original "argv" with null-terminated array of string pointers */
+ while (argc--)
+ argvplus[argc] = argv[argc];
+
+ /* if the program is configured to start from current directory (default),
+ determine program package directory from program binary (some versions
+ of KDE/Konqueror and Mac OS X (especially "Mavericks") apparently do not
+ set the current working directory to the program package directory) */
+
+ if (strEqual(ro_base_path, "."))
+ ro_base_path = getProgramMainDataPath();
+ if (strEqual(rw_base_path, "."))
+ rw_base_path = getProgramMainDataPath();
/* initialize global program options */
options.display_name = NULL;
options.server_host = NULL;
options.server_port = 0;
- options.ro_base_directory = RO_BASE_PATH;
- options.rw_base_directory = RW_BASE_PATH;
- options.level_directory = RO_BASE_PATH "/" LEVELS_DIRECTORY;
- options.graphics_directory = RO_BASE_PATH "/" GRAPHICS_DIRECTORY;
- options.sounds_directory = RO_BASE_PATH "/" SOUNDS_DIRECTORY;
- options.music_directory = RO_BASE_PATH "/" MUSIC_DIRECTORY;
+
+ options.ro_base_directory = ro_base_path;
+ options.rw_base_directory = rw_base_path;
+ options.level_directory = getPath2(ro_base_path, LEVELS_DIRECTORY);
+ options.graphics_directory = getPath2(ro_base_path, GRAPHICS_DIRECTORY);
+ options.sounds_directory = getPath2(ro_base_path, SOUNDS_DIRECTORY);
+ options.music_directory = getPath2(ro_base_path, MUSIC_DIRECTORY);
+ options.docs_directory = getPath2(ro_base_path, DOCS_DIRECTORY);
+
options.execute_command = NULL;
+ options.special_flags = NULL;
+
options.serveronly = FALSE;
options.network = FALSE;
options.verbose = FALSE;
options.debug = FALSE;
+#if 1
+ options.verbose = TRUE;
+#else
+#if !defined(PLATFORM_UNIX)
+ if (*options_left == NULL) /* no options given -- enable verbose mode */
+ options.verbose = TRUE;
+#endif
+#endif
+
while (*options_left)
{
char option_str[MAX_OPTION_LEN];
strcpy(option_str, option); /* copy argument into buffer */
option = option_str;
- if (strcmp(option, "--") == 0) /* stop scanning arguments */
+ if (strEqual(option, "--")) /* stop scanning arguments */
break;
- if (strncmp(option, "--", 2) == 0) /* treat '--' like '-' */
+ if (strPrefix(option, "--")) /* treat '--' like '-' */
option++;
option_arg = strchr(option, '=');
option_len = strlen(option);
- if (strcmp(option, "-") == 0)
+ if (strEqual(option, "-"))
+ {
Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
+ }
else if (strncmp(option, "-help", option_len) == 0)
{
- printUsage();
+ print_usage_function();
exit(0);
}
Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
/* this should be extended to separate options for ro and rw data */
- options.ro_base_directory = option_arg;
- options.rw_base_directory = option_arg;
+ options.ro_base_directory = ro_base_path = option_arg;
+ options.rw_base_directory = rw_base_path = option_arg;
if (option_arg == next_option)
options_left++;
- /* adjust path for level directory accordingly */
- options.level_directory =
- getPath2(options.ro_base_directory, LEVELS_DIRECTORY);
+ /* adjust paths for sub-directories in base directory accordingly */
+ options.level_directory = getPath2(ro_base_path, LEVELS_DIRECTORY);
+ options.graphics_directory = getPath2(ro_base_path, GRAPHICS_DIRECTORY);
+ options.sounds_directory = getPath2(ro_base_path, SOUNDS_DIRECTORY);
+ options.music_directory = getPath2(ro_base_path, MUSIC_DIRECTORY);
+ options.docs_directory = getPath2(ro_base_path, DOCS_DIRECTORY);
}
else if (strncmp(option, "-levels", option_len) == 0)
{
{
options.serveronly = TRUE;
}
+ else if (strncmp(option, "-debug", option_len) == 0)
+ {
+ options.debug = TRUE;
+ }
else if (strncmp(option, "-verbose", option_len) == 0)
{
options.verbose = TRUE;
}
- else if (strncmp(option, "-debug", option_len) == 0)
+ else if (strncmp(option, "-version", option_len) == 0 ||
+ strncmp(option, "-V", option_len) == 0)
{
- options.debug = TRUE;
+ print_version_function();
+
+ exit(0);
+ }
+ else if (strPrefix(option, "-D"))
+ {
+ options.special_flags = getStringCopy(&option[2]);
}
else if (strncmp(option, "-execute", option_len) == 0)
{
options.execute_command = option_arg;
if (option_arg == next_option)
options_left++;
+
+ /* when doing batch processing, always enable verbose mode (warnings) */
+ options.verbose = TRUE;
+ }
+#if defined(PLATFORM_MACOSX)
+ else if (strPrefix(option, "-psn"))
+ {
+ /* ignore process serial number when launched via GUI on Mac OS X */
}
+#endif
else if (*option == '-')
{
Error(ERR_EXIT_HELP, "unrecognized option '%s'", option_str);
/* error handling functions */
/* ------------------------------------------------------------------------- */
+#define MAX_INTERNAL_ERROR_SIZE 1024
+
/* used by SetError() and GetError() to store internal error messages */
-static char internal_error[1024]; /* this is bad */
+static char internal_error[MAX_INTERNAL_ERROR_SIZE];
void SetError(char *format, ...)
{
va_list ap;
va_start(ap, format);
- vsprintf(internal_error, format, ap);
+ vsnprintf(internal_error, MAX_INTERNAL_ERROR_SIZE, format, ap);
va_end(ap);
}
{
static boolean last_line_was_separator = FALSE;
char *process_name = "";
- FILE *error = stderr;
- char *newline = "\n";
+
+ 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 warnings only when running in verbose mode */
if (mode & ERR_WARN && !options.verbose)
return;
- if (mode == ERR_RETURN_LINE)
+ if (mode == ERR_INFO_LINE)
{
if (!last_line_was_separator)
- fprintf_line(error, format, 79);
+ printf_log_line(format, 79);
last_line_was_separator = TRUE;
last_line_was_separator = FALSE;
-#if defined(PLATFORM_MSDOS)
- newline = "\r\n";
-
- if ((error = openErrorFile()) == NULL)
- {
- printf("Cannot write to error output file!%s", newline);
- program.exit_function(1);
- }
-#endif
-
if (mode & ERR_SOUND_SERVER)
process_name = " sound server";
else if (mode & ERR_NETWORK_SERVER)
if (format)
{
- va_list ap;
-
- fprintf(error, "%s%s: ", program.command_basename, process_name);
+#if !defined(PLATFORM_ANDROID)
+ printf_log_nonewline("%s%s: ", program.command_basename, process_name);
+#endif
if (mode & ERR_WARN)
- fprintf(error, "warning: ");
+ printf_log_nonewline("warning: ");
+
+ if (mode & ERR_EXIT)
+ printf_log_nonewline("fatal error: ");
+
+ va_list ap;
va_start(ap, format);
- vfprintf(error, format, ap);
+ vprintf_log(format, ap);
va_end(ap);
-
- fprintf(error, "%s", newline);
+
+ if ((mode & ERR_EXIT) && !(mode & ERR_FROM_SERVER))
+ {
+ va_start(ap, format);
+ program.exit_message_function(format, ap);
+ va_end(ap);
+ }
}
if (mode & ERR_HELP)
- fprintf(error, "%s: Try option '--help' for more information.%s",
- program.command_basename, newline);
+ printf_log("%s: Try option '--help' for more information.",
+ program.command_basename);
if (mode & ERR_EXIT)
- fprintf(error, "%s%s: aborting%s",
- program.command_basename, process_name, newline);
-
- if (error != stderr)
- fclose(error);
+ printf_log("%s%s: aborting", program.command_basename, process_name);
if (mode & ERR_EXIT)
{
/* ------------------------------------------------------------------------- */
-/* memory allocation functions */
+/* checked memory allocation and freeing functions */
/* ------------------------------------------------------------------------- */
-void *checked_malloc(unsigned long size)
+void *checked_malloc(unsigned int size)
{
void *ptr;
return ptr;
}
-void *checked_calloc(unsigned long size)
+void *checked_calloc(unsigned int size)
{
void *ptr;
return ptr;
}
-void *checked_realloc(void *ptr, unsigned long size)
+void *checked_realloc(void *ptr, unsigned int size)
{
ptr = realloc(ptr, size);
return ptr;
}
+void checked_free(void *ptr)
+{
+ if (ptr != NULL) /* this check should be done by free() anyway */
+ free(ptr);
+}
+
+void clear_mem(void *ptr, unsigned int size)
+{
+#if defined(PLATFORM_WIN32)
+ /* for unknown reason, memset() sometimes crashes when compiled with MinGW */
+ char *cptr = (char *)ptr;
+
+ while (size--)
+ *cptr++ = 0;
+#else
+ memset(ptr, 0, size);
+#endif
+}
+
/* ------------------------------------------------------------------------- */
/* various helper functions */
/* ------------------------------------------------------------------------- */
-inline void swap_numbers(int *i1, int *i2)
+void swap_numbers(int *i1, int *i2)
{
int help = *i1;
*i2 = help;
}
-inline void swap_number_pairs(int *x1, int *y1, int *x2, int *y2)
+void swap_number_pairs(int *x1, int *y1, int *x2, int *y2)
{
int help_x = *x1;
int help_y = *y1;
*y2 = help_y;
}
-short getFile16BitInteger(FILE *file, int byte_order)
+/* the "put" variants of the following file access functions check for the file
+ pointer being != NULL and return the number of bytes they have or would have
+ written; this allows for chunk writing functions to first determine the size
+ of the (not yet written) chunk, write the correct chunk size and finally
+ write the chunk itself */
+
+int getFile8BitInteger(File *file)
{
- if (byte_order == BYTE_ORDER_BIG_ENDIAN)
- return ((fgetc(file) << 8) |
- (fgetc(file) << 0));
- else /* BYTE_ORDER_LITTLE_ENDIAN */
- return ((fgetc(file) << 0) |
- (fgetc(file) << 8));
+ return getByteFromFile(file);
+}
+
+int putFile8BitInteger(FILE *file, int value)
+{
+ if (file != NULL)
+ fputc(value, file);
+
+ return 1;
}
-void putFile16BitInteger(FILE *file, short value, int byte_order)
+int getFile16BitInteger(File *file, int byte_order)
{
if (byte_order == BYTE_ORDER_BIG_ENDIAN)
- {
- fputc((value >> 8) & 0xff, file);
- fputc((value >> 0) & 0xff, file);
- }
+ return ((getByteFromFile(file) << 8) |
+ (getByteFromFile(file) << 0));
else /* BYTE_ORDER_LITTLE_ENDIAN */
+ return ((getByteFromFile(file) << 0) |
+ (getByteFromFile(file) << 8));
+}
+
+int putFile16BitInteger(FILE *file, int value, int byte_order)
+{
+ if (file != NULL)
{
- fputc((value >> 0) & 0xff, file);
- fputc((value >> 8) & 0xff, file);
+ if (byte_order == BYTE_ORDER_BIG_ENDIAN)
+ {
+ fputc((value >> 8) & 0xff, file);
+ fputc((value >> 0) & 0xff, file);
+ }
+ else /* BYTE_ORDER_LITTLE_ENDIAN */
+ {
+ fputc((value >> 0) & 0xff, file);
+ fputc((value >> 8) & 0xff, file);
+ }
}
+
+ return 2;
}
-int getFile32BitInteger(FILE *file, int byte_order)
+int getFile32BitInteger(File *file, int byte_order)
{
if (byte_order == BYTE_ORDER_BIG_ENDIAN)
- return ((fgetc(file) << 24) |
- (fgetc(file) << 16) |
- (fgetc(file) << 8) |
- (fgetc(file) << 0));
+ return ((getByteFromFile(file) << 24) |
+ (getByteFromFile(file) << 16) |
+ (getByteFromFile(file) << 8) |
+ (getByteFromFile(file) << 0));
else /* BYTE_ORDER_LITTLE_ENDIAN */
- return ((fgetc(file) << 0) |
- (fgetc(file) << 8) |
- (fgetc(file) << 16) |
- (fgetc(file) << 24));
+ return ((getByteFromFile(file) << 0) |
+ (getByteFromFile(file) << 8) |
+ (getByteFromFile(file) << 16) |
+ (getByteFromFile(file) << 24));
}
-void putFile32BitInteger(FILE *file, int value, int byte_order)
+int putFile32BitInteger(FILE *file, int value, int byte_order)
{
- if (byte_order == BYTE_ORDER_BIG_ENDIAN)
- {
- fputc((value >> 24) & 0xff, file);
- fputc((value >> 16) & 0xff, file);
- fputc((value >> 8) & 0xff, file);
- fputc((value >> 0) & 0xff, file);
- }
- else /* BYTE_ORDER_LITTLE_ENDIAN */
+ if (file != NULL)
{
- fputc((value >> 0) & 0xff, file);
- fputc((value >> 8) & 0xff, file);
- fputc((value >> 16) & 0xff, file);
- fputc((value >> 24) & 0xff, file);
+ if (byte_order == BYTE_ORDER_BIG_ENDIAN)
+ {
+ fputc((value >> 24) & 0xff, file);
+ fputc((value >> 16) & 0xff, file);
+ fputc((value >> 8) & 0xff, file);
+ fputc((value >> 0) & 0xff, file);
+ }
+ else /* BYTE_ORDER_LITTLE_ENDIAN */
+ {
+ fputc((value >> 0) & 0xff, file);
+ fputc((value >> 8) & 0xff, file);
+ fputc((value >> 16) & 0xff, file);
+ fputc((value >> 24) & 0xff, file);
+ }
}
+
+ return 4;
}
-boolean getFileChunk(FILE *file, char *chunk_name, int *chunk_size,
+boolean getFileChunk(File *file, char *chunk_name, int *chunk_size,
int byte_order)
{
const int chunk_name_length = 4;
/* read chunk name */
- fgets(chunk_name, chunk_name_length + 1, file);
+ if (getStringFromFile(file, chunk_name, chunk_name_length + 1) == NULL)
+ return FALSE;
if (chunk_size != NULL)
{
*chunk_size = getFile32BitInteger(file, byte_order);
}
- return (feof(file) || ferror(file) ? FALSE : TRUE);
+ return (checkEndOfFile(file) ? FALSE : TRUE);
}
-void putFileChunk(FILE *file, char *chunk_name, int chunk_size,
- int byte_order)
+int putFileChunk(FILE *file, char *chunk_name, int chunk_size,
+ int byte_order)
{
+ int num_bytes = 0;
+
/* write chunk name */
- fputs(chunk_name, file);
+ if (file != NULL)
+ fputs(chunk_name, file);
+
+ num_bytes += strlen(chunk_name);
if (chunk_size >= 0)
{
/* write chunk size */
- putFile32BitInteger(file, chunk_size, byte_order);
+ if (file != NULL)
+ putFile32BitInteger(file, chunk_size, byte_order);
+
+ num_bytes += 4;
}
+
+ return num_bytes;
+}
+
+int getFileVersion(File *file)
+{
+ int version_major = getByteFromFile(file);
+ int version_minor = getByteFromFile(file);
+ int version_patch = getByteFromFile(file);
+ int version_build = getByteFromFile(file);
+
+ return VERSION_IDENT(version_major, version_minor, version_patch,
+ version_build);
}
-int getFileVersion(FILE *file)
+int putFileVersion(FILE *file, int version)
{
- int version_major, version_minor, version_patch;
+ if (file != NULL)
+ {
+ int version_major = VERSION_MAJOR(version);
+ int version_minor = VERSION_MINOR(version);
+ int version_patch = VERSION_PATCH(version);
+ int version_build = VERSION_BUILD(version);
+
+ fputc(version_major, file);
+ fputc(version_minor, file);
+ fputc(version_patch, file);
+ fputc(version_build, file);
+ }
+
+ return 4;
+}
- version_major = fgetc(file);
- version_minor = fgetc(file);
- version_patch = fgetc(file);
- fgetc(file); /* not used */
+void ReadBytesFromFile(File *file, byte *buffer, unsigned int bytes)
+{
+ int i;
- return VERSION_IDENT(version_major, version_minor, version_patch);
+ for (i = 0; i < bytes && !checkEndOfFile(file); i++)
+ buffer[i] = getByteFromFile(file);
}
-void putFileVersion(FILE *file, int version)
+void WriteBytesToFile(FILE *file, byte *buffer, unsigned int bytes)
{
- int version_major = VERSION_MAJOR(version);
- int version_minor = VERSION_MINOR(version);
- int version_patch = VERSION_PATCH(version);
+ int i;
- fputc(version_major, file);
- fputc(version_minor, file);
- fputc(version_patch, file);
- fputc(0, file); /* not used */
+ for(i = 0; i < bytes; i++)
+ fputc(buffer[i], file);
}
-void ReadUnusedBytesFromFile(FILE *file, unsigned long bytes)
+void ReadUnusedBytesFromFile(File *file, unsigned int bytes)
{
- while (bytes-- && !feof(file))
- fgetc(file);
+ while (bytes-- && !checkEndOfFile(file))
+ getByteFromFile(file);
}
-void WriteUnusedBytesToFile(FILE *file, unsigned long bytes)
+void WriteUnusedBytesToFile(FILE *file, unsigned int bytes)
{
while (bytes--)
fputc(0, file);
{ 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_End, "XK_End", "end" },
{ KSYM_Page_Up, "XK_Page_Up", "page up" },
{ KSYM_Page_Down, "XK_Page_Down", "page down" },
- { KSYM_Menu, "XK_Menu", "menu" }, /* Win-Menu */
+
+#if defined(TARGET_SDL2)
+ { KSYM_Menu, "XK_Menu", "menu" }, /* menu key */
+ { KSYM_Back, "XK_Back", "back" }, /* back key */
+#endif
/* ASCII 0x20 to 0x40 keys (except numbers) */
{ KSYM_space, "XK_space", "space" },
/* more ASCII keys */
{ KSYM_bracketleft, "XK_bracketleft", "[" },
- { KSYM_backslash, "XK_backslash", "backslash" },
+ { KSYM_backslash, "XK_backslash", "\\" },
{ KSYM_bracketright,"XK_bracketright", "]" },
- { KSYM_asciicircum, "XK_asciicircum", "circumflex" },
+ { KSYM_asciicircum, "XK_asciicircum", "^" },
{ KSYM_underscore, "XK_underscore", "_" },
{ KSYM_grave, "XK_grave", "grave" },
{ KSYM_quoteleft, "XK_quoteleft", "quote left" },
{ KSYM_braceleft, "XK_braceleft", "brace left" },
{ KSYM_bar, "XK_bar", "bar" },
{ KSYM_braceright, "XK_braceright", "brace right" },
- { KSYM_asciitilde, "XK_asciitilde", "ascii tilde" },
+ { KSYM_asciitilde, "XK_asciitilde", "~" },
/* special (non-ASCII) keys */
- { KSYM_Adiaeresis, "XK_Adiaeresis", "Ä" },
- { KSYM_Odiaeresis, "XK_Odiaeresis", "Ö" },
- { KSYM_Udiaeresis, "XK_Udiaeresis", "Ü" },
- { KSYM_adiaeresis, "XK_adiaeresis", "ä" },
- { KSYM_odiaeresis, "XK_odiaeresis", "ö" },
- { KSYM_udiaeresis, "XK_udiaeresis", "ü" },
+ { KSYM_degree, "XK_degree", "degree" },
+ { KSYM_Adiaeresis, "XK_Adiaeresis", "A umlaut" },
+ { KSYM_Odiaeresis, "XK_Odiaeresis", "O umlaut" },
+ { KSYM_Udiaeresis, "XK_Udiaeresis", "U umlaut" },
+ { KSYM_adiaeresis, "XK_adiaeresis", "a umlaut" },
+ { KSYM_odiaeresis, "XK_odiaeresis", "o umlaut" },
+ { KSYM_udiaeresis, "XK_udiaeresis", "u umlaut" },
{ KSYM_ssharp, "XK_ssharp", "sharp s" },
+#if defined(TARGET_SDL2)
+ /* special (non-ASCII) keys (UTF-8, for reverse mapping only) */
+ { KSYM_degree, "XK_degree", "\xc2\xb0" },
+ { KSYM_Adiaeresis, "XK_Adiaeresis", "\xc3\x84" },
+ { KSYM_Odiaeresis, "XK_Odiaeresis", "\xc3\x96" },
+ { KSYM_Udiaeresis, "XK_Udiaeresis", "\xc3\x9c" },
+ { KSYM_adiaeresis, "XK_adiaeresis", "\xc3\xa4" },
+ { KSYM_odiaeresis, "XK_odiaeresis", "\xc3\xb6" },
+ { KSYM_udiaeresis, "XK_udiaeresis", "\xc3\xbc" },
+ { KSYM_ssharp, "XK_ssharp", "\xc3\x9f" },
+
+ /* other keys (for reverse mapping only) */
+ { KSYM_space, "XK_space", " " },
+#endif
+
+#if defined(TARGET_SDL2)
+ /* keypad keys are not in numerical order in SDL2 */
+ { KSYM_KP_0, "XK_KP_0", "keypad 0" },
+ { KSYM_KP_1, "XK_KP_1", "keypad 1" },
+ { KSYM_KP_2, "XK_KP_2", "keypad 2" },
+ { KSYM_KP_3, "XK_KP_3", "keypad 3" },
+ { KSYM_KP_4, "XK_KP_4", "keypad 4" },
+ { KSYM_KP_5, "XK_KP_5", "keypad 5" },
+ { KSYM_KP_6, "XK_KP_6", "keypad 6" },
+ { KSYM_KP_7, "XK_KP_7", "keypad 7" },
+ { KSYM_KP_8, "XK_KP_8", "keypad 8" },
+ { KSYM_KP_9, "XK_KP_9", "keypad 9" },
+#endif
+
/* end-of-array identifier */
{ 0, NULL, NULL }
};
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, "function F%d", (int)(key - KSYM_FKEY_FIRST + 1));
+ sprintf(name_buffer, "F%d", (int)(key - KSYM_FKEY_FIRST + 1));
else if (key == KSYM_UNDEFINED)
strcpy(name_buffer, "(undefined)");
else
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)
while (translate_key[++i].x11name);
if (!translate_key[i].x11name)
- sprintf(name_buffer, "0x%04lx", (unsigned long)key);
+ sprintf(name_buffer, "0x%04x", (unsigned int)key);
}
*x11name = name_buffer;
else if (mode == TRANSLATE_KEYNAME_TO_KEYSYM)
{
Key key = KSYM_UNDEFINED;
+ char *name_ptr = *name;
- i = 0;
- do
+ if (strlen(*name) == 1)
{
- if (strcmp(translate_key[i].name, *name) == 0)
- {
- key = translate_key[i].key;
- break;
- }
- }
- while (translate_key[++i].x11name);
+ char c = name_ptr[0];
- if (key == KSYM_UNDEFINED)
- Error(ERR_WARN, "getKeyFromKeyName(): not completely implemented");
-
- *keysym = key;
+ if (c >= 'A' && c <= 'Z')
+ key = KSYM_A + (Key)(c - 'A');
+ else if (c >= 'a' && c <= 'z')
+ key = KSYM_a + (Key)(c - 'a');
+ else if (c >= '0' && c <= '9')
+ key = KSYM_0 + (Key)(c - '0');
+ }
+
+ if (key == KSYM_UNDEFINED)
+ {
+ i = 0;
+
+ do
+ {
+ if (strEqual(translate_key[i].name, *name))
+ {
+ key = translate_key[i].key;
+ break;
+ }
+ }
+ while (translate_key[++i].x11name);
+ }
+
+ if (key == KSYM_UNDEFINED)
+ Error(ERR_WARN, "getKeyFromKeyName(): not completely implemented");
+
+ *keysym = key;
}
else if (mode == TRANSLATE_X11KEYNAME_TO_KEYSYM)
{
Key key = KSYM_UNDEFINED;
char *name_ptr = *x11name;
- if (strncmp(name_ptr, "XK_", 3) == 0 && strlen(name_ptr) == 4)
+ if (strPrefix(name_ptr, "XK_") && strlen(name_ptr) == 4)
{
char c = name_ptr[3];
else if (c >= '0' && c <= '9')
key = KSYM_0 + (Key)(c - '0');
}
- else if (strncmp(name_ptr, "XK_KP_", 6) == 0 && strlen(name_ptr) == 7)
+#if !defined(TARGET_SDL2)
+ else if (strPrefix(name_ptr, "XK_KP_") && strlen(name_ptr) == 7)
{
char c = name_ptr[6];
if (c >= '0' && c <= '9')
- key = KSYM_0 + (Key)(c - '0');
+ key = KSYM_KP_0 + (Key)(c - '0');
}
- else if (strncmp(name_ptr, "XK_F", 4) == 0 && strlen(name_ptr) <= 6)
+#endif
+ else if (strPrefix(name_ptr, "XK_F") && strlen(name_ptr) <= 6)
{
char c1 = name_ptr[4];
char c2 = name_ptr[5];
if (d >= 1 && d <= KSYM_NUM_FKEYS)
key = KSYM_F1 + (Key)(d - 1);
}
- else if (strncmp(name_ptr, "XK_", 3) == 0)
+ else if (strPrefix(name_ptr, "XK_"))
{
i = 0;
do
{
- if (strcmp(name_ptr, translate_key[i].x11name) == 0)
+ if (strEqual(name_ptr, translate_key[i].x11name))
{
key = translate_key[i].key;
break;
}
while (translate_key[++i].x11name);
}
- else if (strncmp(name_ptr, "0x", 2) == 0)
+ else if (strPrefix(name_ptr, "0x"))
{
- unsigned long value = 0;
+ unsigned int value = 0;
name_ptr += 2;
char getCharFromKey(Key key)
{
+ static struct
+ {
+ Key key;
+ byte key_char;
+ } translate_key_char[] =
+ {
+ /* special (non-ASCII) keys (ISO-8859-1) */
+ { KSYM_degree, CHAR_BYTE_DEGREE },
+ { KSYM_Adiaeresis, CHAR_BYTE_UMLAUT_A },
+ { KSYM_Odiaeresis, CHAR_BYTE_UMLAUT_O },
+ { KSYM_Udiaeresis, CHAR_BYTE_UMLAUT_U },
+ { KSYM_adiaeresis, CHAR_BYTE_UMLAUT_a },
+ { KSYM_odiaeresis, CHAR_BYTE_UMLAUT_o },
+ { KSYM_udiaeresis, CHAR_BYTE_UMLAUT_u },
+ { KSYM_ssharp, CHAR_BYTE_SHARP_S },
+
+ /* end-of-array identifier */
+ { 0, 0 }
+ };
+
char *keyname = getKeyNameFromKey(key);
- char letter = 0;
+ char c = 0;
if (strlen(keyname) == 1)
- letter = keyname[0];
- else if (strcmp(keyname, "space") == 0)
- letter = ' ';
- else if (strcmp(keyname, "circumflex") == 0)
- letter = '^';
+ c = keyname[0];
+ else if (strEqual(keyname, "space"))
+ c = ' ';
+ else
+ {
+ int i = 0;
+
+ do
+ {
+ if (key == translate_key_char[i].key)
+ {
+ c = translate_key_char[i].key_char;
+
+ break;
+ }
+ }
+ while (translate_key_char[++i].key_char);
+ }
+
+ return c;
+}
+
+char getValidConfigValueChar(char c)
+{
+ if (c == '#' || /* used to mark comments */
+ c == '\\') /* used to mark continued lines */
+ c = 0;
- return letter;
+ return c;
}
{
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" },
+ { "0", "zero", "null", },
+ { "1", "one", "first" },
+ { "2", "two", "second" },
+ { "3", "three", "third" },
+ { "4", "four", "fourth" },
+ { "5", "five", "fifth" },
+ { "6", "six", "sixth" },
+ { "7", "seven", "seventh" },
+ { "8", "eight", "eighth" },
+ { "9", "nine", "ninth" },
+ { "10", "ten", "tenth" },
+ { "11", "eleven", "eleventh" },
+ { "12", "twelve", "twelfth" },
+
+ { NULL, NULL, NULL },
};
int i, j;
char *s_lower = getStringToLower(s);
int result = -1;
- for (i=0; i<13; i++)
- for (j=0; j<3; j++)
- if (strcmp(s_lower, number_text[i][j]) == 0)
+ 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)
- 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);
char *s_lower = getStringToLower(s);
boolean result = FALSE;
- if (strcmp(s_lower, "true") == 0 ||
- strcmp(s_lower, "yes") == 0 ||
- strcmp(s_lower, "on") == 0 ||
+ if (strEqual(s_lower, "true") ||
+ strEqual(s_lower, "yes") ||
+ strEqual(s_lower, "on") ||
+ get_integer_from_string(s) == 1)
+ result = TRUE;
+
+ free(s_lower);
+
+ return result;
+}
+
+int get_switch3_from_string(char *s)
+{
+ char *s_lower = getStringToLower(s);
+ int result = FALSE;
+
+ if (strEqual(s_lower, "true") ||
+ strEqual(s_lower, "yes") ||
+ strEqual(s_lower, "on") ||
get_integer_from_string(s) == 1)
result = TRUE;
+ else if (strEqual(s_lower, "auto"))
+ result = AUTO;
free(s_lower);
{
ListNode *node_new = newListNode();
-#if 0
- printf("LIST: adding node with key '%s'\n", key);
-#endif
-
node_new->key = getStringCopy(key);
node_new->content = content;
node_new->next = *node_first;
+
+ if (*node_first)
+ (*node_first)->prev = node_new;
+
*node_first = node_new;
}
if (node_first == NULL || *node_first == NULL)
return;
-#if 0
- printf("[CHECKING LIST KEY '%s' == '%s']\n",
- (*node_first)->key, key);
-#endif
-
- if (strcmp((*node_first)->key, key) == 0)
+ if (strEqual((*node_first)->key, key))
{
-#if 0
- printf("[DELETING LIST ENTRY]\n");
-#endif
+ checked_free((*node_first)->key);
- free((*node_first)->key);
if (destructor_function)
destructor_function((*node_first)->content);
+
+ if ((*node_first)->next)
+ (*node_first)->next->prev = (*node_first)->prev;
+
+ checked_free(*node_first);
+
*node_first = (*node_first)->next;
}
else
if (node_first == NULL)
return NULL;
- if (strcmp(node_first->key, key) == 0)
+ if (strEqual(node_first->key, key))
return node_first;
else
return getNodeFromKey(node_first->next, key);
/* ------------------------------------------------------------------------- */
-/* functions for checking filenames */
+/* functions for file handling */
/* ------------------------------------------------------------------------- */
-boolean FileIsGraphic(char *filename)
+File *openFile(char *filename, char *mode)
{
- if (strlen(filename) > 4 &&
- strcmp(&filename[strlen(filename) - 4], ".pcx") == 0)
- return TRUE;
+ File *file = checked_calloc(sizeof(File));
- return FALSE;
+ file->file = fopen(filename, mode);
+
+ if (file->file != NULL)
+ {
+ file->filename = getStringCopy(filename);
+
+ return file;
+ }
+
+#if defined(PLATFORM_ANDROID)
+ file->asset_file = SDL_RWFromFile(filename, mode);
+
+ if (file->asset_file != NULL)
+ {
+ file->file_is_asset = TRUE;
+ file->filename = getStringCopy(filename);
+
+ return file;
+ }
+#endif
+
+ checked_free(file);
+
+ return NULL;
}
-boolean FileIsSound(char *basename)
+int closeFile(File *file)
{
- if (strlen(basename) > 4 &&
- strcmp(&basename[strlen(basename) - 4], ".wav") == 0)
- return TRUE;
+ if (file == NULL)
+ return -1;
- return FALSE;
+ int result = 0;
+
+#if defined(PLATFORM_ANDROID)
+ if (file->asset_file)
+ result = SDL_RWclose(file->asset_file);
+#endif
+
+ if (file->file)
+ result = fclose(file->file);
+
+ checked_free(file->filename);
+ checked_free(file);
+
+ return result;
}
-boolean FileIsMusic(char *basename)
+int checkEndOfFile(File *file)
{
- /* "music" can be a WAV (loop) file or (if compiled with SDL) a MOD file */
+#if defined(PLATFORM_ANDROID)
+ if (file->file_is_asset)
+ return file->end_of_file;
+#endif
- if (FileIsSound(basename))
- return TRUE;
+ return feof(file->file);
+}
-#if defined(TARGET_SDL)
- if (strlen(basename) > 4 &&
- (strcmp(&basename[strlen(basename) - 4], ".mod") == 0 ||
- strcmp(&basename[strlen(basename) - 4], ".MOD") == 0 ||
- strncmp(basename, "mod.", 4) == 0 ||
- strncmp(basename, "MOD.", 4) == 0))
- return TRUE;
+size_t readFile(File *file, void *buffer, size_t item_size, size_t num_items)
+{
+#if defined(PLATFORM_ANDROID)
+ if (file->file_is_asset)
+ {
+ if (file->end_of_file)
+ return 0;
+
+ size_t num_items_read =
+ SDL_RWread(file->asset_file, buffer, item_size, num_items);
+
+ if (num_items_read < num_items)
+ file->end_of_file = TRUE;
+
+ return num_items_read;
+ }
#endif
- return FALSE;
+ return fread(buffer, item_size, num_items, file->file);
}
-boolean FileIsArtworkType(char *basename, int type)
+int seekFile(File *file, long offset, int whence)
{
- if ((type == TREE_TYPE_GRAPHICS_DIR && FileIsGraphic(basename)) ||
- (type == TREE_TYPE_SOUNDS_DIR && FileIsSound(basename)) ||
- (type == TREE_TYPE_MUSIC_DIR && FileIsMusic(basename)))
- return TRUE;
+#if defined(PLATFORM_ANDROID)
+ if (file->file_is_asset)
+ {
+ int sdl_whence = (whence == SEEK_SET ? RW_SEEK_SET :
+ whence == SEEK_CUR ? RW_SEEK_CUR :
+ whence == SEEK_END ? RW_SEEK_END : 0);
- return FALSE;
+ return (SDL_RWseek(file->asset_file, offset, sdl_whence) == -1 ? -1 : 0);
+ }
+#endif
+
+ return fseek(file->file, offset, whence);
+}
+
+int getByteFromFile(File *file)
+{
+#if defined(PLATFORM_ANDROID)
+ if (file->file_is_asset)
+ {
+ if (file->end_of_file)
+ return EOF;
+
+ byte c;
+ size_t num_bytes_read = SDL_RWread(file->asset_file, &c, 1, 1);
+
+ if (num_bytes_read < 1)
+ file->end_of_file = TRUE;
+
+ return (file->end_of_file ? EOF : (int)c);
+ }
+#endif
+
+ return fgetc(file->file);
}
+char *getStringFromFile(File *file, char *line, int size)
+{
+#if defined(PLATFORM_ANDROID)
+ if (file->file_is_asset)
+ {
+ if (file->end_of_file)
+ return NULL;
+
+ char *line_ptr = line;
+ int num_bytes_read = 0;
+
+ while (num_bytes_read < size - 1 &&
+ SDL_RWread(file->asset_file, line_ptr, 1, 1) == 1 &&
+ *line_ptr++ != '\n')
+ num_bytes_read++;
+
+ *line_ptr = '\0';
+
+ if (strlen(line) == 0)
+ {
+ file->end_of_file = TRUE;
+
+ return NULL;
+ }
+
+ return line;
+ }
+#endif
+
+ return fgets(line, size, file->file);
+}
+
+
/* ------------------------------------------------------------------------- */
-/* functions for loading artwork configuration information */
+/* functions for directory handling */
/* ------------------------------------------------------------------------- */
-static int get_parameter_value(int type, char *value)
+Directory *openDirectory(char *dir_name)
{
- return (strcmp(value, ARG_UNDEFINED) == 0 ? ARG_UNDEFINED_VALUE :
- type == TYPE_INTEGER ? get_integer_from_string(value) :
- type == TYPE_BOOLEAN ? get_boolean_from_string(value) :
- -1);
+ Directory *dir = checked_calloc(sizeof(Directory));
+
+ dir->dir = opendir(dir_name);
+
+ if (dir->dir != NULL)
+ {
+ dir->filename = getStringCopy(dir_name);
+
+ return dir;
+ }
+
+#if defined(PLATFORM_ANDROID)
+ char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
+
+ dir->asset_toc_file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
+
+ checked_free(asset_toc_filename);
+
+ if (dir->asset_toc_file != NULL)
+ {
+ dir->directory_is_asset = TRUE;
+ dir->filename = getStringCopy(dir_name);
+
+ return dir;
+ }
+#endif
+
+ checked_free(dir);
+
+ return NULL;
}
-struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list,
- struct ConfigInfo *suffix_list,
- int num_file_list_entries)
+int closeDirectory(Directory *dir)
{
- struct FileInfo *file_list;
- int num_file_list_entries_found = 0;
- int num_suffix_list_entries = 0;
- int list_pos = 0;
- int i, j;
+ if (dir == NULL)
+ return -1;
- file_list = checked_calloc(num_file_list_entries * sizeof(struct FileInfo));
+ int result = 0;
- for (i=0; suffix_list[i].token != NULL; i++)
- num_suffix_list_entries++;
+#if defined(PLATFORM_ANDROID)
+ if (dir->asset_toc_file)
+ result = SDL_RWclose(dir->asset_toc_file);
+#endif
- /* always start with reliable default values */
- for (i=0; i<num_file_list_entries; i++)
+ if (dir->dir)
+ result = closedir(dir->dir);
+
+ if (dir->dir_entry)
+ freeDirectoryEntry(dir->dir_entry);
+
+ checked_free(dir->filename);
+ checked_free(dir);
+
+ return result;
+}
+
+DirectoryEntry *readDirectory(Directory *dir)
+{
+ if (dir->dir_entry)
+ freeDirectoryEntry(dir->dir_entry);
+
+ dir->dir_entry = NULL;
+
+#if defined(PLATFORM_ANDROID)
+ if (dir->directory_is_asset)
{
- file_list[i].token = NULL;
- file_list[i].default_filename = NULL;
- file_list[i].filename = NULL;
+ char line[MAX_LINE_LEN];
+ char *line_ptr = line;
+ int num_bytes_read = 0;
- if (num_suffix_list_entries > 0)
+ while (num_bytes_read < MAX_LINE_LEN - 1 &&
+ SDL_RWread(dir->asset_toc_file, line_ptr, 1, 1) == 1 &&
+ *line_ptr != '\n')
{
- int parameter_array_size = num_suffix_list_entries * sizeof(int);
+ line_ptr++;
+ num_bytes_read++;
+ }
- file_list[i].default_parameter = checked_calloc(parameter_array_size);
- file_list[i].parameter = checked_calloc(parameter_array_size);
+ *line_ptr = '\0';
- for (j=0; j<num_suffix_list_entries; j++)
- {
- int default_parameter =
- get_parameter_value(suffix_list[j].type, suffix_list[j].value);
+ if (strlen(line) == 0)
+ return NULL;
- file_list[i].default_parameter[j] = default_parameter;
- file_list[i].parameter[j] = default_parameter;
- }
+ dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
+
+ dir->dir_entry->is_directory = FALSE;
+ if (line[strlen(line) - 1] == '/')
+ {
+ dir->dir_entry->is_directory = TRUE;
+
+ line[strlen(line) - 1] = '\0';
}
+
+ dir->dir_entry->basename = getStringCopy(line);
+ dir->dir_entry->filename = getPath2(dir->filename, line);
+
+ return dir->dir_entry;
}
+#endif
+
+ struct dirent *dir_entry = readdir(dir->dir);
+
+ if (dir_entry == NULL)
+ return NULL;
+
+ dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
+
+ dir->dir_entry->basename = getStringCopy(dir_entry->d_name);
+ dir->dir_entry->filename = getPath2(dir->filename, dir_entry->d_name);
+
+ struct stat file_status;
+
+ dir->dir_entry->is_directory =
+ (stat(dir->dir_entry->filename, &file_status) == 0 &&
+ S_ISDIR(file_status.st_mode));
+
+ return dir->dir_entry;
+}
+
+void freeDirectoryEntry(DirectoryEntry *dir_entry)
+{
+ if (dir_entry == NULL)
+ return;
+
+ checked_free(dir_entry->basename);
+ checked_free(dir_entry->filename);
+ checked_free(dir_entry);
+}
- for (i=0; config_list[i].token != NULL; i++)
+
+/* ------------------------------------------------------------------------- */
+/* functions for checking files and filenames */
+/* ------------------------------------------------------------------------- */
+
+boolean directoryExists(char *dir_name)
+{
+ if (dir_name == NULL)
+ return FALSE;
+
+ struct stat file_status;
+ boolean success = (stat(dir_name, &file_status) == 0 &&
+ S_ISDIR(file_status.st_mode));
+
+#if defined(PLATFORM_ANDROID)
+ if (!success)
{
- int len_config_token = strlen(config_list[i].token);
- int len_config_value = strlen(config_list[i].value);
- boolean is_file_entry = TRUE;
+ // this might be an asset directory; check by trying to open toc file
+ char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
+ SDL_RWops *file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
+
+ checked_free(asset_toc_filename);
+
+ success = (file != NULL);
+
+ if (success)
+ SDL_RWclose(file);
+ }
+#endif
+
+ return success;
+}
+
+boolean fileExists(char *filename)
+{
+ if (filename == NULL)
+ return FALSE;
+
+ boolean success = (access(filename, F_OK) == 0);
+
+#if defined(PLATFORM_ANDROID)
+ if (!success)
+ {
+ // this might be an asset file; check by trying to open it
+ SDL_RWops *file = SDL_RWFromFile(filename, MODE_READ);
+
+ success = (file != NULL);
+
+ if (success)
+ SDL_RWclose(file);
+ }
+#endif
+
+ return success;
+}
+
+boolean fileHasPrefix(char *basename, char *prefix)
+{
+ static char *basename_lower = NULL;
+ int basename_length, prefix_length;
- for (j=0; suffix_list[j].token != NULL; j++)
+ checked_free(basename_lower);
+
+ if (basename == NULL || prefix == NULL)
+ return FALSE;
+
+ basename_lower = getStringToLower(basename);
+ basename_length = strlen(basename_lower);
+ prefix_length = strlen(prefix);
+
+ if (basename_length > prefix_length + 1 &&
+ basename_lower[prefix_length] == '.' &&
+ strncmp(basename_lower, prefix, prefix_length) == 0)
+ return TRUE;
+
+ return FALSE;
+}
+
+boolean fileHasSuffix(char *basename, char *suffix)
+{
+ static char *basename_lower = NULL;
+ int basename_length, suffix_length;
+
+ checked_free(basename_lower);
+
+ if (basename == NULL || suffix == NULL)
+ return FALSE;
+
+ basename_lower = getStringToLower(basename);
+ basename_length = strlen(basename_lower);
+ suffix_length = strlen(suffix);
+
+ if (basename_length > suffix_length + 1 &&
+ basename_lower[basename_length - suffix_length - 1] == '.' &&
+ strEqual(&basename_lower[basename_length - suffix_length], suffix))
+ return TRUE;
+
+ return FALSE;
+}
+
+static boolean FileCouldBeArtwork(char *filename)
+{
+ char *basename = getBaseNamePtr(filename);
+
+ return (!strEqual(basename, ".") &&
+ !strEqual(basename, "..") &&
+ !fileHasSuffix(basename, "txt") &&
+ !fileHasSuffix(basename, "conf") &&
+ !directoryExists(filename));
+}
+
+boolean FileIsGraphic(char *filename)
+{
+ return FileCouldBeArtwork(filename);
+}
+
+boolean FileIsSound(char *filename)
+{
+ return FileCouldBeArtwork(filename);
+}
+
+boolean FileIsMusic(char *filename)
+{
+ return FileCouldBeArtwork(filename);
+}
+
+boolean FileIsArtworkType(char *filename, int type)
+{
+ if ((type == TREE_TYPE_GRAPHICS_DIR && FileIsGraphic(filename)) ||
+ (type == TREE_TYPE_SOUNDS_DIR && FileIsSound(filename)) ||
+ (type == TREE_TYPE_MUSIC_DIR && FileIsMusic(filename)))
+ return TRUE;
+
+ return FALSE;
+}
+
+/* ------------------------------------------------------------------------- */
+/* functions for loading artwork configuration information */
+/* ------------------------------------------------------------------------- */
+
+char *get_mapped_token(char *token)
+{
+ /* !!! make this dynamically configurable (init.c:InitArtworkConfig) !!! */
+ static char *map_token_prefix[][2] =
+ {
+ { "char_procent", "char_percent" },
+ { NULL, }
+ };
+ int i;
+
+ for (i = 0; map_token_prefix[i][0] != NULL; i++)
+ {
+ int len_token_prefix = strlen(map_token_prefix[i][0]);
+
+ if (strncmp(token, map_token_prefix[i][0], len_token_prefix) == 0)
+ return getStringCat2(map_token_prefix[i][1], &token[len_token_prefix]);
+ }
+
+ return NULL;
+}
+
+/* This function checks if a string <s> of the format "string1, string2, ..."
+ exactly contains a string <s_contained>. */
+
+static boolean string_has_parameter(char *s, char *s_contained)
+{
+ char *substring;
+
+ if (s == NULL || s_contained == NULL)
+ return FALSE;
+
+ if (strlen(s_contained) > strlen(s))
+ return FALSE;
+
+ if (strncmp(s, s_contained, strlen(s_contained)) == 0)
+ {
+ char next_char = s[strlen(s_contained)];
+
+ /* check if next character is delimiter or whitespace */
+ return (next_char == ',' || next_char == '\0' ||
+ next_char == ' ' || next_char == '\t' ? TRUE : FALSE);
+ }
+
+ /* check if string contains another parameter string after a comma */
+ substring = strchr(s, ',');
+ if (substring == NULL) /* string does not contain a comma */
+ return FALSE;
+
+ /* advance string pointer to next character after the comma */
+ substring++;
+
+ /* skip potential whitespaces after the comma */
+ while (*substring == ' ' || *substring == '\t')
+ substring++;
+
+ return string_has_parameter(substring, s_contained);
+}
+
+int get_parameter_value(char *value_raw, char *suffix, int type)
+{
+ char *value = getStringToLower(value_raw);
+ int result = 0; /* probably a save default value */
+
+ if (strEqual(suffix, ".direction"))
+ {
+ result = (strEqual(value, "left") ? MV_LEFT :
+ strEqual(value, "right") ? MV_RIGHT :
+ strEqual(value, "up") ? MV_UP :
+ strEqual(value, "down") ? MV_DOWN : MV_NONE);
+ }
+ else if (strEqual(suffix, ".align"))
+ {
+ result = (strEqual(value, "left") ? ALIGN_LEFT :
+ strEqual(value, "right") ? ALIGN_RIGHT :
+ strEqual(value, "center") ? ALIGN_CENTER :
+ strEqual(value, "middle") ? ALIGN_CENTER : ALIGN_DEFAULT);
+ }
+ else if (strEqual(suffix, ".valign"))
+ {
+ result = (strEqual(value, "top") ? VALIGN_TOP :
+ strEqual(value, "bottom") ? VALIGN_BOTTOM :
+ strEqual(value, "middle") ? VALIGN_MIDDLE :
+ strEqual(value, "center") ? VALIGN_MIDDLE : VALIGN_DEFAULT);
+ }
+ else if (strEqual(suffix, ".anim_mode"))
+ {
+ result = (string_has_parameter(value, "none") ? ANIM_NONE :
+ string_has_parameter(value, "loop") ? ANIM_LOOP :
+ string_has_parameter(value, "linear") ? ANIM_LINEAR :
+ string_has_parameter(value, "pingpong") ? ANIM_PINGPONG :
+ string_has_parameter(value, "pingpong2") ? ANIM_PINGPONG2 :
+ string_has_parameter(value, "random") ? ANIM_RANDOM :
+ string_has_parameter(value, "ce_value") ? ANIM_CE_VALUE :
+ string_has_parameter(value, "ce_score") ? ANIM_CE_SCORE :
+ string_has_parameter(value, "ce_delay") ? ANIM_CE_DELAY :
+ string_has_parameter(value, "horizontal") ? ANIM_HORIZONTAL :
+ string_has_parameter(value, "vertical") ? ANIM_VERTICAL :
+ string_has_parameter(value, "centered") ? ANIM_CENTERED :
+ ANIM_DEFAULT);
+
+ if (string_has_parameter(value, "reverse"))
+ result |= ANIM_REVERSE;
+
+ if (string_has_parameter(value, "opaque_player"))
+ result |= ANIM_OPAQUE_PLAYER;
+
+ if (string_has_parameter(value, "static_panel"))
+ result |= ANIM_STATIC_PANEL;
+ }
+ else if (strEqual(suffix, ".class"))
+ {
+ result = get_hash_from_key(value);
+ }
+ else if (strEqual(suffix, ".style"))
+ {
+ result = STYLE_DEFAULT;
+
+ if (string_has_parameter(value, "accurate_borders"))
+ result |= STYLE_ACCURATE_BORDERS;
+
+ if (string_has_parameter(value, "inner_corners"))
+ result |= STYLE_INNER_CORNERS;
+ }
+ else if (strEqual(suffix, ".fade_mode"))
+ {
+ result = (string_has_parameter(value, "none") ? FADE_MODE_NONE :
+ string_has_parameter(value, "fade") ? FADE_MODE_FADE :
+ string_has_parameter(value, "crossfade") ? FADE_MODE_CROSSFADE :
+ string_has_parameter(value, "melt") ? FADE_MODE_MELT :
+ FADE_MODE_DEFAULT);
+ }
+ else if (strPrefix(suffix, ".font")) /* (may also be ".font_xyz") */
+ {
+ result = gfx.get_font_from_token_function(value);
+ }
+ else /* generic parameter of type integer or boolean */
+ {
+ result = (strEqual(value, ARG_UNDEFINED) ? ARG_UNDEFINED_VALUE :
+ type == TYPE_INTEGER ? get_integer_from_string(value) :
+ type == TYPE_BOOLEAN ? get_boolean_from_string(value) :
+ ARG_UNDEFINED_VALUE);
+ }
+
+ free(value);
+
+ return result;
+}
+
+struct ScreenModeInfo *get_screen_mode_from_string(char *screen_mode_string)
+{
+ static struct ScreenModeInfo screen_mode;
+ char *screen_mode_string_x = strchr(screen_mode_string, 'x');
+ char *screen_mode_string_copy;
+ char *screen_mode_string_pos_w;
+ char *screen_mode_string_pos_h;
+
+ if (screen_mode_string_x == NULL) /* invalid screen mode format */
+ return NULL;
+
+ screen_mode_string_copy = getStringCopy(screen_mode_string);
+
+ screen_mode_string_pos_w = screen_mode_string_copy;
+ screen_mode_string_pos_h = strchr(screen_mode_string_copy, 'x');
+ *screen_mode_string_pos_h++ = '\0';
+
+ screen_mode.width = atoi(screen_mode_string_pos_w);
+ screen_mode.height = atoi(screen_mode_string_pos_h);
+
+ return &screen_mode;
+}
+
+void get_aspect_ratio_from_screen_mode(struct ScreenModeInfo *screen_mode,
+ int *x, int *y)
+{
+ float aspect_ratio = (float)screen_mode->width / (float)screen_mode->height;
+ float aspect_ratio_new;
+ int i = 1;
+
+ do
+ {
+ *x = i * aspect_ratio + 0.000001;
+ *y = i;
+
+ aspect_ratio_new = (float)*x / (float)*y;
+
+ i++;
+ }
+ while (aspect_ratio_new != aspect_ratio && *y < screen_mode->height);
+}
+
+static void FreeCustomArtworkList(struct ArtworkListInfo *,
+ struct ListNodeInfo ***, int *);
+
+struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list,
+ struct ConfigTypeInfo *suffix_list,
+ char **ignore_tokens,
+ int num_file_list_entries)
+{
+ struct FileInfo *file_list;
+ int num_file_list_entries_found = 0;
+ int num_suffix_list_entries = 0;
+ int list_pos;
+ int i, j;
+
+ file_list = checked_calloc(num_file_list_entries * sizeof(struct FileInfo));
+
+ for (i = 0; suffix_list[i].token != NULL; i++)
+ num_suffix_list_entries++;
+
+ /* always start with reliable default values */
+ for (i = 0; i < num_file_list_entries; i++)
+ {
+ file_list[i].token = NULL;
+
+ file_list[i].default_filename = NULL;
+ file_list[i].filename = NULL;
+
+ if (num_suffix_list_entries > 0)
+ {
+ int parameter_array_size = num_suffix_list_entries * sizeof(char *);
+
+ file_list[i].default_parameter = checked_calloc(parameter_array_size);
+ file_list[i].parameter = checked_calloc(parameter_array_size);
+
+ for (j = 0; j < num_suffix_list_entries; j++)
+ {
+ setString(&file_list[i].default_parameter[j], suffix_list[j].value);
+ setString(&file_list[i].parameter[j], suffix_list[j].value);
+ }
+
+ file_list[i].redefined = FALSE;
+ file_list[i].fallback_to_default = FALSE;
+ file_list[i].default_is_cloned = FALSE;
+ }
+ }
+
+ list_pos = 0;
+
+ for (i = 0; config_list[i].token != NULL; i++)
+ {
+ int len_config_token = strlen(config_list[i].token);
+ boolean is_file_entry = TRUE;
+
+ for (j = 0; suffix_list[j].token != NULL; j++)
+ {
+ int len_suffix = strlen(suffix_list[j].token);
+
+ if (len_suffix < len_config_token &&
+ strEqual(&config_list[i].token[len_config_token - len_suffix],
+ suffix_list[j].token))
+ {
+ setString(&file_list[list_pos].default_parameter[j],
+ config_list[i].value);
+
+ is_file_entry = FALSE;
+
+ break;
+ }
+ }
+
+ /* the following tokens are no file definitions, but other config tokens */
+ for (j = 0; ignore_tokens[j] != NULL; j++)
+ if (strEqual(config_list[i].token, ignore_tokens[j]))
+ is_file_entry = FALSE;
+
+ if (is_file_entry)
+ {
+ if (i > 0)
+ list_pos++;
+
+ if (list_pos >= num_file_list_entries)
+ break;
+
+ file_list[list_pos].token = config_list[i].token;
+ file_list[list_pos].default_filename = config_list[i].value;
+ }
+
+ if (strSuffix(config_list[i].token, ".clone_from"))
+ file_list[list_pos].default_is_cloned = TRUE;
+ }
+
+ num_file_list_entries_found = list_pos + 1;
+ if (num_file_list_entries_found != num_file_list_entries)
+ {
+ Error(ERR_INFO_LINE, "-");
+ Error(ERR_INFO, "inconsistant config list information:");
+ Error(ERR_INFO, "- should be: %d (according to 'src/conf_xxx.h')",
+ num_file_list_entries);
+ Error(ERR_INFO, "- found to be: %d (according to 'src/conf_xxx.c')",
+ num_file_list_entries_found);
+ Error(ERR_EXIT, "please fix");
+ }
+
+ return file_list;
+}
+
+static boolean token_suffix_match(char *token, char *suffix, int start_pos)
+{
+ int len_token = strlen(token);
+ int len_suffix = strlen(suffix);
+
+ if (start_pos < 0) /* compare suffix from end of string */
+ start_pos += len_token;
+
+ if (start_pos < 0 || start_pos + len_suffix > len_token)
+ return FALSE;
+
+ if (strncmp(&token[start_pos], suffix, len_suffix) != 0)
+ return FALSE;
+
+ if (token[start_pos + len_suffix] == '\0')
+ return TRUE;
+
+ if (token[start_pos + len_suffix] == '.')
+ return TRUE;
+
+ return FALSE;
+}
+
+#define KNOWN_TOKEN_VALUE "[KNOWN_TOKEN_VALUE]"
+
+static void read_token_parameters(SetupFileHash *setup_file_hash,
+ struct ConfigTypeInfo *suffix_list,
+ struct FileInfo *file_list_entry)
+{
+ /* check for config token that is the base token without any suffixes */
+ char *filename = getHashEntry(setup_file_hash, file_list_entry->token);
+ char *known_token_value = KNOWN_TOKEN_VALUE;
+ int i;
+
+ if (filename != NULL)
+ {
+ setString(&file_list_entry->filename, filename);
+
+ /* when file definition found, set all parameters to default values */
+ for (i = 0; suffix_list[i].token != NULL; i++)
+ setString(&file_list_entry->parameter[i], suffix_list[i].value);
+
+ file_list_entry->redefined = TRUE;
+
+ /* mark config file token as well known from default config */
+ setHashEntry(setup_file_hash, file_list_entry->token, known_token_value);
+ }
+
+ /* check for config tokens that can be build by base token and suffixes */
+ for (i = 0; suffix_list[i].token != NULL; i++)
+ {
+ char *token = getStringCat2(file_list_entry->token, suffix_list[i].token);
+ char *value = getHashEntry(setup_file_hash, token);
+
+ if (value != NULL)
+ {
+ setString(&file_list_entry->parameter[i], value);
+
+ /* mark config file token as well known from default config */
+ setHashEntry(setup_file_hash, token, known_token_value);
+ }
+
+ free(token);
+ }
+}
+
+static void add_dynamic_file_list_entry(struct FileInfo **list,
+ int *num_list_entries,
+ SetupFileHash *extra_file_hash,
+ struct ConfigTypeInfo *suffix_list,
+ int num_suffix_list_entries,
+ char *token)
+{
+ struct FileInfo *new_list_entry;
+ int parameter_array_size = num_suffix_list_entries * sizeof(char *);
+
+ (*num_list_entries)++;
+ *list = checked_realloc(*list, *num_list_entries * sizeof(struct FileInfo));
+ new_list_entry = &(*list)[*num_list_entries - 1];
+
+ new_list_entry->token = getStringCopy(token);
+ new_list_entry->default_filename = NULL;
+ new_list_entry->filename = NULL;
+ new_list_entry->parameter = checked_calloc(parameter_array_size);
+
+ new_list_entry->redefined = FALSE;
+ new_list_entry->fallback_to_default = FALSE;
+ new_list_entry->default_is_cloned = FALSE;
+
+ read_token_parameters(extra_file_hash, suffix_list, new_list_entry);
+}
+
+static void add_property_mapping(struct PropertyMapping **list,
+ int *num_list_entries,
+ int base_index, int ext1_index,
+ int ext2_index, int ext3_index,
+ int artwork_index)
+{
+ struct PropertyMapping *new_list_entry;
+
+ (*num_list_entries)++;
+ *list = checked_realloc(*list,
+ *num_list_entries * sizeof(struct PropertyMapping));
+ new_list_entry = &(*list)[*num_list_entries - 1];
+
+ new_list_entry->base_index = base_index;
+ new_list_entry->ext1_index = ext1_index;
+ new_list_entry->ext2_index = ext2_index;
+ new_list_entry->ext3_index = ext3_index;
+
+ new_list_entry->artwork_index = artwork_index;
+}
+
+static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info,
+ char *filename)
+{
+ struct FileInfo *file_list = artwork_info->file_list;
+ struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
+ char **base_prefixes = artwork_info->base_prefixes;
+ char **ext1_suffixes = artwork_info->ext1_suffixes;
+ char **ext2_suffixes = artwork_info->ext2_suffixes;
+ char **ext3_suffixes = artwork_info->ext3_suffixes;
+ char **ignore_tokens = artwork_info->ignore_tokens;
+ int num_file_list_entries = artwork_info->num_file_list_entries;
+ int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
+ int num_base_prefixes = artwork_info->num_base_prefixes;
+ int num_ext1_suffixes = artwork_info->num_ext1_suffixes;
+ int num_ext2_suffixes = artwork_info->num_ext2_suffixes;
+ int num_ext3_suffixes = artwork_info->num_ext3_suffixes;
+ int num_ignore_tokens = artwork_info->num_ignore_tokens;
+ SetupFileHash *setup_file_hash, *valid_file_hash;
+ SetupFileHash *extra_file_hash, *empty_file_hash;
+ char *known_token_value = KNOWN_TOKEN_VALUE;
+ int i, j, k, l;
+
+ if (filename == NULL)
+ return;
+
+ if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
+ return;
+
+ /* separate valid (defined) from empty (undefined) config token values */
+ valid_file_hash = newSetupFileHash();
+ empty_file_hash = newSetupFileHash();
+ BEGIN_HASH_ITERATION(setup_file_hash, itr)
+ {
+ char *value = HASH_ITERATION_VALUE(itr);
+
+ setHashEntry(*value ? valid_file_hash : empty_file_hash,
+ HASH_ITERATION_TOKEN(itr), value);
+ }
+ END_HASH_ITERATION(setup_file_hash, itr)
+
+ /* at this point, we do not need the setup file hash anymore -- free it */
+ freeSetupFileHash(setup_file_hash);
+
+ /* map deprecated to current tokens (using prefix match and replace) */
+ BEGIN_HASH_ITERATION(valid_file_hash, itr)
+ {
+ char *token = HASH_ITERATION_TOKEN(itr);
+ char *mapped_token = get_mapped_token(token);
+
+ if (mapped_token != NULL)
+ {
+ char *value = HASH_ITERATION_VALUE(itr);
+
+ /* add mapped token */
+ setHashEntry(valid_file_hash, mapped_token, value);
+
+ /* ignore old token (by setting it to "known" keyword) */
+ setHashEntry(valid_file_hash, token, known_token_value);
+
+ free(mapped_token);
+ }
+ }
+ END_HASH_ITERATION(valid_file_hash, itr)
+
+ /* read parameters for all known config file tokens */
+ for (i = 0; i < num_file_list_entries; i++)
+ read_token_parameters(valid_file_hash, suffix_list, &file_list[i]);
+
+ /* set all tokens that can be ignored here to "known" keyword */
+ for (i = 0; i < num_ignore_tokens; i++)
+ setHashEntry(valid_file_hash, ignore_tokens[i], known_token_value);
+
+ /* copy all unknown config file tokens to extra config hash */
+ extra_file_hash = newSetupFileHash();
+ BEGIN_HASH_ITERATION(valid_file_hash, itr)
+ {
+ char *value = HASH_ITERATION_VALUE(itr);
+
+ if (!strEqual(value, known_token_value))
+ setHashEntry(extra_file_hash, HASH_ITERATION_TOKEN(itr), value);
+ }
+ END_HASH_ITERATION(valid_file_hash, itr)
+
+ /* at this point, we do not need the valid file hash anymore -- free it */
+ freeSetupFileHash(valid_file_hash);
+
+ /* now try to determine valid, dynamically defined config tokens */
+
+ BEGIN_HASH_ITERATION(extra_file_hash, itr)
+ {
+ struct FileInfo **dynamic_file_list =
+ &artwork_info->dynamic_file_list;
+ int *num_dynamic_file_list_entries =
+ &artwork_info->num_dynamic_file_list_entries;
+ struct PropertyMapping **property_mapping =
+ &artwork_info->property_mapping;
+ int *num_property_mapping_entries =
+ &artwork_info->num_property_mapping_entries;
+ int current_summarized_file_list_entry =
+ artwork_info->num_file_list_entries +
+ artwork_info->num_dynamic_file_list_entries;
+ char *token = HASH_ITERATION_TOKEN(itr);
+ int len_token = strlen(token);
+ int start_pos;
+ boolean base_prefix_found = FALSE;
+ boolean parameter_suffix_found = FALSE;
+
+ /* skip all parameter definitions (handled by read_token_parameters()) */
+ for (i = 0; i < num_suffix_list_entries && !parameter_suffix_found; i++)
+ {
+ int len_suffix = strlen(suffix_list[i].token);
+
+ if (token_suffix_match(token, suffix_list[i].token, -len_suffix))
+ parameter_suffix_found = TRUE;
+ }
+
+ if (parameter_suffix_found)
+ continue;
+
+ /* ---------- step 0: search for matching base prefix ---------- */
+
+ start_pos = 0;
+ for (i = 0; i < num_base_prefixes && !base_prefix_found; i++)
+ {
+ char *base_prefix = base_prefixes[i];
+ int len_base_prefix = strlen(base_prefix);
+ boolean ext1_suffix_found = FALSE;
+ boolean ext2_suffix_found = FALSE;
+ boolean ext3_suffix_found = FALSE;
+ boolean exact_match = FALSE;
+ int base_index = -1;
+ int ext1_index = -1;
+ int ext2_index = -1;
+ int ext3_index = -1;
+
+ base_prefix_found = token_suffix_match(token, base_prefix, start_pos);
+
+ if (!base_prefix_found)
+ continue;
+
+ base_index = i;
+
+ if (start_pos + len_base_prefix == len_token) /* exact match */
+ {
+ exact_match = TRUE;
+
+ add_dynamic_file_list_entry(dynamic_file_list,
+ num_dynamic_file_list_entries,
+ extra_file_hash,
+ suffix_list,
+ num_suffix_list_entries,
+ token);
+ add_property_mapping(property_mapping,
+ num_property_mapping_entries,
+ base_index, -1, -1, -1,
+ current_summarized_file_list_entry);
+ continue;
+ }
+
+ /* ---------- step 1: search for matching first suffix ---------- */
+
+ start_pos += len_base_prefix;
+ for (j = 0; j < num_ext1_suffixes && !ext1_suffix_found; j++)
+ {
+ char *ext1_suffix = ext1_suffixes[j];
+ int len_ext1_suffix = strlen(ext1_suffix);
+
+ ext1_suffix_found = token_suffix_match(token, ext1_suffix, start_pos);
+
+ if (!ext1_suffix_found)
+ continue;
+
+ ext1_index = j;
+
+ if (start_pos + len_ext1_suffix == len_token) /* exact match */
+ {
+ exact_match = TRUE;
+
+ add_dynamic_file_list_entry(dynamic_file_list,
+ num_dynamic_file_list_entries,
+ extra_file_hash,
+ suffix_list,
+ num_suffix_list_entries,
+ token);
+ add_property_mapping(property_mapping,
+ num_property_mapping_entries,
+ base_index, ext1_index, -1, -1,
+ current_summarized_file_list_entry);
+ continue;
+ }
+
+ start_pos += len_ext1_suffix;
+ }
+
+ if (exact_match)
+ break;
+
+ /* ---------- step 2: search for matching second suffix ---------- */
+
+ for (k = 0; k < num_ext2_suffixes && !ext2_suffix_found; k++)
+ {
+ char *ext2_suffix = ext2_suffixes[k];
+ int len_ext2_suffix = strlen(ext2_suffix);
+
+ ext2_suffix_found = token_suffix_match(token, ext2_suffix, start_pos);
+
+ if (!ext2_suffix_found)
+ continue;
+
+ ext2_index = k;
+
+ if (start_pos + len_ext2_suffix == len_token) /* exact match */
+ {
+ exact_match = TRUE;
+
+ add_dynamic_file_list_entry(dynamic_file_list,
+ num_dynamic_file_list_entries,
+ extra_file_hash,
+ suffix_list,
+ num_suffix_list_entries,
+ token);
+ add_property_mapping(property_mapping,
+ num_property_mapping_entries,
+ base_index, ext1_index, ext2_index, -1,
+ current_summarized_file_list_entry);
+ continue;
+ }
+
+ start_pos += len_ext2_suffix;
+ }
+
+ if (exact_match)
+ break;
+
+ /* ---------- step 3: search for matching third suffix ---------- */
+
+ for (l = 0; l < num_ext3_suffixes && !ext3_suffix_found; l++)
+ {
+ char *ext3_suffix = ext3_suffixes[l];
+ int len_ext3_suffix = strlen(ext3_suffix);
+
+ ext3_suffix_found = token_suffix_match(token, ext3_suffix, start_pos);
+
+ if (!ext3_suffix_found)
+ continue;
+
+ ext3_index = l;
+
+ if (start_pos + len_ext3_suffix == len_token) /* exact match */
+ {
+ exact_match = TRUE;
+
+ add_dynamic_file_list_entry(dynamic_file_list,
+ num_dynamic_file_list_entries,
+ extra_file_hash,
+ suffix_list,
+ num_suffix_list_entries,
+ token);
+ add_property_mapping(property_mapping,
+ num_property_mapping_entries,
+ base_index, ext1_index, ext2_index, ext3_index,
+ current_summarized_file_list_entry);
+ continue;
+ }
+ }
+ }
+ }
+ END_HASH_ITERATION(extra_file_hash, itr)
+
+ if (artwork_info->num_dynamic_file_list_entries > 0)
+ {
+ artwork_info->dynamic_artwork_list =
+ checked_calloc(artwork_info->num_dynamic_file_list_entries *
+ artwork_info->sizeof_artwork_list_entry);
+ }
+
+ if (options.verbose && IS_PARENT_PROCESS())
+ {
+ SetupFileList *setup_file_list, *list;
+ boolean dynamic_tokens_found = FALSE;
+ boolean unknown_tokens_found = FALSE;
+ boolean undefined_values_found = (hashtable_count(empty_file_hash) != 0);
+
+ if ((setup_file_list = loadSetupFileList(filename)) == NULL)
+ Error(ERR_EXIT, "loadSetupFileHash works, but loadSetupFileList fails");
+
+ BEGIN_HASH_ITERATION(extra_file_hash, itr)
+ {
+ if (strEqual(HASH_ITERATION_VALUE(itr), known_token_value))
+ dynamic_tokens_found = TRUE;
+ else
+ unknown_tokens_found = TRUE;
+ }
+ END_HASH_ITERATION(extra_file_hash, itr)
+
+ if (options.debug && dynamic_tokens_found)
+ {
+ Error(ERR_INFO_LINE, "-");
+ Error(ERR_INFO, "dynamic token(s) found in config file:");
+ Error(ERR_INFO, "- config file: '%s'", filename);
+
+ for (list = setup_file_list; list != NULL; list = list->next)
+ {
+ char *value = getHashEntry(extra_file_hash, list->token);
+
+ if (value != NULL && strEqual(value, known_token_value))
+ Error(ERR_INFO, "- dynamic token: '%s'", list->token);
+ }
+
+ Error(ERR_INFO_LINE, "-");
+ }
+
+ if (unknown_tokens_found)
{
- int len_suffix = strlen(suffix_list[j].token);
+ Error(ERR_INFO_LINE, "-");
+ Error(ERR_INFO, "warning: unknown token(s) found in config file:");
+ Error(ERR_INFO, "- config file: '%s'", filename);
- if (len_suffix < len_config_token &&
- strcmp(&config_list[i].token[len_config_token - len_suffix],
- suffix_list[j].token) == 0)
+ for (list = setup_file_list; list != NULL; list = list->next)
{
- file_list[list_pos].default_parameter[j] =
- get_parameter_value(suffix_list[j].type, config_list[i].value);
+ char *value = getHashEntry(extra_file_hash, list->token);
- is_file_entry = FALSE;
- break;
+ if (value != NULL && !strEqual(value, known_token_value))
+ Error(ERR_INFO, "- dynamic token: '%s'", list->token);
}
+
+ Error(ERR_INFO_LINE, "-");
}
- if (is_file_entry)
+ if (undefined_values_found)
{
- if (i > 0)
- list_pos++;
+ Error(ERR_INFO_LINE, "-");
+ Error(ERR_INFO, "warning: undefined values found in config file:");
+ Error(ERR_INFO, "- config file: '%s'", filename);
- if (list_pos >= num_file_list_entries)
- break;
-
- /* simple sanity check if this is really a file definition */
- if (strcmp(&config_list[i].value[len_config_value - 4], ".pcx") != 0 &&
- strcmp(&config_list[i].value[len_config_value - 4], ".wav") != 0 &&
- strcmp(config_list[i].value, UNDEFINED_FILENAME) != 0)
+ for (list = setup_file_list; list != NULL; list = list->next)
{
- Error(ERR_RETURN, "Configuration directive '%s' -> '%s':",
- config_list[i].token, config_list[i].value);
- Error(ERR_EXIT, "This seems to be no valid definition -- please fix");
+ char *value = getHashEntry(empty_file_hash, list->token);
+
+ if (value != NULL)
+ Error(ERR_INFO, "- undefined value for token: '%s'", list->token);
}
- file_list[list_pos].token = config_list[i].token;
- file_list[list_pos].default_filename = config_list[i].value;
+ Error(ERR_INFO_LINE, "-");
}
- }
- num_file_list_entries_found = list_pos + 1;
- if (num_file_list_entries_found != num_file_list_entries)
- {
- Error(ERR_RETURN, "inconsistant config list information:");
- Error(ERR_RETURN, "- should be: %d (according to 'src/conf_gfx.h')",
- num_file_list_entries);
- Error(ERR_RETURN, "- found to be: %d (according to 'src/conf_gfx.c')",
- num_file_list_entries_found);
- Error(ERR_EXIT, "please fix");
+ freeSetupFileList(setup_file_list);
}
- return file_list;
+ freeSetupFileHash(extra_file_hash);
+ freeSetupFileHash(empty_file_hash);
}
void LoadArtworkConfig(struct ArtworkListInfo *artwork_info)
{
struct FileInfo *file_list = artwork_info->file_list;
- struct ConfigInfo *suffix_list = artwork_info->suffix_list;
int num_file_list_entries = artwork_info->num_file_list_entries;
int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
- char *filename = getCustomArtworkConfigFilename(artwork_info->type);
- struct SetupFileList *setup_file_list;
- struct SetupFileList *extra_file_list = NULL;
- char *known_token_value = "[KNOWN_TOKEN]";
+ char *filename_base = UNDEFINED_FILENAME, *filename_local;
int i, j;
-#if 0
- printf("GOT CUSTOM ARTWORK CONFIG FILE '%s'\n", filename);
-#endif
+ DrawInitText("Loading artwork config", 120, FC_GREEN);
+ DrawInitText(ARTWORKINFO_FILENAME(artwork_info->type), 150, FC_YELLOW);
/* always start with reliable default values */
- for (i=0; i<num_file_list_entries; i++)
+ for (i = 0; i < num_file_list_entries; i++)
{
- if (file_list[i].filename != NULL)
- free(file_list[i].filename);
- file_list[i].filename = NULL;
-
- for (j=0; j<num_suffix_list_entries; j++)
- file_list[i].parameter[j] = file_list[i].default_parameter[j];
- }
+ setString(&file_list[i].filename, file_list[i].default_filename);
- if (filename == NULL)
- return;
+ for (j = 0; j < num_suffix_list_entries; j++)
+ setString(&file_list[i].parameter[j], file_list[i].default_parameter[j]);
- if ((setup_file_list = loadSetupFileList(filename)) == NULL)
- return;
+ file_list[i].redefined = FALSE;
+ file_list[i].fallback_to_default = FALSE;
+ }
- for (i=0; i<num_file_list_entries; i++)
+ /* free previous dynamic artwork file array */
+ if (artwork_info->dynamic_file_list != NULL)
{
- /* check for config token that is the base token without any suffixes */
- char *filename = getTokenValue(setup_file_list, file_list[i].token);
-
- if (filename != NULL)
+ for (i = 0; i < artwork_info->num_dynamic_file_list_entries; i++)
{
- for (j=0; j<num_suffix_list_entries; j++)
- file_list[i].parameter[j] =
- get_parameter_value(suffix_list[j].type, suffix_list[j].value);
-
- file_list[i].filename = getStringCopy(filename);
-
- /* mark token as well known from default config */
- setTokenValue(setup_file_list, file_list[i].token, known_token_value);
+ free(artwork_info->dynamic_file_list[i].token);
+ free(artwork_info->dynamic_file_list[i].filename);
+ free(artwork_info->dynamic_file_list[i].parameter);
}
- else
- file_list[i].filename = getStringCopy(file_list[i].default_filename);
-
- /* check for config tokens that can be build by base token and suffixes */
- for (j=0; j<num_suffix_list_entries; j++)
- {
- char *token = getStringCat2(file_list[i].token, suffix_list[j].token);
- char *value = getTokenValue(setup_file_list, token);
-
- if (value != NULL)
- {
- file_list[i].parameter[j] =
- get_parameter_value(suffix_list[j].type, value);
- /* mark token as well known from default config */
- setTokenValue(setup_file_list, token, known_token_value);
- }
+ free(artwork_info->dynamic_file_list);
+ artwork_info->dynamic_file_list = NULL;
- free(token);
- }
+ FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
+ &artwork_info->num_dynamic_file_list_entries);
}
- /* set some additional tokens to "known" */
- setTokenValue(setup_file_list, "name", known_token_value);
- setTokenValue(setup_file_list, "sort_priority", known_token_value);
-
- if (options.verbose && !IS_CHILD_PROCESS(audio.mixer_pid))
+ /* free previous property mapping */
+ if (artwork_info->property_mapping != NULL)
{
- boolean unknown_tokens_found = FALSE;
-
- /* check each token in config file if it is defined in default config */
- while (setup_file_list != NULL)
- {
- if (strcmp(setup_file_list->value, known_token_value) != 0)
- {
- if (extra_file_list == NULL)
- extra_file_list = newSetupFileList(setup_file_list->token,
- setup_file_list->value);
- else
- setTokenValue(extra_file_list, setup_file_list->token,
- setup_file_list->value);
-
- if (!unknown_tokens_found)
- {
- Error(ERR_RETURN_LINE, "-");
- Error(ERR_RETURN, "warning: unknown token(s) found in config file:");
- Error(ERR_RETURN, "- config file: '%s'", filename);
-
- unknown_tokens_found = TRUE;
- }
+ free(artwork_info->property_mapping);
- Error(ERR_RETURN, "- unknown token: '%s'", setup_file_list->token);
- }
+ artwork_info->property_mapping = NULL;
+ artwork_info->num_property_mapping_entries = 0;
+ }
- setup_file_list = setup_file_list->next;
- }
+ if (!GFX_OVERRIDE_ARTWORK(artwork_info->type))
+ {
+ /* first look for special artwork configured in level series config */
+ filename_base = getCustomArtworkLevelConfigFilename(artwork_info->type);
- if (unknown_tokens_found)
- Error(ERR_RETURN_LINE, "-");
+ if (fileExists(filename_base))
+ LoadArtworkConfigFromFilename(artwork_info, filename_base);
}
- freeSetupFileList(setup_file_list);
+ filename_local = getCustomArtworkConfigFilename(artwork_info->type);
- freeSetupFileList(extra_file_list);
-
-#if 0
- for (i=0; i<num_file_list_entries; i++)
- {
- printf("'%s' ", file_list[i].token);
- if (file_list[i].filename)
- printf("-> '%s'\n", file_list[i].filename);
- else
- printf("-> UNDEFINED [-> '%s']\n", file_list[i].default_filename);
- }
-#endif
+ if (filename_local != NULL && !strEqual(filename_base, filename_local))
+ LoadArtworkConfigFromFilename(artwork_info, filename_local);
}
static void deleteArtworkListEntry(struct ArtworkListInfo *artwork_info,
{
char *filename = (*listnode)->source_filename;
-#if 0
- printf("[decrementing reference counter of artwork '%s']\n", filename);
-#endif
-
if (--(*listnode)->num_references <= 0)
- {
-#if 0
- printf("[deleting artwork '%s']\n", filename);
-#endif
-
deleteNodeFromList(&artwork_info->content_list, filename,
artwork_info->free_artwork);
- }
*listnode = NULL;
}
static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info,
struct ListNodeInfo **listnode,
- char *basename)
+ struct FileInfo *file_list_entry)
{
char *init_text[] =
- { "",
- "Loading graphics:",
- "Loading sounds:",
- "Loading music:"
+ {
+ "Loading graphics",
+ "Loading sounds",
+ "Loading music"
};
ListNode *node;
+ char *basename = file_list_entry->filename;
char *filename = getCustomArtworkFilename(basename, artwork_info->type);
if (filename == NULL)
{
- int error_mode = ERR_WARN;
+ Error(ERR_WARN, "cannot find artwork file '%s'", basename);
- /* 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;
+ basename = file_list_entry->default_filename;
- Error(error_mode, "cannot find artwork file '%s'", basename);
- return;
+ /* 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;
+
+ /* 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(error_mode, "token '%s' was cloned and has no default filename",
+ file_list_entry->token);
+
+ return;
+ }
+
+ /* dynamic artwork has no default filename / skip empty default artwork */
+ if (basename == NULL || strEqual(basename, UNDEFINED_FILENAME))
+ return;
+
+ file_list_entry->fallback_to_default = TRUE;
+
+ Error(ERR_WARN, "trying default artwork file '%s'", basename);
+
+ filename = getCustomArtworkFilename(basename, artwork_info->type);
+
+ if (filename == NULL)
+ {
+ int error_mode = ERR_WARN;
+
+ /* 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(error_mode, "cannot find default artwork file '%s'", basename);
+
+ return;
+ }
}
/* check if the old and the new artwork file are the same */
- if (*listnode && strcmp((*listnode)->source_filename, filename) == 0)
+ if (*listnode && strEqual((*listnode)->source_filename, filename))
{
/* The old and new artwork are the same (have the same filename and path).
This usually means that this artwork does not exist in this artwork set
and a fallback to the existing artwork is done. */
-#if 0
- printf("[artwork '%s' already exists (same list entry)]\n", filename);
-#endif
-
return;
}
/* delete existing artwork file entry */
deleteArtworkListEntry(artwork_info, listnode);
- /* check if the new artwork file already exists in the list of artworks */
+ /* check if the new artwork file already exists in the list of artwork */
if ((node = getNodeFromKey(artwork_info->content_list, filename)) != NULL)
{
-#if 0
- printf("[artwork '%s' already exists (other list entry)]\n", filename);
-#endif
-
*listnode = (struct ListNodeInfo *)node->content;
(*listnode)->num_references++;
if ((*listnode = artwork_info->load_artwork(filename)) != NULL)
{
-#if 0
- printf("[adding new artwork '%s']\n", filename);
-#endif
-
+ /* add new artwork file entry to the list of artwork files */
(*listnode)->num_references = 1;
addNodeToList(&artwork_info->content_list, (*listnode)->source_filename,
*listnode);
error_mode = ERR_EXIT;
Error(error_mode, "cannot load artwork file '%s'", basename);
+
return;
}
}
static void LoadCustomArtwork(struct ArtworkListInfo *artwork_info,
struct ListNodeInfo **listnode,
- char *basename)
+ struct FileInfo *file_list_entry)
{
-#if 0
- char *filename = getCustomArtworkFilename(basename, artwork_info->type);
-#endif
-
-#if 0
- printf("GOT CUSTOM ARTWORK FILE '%s'\n", filename);
-#endif
-
- if (strcmp(basename, UNDEFINED_FILENAME) == 0)
+ if (strEqual(file_list_entry->filename, UNDEFINED_FILENAME))
{
deleteArtworkListEntry(artwork_info, listnode);
- return;
- }
-#if 0
- if (filename == NULL)
- {
- Error(ERR_WARN, "cannot find artwork file '%s'", basename);
return;
}
- replaceArtworkListEntry(artwork_info, listnode, filename);
-#else
- replaceArtworkListEntry(artwork_info, listnode, basename);
-#endif
-}
-
-static void LoadArtworkToList(struct ArtworkListInfo *artwork_info,
- char *basename, int list_pos)
-{
- if (artwork_info->artwork_list == NULL ||
- list_pos >= artwork_info->num_file_list_entries)
- return;
-
-#if 0
- printf("loading artwork '%s' ... [%d]\n",
- basename, getNumNodes(artwork_info->content_list));
-#endif
-
- LoadCustomArtwork(artwork_info, &artwork_info->artwork_list[list_pos],
- basename);
-
-#if 0
- printf("loading artwork '%s' done [%d]\n",
- basename, getNumNodes(artwork_info->content_list));
-#endif
+ replaceArtworkListEntry(artwork_info, listnode, file_list_entry);
}
void ReloadCustomArtworkList(struct ArtworkListInfo *artwork_info)
{
-#if 0
- static struct
- {
- char *text;
- boolean do_it;
- }
- draw_init[] =
- {
- { "", FALSE },
- { "Loading graphics:", TRUE },
- { "Loading sounds:", TRUE },
- { "Loading music:", TRUE }
- };
-#endif
-
- int num_file_list_entries = artwork_info->num_file_list_entries;
struct FileInfo *file_list = artwork_info->file_list;
+ struct FileInfo *dynamic_file_list = artwork_info->dynamic_file_list;
+ int num_file_list_entries = artwork_info->num_file_list_entries;
+ int num_dynamic_file_list_entries =
+ artwork_info->num_dynamic_file_list_entries;
int i;
-#if 0
- LoadArtworkConfig(artwork_info);
-#endif
-
-#if 0
- if (draw_init[artwork_info->type].do_it)
- DrawInitText(draw_init[artwork_info->type].text, 120, FC_GREEN);
-#endif
-
-#if 0
- printf("DEBUG: reloading %d artwork files ...\n", num_file_list_entries);
-#endif
-
- for(i=0; i<num_file_list_entries; i++)
- {
-#if 0
- if (draw_init[artwork_info->type].do_it)
- DrawInitText(file_list[i].token, 150, FC_YELLOW);
-#endif
+ print_timestamp_init("ReloadCustomArtworkList");
- LoadArtworkToList(artwork_info, file_list[i].filename, i);
-
-#if 0
- printf("DEBUG: loading artwork file '%s'...\n", file_list[i].filename);
-#endif
- }
+ for (i = 0; i < num_file_list_entries; i++)
+ LoadCustomArtwork(artwork_info, &artwork_info->artwork_list[i],
+ &file_list[i]);
-#if 0
- draw_init[artwork_info->type].do_it = FALSE;
-#endif
+ for (i = 0; i < num_dynamic_file_list_entries; i++)
+ LoadCustomArtwork(artwork_info, &artwork_info->dynamic_artwork_list[i],
+ &dynamic_file_list[i]);
- /*
- printf("list size == %d\n", getNumNodes(artwork_info->content_list));
- */
+ print_timestamp_done("ReloadCustomArtworkList");
#if 0
dumpList(artwork_info->content_list);
#endif
}
-void FreeCustomArtworkList(struct ArtworkListInfo *artwork_info)
+static void FreeCustomArtworkList(struct ArtworkListInfo *artwork_info,
+ struct ListNodeInfo ***list,
+ int *num_list_entries)
{
int i;
- if (artwork_info == NULL || artwork_info->artwork_list == NULL)
+ if (*list == NULL)
return;
-#if 0
- printf("%s: FREEING ARTWORK ...\n",
- IS_CHILD_PROCESS(audio.mixer_pid) ? "CHILD" : "PARENT");
-#endif
+ for (i = 0; i < *num_list_entries; i++)
+ deleteArtworkListEntry(artwork_info, &(*list)[i]);
+ free(*list);
- for(i=0; i<artwork_info->num_file_list_entries; i++)
- deleteArtworkListEntry(artwork_info, &artwork_info->artwork_list[i]);
+ *list = NULL;
+ *num_list_entries = 0;
+}
-#if 0
- printf("%s: FREEING ARTWORK -- DONE\n",
- IS_CHILD_PROCESS(audio.mixer_pid) ? "CHILD" : "PARENT");
-#endif
+void FreeCustomArtworkLists(struct ArtworkListInfo *artwork_info)
+{
+ if (artwork_info == NULL)
+ return;
- free(artwork_info->artwork_list);
+ FreeCustomArtworkList(artwork_info, &artwork_info->artwork_list,
+ &artwork_info->num_file_list_entries);
- artwork_info->artwork_list = NULL;
- artwork_info->num_file_list_entries = 0;
+ FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
+ &artwork_info->num_dynamic_file_list_entries);
}
/* ------------------------------------------------------------------------- */
/* 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) */
/* ------------------------------------------------------------------------- */
-#if defined(PLATFORM_MSDOS)
-
-#define ERROR_FILENAME "stderr.txt"
+char *getLogFilename(char *basename)
+{
+ return getPath2(getUserGameDataDir(), basename);
+}
-void initErrorFile()
+void OpenLogFiles()
{
- unlink(ERROR_FILENAME);
+ int i;
+
+ InitUserDataDirectory();
+
+ for (i = 0; i < NUM_LOGS; i++)
+ {
+ if ((program.log_file[i] = fopen(program.log_filename[i], MODE_WRITE))
+ == NULL)
+ {
+ program.log_file[i] = program.log_file_default[i]; // reset to default
+
+ Error(ERR_WARN, "cannot open file '%s' for writing: %s",
+ program.log_filename[i], strerror(errno));
+ }
+
+ /* output should be unbuffered so it is not truncated in a crash */
+ setbuf(program.log_file[i], NULL);
+ }
}
-FILE *openErrorFile()
+void CloseLogFiles()
{
- return fopen(ERROR_FILENAME, MODE_APPEND);
+ int i;
+
+ for (i = 0; i < NUM_LOGS; i++)
+ if (program.log_file[i] != program.log_file_default[i])
+ fclose(program.log_file[i]);
}
-void dumpErrorFile()
+void DumpLogFile(int nr)
{
- FILE *error_file = fopen(ERROR_FILENAME, MODE_READ);
+ FILE *log_file = fopen(program.log_filename[nr], MODE_READ);
- if (error_file != NULL)
- {
- while (!feof(error_file))
- fputc(fgetc(error_file), stderr);
+ if (log_file == NULL)
+ return;
- fclose(error_file);
- }
+ while (!feof(log_file))
+ fputc(fgetc(log_file), stdout);
+
+ fclose(log_file);
}
+
+void NotifyUserAboutErrorFile()
+{
+#if defined(PLATFORM_WIN32)
+ char *title_text = getStringCat2(program.program_title, " Error Message");
+ char *error_text = getStringCat2("The program was aborted due to an error; "
+ "for details, see the following error file:"
+ STRING_NEWLINE,
+ program.log_filename[LOG_ERR_ID]);
+
+ MessageBox(NULL, error_text, title_text, MB_OK);
#endif
+}
/* ------------------------------------------------------------------------- */
/* the following is only for debugging purpose and normally not used */
/* ------------------------------------------------------------------------- */
-#define DEBUG_NUM_TIMESTAMPS 3
+#if DEBUG
+
+#define DEBUG_PRINT_INIT_TIMESTAMPS FALSE
+#define DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH 10
+
+#define DEBUG_NUM_TIMESTAMPS 10
+#define DEBUG_TIME_IN_MICROSECONDS 0
+
+#if DEBUG_TIME_IN_MICROSECONDS
+static double Counter_Microseconds()
+{
+ static struct timeval base_time = { 0, 0 };
+ struct timeval current_time;
+ double counter;
+
+ gettimeofday(¤t_time, NULL);
+
+ /* reset base time in case of wrap-around */
+ if (current_time.tv_sec < base_time.tv_sec)
+ base_time = current_time;
+
+ counter =
+ ((double)(current_time.tv_sec - base_time.tv_sec)) * 1000000 +
+ ((double)(current_time.tv_usec - base_time.tv_usec));
+
+ return counter; /* return microseconds since last init */
+}
+#endif
+
+char *debug_print_timestamp_get_padding(int padding_size)
+{
+ static char *padding = NULL;
+ int max_padding_size = 100;
+
+ if (padding == NULL)
+ {
+ padding = checked_calloc(max_padding_size + 1);
+ memset(padding, ' ', max_padding_size);
+ }
+
+ return &padding[MAX(0, max_padding_size - padding_size)];
+}
void debug_print_timestamp(int counter_nr, char *message)
{
- static long counter[DEBUG_NUM_TIMESTAMPS][2];
+ int indent_size = 8;
+ int padding_size = 40;
+ float timestamp_interval;
- if (counter_nr >= DEBUG_NUM_TIMESTAMPS)
+ if (counter_nr < 0)
+ Error(ERR_EXIT, "debugging: invalid negative counter");
+ else if (counter_nr >= DEBUG_NUM_TIMESTAMPS)
Error(ERR_EXIT, "debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c");
+#if DEBUG_TIME_IN_MICROSECONDS
+ static double counter[DEBUG_NUM_TIMESTAMPS][2];
+ char *unit = "ms";
+
+ counter[counter_nr][0] = Counter_Microseconds();
+#else
+ static int counter[DEBUG_NUM_TIMESTAMPS][2];
+ char *unit = "s";
+
counter[counter_nr][0] = Counter();
+#endif
+
+ timestamp_interval = counter[counter_nr][0] - counter[counter_nr][1];
+ counter[counter_nr][1] = counter[counter_nr][0];
if (message)
- printf("%s %.2f seconds\n", message,
- (float)(counter[counter_nr][0] - counter[counter_nr][1]) / 1000);
+ 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);
+}
+
+void debug_print_parent_only(char *format, ...)
+{
+ if (!IS_PARENT_PROCESS())
+ return;
+
+ if (format)
+ {
+ va_list ap;
+
+ va_start(ap, format);
+ vprintf(format, ap);
+ va_end(ap);
+
+ printf("\n");
+ }
+}
+
+#endif /* DEBUG */
+
+void print_timestamp_ext(char *message, char *mode)
+{
+#if DEBUG_PRINT_INIT_TIMESTAMPS
+ static char *debug_message = NULL;
+ static char *last_message = NULL;
+ static int counter_nr = 0;
+ int max_depth = DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH;
+
+ checked_free(debug_message);
+ debug_message = getStringCat3(mode, " ", message);
+
+ if (strEqual(mode, "INIT"))
+ {
+ debug_print_timestamp(counter_nr, NULL);
+
+ if (counter_nr + 1 < max_depth)
+ debug_print_timestamp(counter_nr, debug_message);
+
+ counter_nr++;
+
+ debug_print_timestamp(counter_nr, NULL);
+ }
+ else if (strEqual(mode, "DONE"))
+ {
+ counter_nr--;
+
+ if (counter_nr + 1 < max_depth ||
+ (counter_nr == 0 && max_depth == 1))
+ {
+ last_message = message;
+
+ if (counter_nr == 0 && max_depth == 1)
+ {
+ checked_free(debug_message);
+ debug_message = getStringCat3("TIME", " ", message);
+ }
+
+ debug_print_timestamp(counter_nr, debug_message);
+ }
+ }
+ else if (!strEqual(mode, "TIME") ||
+ !strEqual(message, last_message))
+ {
+ if (counter_nr < max_depth)
+ debug_print_timestamp(counter_nr, debug_message);
+ }
+#endif
+}
+
+void print_timestamp_init(char *message)
+{
+ print_timestamp_ext(message, "INIT");
+}
- counter[counter_nr][1] = Counter();
+void print_timestamp_time(char *message)
+{
+ print_timestamp_ext(message, "TIME");
+}
+
+void print_timestamp_done(char *message)
+{
+ print_timestamp_ext(message, "DONE");
}
projects / rocksndiamonds.git / blobdiff