X-Git-Url: https://git.artsoft.org/?a=blobdiff_plain;f=src%2Flibgame%2Fsetup.c;h=102d5fd13d92d0bd7fa1fa0ca494d7ecbe34994b;hb=f857fec3082c785b0dd271b6ad1b7642a2ed4e65;hp=0996d10dfea85596e4fdc50b8fb39e380af069e8;hpb=e1fdeb57afb3db322b3757d8105c66ba33cadca4;p=rocksndiamonds.git diff --git a/src/libgame/setup.c b/src/libgame/setup.c index 0996d10d..102d5fd1 100644 --- a/src/libgame/setup.c +++ b/src/libgame/setup.c @@ -21,6 +21,7 @@ #include "joystick.h" #include "text.h" #include "misc.h" +#include "hash.h" /* file names and filename extensions */ #if !defined(PLATFORM_MSDOS) @@ -1020,7 +1021,7 @@ boolean checkCookieString(const char *cookie, const char *template) } /* ------------------------------------------------------------------------- */ -/* setup file list handling functions */ +/* setup file list and hash handling functions */ /* ------------------------------------------------------------------------- */ char *getFormattedSetupEntry(char *token, char *value) @@ -1039,23 +1040,9 @@ char *getFormattedSetupEntry(char *token, char *value) return entry; } -void freeSetupFileList(struct SetupFileList *setup_file_list) +SetupFileList *newSetupFileList(char *token, char *value) { - if (setup_file_list == NULL) - return; - - if (setup_file_list->token) - free(setup_file_list->token); - if (setup_file_list->value) - free(setup_file_list->value); - if (setup_file_list->next) - freeSetupFileList(setup_file_list->next); - free(setup_file_list); -} - -struct SetupFileList *newSetupFileList(char *token, char *value) -{ - struct SetupFileList *new = checked_malloc(sizeof(struct SetupFileList)); + SetupFileList *new = checked_malloc(sizeof(SetupFileList)); new->token = getStringCopy(token); new->value = getStringCopy(value); @@ -1065,58 +1052,175 @@ struct SetupFileList *newSetupFileList(char *token, char *value) return new; } -char *getTokenValue(struct SetupFileList *setup_file_list, char *token) +void freeSetupFileList(SetupFileList *list) { - if (setup_file_list == NULL) + if (list == NULL) + return; + + if (list->token) + free(list->token); + if (list->value) + free(list->value); + if (list->next) + freeSetupFileList(list->next); + free(list); +} + +char *getListEntry(SetupFileList *list, char *token) +{ + if (list == NULL) return NULL; - if (strcmp(setup_file_list->token, token) == 0) - return setup_file_list->value; + if (strcmp(list->token, token) == 0) + return list->value; else - return getTokenValue(setup_file_list->next, token); + return getListEntry(list->next, token); } -void setTokenValue(struct SetupFileList *setup_file_list, - char *token, char *value) +void setListEntry(SetupFileList *list, char *token, char *value) { - if (setup_file_list == NULL) + if (list == NULL) return; - if (strcmp(setup_file_list->token, token) == 0) + if (strcmp(list->token, token) == 0) { - if (setup_file_list->value) - free(setup_file_list->value); + if (list->value) + free(list->value); - setup_file_list->value = getStringCopy(value); + list->value = getStringCopy(value); } - else if (setup_file_list->next == NULL) - setup_file_list->next = newSetupFileList(token, value); + else if (list->next == NULL) + list->next = newSetupFileList(token, value); else - setTokenValue(setup_file_list->next, token, value); + setListEntry(list->next, token, value); } #ifdef DEBUG -static void printSetupFileList(struct SetupFileList *setup_file_list) +static void printSetupFileList(SetupFileList *list) { - if (!setup_file_list) + if (!list) return; - printf("token: '%s'\n", setup_file_list->token); - printf("value: '%s'\n", setup_file_list->value); + printf("token: '%s'\n", list->token); + printf("value: '%s'\n", list->value); - printSetupFileList(setup_file_list->next); + printSetupFileList(list->next); } #endif -struct SetupFileList *loadSetupFileList(char *filename) +#ifdef DEBUG +DEFINE_HASHTABLE_INSERT(insert_hash_entry, char, char); +DEFINE_HASHTABLE_SEARCH(search_hash_entry, char, char); +DEFINE_HASHTABLE_CHANGE(change_hash_entry, char, char); +DEFINE_HASHTABLE_REMOVE(remove_hash_entry, char, char); +#else +#define insert_hash_entry hashtable_insert +#define search_hash_entry hashtable_search +#define change_hash_entry hashtable_change +#define remove_hash_entry hashtable_remove +#endif + +static unsigned int get_hash_from_key(void *key) +{ + /* + djb2 + + This algorithm (k=33) was first reported by Dan Bernstein many years ago in + 'comp.lang.c'. Another version of this algorithm (now favored by Bernstein) + uses XOR: hash(i) = hash(i - 1) * 33 ^ str[i]; the magic of number 33 (why + it works better than many other constants, prime or not) has never been + adequately explained. + + If you just want to have a good hash function, and cannot wait, djb2 + is one of the best string hash functions i know. It has excellent + distribution and speed on many different sets of keys and table sizes. + You are not likely to do better with one of the "well known" functions + such as PJW, K&R, etc. + + Ozan (oz) Yigit [http://www.cs.yorku.ca/~oz/hash.html] + */ + + char *str = (char *)key; + unsigned int hash = 5381; + int c; + + while ((c = *str++)) + hash = ((hash << 5) + hash) + c; /* hash * 33 + c */ + + return hash; +} + +static int keys_are_equal(void *key1, void *key2) +{ + return (strcmp((char *)key1, (char *)key2) == 0); +} + +SetupFileHash *newSetupFileHash() +{ + SetupFileHash *new_hash = + create_hashtable(16, 0.75, get_hash_from_key, keys_are_equal); + + return new_hash; +} + +void freeSetupFileHash(SetupFileHash *hash) +{ + if (hash == NULL) + return; + + hashtable_destroy(hash, 1); /* 1 == also free values stored in hash */ +} + +char *getHashEntry(SetupFileHash *hash, char *token) +{ + if (hash == NULL) + return NULL; + + return search_hash_entry(hash, token); +} + +void setHashEntry(SetupFileHash *hash, char *token, char *value) +{ + char *value_copy; + + if (hash == NULL) + return; + + value_copy = getStringCopy(value); + + /* change value; if it does not exist, insert it as new */ + if (!change_hash_entry(hash, token, value_copy)) + if (!insert_hash_entry(hash, getStringCopy(token), value_copy)) + Error(ERR_EXIT, "cannot insert into hash -- aborting"); +} + +#if 0 +#ifdef DEBUG +static void printSetupFileHash(SetupFileHash *hash) +{ + BEGIN_HASH_ITERATION(hash, itr) + { + printf("token: '%s'\n", HASH_ITERATION_TOKEN(itr)); + printf("value: '%s'\n", HASH_ITERATION_VALUE(itr)); + } + END_HASH_ITERATION(hash, itr) +} +#endif +#endif + +static void *loadSetupFileData(char *filename, boolean use_hash) { int line_len; char line[MAX_LINE_LEN]; char *token, *value, *line_ptr; - struct SetupFileList *setup_file_list = newSetupFileList("", ""); - struct SetupFileList *first_valid_list_entry; + void *setup_file_data; FILE *file; + if (use_hash) + setup_file_data = newSetupFileHash(); + else + setup_file_data = newSetupFileList("", ""); + if (!(file = fopen(filename, MODE_READ))) { Error(ERR_WARN, "cannot open configuration file '%s'", filename); @@ -1176,47 +1280,57 @@ struct SetupFileList *loadSetupFileList(char *filename) break; if (*token && *value) - setTokenValue(setup_file_list, token, value); + { + if (use_hash) + setHashEntry((SetupFileHash *)setup_file_data, token, value); + else + setListEntry((SetupFileList *)setup_file_data, token, value); + } } fclose(file); - first_valid_list_entry = setup_file_list->next; + if (use_hash) + { + if (hashtable_count((SetupFileHash *)setup_file_data) == 0) + Error(ERR_WARN, "configuration file '%s' is empty", filename); + } + else + { + SetupFileList *setup_file_list = (SetupFileList *)setup_file_data; + SetupFileList *first_valid_list_entry = setup_file_list->next; - /* free empty list header */ - setup_file_list->next = NULL; - freeSetupFileList(setup_file_list); + /* free empty list header */ + setup_file_list->next = NULL; + freeSetupFileList(setup_file_list); + setup_file_data = first_valid_list_entry; - if (first_valid_list_entry == NULL) - Error(ERR_WARN, "configuration file '%s' is empty", filename); + if (first_valid_list_entry == NULL) + Error(ERR_WARN, "configuration file '%s' is empty", filename); + } - return first_valid_list_entry; + return setup_file_data; } -void checkSetupFileListIdentifier(struct SetupFileList *setup_file_list, - char *identifier) +SetupFileList *loadSetupFileList(char *filename) { - if (!setup_file_list) - return; + return (SetupFileList *)loadSetupFileData(filename, FALSE); +} - if (strcmp(setup_file_list->token, TOKEN_STR_FILE_IDENTIFIER) == 0) - { - if (!checkCookieString(setup_file_list->value, identifier)) - { - Error(ERR_WARN, "configuration file has wrong file identifier"); - return; - } - else - return; - } +SetupFileHash *loadSetupFileHash(char *filename) +{ + return (SetupFileHash *)loadSetupFileData(filename, TRUE); +} - if (setup_file_list->next) - checkSetupFileListIdentifier(setup_file_list->next, identifier); - else - { +void checkSetupFileHashIdentifier(SetupFileHash *setup_file_hash, + char *identifier) +{ + char *value = getHashEntry(setup_file_hash, TOKEN_STR_FILE_IDENTIFIER); + + if (value == NULL) Error(ERR_WARN, "configuration file has no file identifier"); - return; - } + else if (!checkCookieString(value, identifier)) + Error(ERR_WARN, "configuration file has wrong file identifier"); } @@ -1466,11 +1580,11 @@ static boolean LoadLevelInfoFromLevelConf(TreeInfo **node_first, { char *directory_path = getPath2(level_directory, directory_name); char *filename = getPath2(directory_path, LEVELINFO_FILENAME); - struct SetupFileList *setup_file_list = loadSetupFileList(filename); + SetupFileHash *setup_file_hash = loadSetupFileHash(filename); LevelDirTree *leveldir_new = NULL; int i; - if (setup_file_list == NULL) + if (setup_file_hash == NULL) { Error(ERR_WARN, "ignoring level directory '%s'", directory_path); @@ -1489,13 +1603,13 @@ static boolean LoadLevelInfoFromLevelConf(TreeInfo **node_first, leveldir_new->filename = getStringCopy(directory_name); - checkSetupFileListIdentifier(setup_file_list, getCookie("LEVELINFO")); + checkSetupFileHashIdentifier(setup_file_hash, getCookie("LEVELINFO")); /* set all structure fields according to the token/value pairs */ ldi = *leveldir_new; for (i=0; iname, ANONYMOUS_NAME) == 0) @@ -1542,7 +1656,7 @@ static boolean LoadLevelInfoFromLevelConf(TreeInfo **node_first, pushTreeInfo(node_first, leveldir_new); - freeSetupFileList(setup_file_list); + freeSetupFileHash(setup_file_hash); if (leveldir_new->level_group) { @@ -1651,14 +1765,14 @@ static boolean LoadArtworkInfoFromArtworkConf(TreeInfo **node_first, { char *directory_path = getPath2(base_directory, directory_name); char *filename = getPath2(directory_path, ARTWORKINFO_FILENAME(type)); - struct SetupFileList *setup_file_list = NULL; + SetupFileHash *setup_file_hash = NULL; TreeInfo *artwork_new = NULL; int i; if (access(filename, F_OK) == 0) /* file exists */ - setup_file_list = loadSetupFileList(filename); + setup_file_hash = loadSetupFileHash(filename); - if (setup_file_list == NULL) /* no config file -- look for artwork files */ + if (setup_file_hash == NULL) /* no config file -- look for artwork files */ { DIR *dir; struct dirent *dir_entry; @@ -1701,17 +1815,17 @@ static boolean LoadArtworkInfoFromArtworkConf(TreeInfo **node_first, artwork_new->filename = getStringCopy(directory_name); - if (setup_file_list) /* (before defining ".color" and ".class_desc") */ + if (setup_file_hash) /* (before defining ".color" and ".class_desc") */ { #if 0 - checkSetupFileListIdentifier(setup_file_list, getCookie("...")); + checkSetupFileHashIdentifier(setup_file_hash, getCookie("...")); #endif /* set all structure fields according to the token/value pairs */ ldi = *artwork_new; for (i=0; iname, ANONYMOUS_NAME) == 0) @@ -1745,11 +1859,11 @@ static boolean LoadArtworkInfoFromArtworkConf(TreeInfo **node_first, artwork_new->user_defined = (artwork_new->basepath == OPTIONS_ARTWORK_DIRECTORY(type) ? FALSE : TRUE); - /* (may use ".sort_priority" from "setup_file_list" above) */ + /* (may use ".sort_priority" from "setup_file_hash" above) */ artwork_new->color = ARTWORKCOLOR(artwork_new); artwork_new->class_desc = getLevelClassDescription(artwork_new); - if (setup_file_list == NULL) /* (after determining ".user_defined") */ + if (setup_file_hash == NULL) /* (after determining ".user_defined") */ { if (artwork_new->name != NULL) free(artwork_new->name); @@ -1784,7 +1898,7 @@ static boolean LoadArtworkInfoFromArtworkConf(TreeInfo **node_first, pushTreeInfo(node_first, artwork_new); - freeSetupFileList(setup_file_list); + freeSetupFileHash(setup_file_hash); free(directory_path); free(filename); @@ -2158,7 +2272,7 @@ char *getSetupLine(struct TokenInfo *token_info, char *prefix, int token_nr) void LoadLevelSetup_LastSeries() { char *filename; - struct SetupFileList *level_setup_list = NULL; + SetupFileHash *level_setup_hash = NULL; /* always start with reliable default values */ leveldir_current = getFirstValidTreeInfoEntry(leveldir_first); @@ -2169,19 +2283,19 @@ void LoadLevelSetup_LastSeries() filename = getPath2(getSetupDir(), LEVELSETUP_FILENAME); - if ((level_setup_list = loadSetupFileList(filename))) + if ((level_setup_hash = loadSetupFileHash(filename))) { char *last_level_series = - getTokenValue(level_setup_list, TOKEN_STR_LAST_LEVEL_SERIES); + getHashEntry(level_setup_hash, TOKEN_STR_LAST_LEVEL_SERIES); leveldir_current = getTreeInfoFromIdentifier(leveldir_first, last_level_series); if (leveldir_current == NULL) leveldir_current = getFirstValidTreeInfoEntry(leveldir_first); - checkSetupFileListIdentifier(level_setup_list, getCookie("LEVELSETUP")); + checkSetupFileHashIdentifier(level_setup_hash, getCookie("LEVELSETUP")); - freeSetupFileList(level_setup_list); + freeSetupFileHash(level_setup_hash); } else Error(ERR_WARN, "using default setup values"); @@ -2254,6 +2368,7 @@ static void checkSeriesInfo() levelnum_value = atoi(levelnum_str); +#if 0 if (levelnum_value < leveldir_current->first_level) { Error(ERR_WARN, "additional level %d found", levelnum_value); @@ -2264,6 +2379,7 @@ static void checkSeriesInfo() Error(ERR_WARN, "additional level %d found", levelnum_value); leveldir_current->last_level = levelnum_value; } +#endif } } @@ -2273,7 +2389,7 @@ static void checkSeriesInfo() void LoadLevelSetup_SeriesInfo() { char *filename; - struct SetupFileList *level_setup_list = NULL; + SetupFileHash *level_setup_hash = NULL; char *level_subdir = leveldir_current->filename; /* always start with reliable default values */ @@ -2289,11 +2405,11 @@ void LoadLevelSetup_SeriesInfo() filename = getPath2(getLevelSetupDir(level_subdir), LEVELSETUP_FILENAME); - if ((level_setup_list = loadSetupFileList(filename))) + if ((level_setup_hash = loadSetupFileHash(filename))) { char *token_value; - token_value = getTokenValue(level_setup_list, TOKEN_STR_LAST_PLAYED_LEVEL); + token_value = getHashEntry(level_setup_hash, TOKEN_STR_LAST_PLAYED_LEVEL); if (token_value) { @@ -2305,7 +2421,7 @@ void LoadLevelSetup_SeriesInfo() level_nr = leveldir_current->last_level; } - token_value = getTokenValue(level_setup_list, TOKEN_STR_HANDICAP_LEVEL); + token_value = getHashEntry(level_setup_hash, TOKEN_STR_HANDICAP_LEVEL); if (token_value) { @@ -2322,9 +2438,9 @@ void LoadLevelSetup_SeriesInfo() leveldir_current->handicap_level = level_nr; } - checkSetupFileListIdentifier(level_setup_list, getCookie("LEVELSETUP")); + checkSetupFileHashIdentifier(level_setup_hash, getCookie("LEVELSETUP")); - freeSetupFileList(level_setup_list); + freeSetupFileHash(level_setup_hash); } else Error(ERR_WARN, "using default setup values");