X-Git-Url: https://git.artsoft.org/?a=blobdiff_plain;f=src%2Flibgame%2Fmisc.c;h=264060305f3ba9e64d6d7268da8a1ca472fcfbb1;hb=268045d6b06349f1cf10d5cc6f9516b5caa20dea;hp=757872e8647a8c11d35b36238e3579c74fdc99a0;hpb=2e9b81c595b0150da80f8bf5ee56a74240fda6c1;p=rocksndiamonds.git diff --git a/src/libgame/misc.c b/src/libgame/misc.c index 757872e8..26406030 100644 --- a/src/libgame/misc.c +++ b/src/libgame/misc.c @@ -32,6 +32,60 @@ #include "text.h" +/* ------------------------------------------------------------------------- */ +/* some generic helper functions */ +/* ------------------------------------------------------------------------- */ + +void fprintf_line(FILE *stream, char *line_string, int line_length) +{ + int i; + + for (i=0; i 20) + size = 20; + + if (size) + { + sprintf(s, " %09d", number); + return &s[strlen(s) - size]; + } + else + { + sprintf(s, "%d", number); + return s; + } +} + + +/* ------------------------------------------------------------------------- */ +/* counter functions */ +/* ------------------------------------------------------------------------- */ + #if defined(PLATFORM_MSDOS) volatile unsigned long counter = 0; @@ -161,8 +215,8 @@ boolean FrameReached(unsigned long *frame_counter_var, { unsigned long 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; @@ -175,8 +229,8 @@ boolean DelayReached(unsigned long *counter_var, { unsigned long 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; @@ -192,8 +246,8 @@ void WaitUntilDelayReached(unsigned long *counter_var, unsigned long delay) { 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; @@ -202,113 +256,129 @@ void WaitUntilDelayReached(unsigned long *counter_var, unsigned long delay) *counter_var = actual_counter; } -/* int2str() returns a number converted to a string; - the used memory is static, but will be overwritten by later calls, - so if you want to save the result, copy it to a private string buffer; - there can be 10 local calls of int2str() without buffering the result -- - the 11th call will then destroy the result from the first call and so on. -*/ - -char *int2str(int number, int size) -{ - static char shift_array[10][40]; - static int shift_counter = 0; - char *s = shift_array[shift_counter]; - shift_counter = (shift_counter + 1) % 10; +/* ------------------------------------------------------------------------- */ +/* random generator functions */ +/* ------------------------------------------------------------------------- */ - if (size > 20) - size = 20; +#if 0 +unsigned int SimpleRND(unsigned int max) +{ + return (random_linux_libc(RND_FREE) % max); +} - if (size) +unsigned int InitSimpleRND(long seed) +{ + if (seed == NEW_RANDOMIZE) { - sprintf(s, " %09d", number); - return &s[strlen(s) - size]; + struct timeval current_time; + + gettimeofday(¤t_time, NULL); + seed = (long)current_time.tv_usec; } - else + + srandom_linux_libc(RND_FREE, (unsigned int) seed); + + return (unsigned int) seed; +} + +unsigned int RND(unsigned int max) +{ + return (random_linux_libc(RND_GAME) % max); +} + +unsigned int InitRND(long seed) +{ + if (seed == NEW_RANDOMIZE) { - sprintf(s, "%d", number); - return s; + struct timeval current_time; + + gettimeofday(¤t_time, NULL); + seed = (long)current_time.tv_usec; } + + srandom_linux_libc(RND_GAME, (unsigned int) seed); + + return (unsigned int) seed; } +#endif -unsigned int SimpleRND(unsigned int max) +unsigned int init_random_number(int nr, long seed) { + if (seed == NEW_RANDOMIZE) + { #if defined(TARGET_SDL) - static unsigned long root = 654321; - unsigned long current_ms; - - current_ms = SDL_GetTicks(); - root = root * 4253261 + current_ms; - return (root % max); + seed = (long)SDL_GetTicks(); #else - static unsigned long root = 654321; - struct timeval current_time; + 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 = (long)current_time.tv_usec; #endif -} + } -#ifdef DEBUG -static unsigned int last_RND_value = 0; + srandom_linux_libc(nr, (unsigned int) seed); -unsigned int last_RND() -{ - return last_RND_value; + return (unsigned int) seed; } -#endif -unsigned int RND(unsigned int max) +unsigned int get_random_number(int nr, unsigned 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 */ +/* ------------------------------------------------------------------------- */ + +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 + if (strchr(real_name, 'ß') == NULL) /* name does not contain 'ß' */ { - srandom_linux_libc((unsigned int) seed); - return (unsigned int) seed; - } -#else - struct timeval current_time; + strncpy(real_name_new, real_name, MAX_USERNAME_LEN); + real_name_new[MAX_USERNAME_LEN] = '\0'; - if (seed == NEW_RANDOMIZE) - { - gettimeofday(¤t_time, NULL); - srandom_linux_libc((unsigned int) current_time.tv_usec); - return (unsigned int) current_time.tv_usec; + return real_name_new; } - else + + /* the user's real name may contain a 'ß' character (german sharp s), + which has no equivalent in upper case letters (which our fonts use) */ + while (*from_ptr && (long)(to_ptr - real_name_new) < MAX_USERNAME_LEN - 1) { - srandom_linux_libc((unsigned int) seed); - return (unsigned int) seed; + if (*from_ptr != 'ß') + *to_ptr++ = *from_ptr++; + else + { + from_ptr++; + *to_ptr++ = 's'; + *to_ptr++ = 's'; + } } -#endif + + *to_ptr = '\0'; + + return real_name_new; } 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; @@ -318,78 +388,87 @@ char *getLoginName() 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) + 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() { -#if defined(PLATFORM_UNIX) - static char *home_dir = NULL; + static char *dir = NULL; + +#if defined(PLATFORM_WIN32) + if (dir == NULL) + { + dir = checked_malloc(MAX_PATH + 1); - if (home_dir == NULL) + if (!SUCCEEDED(SHGetFolderPath(NULL, CSIDL_PERSONAL, NULL, 0, dir))) + strcpy(dir, "."); + } +#elif defined(PLATFORM_UNIX) + if (dir == NULL) { - if ((home_dir = getenv("HOME")) == NULL) + if ((dir = getenv("HOME")) == NULL) { struct passwd *pwd; - if ((pwd = getpwuid(getuid())) == NULL) - home_dir = "."; + if ((pwd = getpwuid(getuid())) != NULL) + dir = getStringCopy(pwd->pw_dir); else - home_dir = getStringCopy(pwd->pw_dir); + dir = "."; } } - - return home_dir; #else - return "."; + dir = "."; #endif + + return dir; } + +/* ------------------------------------------------------------------------- */ +/* various string functions */ +/* ------------------------------------------------------------------------- */ + char *getPath2(char *path1, char *path2) { char *complete_path = checked_malloc(strlen(path1) + 1 + strlen(path2) + 1); sprintf(complete_path, "%s/%s", path1, path2); + return complete_path; } @@ -400,14 +479,16 @@ char *getPath3(char *path1, char *path2, char *path3) strlen(path3) + 1); sprintf(complete_path, "%s/%s/%s", path1, path2, path3); + return complete_path; } -static char *getStringCat2(char *s1, char *s2) +char *getStringCat2(char *s1, char *s2) { char *complete_string = checked_malloc(strlen(s1) + strlen(s2) + 1); sprintf(complete_string, "%s%s", s1, s2); + return complete_string; } @@ -419,8 +500,8 @@ char *getStringCopy(char *s) return NULL; s_copy = checked_malloc(strlen(s) + 1); - strcpy(s_copy, s); + return s_copy; } @@ -436,6 +517,48 @@ char *getStringToLower(char *s) return s_copy; } +void setString(char **old_value, char *new_value) +{ + if (*old_value != NULL) + free(*old_value); + + *old_value = getStringCopy(new_value); +} + + +/* ------------------------------------------------------------------------- */ +/* 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]; @@ -450,11 +573,17 @@ void GetOptions(char *argv[]) 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.docs_directory = RO_BASE_PATH "/" DOCS_DIRECTORY; + options.execute_command = NULL; options.serveronly = FALSE; options.network = FALSE; options.verbose = FALSE; options.debug = FALSE; - options.debug_command = NULL; + +#if !defined(PLATFORM_UNIX) + if (*options_left == NULL) /* no options given -- enable verbose mode */ + options.verbose = TRUE; +#endif while (*options_left) { @@ -492,22 +621,7 @@ void GetOptions(char *argv[]) Error(ERR_EXIT_HELP, "unrecognized option '%s'", option); else if (strncmp(option, "-help", option_len) == 0) { - printf("Usage: %s [options] [ []]\n" - "Options:\n" - " -d, --display [:] X server display\n" - " -b, --basepath alternative base directory\n" - " -l, --level alternative level directory\n" - " -g, --graphics alternative graphics directory\n" - " -s, --sounds alternative sounds directory\n" - " -m, --music 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", - program.command_basename); - - if (options.debug) - printf(" --debug-command execute special command\n"); + printUsage(); exit(0); } @@ -587,12 +701,12 @@ void GetOptions(char *argv[]) { options.debug = TRUE; } - else if (strncmp(option, "-debug-command", option_len) == 0) + else if (strncmp(option, "-execute", option_len) == 0) { if (option_arg == NULL) Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str); - options.debug_command = option_arg; + options.execute_command = option_arg; if (option_arg == next_option) options_left++; } @@ -617,6 +731,11 @@ void GetOptions(char *argv[]) } } + +/* ------------------------------------------------------------------------- */ +/* error handling functions */ +/* ------------------------------------------------------------------------- */ + /* used by SetError() and GetError() to store internal error messages */ static char internal_error[1024]; /* this is bad */ @@ -636,6 +755,7 @@ char *GetError() void Error(int mode, char *format, ...) { + static boolean last_line_was_separator = FALSE; char *process_name = ""; FILE *error = stderr; char *newline = "\n"; @@ -644,6 +764,18 @@ void Error(int mode, char *format, ...) if (mode & ERR_WARN && !options.verbose) return; + if (mode == ERR_RETURN_LINE) + { + if (!last_line_was_separator) + fprintf_line(error, format, 79); + + last_line_was_separator = TRUE; + + return; + } + + last_line_was_separator = FALSE; + #if defined(PLATFORM_MSDOS) newline = "\r\n"; @@ -697,6 +829,11 @@ void Error(int mode, char *format, ...) } } + +/* ------------------------------------------------------------------------- */ +/* memory allocation functions */ +/* ------------------------------------------------------------------------- */ + void *checked_malloc(unsigned long size) { void *ptr; @@ -731,6 +868,11 @@ void *checked_realloc(void *ptr, unsigned long size) return ptr; } + +/* ------------------------------------------------------------------------- */ +/* various helper functions */ +/* ------------------------------------------------------------------------- */ + inline void swap_numbers(int *i1, int *i2) { int help = *i1; @@ -839,26 +981,28 @@ void putFileChunk(FILE *file, char *chunk_name, int chunk_size, int getFileVersion(FILE *file) { - int version_major, version_minor, version_patch; + int version_major, version_minor, version_patch, version_release; - version_major = fgetc(file); - version_minor = fgetc(file); - version_patch = fgetc(file); - fgetc(file); /* not used */ + version_major = fgetc(file); + version_minor = fgetc(file); + version_patch = fgetc(file); + version_release = fgetc(file); - return VERSION_IDENT(version_major, version_minor, version_patch); + return RELEASE_IDENT(version_major, version_minor, version_patch, + version_release); } void putFileVersion(FILE *file, int version) { - int version_major = VERSION_MAJOR(version); - int version_minor = VERSION_MINOR(version); - int version_patch = VERSION_PATCH(version); + int version_major = VERSION_MAJOR(version); + int version_minor = VERSION_MINOR(version); + int version_patch = VERSION_PATCH(version); + int version_release = VERSION_RELEASE(version); - fputc(version_major, file); - fputc(version_minor, file); - fputc(version_patch, file); - fputc(0, file); /* not used */ + fputc(version_major, file); + fputc(version_minor, file); + fputc(version_patch, file); + fputc(version_release, file); } void ReadUnusedBytesFromFile(FILE *file, unsigned long bytes) @@ -1221,9 +1365,66 @@ char getCharFromKey(Key key) } -/* ========================================================================= */ +/* ------------------------------------------------------------------------- */ +/* functions to translate string identifiers to integer or boolean value */ +/* ------------------------------------------------------------------------- */ + +int get_integer_from_string(char *s) +{ + static char *number_text[][3] = + { + { "0", "zero", "null", }, + { "1", "one", "first" }, + { "2", "two", "second" }, + { "3", "three", "third" }, + { "4", "four", "fourth" }, + { "5", "five", "fifth" }, + { "6", "six", "sixth" }, + { "7", "seven", "seventh" }, + { "8", "eight", "eighth" }, + { "9", "nine", "ninth" }, + { "10", "ten", "tenth" }, + { "11", "eleven", "eleventh" }, + { "12", "twelve", "twelfth" }, + }; + + 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) + result = i; + + if (result == -1) + result = atoi(s); + + free(s_lower); + + return result; +} + +boolean get_boolean_from_string(char *s) +{ + char *s_lower = getStringToLower(s); + boolean result = FALSE; + + if (strcmp(s_lower, "true") == 0 || + strcmp(s_lower, "yes") == 0 || + strcmp(s_lower, "on") == 0 || + get_integer_from_string(s) == 1) + result = TRUE; + + free(s_lower); + + return result; +} + + +/* ------------------------------------------------------------------------- */ /* functions for generic lists */ -/* ========================================================================= */ +/* ------------------------------------------------------------------------- */ ListNode *newListNode() { @@ -1301,9 +1502,18 @@ void dumpList(ListNode *node_first) } -/* ========================================================================= */ -/* functions for checking filenames */ -/* ========================================================================= */ +/* ------------------------------------------------------------------------- */ +/* functions for checking files and filenames */ +/* ------------------------------------------------------------------------- */ + +boolean fileExists(char *filename) +{ +#if 0 + printf("checking file '%s'\n", filename); +#endif + + return (access(filename, F_OK) == 0); +} boolean FileIsGraphic(char *filename) { @@ -1352,51 +1562,132 @@ boolean FileIsArtworkType(char *basename, int type) return FALSE; } -/* ========================================================================= */ +/* ------------------------------------------------------------------------- */ /* functions for loading artwork configuration information */ -/* ========================================================================= */ +/* ------------------------------------------------------------------------- */ -struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list, - struct ConfigInfo *suffix_list, - int num_file_list_entries) +/* This function checks if a string of the format "string1, string2, ..." + exactly contains a string . */ + +static boolean string_has_parameter(char *s, char *s_contained) { - struct FileInfo *file_list; - int num_suffix_list_entries = 0; - int list_pos = 0; - int i, j; + char *substring; - file_list = checked_calloc(num_file_list_entries * sizeof(struct FileInfo)); + if (s == NULL || s_contained == NULL) + return FALSE; - for (i=0; suffix_list[i].token != NULL; i++) - num_suffix_list_entries++; + if (strlen(s_contained) > strlen(s)) + return FALSE; - /* always start with reliable default values */ - for (i=0; i 0) { - int parameter_array_size = num_suffix_list_entries * sizeof(int); + 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 0) list_pos++; if (list_pos >= num_file_list_entries) - Error(ERR_EXIT, "inconsistant config list information -- please fix"); + 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) + { + Error(ERR_RETURN, "Configuration directive '%s' -> '%s':", + config_list[i].token, config_list[i].value); + Error(ERR_EXIT, "This seems to be no valid definition -- please fix"); + } file_list[list_pos].token = config_list[i].token; file_list[list_pos].default_filename = config_list[i].value; } } - if (list_pos != num_file_list_entries - 1) - Error(ERR_EXIT, "inconsistant config list information -- please fix"); + num_file_list_entries_found = list_pos + 1; + if (num_file_list_entries_found != num_file_list_entries) + { + Error(ERR_RETURN_LINE, "-"); + Error(ERR_RETURN, "inconsistant config list information:"); + Error(ERR_RETURN, "- should be: %d (according to 'src/conf_gfx.h')", + 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"); + } return file_list; } -static void LoadArtworkConfig(struct ArtworkListInfo *artwork_info) +static boolean token_suffix_match(char *token, char *suffix, int start_pos) +{ + int len_token = strlen(token); + int len_suffix = strlen(suffix); + +#if 0 + if (IS_PARENT_PROCESS()) + printf(":::::::::: check '%s' for '%s' ::::::::::\n", token, suffix); +#endif + + 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]" + +static void read_token_parameters(SetupFileHash *setup_file_hash, + struct ConfigInfo *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); + } +#if 0 + else + { + if (strcmp(file_list_entry->filename, + file_list_entry->default_filename) != 0) + printf("___ resetting '%s' to default\n", file_list_entry->token); + + setString(&file_list_entry->filename, file_list_entry->default_filename); + } +#endif + + /* 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 ConfigInfo *suffix_list, + int num_suffix_list_entries, + char *token) +{ + struct FileInfo *new_list_entry; + int parameter_array_size = num_suffix_list_entries * sizeof(char *); + +#if 0 + if (IS_PARENT_PROCESS()) + printf("===> found dynamic definition '%s'\n", token); +#endif + + (*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->filename = NULL; + new_list_entry->parameter = checked_calloc(parameter_array_size); + + 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 ConfigInfo *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, *extra_file_hash; + char *known_token_value = KNOWN_TOKEN_VALUE; + int i, j, k, l; + + if (filename == NULL) + return; + +#if 0 + printf("::: LoadArtworkConfigFromFilename: '%s'\n", filename); +#endif + + if ((setup_file_hash = loadSetupFileHash(filename)) == NULL) + return; + + /* read parameters for all known config file tokens */ + for (i=0; idynamic_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 0 + if (IS_PARENT_PROCESS()) + { + if (parameter_suffix_found) + printf("---> skipping token '%s' (parameter token)\n", token); + else + printf("---> examining token '%s': search prefix ...\n", token); + } +#endif + + if (parameter_suffix_found) + continue; + + /* ---------- step 0: search for matching base prefix ---------- */ + + start_pos = 0; + for (i=0; i examining token '%s': search 1st suffix ...\n", token); +#endif + + /* ---------- step 1: search for matching first suffix ---------- */ + + start_pos += len_base_prefix; + for (j=0; j examining token '%s': search 2nd suffix ...\n", token); +#endif + + /* ---------- step 2: search for matching second suffix ---------- */ + + for (k=0; k examining token '%s': search 3rd suffix ...\n",token); +#endif + + /* ---------- step 3: search for matching third suffix ---------- */ + + for (l=0; lnum_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 (extra_file_hash != NULL && options.verbose && IS_PARENT_PROCESS()) + { + SetupFileList *setup_file_list, *list; + boolean dynamic_tokens_found = FALSE; + boolean unknown_tokens_found = FALSE; + + if ((setup_file_list = loadSetupFileList(filename)) == NULL) + Error(ERR_EXIT, "loadSetupFileHash works, but loadSetupFileList fails"); + + BEGIN_HASH_ITERATION(extra_file_hash, itr) + { + if (strcmp(HASH_ITERATION_VALUE(itr), known_token_value) == 0) + dynamic_tokens_found = TRUE; + else + unknown_tokens_found = TRUE; + } + END_HASH_ITERATION(extra_file_hash, itr) + +#if DEBUG + if (dynamic_tokens_found) + { + Error(ERR_RETURN_LINE, "-"); + Error(ERR_RETURN, "dynamic token(s) found:"); + + for (list = setup_file_list; list != NULL; list = list->next) + { + char *value = getHashEntry(extra_file_hash, list->token); + + if (value != NULL && strcmp(value, known_token_value) == 0) + Error(ERR_RETURN, "- dynamic token: '%s'", list->token); + } + + Error(ERR_RETURN_LINE, "-"); + } +#endif + + 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); + + for (list = setup_file_list; list != NULL; list = list->next) + { + char *value = getHashEntry(extra_file_hash, list->token); + + if (value != NULL && strcmp(value, known_token_value) != 0) + Error(ERR_RETURN, "- dynamic token: '%s'", list->token); + } + + Error(ERR_RETURN_LINE, "-"); + } + + freeSetupFileList(setup_file_list); + } + + freeSetupFileHash(extra_file_hash); + +#if 0 + for (i=0; i '%s'\n", file_list[i].filename); + else + printf("-> UNDEFINED [-> '%s']\n", file_list[i].default_filename); + } +#endif +} + +void LoadArtworkConfig(struct ArtworkListInfo *artwork_info) +{ +#if 0 + struct FileInfo *file_list = artwork_info->file_list; + struct ConfigInfo *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; char *filename = getCustomArtworkConfigFilename(artwork_info->type); - struct SetupFileList *setup_file_list; + SetupFileHash *setup_file_hash, *extra_file_hash; + char *known_token_value = KNOWN_TOKEN_VALUE; + int i, j, k, l; +#else + struct FileInfo *file_list = artwork_info->file_list; + int num_file_list_entries = artwork_info->num_file_list_entries; + int num_suffix_list_entries = artwork_info->num_suffix_list_entries; + char *filename_base, *filename_local; int i, j; +#endif #if 0 printf("GOT CUSTOM ARTWORK CONFIG FILE '%s'\n", filename); @@ -1450,52 +2250,384 @@ static void LoadArtworkConfig(struct ArtworkListInfo *artwork_info) /* always start with reliable default values */ for (i=0; idynamic_file_list != NULL) + { + for (i=0; inum_dynamic_file_list_entries; i++) + { + free(artwork_info->dynamic_file_list[i].token); + free(artwork_info->dynamic_file_list[i].filename); + free(artwork_info->dynamic_file_list[i].parameter); + } + + free(artwork_info->dynamic_file_list); + artwork_info->dynamic_file_list = NULL; + + FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list, + &artwork_info->num_dynamic_file_list_entries); } + /* free previous property mapping */ + if (artwork_info->property_mapping != NULL) + { + free(artwork_info->property_mapping); + + artwork_info->property_mapping = NULL; + artwork_info->num_property_mapping_entries = 0; + } + +#if 1 + /* first look for special artwork configured in level series config */ + filename_base = getCustomArtworkLevelConfigFilename(artwork_info->type); + + if (fileExists(filename_base)) + LoadArtworkConfigFromFilename(artwork_info, filename_base); + +#if 0 + for(i=0; i '%s'\n", + file_list[i].token, file_list[i].filename); +#endif + +#if 1 + filename_local = getCustomArtworkConfigFilename(artwork_info->type); + + if (filename_local != NULL && strcmp(filename_base, filename_local) != 0) + LoadArtworkConfigFromFilename(artwork_info, filename_local); + +#if 0 + for(i=0; i '%s'\n", + file_list[i].token, file_list[i].filename); +#endif + +#endif +#endif + +#if 0 + if (filename == NULL) return; - if ((setup_file_list = loadSetupFileList(filename))) + if ((setup_file_hash = loadSetupFileHash(filename)) == NULL) + return; + + /* read parameters for all known config file tokens */ + for (i=0; idynamic_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++) { - char *filename = getTokenValue(setup_file_list, file_list[i].token); + int len_suffix = strlen(suffix_list[i].token); - if (filename == NULL) - filename = file_list[i].default_filename; - file_list[i].filename = getStringCopy(filename); + if (token_suffix_match(token, suffix_list[i].token, -len_suffix)) + parameter_suffix_found = TRUE; + } - for (j=0; j skipping token '%s' (parameter token)\n", token); + else + printf("---> examining token '%s': search prefix ...\n", token); + } +#endif + + if (parameter_suffix_found) + continue; + + /* ---------- step 0: search for matching base prefix ---------- */ + + start_pos = 0; + for (i=0; i examining token '%s': search 1st suffix ...\n", token); +#endif + + /* ---------- step 1: search for matching first suffix ---------- */ + + start_pos += len_base_prefix; + for (j=0; j examining token '%s': search 2nd suffix ...\n", token); +#endif + + /* ---------- step 2: search for matching second suffix ---------- */ + + for (k=0; k examining token '%s': search 3rd suffix ...\n",token); +#endif + + /* ---------- step 3: search for matching third suffix ---------- */ + + for (l=0; lnum_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 (extra_file_hash != NULL && options.verbose && IS_PARENT_PROCESS()) + { + SetupFileList *setup_file_list, *list; + boolean dynamic_tokens_found = FALSE; + boolean unknown_tokens_found = FALSE; + + if ((setup_file_list = loadSetupFileList(filename)) == NULL) + Error(ERR_EXIT, "loadSetupFileHash works, but loadSetupFileList fails"); + + BEGIN_HASH_ITERATION(extra_file_hash, itr) { - printf("'%s' ", file_list[i].token); - if (file_list[i].filename) - printf("-> '%s'\n", file_list[i].filename); + if (strcmp(HASH_ITERATION_VALUE(itr), known_token_value) == 0) + dynamic_tokens_found = TRUE; else - printf("-> UNDEFINED [-> '%s']\n", file_list[i].default_filename); + unknown_tokens_found = TRUE; + } + END_HASH_ITERATION(extra_file_hash, itr) + +#if DEBUG + if (dynamic_tokens_found) + { + Error(ERR_RETURN_LINE, "-"); + Error(ERR_RETURN, "dynamic token(s) found:"); + + for (list = setup_file_list; list != NULL; list = list->next) + { + char *value = getHashEntry(extra_file_hash, list->token); + + if (value != NULL && strcmp(value, known_token_value) == 0) + Error(ERR_RETURN, "- dynamic token: '%s'", list->token); + } + + Error(ERR_RETURN_LINE, "-"); } #endif + + 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); + + for (list = setup_file_list; list != NULL; list = list->next) + { + char *value = getHashEntry(extra_file_hash, list->token); + + if (value != NULL && strcmp(value, known_token_value) != 0) + Error(ERR_RETURN, "- dynamic token: '%s'", list->token); + } + + Error(ERR_RETURN_LINE, "-"); + } + + freeSetupFileList(setup_file_list); } + + freeSetupFileHash(extra_file_hash); + +#if 0 + for (i=0; i '%s'\n", file_list[i].filename); + else + printf("-> UNDEFINED [-> '%s']\n", file_list[i].default_filename); + } +#endif + +#endif } static void deleteArtworkListEntry(struct ArtworkListInfo *artwork_info, @@ -1525,9 +2657,29 @@ static void deleteArtworkListEntry(struct ArtworkListInfo *artwork_info, static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info, struct ListNodeInfo **listnode, - char *filename) + char *basename) { + char *init_text[] = + { "", + "Loading graphics:", + "Loading sounds:", + "Loading music:" + }; + ListNode *node; + char *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 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) @@ -1555,21 +2707,40 @@ static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info, *listnode = (struct ListNodeInfo *)node->content; (*listnode)->num_references++; + + return; } - else if ((*listnode = artwork_info->load_artwork(filename)) != NULL) + + DrawInitText(init_text[artwork_info->type], 120, FC_GREEN); + DrawInitText(basename, 150, FC_YELLOW); + + if ((*listnode = artwork_info->load_artwork(filename)) != NULL) { +#if 0 + printf("[adding new artwork '%s']\n", filename); +#endif + (*listnode)->num_references = 1; addNodeToList(&artwork_info->content_list, (*listnode)->source_filename, *listnode); } + else + { + int error_mode = ERR_WARN; + + /* we can get away without sounds and music, but not without graphics */ + if (artwork_info->type == ARTWORK_TYPE_GRAPHICS) + 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) { - char *filename = getCustomArtworkFilename(basename, artwork_info->type); - #if 0 printf("GOT CUSTOM ARTWORK FILE '%s'\n", filename); #endif @@ -1580,29 +2751,30 @@ static void LoadCustomArtwork(struct ArtworkListInfo *artwork_info, return; } - if (filename == NULL) - { - Error(ERR_WARN, "cannot find artwork file '%s'", basename); - return; - } - - replaceArtworkListEntry(artwork_info, listnode, filename); + replaceArtworkListEntry(artwork_info, listnode, basename); } static void LoadArtworkToList(struct ArtworkListInfo *artwork_info, + struct ListNodeInfo **listnode, char *basename, int list_pos) { +#if 0 if (artwork_info->artwork_list == NULL || list_pos >= artwork_info->num_file_list_entries) return; +#endif #if 0 printf("loading artwork '%s' ... [%d]\n", basename, getNumNodes(artwork_info->content_list)); #endif +#if 1 + LoadCustomArtwork(artwork_info, listnode, basename); +#else LoadCustomArtwork(artwork_info, &artwork_info->artwork_list[list_pos], basename); +#endif #if 0 printf("loading artwork '%s' done [%d]\n", @@ -1612,82 +2784,87 @@ static void LoadArtworkToList(struct ArtworkListInfo *artwork_info, void ReloadCustomArtworkList(struct ArtworkListInfo *artwork_info) { - static struct - { - char *text; - boolean do_it; - } - draw_init[] = - { - { "", FALSE }, - { "Loading graphics:", TRUE }, - { "Loading sounds:", TRUE }, - { "Loading music:", TRUE } - }; - - 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; - LoadArtworkConfig(artwork_info); - - if (draw_init[artwork_info->type].do_it) - DrawInitText(draw_init[artwork_info->type].text, 120, FC_GREEN); - #if 0 - printf("DEBUG: reloading %d artwork files ...\n", num_file_list_entries); + printf("DEBUG: reloading %d static artwork files ...\n", + num_file_list_entries); #endif for(i=0; itype].do_it) - DrawInitText(file_list[i].token, 150, FC_YELLOW); +#if 0 + if (strcmp(file_list[i].token, "background") == 0) + printf("::: '%s' -> '%s'\n", file_list[i].token, file_list[i].filename); +#endif - LoadArtworkToList(artwork_info, file_list[i].filename, i); + LoadArtworkToList(artwork_info, &artwork_info->artwork_list[i], + file_list[i].filename, i); } - draw_init[artwork_info->type].do_it = FALSE; +#if 0 + printf("DEBUG: reloading %d dynamic artwork files ...\n", + num_dynamic_file_list_entries); +#endif - /* - printf("list size == %d\n", getNumNodes(artwork_info->content_list)); - */ + for(i=0; idynamic_artwork_list[i], + dynamic_file_list[i].filename, i); #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->artwork_list == NULL) + if (*list == NULL) + return; + + for(i=0; i<*num_list_entries; i++) + deleteArtworkListEntry(artwork_info, &(*list)[i]); + free(*list); + + *list = NULL; + *num_list_entries = 0; +} + +void FreeCustomArtworkLists(struct ArtworkListInfo *artwork_info) +{ + if (artwork_info == NULL) return; #if 0 printf("%s: FREEING ARTWORK ...\n", - IS_CHILD_PROCESS(audio.mixer_pid) ? "CHILD" : "PARENT"); + IS_CHILD_PROCESS() ? "CHILD" : "PARENT"); #endif - for(i=0; inum_file_list_entries; i++) - deleteArtworkListEntry(artwork_info, &artwork_info->artwork_list[i]); + FreeCustomArtworkList(artwork_info, &artwork_info->artwork_list, + &artwork_info->num_file_list_entries); + + FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list, + &artwork_info->num_dynamic_file_list_entries); #if 0 printf("%s: FREEING ARTWORK -- DONE\n", - IS_CHILD_PROCESS(audio.mixer_pid) ? "CHILD" : "PARENT"); + IS_CHILD_PROCESS() ? "CHILD" : "PARENT"); #endif - - free(artwork_info->artwork_list); - - artwork_info->artwork_list = NULL; - artwork_info->num_file_list_entries = 0; } -/* ========================================================================= */ +/* ------------------------------------------------------------------------- */ /* functions only needed for non-Unix (non-command-line) systems */ /* (MS-DOS only; SDL/Windows creates files "stdout.txt" and "stderr.txt") */ -/* ========================================================================= */ +/* ------------------------------------------------------------------------- */ #if defined(PLATFORM_MSDOS) @@ -1718,9 +2895,9 @@ void dumpErrorFile() #endif -/* ========================================================================= */ +/* ------------------------------------------------------------------------- */ /* the following is only for debugging purpose and normally not used */ -/* ========================================================================= */ +/* ------------------------------------------------------------------------- */ #define DEBUG_NUM_TIMESTAMPS 3 @@ -1739,3 +2916,20 @@ void debug_print_timestamp(int counter_nr, char *message) counter[counter_nr][1] = Counter(); } + +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"); + } +}