X-Git-Url: https://git.artsoft.org/?a=blobdiff_plain;f=src%2Flibgame%2Fmisc.c;h=a502ec49026cd1baab8dc85ac4f267a8a1cd68c6;hb=4b1b5a2a67227d3023ff6da4596be31eae8eaefc;hp=264060305f3ba9e64d6d7268da8a1ca472fcfbb1;hpb=268045d6b06349f1cf10d5cc6f9516b5caa20dea;p=rocksndiamonds.git diff --git a/src/libgame/misc.c b/src/libgame/misc.c index 26406030..a502ec49 100644 --- a/src/libgame/misc.c +++ b/src/libgame/misc.c @@ -30,6 +30,7 @@ #include "setup.h" #include "random.h" #include "text.h" +#include "image.h" /* ------------------------------------------------------------------------- */ @@ -40,7 +41,7 @@ void fprintf_line(FILE *stream, char *line_string, int line_length) { int i; - for (i=0; i 2147483647) /* yes, this is a kludge */ + i = 2147483647; + + a = checked_malloc(10 + 1); + + sprintf(a, "%d", i); + + return a; +} + + +/* calculate base-2 logarithm of argument (rounded down to integer; + this function returns the number of the highest bit set in argument) */ + +int log_2(unsigned int x) +{ + int e = 0; + + while ((1 << e) < x) + { + x -= (1 << e); /* for rounding down (rounding up: remove this line) */ + e++; + } + + return e; +} + + /* ------------------------------------------------------------------------- */ /* counter functions */ /* ------------------------------------------------------------------------- */ @@ -242,7 +282,7 @@ void WaitUntilDelayReached(unsigned long *counter_var, unsigned long delay) { unsigned long actual_counter; - while(1) + while (1) { actual_counter = Counter(); @@ -261,48 +301,6 @@ void WaitUntilDelayReached(unsigned long *counter_var, unsigned long delay) /* random generator functions */ /* ------------------------------------------------------------------------- */ -#if 0 -unsigned int SimpleRND(unsigned int max) -{ - return (random_linux_libc(RND_FREE) % max); -} - -unsigned int InitSimpleRND(long seed) -{ - if (seed == NEW_RANDOMIZE) - { - struct timeval current_time; - - gettimeofday(¤t_time, NULL); - seed = (long)current_time.tv_usec; - } - - 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) - { - 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 init_random_number(int nr, long seed) { if (seed == NEW_RANDOMIZE) @@ -322,7 +320,7 @@ unsigned int init_random_number(int nr, long seed) return (unsigned int) seed; } -unsigned int get_random_number(int nr, unsigned int max) +unsigned int get_random_number(int nr, int max) { return (max > 0 ? random_linux_libc(nr) % max : 0); } @@ -332,38 +330,38 @@ unsigned int get_random_number(int nr, unsigned int max) /* system info functions */ /* ------------------------------------------------------------------------- */ +#if !defined(PLATFORM_MSDOS) static char *get_corrected_real_name(char *real_name) { char *real_name_new = checked_malloc(MAX_USERNAME_LEN + 1); char *from_ptr = real_name; char *to_ptr = real_name_new; - if (strchr(real_name, 'ß') == NULL) /* name does not contain 'ß' */ - { - strncpy(real_name_new, real_name, MAX_USERNAME_LEN); - real_name_new[MAX_USERNAME_LEN] = '\0'; - - return real_name_new; - } - - /* the user's real name may contain a 'ß' character (german sharp s), - which has no equivalent in upper case letters (which our fonts use) */ + /* copy the name string, but not more than MAX_USERNAME_LEN characters */ while (*from_ptr && (long)(to_ptr - real_name_new) < MAX_USERNAME_LEN - 1) { - if (*from_ptr != 'ß') - *to_ptr++ = *from_ptr++; - else + /* the name field read from "passwd" file may also contain additional + user information, separated by commas, which will be removed here */ + if (*from_ptr == ',') + break; + + /* the user's real name may contain 'ß' characters (german sharp s), + which have no equivalent in upper case letters (used by our fonts) */ + if (*from_ptr == 'ß') { from_ptr++; *to_ptr++ = 's'; *to_ptr++ = 's'; } + else + *to_ptr++ = *from_ptr++; } *to_ptr = '\0'; return real_name_new; } +#endif char *getLoginName() { @@ -519,8 +517,7 @@ char *getStringToLower(char *s) void setString(char **old_value, char *new_value) { - if (*old_value != NULL) - free(*old_value); + checked_free(*old_value); *old_value = getStringCopy(new_value); } @@ -530,36 +527,7 @@ void setString(char **old_value, char *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[]) +void GetOptions(char *argv[], void (*print_usage_function)(void)) { char **options_left = &argv[1]; @@ -621,7 +589,7 @@ void GetOptions(char *argv[]) Error(ERR_EXIT_HELP, "unrecognized option '%s'", option); else if (strncmp(option, "-help", option_len) == 0) { - printUsage(); + print_usage_function(); exit(0); } @@ -645,9 +613,17 @@ void GetOptions(char *argv[]) if (option_arg == next_option) options_left++; - /* adjust path for level directory accordingly */ + /* adjust paths for sub-directories in base directory accordingly */ options.level_directory = getPath2(options.ro_base_directory, LEVELS_DIRECTORY); + options.graphics_directory = + getPath2(options.ro_base_directory, GRAPHICS_DIRECTORY); + options.sounds_directory = + getPath2(options.ro_base_directory, SOUNDS_DIRECTORY); + options.music_directory = + getPath2(options.ro_base_directory, MUSIC_DIRECTORY); + options.docs_directory = + getPath2(options.ro_base_directory, DOCS_DIRECTORY); } else if (strncmp(option, "-levels", option_len) == 0) { @@ -709,6 +685,11 @@ void GetOptions(char *argv[]) options.execute_command = option_arg; if (option_arg == next_option) options_left++; + +#if 1 + /* when doing batch processing, always enable verbose mode (warnings) */ + options.verbose = TRUE; +#endif } else if (*option == '-') { @@ -831,7 +812,7 @@ void Error(int mode, char *format, ...) /* ------------------------------------------------------------------------- */ -/* memory allocation functions */ +/* checked memory allocation and freeing functions */ /* ------------------------------------------------------------------------- */ void *checked_malloc(unsigned long size) @@ -868,6 +849,12 @@ void *checked_realloc(void *ptr, unsigned long size) return ptr; } +void checked_free(void *ptr) +{ + if (ptr != NULL) /* this check should be done by free() anyway */ + free(ptr); +} + /* ------------------------------------------------------------------------- */ /* various helper functions */ @@ -893,27 +880,27 @@ inline void swap_number_pairs(int *x1, int *y1, int *x2, int *y2) *y2 = help_y; } -short getFile16BitInteger(FILE *file, int byte_order) +int getFile16BitInteger(FILE *file, int byte_order) { if (byte_order == BYTE_ORDER_BIG_ENDIAN) - return ((fgetc(file) << 8) | - (fgetc(file) << 0)); + return ((fgetc(file) << 8) | + (fgetc(file) << 0)); else /* BYTE_ORDER_LITTLE_ENDIAN */ - return ((fgetc(file) << 0) | - (fgetc(file) << 8)); + return ((fgetc(file) << 0) | + (fgetc(file) << 8)); } -void putFile16BitInteger(FILE *file, short value, int byte_order) +void putFile16BitInteger(FILE *file, int value, int byte_order) { if (byte_order == BYTE_ORDER_BIG_ENDIAN) { - fputc((value >> 8) & 0xff, file); - fputc((value >> 0) & 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 >> 0) & 0xff, file); + fputc((value >> 8) & 0xff, file); } } @@ -981,28 +968,26 @@ void putFileChunk(FILE *file, char *chunk_name, int chunk_size, int getFileVersion(FILE *file) { - int version_major, version_minor, version_patch, version_release; - - version_major = fgetc(file); - version_minor = fgetc(file); - version_patch = fgetc(file); - version_release = fgetc(file); + int version_major = fgetc(file); + int version_minor = fgetc(file); + int version_patch = fgetc(file); + int version_build = fgetc(file); - return RELEASE_IDENT(version_major, version_minor, version_patch, - version_release); + return VERSION_IDENT(version_major, version_minor, version_patch, + version_build); } 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_release = VERSION_RELEASE(version); + 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_release, file); + fputc(version_major, file); + fputc(version_minor, file); + fputc(version_patch, file); + fputc(version_build, file); } void ReadUnusedBytesFromFile(FILE *file, unsigned long bytes) @@ -1253,7 +1238,7 @@ void translate_keyname(Key *keysym, char **x11name, char **name, int mode) 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) { @@ -1373,32 +1358,41 @@ 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" }, + { "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++) + for (i = 0; number_text[i][0] != NULL; i++) + for (j = 0; j < 3; j++) if (strcmp(s_lower, number_text[i][j]) == 0) result = i; if (result == -1) - result = atoi(s); + { + if (strcmp(s_lower, "false") == 0) + result = 0; + else if (strcmp(s_lower, "true") == 0) + result = 1; + else + result = atoi(s); + } free(s_lower); @@ -1508,6 +1502,9 @@ void dumpList(ListNode *node_first) boolean fileExists(char *filename) { + if (filename == NULL) + return FALSE; + #if 0 printf("checking file '%s'\n", filename); #endif @@ -1515,37 +1512,87 @@ boolean fileExists(char *filename) return (access(filename, F_OK) == 0); } -boolean FileIsGraphic(char *filename) +boolean fileHasPrefix(char *basename, char *prefix) { - if (strlen(filename) > 4 && - strcmp(&filename[strlen(filename) - 4], ".pcx") == 0) + static char *basename_lower = NULL; + int basename_length, prefix_length; + + checked_free(basename_lower); + + if (basename == NULL || prefix == NULL) + return FALSE; + + basename_lower = getStringToLower(basename); + basename_length = strlen(basename_lower); + prefix_length = strlen(prefix); + + if (basename_length > prefix_length + 1 && + basename_lower[prefix_length] == '.' && + strncmp(basename_lower, prefix, prefix_length) == 0) return TRUE; return FALSE; } -boolean FileIsSound(char *basename) +boolean fileHasSuffix(char *basename, char *suffix) { - if (strlen(basename) > 4 && - strcmp(&basename[strlen(basename) - 4], ".wav") == 0) + 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] == '.' && + strcmp(&basename_lower[basename_length - suffix_length], suffix) == 0) return TRUE; return FALSE; } -boolean FileIsMusic(char *basename) +boolean FileIsGraphic(char *filename) +{ + char *basename = strrchr(filename, '/'); + + basename = (basename != NULL ? basename + 1 : filename); + + return fileHasSuffix(basename, "pcx"); +} + +boolean FileIsSound(char *filename) { - /* "music" can be a WAV (loop) file or (if compiled with SDL) a MOD file */ + char *basename = strrchr(filename, '/'); + + basename = (basename != NULL ? basename + 1 : filename); + + return fileHasSuffix(basename, "wav"); +} + +boolean FileIsMusic(char *filename) +{ + char *basename = strrchr(filename, '/'); + + basename = (basename != NULL ? basename + 1 : filename); if (FileIsSound(basename)) return TRUE; #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)) + if (fileHasPrefix(basename, "mod") || + fileHasSuffix(basename, "mod") || + fileHasSuffix(basename, "s3m") || + fileHasSuffix(basename, "it") || + fileHasSuffix(basename, "xm") || + fileHasSuffix(basename, "midi") || + fileHasSuffix(basename, "mid") || + fileHasSuffix(basename, "mp3") || + fileHasSuffix(basename, "ogg")) return TRUE; #endif @@ -1566,6 +1613,27 @@ boolean FileIsArtworkType(char *basename, int type) /* functions for loading artwork configuration information */ /* ------------------------------------------------------------------------- */ +char *get_mapped_token(char *token) +{ + /* !!! make this dynamically configurable (init.c:InitArtworkConfig) !!! */ + static char *map_token_prefix[][2] = + { + { "char_procent", "char_percent" }, + { NULL, } + }; + int i; + + for (i = 0; map_token_prefix[i][0] != NULL; i++) + { + int len_token_prefix = strlen(map_token_prefix[i][0]); + + if (strncmp(token, map_token_prefix[i][0], len_token_prefix) == 0) + return getStringCat2(map_token_prefix[i][1], &token[len_token_prefix]); + } + + return NULL; +} + /* This function checks if a string of the format "string1, string2, ..." exactly contains a string . */ @@ -1603,27 +1671,29 @@ static boolean string_has_parameter(char *s, char *s_contained) return string_has_parameter(substring, s_contained); } -int get_parameter_value(char *token, char *value_raw, int type) +int get_parameter_value(char *suffix, char *value_raw, int type) { char *value = getStringToLower(value_raw); int result = 0; /* probably a save default value */ - if (strcmp(token, ".direction") == 0) + if (strcmp(suffix, ".direction") == 0) { result = (strcmp(value, "left") == 0 ? MV_LEFT : strcmp(value, "right") == 0 ? MV_RIGHT : strcmp(value, "up") == 0 ? MV_UP : strcmp(value, "down") == 0 ? MV_DOWN : MV_NO_MOVING); } - else if (strcmp(token, ".anim_mode") == 0) + else if (strcmp(suffix, ".anim_mode") == 0) { - result = (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, "none") ? ANIM_NONE : - ANIM_LOOP); + 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, "horizontal") ? ANIM_HORIZONTAL : + string_has_parameter(value, "vertical") ? ANIM_VERTICAL : + ANIM_DEFAULT); if (string_has_parameter(value, "reverse")) result |= ANIM_REVERSE; @@ -1641,11 +1711,25 @@ int get_parameter_value(char *token, char *value_raw, int type) return result; } +int get_auto_parameter_value(char *token, char *value_raw) +{ + char *suffix; + + if (token == NULL || value_raw == NULL) + return ARG_UNDEFINED_VALUE; + + suffix = strrchr(token, '.'); + if (suffix == NULL) + suffix = token; + + return get_parameter_value(suffix, value_raw, TYPE_INTEGER); +} + static void FreeCustomArtworkList(struct ArtworkListInfo *, struct ListNodeInfo ***, int *); struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list, - struct ConfigInfo *suffix_list, + struct ConfigTypeInfo *suffix_list, char **ignore_tokens, int num_file_list_entries) { @@ -1657,11 +1741,11 @@ struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list, file_list = checked_calloc(num_file_list_entries * sizeof(struct FileInfo)); - for (i=0; suffix_list[i].token != NULL; i++) + for (i = 0; suffix_list[i].token != NULL; i++) num_suffix_list_entries++; /* always start with reliable default values */ - for (i=0; ifilename, filename); /* when file definition found, set all parameters to default values */ - for (i=0; suffix_list[i].token != NULL; i++) + for (i = 0; suffix_list[i].token != NULL; i++) setString(&file_list_entry->parameter[i], suffix_list[i].value); file_list_entry->redefined = TRUE; @@ -1813,7 +1900,7 @@ static void read_token_parameters(SetupFileHash *setup_file_hash, #endif /* check for config tokens that can be build by base token and suffixes */ - for (i=0; suffix_list[i].token != NULL; i++) + 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); @@ -1833,7 +1920,7 @@ static void read_token_parameters(SetupFileHash *setup_file_hash, static void add_dynamic_file_list_entry(struct FileInfo **list, int *num_list_entries, SetupFileHash *extra_file_hash, - struct ConfigInfo *suffix_list, + struct ConfigTypeInfo *suffix_list, int num_suffix_list_entries, char *token) { @@ -1850,9 +1937,13 @@ static void add_dynamic_file_list_entry(struct FileInfo **list, 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; + read_token_parameters(extra_file_hash, suffix_list, new_list_entry); } @@ -1881,7 +1972,7 @@ 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; + 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; @@ -1894,7 +1985,8 @@ static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info, int num_ext2_suffixes = artwork_info->num_ext2_suffixes; int num_ext3_suffixes = artwork_info->num_ext3_suffixes; int num_ignore_tokens = artwork_info->num_ignore_tokens; - SetupFileHash *setup_file_hash, *extra_file_hash; + 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; @@ -1908,26 +2000,65 @@ static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info, 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); + +#if 1 + /* 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) +#endif + /* read parameters for all known config file tokens */ - for (i=0; isizeof_artwork_list_entry); } - if (extra_file_hash != NULL && options.verbose && IS_PARENT_PROCESS()) + 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"); @@ -2162,11 +2294,11 @@ static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info, } END_HASH_ITERATION(extra_file_hash, itr) -#if DEBUG - if (dynamic_tokens_found) + if (options.debug && dynamic_tokens_found) { Error(ERR_RETURN_LINE, "-"); - Error(ERR_RETURN, "dynamic token(s) found:"); + Error(ERR_RETURN, "dynamic token(s) found in config file:"); + Error(ERR_RETURN, "- config file: '%s'", filename); for (list = setup_file_list; list != NULL; list = list->next) { @@ -2178,7 +2310,6 @@ static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info, Error(ERR_RETURN_LINE, "-"); } -#endif if (unknown_tokens_found) { @@ -2197,13 +2328,31 @@ static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info, Error(ERR_RETURN_LINE, "-"); } + if (undefined_values_found) + { + Error(ERR_RETURN_LINE, "-"); + Error(ERR_RETURN, "warning: undefined values found in config file:"); + Error(ERR_RETURN, "- config file: '%s'", filename); + + for (list = setup_file_list; list != NULL; list = list->next) + { + char *value = getHashEntry(empty_file_hash, list->token); + + if (value != NULL) + Error(ERR_RETURN, "- undefined value for token: '%s'", list->token); + } + + Error(ERR_RETURN_LINE, "-"); + } + freeSetupFileList(setup_file_list); } freeSetupFileHash(extra_file_hash); + freeSetupFileHash(empty_file_hash); #if 0 - for (i=0; ifile_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); - 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; + char *filename_base = UNDEFINED_FILENAME, *filename_local; int i, j; -#endif #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; idynamic_file_list != NULL) { - for (i=0; inum_dynamic_file_list_entries; i++) + for (i = 0; i < artwork_info->num_dynamic_file_list_entries; i++) { free(artwork_info->dynamic_file_list[i].token); free(artwork_info->dynamic_file_list[i].filename); @@ -2284,383 +2416,162 @@ void LoadArtworkConfig(struct ArtworkListInfo *artwork_info) 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 (!SETUP_OVERRIDE_ARTWORK(setup, artwork_info->type)) + { + /* first look for special artwork configured in level series config */ + filename_base = getCustomArtworkLevelConfigFilename(artwork_info->type); -#if 0 - for(i=0; i '%s'\n", - file_list[i].token, file_list[i].filename); -#endif + if (fileExists(filename_base)) + LoadArtworkConfigFromFilename(artwork_info, filename_base); + } -#if 1 filename_local = getCustomArtworkConfigFilename(artwork_info->type); if (filename_local != NULL && strcmp(filename_base, filename_local) != 0) LoadArtworkConfigFromFilename(artwork_info, filename_local); +} + +static void deleteArtworkListEntry(struct ArtworkListInfo *artwork_info, + struct ListNodeInfo **listnode) +{ + if (*listnode) + { + char *filename = (*listnode)->source_filename; #if 0 - for(i=0; i '%s'\n", - file_list[i].token, file_list[i].filename); + printf("[decrementing reference counter of artwork '%s']\n", filename); #endif -#endif + if (--(*listnode)->num_references <= 0) + { +#if 0 + printf("[deleting artwork '%s']\n", filename); #endif -#if 0 + deleteNodeFromList(&artwork_info->content_list, filename, + artwork_info->free_artwork); + } + + *listnode = NULL; + } +} + +#if 1 +static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info, + struct ListNodeInfo **listnode, + struct FileInfo *file_list_entry) +{ + char *init_text[] = + { + "Loading graphics:", + "Loading sounds:", + "Loading music:" + }; + + ListNode *node; + char *basename = file_list_entry->filename; + char *filename = getCustomArtworkFilename(basename, artwork_info->type); if (filename == NULL) - return; + { + Error(ERR_WARN, "cannot find artwork file '%s'", basename); - if ((setup_file_hash = loadSetupFileHash(filename)) == NULL) - return; + basename = file_list_entry->default_filename; - /* read parameters for all known config file tokens */ - for (i=0; ifallback_to_default = TRUE; - /* copy all unknown config file tokens to extra config list */ - extra_file_hash = newSetupFileHash(); - BEGIN_HASH_ITERATION(setup_file_hash, itr) - { - if (strcmp(HASH_ITERATION_VALUE(itr), known_token_value) != 0) - setHashEntry(extra_file_hash, - HASH_ITERATION_TOKEN(itr), HASH_ITERATION_VALUE(itr)); - } - END_HASH_ITERATION(setup_file_hash, itr) + Error(ERR_WARN, "trying default artwork file '%s'", basename); - /* at this point, we do not need the config file hash anymore -- free it */ - freeSetupFileHash(setup_file_hash); + filename = getCustomArtworkFilename(basename, artwork_info->type); - /* now try to determine valid, dynamically defined config tokens */ + if (filename == NULL) + { + int error_mode = ERR_WARN; - BEGIN_HASH_ITERATION(extra_file_hash, itr) + /* 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) { - 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; - } + /* 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 - 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); - } + printf("[artwork '%s' already exists (same list entry)]\n", filename); #endif - if (parameter_suffix_found) - continue; - - /* ---------- step 0: search for matching base prefix ---------- */ - - start_pos = 0; - for (i=0; icontent_list, filename)) != NULL) + { #if 0 - if (IS_PARENT_PROCESS()) - printf("---> examining token '%s': search 1st suffix ...\n", token); + printf("[artwork '%s' already exists (other list entry)]\n", filename); #endif - /* ---------- step 1: search for matching first suffix ---------- */ - - start_pos += len_base_prefix; - for (j=0; jcontent; + (*listnode)->num_references++; - if (exact_match) - break; + return; + } #if 0 - if (IS_PARENT_PROCESS()) - printf("---> examining token '%s': search 2nd suffix ...\n", token); + printf("::: %s: '%s'\n", init_text[artwork_info->type], basename); #endif - /* ---------- step 2: search for matching second suffix ---------- */ - - for (k=0; ktype], 120, FC_GREEN); + DrawInitText(basename, 150, FC_YELLOW); + if ((*listnode = artwork_info->load_artwork(filename)) != NULL) + { #if 0 - if (IS_PARENT_PROCESS()) - printf("---> examining token '%s': search 3rd suffix ...\n",token); + printf("[adding new artwork '%s']\n", filename); #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); + (*listnode)->num_references = 1; + addNodeToList(&artwork_info->content_list, (*listnode)->source_filename, + *listnode); } - - if (extra_file_hash != NULL && options.verbose && IS_PARENT_PROCESS()) + else { - 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); - } + int error_mode = ERR_WARN; - Error(ERR_RETURN_LINE, "-"); - } +#if 1 + /* we can get away without sounds and music, but not without graphics */ + if (artwork_info->type == ARTWORK_TYPE_GRAPHICS) + error_mode = ERR_EXIT; #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); + Error(error_mode, "cannot load artwork file '%s'", basename); + return; } -#endif - -#endif } -static void deleteArtworkListEntry(struct ArtworkListInfo *artwork_info, - struct ListNodeInfo **listnode) -{ - if (*listnode) - { - 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; - } -} +#else static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info, struct ListNodeInfo **listnode, char *basename) { char *init_text[] = - { "", + { "Loading graphics:", "Loading sounds:", "Loading music:" @@ -2673,9 +2584,14 @@ static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info, { int error_mode = ERR_WARN; +#if 1 + /* !!! NEW ARTWORK FALLBACK CODE !!! NEARLY UNTESTED !!! */ + /* before failing, try fallback to default artwork */ +#else /* 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; +#endif Error(error_mode, "cannot find artwork file '%s'", basename); return; @@ -2711,6 +2627,10 @@ static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info, return; } +#if 0 + printf("::: %s: '%s'\n", init_text[artwork_info->type], basename); +#endif + DrawInitText(init_text[artwork_info->type], 120, FC_GREEN); DrawInitText(basename, 150, FC_YELLOW); @@ -2728,14 +2648,37 @@ static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info, { int error_mode = ERR_WARN; +#if 1 /* we can get away without sounds and music, but not without graphics */ if (artwork_info->type == ARTWORK_TYPE_GRAPHICS) error_mode = ERR_EXIT; +#endif Error(error_mode, "cannot load artwork file '%s'", basename); return; } } +#endif + +#if 1 +static void LoadCustomArtwork(struct ArtworkListInfo *artwork_info, + struct ListNodeInfo **listnode, + struct FileInfo *file_list_entry) +{ +#if 0 + printf("GOT CUSTOM ARTWORK FILE '%s'\n", filename); +#endif + + if (strcmp(file_list_entry->filename, UNDEFINED_FILENAME) == 0) + { + deleteArtworkListEntry(artwork_info, listnode); + return; + } + + replaceArtworkListEntry(artwork_info, listnode, file_list_entry); +} + +#else static void LoadCustomArtwork(struct ArtworkListInfo *artwork_info, struct ListNodeInfo **listnode, @@ -2753,6 +2696,38 @@ static void LoadCustomArtwork(struct ArtworkListInfo *artwork_info, replaceArtworkListEntry(artwork_info, listnode, basename); } +#endif + +#if 1 +static void LoadArtworkToList(struct ArtworkListInfo *artwork_info, + struct ListNodeInfo **listnode, + struct FileInfo *file_list_entry) +{ +#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, file_list_entry); +#else + LoadCustomArtwork(artwork_info, &artwork_info->artwork_list[list_pos], + basename); +#endif + +#if 0 + printf("loading artwork '%s' done [%d]\n", + basename, getNumNodes(artwork_info->content_list)); +#endif +} + +#else static void LoadArtworkToList(struct ArtworkListInfo *artwork_info, struct ListNodeInfo **listnode, @@ -2781,6 +2756,7 @@ static void LoadArtworkToList(struct ArtworkListInfo *artwork_info, basename, getNumNodes(artwork_info->content_list)); #endif } +#endif void ReloadCustomArtworkList(struct ArtworkListInfo *artwork_info) { @@ -2796,15 +2772,43 @@ void ReloadCustomArtworkList(struct ArtworkListInfo *artwork_info) num_file_list_entries); #endif - for(i=0; i '%s'\n", file_list[i].token, file_list[i].filename); #endif +#if 1 + LoadArtworkToList(artwork_info, &artwork_info->artwork_list[i], + &file_list[i]); +#else LoadArtworkToList(artwork_info, &artwork_info->artwork_list[i], file_list[i].filename, i); +#endif + +#if 0 + /* !!! NEW ARTWORK FALLBACK CODE !!! NEARLY UNTESTED !!! */ + if (artwork_info->artwork_list[i] == NULL && + strcmp(file_list[i].filename, UNDEFINED_FILENAME) != 0 && + strcmp(file_list[i].default_filename, file_list[i].filename) != 0 && + strcmp(file_list[i].default_filename, UNDEFINED_FILENAME) != 0) + { + Error(ERR_WARN, "trying default artwork file '%s'", + file_list[i].default_filename); + + LoadArtworkToList(artwork_info, &artwork_info->artwork_list[i], + file_list[i].default_filename, i); + + /* even the fallback to default artwork was not successful -- fail now */ + if (artwork_info->artwork_list[i] == NULL && + artwork_info->type == ARTWORK_TYPE_GRAPHICS) + Error(ERR_EXIT, "cannot find artwork file '%s' or default file '%s'", + file_list[i].filename, file_list[i].default_filename); + + file_list[i].fallback_to_default = TRUE; + } +#endif } #if 0 @@ -2812,9 +2816,24 @@ void ReloadCustomArtworkList(struct ArtworkListInfo *artwork_info) num_dynamic_file_list_entries); #endif - for(i=0; idynamic_artwork_list[i], + &dynamic_file_list[i]); +#else LoadArtworkToList(artwork_info, &artwork_info->dynamic_artwork_list[i], dynamic_file_list[i].filename, i); +#endif + +#if 0 + printf("::: '%s', '0x%08x'\n", + dynamic_file_list[i].filename, + dynamic_file_list[i].default_filename); +#endif + + /* dynamic artwork does not have default filename! */ + } #if 0 dumpList(artwork_info->content_list); @@ -2830,7 +2849,7 @@ static void FreeCustomArtworkList(struct ArtworkListInfo *artwork_info, if (*list == NULL) return; - for(i=0; i<*num_list_entries; i++) + for (i = 0; i < *num_list_entries; i++) deleteArtworkListEntry(artwork_info, &(*list)[i]); free(*list);