X-Git-Url: https://git.artsoft.org/?a=blobdiff_plain;f=src%2Flibgame%2Fsetup.c;h=102d5fd13d92d0bd7fa1fa0ca494d7ecbe34994b;hb=f857fec3082c785b0dd271b6ad1b7642a2ed4e65;hp=def8fa9e715bad821e011abc843893996707b3d1;hpb=fe158e864d3fa4b0221e9c88d8dfff0157051396;p=rocksndiamonds.git diff --git a/src/libgame/setup.c b/src/libgame/setup.c index def8fa9e..102d5fd1 100644 --- a/src/libgame/setup.c +++ b/src/libgame/setup.c @@ -11,8 +11,9 @@ * setup.c * ***********************************************************/ -#include +#include #include +#include #include #include @@ -20,6 +21,7 @@ #include "joystick.h" #include "text.h" #include "misc.h" +#include "hash.h" /* file names and filename extensions */ #if !defined(PLATFORM_MSDOS) @@ -27,6 +29,9 @@ #define SETUP_FILENAME "setup.conf" #define LEVELSETUP_FILENAME "levelsetup.conf" #define LEVELINFO_FILENAME "levelinfo.conf" +#define GRAPHICSINFO_FILENAME "graphicsinfo.conf" +#define SOUNDSINFO_FILENAME "soundsinfo.conf" +#define MUSICINFO_FILENAME "musicinfo.conf" #define LEVELFILE_EXTENSION "level" #define TAPEFILE_EXTENSION "tape" #define SCOREFILE_EXTENSION "score" @@ -35,6 +40,9 @@ #define SETUP_FILENAME "setup.cnf" #define LEVELSETUP_FILENAME "lvlsetup.cnf" #define LEVELINFO_FILENAME "lvlinfo.cnf" +#define GRAPHICSINFO_FILENAME "gfxinfo.cnf" +#define SOUNDSINFO_FILENAME "sndinfo.cnf" +#define MUSICINFO_FILENAME "musinfo.cnf" #define LEVELFILE_EXTENSION "lvl" #define TAPEFILE_EXTENSION "tap" #define SCOREFILE_EXTENSION "sco" @@ -73,16 +81,50 @@ static char *levelclass_desc[NUM_LEVELCLASS_DESC] = IS_LEVELCLASS_USER(n) ? 7 : \ 9) -#define TOKEN_VALUE_POSITION 30 +#define ARTWORKCOLOR(n) (IS_ARTWORKCLASS_CLASSICS(n) ? FC_RED : \ + IS_ARTWORKCLASS_CONTRIBUTION(n) ? FC_YELLOW : \ + IS_ARTWORKCLASS_LEVEL(n) ? FC_GREEN : \ + IS_ARTWORKCLASS_USER(n) ? FC_RED : \ + FC_BLUE) + +#define ARTWORKSORTING(n) (IS_ARTWORKCLASS_CLASSICS(n) ? 0 : \ + IS_ARTWORKCLASS_CONTRIBUTION(n) ? 1 : \ + IS_ARTWORKCLASS_LEVEL(n) ? 2 : \ + IS_ARTWORKCLASS_USER(n) ? 3 : \ + 9) + +#define TOKEN_VALUE_POSITION 40 +#define TOKEN_COMMENT_POSITION 60 #define MAX_COOKIE_LEN 256 +#define ARTWORKINFO_FILENAME(type) ((type) == TREE_TYPE_GRAPHICS_DIR ? \ + GRAPHICSINFO_FILENAME : \ + (type) == TREE_TYPE_SOUNDS_DIR ? \ + SOUNDSINFO_FILENAME : \ + (type) == TREE_TYPE_MUSIC_DIR ? \ + MUSICINFO_FILENAME : "") + +#define ARTWORK_DIRECTORY(type) ((type) == TREE_TYPE_GRAPHICS_DIR ? \ + GRAPHICS_DIRECTORY : \ + (type) == TREE_TYPE_SOUNDS_DIR ? \ + SOUNDS_DIRECTORY : \ + (type) == TREE_TYPE_MUSIC_DIR ? \ + MUSIC_DIRECTORY : "") + +#define OPTIONS_ARTWORK_DIRECTORY(type) ((type) == TREE_TYPE_GRAPHICS_DIR ? \ + options.graphics_directory : \ + (type) == TREE_TYPE_SOUNDS_DIR ? \ + options.sounds_directory : \ + (type) == TREE_TYPE_MUSIC_DIR ? \ + options.music_directory : "") + /* ------------------------------------------------------------------------- */ /* file functions */ /* ------------------------------------------------------------------------- */ -char *getLevelClassDescription(struct LevelDirInfo *ldi) +static char *getLevelClassDescription(TreeInfo *ldi) { int position = ldi->sort_priority / 100; @@ -101,7 +143,7 @@ static char *getUserLevelDir(char *level_subdir) if (userlevel_dir) free(userlevel_dir); - if (strlen(level_subdir) > 0) + if (level_subdir != NULL) userlevel_dir = getPath3(data_dir, userlevel_subdir, level_subdir); else userlevel_dir = getPath2(data_dir, userlevel_subdir); @@ -118,7 +160,7 @@ static char *getTapeDir(char *level_subdir) if (tape_dir) free(tape_dir); - if (strlen(level_subdir) > 0) + if (level_subdir != NULL) tape_dir = getPath3(data_dir, tape_subdir, level_subdir); else tape_dir = getPath2(data_dir, tape_subdir); @@ -129,13 +171,13 @@ static char *getTapeDir(char *level_subdir) static char *getScoreDir(char *level_subdir) { static char *score_dir = NULL; - char *data_dir = options.rw_base_directory; + char *data_dir = getCommonDataDir(); char *score_subdir = SCORES_DIRECTORY; if (score_dir) free(score_dir); - if (strlen(level_subdir) > 0) + if (level_subdir != NULL) score_dir = getPath3(data_dir, score_subdir, level_subdir); else score_dir = getPath2(data_dir, score_subdir); @@ -152,7 +194,7 @@ static char *getLevelSetupDir(char *level_subdir) if (levelsetup_dir) free(levelsetup_dir); - if (strlen(level_subdir) > 0) + if (level_subdir != NULL) levelsetup_dir = getPath3(data_dir, levelsetup_subdir, level_subdir); else levelsetup_dir = getPath2(data_dir, levelsetup_subdir); @@ -160,6 +202,157 @@ static char *getLevelSetupDir(char *level_subdir) return levelsetup_dir; } +static char *getLevelDirFromTreeInfo(TreeInfo *node) +{ + static char *level_dir = NULL; + + if (node == NULL) + return options.level_directory; + + if (level_dir) + free(level_dir); + + level_dir = getPath2((node->user_defined ? getUserLevelDir(NULL) : + options.level_directory), node->fullpath); + + return level_dir; +} + +static char *getCurrentLevelDir() +{ + return getLevelDirFromTreeInfo(leveldir_current); +} + +static char *getDefaultGraphicsDir(char *graphics_subdir) +{ + static char *graphics_dir = NULL; + + if (graphics_subdir == NULL) + return options.graphics_directory; + + if (graphics_dir) + free(graphics_dir); + + graphics_dir = getPath2(options.graphics_directory, graphics_subdir); + + return graphics_dir; +} + +static char *getDefaultSoundsDir(char *sounds_subdir) +{ + static char *sounds_dir = NULL; + + if (sounds_subdir == NULL) + return options.sounds_directory; + + if (sounds_dir) + free(sounds_dir); + + sounds_dir = getPath2(options.sounds_directory, sounds_subdir); + + return sounds_dir; +} + +static char *getDefaultMusicDir(char *music_subdir) +{ + static char *music_dir = NULL; + + if (music_subdir == NULL) + return options.music_directory; + + if (music_dir) + free(music_dir); + + music_dir = getPath2(options.music_directory, music_subdir); + + return music_dir; +} + +static char *getUserGraphicsDir() +{ + static char *usergraphics_dir = NULL; + + if (usergraphics_dir == NULL) + usergraphics_dir = getPath2(getUserDataDir(), GRAPHICS_DIRECTORY); + + return usergraphics_dir; +} + +static char *getUserSoundsDir() +{ + static char *usersounds_dir = NULL; + + if (usersounds_dir == NULL) + usersounds_dir = getPath2(getUserDataDir(), SOUNDS_DIRECTORY); + + return usersounds_dir; +} + +static char *getUserMusicDir() +{ + static char *usermusic_dir = NULL; + + if (usermusic_dir == NULL) + usermusic_dir = getPath2(getUserDataDir(), MUSIC_DIRECTORY); + + return usermusic_dir; +} + +static char *getSetupArtworkDir(TreeInfo *ti) +{ + static char *artwork_dir = NULL; + + if (artwork_dir != NULL) + free(artwork_dir); + + artwork_dir = getPath2(ti->basepath, ti->fullpath); + + return artwork_dir; +} + +void setLevelArtworkDir(TreeInfo *ti) +{ + char **artwork_path_ptr, *artwork_set; + TreeInfo *level_artwork; + + if (ti == NULL || leveldir_current == NULL) + return; + + artwork_path_ptr = + (ti->type == TREE_TYPE_GRAPHICS_DIR ? &leveldir_current->graphics_path : + ti->type == TREE_TYPE_SOUNDS_DIR ? &leveldir_current->sounds_path : + &leveldir_current->music_path); + + artwork_set = + (ti->type == TREE_TYPE_GRAPHICS_DIR ? leveldir_current->graphics_set : + ti->type == TREE_TYPE_SOUNDS_DIR ? leveldir_current->sounds_set : + leveldir_current->music_set); + + if ((level_artwork = getTreeInfoFromIdentifier(ti, artwork_set)) == NULL) + return; + + if (*artwork_path_ptr != NULL) + free(*artwork_path_ptr); + + *artwork_path_ptr = getStringCopy(getSetupArtworkDir(level_artwork)); +} + +static char *getLevelArtworkDir(int type) +{ + char *artwork_path; + + if (leveldir_current == NULL) + return UNDEFINED_FILENAME; + + artwork_path = + (type == TREE_TYPE_GRAPHICS_DIR ? leveldir_current->graphics_path : + type == TREE_TYPE_SOUNDS_DIR ? leveldir_current->sounds_path : + type == TREE_TYPE_MUSIC_DIR ? leveldir_current->music_path : + UNDEFINED_FILENAME); + + return artwork_path; +} + char *getLevelFilename(int nr) { static char *filename = NULL; @@ -169,11 +362,7 @@ char *getLevelFilename(int nr) free(filename); sprintf(basename, "%03d.%s", nr, LEVELFILE_EXTENSION); - filename = getPath3((leveldir_current->user_defined ? - getUserLevelDir("") : - options.level_directory), - leveldir_current->fullpath, - basename); + filename = getPath2(getCurrentLevelDir(), basename); return filename; } @@ -218,9 +407,9 @@ char *getSetupFilename() return filename; } -static char *getImageBasename(char *basename) +static char *getCorrectedImageBasename(char *basename) { - char *result = basename; + char *basename_corrected = basename; #if defined(PLATFORM_MSDOS) if (program.filename_prefix != NULL) @@ -228,53 +417,193 @@ static char *getImageBasename(char *basename) int prefix_len = strlen(program.filename_prefix); if (strncmp(basename, program.filename_prefix, prefix_len) == 0) - result = &basename[prefix_len]; + basename_corrected = &basename[prefix_len]; + + /* if corrected filename is still longer than standard MS-DOS filename + size (8 characters + 1 dot + 3 characters file extension), shorten + filename by writing file extension after 8th basename character */ + if (strlen(basename_corrected) > 8+1+3) + { + static char *msdos_filename = NULL; + + if (msdos_filename != NULL) + free(msdos_filename); + + msdos_filename = getStringCopy(basename_corrected); + strncpy(&msdos_filename[8], &basename[strlen(basename) - 1+3], 1+3 + 1); + } } #endif - return result; + return basename_corrected; } -char *getImageFilename(char *basename) +char *getCustomImageFilename(char *basename) { static char *filename = NULL; if (filename != NULL) free(filename); - filename = getPath2(options.graphics_directory, getImageBasename(basename)); + basename = getCorrectedImageBasename(basename); - return filename; + if (!setup.override_level_graphics) + { + /* 1st try: look for special artwork configured in level series config */ + filename = getPath2(getLevelArtworkDir(TREE_TYPE_GRAPHICS_DIR), basename); + if (fileExists(filename)) + return filename; + + free(filename); + + /* 2nd try: look for special artwork in current level series directory */ + filename = getPath3(getCurrentLevelDir(), GRAPHICS_DIRECTORY, basename); + if (fileExists(filename)) + return filename; + + free(filename); + } + + /* 3rd try: look for special artwork in configured artwork directory */ + filename = getPath2(getSetupArtworkDir(artwork.gfx_current), basename); + if (fileExists(filename)) + return filename; + + free(filename); + + /* 4th try: look for default artwork in new default artwork directory */ + filename = getPath2(getDefaultGraphicsDir(GRAPHICS_SUBDIR), basename); + if (fileExists(filename)) + return filename; + + free(filename); + + /* 5th try: look for default artwork in old default artwork directory */ + filename = getPath2(options.graphics_directory, basename); + if (fileExists(filename)) + return filename; + + return NULL; /* cannot find specified artwork file anywhere */ } -char *getCustomImageFilename(char *basename) +char *getCustomSoundFilename(char *basename) { -#if 0 - if (strcmp(basename, "RocksFont.pcx") == 0) + static char *filename = NULL; + + if (filename != NULL) + free(filename); + + if (!setup.override_level_sounds) { - char *dir = options.graphics_directory; + /* 1st try: look for special artwork configured in level series config */ + filename = getPath2(getLevelArtworkDir(TREE_TYPE_SOUNDS_DIR), basename); + if (fileExists(filename)) + return filename; - printf("checking directory '%s' ...\n", dir); + free(filename); + + /* 2nd try: look for special artwork in current level series directory */ + filename = getPath3(getCurrentLevelDir(), SOUNDS_DIRECTORY, basename); + if (fileExists(filename)) + return filename; - /* - dir = getPath2(options.graphics_directory); - */ + free(filename); } -#endif - return getImageFilename(basename); + /* 3rd try: look for special artwork in configured artwork directory */ + filename = getPath2(getSetupArtworkDir(artwork.snd_current), basename); + if (fileExists(filename)) + return filename; + + free(filename); + + /* 4th try: look for default artwork in new default artwork directory */ + filename = getPath2(getDefaultSoundsDir(SOUNDS_SUBDIR), basename); + if (fileExists(filename)) + return filename; + + free(filename); + + /* 5th try: look for default artwork in old default artwork directory */ + filename = getPath2(options.sounds_directory, basename); + if (fileExists(filename)) + return filename; + + return NULL; /* cannot find specified artwork file anywhere */ +} + +char *getCustomArtworkFilename(char *basename, int type) +{ + if (type == ARTWORK_TYPE_GRAPHICS) + return getCustomImageFilename(basename); + else if (type == ARTWORK_TYPE_SOUNDS) + return getCustomSoundFilename(basename); + else + return UNDEFINED_FILENAME; +} + +char *getCustomArtworkConfigFilename(int type) +{ + return getCustomArtworkFilename(ARTWORKINFO_FILENAME(type), type); +} + +char *getCustomMusicDirectory(void) +{ + static char *directory = NULL; + + if (directory != NULL) + free(directory); + + if (!setup.override_level_music) + { + /* 1st try: look for special artwork configured in level series config */ + directory = getStringCopy(getLevelArtworkDir(TREE_TYPE_MUSIC_DIR)); + if (fileExists(directory)) + return directory; + + free(directory); + + /* 2nd try: look for special artwork in current level series directory */ + directory = getPath2(getCurrentLevelDir(), MUSIC_DIRECTORY); + if (fileExists(directory)) + return directory; + + free(directory); + } + + /* 3rd try: look for special artwork in configured artwork directory */ + directory = getStringCopy(getSetupArtworkDir(artwork.mus_current)); + if (fileExists(directory)) + return directory; + + free(directory); + + /* 4th try: look for default artwork in new default artwork directory */ + directory = getStringCopy(getDefaultMusicDir(MUSIC_SUBDIR)); + if (fileExists(directory)) + return directory; + + free(directory); + + /* 5th try: look for default artwork in old default artwork directory */ + directory = getStringCopy(options.music_directory); + if (fileExists(directory)) + return directory; + + return NULL; /* cannot find specified artwork file anywhere */ } void InitTapeDirectory(char *level_subdir) { createDirectory(getUserDataDir(), "user data", PERMS_PRIVATE); - createDirectory(getTapeDir(""), "main tape", PERMS_PRIVATE); + createDirectory(getTapeDir(NULL), "main tape", PERMS_PRIVATE); createDirectory(getTapeDir(level_subdir), "level tape", PERMS_PRIVATE); } void InitScoreDirectory(char *level_subdir) { - createDirectory(getScoreDir(""), "main score", PERMS_PUBLIC); + createDirectory(getCommonDataDir(), "common data", PERMS_PUBLIC); + createDirectory(getScoreDir(NULL), "main score", PERMS_PUBLIC); createDirectory(getScoreDir(level_subdir), "level score", PERMS_PUBLIC); } @@ -285,7 +614,7 @@ void InitUserLevelDirectory(char *level_subdir) if (access(getUserLevelDir(level_subdir), F_OK) != 0) { createDirectory(getUserDataDir(), "user data", PERMS_PRIVATE); - createDirectory(getUserLevelDir(""), "main user level", PERMS_PRIVATE); + createDirectory(getUserLevelDir(NULL), "main user level", PERMS_PRIVATE); createDirectory(getUserLevelDir(level_subdir), "user level",PERMS_PRIVATE); SaveUserLevelInfo(); @@ -295,72 +624,27 @@ void InitUserLevelDirectory(char *level_subdir) void InitLevelSetupDirectory(char *level_subdir) { createDirectory(getUserDataDir(), "user data", PERMS_PRIVATE); - createDirectory(getLevelSetupDir(""), "main level setup", PERMS_PRIVATE); + createDirectory(getLevelSetupDir(NULL), "main level setup", PERMS_PRIVATE); createDirectory(getLevelSetupDir(level_subdir), "level setup",PERMS_PRIVATE); } -void ReadChunk_VERS(FILE *file, int *file_version, int *game_version) -{ - int file_version_major, file_version_minor, file_version_patch; - int game_version_major, game_version_minor, game_version_patch; - - file_version_major = fgetc(file); - file_version_minor = fgetc(file); - file_version_patch = fgetc(file); - fgetc(file); /* not used */ - - game_version_major = fgetc(file); - game_version_minor = fgetc(file); - game_version_patch = fgetc(file); - fgetc(file); /* not used */ - - *file_version = VERSION_IDENT(file_version_major, - file_version_minor, - file_version_patch); - - *game_version = VERSION_IDENT(game_version_major, - game_version_minor, - game_version_patch); -} - -void WriteChunk_VERS(FILE *file, int file_version, int game_version) -{ - int file_version_major = VERSION_MAJOR(file_version); - int file_version_minor = VERSION_MINOR(file_version); - int file_version_patch = VERSION_PATCH(file_version); - int game_version_major = VERSION_MAJOR(game_version); - int game_version_minor = VERSION_MINOR(game_version); - int game_version_patch = VERSION_PATCH(game_version); - - fputc(file_version_major, file); - fputc(file_version_minor, file); - fputc(file_version_patch, file); - fputc(0, file); /* not used */ - - fputc(game_version_major, file); - fputc(game_version_minor, file); - fputc(game_version_patch, file); - fputc(0, file); /* not used */ -} - /* ------------------------------------------------------------------------- */ /* some functions to handle lists of level directories */ /* ------------------------------------------------------------------------- */ -struct LevelDirInfo *newLevelDirInfo() +TreeInfo *newTreeInfo() { - return checked_calloc(sizeof(struct LevelDirInfo)); + return checked_calloc(sizeof(TreeInfo)); } -void pushLevelDirInfo(struct LevelDirInfo **node_first, - struct LevelDirInfo *node_new) +void pushTreeInfo(TreeInfo **node_first, TreeInfo *node_new) { node_new->next = *node_first; *node_first = node_new; } -int numLevelDirInfo(struct LevelDirInfo *node) +int numTreeInfo(TreeInfo *node) { int num = 0; @@ -373,52 +657,48 @@ int numLevelDirInfo(struct LevelDirInfo *node) return num; } -boolean validLevelSeries(struct LevelDirInfo *node) +boolean validLevelSeries(TreeInfo *node) { return (node != NULL && !node->node_group && !node->parent_link); } -struct LevelDirInfo *getFirstValidLevelSeries(struct LevelDirInfo *node) +TreeInfo *getFirstValidTreeInfoEntry(TreeInfo *node) { if (node == NULL) - { - if (leveldir_first) /* start with first level directory entry */ - return getFirstValidLevelSeries(leveldir_first); - else - return NULL; - } - else if (node->node_group) /* enter level group (step down into tree) */ - return getFirstValidLevelSeries(node->node_group); + return NULL; + + if (node->node_group) /* enter level group (step down into tree) */ + return getFirstValidTreeInfoEntry(node->node_group); else if (node->parent_link) /* skip start entry of level group */ { if (node->next) /* get first real level series entry */ - return getFirstValidLevelSeries(node->next); + return getFirstValidTreeInfoEntry(node->next); else /* leave empty level group and go on */ - return getFirstValidLevelSeries(node->node_parent->next); + return getFirstValidTreeInfoEntry(node->node_parent->next); } else /* this seems to be a regular level series */ return node; } -struct LevelDirInfo *getLevelDirInfoFirstGroupEntry(struct LevelDirInfo *node) +TreeInfo *getTreeInfoFirstGroupEntry(TreeInfo *node) { if (node == NULL) return NULL; if (node->node_parent == NULL) /* top level group */ - return leveldir_first; + return *node->node_top; else /* sub level group */ return node->node_parent->node_group; } -int numLevelDirInfoInGroup(struct LevelDirInfo *node) +int numTreeInfoInGroup(TreeInfo *node) { - return numLevelDirInfo(getLevelDirInfoFirstGroupEntry(node)); + return numTreeInfo(getTreeInfoFirstGroupEntry(node)); } -int posLevelDirInfo(struct LevelDirInfo *node) +int posTreeInfo(TreeInfo *node) { - struct LevelDirInfo *node_cmp = getLevelDirInfoFirstGroupEntry(node); + TreeInfo *node_cmp = getTreeInfoFirstGroupEntry(node); int pos = 0; while (node_cmp) @@ -433,9 +713,9 @@ int posLevelDirInfo(struct LevelDirInfo *node) return 0; } -struct LevelDirInfo *getLevelDirInfoFromPos(struct LevelDirInfo *node, int pos) +TreeInfo *getTreeInfoFromPos(TreeInfo *node, int pos) { - struct LevelDirInfo *node_default = node; + TreeInfo *node_default = node; int pos_cmp = 0; while (node) @@ -450,26 +730,25 @@ struct LevelDirInfo *getLevelDirInfoFromPos(struct LevelDirInfo *node, int pos) return node_default; } -struct LevelDirInfo *getLevelDirInfoFromFilenameExt(struct LevelDirInfo *node, - char *filename) +TreeInfo *getTreeInfoFromIdentifier(TreeInfo *node, char *identifier) { - if (filename == NULL) + if (identifier == NULL) return NULL; while (node) { if (node->node_group) { - struct LevelDirInfo *node_group; + TreeInfo *node_group; - node_group = getLevelDirInfoFromFilenameExt(node->node_group, filename); + node_group = getTreeInfoFromIdentifier(node->node_group, identifier); if (node_group) return node_group; } else if (!node->parent_link) { - if (strcmp(filename, node->filename) == 0) + if (strcmp(identifier, node->identifier) == 0) return node; } @@ -479,42 +758,40 @@ struct LevelDirInfo *getLevelDirInfoFromFilenameExt(struct LevelDirInfo *node, return NULL; } -struct LevelDirInfo *getLevelDirInfoFromFilename(char *filename) -{ - return getLevelDirInfoFromFilenameExt(leveldir_first, filename); -} - -void dumpLevelDirInfo(struct LevelDirInfo *node, int depth) +void dumpTreeInfo(TreeInfo *node, int depth) { int i; + printf("Dumping TreeInfo:\n"); + while (node) { - for (i=0; ifilename); + printf("filename == '%s' (%s) [%s] (%d)\n", + node->filename, node->name, node->identifier, node->sort_priority); if (node->node_group != NULL) - dumpLevelDirInfo(node->node_group, depth + 1); + dumpTreeInfo(node->node_group, depth + 1); node = node->next; } } -void sortLevelDirInfo(struct LevelDirInfo **node_first, - int (*compare_function)(const void *, const void *)) +void sortTreeInfo(TreeInfo **node_first, + int (*compare_function)(const void *, const void *)) { - int num_nodes = numLevelDirInfo(*node_first); - struct LevelDirInfo **sort_array; - struct LevelDirInfo *node = *node_first; + int num_nodes = numTreeInfo(*node_first); + TreeInfo **sort_array; + TreeInfo *node = *node_first; int i = 0; if (num_nodes == 0) return; /* allocate array for sorting structure pointers */ - sort_array = checked_calloc(num_nodes * sizeof(struct LevelDirInfo *)); + sort_array = checked_calloc(num_nodes * sizeof(TreeInfo *)); /* writing structure pointers to sorting array */ while (i < num_nodes && node) /* double boundary check... */ @@ -526,7 +803,7 @@ void sortLevelDirInfo(struct LevelDirInfo **node_first, } /* sorting the structure pointers in the sorting array */ - qsort(sort_array, num_nodes, sizeof(struct LevelDirInfo *), + qsort(sort_array, num_nodes, sizeof(TreeInfo *), compare_function); /* update the linkage of list elements with the sorted node array */ @@ -544,7 +821,7 @@ void sortLevelDirInfo(struct LevelDirInfo **node_first, while (node) { if (node->node_group != NULL) - sortLevelDirInfo(&node->node_group, compare_function); + sortTreeInfo(&node->node_group, compare_function); node = node->next; } @@ -601,15 +878,33 @@ char *getUserDataDir(void) { static char *userdata_dir = NULL; - if (!userdata_dir) + if (userdata_dir == NULL) + userdata_dir = getPath2(getHomeDir(), program.userdata_directory); + + return userdata_dir; +} + +char *getCommonDataDir(void) +{ + static char *common_data_dir = NULL; + +#if defined(PLATFORM_WIN32) + if (common_data_dir == NULL) { - char *home_dir = getHomeDir(); - char *data_dir = program.userdata_directory; + char *dir = checked_malloc(MAX_PATH + 1); - userdata_dir = getPath2(home_dir, data_dir); + if (SUCCEEDED(SHGetFolderPath(NULL, CSIDL_COMMON_DOCUMENTS, NULL, 0, dir)) + && strcmp(dir, "") != 0) /* empty for Windows 95/98 */ + common_data_dir = getPath2(dir, program.userdata_directory); + else + common_data_dir = options.rw_base_directory; } +#else + if (common_data_dir == NULL) + common_data_dir = options.rw_base_directory; +#endif - return userdata_dir; + return common_data_dir; } char *getSetupDir() @@ -726,157 +1021,206 @@ boolean checkCookieString(const char *cookie, const char *template) } /* ------------------------------------------------------------------------- */ -/* setup file list handling functions */ +/* setup file list and hash handling functions */ /* ------------------------------------------------------------------------- */ -int get_string_integer_value(char *s) +char *getFormattedSetupEntry(char *token, char *value) { - static char *number_text[][3] = - { - { "0", "zero", "null", }, - { "1", "one", "first" }, - { "2", "two", "second" }, - { "3", "three", "third" }, - { "4", "four", "fourth" }, - { "5", "five", "fifth" }, - { "6", "six", "sixth" }, - { "7", "seven", "seventh" }, - { "8", "eight", "eighth" }, - { "9", "nine", "ninth" }, - { "10", "ten", "tenth" }, - { "11", "eleven", "eleventh" }, - { "12", "twelve", "twelfth" }, - }; + int i; + static char entry[MAX_LINE_LEN]; + + /* start with the token and some spaces to format output line */ + sprintf(entry, "%s:", token); + for (i=strlen(entry); itoken = getStringCopy(token); + new->value = getStringCopy(value); - free(s_lower); + new->next = NULL; - return result; + return new; } -boolean get_string_boolean_value(char *s) +void freeSetupFileList(SetupFileList *list) { - char *s_lower = getStringToLower(s); - boolean result = FALSE; + if (list == NULL) + return; - if (strcmp(s_lower, "true") == 0 || - strcmp(s_lower, "yes") == 0 || - strcmp(s_lower, "on") == 0 || - get_string_integer_value(s) == 1) - result = TRUE; + if (list->token) + free(list->token); + if (list->value) + free(list->value); + if (list->next) + freeSetupFileList(list->next); + free(list); +} - free(s_lower); +char *getListEntry(SetupFileList *list, char *token) +{ + if (list == NULL) + return NULL; - return result; + if (strcmp(list->token, token) == 0) + return list->value; + else + return getListEntry(list->next, token); } -char *getFormattedSetupEntry(char *token, char *value) +void setListEntry(SetupFileList *list, char *token, char *value) { - int i; - static char entry[MAX_LINE_LEN]; - - sprintf(entry, "%s:", token); - for (i=strlen(entry); itoken, token) == 0) + { + if (list->value) + free(list->value); - return entry; + list->value = getStringCopy(value); + } + else if (list->next == NULL) + list->next = newSetupFileList(token, value); + else + setListEntry(list->next, token, value); } -void freeSetupFileList(struct SetupFileList *setup_file_list) +#ifdef DEBUG +static void printSetupFileList(SetupFileList *list) { - if (!setup_file_list) + if (!list) 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); + printf("token: '%s'\n", list->token); + printf("value: '%s'\n", list->value); + + printSetupFileList(list->next); } +#endif + +#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 struct SetupFileList *newSetupFileList(char *token, char *value) +static unsigned int get_hash_from_key(void *key) { - struct SetupFileList *new = checked_malloc(sizeof(struct SetupFileList)); + /* + djb2 - new->token = checked_malloc(strlen(token) + 1); - strcpy(new->token, token); + 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. - new->value = checked_malloc(strlen(value) + 1); - strcpy(new->value, value); + 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. - new->next = NULL; + Ozan (oz) Yigit [http://www.cs.yorku.ca/~oz/hash.html] + */ - return new; + char *str = (char *)key; + unsigned int hash = 5381; + int c; + + while ((c = *str++)) + hash = ((hash << 5) + hash) + c; /* hash * 33 + c */ + + return hash; } -char *getTokenValue(struct SetupFileList *setup_file_list, char *token) +static int keys_are_equal(void *key1, void *key2) { - if (!setup_file_list) - return NULL; + return (strcmp((char *)key1, (char *)key2) == 0); +} - if (strcmp(setup_file_list->token, token) == 0) - return setup_file_list->value; - else - return getTokenValue(setup_file_list->next, token); +SetupFileHash *newSetupFileHash() +{ + SetupFileHash *new_hash = + create_hashtable(16, 0.75, get_hash_from_key, keys_are_equal); + + return new_hash; } -static void setTokenValue(struct SetupFileList *setup_file_list, - char *token, char *value) +void freeSetupFileHash(SetupFileHash *hash) { - if (!setup_file_list) + if (hash == NULL) return; - if (strcmp(setup_file_list->token, token) == 0) - { - free(setup_file_list->value); - setup_file_list->value = checked_malloc(strlen(value) + 1); - strcpy(setup_file_list->value, value); - } - else if (setup_file_list->next == NULL) - setup_file_list->next = newSetupFileList(token, value); - else - setTokenValue(setup_file_list->next, token, value); + hashtable_destroy(hash, 1); /* 1 == also free values stored in hash */ } -#ifdef DEBUG -static void printSetupFileList(struct SetupFileList *setup_file_list) +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) { - if (!setup_file_list) + char *value_copy; + + if (hash == NULL) return; - printf("token: '%s'\n", setup_file_list->token); - printf("value: '%s'\n", setup_file_list->value); + 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"); +} - printSetupFileList(setup_file_list->next); +#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 -struct SetupFileList *loadSetupFileList(char *filename) +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); @@ -936,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"); } @@ -989,8 +1343,8 @@ void checkSetupFileListIdentifier(struct SetupFileList *setup_file_list, #define TOKEN_STR_HANDICAP_LEVEL "handicap_level" /* level directory info */ -#define LEVELINFO_TOKEN_NAME 0 -#define LEVELINFO_TOKEN_NAME_SHORT 1 +#define LEVELINFO_TOKEN_IDENTIFIER 0 +#define LEVELINFO_TOKEN_NAME 1 #define LEVELINFO_TOKEN_NAME_SORTING 2 #define LEVELINFO_TOKEN_AUTHOR 3 #define LEVELINFO_TOKEN_IMPORTED_FROM 4 @@ -999,61 +1353,88 @@ void checkSetupFileListIdentifier(struct SetupFileList *setup_file_list, #define LEVELINFO_TOKEN_SORT_PRIORITY 7 #define LEVELINFO_TOKEN_LEVEL_GROUP 8 #define LEVELINFO_TOKEN_READONLY 9 +#define LEVELINFO_TOKEN_GRAPHICS_SET 10 +#define LEVELINFO_TOKEN_SOUNDS_SET 11 +#define LEVELINFO_TOKEN_MUSIC_SET 12 -#define NUM_LEVELINFO_TOKENS 10 +#define NUM_LEVELINFO_TOKENS 13 -static struct LevelDirInfo ldi; +static LevelDirTree ldi; static struct TokenInfo levelinfo_tokens[] = { /* level directory info */ - { TYPE_STRING, &ldi.name, "name" }, - { TYPE_STRING, &ldi.name_short, "name_short" }, - { TYPE_STRING, &ldi.name_sorting, "name_sorting" }, - { TYPE_STRING, &ldi.author, "author" }, - { TYPE_STRING, &ldi.imported_from, "imported_from" }, - { TYPE_INTEGER, &ldi.levels, "levels" }, - { TYPE_INTEGER, &ldi.first_level, "first_level" }, - { TYPE_INTEGER, &ldi.sort_priority, "sort_priority" }, - { TYPE_BOOLEAN, &ldi.level_group, "level_group" }, - { TYPE_BOOLEAN, &ldi.readonly, "readonly" } + { TYPE_STRING, &ldi.identifier, "identifier" }, + { TYPE_STRING, &ldi.name, "name" }, + { TYPE_STRING, &ldi.name_sorting, "name_sorting" }, + { TYPE_STRING, &ldi.author, "author" }, + { TYPE_STRING, &ldi.imported_from, "imported_from" }, + { TYPE_INTEGER, &ldi.levels, "levels" }, + { TYPE_INTEGER, &ldi.first_level, "first_level" }, + { TYPE_INTEGER, &ldi.sort_priority, "sort_priority" }, + { TYPE_BOOLEAN, &ldi.level_group, "level_group" }, + { TYPE_BOOLEAN, &ldi.readonly, "readonly" }, + { TYPE_STRING, &ldi.graphics_set, "graphics_set" }, + { TYPE_STRING, &ldi.sounds_set, "sounds_set" }, + { TYPE_STRING, &ldi.music_set, "music_set" } }; -static void setLevelDirInfoToDefaults(struct LevelDirInfo *ldi) +static void setTreeInfoToDefaults(TreeInfo *ldi, int type) { + ldi->type = type; + + ldi->node_top = (ldi->type == TREE_TYPE_LEVEL_DIR ? &leveldir_first : + ldi->type == TREE_TYPE_GRAPHICS_DIR ? &artwork.gfx_first : + ldi->type == TREE_TYPE_SOUNDS_DIR ? &artwork.snd_first : + ldi->type == TREE_TYPE_MUSIC_DIR ? &artwork.mus_first : + NULL); + + ldi->node_parent = NULL; + ldi->node_group = NULL; + ldi->next = NULL; + + ldi->cl_first = -1; + ldi->cl_cursor = -1; + ldi->filename = NULL; ldi->fullpath = NULL; ldi->basepath = NULL; + ldi->identifier = NULL; ldi->name = getStringCopy(ANONYMOUS_NAME); - ldi->name_short = NULL; ldi->name_sorting = NULL; ldi->author = getStringCopy(ANONYMOUS_NAME); - ldi->imported_from = NULL; - ldi->levels = 0; - ldi->first_level = 0; - ldi->last_level = 0; + ldi->sort_priority = LEVELCLASS_UNDEFINED; /* default: least priority */ - ldi->level_group = FALSE; ldi->parent_link = FALSE; ldi->user_defined = FALSE; - ldi->readonly = TRUE; ldi->color = 0; ldi->class_desc = NULL; - ldi->handicap_level = 0; - ldi->cl_first = -1; - ldi->cl_cursor = -1; - ldi->node_parent = NULL; - ldi->node_group = NULL; - ldi->next = NULL; + if (ldi->type == TREE_TYPE_LEVEL_DIR) + { + ldi->imported_from = NULL; + ldi->graphics_set = NULL; + ldi->sounds_set = NULL; + ldi->music_set = NULL; + ldi->graphics_path = getStringCopy(UNDEFINED_FILENAME); + ldi->sounds_path = getStringCopy(UNDEFINED_FILENAME); + ldi->music_path = getStringCopy(UNDEFINED_FILENAME); + ldi->levels = 0; + ldi->first_level = 0; + ldi->last_level = 0; + ldi->level_group = FALSE; + ldi->handicap_level = 0; + ldi->readonly = TRUE; + } } -static void setLevelDirInfoToDefaultsFromParent(struct LevelDirInfo *ldi, - struct LevelDirInfo *parent) +static void setTreeInfoToDefaultsFromParent(TreeInfo *ldi, TreeInfo *parent) { if (parent == NULL) { - setLevelDirInfoToDefaults(ldi); + Error(ERR_WARN, "setTreeInfoToDefaultsFromParent(): parent == NULL"); + + setTreeInfoToDefaults(ldi, TREE_TYPE_GENERIC); return; } @@ -1070,8 +1451,8 @@ static void setLevelDirInfoToDefaultsFromParent(struct LevelDirInfo *ldi, ldi->filename = NULL; ldi->fullpath = NULL; ldi->basepath = NULL; + ldi->identifier = NULL; ldi->name = getStringCopy(ANONYMOUS_NAME); - ldi->name_short = NULL; ldi->name_sorting = NULL; ldi->author = getStringCopy(parent->author); ldi->imported_from = getStringCopy(parent->imported_from); @@ -1079,6 +1460,7 @@ static void setLevelDirInfoToDefaultsFromParent(struct LevelDirInfo *ldi, ldi->level_group = FALSE; ldi->parent_link = FALSE; + ldi->node_top = parent->node_top; ldi->node_parent = parent; ldi->node_group = NULL; ldi->next = NULL; @@ -1098,15 +1480,19 @@ void setSetupInfo(struct TokenInfo *token_info, { case TYPE_BOOLEAN: case TYPE_SWITCH: - *(boolean *)setup_value = get_string_boolean_value(token_value); + *(boolean *)setup_value = get_boolean_from_string(token_value); break; case TYPE_KEY: + *(Key *)setup_value = getKeyFromKeyName(token_value); + break; + + case TYPE_KEY_X11: *(Key *)setup_value = getKeyFromX11KeyName(token_value); break; case TYPE_INTEGER: - *(int *)setup_value = get_string_integer_value(token_value); + *(int *)setup_value = get_integer_from_string(token_value); break; case TYPE_STRING: @@ -1120,12 +1506,24 @@ void setSetupInfo(struct TokenInfo *token_info, } } -static int compareLevelDirInfoEntries(const void *object1, const void *object2) +static int compareTreeInfoEntries(const void *object1, const void *object2) { - const struct LevelDirInfo *entry1 = *((struct LevelDirInfo **)object1); - const struct LevelDirInfo *entry2 = *((struct LevelDirInfo **)object2); + const TreeInfo *entry1 = *((TreeInfo **)object1); + const TreeInfo *entry2 = *((TreeInfo **)object2); + int class_sorting1, class_sorting2; int compare_result; + if (entry1->type == TREE_TYPE_LEVEL_DIR) + { + class_sorting1 = LEVELSORTING(entry1); + class_sorting2 = LEVELSORTING(entry2); + } + else + { + class_sorting1 = ARTWORKSORTING(entry1); + class_sorting2 = ARTWORKSORTING(entry2); + } + if (entry1->parent_link || entry2->parent_link) compare_result = (entry1->parent_link ? -1 : +1); else if (entry1->sort_priority == entry2->sort_priority) @@ -1138,55 +1536,57 @@ static int compareLevelDirInfoEntries(const void *object1, const void *object2) free(name1); free(name2); } - else if (LEVELSORTING(entry1) == LEVELSORTING(entry2)) + else if (class_sorting1 == class_sorting2) compare_result = entry1->sort_priority - entry2->sort_priority; else - compare_result = LEVELSORTING(entry1) - LEVELSORTING(entry2); + compare_result = class_sorting1 - class_sorting2; return compare_result; } -static void createParentLevelDirNode(struct LevelDirInfo *node_parent) +static void createParentTreeInfoNode(TreeInfo *node_parent) { - struct LevelDirInfo *leveldir_new = newLevelDirInfo(); + TreeInfo *ti_new; - setLevelDirInfoToDefaults(leveldir_new); + if (node_parent == NULL) + return; - leveldir_new->node_parent = node_parent; - leveldir_new->parent_link = TRUE; + ti_new = newTreeInfo(); + setTreeInfoToDefaults(ti_new, node_parent->type); - leveldir_new->name = ".. (parent directory)"; - leveldir_new->name_short = getStringCopy(leveldir_new->name); - leveldir_new->name_sorting = getStringCopy(leveldir_new->name); + ti_new->node_parent = node_parent; + ti_new->parent_link = TRUE; - leveldir_new->filename = ".."; - leveldir_new->fullpath = getStringCopy(node_parent->fullpath); + ti_new->identifier = getStringCopy(node_parent->identifier); + ti_new->name = ".. (parent directory)"; + ti_new->name_sorting = getStringCopy(ti_new->name); - leveldir_new->sort_priority = node_parent->sort_priority; - leveldir_new->class_desc = getLevelClassDescription(leveldir_new); + ti_new->filename = ".."; + ti_new->fullpath = getStringCopy(node_parent->fullpath); - pushLevelDirInfo(&node_parent->node_group, leveldir_new); + ti_new->sort_priority = node_parent->sort_priority; + ti_new->class_desc = getLevelClassDescription(ti_new); + + pushTreeInfo(&node_parent->node_group, ti_new); } -/* forward declaration for recursive call by "LoadLevelInfoFromSetupFile()" */ -static void LoadLevelInfoFromLevelGroupDir(struct LevelDirInfo **, - struct LevelDirInfo *, - char *); +/* forward declaration for recursive call by "LoadLevelInfoFromLevelDir()" */ +static void LoadLevelInfoFromLevelDir(TreeInfo **, TreeInfo *, char *); -static boolean LoadLevelInfoFromLevelDir(struct LevelDirInfo **node_first, - struct LevelDirInfo *node_parent, - char *level_directory, - char *directory_name) +static boolean LoadLevelInfoFromLevelConf(TreeInfo **node_first, + TreeInfo *node_parent, + char *level_directory, + char *directory_name) { char *directory_path = getPath2(level_directory, directory_name); char *filename = getPath2(directory_path, LEVELINFO_FILENAME); - struct SetupFileList *setup_file_list = loadSetupFileList(filename); - struct LevelDirInfo *leveldir_new = NULL; + 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'", level_directory); + Error(ERR_WARN, "ignoring level directory '%s'", directory_path); free(directory_path); free(filename); @@ -1194,28 +1594,38 @@ static boolean LoadLevelInfoFromLevelDir(struct LevelDirInfo **node_first, return FALSE; } - leveldir_new = newLevelDirInfo(); + leveldir_new = newTreeInfo(); - checkSetupFileListIdentifier(setup_file_list, getCookie("LEVELINFO")); - setLevelDirInfoToDefaultsFromParent(leveldir_new, node_parent); + if (node_parent) + setTreeInfoToDefaultsFromParent(leveldir_new, node_parent); + else + setTreeInfoToDefaults(leveldir_new, TREE_TYPE_LEVEL_DIR); + + leveldir_new->filename = getStringCopy(directory_name); + + 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) + { + free(leveldir_new->name); + leveldir_new->name = getStringCopy(leveldir_new->filename); + } + DrawInitText(leveldir_new->name, 150, FC_YELLOW); - if (leveldir_new->name_short == NULL) - leveldir_new->name_short = getStringCopy(leveldir_new->name); + if (leveldir_new->identifier == NULL) + leveldir_new->identifier = getStringCopy(leveldir_new->filename); if (leveldir_new->name_sorting == NULL) leveldir_new->name_sorting = getStringCopy(leveldir_new->name); - leveldir_new->filename = getStringCopy(directory_name); - if (node_parent == NULL) /* top level group */ { leveldir_new->basepath = level_directory; @@ -1224,8 +1634,7 @@ static boolean LoadLevelInfoFromLevelDir(struct LevelDirInfo **node_first, else /* sub level group */ { leveldir_new->basepath = node_parent->basepath; - leveldir_new->fullpath = getPath2(node_parent->fullpath, - directory_name); + leveldir_new->fullpath = getPath2(node_parent->fullpath, directory_name); } if (leveldir_new->levels < 1) @@ -1245,18 +1654,18 @@ static boolean LoadLevelInfoFromLevelDir(struct LevelDirInfo **node_first, leveldir_new->last_level : leveldir_new->first_level); - pushLevelDirInfo(node_first, leveldir_new); + pushTreeInfo(node_first, leveldir_new); - freeSetupFileList(setup_file_list); + freeSetupFileHash(setup_file_hash); if (leveldir_new->level_group) { /* create node to link back to current level directory */ - createParentLevelDirNode(leveldir_new); + createParentTreeInfoNode(leveldir_new); /* step into sub-directory and look for more level series */ - LoadLevelInfoFromLevelGroupDir(&leveldir_new->node_group, - leveldir_new, directory_path); + LoadLevelInfoFromLevelDir(&leveldir_new->node_group, + leveldir_new, directory_path); } free(directory_path); @@ -1265,9 +1674,9 @@ static boolean LoadLevelInfoFromLevelDir(struct LevelDirInfo **node_first, return TRUE; } -static void LoadLevelInfoFromLevelGroupDir(struct LevelDirInfo **node_first, - struct LevelDirInfo *node_parent, - char *level_directory) +static void LoadLevelInfoFromLevelDir(TreeInfo **node_first, + TreeInfo *node_parent, + char *level_directory) { DIR *dir; struct dirent *dir_entry; @@ -1303,9 +1712,14 @@ static void LoadLevelInfoFromLevelGroupDir(struct LevelDirInfo **node_first, free(directory_path); - valid_entry_found |= LoadLevelInfoFromLevelDir(node_first, node_parent, - level_directory, - directory_name); + if (strcmp(directory_name, GRAPHICS_DIRECTORY) == 0 || + strcmp(directory_name, SOUNDS_DIRECTORY) == 0 || + strcmp(directory_name, MUSIC_DIRECTORY) == 0) + continue; + + valid_entry_found |= LoadLevelInfoFromLevelConf(node_first, node_parent, + level_directory, + directory_name); } closedir(dir); @@ -1313,8 +1727,8 @@ static void LoadLevelInfoFromLevelGroupDir(struct LevelDirInfo **node_first, if (!valid_entry_found) { /* check if this directory directly contains a file "levelinfo.conf" */ - valid_entry_found |= LoadLevelInfoFromLevelDir(node_first, node_parent, - level_directory, "."); + valid_entry_found |= LoadLevelInfoFromLevelConf(node_first, node_parent, + level_directory, "."); } if (!valid_entry_found) @@ -1328,19 +1742,404 @@ void LoadLevelInfo() DrawInitText("Loading level series:", 120, FC_GREEN); - /* check if this directory directly contains a file "levelinfo.conf" */ - LoadLevelInfoFromLevelGroupDir(&leveldir_first,NULL,options.level_directory); - LoadLevelInfoFromLevelGroupDir(&leveldir_first,NULL,getUserLevelDir("")); + LoadLevelInfoFromLevelDir(&leveldir_first, NULL, options.level_directory); + LoadLevelInfoFromLevelDir(&leveldir_first, NULL, getUserLevelDir(NULL)); - leveldir_current = getFirstValidLevelSeries(leveldir_first); + /* before sorting, the first entries will be from the user directory */ + leveldir_current = getFirstValidTreeInfoEntry(leveldir_first); if (leveldir_first == NULL) Error(ERR_EXIT, "cannot find any valid level series in any directory"); - sortLevelDirInfo(&leveldir_first, compareLevelDirInfoEntries); + sortTreeInfo(&leveldir_first, compareTreeInfoEntries); + +#if 0 + dumpTreeInfo(leveldir_first, 0); +#endif +} + +static boolean LoadArtworkInfoFromArtworkConf(TreeInfo **node_first, + TreeInfo *node_parent, + char *base_directory, + char *directory_name, int type) +{ + char *directory_path = getPath2(base_directory, directory_name); + char *filename = getPath2(directory_path, ARTWORKINFO_FILENAME(type)); + SetupFileHash *setup_file_hash = NULL; + TreeInfo *artwork_new = NULL; + int i; + + if (access(filename, F_OK) == 0) /* file exists */ + setup_file_hash = loadSetupFileHash(filename); + + if (setup_file_hash == NULL) /* no config file -- look for artwork files */ + { + DIR *dir; + struct dirent *dir_entry; + boolean valid_file_found = FALSE; + + if ((dir = opendir(directory_path)) != NULL) + { + while ((dir_entry = readdir(dir)) != NULL) + { + char *entry_name = dir_entry->d_name; + + if (FileIsArtworkType(entry_name, type)) + { + valid_file_found = TRUE; + break; + } + } + + closedir(dir); + } + + if (!valid_file_found) + { + if (strcmp(directory_name, ".") != 0) + Error(ERR_WARN, "ignoring artwork directory '%s'", directory_path); + + free(directory_path); + free(filename); + + return FALSE; + } + } + + artwork_new = newTreeInfo(); + + if (node_parent) + setTreeInfoToDefaultsFromParent(artwork_new, node_parent); + else + setTreeInfoToDefaults(artwork_new, type); + + artwork_new->filename = getStringCopy(directory_name); + + if (setup_file_hash) /* (before defining ".color" and ".class_desc") */ + { +#if 0 + 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) + { + free(artwork_new->name); + artwork_new->name = getStringCopy(artwork_new->filename); + } #if 0 - dumpLevelDirInfo(leveldir_first, 0); + DrawInitText(artwork_new->name, 150, FC_YELLOW); +#endif + + if (artwork_new->identifier == NULL) + artwork_new->identifier = getStringCopy(artwork_new->filename); + + if (artwork_new->name_sorting == NULL) + artwork_new->name_sorting = getStringCopy(artwork_new->name); + } + + if (node_parent == NULL) /* top level group */ + { + artwork_new->basepath = getStringCopy(base_directory); + artwork_new->fullpath = getStringCopy(artwork_new->filename); + } + else /* sub level group */ + { + artwork_new->basepath = getStringCopy(node_parent->basepath); + artwork_new->fullpath = getPath2(node_parent->fullpath, directory_name); + } + + artwork_new->user_defined = + (artwork_new->basepath == OPTIONS_ARTWORK_DIRECTORY(type) ? FALSE : TRUE); + + /* (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_hash == NULL) /* (after determining ".user_defined") */ + { + if (artwork_new->name != NULL) + free(artwork_new->name); + + if (strcmp(artwork_new->filename, ".") == 0) + { + if (artwork_new->user_defined) + { + artwork_new->identifier = getStringCopy("private"); + artwork_new->sort_priority = ARTWORKCLASS_USER; + } + else + { + artwork_new->identifier = getStringCopy("classic"); + artwork_new->sort_priority = ARTWORKCLASS_CLASSICS; + } + + /* set to new values after changing ".sort_priority" */ + artwork_new->color = ARTWORKCOLOR(artwork_new); + artwork_new->class_desc = getLevelClassDescription(artwork_new); + } + else + { + artwork_new->identifier = getStringCopy(artwork_new->filename); + } + + artwork_new->name = getStringCopy(artwork_new->identifier); + artwork_new->name_sorting = getStringCopy(artwork_new->name); + } + + DrawInitText(artwork_new->name, 150, FC_YELLOW); + + pushTreeInfo(node_first, artwork_new); + + freeSetupFileHash(setup_file_hash); + + free(directory_path); + free(filename); + + return TRUE; +} + +static void LoadArtworkInfoFromArtworkDir(TreeInfo **node_first, + TreeInfo *node_parent, + char *base_directory, int type) +{ + DIR *dir; + struct dirent *dir_entry; + boolean valid_entry_found = FALSE; + + if ((dir = opendir(base_directory)) == NULL) + { + if (base_directory == OPTIONS_ARTWORK_DIRECTORY(type)) + Error(ERR_WARN, "cannot read directory '%s'", base_directory); + return; + } + + while ((dir_entry = readdir(dir)) != NULL) /* loop until last dir entry */ + { + struct stat file_status; + char *directory_name = dir_entry->d_name; + char *directory_path = getPath2(base_directory, directory_name); + + /* skip entries for current and parent directory */ + if (strcmp(directory_name, ".") == 0 || + strcmp(directory_name, "..") == 0) + { + free(directory_path); + continue; + } + + /* find out if directory entry is itself a directory */ + if (stat(directory_path, &file_status) != 0 || /* cannot stat file */ + (file_status.st_mode & S_IFMT) != S_IFDIR) /* not a directory */ + { + free(directory_path); + continue; + } + + free(directory_path); + + /* check if this directory contains artwork with or without config file */ + valid_entry_found |= LoadArtworkInfoFromArtworkConf(node_first,node_parent, + base_directory, + directory_name, type); + } + + closedir(dir); + + /* check if this directory directly contains artwork itself */ + valid_entry_found |= LoadArtworkInfoFromArtworkConf(node_first,node_parent, + base_directory, ".", + type); + if (!valid_entry_found) + Error(ERR_WARN, "cannot find any valid artwork in directory '%s'", + base_directory); +} + +static TreeInfo *getDummyArtworkInfo(int type) +{ + /* this is only needed when there is completely no artwork available */ + TreeInfo *artwork_new = newTreeInfo(); + + setTreeInfoToDefaults(artwork_new, type); + + artwork_new->filename = getStringCopy(UNDEFINED_FILENAME); + artwork_new->fullpath = getStringCopy(UNDEFINED_FILENAME); + artwork_new->basepath = getStringCopy(UNDEFINED_FILENAME); + + if (artwork_new->name != NULL) + free(artwork_new->name); + + artwork_new->identifier = getStringCopy(UNDEFINED_FILENAME); + artwork_new->name = getStringCopy(UNDEFINED_FILENAME); + artwork_new->name_sorting = getStringCopy(UNDEFINED_FILENAME); + + return artwork_new; +} + +void LoadArtworkInfo() +{ + DrawInitText("Looking for custom artwork:", 120, FC_GREEN); + + LoadArtworkInfoFromArtworkDir(&artwork.gfx_first, NULL, + options.graphics_directory, + TREE_TYPE_GRAPHICS_DIR); + LoadArtworkInfoFromArtworkDir(&artwork.gfx_first, NULL, + getUserGraphicsDir(), + TREE_TYPE_GRAPHICS_DIR); + + LoadArtworkInfoFromArtworkDir(&artwork.snd_first, NULL, + options.sounds_directory, + TREE_TYPE_SOUNDS_DIR); + LoadArtworkInfoFromArtworkDir(&artwork.snd_first, NULL, + getUserSoundsDir(), + TREE_TYPE_SOUNDS_DIR); + + LoadArtworkInfoFromArtworkDir(&artwork.mus_first, NULL, + options.music_directory, + TREE_TYPE_MUSIC_DIR); + LoadArtworkInfoFromArtworkDir(&artwork.mus_first, NULL, + getUserMusicDir(), + TREE_TYPE_MUSIC_DIR); + + if (artwork.gfx_first == NULL) + artwork.gfx_first = getDummyArtworkInfo(TREE_TYPE_GRAPHICS_DIR); + if (artwork.snd_first == NULL) + artwork.snd_first = getDummyArtworkInfo(TREE_TYPE_SOUNDS_DIR); + if (artwork.mus_first == NULL) + artwork.mus_first = getDummyArtworkInfo(TREE_TYPE_MUSIC_DIR); + + /* before sorting, the first entries will be from the user directory */ + artwork.gfx_current = + getTreeInfoFromIdentifier(artwork.gfx_first, setup.graphics_set); + if (artwork.gfx_current == NULL) + artwork.gfx_current = getFirstValidTreeInfoEntry(artwork.gfx_first); + + artwork.snd_current = + getTreeInfoFromIdentifier(artwork.snd_first, setup.sounds_set); + if (artwork.snd_current == NULL) + artwork.snd_current = getFirstValidTreeInfoEntry(artwork.snd_first); + + artwork.mus_current = + getTreeInfoFromIdentifier(artwork.mus_first, setup.music_set); + if (artwork.mus_current == NULL) + artwork.mus_current = getFirstValidTreeInfoEntry(artwork.mus_first); + + artwork.gfx_current_identifier = artwork.gfx_current->identifier; + artwork.snd_current_identifier = artwork.snd_current->identifier; + artwork.mus_current_identifier = artwork.mus_current->identifier; + +#if 0 + printf("graphics set == %s\n\n", artwork.gfx_current_identifier); + printf("sounds set == %s\n\n", artwork.snd_current_identifier); + printf("music set == %s\n\n", artwork.mus_current_identifier); +#endif + + sortTreeInfo(&artwork.gfx_first, compareTreeInfoEntries); + sortTreeInfo(&artwork.snd_first, compareTreeInfoEntries); + sortTreeInfo(&artwork.mus_first, compareTreeInfoEntries); + +#if 0 + dumpTreeInfo(artwork.gfx_first, 0); + dumpTreeInfo(artwork.snd_first, 0); + dumpTreeInfo(artwork.mus_first, 0); +#endif +} + +void LoadArtworkInfoFromLevelInfo(ArtworkDirTree **artwork_node, + LevelDirTree *level_node) +{ + /* recursively check all level directories for artwork sub-directories */ + + while (level_node) + { + char *path = getPath2(getLevelDirFromTreeInfo(level_node), + ARTWORK_DIRECTORY((*artwork_node)->type)); + +#if 0 + if (!level_node->parent_link) + printf("CHECKING '%s' ['%s', '%s'] ...\n", path, + level_node->filename, level_node->name); +#endif + + if (!level_node->parent_link) + { + TreeInfo *topnode_last = *artwork_node; + + LoadArtworkInfoFromArtworkDir(artwork_node, NULL, path, + (*artwork_node)->type); + + if (topnode_last != *artwork_node) + { + free((*artwork_node)->identifier); + free((*artwork_node)->name); + free((*artwork_node)->name_sorting); + + (*artwork_node)->identifier = getStringCopy(level_node->filename); + (*artwork_node)->name = getStringCopy(level_node->name); + (*artwork_node)->name_sorting = getStringCopy(level_node->name); + + (*artwork_node)->sort_priority = level_node->sort_priority; + (*artwork_node)->color = LEVELCOLOR((*artwork_node)); + } + } + + free(path); + + if (level_node->node_group != NULL) + LoadArtworkInfoFromLevelInfo(artwork_node, level_node->node_group); + + level_node = level_node->next; + } +} + +void LoadLevelArtworkInfo() +{ + DrawInitText("Looking for custom level artwork:", 120, FC_GREEN); + + LoadArtworkInfoFromLevelInfo(&artwork.gfx_first, leveldir_first); + LoadArtworkInfoFromLevelInfo(&artwork.snd_first, leveldir_first); + LoadArtworkInfoFromLevelInfo(&artwork.mus_first, leveldir_first); + + /* needed for reloading level artwork not known at ealier stage */ + if (strcmp(artwork.gfx_current_identifier, setup.graphics_set) != 0) + { + artwork.gfx_current = + getTreeInfoFromIdentifier(artwork.gfx_first, setup.graphics_set); + if (artwork.gfx_current == NULL) + artwork.gfx_current = getFirstValidTreeInfoEntry(artwork.gfx_first); + } + + if (strcmp(artwork.snd_current_identifier, setup.sounds_set) != 0) + { + artwork.snd_current = + getTreeInfoFromIdentifier(artwork.snd_first, setup.sounds_set); + if (artwork.snd_current == NULL) + artwork.snd_current = getFirstValidTreeInfoEntry(artwork.snd_first); + } + + if (strcmp(artwork.mus_current_identifier, setup.music_set) != 0) + { + artwork.mus_current = + getTreeInfoFromIdentifier(artwork.mus_first, setup.music_set); + if (artwork.mus_current == NULL) + artwork.mus_current = getFirstValidTreeInfoEntry(artwork.mus_first); + } + + sortTreeInfo(&artwork.gfx_first, compareTreeInfoEntries); + sortTreeInfo(&artwork.snd_first, compareTreeInfoEntries); + sortTreeInfo(&artwork.mus_first, compareTreeInfoEntries); + +#if 0 + dumpTreeInfo(artwork.gfx_first, 0); + dumpTreeInfo(artwork.snd_first, 0); + dumpTreeInfo(artwork.mus_first, 0); #endif } @@ -1360,20 +2159,23 @@ static void SaveUserLevelInfo() } /* always start with reliable default values */ - setLevelDirInfoToDefaults(&ldi); + setTreeInfoToDefaults(&ldi, TREE_TYPE_LEVEL_DIR); - ldi.name = getLoginName(); - ldi.author = getRealName(); + ldi.name = getStringCopy(getLoginName()); + ldi.author = getStringCopy(getRealName()); ldi.levels = 100; ldi.first_level = 1; ldi.sort_priority = LEVELCLASS_USER_START; ldi.readonly = FALSE; + ldi.graphics_set = getStringCopy(GRAPHICS_SUBDIR); + ldi.sounds_set = getStringCopy(SOUNDS_SUBDIR); + ldi.music_set = getStringCopy(MUSIC_SUBDIR); fprintf(file, "%s\n\n", getFormattedSetupEntry(TOKEN_STR_FILE_IDENTIFIER, getCookie("LEVELINFO"))); for (i=0; i/levelsetup.conf */ @@ -1461,18 +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 = getLevelDirInfoFromFilename(last_level_series); + leveldir_current = getTreeInfoFromIdentifier(leveldir_first, + last_level_series); if (leveldir_current == NULL) - leveldir_current = leveldir_first; + 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"); @@ -1521,7 +2344,7 @@ static void checkSeriesInfo() /* check for more levels besides the 'levels' field of 'levelinfo.conf' */ level_directory = getPath2((leveldir_current->user_defined ? - getUserLevelDir("") : + getUserLevelDir(NULL) : options.level_directory), leveldir_current->fullpath); @@ -1545,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); @@ -1555,6 +2379,7 @@ static void checkSeriesInfo() Error(ERR_WARN, "additional level %d found", levelnum_value); leveldir_current->last_level = levelnum_value; } +#endif } } @@ -1564,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 */ @@ -1580,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) { @@ -1596,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) { @@ -1613,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");