X-Git-Url: https://git.artsoft.org/?a=blobdiff_plain;f=src%2Flibgame%2Fmisc.c;h=f35620c237768cadcb77ac225d9bf8ba7c168bc0;hb=29fc833ae1b5e46a429a9fa82098e8ad94f6f400;hp=bfc6d454d9652253e9766676960913783c469a9c;hpb=da14f69fd95c7bd5a0d70cdf4935af06f1f20a04;p=rocksndiamonds.git diff --git a/src/libgame/misc.c b/src/libgame/misc.c index bfc6d454..f35620c2 100644 --- a/src/libgame/misc.c +++ b/src/libgame/misc.c @@ -1,14 +1,14 @@ /*********************************************************** -* Rocks'n'Diamonds -- McDuffin Strikes Back! * +* Artsoft Retro-Game Library * *----------------------------------------------------------* -* (c) 1995-98 Artsoft Entertainment * -* Holger Schemel * -* Oststrasse 11a * -* 33604 Bielefeld * -* phone: ++49 +521 290471 * -* email: aeglos@valinor.owl.de * +* (c) 1994-2002 Artsoft Entertainment * +* Holger Schemel * +* Detmolder Strasse 189 * +* 33604 Bielefeld * +* Germany * +* e-mail: info@artsoft.org * *----------------------------------------------------------* -* misc.c * +* misc.c * ***********************************************************/ #include @@ -16,19 +16,75 @@ #include #include #include +#include +#include + +#include "platform.h" #if !defined(PLATFORM_WIN32) #include #include #endif -#include "libgame.h" +#include "misc.h" +#include "setup.h" +#include "random.h" +#include "text.h" -#include "main_TMP.h" -#include "misc.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; + } +} -#include "joystick_TMP.h" + +/* ------------------------------------------------------------------------- */ +/* counter functions */ +/* ------------------------------------------------------------------------- */ #if defined(PLATFORM_MSDOS) volatile unsigned long counter = 0; @@ -110,10 +166,12 @@ static void sleep_milliseconds(unsigned long 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/Windows + /* 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) @@ -133,6 +191,8 @@ static void sleep_milliseconds(unsigned long milliseconds_delay) { #if defined(TARGET_SDL) SDL_Delay(milliseconds_delay); +#elif defined(TARGET_ALLEGRO) + rest(milliseconds_delay); #else struct timeval delay; @@ -155,12 +215,13 @@ boolean FrameReached(unsigned long *frame_counter_var, { unsigned long actual_frame_counter = FrameCounter; - if (actual_frame_counter < *frame_counter_var+frame_delay && + if (actual_frame_counter < *frame_counter_var + frame_delay && actual_frame_counter >= *frame_counter_var) - return(FALSE); + return FALSE; *frame_counter_var = actual_frame_counter; - return(TRUE); + + return TRUE; } boolean DelayReached(unsigned long *counter_var, @@ -170,10 +231,11 @@ boolean DelayReached(unsigned long *counter_var, if (actual_counter < *counter_var + delay && actual_counter >= *counter_var) - return(FALSE); + return FALSE; *counter_var = actual_counter; - return(TRUE); + + return TRUE; } void WaitUntilDelayReached(unsigned long *counter_var, unsigned long delay) @@ -194,35 +256,10 @@ void WaitUntilDelayReached(unsigned long *counter_var, unsigned long delay) *counter_var = actual_counter; } -/* int2str() returns a number converted to a string; - the used memory is static, but will be overwritten by later calls, - so if you want to save the result, copy it to a private string buffer; - there can be 10 local calls of int2str() without buffering the result -- - the 11th call will then destroy the result from the first call and so on. -*/ - -char *int2str(int number, int size) -{ - static char shift_array[10][40]; - static int shift_counter = 0; - char *s = shift_array[shift_counter]; - - shift_counter = (shift_counter + 1) % 10; - - if (size > 20) - size = 20; - if (size) - { - sprintf(s, " %09d", number); - return &s[strlen(s) - size]; - } - else - { - sprintf(s, "%d", number); - return s; - } -} +/* ------------------------------------------------------------------------- */ +/* random generator functions */ +/* ------------------------------------------------------------------------- */ unsigned int SimpleRND(unsigned int max) { @@ -294,17 +331,29 @@ unsigned int InitRND(long seed) #endif } + +/* ------------------------------------------------------------------------- */ +/* system info functions */ +/* ------------------------------------------------------------------------- */ + char *getLoginName() { #if defined(PLATFORM_WIN32) return ANONYMOUS_NAME; #else - struct passwd *pwd; + static char *login_name = NULL; - if ((pwd = getpwuid(getuid())) == NULL) - return ANONYMOUS_NAME; - else - return pwd->pw_name; + if (login_name == NULL) + { + struct passwd *pwd; + + if ((pwd = getpwuid(getuid())) == NULL) + login_name = ANONYMOUS_NAME; + else + login_name = getStringCopy(pwd->pw_name); + } + + return login_name; #endif } @@ -350,16 +399,16 @@ char *getHomeDir() #if defined(PLATFORM_UNIX) static char *home_dir = NULL; - if (!home_dir) + if (home_dir == NULL) { - if (!(home_dir = getenv("HOME"))) + if ((home_dir = getenv("HOME")) == NULL) { struct passwd *pwd; - if ((pwd = getpwuid(getuid()))) - home_dir = pwd->pw_dir; - else + if ((pwd = getpwuid(getuid())) == NULL) home_dir = "."; + else + home_dir = getStringCopy(pwd->pw_dir); } } @@ -369,6 +418,11 @@ char *getHomeDir() #endif } + +/* ------------------------------------------------------------------------- */ +/* various string functions */ +/* ------------------------------------------------------------------------- */ + char *getPath2(char *path1, char *path2) { char *complete_path = checked_malloc(strlen(path1) + 1 + @@ -388,6 +442,14 @@ char *getPath3(char *path1, char *path2, char *path3) return complete_path; } +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; +} + char *getStringCopy(char *s) { char *s_copy; @@ -413,35 +475,46 @@ char *getStringToLower(char *s) return s_copy; } -void MarkTileDirty(int x, int y) +void setString(char **old_value, char *new_value) { - int xx = redraw_x1 + x; - int yy = redraw_y1 + y; + if (*old_value != NULL) + free(*old_value); - if (!redraw[xx][yy]) - redraw_tiles++; - - redraw[xx][yy] = TRUE; - redraw_mask |= REDRAW_TILES; + *old_value = getStringCopy(new_value); } -void SetBorderElement() -{ - int x, y; - - BorderElement = EL_LEERRAUM; - for(y=0; y= 0) + { + /* write chunk size */ + putFile32BitInteger(file, chunk_size, byte_order); + } +} + +int getFileVersion(FILE *file) +{ + int version_major, version_minor, version_patch; + + version_major = fgetc(file); + version_minor = fgetc(file); + version_patch = fgetc(file); + fgetc(file); /* not used */ + + return VERSION_IDENT(version_major, version_minor, version_patch); +} + +void putFileVersion(FILE *file, int version) +{ + int version_major = VERSION_MAJOR(version); + int version_minor = VERSION_MINOR(version); + int version_patch = VERSION_PATCH(version); + + fputc(version_major, file); + fputc(version_minor, file); + fputc(version_patch, file); + fputc(0, file); /* not used */ +} + +void ReadUnusedBytesFromFile(FILE *file, unsigned long bytes) +{ + while (bytes-- && !feof(file)) + fgetc(file); +} + +void WriteUnusedBytesToFile(FILE *file, unsigned long bytes) +{ + while (bytes--) + fputc(0, file); } + +/* ------------------------------------------------------------------------- */ +/* functions to translate key identifiers between different format */ +/* ------------------------------------------------------------------------- */ + #define TRANSLATE_KEYSYM_TO_KEYNAME 0 #define TRANSLATE_KEYSYM_TO_X11KEYNAME 1 -#define TRANSLATE_X11KEYNAME_TO_KEYSYM 2 +#define TRANSLATE_KEYNAME_TO_KEYSYM 2 +#define TRANSLATE_X11KEYNAME_TO_KEYSYM 3 void translate_keyname(Key *keysym, char **x11name, char **name, int mode) { @@ -871,8 +1101,8 @@ void translate_keyname(Key *keysym, char **x11name, char **name, int mode) sprintf(name_buffer, "%c", '0' + (char)(key - KSYM_0)); else if (key >= KSYM_KP_0 && key <= KSYM_KP_9) sprintf(name_buffer, "keypad %c", '0' + (char)(key - KSYM_KP_0)); - else if (key >= KSYM_F1 && key <= KSYM_F24) - sprintf(name_buffer, "function F%d", (int)(key - KSYM_F1 + 1)); + else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST) + sprintf(name_buffer, "function F%d", (int)(key - KSYM_FKEY_FIRST + 1)); else if (key == KSYM_UNDEFINED) strcpy(name_buffer, "(undefined)"); else @@ -908,8 +1138,8 @@ void translate_keyname(Key *keysym, char **x11name, char **name, int mode) sprintf(name_buffer, "XK_%c", '0' + (char)(key - KSYM_0)); else if (key >= KSYM_KP_0 && key <= KSYM_KP_9) sprintf(name_buffer, "XK_KP_%c", '0' + (char)(key - KSYM_KP_0)); - else if (key >= KSYM_F1 && key <= KSYM_F24) - sprintf(name_buffer, "XK_F%d", (int)(key - KSYM_F1 + 1)); + else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST) + sprintf(name_buffer, "XK_F%d", (int)(key - KSYM_FKEY_FIRST + 1)); else if (key == KSYM_UNDEFINED) strcpy(name_buffer, "[undefined]"); else @@ -932,6 +1162,26 @@ void translate_keyname(Key *keysym, char **x11name, char **name, int mode) *x11name = name_buffer; } + else if (mode == TRANSLATE_KEYNAME_TO_KEYSYM) + { + Key key = KSYM_UNDEFINED; + + i = 0; + do + { + if (strcmp(translate_key[i].name, *name) == 0) + { + 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; @@ -965,7 +1215,7 @@ void translate_keyname(Key *keysym, char **x11name, char **name, int mode) ((c2 >= '0' && c1 <= '9') || c2 == '\0')) d = atoi(&name_ptr[4]); - if (d >=1 && d <= 24) + if (d >= 1 && d <= KSYM_NUM_FKEYS) key = KSYM_F1 + (Key)(d - 1); } else if (strncmp(name_ptr, "XK_", 3) == 0) @@ -1033,6 +1283,14 @@ char *getX11KeyNameFromKey(Key key) return x11name; } +Key getKeyFromKeyName(char *name) +{ + Key key; + + translate_keyname(&key, NULL, &name, TRANSLATE_KEYNAME_TO_KEYSYM); + return key; +} + Key getKeyFromX11KeyName(char *x11name) { Key key; @@ -1056,316 +1314,1053 @@ char getCharFromKey(Key key) return letter; } -#define TRANSLATE_JOYSYMBOL_TO_JOYNAME 0 -#define TRANSLATE_JOYNAME_TO_JOYSYMBOL 1 -void translate_joyname(int *joysymbol, char **name, int mode) +/* ------------------------------------------------------------------------- */ +/* functions to translate string identifiers to integer or boolean value */ +/* ------------------------------------------------------------------------- */ + +int get_integer_from_string(char *s) { - static struct - { - int joysymbol; - char *name; - } translate_joy[] = + static char *number_text[][3] = { - { JOY_LEFT, "joystick_left" }, - { JOY_RIGHT, "joystick_right" }, - { JOY_UP, "joystick_up" }, - { JOY_DOWN, "joystick_down" }, - { JOY_BUTTON_1, "joystick_button_1" }, - { JOY_BUTTON_2, "joystick_button_2" }, + { "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; + int i, j; + char *s_lower = getStringToLower(s); + int result = -1; - if (mode == TRANSLATE_JOYSYMBOL_TO_JOYNAME) - { - *name = "[undefined]"; + for (i=0; i<13; i++) + for (j=0; j<3; j++) + if (strcmp(s_lower, number_text[i][j]) == 0) + result = i; - for (i=0; i<6; i++) - { - if (*joysymbol == translate_joy[i].joysymbol) - { - *name = translate_joy[i].name; - break; - } - } - } - else if (mode == TRANSLATE_JOYNAME_TO_JOYSYMBOL) - { - *joysymbol = 0; + if (result == -1) + result = atoi(s); - for (i=0; i<6; i++) - { - if (strcmp(*name, translate_joy[i].name) == 0) - { - *joysymbol = translate_joy[i].joysymbol; - break; - } - } - } + free(s_lower); + + return result; } -char *getJoyNameFromJoySymbol(int joysymbol) +boolean get_boolean_from_string(char *s) { - char *name; + char *s_lower = getStringToLower(s); + boolean result = FALSE; - translate_joyname(&joysymbol, &name, TRANSLATE_JOYSYMBOL_TO_JOYNAME); - return name; + 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() +{ + return checked_calloc(sizeof(ListNode)); +} + +void addNodeToList(ListNode **node_first, char *key, void *content) +{ + 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; + *node_first = node_new; } -int getJoySymbolFromJoyName(char *name) +void deleteNodeFromList(ListNode **node_first, char *key, + void (*destructor_function)(void *)) { - int joysymbol; + if (node_first == NULL || *node_first == NULL) + return; + +#if 0 + printf("[CHECKING LIST KEY '%s' == '%s']\n", + (*node_first)->key, key); +#endif - translate_joyname(&joysymbol, &name, TRANSLATE_JOYNAME_TO_JOYSYMBOL); - return joysymbol; + if (strcmp((*node_first)->key, key) == 0) + { +#if 0 + printf("[DELETING LIST ENTRY]\n"); +#endif + + free((*node_first)->key); + if (destructor_function) + destructor_function((*node_first)->content); + *node_first = (*node_first)->next; + } + else + deleteNodeFromList(&(*node_first)->next, key, destructor_function); } -int getJoystickNrFromDeviceName(char *device_name) +ListNode *getNodeFromKey(ListNode *node_first, char *key) { - char c; - int joystick_nr = 0; + if (node_first == NULL) + return NULL; - if (device_name == NULL || device_name[0] == '\0') - return 0; + if (strcmp(node_first->key, key) == 0) + return node_first; + else + return getNodeFromKey(node_first->next, key); +} - c = device_name[strlen(device_name) - 1]; +int getNumNodes(ListNode *node_first) +{ + return (node_first ? 1 + getNumNodes(node_first->next) : 0); +} - if (c >= '0' && c <= '9') - joystick_nr = (int)(c - '0'); +void dumpList(ListNode *node_first) +{ + ListNode *node = node_first; - if (joystick_nr < 0 || joystick_nr >= MAX_PLAYERS) - joystick_nr = 0; + while (node) + { + printf("['%s' (%d)]\n", node->key, + ((struct ListNodeInfo *)node->content)->num_references); + node = node->next; + } - return joystick_nr; + printf("[%d nodes]\n", getNumNodes(node_first)); } + /* ------------------------------------------------------------------------- */ -/* some functions to handle lists of level directories */ +/* functions for checking filenames */ /* ------------------------------------------------------------------------- */ -struct LevelDirInfo *newLevelDirInfo() +boolean FileIsGraphic(char *filename) +{ + if (strlen(filename) > 4 && + strcmp(&filename[strlen(filename) - 4], ".pcx") == 0) + return TRUE; + + return FALSE; +} + +boolean FileIsSound(char *basename) { - return checked_calloc(sizeof(struct LevelDirInfo)); + if (strlen(basename) > 4 && + strcmp(&basename[strlen(basename) - 4], ".wav") == 0) + return TRUE; + + return FALSE; } -void pushLevelDirInfo(struct LevelDirInfo **node_first, - struct LevelDirInfo *node_new) +boolean FileIsMusic(char *basename) { - node_new->next = *node_first; - *node_first = node_new; + /* "music" can be a WAV (loop) file or (if compiled with SDL) a MOD file */ + + 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)) + return TRUE; +#endif + + return FALSE; } -int numLevelDirInfo(struct LevelDirInfo *node) +boolean FileIsArtworkType(char *basename, int type) { - int num = 0; + if ((type == TREE_TYPE_GRAPHICS_DIR && FileIsGraphic(basename)) || + (type == TREE_TYPE_SOUNDS_DIR && FileIsSound(basename)) || + (type == TREE_TYPE_MUSIC_DIR && FileIsMusic(basename))) + return TRUE; - while (node) + return FALSE; +} + +/* ------------------------------------------------------------------------- */ +/* functions for loading artwork configuration information */ +/* ------------------------------------------------------------------------- */ + +int get_parameter_value(int type, char *value) +{ + 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) : + ARG_UNDEFINED_VALUE); +} + +static void FreeCustomArtworkList(struct ArtworkListInfo *, + struct ListNodeInfo ***, int *); + +struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list, + struct ConfigInfo *suffix_list, + 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; inext; + 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 0) + list_pos++; + + 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) + { + 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; + } + } + + 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; } -boolean validLevelSeries(struct LevelDirInfo *node) +static boolean token_suffix_match(char *token, char *suffix, int start_pos) { - return (node != NULL && !node->node_group && !node->parent_link); + 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; } -struct LevelDirInfo *getFirstValidLevelSeries(struct LevelDirInfo *node) +#define KNOWN_TOKEN_VALUE "[KNOWN_TOKEN]" + +static void read_token_parameters(struct SetupFileList *setup_file_list, + struct ConfigInfo *suffix_list, + struct FileInfo *file_list_entry) { - if (node == NULL) + /* check for config token that is the base token without any suffixes */ + char *filename = getTokenValue(setup_file_list, file_list_entry->token); + char *known_token_value = KNOWN_TOKEN_VALUE; + int i; + + if (filename != NULL) { - if (leveldir_first) /* start with first level directory entry */ - return getFirstValidLevelSeries(leveldir_first); - else - return 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 */ + setTokenValue(setup_file_list, file_list_entry->token, known_token_value); } - else if (node->node_group) /* enter level group (step down into tree) */ - return getFirstValidLevelSeries(node->node_group); - else if (node->parent_link) /* skip start entry of level group */ + else + setString(&file_list_entry->filename, file_list_entry->default_filename); + + /* check for config tokens that can be build by base token and suffixes */ + for (i=0; suffix_list[i].token != NULL; i++) { - if (node->next) /* get first real level series entry */ - return getFirstValidLevelSeries(node->next); - else /* leave empty level group and go on */ - return getFirstValidLevelSeries(node->node_parent->next); + char *token = getStringCat2(file_list_entry->token, suffix_list[i].token); + char *value = getTokenValue(setup_file_list, token); + + if (value != NULL) + { + setString(&file_list_entry->parameter[i], value); + + /* mark config file token as well known from default config */ + setTokenValue(setup_file_list, token, known_token_value); + } + + free(token); } - else /* this seems to be a regular level series */ - return node; } -struct LevelDirInfo *getLevelDirInfoFirstGroupEntry(struct LevelDirInfo *node) +static void add_dynamic_file_list_entry(struct FileInfo **list, + int *num_list_entries, + struct SetupFileList *extra_file_list, + struct ConfigInfo *suffix_list, + int num_suffix_list_entries, + char *token) { - if (node == NULL) - return NULL; + struct FileInfo *new_list_entry; + int parameter_array_size = num_suffix_list_entries * sizeof(char *); - if (node->node_parent == NULL) /* top level group */ - return leveldir_first; - else /* sub level group */ - return node->node_parent->node_group; +#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_list, suffix_list, new_list_entry); } -int numLevelDirInfoInGroup(struct LevelDirInfo *node) +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) { - return numLevelDirInfo(getLevelDirInfoFirstGroupEntry(node)); + 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; } -int posLevelDirInfo(struct LevelDirInfo *node) +void LoadArtworkConfig(struct ArtworkListInfo *artwork_info) { - struct LevelDirInfo *node_cmp = getLevelDirInfoFirstGroupEntry(node); - int pos = 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; + struct SetupFileList *extra_file_list = NULL; + struct SetupFileList *list; + char *known_token_value = KNOWN_TOKEN_VALUE; + int i, j, k, l; + +#if 0 + printf("GOT CUSTOM ARTWORK CONFIG FILE '%s'\n", filename); +#endif - while (node_cmp) + /* always start with reliable default values */ + for (i=0; inext; + file_list[i].redefined = FALSE; } - return 0; -} + /* free previous dynamic artwork file array */ + if (artwork_info->dynamic_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); + } -struct LevelDirInfo *getLevelDirInfoFromPos(struct LevelDirInfo *node, int pos) -{ - struct LevelDirInfo *node_default = node; - int pos_cmp = 0; + free(artwork_info->dynamic_file_list); + artwork_info->dynamic_file_list = NULL; - while (node) + 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) { - if (pos_cmp == pos) - return node; + free(artwork_info->property_mapping); - pos_cmp++; - node = node->next; + artwork_info->property_mapping = NULL; + artwork_info->num_property_mapping_entries = 0; } - return node_default; -} - -struct LevelDirInfo *getLevelDirInfoFromFilenameExt(struct LevelDirInfo *node, - char *filename) -{ if (filename == NULL) - return NULL; + return; - while (node) + if ((setup_file_list = loadSetupFileList(filename)) == NULL) + return; + + /* read parameters for all known config file tokens */ + for (i=0; inext) { - if (node->node_group) + if (strcmp(list->value, known_token_value) != 0) { - struct LevelDirInfo *node_group; + if (extra_file_list == NULL) + extra_file_list = newSetupFileList(list->token, list->value); + else + setTokenValue(extra_file_list, list->token, list->value); + } + } + + /* at this point, we do not need the config file list anymore -- free it */ + freeSetupFileList(setup_file_list); - node_group = getLevelDirInfoFromFilenameExt(node->node_group, filename); + /* now try to determine valid, dynamically defined config tokens */ - if (node_group) - return node_group; + for (list = extra_file_list; list != NULL; list = list->next) + { + 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 = list->token; + 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; } - else if (!node->parent_link) + +#if 0 + if (IS_PARENT_PROCESS()) { - if (strcmp(filename, node->filename) == 0) - return node; + if (parameter_suffix_found) + printf("---> skipping token '%s' (parameter token)\n", token); + else + printf("---> examining token '%s': search prefix ...\n", token); } +#endif - node = node->next; + 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); + } -struct LevelDirInfo *getLevelDirInfoFromFilename(char *filename) -{ - return getLevelDirInfoFromFilenameExt(leveldir_first, filename); + if (extra_file_list != NULL && options.verbose && IS_PARENT_PROCESS()) + { + boolean dynamic_tokens_found = FALSE; + boolean unknown_tokens_found = FALSE; + + for (list = extra_file_list; list != NULL; list = list->next) + { + if (strcmp(list->value, known_token_value) == 0) + dynamic_tokens_found = TRUE; + else + unknown_tokens_found = TRUE; + } + +#if DEBUG + if (dynamic_tokens_found) + { + Error(ERR_RETURN_LINE, "-"); + Error(ERR_RETURN, "dynamic token(s) found:"); + + for (list = extra_file_list; list != NULL; list = list->next) + if (strcmp(list->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 = extra_file_list; list != NULL; list = list->next) + if (strcmp(list->value, known_token_value) != 0) + Error(ERR_RETURN, "- unknown token: '%s'", list->token); + + Error(ERR_RETURN_LINE, "-"); + } + } + + freeSetupFileList(extra_file_list); + +#if 0 + for (i=0; i '%s'\n", file_list[i].filename); + else + printf("-> UNDEFINED [-> '%s']\n", file_list[i].default_filename); + } +#endif } -void dumpLevelDirInfo(struct LevelDirInfo *node, int depth) +static void deleteArtworkListEntry(struct ArtworkListInfo *artwork_info, + struct ListNodeInfo **listnode) { - int i; - - while (node) + if (*listnode) { - for (i=0; isource_filename; - printf("filename == '%s'\n", node->filename); +#if 0 + printf("[decrementing reference counter of artwork '%s']\n", filename); +#endif - if (node->node_group != NULL) - dumpLevelDirInfo(node->node_group, depth + 1); + if (--(*listnode)->num_references <= 0) + { +#if 0 + printf("[deleting artwork '%s']\n", filename); +#endif - node = node->next; + deleteNodeFromList(&artwork_info->content_list, filename, + artwork_info->free_artwork); + } + + *listnode = NULL; } } -void sortLevelDirInfo(struct LevelDirInfo **node_first, - int (*compare_function)(const void *, const void *)) +static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info, + struct ListNodeInfo **listnode, + char *basename) { - int num_nodes = numLevelDirInfo(*node_first); - struct LevelDirInfo **sort_array; - struct LevelDirInfo *node = *node_first; - int i = 0; + char *init_text[] = + { "", + "Loading graphics:", + "Loading sounds:", + "Loading music:" + }; - if (num_nodes == 0) - return; + 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; - /* allocate array for sorting structure pointers */ - sort_array = checked_calloc(num_nodes * sizeof(struct LevelDirInfo *)); + Error(error_mode, "cannot find artwork file '%s'", basename); + return; + } - /* writing structure pointers to sorting array */ - while (i < num_nodes && node) /* double boundary check... */ + /* check if the old and the new artwork file are the same */ + if (*listnode && strcmp((*listnode)->source_filename, filename) == 0) { - sort_array[i] = node; + /* 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. */ - i++; - node = node->next; +#if 0 + printf("[artwork '%s' already exists (same list entry)]\n", filename); +#endif + + return; } - /* sorting the structure pointers in the sorting array */ - qsort(sort_array, num_nodes, sizeof(struct LevelDirInfo *), - compare_function); + /* delete existing artwork file entry */ + deleteArtworkListEntry(artwork_info, listnode); - /* update the linkage of list elements with the sorted node array */ - for (i=0; inext = sort_array[i + 1]; - sort_array[num_nodes - 1]->next = NULL; + /* check if the new artwork file already exists in the list of artworks */ + if ((node = getNodeFromKey(artwork_info->content_list, filename)) != NULL) + { +#if 0 + printf("[artwork '%s' already exists (other list entry)]\n", filename); +#endif - /* update the linkage of the main list anchor pointer */ - *node_first = sort_array[0]; + *listnode = (struct ListNodeInfo *)node->content; + (*listnode)->num_references++; - free(sort_array); + return; + } - /* now recursively sort the level group structures */ - node = *node_first; - while (node) + DrawInitText(init_text[artwork_info->type], 120, FC_GREEN); + DrawInitText(basename, 150, FC_YELLOW); + + if ((*listnode = artwork_info->load_artwork(filename)) != NULL) { - if (node->node_group != NULL) - sortLevelDirInfo(&node->node_group, compare_function); +#if 0 + printf("[adding new artwork '%s']\n", filename); +#endif - node = node->next; + (*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; } } -inline void swap_numbers(int *i1, int *i2) +static void LoadCustomArtwork(struct ArtworkListInfo *artwork_info, + struct ListNodeInfo **listnode, + char *basename) { - int help = *i1; +#if 0 + printf("GOT CUSTOM ARTWORK FILE '%s'\n", filename); +#endif - *i1 = *i2; - *i2 = help; + if (strcmp(basename, UNDEFINED_FILENAME) == 0) + { + deleteArtworkListEntry(artwork_info, listnode); + return; + } + + replaceArtworkListEntry(artwork_info, listnode, basename); } -inline void swap_number_pairs(int *x1, int *y1, int *x2, int *y2) +static void LoadArtworkToList(struct ArtworkListInfo *artwork_info, + struct ListNodeInfo **listnode, + char *basename, int list_pos) { - int help_x = *x1; - int help_y = *y1; +#if 0 + if (artwork_info->artwork_list == NULL || + list_pos >= artwork_info->num_file_list_entries) + return; +#endif - *x1 = *x2; - *x2 = help_x; +#if 0 + printf("loading artwork '%s' ... [%d]\n", + basename, getNumNodes(artwork_info->content_list)); +#endif - *y1 = *y2; - *y2 = help_y; +#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", + basename, getNumNodes(artwork_info->content_list)); +#endif } +void ReloadCustomArtworkList(struct ArtworkListInfo *artwork_info) +{ + 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 + printf("DEBUG: reloading %d static artwork files ...\n", + num_file_list_entries); +#endif + + for(i=0; iartwork_list[i], + file_list[i].filename, i); + +#if 0 + printf("DEBUG: reloading %d dynamic artwork files ...\n", + num_dynamic_file_list_entries); +#endif + + for(i=0; idynamic_artwork_list[i], + dynamic_file_list[i].filename, i); + +#if 0 + dumpList(artwork_info->content_list); +#endif +} + +static void FreeCustomArtworkList(struct ArtworkListInfo *artwork_info, + struct ListNodeInfo ***list, + int *num_list_entries) +{ + int i; + + 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() ? "CHILD" : "PARENT"); +#endif + + 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() ? "CHILD" : "PARENT"); +#endif +} + + +/* ------------------------------------------------------------------------- */ +/* 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) + +#define ERROR_FILENAME "stderr.txt" + +void initErrorFile() +{ + unlink(ERROR_FILENAME); +} + +FILE *openErrorFile() +{ + return fopen(ERROR_FILENAME, MODE_APPEND); +} + +void dumpErrorFile() +{ + FILE *error_file = fopen(ERROR_FILENAME, MODE_READ); + + if (error_file != NULL) + { + while (!feof(error_file)) + fputc(fgetc(error_file), stderr); + + fclose(error_file); + } +} +#endif + /* ------------------------------------------------------------------------- */ /* the following is only for debugging purpose and normally not used */ @@ -1388,3 +2383,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"); + } +}