X-Git-Url: https://git.artsoft.org/?p=rocksndiamonds.git;a=blobdiff_plain;f=src%2Flibgame%2Fsetup.c;h=496b867b42440951bdc8144d4bcef043f1ef99df;hp=7b0189b880f3744e0ff6a0d85137cc7b261bf233;hb=8511bdf9d8df009aae3e4abd68ac5b5f18970237;hpb=fd38efeb44f3bb6bfaa71351c202fd4fe78c5d16 diff --git a/src/libgame/setup.c b/src/libgame/setup.c index 7b0189b8..496b867b 100644 --- a/src/libgame/setup.c +++ b/src/libgame/setup.c @@ -1,7 +1,7 @@ /*********************************************************** * Artsoft Retro-Game Library * *----------------------------------------------------------* -* (c) 1994-2002 Artsoft Entertainment * +* (c) 1994-2006 Artsoft Entertainment * * Holger Schemel * * Detmolder Strasse 189 * * 33604 Bielefeld * @@ -11,42 +11,28 @@ * setup.c * ***********************************************************/ -#include +#include #include +#include #include #include +#include "platform.h" + +#if !defined(PLATFORM_WIN32) +#include +#include +#endif + #include "setup.h" #include "joystick.h" #include "text.h" #include "misc.h" +#include "hash.h" -/* file names and filename extensions */ -#if !defined(PLATFORM_MSDOS) -#define LEVELSETUP_DIRECTORY "levelsetup" -#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" -#else -#define LEVELSETUP_DIRECTORY "lvlsetup" -#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" -#endif #define NUM_LEVELCLASS_DESC 8 + static char *levelclass_desc[NUM_LEVELCLASS_DESC] = { "Tutorial Levels", @@ -59,39 +45,67 @@ static char *levelclass_desc[NUM_LEVELCLASS_DESC] = "DX Boulderdash" }; -#define LEVELCOLOR(n) (IS_LEVELCLASS_TUTORIAL(n) ? FC_BLUE : \ - IS_LEVELCLASS_CLASSICS(n) ? FC_RED : \ - IS_LEVELCLASS_BD(n) ? FC_GREEN : \ - IS_LEVELCLASS_EM(n) ? FC_YELLOW : \ - IS_LEVELCLASS_SP(n) ? FC_GREEN : \ - IS_LEVELCLASS_DX(n) ? FC_YELLOW : \ - IS_LEVELCLASS_CONTRIBUTION(n) ? FC_GREEN : \ - IS_LEVELCLASS_USER(n) ? FC_RED : \ + +#define LEVELCOLOR(n) (IS_LEVELCLASS_TUTORIAL(n) ? FC_BLUE : \ + IS_LEVELCLASS_CLASSICS(n) ? FC_RED : \ + IS_LEVELCLASS_BD(n) ? FC_YELLOW : \ + IS_LEVELCLASS_EM(n) ? FC_YELLOW : \ + IS_LEVELCLASS_SP(n) ? FC_YELLOW : \ + IS_LEVELCLASS_DX(n) ? FC_YELLOW : \ + IS_LEVELCLASS_SB(n) ? FC_YELLOW : \ + IS_LEVELCLASS_CONTRIB(n) ? FC_GREEN : \ + IS_LEVELCLASS_PRIVATE(n) ? FC_RED : \ FC_BLUE) -#define LEVELSORTING(n) (IS_LEVELCLASS_TUTORIAL(n) ? 0 : \ - IS_LEVELCLASS_CLASSICS(n) ? 1 : \ - IS_LEVELCLASS_BD(n) ? 2 : \ - IS_LEVELCLASS_EM(n) ? 3 : \ - IS_LEVELCLASS_SP(n) ? 4 : \ - IS_LEVELCLASS_DX(n) ? 5 : \ - IS_LEVELCLASS_CONTRIBUTION(n) ? 6 : \ - IS_LEVELCLASS_USER(n) ? 7 : \ +#define LEVELSORTING(n) (IS_LEVELCLASS_TUTORIAL(n) ? 0 : \ + IS_LEVELCLASS_CLASSICS(n) ? 1 : \ + IS_LEVELCLASS_BD(n) ? 2 : \ + IS_LEVELCLASS_EM(n) ? 3 : \ + IS_LEVELCLASS_SP(n) ? 4 : \ + IS_LEVELCLASS_DX(n) ? 5 : \ + IS_LEVELCLASS_SB(n) ? 6 : \ + IS_LEVELCLASS_CONTRIB(n) ? 7 : \ + IS_LEVELCLASS_PRIVATE(n) ? 8 : \ 9) -#define TOKEN_VALUE_POSITION 40 -#define TOKEN_COMMENT_POSITION 60 +#define ARTWORKCOLOR(n) (IS_ARTWORKCLASS_CLASSICS(n) ? FC_RED : \ + IS_ARTWORKCLASS_CONTRIB(n) ? FC_GREEN : \ + IS_ARTWORKCLASS_PRIVATE(n) ? FC_RED : \ + IS_ARTWORKCLASS_LEVEL(n) ? FC_YELLOW : \ + FC_BLUE) + +#define ARTWORKSORTING(n) (IS_ARTWORKCLASS_CLASSICS(n) ? 0 : \ + IS_ARTWORKCLASS_LEVEL(n) ? 1 : \ + IS_ARTWORKCLASS_CONTRIB(n) ? 2 : \ + IS_ARTWORKCLASS_PRIVATE(n) ? 3 : \ + 9) + +#define TOKEN_VALUE_POSITION_SHORT 32 +#define TOKEN_VALUE_POSITION_DEFAULT 40 +#define TOKEN_COMMENT_POSITION_DEFAULT 60 + +#define MAX_COOKIE_LEN 256 + + +static void setTreeInfoToDefaults(TreeInfo *, int); +static TreeInfo *getTreeInfoCopy(TreeInfo *ti); +static int compareTreeInfoEntries(const void *, const void *); + +static int token_value_position = TOKEN_VALUE_POSITION_DEFAULT; +static int token_comment_position = TOKEN_COMMENT_POSITION_DEFAULT; -#define MAX_COOKIE_LEN 256 +static SetupFileHash *artworkinfo_cache_old = NULL; +static SetupFileHash *artworkinfo_cache_new = NULL; +static boolean use_artworkinfo_cache = TRUE; /* ------------------------------------------------------------------------- */ /* file functions */ /* ------------------------------------------------------------------------- */ -static char *getLevelClassDescription(TreeInfo *ldi) +static char *getLevelClassDescription(TreeInfo *ti) { - int position = ldi->sort_priority / 100; + int position = ti->sort_priority / 100; if (position >= 0 && position < NUM_LEVELCLASS_DESC) return levelclass_desc[position]; @@ -102,11 +116,10 @@ static char *getLevelClassDescription(TreeInfo *ldi) static char *getUserLevelDir(char *level_subdir) { static char *userlevel_dir = NULL; - char *data_dir = getUserDataDir(); + char *data_dir = getUserGameDataDir(); char *userlevel_subdir = LEVELS_DIRECTORY; - if (userlevel_dir) - free(userlevel_dir); + checked_free(userlevel_dir); if (level_subdir != NULL) userlevel_dir = getPath3(data_dir, userlevel_subdir, level_subdir); @@ -116,31 +129,13 @@ static char *getUserLevelDir(char *level_subdir) return userlevel_dir; } -static char *getTapeDir(char *level_subdir) -{ - static char *tape_dir = NULL; - char *data_dir = getUserDataDir(); - char *tape_subdir = TAPES_DIRECTORY; - - if (tape_dir) - free(tape_dir); - - if (level_subdir != NULL) - tape_dir = getPath3(data_dir, tape_subdir, level_subdir); - else - tape_dir = getPath2(data_dir, tape_subdir); - - return tape_dir; -} - 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); + checked_free(score_dir); if (level_subdir != NULL) score_dir = getPath3(data_dir, score_subdir, level_subdir); @@ -153,11 +148,10 @@ static char *getScoreDir(char *level_subdir) static char *getLevelSetupDir(char *level_subdir) { static char *levelsetup_dir = NULL; - char *data_dir = getUserDataDir(); + char *data_dir = getUserGameDataDir(); char *levelsetup_subdir = LEVELSETUP_DIRECTORY; - if (levelsetup_dir) - free(levelsetup_dir); + checked_free(levelsetup_dir); if (level_subdir != NULL) levelsetup_dir = getPath3(data_dir, levelsetup_subdir, level_subdir); @@ -167,23 +161,65 @@ static char *getLevelSetupDir(char *level_subdir) return levelsetup_dir; } -static char *getCurrentLevelDir() +static char *getCacheDir() { - static char *level_dir = NULL; + static char *cache_dir = NULL; - if (level_dir) - free(level_dir); + if (cache_dir == NULL) + cache_dir = getPath2(getUserGameDataDir(), CACHE_DIRECTORY); - if (leveldir_current == NULL) + return cache_dir; +} + +static char *getLevelDirFromTreeInfo(TreeInfo *node) +{ + static char *level_dir = NULL; + + if (node == NULL) return options.level_directory; - level_dir = getPath2((leveldir_current->user_defined ? - getUserLevelDir(NULL) : options.level_directory), - leveldir_current->fullpath); + checked_free(level_dir); + + level_dir = getPath2((node->in_user_dir ? getUserLevelDir(NULL) : + options.level_directory), node->fullpath); return level_dir; } +char *getCurrentLevelDir() +{ + return getLevelDirFromTreeInfo(leveldir_current); +} + +static char *getTapeDir(char *level_subdir) +{ + static char *tape_dir = NULL; + char *data_dir = getUserGameDataDir(); + char *tape_subdir = TAPES_DIRECTORY; + + checked_free(tape_dir); + + if (level_subdir != NULL) + tape_dir = getPath3(data_dir, tape_subdir, level_subdir); + else + tape_dir = getPath2(data_dir, tape_subdir); + + return tape_dir; +} + +static char *getSolutionTapeDir() +{ + static char *tape_dir = NULL; + char *data_dir = getCurrentLevelDir(); + char *tape_subdir = TAPES_DIRECTORY; + + checked_free(tape_dir); + + tape_dir = getPath2(data_dir, tape_subdir); + + return tape_dir; +} + static char *getDefaultGraphicsDir(char *graphics_subdir) { static char *graphics_dir = NULL; @@ -191,8 +227,7 @@ static char *getDefaultGraphicsDir(char *graphics_subdir) if (graphics_subdir == NULL) return options.graphics_directory; - if (graphics_dir) - free(graphics_dir); + checked_free(graphics_dir); graphics_dir = getPath2(options.graphics_directory, graphics_subdir); @@ -206,8 +241,7 @@ static char *getDefaultSoundsDir(char *sounds_subdir) if (sounds_subdir == NULL) return options.sounds_directory; - if (sounds_dir) - free(sounds_dir); + checked_free(sounds_dir); sounds_dir = getPath2(options.sounds_directory, sounds_subdir); @@ -221,20 +255,36 @@ static char *getDefaultMusicDir(char *music_subdir) if (music_subdir == NULL) return options.music_directory; - if (music_dir) - free(music_dir); + checked_free(music_dir); music_dir = getPath2(options.music_directory, music_subdir); return music_dir; } +static char *getDefaultArtworkSet(int type) +{ + return (type == TREE_TYPE_GRAPHICS_DIR ? GFX_CLASSIC_SUBDIR : + type == TREE_TYPE_SOUNDS_DIR ? SND_CLASSIC_SUBDIR : + type == TREE_TYPE_MUSIC_DIR ? MUS_CLASSIC_SUBDIR : ""); +} + +static char *getDefaultArtworkDir(int type) +{ + return (type == TREE_TYPE_GRAPHICS_DIR ? + getDefaultGraphicsDir(GFX_CLASSIC_SUBDIR) : + type == TREE_TYPE_SOUNDS_DIR ? + getDefaultSoundsDir(SND_CLASSIC_SUBDIR) : + type == TREE_TYPE_MUSIC_DIR ? + getDefaultMusicDir(MUS_CLASSIC_SUBDIR) : ""); +} + static char *getUserGraphicsDir() { static char *usergraphics_dir = NULL; if (usergraphics_dir == NULL) - usergraphics_dir = getPath2(getUserDataDir(), GRAPHICS_DIRECTORY); + usergraphics_dir = getPath2(getUserGameDataDir(), GRAPHICS_DIRECTORY); return usergraphics_dir; } @@ -244,7 +294,7 @@ static char *getUserSoundsDir() static char *usersounds_dir = NULL; if (usersounds_dir == NULL) - usersounds_dir = getPath2(getUserDataDir(), SOUNDS_DIRECTORY); + usersounds_dir = getPath2(getUserGameDataDir(), SOUNDS_DIRECTORY); return usersounds_dir; } @@ -254,35 +304,105 @@ static char *getUserMusicDir() static char *usermusic_dir = NULL; if (usermusic_dir == NULL) - usermusic_dir = getPath2(getUserDataDir(), MUSIC_DIRECTORY); + usermusic_dir = getPath2(getUserGameDataDir(), MUSIC_DIRECTORY); return usermusic_dir; } -char *getLevelFilename(int nr) +static char *getSetupArtworkDir(TreeInfo *ti) +{ + static char *artwork_dir = NULL; + + checked_free(artwork_dir); + + artwork_dir = getPath2(ti->basepath, ti->fullpath); + + return artwork_dir; +} + +char *setLevelArtworkDir(TreeInfo *ti) +{ + char **artwork_path_ptr, **artwork_set_ptr; + TreeInfo *level_artwork; + + if (ti == NULL || leveldir_current == NULL) + return NULL; + + artwork_path_ptr = LEVELDIR_ARTWORK_PATH_PTR(leveldir_current, ti->type); + artwork_set_ptr = LEVELDIR_ARTWORK_SET_PTR( leveldir_current, ti->type); + + checked_free(*artwork_path_ptr); + + if ((level_artwork = getTreeInfoFromIdentifier(ti, *artwork_set_ptr))) + *artwork_path_ptr = getStringCopy(getSetupArtworkDir(level_artwork)); + else + { + /* No (or non-existing) artwork configured in "levelinfo.conf". This would + normally result in using the artwork configured in the setup menu. But + if an artwork subdirectory exists (which might contain custom artwork + or an artwork configuration file), this level artwork must be treated + as relative to the default "classic" artwork, not to the artwork that + is currently configured in the setup menu. */ + + char *dir = getPath2(getCurrentLevelDir(), ARTWORK_DIRECTORY(ti->type)); + + checked_free(*artwork_set_ptr); + + if (fileExists(dir)) + { + *artwork_path_ptr = getStringCopy(getDefaultArtworkDir(ti->type)); + *artwork_set_ptr = getStringCopy(getDefaultArtworkSet(ti->type)); + } + else + { + *artwork_path_ptr = getStringCopy(UNDEFINED_FILENAME); + *artwork_set_ptr = NULL; + } + + free(dir); + } + + return *artwork_set_ptr; +} + +inline static char *getLevelArtworkSet(int type) +{ + if (leveldir_current == NULL) + return NULL; + + return LEVELDIR_ARTWORK_SET(leveldir_current, type); +} + +inline static char *getLevelArtworkDir(int type) +{ + if (leveldir_current == NULL) + return UNDEFINED_FILENAME; + + return LEVELDIR_ARTWORK_PATH(leveldir_current, type); +} + +char *getTapeFilename(int nr) { static char *filename = NULL; char basename[MAX_FILENAME_LEN]; - if (filename != NULL) - free(filename); + checked_free(filename); - sprintf(basename, "%03d.%s", nr, LEVELFILE_EXTENSION); - filename = getPath2(getCurrentLevelDir(), basename); + sprintf(basename, "%03d.%s", nr, TAPEFILE_EXTENSION); + filename = getPath2(getTapeDir(leveldir_current->subdir), basename); return filename; } -char *getTapeFilename(int nr) +char *getSolutionTapeFilename(int nr) { static char *filename = NULL; char basename[MAX_FILENAME_LEN]; - if (filename != NULL) - free(filename); + checked_free(filename); sprintf(basename, "%03d.%s", nr, TAPEFILE_EXTENSION); - filename = getPath2(getTapeDir(leveldir_current->filename), basename); + filename = getPath2(getSolutionTapeDir(), basename); return filename; } @@ -292,11 +412,10 @@ char *getScoreFilename(int nr) static char *filename = NULL; char basename[MAX_FILENAME_LEN]; - if (filename != NULL) - free(filename); + checked_free(filename); sprintf(basename, "%03d.%s", nr, SCOREFILE_EXTENSION); - filename = getPath2(getScoreDir(leveldir_current->filename), basename); + filename = getPath2(getScoreDir(leveldir_current->subdir), basename); return filename; } @@ -305,29 +424,112 @@ char *getSetupFilename() { static char *filename = NULL; - if (filename != NULL) - free(filename); + checked_free(filename); filename = getPath2(getSetupDir(), SETUP_FILENAME); return filename; } -static char *getSetupArtworkDir(TreeInfo *ti) +char *getEditorSetupFilename() { - static char *artwork_dir = NULL; + static char *filename = NULL; - if (artwork_dir != NULL) - free(artwork_dir); + checked_free(filename); + filename = getPath2(getCurrentLevelDir(), EDITORSETUP_FILENAME); - artwork_dir = getPath2(ti->basepath, ti->fullpath); + if (fileExists(filename)) + return filename; - return artwork_dir; + checked_free(filename); + filename = getPath2(getSetupDir(), EDITORSETUP_FILENAME); + + return filename; +} + +char *getHelpAnimFilename() +{ + static char *filename = NULL; + + checked_free(filename); + + filename = getPath2(getCurrentLevelDir(), HELPANIM_FILENAME); + + return filename; +} + +char *getHelpTextFilename() +{ + static char *filename = NULL; + + checked_free(filename); + + filename = getPath2(getCurrentLevelDir(), HELPTEXT_FILENAME); + + return filename; +} + +char *getLevelSetInfoFilename() +{ + static char *filename = NULL; + char *basenames[] = + { + "README", + "README.TXT", + "README.txt", + "Readme", + "Readme.txt", + "readme", + "readme.txt", + + NULL + }; + int i; + + for (i = 0; basenames[i] != NULL; i++) + { + checked_free(filename); + filename = getPath2(getCurrentLevelDir(), basenames[i]); + + if (fileExists(filename)) + return filename; + } + + return NULL; +} + +char *getLevelSetMessageFilename() +{ + static char *filename = NULL; + char *basenames[] = + { + "MESSAGE", + "MESSAGE.TXT", + "MESSAGE.txt", + "Message", + "Message.txt", + "message", + "message.txt", + + NULL + }; + int i; + + for (i = 0; basenames[i] != NULL; i++) + { + checked_free(filename); + filename = getPath2(getCurrentLevelDir(), basenames[i]); + + if (fileExists(filename)) + return filename; + } + + return NULL; } -static char *getCorrectedImageBasename(char *basename) +static char *getCorrectedArtworkBasename(char *basename) { - char *result = basename; + char *basename_corrected = basename; #if defined(PLATFORM_MSDOS) if (program.filename_prefix != NULL) @@ -335,143 +537,296 @@ static char *getCorrectedImageBasename(char *basename) int prefix_len = strlen(program.filename_prefix); if (strncmp(basename, program.filename_prefix, prefix_len) == 0) - result = &basename[prefix_len]; - } -#endif + basename_corrected = &basename[prefix_len]; - return result; -} + /* 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; -static boolean fileExists(char *filename) -{ -#if 0 - printf("checking file '%s'\n", filename); + checked_free(msdos_filename); + + msdos_filename = getStringCopy(basename_corrected); + strncpy(&msdos_filename[8], &basename[strlen(basename) - (1+3)], 1+3 +1); + + basename_corrected = msdos_filename; + } + } #endif - return (access(filename, F_OK) == 0); + return basename_corrected; } char *getCustomImageFilename(char *basename) { static char *filename = NULL; + boolean skip_setup_artwork = FALSE; + + checked_free(filename); + + basename = getCorrectedArtworkBasename(basename); + + if (!setup.override_level_graphics) + { + /* 1st try: look for special artwork in current level series directory */ + filename = getPath3(getCurrentLevelDir(), GRAPHICS_DIRECTORY, basename); + if (fileExists(filename)) + return filename; - if (filename != NULL) free(filename); - basename = getCorrectedImageBasename(basename); + /* check if there is special artwork configured in level series config */ + if (getLevelArtworkSet(ARTWORK_TYPE_GRAPHICS) != NULL) + { + /* 2nd try: look for special artwork configured in level series config */ + filename = getPath2(getLevelArtworkDir(ARTWORK_TYPE_GRAPHICS), basename); + if (fileExists(filename)) + return filename; - /* 1st try: look for special artwork in current level series directory */ - filename = getPath3(getCurrentLevelDir(), GRAPHICS_DIRECTORY, basename); - if (fileExists(filename)) - return filename; + free(filename); - /* 2nd try: look for special artwork in private artwork directory */ - filename = getPath2(getUserGraphicsDir(), basename); - if (fileExists(filename)) - return filename; + /* take missing artwork configured in level set config from default */ + skip_setup_artwork = TRUE; + } + } - /* 3rd try: look for special artwork in configured artwork directory */ - filename = getPath2(getSetupArtworkDir(artwork.gfx_current), basename); - if (fileExists(filename)) - return filename; + if (!skip_setup_artwork) + { + /* 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); + filename = getPath2(getDefaultGraphicsDir(GFX_CLASSIC_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 image file */ + return NULL; /* cannot find specified artwork file anywhere */ } char *getCustomSoundFilename(char *basename) { static char *filename = NULL; + boolean skip_setup_artwork = FALSE; + + checked_free(filename); + + basename = getCorrectedArtworkBasename(basename); + + if (!setup.override_level_sounds) + { + /* 1st try: look for special artwork in current level series directory */ + filename = getPath3(getCurrentLevelDir(), SOUNDS_DIRECTORY, basename); + if (fileExists(filename)) + return filename; - if (filename != NULL) free(filename); - /* 1st try: look for special artwork in current level series directory */ - filename = getPath3(getCurrentLevelDir(), SOUNDS_DIRECTORY, basename); - if (fileExists(filename)) - return filename; + /* check if there is special artwork configured in level series config */ + if (getLevelArtworkSet(ARTWORK_TYPE_SOUNDS) != NULL) + { + /* 2nd try: look for special artwork configured in level series config */ + filename = getPath2(getLevelArtworkDir(TREE_TYPE_SOUNDS_DIR), basename); + if (fileExists(filename)) + return filename; - /* 2nd try: look for special artwork in private artwork directory */ - filename = getPath2(getUserSoundsDir(), basename); - if (fileExists(filename)) - return filename; + free(filename); - /* 3rd try: look for special artwork in configured artwork directory */ - filename = getPath2(getSetupArtworkDir(artwork.snd_current), basename); - if (fileExists(filename)) - return filename; + /* take missing artwork configured in level set config from default */ + skip_setup_artwork = TRUE; + } + } + + if (!skip_setup_artwork) + { + /* 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); + filename = getPath2(getDefaultSoundsDir(SND_CLASSIC_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 image file */ + return NULL; /* cannot find specified artwork file anywhere */ } -char *getCustomSoundConfigFilename() +char *getCustomMusicFilename(char *basename) { - return getCustomSoundFilename(SOUNDSINFO_FILENAME); -} + static char *filename = NULL; + boolean skip_setup_artwork = FALSE; -char *getCustomMusicDirectory(void) -{ - static char *directory = NULL; + checked_free(filename); - if (directory != NULL) - free(directory); + basename = getCorrectedArtworkBasename(basename); - /* 1st try: look for special artwork in current level series directory */ - directory = getPath2(getCurrentLevelDir(), MUSIC_DIRECTORY); - if (fileExists(directory)) - return directory; + if (!setup.override_level_music) + { + /* 1st try: look for special artwork in current level series directory */ + filename = getPath3(getCurrentLevelDir(), MUSIC_DIRECTORY, basename); + if (fileExists(filename)) + return filename; - /* 2nd try: look for special artwork in private artwork directory */ - directory = getStringCopy(getUserMusicDir()); - if (fileExists(directory)) - return directory; + free(filename); - /* 3rd try: look for special artwork in configured artwork directory */ - directory = getStringCopy(getSetupArtworkDir(artwork.mus_current)); - if (fileExists(directory)) - return directory; + /* check if there is special artwork configured in level series config */ + if (getLevelArtworkSet(ARTWORK_TYPE_MUSIC) != NULL) + { + /* 2nd try: look for special artwork configured in level series config */ + filename = getPath2(getLevelArtworkDir(TREE_TYPE_MUSIC_DIR), basename); + if (fileExists(filename)) + return filename; - /* 4th try: look for default artwork in new default artwork directory */ - directory = getStringCopy(getDefaultMusicDir(MUSIC_SUBDIR)); - if (fileExists(directory)) - return directory; + free(filename); - /* 5th try: look for default artwork in old default artwork directory */ - directory = getStringCopy(options.music_directory); - if (fileExists(directory)) - return directory; + /* take missing artwork configured in level set config from default */ + skip_setup_artwork = TRUE; + } + } - return NULL; /* cannot find image file */ -} + if (!skip_setup_artwork) + { + /* 3rd try: look for special artwork in configured artwork directory */ + filename = getPath2(getSetupArtworkDir(artwork.mus_current), basename); + if (fileExists(filename)) + return filename; -void InitTapeDirectory(char *level_subdir) -{ - createDirectory(getUserDataDir(), "user data", PERMS_PRIVATE); - createDirectory(getTapeDir(NULL), "main tape", PERMS_PRIVATE); - createDirectory(getTapeDir(level_subdir), "level tape", PERMS_PRIVATE); -} + free(filename); + } + + /* 4th try: look for default artwork in new default artwork directory */ + filename = getPath2(getDefaultMusicDir(MUS_CLASSIC_SUBDIR), basename); + if (fileExists(filename)) + return filename; + + free(filename); + + /* 5th try: look for default artwork in old default artwork directory */ + filename = getPath2(options.music_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 if (type == ARTWORK_TYPE_MUSIC) + return getCustomMusicFilename(basename); + else + return UNDEFINED_FILENAME; +} + +char *getCustomArtworkConfigFilename(int type) +{ + return getCustomArtworkFilename(ARTWORKINFO_FILENAME(type), type); +} + +char *getCustomArtworkLevelConfigFilename(int type) +{ + static char *filename = NULL; + + checked_free(filename); + + filename = getPath2(getLevelArtworkDir(type), ARTWORKINFO_FILENAME(type)); + + return filename; +} + +char *getCustomMusicDirectory(void) +{ + static char *directory = NULL; + boolean skip_setup_artwork = FALSE; + + checked_free(directory); + + if (!setup.override_level_music) + { + /* 1st try: look for special artwork in current level series directory */ + directory = getPath2(getCurrentLevelDir(), MUSIC_DIRECTORY); + if (fileExists(directory)) + return directory; + + free(directory); + + /* check if there is special artwork configured in level series config */ + if (getLevelArtworkSet(ARTWORK_TYPE_MUSIC) != NULL) + { + /* 2nd try: look for special artwork configured in level series config */ + directory = getStringCopy(getLevelArtworkDir(TREE_TYPE_MUSIC_DIR)); + if (fileExists(directory)) + return directory; + + free(directory); + + /* take missing artwork configured in level set config from default */ + skip_setup_artwork = TRUE; + } + } + + if (!skip_setup_artwork) + { + /* 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(MUS_CLASSIC_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(getUserGameDataDir(), "user data", PERMS_PRIVATE); + createDirectory(getTapeDir(NULL), "main tape", PERMS_PRIVATE); + createDirectory(getTapeDir(level_subdir), "level tape", PERMS_PRIVATE); +} void InitScoreDirectory(char *level_subdir) { + createDirectory(getCommonDataDir(), "common data", PERMS_PUBLIC); createDirectory(getScoreDir(NULL), "main score", PERMS_PUBLIC); createDirectory(getScoreDir(level_subdir), "level score", PERMS_PUBLIC); } @@ -480,11 +835,11 @@ static void SaveUserLevelInfo(); void InitUserLevelDirectory(char *level_subdir) { - if (access(getUserLevelDir(level_subdir), F_OK) != 0) + if (!fileExists(getUserLevelDir(level_subdir))) { - createDirectory(getUserDataDir(), "user data", PERMS_PRIVATE); + createDirectory(getUserGameDataDir(), "user data", PERMS_PRIVATE); createDirectory(getUserLevelDir(NULL), "main user level", PERMS_PRIVATE); - createDirectory(getUserLevelDir(level_subdir), "user level",PERMS_PRIVATE); + createDirectory(getUserLevelDir(level_subdir), "user level", PERMS_PRIVATE); SaveUserLevelInfo(); } @@ -492,58 +847,20 @@ void InitUserLevelDirectory(char *level_subdir) void InitLevelSetupDirectory(char *level_subdir) { - createDirectory(getUserDataDir(), "user data", PERMS_PRIVATE); + createDirectory(getUserGameDataDir(), "user data", PERMS_PRIVATE); createDirectory(getLevelSetupDir(NULL), "main level setup", PERMS_PRIVATE); - createDirectory(getLevelSetupDir(level_subdir), "level setup",PERMS_PRIVATE); + createDirectory(getLevelSetupDir(level_subdir), "level setup", PERMS_PRIVATE); } -void ReadChunk_VERS(FILE *file, int *file_version, int *game_version) +void InitCacheDirectory() { - 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 */ + createDirectory(getUserGameDataDir(), "user data", PERMS_PRIVATE); + createDirectory(getCacheDir(), "cache data", PERMS_PRIVATE); } /* ------------------------------------------------------------------------- */ -/* some functions to handle lists of level directories */ +/* some functions to handle lists of level and artwork directories */ /* ------------------------------------------------------------------------- */ TreeInfo *newTreeInfo() @@ -551,6 +868,15 @@ TreeInfo *newTreeInfo() return checked_calloc(sizeof(TreeInfo)); } +TreeInfo *newTreeInfo_setDefaults(int type) +{ + TreeInfo *ti = newTreeInfo(); + + setTreeInfoToDefaults(ti, type); + + return ti; +} + void pushTreeInfo(TreeInfo **node_first, TreeInfo *node_new) { node_new->next = *node_first; @@ -578,13 +904,9 @@ boolean validLevelSeries(TreeInfo *node) TreeInfo *getFirstValidTreeInfoEntry(TreeInfo *node) { if (node == NULL) - { - if (node->node_top) /* start with first tree entry */ - return getFirstValidTreeInfoEntry(*node->node_top); - else - return NULL; - } - else if (node->node_group) /* enter level group (step down into tree) */ + 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 */ { @@ -647,9 +969,9 @@ TreeInfo *getTreeInfoFromPos(TreeInfo *node, int pos) return node_default; } -TreeInfo *getTreeInfoFromFilenameExt(TreeInfo *node, char *filename) +TreeInfo *getTreeInfoFromIdentifier(TreeInfo *node, char *identifier) { - if (filename == NULL) + if (identifier == NULL) return NULL; while (node) @@ -658,14 +980,14 @@ TreeInfo *getTreeInfoFromFilenameExt(TreeInfo *node, char *filename) { TreeInfo *node_group; - node_group = getTreeInfoFromFilenameExt(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 (strEqual(identifier, node->identifier)) return node; } @@ -675,9 +997,73 @@ TreeInfo *getTreeInfoFromFilenameExt(TreeInfo *node, char *filename) return NULL; } -TreeInfo *getTreeInfoFromFilename(TreeInfo *ti, char *filename) +TreeInfo *cloneTreeNode(TreeInfo **node_top, TreeInfo *node_parent, + TreeInfo *node, boolean skip_sets_without_levels) { - return getTreeInfoFromFilenameExt(ti, filename); + TreeInfo *node_new; + + if (node == NULL) + return NULL; + + if (!node->parent_link && !node->level_group && + skip_sets_without_levels && node->levels == 0) + return cloneTreeNode(node_top, node_parent, node->next, + skip_sets_without_levels); + +#if 1 + node_new = getTreeInfoCopy(node); /* copy complete node */ +#else + node_new = newTreeInfo(); + + *node_new = *node; /* copy complete node */ +#endif + + node_new->node_top = node_top; /* correct top node link */ + node_new->node_parent = node_parent; /* correct parent node link */ + + if (node->level_group) + node_new->node_group = cloneTreeNode(node_top, node_new, node->node_group, + skip_sets_without_levels); + + node_new->next = cloneTreeNode(node_top, node_parent, node->next, + skip_sets_without_levels); + + return node_new; +} + +void cloneTree(TreeInfo **ti_new, TreeInfo *ti, boolean skip_empty_sets) +{ + TreeInfo *ti_cloned = cloneTreeNode(ti_new, NULL, ti, skip_empty_sets); + + *ti_new = ti_cloned; +} + +static boolean adjustTreeGraphicsForEMC(TreeInfo *node) +{ + boolean settings_changed = FALSE; + + while (node) + { + if (node->graphics_set_ecs && !setup.prefer_aga_graphics && + !strEqual(node->graphics_set, node->graphics_set_ecs)) + { + setString(&node->graphics_set, node->graphics_set_ecs); + settings_changed = TRUE; + } + else if (node->graphics_set_aga && setup.prefer_aga_graphics && + !strEqual(node->graphics_set, node->graphics_set_aga)) + { + setString(&node->graphics_set, node->graphics_set_aga); + settings_changed = TRUE; + } + + if (node->node_group != NULL) + settings_changed |= adjustTreeGraphicsForEMC(node->node_group); + + node = node->next; + } + + return settings_changed; } void dumpTreeInfo(TreeInfo *node, int depth) @@ -688,10 +1074,11 @@ void dumpTreeInfo(TreeInfo *node, int depth) while (node) { - for (i=0; i<(depth + 1) * 3; i++) + for (i = 0; i < (depth + 1) * 3; i++) printf(" "); - printf("filename == '%s' [%s]\n", node->filename, node->name); + printf("subdir == '%s' ['%s', '%s'] [%d])\n", + node->subdir, node->fullpath, node->basepath, node->in_user_dir); if (node->node_group != NULL) dumpTreeInfo(node->node_group, depth + 1); @@ -700,8 +1087,9 @@ void dumpTreeInfo(TreeInfo *node, int depth) } } -void sortTreeInfo(TreeInfo **node_first, - int (*compare_function)(const void *, const void *)) +void sortTreeInfoBySortFunction(TreeInfo **node_first, + int (*compare_function)(const void *, + const void *)) { int num_nodes = numTreeInfo(*node_first); TreeInfo **sort_array; @@ -728,7 +1116,7 @@ void sortTreeInfo(TreeInfo **node_first, compare_function); /* 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; @@ -742,12 +1130,17 @@ void sortTreeInfo(TreeInfo **node_first, while (node) { if (node->node_group != NULL) - sortTreeInfo(&node->node_group, compare_function); + sortTreeInfoBySortFunction(&node->node_group, compare_function); node = node->next; } } +void sortTreeInfo(TreeInfo **node_first) +{ + sortTreeInfoBySortFunction(node_first, compareTreeInfoEntries); +} + /* ========================================================================= */ /* some stuff from "files.c" */ @@ -795,24 +1188,114 @@ void sortTreeInfo(TreeInfo **node_first, #define FILE_PERMS_PRIVATE (MODE_R_ALL | MODE_W_PRIVATE) #define FILE_PERMS_PUBLIC (MODE_R_ALL | MODE_W_PUBLIC) -char *getUserDataDir(void) +char *getHomeDir() { - static char *userdata_dir = NULL; + static char *dir = NULL; - if (!userdata_dir) +#if defined(PLATFORM_WIN32) + if (dir == NULL) + { + dir = checked_malloc(MAX_PATH + 1); + + if (!SUCCEEDED(SHGetFolderPath(NULL, CSIDL_PERSONAL, NULL, 0, dir))) + strcpy(dir, "."); + } +#elif defined(PLATFORM_UNIX) + if (dir == NULL) + { + if ((dir = getenv("HOME")) == NULL) + { + struct passwd *pwd; + + if ((pwd = getpwuid(getuid())) != NULL) + dir = getStringCopy(pwd->pw_dir); + else + dir = "."; + } + } +#else + dir = "."; +#endif + + return 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)) + && !strEqual(dir, "")) /* empty for Windows 95/98 */ + common_data_dir = getPath2(dir, program.userdata_subdir); + 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 *getPersonalDataDir(void) +{ + static char *personal_data_dir = NULL; + +#if defined(PLATFORM_MACOSX) + if (personal_data_dir == NULL) + personal_data_dir = getPath2(getHomeDir(), "Documents"); +#else + if (personal_data_dir == NULL) + personal_data_dir = getHomeDir(); +#endif + + return personal_data_dir; +} + +char *getUserGameDataDir(void) +{ + static char *user_game_data_dir = NULL; + + if (user_game_data_dir == NULL) + user_game_data_dir = getPath2(getPersonalDataDir(), + program.userdata_subdir); + + return user_game_data_dir; +} + +void updateUserGameDataDir() +{ +#if defined(PLATFORM_MACOSX) + char *userdata_dir_old = getPath2(getHomeDir(), program.userdata_subdir_unix); + char *userdata_dir_new = getUserGameDataDir(); /* do not free() this */ + + /* convert old Unix style game data directory to Mac OS X style, if needed */ + if (fileExists(userdata_dir_old) && !fileExists(userdata_dir_new)) + { + if (rename(userdata_dir_old, userdata_dir_new) != 0) + { + Error(ERR_WARN, "cannot move game data directory '%s' to '%s'", + userdata_dir_old, userdata_dir_new); + + /* continue using Unix style data directory -- this should not happen */ + program.userdata_path = getPath2(getPersonalDataDir(), + program.userdata_subdir_unix); + } + } + + free(userdata_dir_old); +#endif } char *getSetupDir() { - return getUserDataDir(); + return getUserGameDataDir(); } static mode_t posix_umask(mode_t mask) @@ -843,7 +1326,7 @@ void createDirectory(char *dir, char *text, int permission_class) mode_t group_umask = ~(dir_mode & S_IRWXG); posix_umask(normal_umask & group_umask); - if (access(dir, F_OK) != 0) + if (!fileExists(dir)) if (posix_mkdir(dir, dir_mode) != 0) Error(ERR_WARN, "cannot create %s directory '%s'", text, dir); @@ -852,7 +1335,7 @@ void createDirectory(char *dir, char *text, int permission_class) void InitUserDataDirectory() { - createDirectory(getUserDataDir(), "user data", PERMS_PRIVATE); + createDirectory(getUserGameDataDir(), "user data", PERMS_PRIVATE); } void SetFilePermissions(char *filename, int permission_class) @@ -904,7 +1387,7 @@ int getFileVersionFromCookieString(const char *cookie) version_major = ptr_cookie2[0] - '0'; version_minor = ptr_cookie2[2] - '0'; - return VERSION_IDENT(version_major, version_minor, 0); + return VERSION_IDENT(version_major, version_minor, 0, 0); } boolean checkCookieString(const char *cookie, const char *template) @@ -924,173 +1407,280 @@ 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) -{ - static char *number_text[][3] = - { - { "0", "zero", "null", }, - { "1", "one", "first" }, - { "2", "two", "second" }, - { "3", "three", "third" }, - { "4", "four", "fourth" }, - { "5", "five", "fifth" }, - { "6", "six", "sixth" }, - { "7", "seven", "seventh" }, - { "8", "eight", "eighth" }, - { "9", "nine", "ninth" }, - { "10", "ten", "tenth" }, - { "11", "eleven", "eleventh" }, - { "12", "twelve", "twelfth" }, - }; - - int i, j; - char *s_lower = getStringToLower(s); - int result = -1; +char *getFormattedSetupEntry(char *token, char *value) +{ + int i; + static char entry[MAX_LINE_LEN]; - for (i=0; i<13; i++) - for (j=0; j<3; j++) - if (strcmp(s_lower, number_text[i][j]) == 0) - result = i; + /* if value is an empty string, just return token without value */ + if (*value == '\0') + return token; - if (result == -1) - result = atoi(s); + /* start with the token and some spaces to format output line */ + sprintf(entry, "%s:", token); + for (i = strlen(entry); i < token_value_position; i++) + strcat(entry, " "); - free(s_lower); + /* continue with the token's value */ + strcat(entry, value); - return result; + return entry; } -boolean get_string_boolean_value(char *s) +SetupFileList *newSetupFileList(char *token, char *value) { - char *s_lower = getStringToLower(s); - boolean result = FALSE; + SetupFileList *new = checked_malloc(sizeof(SetupFileList)); - if (strcmp(s_lower, "true") == 0 || - strcmp(s_lower, "yes") == 0 || - strcmp(s_lower, "on") == 0 || - get_string_integer_value(s) == 1) - result = TRUE; + new->token = getStringCopy(token); + new->value = getStringCopy(value); - free(s_lower); + new->next = NULL; - return result; + return new; } -char *getFormattedSetupEntry(char *token, char *value) +void freeSetupFileList(SetupFileList *list) { - int i; - static char entry[MAX_LINE_LEN]; + if (list == NULL) + return; - sprintf(entry, "%s:", token); - for (i=strlen(entry); itoken); + checked_free(list->value); - strcat(entry, value); + if (list->next) + freeSetupFileList(list->next); - return entry; + free(list); } -void freeSetupFileList(struct SetupFileList *setup_file_list) +char *getListEntry(SetupFileList *list, char *token) { - if (!setup_file_list) - return; + if (list == NULL) + return NULL; - 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); + if (strEqual(list->token, token)) + return list->value; + else + return getListEntry(list->next, token); } -static struct SetupFileList *newSetupFileList(char *token, char *value) +SetupFileList *setListEntry(SetupFileList *list, char *token, char *value) { - struct SetupFileList *new = checked_malloc(sizeof(struct SetupFileList)); - - new->token = checked_malloc(strlen(token) + 1); - strcpy(new->token, token); + if (list == NULL) + return NULL; - new->value = checked_malloc(strlen(value) + 1); - strcpy(new->value, value); + if (strEqual(list->token, token)) + { + checked_free(list->value); - new->next = NULL; + list->value = getStringCopy(value); - return new; + return list; + } + else if (list->next == NULL) + return (list->next = newSetupFileList(token, value)); + else + return setListEntry(list->next, token, value); } -char *getTokenValue(struct SetupFileList *setup_file_list, char *token) +SetupFileList *addListEntry(SetupFileList *list, char *token, char *value) { - if (!setup_file_list) + if (list == NULL) return NULL; - if (strcmp(setup_file_list->token, token) == 0) - return setup_file_list->value; + if (list->next == NULL) + return (list->next = newSetupFileList(token, value)); else - return getTokenValue(setup_file_list->next, token); + return addListEntry(list->next, token, value); } -static void setTokenValue(struct SetupFileList *setup_file_list, - char *token, char *value) +#ifdef DEBUG +static void printSetupFileList(SetupFileList *list) { - if (!setup_file_list) + if (!list) 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); + printf("token: '%s'\n", list->token); + printf("value: '%s'\n", list->value); + + printSetupFileList(list->next); } +#endif #ifdef DEBUG -static void printSetupFileList(struct SetupFileList *setup_file_list) +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) { - if (!setup_file_list) + /* + 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 (strEqual((char *)key1, (char *)key2)); +} + +SetupFileHash *newSetupFileHash() +{ + SetupFileHash *new_hash = + create_hashtable(16, 0.75, get_hash_from_key, keys_are_equal); + + if (new_hash == NULL) + Error(ERR_EXIT, "create_hashtable() failed -- out of memory"); + + return new_hash; +} + +void freeSetupFileHash(SetupFileHash *hash) +{ + if (hash == NULL) return; - printf("token: '%s'\n", setup_file_list->token); - printf("value: '%s'\n", setup_file_list->value); + 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"); +} + +char *removeHashEntry(SetupFileHash *hash, char *token) +{ + if (hash == NULL) + return NULL; + + return remove_hash_entry(hash, token); +} - printSetupFileList(setup_file_list->next); +#if 0 +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 -struct SetupFileList *loadSetupFileList(char *filename) +static void *loadSetupFileData(char *filename, boolean use_hash) { - int line_len; - char line[MAX_LINE_LEN]; + char line[MAX_LINE_LEN], previous_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, *insert_ptr = NULL; + boolean read_continued_line = FALSE; FILE *file; if (!(file = fopen(filename, MODE_READ))) { Error(ERR_WARN, "cannot open configuration file '%s'", filename); + return NULL; } - while(!feof(file)) + if (use_hash) + setup_file_data = newSetupFileHash(); + else + insert_ptr = setup_file_data = newSetupFileList("", ""); + + while (!feof(file)) { /* read next line of input file */ if (!fgets(line, MAX_LINE_LEN, file)) break; - /* cut trailing comment or whitespace from input line */ + /* cut trailing newline or carriage return */ + for (line_ptr = &line[strlen(line)]; line_ptr >= line; line_ptr--) + if ((*line_ptr == '\n' || *line_ptr == '\r') && *(line_ptr + 1) == '\0') + *line_ptr = '\0'; + + if (read_continued_line) + { + /* cut leading whitespaces from input line */ + for (line_ptr = line; *line_ptr; line_ptr++) + if (*line_ptr != ' ' && *line_ptr != '\t') + break; + + /* append new line to existing line, if there is enough space */ + if (strlen(previous_line) + strlen(line_ptr) < MAX_LINE_LEN) + strcat(previous_line, line_ptr); + + strcpy(line, previous_line); /* copy storage buffer to line */ + + read_continued_line = FALSE; + } + + /* if the last character is '\', continue at next line */ + if (strlen(line) > 0 && line[strlen(line) - 1] == '\\') + { + line[strlen(line) - 1] = '\0'; /* cut off trailing backslash */ + strcpy(previous_line, line); /* copy line to storage buffer */ + + read_continued_line = TRUE; + + continue; + } + + /* cut trailing comment from input line */ for (line_ptr = line; *line_ptr; line_ptr++) { - if (*line_ptr == '#' || *line_ptr == '\n' || *line_ptr == '\r') + if (*line_ptr == '#') { *line_ptr = '\0'; break; @@ -1098,83 +1688,126 @@ struct SetupFileList *loadSetupFileList(char *filename) } /* cut trailing whitespaces from input line */ - for (line_ptr = &line[strlen(line)]; line_ptr > line; line_ptr--) - if ((*line_ptr == ' ' || *line_ptr == '\t') && line_ptr[1] == '\0') + for (line_ptr = &line[strlen(line)]; line_ptr >= line; line_ptr--) + if ((*line_ptr == ' ' || *line_ptr == '\t') && *(line_ptr + 1) == '\0') *line_ptr = '\0'; /* ignore empty lines */ if (*line == '\0') continue; - line_len = strlen(line); - /* cut leading whitespaces from token */ for (token = line; *token; token++) if (*token != ' ' && *token != '\t') break; - /* find end of token */ + /* start with empty value as reliable default */ + value = ""; + + /* find end of token to determine start of value */ for (line_ptr = token; *line_ptr; line_ptr++) { +#if 1 + if (*line_ptr == ':' || *line_ptr == '=') +#else if (*line_ptr == ' ' || *line_ptr == '\t' || *line_ptr == ':') +#endif { - *line_ptr = '\0'; + *line_ptr = '\0'; /* terminate token string */ + value = line_ptr + 1; /* set beginning of value */ + break; } } - if (line_ptr < line + line_len) - value = line_ptr + 1; - else - value = "\0"; + /* cut trailing whitespaces from token */ + for (line_ptr = &token[strlen(token)]; line_ptr >= token; line_ptr--) + if ((*line_ptr == ' ' || *line_ptr == '\t') && *(line_ptr + 1) == '\0') + *line_ptr = '\0'; /* cut leading whitespaces from value */ for (; *value; value++) if (*value != ' ' && *value != '\t') break; - if (*token && *value) - setTokenValue(setup_file_list, token, value); +#if 0 + if (*value == '\0') + value = "true"; /* treat tokens without value as "true" */ +#endif + + if (*token) + { + if (use_hash) + setHashEntry((SetupFileHash *)setup_file_data, token, value); + else + insert_ptr = addListEntry((SetupFileList *)insert_ptr, 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) +void saveSetupFileHash(SetupFileHash *hash, char *filename) { - if (!setup_file_list) - return; + FILE *file; - if (strcmp(setup_file_list->token, TOKEN_STR_FILE_IDENTIFIER) == 0) + if (!(file = fopen(filename, MODE_WRITE))) { - if (!checkCookieString(setup_file_list->value, identifier)) - { - Error(ERR_WARN, "configuration file has wrong file identifier"); - return; - } - else - return; + Error(ERR_WARN, "cannot write configuration file '%s'", filename); + + return; } - if (setup_file_list->next) - checkSetupFileListIdentifier(setup_file_list->next, identifier); - else + BEGIN_HASH_ITERATION(hash, itr) { - Error(ERR_WARN, "configuration file has no file identifier"); - return; + fprintf(file, "%s\n", getFormattedSetupEntry(HASH_ITERATION_TOKEN(itr), + HASH_ITERATION_VALUE(itr))); } + END_HASH_ITERATION(hash, itr) + + fclose(file); +} + +SetupFileList *loadSetupFileList(char *filename) +{ + return (SetupFileList *)loadSetupFileData(filename, FALSE); +} + +SetupFileHash *loadSetupFileHash(char *filename) +{ + return (SetupFileHash *)loadSetupFileData(filename, TRUE); +} + +void checkSetupFileHashIdentifier(SetupFileHash *setup_file_hash, + char *filename, char *identifier) +{ + char *value = getHashEntry(setup_file_hash, TOKEN_STR_FILE_IDENTIFIER); + + if (value == NULL) + Error(ERR_WARN, "config file '%s' has no file identifier", filename); + else if (!checkCookieString(value, identifier)) + Error(ERR_WARN, "config file '%s' has wrong file identifier", filename); } @@ -1182,214 +1815,635 @@ void checkSetupFileListIdentifier(struct SetupFileList *setup_file_list, /* setup file stuff */ /* ========================================================================= */ -#define TOKEN_STR_LAST_LEVEL_SERIES "last_level_series" -#define TOKEN_STR_LAST_PLAYED_LEVEL "last_played_level" -#define TOKEN_STR_HANDICAP_LEVEL "handicap_level" +#define TOKEN_STR_LAST_LEVEL_SERIES "last_level_series" +#define TOKEN_STR_LAST_PLAYED_LEVEL "last_played_level" +#define TOKEN_STR_HANDICAP_LEVEL "handicap_level" /* level directory info */ -#define LEVELINFO_TOKEN_NAME 0 -#define LEVELINFO_TOKEN_NAME_SHORT 1 -#define LEVELINFO_TOKEN_NAME_SORTING 2 -#define LEVELINFO_TOKEN_AUTHOR 3 -#define LEVELINFO_TOKEN_IMPORTED_FROM 4 -#define LEVELINFO_TOKEN_LEVELS 5 -#define LEVELINFO_TOKEN_FIRST_LEVEL 6 -#define LEVELINFO_TOKEN_SORT_PRIORITY 7 -#define LEVELINFO_TOKEN_LEVEL_GROUP 8 -#define LEVELINFO_TOKEN_READONLY 9 - -#define NUM_LEVELINFO_TOKENS 10 +#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 +#define LEVELINFO_TOKEN_IMPORTED_BY 5 +#define LEVELINFO_TOKEN_LEVELS 6 +#define LEVELINFO_TOKEN_FIRST_LEVEL 7 +#define LEVELINFO_TOKEN_SORT_PRIORITY 8 +#define LEVELINFO_TOKEN_LATEST_ENGINE 9 +#define LEVELINFO_TOKEN_LEVEL_GROUP 10 +#define LEVELINFO_TOKEN_READONLY 11 +#define LEVELINFO_TOKEN_GRAPHICS_SET_ECS 12 +#define LEVELINFO_TOKEN_GRAPHICS_SET_AGA 13 +#define LEVELINFO_TOKEN_GRAPHICS_SET 14 +#define LEVELINFO_TOKEN_SOUNDS_SET 15 +#define LEVELINFO_TOKEN_MUSIC_SET 16 +#define LEVELINFO_TOKEN_FILENAME 17 +#define LEVELINFO_TOKEN_FILETYPE 18 +#define LEVELINFO_TOKEN_HANDICAP 19 +#define LEVELINFO_TOKEN_SKIP_LEVELS 20 + +#define NUM_LEVELINFO_TOKENS 21 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_STRING, &ldi.imported_by, "imported_by" }, + { TYPE_INTEGER, &ldi.levels, "levels" }, + { TYPE_INTEGER, &ldi.first_level, "first_level" }, + { TYPE_INTEGER, &ldi.sort_priority, "sort_priority" }, + { TYPE_BOOLEAN, &ldi.latest_engine, "latest_engine" }, + { TYPE_BOOLEAN, &ldi.level_group, "level_group" }, + { TYPE_BOOLEAN, &ldi.readonly, "readonly" }, + { TYPE_STRING, &ldi.graphics_set_ecs, "graphics_set.ecs" }, + { TYPE_STRING, &ldi.graphics_set_aga, "graphics_set.aga" }, + { TYPE_STRING, &ldi.graphics_set, "graphics_set" }, + { TYPE_STRING, &ldi.sounds_set, "sounds_set" }, + { TYPE_STRING, &ldi.music_set, "music_set" }, + { TYPE_STRING, &ldi.level_filename, "filename" }, + { TYPE_STRING, &ldi.level_filetype, "filetype" }, + { TYPE_BOOLEAN, &ldi.handicap, "handicap" }, + { TYPE_BOOLEAN, &ldi.skip_levels, "skip_levels" } +}; + +static struct TokenInfo artworkinfo_tokens[] = +{ + /* artwork directory info */ + { TYPE_STRING, &ldi.identifier, "identifier" }, + { TYPE_STRING, &ldi.subdir, "subdir" }, + { TYPE_STRING, &ldi.name, "name" }, + { TYPE_STRING, &ldi.name_sorting, "name_sorting" }, + { TYPE_STRING, &ldi.author, "author" }, + { TYPE_INTEGER, &ldi.sort_priority, "sort_priority" }, + { TYPE_STRING, &ldi.basepath, "basepath" }, + { TYPE_STRING, &ldi.fullpath, "fullpath" }, + { TYPE_BOOLEAN, &ldi.in_user_dir, "in_user_dir" }, + { TYPE_INTEGER, &ldi.color, "color" }, + { TYPE_STRING, &ldi.class_desc, "class_desc" }, + + { -1, NULL, NULL }, }; -static void setTreeInfoToDefaults(TreeInfo *ldi, int type) +static void setTreeInfoToDefaults(TreeInfo *ti, int type) +{ + ti->type = type; + + ti->node_top = (ti->type == TREE_TYPE_LEVEL_DIR ? &leveldir_first : + ti->type == TREE_TYPE_GRAPHICS_DIR ? &artwork.gfx_first : + ti->type == TREE_TYPE_SOUNDS_DIR ? &artwork.snd_first : + ti->type == TREE_TYPE_MUSIC_DIR ? &artwork.mus_first : + NULL); + + ti->node_parent = NULL; + ti->node_group = NULL; + ti->next = NULL; + + ti->cl_first = -1; + ti->cl_cursor = -1; + + ti->subdir = NULL; + ti->fullpath = NULL; + ti->basepath = NULL; + ti->identifier = NULL; + ti->name = getStringCopy(ANONYMOUS_NAME); + ti->name_sorting = NULL; + ti->author = getStringCopy(ANONYMOUS_NAME); + + ti->sort_priority = LEVELCLASS_UNDEFINED; /* default: least priority */ + ti->latest_engine = FALSE; /* default: get from level */ + ti->parent_link = FALSE; + ti->in_user_dir = FALSE; + ti->user_defined = FALSE; + ti->color = 0; + ti->class_desc = NULL; + + ti->infotext = getStringCopy(TREE_INFOTEXT(ti->type)); + + if (ti->type == TREE_TYPE_LEVEL_DIR) + { + ti->imported_from = NULL; + ti->imported_by = NULL; + + ti->graphics_set_ecs = NULL; + ti->graphics_set_aga = NULL; + ti->graphics_set = NULL; + ti->sounds_set = NULL; + ti->music_set = NULL; + ti->graphics_path = getStringCopy(UNDEFINED_FILENAME); + ti->sounds_path = getStringCopy(UNDEFINED_FILENAME); + ti->music_path = getStringCopy(UNDEFINED_FILENAME); + + ti->level_filename = NULL; + ti->level_filetype = NULL; + + ti->levels = 0; + ti->first_level = 0; + ti->last_level = 0; + ti->level_group = FALSE; + ti->handicap_level = 0; + ti->readonly = TRUE; + ti->handicap = TRUE; + ti->skip_levels = FALSE; + } +} + +static void setTreeInfoToDefaultsFromParent(TreeInfo *ti, TreeInfo *parent) +{ + if (parent == NULL) + { + Error(ERR_WARN, "setTreeInfoToDefaultsFromParent(): parent == NULL"); + + setTreeInfoToDefaults(ti, TREE_TYPE_UNDEFINED); + + return; + } + + /* copy all values from the parent structure */ + + ti->type = parent->type; + + ti->node_top = parent->node_top; + ti->node_parent = parent; + ti->node_group = NULL; + ti->next = NULL; + + ti->cl_first = -1; + ti->cl_cursor = -1; + + ti->subdir = NULL; + ti->fullpath = NULL; + ti->basepath = NULL; + ti->identifier = NULL; + ti->name = getStringCopy(ANONYMOUS_NAME); + ti->name_sorting = NULL; + ti->author = getStringCopy(parent->author); + + ti->sort_priority = parent->sort_priority; + ti->latest_engine = parent->latest_engine; + ti->parent_link = FALSE; + ti->in_user_dir = parent->in_user_dir; + ti->user_defined = parent->user_defined; + ti->color = parent->color; + ti->class_desc = getStringCopy(parent->class_desc); + + ti->infotext = getStringCopy(parent->infotext); + + if (ti->type == TREE_TYPE_LEVEL_DIR) + { + ti->imported_from = getStringCopy(parent->imported_from); + ti->imported_by = getStringCopy(parent->imported_by); + + ti->graphics_set_ecs = NULL; + ti->graphics_set_aga = NULL; + ti->graphics_set = NULL; + ti->sounds_set = NULL; + ti->music_set = NULL; + ti->graphics_path = getStringCopy(UNDEFINED_FILENAME); + ti->sounds_path = getStringCopy(UNDEFINED_FILENAME); + ti->music_path = getStringCopy(UNDEFINED_FILENAME); + + ti->level_filename = NULL; + ti->level_filetype = NULL; + + ti->levels = 0; + ti->first_level = 0; + ti->last_level = 0; + ti->level_group = FALSE; + ti->handicap_level = 0; + ti->readonly = TRUE; + ti->handicap = TRUE; + ti->skip_levels = FALSE; + } +} + +static TreeInfo *getTreeInfoCopy(TreeInfo *ti) +{ + TreeInfo *ti_copy = newTreeInfo(); + + /* copy all values from the original structure */ + + ti_copy->type = ti->type; + + ti_copy->node_top = ti->node_top; + ti_copy->node_parent = ti->node_parent; + ti_copy->node_group = ti->node_group; + ti_copy->next = ti->next; + + ti_copy->cl_first = ti->cl_first; + ti_copy->cl_cursor = ti->cl_cursor; + + ti_copy->subdir = getStringCopy(ti->subdir); + ti_copy->fullpath = getStringCopy(ti->fullpath); + ti_copy->basepath = getStringCopy(ti->basepath); + ti_copy->identifier = getStringCopy(ti->identifier); + ti_copy->name = getStringCopy(ti->name); + ti_copy->name_sorting = getStringCopy(ti->name_sorting); + ti_copy->author = getStringCopy(ti->author); + ti_copy->imported_from = getStringCopy(ti->imported_from); + ti_copy->imported_by = getStringCopy(ti->imported_by); + + ti_copy->graphics_set_ecs = getStringCopy(ti->graphics_set_ecs); + ti_copy->graphics_set_aga = getStringCopy(ti->graphics_set_aga); + ti_copy->graphics_set = getStringCopy(ti->graphics_set); + ti_copy->sounds_set = getStringCopy(ti->sounds_set); + ti_copy->music_set = getStringCopy(ti->music_set); + ti_copy->graphics_path = getStringCopy(ti->graphics_path); + ti_copy->sounds_path = getStringCopy(ti->sounds_path); + ti_copy->music_path = getStringCopy(ti->music_path); + + ti_copy->level_filename = getStringCopy(ti->level_filename); + ti_copy->level_filetype = getStringCopy(ti->level_filetype); + + ti_copy->levels = ti->levels; + ti_copy->first_level = ti->first_level; + ti_copy->last_level = ti->last_level; + ti_copy->sort_priority = ti->sort_priority; + + ti_copy->latest_engine = ti->latest_engine; + + ti_copy->level_group = ti->level_group; + ti_copy->parent_link = ti->parent_link; + ti_copy->in_user_dir = ti->in_user_dir; + ti_copy->user_defined = ti->user_defined; + ti_copy->readonly = ti->readonly; + ti_copy->handicap = ti->handicap; + ti_copy->skip_levels = ti->skip_levels; + + ti_copy->color = ti->color; + ti_copy->class_desc = getStringCopy(ti->class_desc); + ti_copy->handicap_level = ti->handicap_level; + + ti_copy->infotext = getStringCopy(ti->infotext); + + return ti_copy; +} + +static void freeTreeInfo(TreeInfo *ti) +{ + if (ti == NULL) + return; + + checked_free(ti->subdir); + checked_free(ti->fullpath); + checked_free(ti->basepath); + checked_free(ti->identifier); + + checked_free(ti->name); + checked_free(ti->name_sorting); + checked_free(ti->author); + + checked_free(ti->class_desc); + + checked_free(ti->infotext); + + if (ti->type == TREE_TYPE_LEVEL_DIR) + { + checked_free(ti->imported_from); + checked_free(ti->imported_by); + + checked_free(ti->graphics_set_ecs); + checked_free(ti->graphics_set_aga); + checked_free(ti->graphics_set); + checked_free(ti->sounds_set); + checked_free(ti->music_set); + + checked_free(ti->graphics_path); + checked_free(ti->sounds_path); + checked_free(ti->music_path); + + checked_free(ti->level_filename); + checked_free(ti->level_filetype); + } + + checked_free(ti); +} + +void setSetupInfo(struct TokenInfo *token_info, + int token_nr, char *token_value) +{ + int token_type = token_info[token_nr].type; + void *setup_value = token_info[token_nr].value; + + if (token_value == NULL) + return; + + /* set setup field to corresponding token value */ + switch (token_type) + { + case TYPE_BOOLEAN: + case TYPE_SWITCH: + *(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_integer_from_string(token_value); + break; + + case TYPE_STRING: + checked_free(*(char **)setup_value); + *(char **)setup_value = getStringCopy(token_value); + break; + + default: + break; + } +} + +static int compareTreeInfoEntries(const void *object1, const void *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) + { + char *name1 = getStringToLower(entry1->name_sorting); + char *name2 = getStringToLower(entry2->name_sorting); + + compare_result = strcmp(name1, name2); + + free(name1); + free(name2); + } + else if (class_sorting1 == class_sorting2) + compare_result = entry1->sort_priority - entry2->sort_priority; + else + compare_result = class_sorting1 - class_sorting2; + + return compare_result; +} + +static void createParentTreeInfoNode(TreeInfo *node_parent) +{ + TreeInfo *ti_new; + + if (node_parent == NULL) + return; + + ti_new = newTreeInfo(); + setTreeInfoToDefaults(ti_new, node_parent->type); + + ti_new->node_parent = node_parent; + ti_new->parent_link = TRUE; + + setString(&ti_new->identifier, node_parent->identifier); + setString(&ti_new->name, ".. (parent directory)"); + setString(&ti_new->name_sorting, ti_new->name); + + setString(&ti_new->subdir, ".."); + setString(&ti_new->fullpath, node_parent->fullpath); + + ti_new->sort_priority = node_parent->sort_priority; + ti_new->latest_engine = node_parent->latest_engine; + + setString(&ti_new->class_desc, getLevelClassDescription(ti_new)); + + pushTreeInfo(&node_parent->node_group, ti_new); +} + + +/* -------------------------------------------------------------------------- */ +/* functions for handling level and custom artwork info cache */ +/* -------------------------------------------------------------------------- */ + +static void LoadArtworkInfoCache() +{ + InitCacheDirectory(); + + if (artworkinfo_cache_old == NULL) + { + char *filename = getPath2(getCacheDir(), ARTWORKINFO_CACHE_FILE); + + /* try to load artwork info hash from already existing cache file */ + artworkinfo_cache_old = loadSetupFileHash(filename); + + /* if no artwork info cache file was found, start with empty hash */ + if (artworkinfo_cache_old == NULL) + artworkinfo_cache_old = newSetupFileHash(); + + free(filename); + } + + if (artworkinfo_cache_new == NULL) + artworkinfo_cache_new = newSetupFileHash(); +} + +static void SaveArtworkInfoCache() +{ + char *filename = getPath2(getCacheDir(), ARTWORKINFO_CACHE_FILE); + + InitCacheDirectory(); + + saveSetupFileHash(artworkinfo_cache_new, filename); + + free(filename); +} + +static char *getCacheTokenPrefix(char *prefix1, char *prefix2) { - ldi->type = type; + static char *prefix = NULL; - 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); + checked_free(prefix); - ldi->node_parent = NULL; - ldi->node_group = NULL; - ldi->next = NULL; + prefix = getStringCat2WithSeparator(prefix1, prefix2, "."); - ldi->cl_first = -1; - ldi->cl_cursor = -1; + return prefix; +} - ldi->filename = NULL; - ldi->fullpath = NULL; - ldi->basepath = NULL; - ldi->name = getStringCopy(ANONYMOUS_NAME); - ldi->name_short = NULL; - ldi->name_sorting = NULL; - ldi->author = getStringCopy(ANONYMOUS_NAME); +/* (identical to above function, but separate string buffer needed -- nasty) */ +static char *getCacheToken(char *prefix, char *suffix) +{ + static char *token = NULL; - ldi->sort_priority = LEVELCLASS_UNDEFINED; /* default: least priority */ - ldi->parent_link = FALSE; - ldi->user_defined = FALSE; - ldi->color = 0; - ldi->class_desc = NULL; + checked_free(token); - if (ldi->type == TREE_TYPE_LEVEL_DIR) - { - ldi->imported_from = NULL; - ldi->levels = 0; - ldi->first_level = 0; - ldi->last_level = 0; - ldi->level_group = FALSE; - ldi->handicap_level = 0; - ldi->readonly = TRUE; - } + token = getStringCat2WithSeparator(prefix, suffix, "."); + + return token; } -static void setTreeInfoToDefaultsFromParent(TreeInfo *ldi, TreeInfo *parent) +static char *getFileTimestamp(char *filename) { - if (parent == NULL) - { - Error(ERR_WARN, "setTreeInfoToDefaultsFromParent(): parent == NULL"); + struct stat file_status; - setTreeInfoToDefaults(ldi, TREE_TYPE_GENERIC); - return; - } + if (stat(filename, &file_status) != 0) /* cannot stat file */ + return getStringCopy(i_to_a(0)); - /* first copy all values from the parent structure ... */ - *ldi = *parent; + return getStringCopy(i_to_a(file_status.st_mtime)); +} - /* ... then set all fields to default that cannot be inherited from parent. - This is especially important for all those fields that can be set from - the 'levelinfo.conf' config file, because the function 'setSetupInfo()' - calls 'free()' for all already set token values which requires that no - other structure's pointer may point to them! - */ +static boolean modifiedFileTimestamp(char *filename, char *timestamp_string) +{ + struct stat file_status; - ldi->filename = NULL; - ldi->fullpath = NULL; - ldi->basepath = 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); + if (timestamp_string == NULL) + return TRUE; - ldi->level_group = FALSE; - ldi->parent_link = FALSE; + if (stat(filename, &file_status) != 0) /* cannot stat file */ + return TRUE; - ldi->node_top = parent->node_top; - ldi->node_parent = parent; - ldi->node_group = NULL; - ldi->next = NULL; + return (file_status.st_mtime != atoi(timestamp_string)); } -void setSetupInfo(struct TokenInfo *token_info, - int token_nr, char *token_value) +static TreeInfo *getArtworkInfoCacheEntry(LevelDirTree *level_node, int type) { - int token_type = token_info[token_nr].type; - void *setup_value = token_info[token_nr].value; + char *identifier = level_node->subdir; + char *type_string = ARTWORK_DIRECTORY(type); + char *token_prefix = getCacheTokenPrefix(type_string, identifier); + char *token_main = getCacheToken(token_prefix, "CACHED"); + char *cache_entry = getHashEntry(artworkinfo_cache_old, token_main); + boolean cached = (cache_entry != NULL && strEqual(cache_entry, "true")); + TreeInfo *artwork_info = NULL; - if (token_value == NULL) - return; + if (!use_artworkinfo_cache) + return NULL; - /* set setup field to corresponding token value */ - switch (token_type) + if (cached) { - case TYPE_BOOLEAN: - case TYPE_SWITCH: - *(boolean *)setup_value = get_string_boolean_value(token_value); - break; + int i; - case TYPE_KEY: - *(Key *)setup_value = getKeyFromKeyName(token_value); - break; + artwork_info = newTreeInfo(); + setTreeInfoToDefaults(artwork_info, type); - case TYPE_KEY_X11: - *(Key *)setup_value = getKeyFromX11KeyName(token_value); - break; + /* set all structure fields according to the token/value pairs */ + ldi = *artwork_info; + for (i = 0; artworkinfo_tokens[i].type != -1; i++) + { + char *token = getCacheToken(token_prefix, artworkinfo_tokens[i].text); + char *value = getHashEntry(artworkinfo_cache_old, token); - case TYPE_INTEGER: - *(int *)setup_value = get_string_integer_value(token_value); - break; + setSetupInfo(artworkinfo_tokens, i, value); - case TYPE_STRING: - if (*(char **)setup_value != NULL) - free(*(char **)setup_value); - *(char **)setup_value = getStringCopy(token_value); - break; + /* check if cache entry for this item is invalid or incomplete */ + if (value == NULL) + { +#if 1 + Error(ERR_WARN, "cache entry '%s' invalid", token); +#endif - default: - break; + cached = FALSE; + } + } + *artwork_info = ldi; } -} - -static int compareTreeInfoEntries(const void *object1, const void *object2) -{ - const TreeInfo *entry1 = *((TreeInfo **)object1); - const TreeInfo *entry2 = *((TreeInfo **)object2); - int compare_result; - if (entry1->parent_link || entry2->parent_link) - compare_result = (entry1->parent_link ? -1 : +1); - else if (entry1->sort_priority == entry2->sort_priority) + if (cached) { - char *name1 = getStringToLower(entry1->name_sorting); - char *name2 = getStringToLower(entry2->name_sorting); + char *filename_levelinfo = getPath2(getLevelDirFromTreeInfo(level_node), + LEVELINFO_FILENAME); + char *filename_artworkinfo = getPath2(getSetupArtworkDir(artwork_info), + ARTWORKINFO_FILENAME(type)); - compare_result = strcmp(name1, name2); + /* check if corresponding "levelinfo.conf" file has changed */ + token_main = getCacheToken(token_prefix, "TIMESTAMP_LEVELINFO"); + cache_entry = getHashEntry(artworkinfo_cache_old, token_main); - free(name1); - free(name2); - } - else if (LEVELSORTING(entry1) == LEVELSORTING(entry2)) - compare_result = entry1->sort_priority - entry2->sort_priority; - else - compare_result = LEVELSORTING(entry1) - LEVELSORTING(entry2); + if (modifiedFileTimestamp(filename_levelinfo, cache_entry)) + cached = FALSE; - return compare_result; -} + /* check if corresponding ".conf" file has changed */ + token_main = getCacheToken(token_prefix, "TIMESTAMP_ARTWORKINFO"); + cache_entry = getHashEntry(artworkinfo_cache_old, token_main); -static void createParentTreeInfoNode(TreeInfo *node_parent) -{ - TreeInfo *ti_new; + if (modifiedFileTimestamp(filename_artworkinfo, cache_entry)) + cached = FALSE; - if (node_parent == NULL) - return; +#if 0 + if (!cached) + printf("::: '%s': INVALIDATED FROM CACHE BY TIMESTAMP\n", identifier); +#endif - ti_new = newTreeInfo(); - setTreeInfoToDefaults(ti_new, node_parent->type); + checked_free(filename_levelinfo); + checked_free(filename_artworkinfo); + } - ti_new->node_parent = node_parent; - ti_new->parent_link = TRUE; + if (!cached && artwork_info != NULL) + { + freeTreeInfo(artwork_info); + + return NULL; + } - ti_new->name = ".. (parent directory)"; - ti_new->name_short = getStringCopy(ti_new->name); - ti_new->name_sorting = getStringCopy(ti_new->name); + return artwork_info; +} - ti_new->filename = ".."; - ti_new->fullpath = getStringCopy(node_parent->fullpath); +static void setArtworkInfoCacheEntry(TreeInfo *artwork_info, + LevelDirTree *level_node, int type) +{ + char *identifier = level_node->subdir; + char *type_string = ARTWORK_DIRECTORY(type); + char *token_prefix = getCacheTokenPrefix(type_string, identifier); + char *token_main = getCacheToken(token_prefix, "CACHED"); + boolean set_cache_timestamps = TRUE; + int i; - ti_new->sort_priority = node_parent->sort_priority; - ti_new->class_desc = getLevelClassDescription(ti_new); + setHashEntry(artworkinfo_cache_new, token_main, "true"); - pushTreeInfo(&node_parent->node_group, ti_new); + if (set_cache_timestamps) + { + char *filename_levelinfo = getPath2(getLevelDirFromTreeInfo(level_node), + LEVELINFO_FILENAME); + char *filename_artworkinfo = getPath2(getSetupArtworkDir(artwork_info), + ARTWORKINFO_FILENAME(type)); + char *timestamp_levelinfo = getFileTimestamp(filename_levelinfo); + char *timestamp_artworkinfo = getFileTimestamp(filename_artworkinfo); + + token_main = getCacheToken(token_prefix, "TIMESTAMP_LEVELINFO"); + setHashEntry(artworkinfo_cache_new, token_main, timestamp_levelinfo); + + token_main = getCacheToken(token_prefix, "TIMESTAMP_ARTWORKINFO"); + setHashEntry(artworkinfo_cache_new, token_main, timestamp_artworkinfo); + + checked_free(filename_levelinfo); + checked_free(filename_artworkinfo); + checked_free(timestamp_levelinfo); + checked_free(timestamp_artworkinfo); + } + + ldi = *artwork_info; + for (i = 0; artworkinfo_tokens[i].type != -1; i++) + { + char *token = getCacheToken(token_prefix, artworkinfo_tokens[i].text); + char *value = getSetupValue(artworkinfo_tokens[i].type, + artworkinfo_tokens[i].value); + if (value != NULL) + setHashEntry(artworkinfo_cache_new, token, value); + } } + +/* -------------------------------------------------------------------------- */ +/* functions for loading level info and custom artwork info */ +/* -------------------------------------------------------------------------- */ + /* forward declaration for recursive call by "LoadLevelInfoFromLevelDir()" */ static void LoadLevelInfoFromLevelDir(TreeInfo **, TreeInfo *, char *); @@ -1398,15 +2452,28 @@ static boolean LoadLevelInfoFromLevelConf(TreeInfo **node_first, char *level_directory, char *directory_name) { + static unsigned long progress_delay = 0; + unsigned long progress_delay_value = 100; /* (in milliseconds) */ 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; LevelDirTree *leveldir_new = NULL; int i; - if (setup_file_list == NULL) + /* unless debugging, silently ignore directories without "levelinfo.conf" */ + if (!options.debug && !fileExists(filename)) + { + free(directory_path); + free(filename); + + return FALSE; + } + + setup_file_hash = loadSetupFileHash(filename); + + 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); @@ -1421,63 +2488,105 @@ static boolean LoadLevelInfoFromLevelConf(TreeInfo **node_first, else setTreeInfoToDefaults(leveldir_new, TREE_TYPE_LEVEL_DIR); - checkSetupFileListIdentifier(setup_file_list, getCookie("LEVELINFO")); + leveldir_new->subdir = getStringCopy(directory_name); + + checkSetupFileHashIdentifier(setup_file_hash, filename, + getCookie("LEVELINFO")); /* set all structure fields according to the token/value pairs */ ldi = *leveldir_new; - for (i=0; iname, 150, FC_YELLOW); + if (strEqual(leveldir_new->name, ANONYMOUS_NAME)) + setString(&leveldir_new->name, leveldir_new->subdir); - 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->subdir); 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; - leveldir_new->fullpath = leveldir_new->filename; + leveldir_new->basepath = getStringCopy(level_directory); + leveldir_new->fullpath = getStringCopy(leveldir_new->subdir); } else /* sub level group */ { - leveldir_new->basepath = node_parent->basepath; + leveldir_new->basepath = getStringCopy(node_parent->basepath); leveldir_new->fullpath = getPath2(node_parent->fullpath, directory_name); } +#if 0 if (leveldir_new->levels < 1) leveldir_new->levels = 1; +#endif leveldir_new->last_level = leveldir_new->first_level + leveldir_new->levels - 1; + leveldir_new->in_user_dir = + (!strEqual(leveldir_new->basepath, options.level_directory)); + + /* adjust some settings if user's private level directory was detected */ + if (leveldir_new->sort_priority == LEVELCLASS_UNDEFINED && + leveldir_new->in_user_dir && + (strEqual(leveldir_new->subdir, getLoginName()) || + strEqual(leveldir_new->name, getLoginName()) || + strEqual(leveldir_new->author, getRealName()))) + { + leveldir_new->sort_priority = LEVELCLASS_PRIVATE_START; + leveldir_new->readonly = FALSE; + } + leveldir_new->user_defined = - (leveldir_new->basepath == options.level_directory ? FALSE : TRUE); + (leveldir_new->in_user_dir && IS_LEVELCLASS_PRIVATE(leveldir_new)); leveldir_new->color = LEVELCOLOR(leveldir_new); - leveldir_new->class_desc = getLevelClassDescription(leveldir_new); + + setString(&leveldir_new->class_desc, getLevelClassDescription(leveldir_new)); leveldir_new->handicap_level = /* set handicap to default value */ - (leveldir_new->user_defined ? - leveldir_new->last_level : - leveldir_new->first_level); + (leveldir_new->user_defined || !leveldir_new->handicap ? + leveldir_new->last_level : leveldir_new->first_level); + +#if 1 + if (leveldir_new->level_group || + DelayReached(&progress_delay, progress_delay_value)) + DrawInitText(leveldir_new->name, 150, FC_YELLOW); +#else + DrawInitText(leveldir_new->name, 150, FC_YELLOW); +#endif + +#if 0 + /* !!! don't skip sets without levels (else artwork base sets are missing) */ +#if 1 + if (leveldir_new->levels < 1 && !leveldir_new->level_group) + { + /* skip level sets without levels (which are probably artwork base sets) */ + + freeSetupFileHash(setup_file_hash); + free(directory_path); + free(filename); + + return FALSE; + } +#endif +#endif 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 */ createParentTreeInfoNode(leveldir_new); - /* step into sub-directory and look for more level series */ + /* recursively step into sub-directory and look for more level series */ LoadLevelInfoFromLevelDir(&leveldir_new->node_group, leveldir_new, directory_path); } @@ -1509,8 +2618,8 @@ static void LoadLevelInfoFromLevelDir(TreeInfo **node_first, char *directory_path = getPath2(level_directory, directory_name); /* skip entries for current and parent directory */ - if (strcmp(directory_name, ".") == 0 || - strcmp(directory_name, "..") == 0) + if (strEqual(directory_name, ".") || + strEqual(directory_name, "..")) { free(directory_path); continue; @@ -1526,6 +2635,11 @@ static void LoadLevelInfoFromLevelDir(TreeInfo **node_first, free(directory_path); + if (strEqual(directory_name, GRAPHICS_DIRECTORY) || + strEqual(directory_name, SOUNDS_DIRECTORY) || + strEqual(directory_name, MUSIC_DIRECTORY)) + continue; + valid_entry_found |= LoadLevelInfoFromLevelConf(node_first, node_parent, level_directory, directory_name); @@ -1533,7 +2647,8 @@ static void LoadLevelInfoFromLevelDir(TreeInfo **node_first, closedir(dir); - if (!valid_entry_found) + /* special case: top level directory may directly contain "levelinfo.conf" */ + if (node_parent == NULL && !valid_entry_found) { /* check if this directory directly contains a file "levelinfo.conf" */ valid_entry_found |= LoadLevelInfoFromLevelConf(node_first, node_parent, @@ -1545,22 +2660,41 @@ static void LoadLevelInfoFromLevelDir(TreeInfo **node_first, level_directory); } +boolean AdjustGraphicsForEMC() +{ + boolean settings_changed = FALSE; + + settings_changed |= adjustTreeGraphicsForEMC(leveldir_first_all); + settings_changed |= adjustTreeGraphicsForEMC(leveldir_first); + + return settings_changed; +} + void LoadLevelInfo() { InitUserLevelDirectory(getLoginName()); - DrawInitText("Loading level series:", 120, FC_GREEN); + DrawInitText("Loading level series", 120, FC_GREEN); LoadLevelInfoFromLevelDir(&leveldir_first, NULL, options.level_directory); LoadLevelInfoFromLevelDir(&leveldir_first, NULL, getUserLevelDir(NULL)); + /* after loading all level set information, clone the level directory tree + and remove all level sets without levels (these may still contain artwork + to be offered in the setup menu as "custom artwork", and are therefore + checked for existing artwork in the function "LoadLevelArtworkInfo()") */ + leveldir_first_all = leveldir_first; + cloneTree(&leveldir_first, leveldir_first_all, TRUE); + + AdjustGraphicsForEMC(); + /* 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"); - sortTreeInfo(&leveldir_first, compareTreeInfoEntries); + sortTreeInfo(&leveldir_first); #if 0 dumpTreeInfo(leveldir_first, 0); @@ -1573,20 +2707,15 @@ static boolean LoadArtworkInfoFromArtworkConf(TreeInfo **node_first, char *directory_name, int type) { char *directory_path = getPath2(base_directory, directory_name); - char *filename = - getPath2(directory_path, - (type == TREE_TYPE_GRAPHICS_DIR ? GRAPHICSINFO_FILENAME : - type == TREE_TYPE_SOUNDS_DIR ? SOUNDSINFO_FILENAME : - type == TREE_TYPE_MUSIC_DIR ? MUSICINFO_FILENAME : "")); - struct SetupFileList *setup_file_list = NULL; + char *filename = getPath2(directory_path, ARTWORKINFO_FILENAME(type)); + SetupFileHash *setup_file_hash = NULL; TreeInfo *artwork_new = NULL; - char *check_dir = NULL; int i; - if (access(filename, F_OK) == 0) /* file exists */ - loadSetupFileList(filename); + if (fileExists(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; @@ -1598,9 +2727,7 @@ static boolean LoadArtworkInfoFromArtworkConf(TreeInfo **node_first, { char *entry_name = dir_entry->d_name; - if ((type == TREE_TYPE_GRAPHICS_DIR && FileIsGraphic(entry_name)) || - (type == TREE_TYPE_SOUNDS_DIR && FileIsSound(entry_name)) || - (type == TREE_TYPE_MUSIC_DIR && FileIsMusic(entry_name))) + if (FileIsArtworkType(entry_name, type)) { valid_file_found = TRUE; break; @@ -1612,8 +2739,8 @@ static boolean LoadArtworkInfoFromArtworkConf(TreeInfo **node_first, if (!valid_file_found) { - if (options.debug) - Error(ERR_WARN, "ignoring artwork directory '%s'", base_directory); + if (!strEqual(directory_name, ".")) + Error(ERR_WARN, "ignoring artwork directory '%s'", directory_path); free(directory_path); free(filename); @@ -1629,25 +2756,26 @@ static boolean LoadArtworkInfoFromArtworkConf(TreeInfo **node_first, else setTreeInfoToDefaults(artwork_new, type); - artwork_new->filename = getStringCopy(directory_name); + artwork_new->subdir = 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, filename, getCookie("...")); #endif /* set all structure fields according to the token/value pairs */ ldi = *artwork_new; - for (i=0; iname, 150, FC_YELLOW); + if (strEqual(artwork_new->name, ANONYMOUS_NAME)) + setString(&artwork_new->name, artwork_new->subdir); - if (artwork_new->name_short == NULL) - artwork_new->name_short = getStringCopy(artwork_new->name); + if (artwork_new->identifier == NULL) + artwork_new->identifier = getStringCopy(artwork_new->subdir); if (artwork_new->name_sorting == NULL) artwork_new->name_sorting = getStringCopy(artwork_new->name); @@ -1656,7 +2784,7 @@ static boolean LoadArtworkInfoFromArtworkConf(TreeInfo **node_first, if (node_parent == NULL) /* top level group */ { artwork_new->basepath = getStringCopy(base_directory); - artwork_new->fullpath = getStringCopy(artwork_new->filename); + artwork_new->fullpath = getStringCopy(artwork_new->subdir); } else /* sub level group */ { @@ -1664,38 +2792,51 @@ static boolean LoadArtworkInfoFromArtworkConf(TreeInfo **node_first, artwork_new->fullpath = getPath2(node_parent->fullpath, directory_name); } - check_dir = (type == TREE_TYPE_GRAPHICS_DIR ? options.graphics_directory : - type == TREE_TYPE_SOUNDS_DIR ? options.sounds_directory : - type == TREE_TYPE_MUSIC_DIR ? options.music_directory : ""); - artwork_new->user_defined = - (artwork_new->basepath == check_dir ? FALSE : TRUE); + artwork_new->in_user_dir = + (!strEqual(artwork_new->basepath, OPTIONS_ARTWORK_DIRECTORY(type))); - /* (may use ".sort_priority" from "setup_file_list" above) */ - artwork_new->color = LEVELCOLOR(artwork_new); - artwork_new->class_desc = getLevelClassDescription(artwork_new); + /* (may use ".sort_priority" from "setup_file_hash" above) */ + artwork_new->color = ARTWORKCOLOR(artwork_new); - if (setup_file_list == NULL) /* (after determining ".user_defined") */ - { - if (artwork_new->name != NULL) - free(artwork_new->name); + setString(&artwork_new->class_desc, getLevelClassDescription(artwork_new)); - if (strcmp(artwork_new->filename, ".") == 0) + if (setup_file_hash == NULL) /* (after determining ".user_defined") */ + { + if (strEqual(artwork_new->subdir, ".")) { if (artwork_new->user_defined) - artwork_new->name = getStringCopy("private"); + { + setString(&artwork_new->identifier, "private"); + artwork_new->sort_priority = ARTWORKCLASS_PRIVATE; + } else - artwork_new->name = getStringCopy("default"); + { + setString(&artwork_new->identifier, "classic"); + artwork_new->sort_priority = ARTWORKCLASS_CLASSICS; + } + + /* set to new values after changing ".sort_priority" */ + artwork_new->color = ARTWORKCOLOR(artwork_new); + + setString(&artwork_new->class_desc, + getLevelClassDescription(artwork_new)); } else - artwork_new->name = getStringCopy(artwork_new->filename); + { + setString(&artwork_new->identifier, artwork_new->subdir); + } - artwork_new->name_short = getStringCopy(artwork_new->name); - artwork_new->name_sorting = getStringCopy(artwork_new->name); + setString(&artwork_new->name, artwork_new->identifier); + setString(&artwork_new->name_sorting, artwork_new->name); } +#if 0 + DrawInitText(artwork_new->name, 150, FC_YELLOW); +#endif + pushTreeInfo(node_first, artwork_new); - freeSetupFileList(setup_file_list); + freeSetupFileHash(setup_file_hash); free(directory_path); free(filename); @@ -1713,13 +2854,10 @@ static void LoadArtworkInfoFromArtworkDir(TreeInfo **node_first, if ((dir = opendir(base_directory)) == NULL) { - if ((type == TREE_TYPE_GRAPHICS_DIR && - base_directory == options.graphics_directory) || - (type == TREE_TYPE_SOUNDS_DIR && - base_directory == options.sounds_directory) || - (type == TREE_TYPE_MUSIC_DIR && - base_directory == options.music_directory)) + /* display error if directory is main "options.graphics_directory" etc. */ + if (base_directory == OPTIONS_ARTWORK_DIRECTORY(type)) Error(ERR_WARN, "cannot read directory '%s'", base_directory); + return; } @@ -1729,15 +2867,15 @@ static void LoadArtworkInfoFromArtworkDir(TreeInfo **node_first, 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) + /* skip directory entries for current and parent directory */ + if (strEqual(directory_name, ".") || + strEqual(directory_name, "..")) { free(directory_path); continue; } - /* find out if directory entry is itself a directory */ + /* skip directory entries which are not a directory or are not accessible */ if (stat(directory_path, &file_status) != 0 || /* cannot stat file */ (file_status.st_mode & S_IFMT) != S_IFDIR) /* not a directory */ { @@ -1748,7 +2886,7 @@ static void LoadArtworkInfoFromArtworkDir(TreeInfo **node_first, free(directory_path); /* check if this directory contains artwork with or without config file */ - valid_entry_found |= LoadArtworkInfoFromArtworkConf(node_first,node_parent, + valid_entry_found |= LoadArtworkInfoFromArtworkConf(node_first, node_parent, base_directory, directory_name, type); } @@ -1756,7 +2894,7 @@ static void LoadArtworkInfoFromArtworkDir(TreeInfo **node_first, closedir(dir); /* check if this directory directly contains artwork itself */ - valid_entry_found |= LoadArtworkInfoFromArtworkConf(node_first,node_parent, + valid_entry_found |= LoadArtworkInfoFromArtworkConf(node_first, node_parent, base_directory, ".", type); if (!valid_entry_found) @@ -1764,9 +2902,29 @@ static void LoadArtworkInfoFromArtworkDir(TreeInfo **node_first, 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); + + setString(&artwork_new->subdir, UNDEFINED_FILENAME); + setString(&artwork_new->fullpath, UNDEFINED_FILENAME); + setString(&artwork_new->basepath, UNDEFINED_FILENAME); + + setString(&artwork_new->identifier, UNDEFINED_FILENAME); + setString(&artwork_new->name, UNDEFINED_FILENAME); + setString(&artwork_new->name_sorting, UNDEFINED_FILENAME); + + return artwork_new; +} + void LoadArtworkInfo() { - DrawInitText("Looking for custom artwork:", 120, FC_GREEN); + LoadArtworkInfoCache(); + + DrawInitText("Looking for custom artwork", 120, FC_GREEN); LoadArtworkInfoFromArtworkDir(&artwork.gfx_first, NULL, options.graphics_directory, @@ -1789,29 +2947,169 @@ void LoadArtworkInfo() 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 = - getTreeInfoFromFilename(artwork.gfx_first, setup.graphics_set); + getTreeInfoFromIdentifier(artwork.gfx_first, setup.graphics_set); + if (artwork.gfx_current == NULL) + artwork.gfx_current = + getTreeInfoFromIdentifier(artwork.gfx_first, GFX_CLASSIC_SUBDIR); if (artwork.gfx_current == NULL) artwork.gfx_current = getFirstValidTreeInfoEntry(artwork.gfx_first); artwork.snd_current = - getTreeInfoFromFilename(artwork.snd_first, setup.sounds_set); + getTreeInfoFromIdentifier(artwork.snd_first, setup.sounds_set); if (artwork.snd_current == NULL) - artwork.snd_current = getFirstValidTreeInfoEntry(artwork.snd_first); + artwork.snd_current = + getTreeInfoFromIdentifier(artwork.snd_first, SND_CLASSIC_SUBDIR); + if (artwork.snd_current == NULL) + artwork.snd_current = getFirstValidTreeInfoEntry(artwork.snd_first); artwork.mus_current = - getTreeInfoFromFilename(artwork.mus_first, setup.music_set); + getTreeInfoFromIdentifier(artwork.mus_first, setup.music_set); + if (artwork.mus_current == NULL) + artwork.mus_current = + getTreeInfoFromIdentifier(artwork.mus_first, MUS_CLASSIC_SUBDIR); if (artwork.mus_current == NULL) - artwork.mus_current = getFirstValidTreeInfoEntry(artwork.mus_first); + 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); + sortTreeInfo(&artwork.snd_first); + sortTreeInfo(&artwork.mus_first); + +#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) +{ + static unsigned long progress_delay = 0; + unsigned long progress_delay_value = 100; /* (in milliseconds) */ + int type = (*artwork_node)->type; + + /* recursively check all level directories for artwork sub-directories */ + + while (level_node) + { + /* check all tree entries for artwork, but skip parent link entries */ + if (!level_node->parent_link) + { + TreeInfo *artwork_new = getArtworkInfoCacheEntry(level_node, type); + boolean cached = (artwork_new != NULL); + + if (cached) + { + pushTreeInfo(artwork_node, artwork_new); + } + else + { + TreeInfo *topnode_last = *artwork_node; + char *path = getPath2(getLevelDirFromTreeInfo(level_node), + ARTWORK_DIRECTORY(type)); + + LoadArtworkInfoFromArtworkDir(artwork_node, NULL, path, type); + + if (topnode_last != *artwork_node) /* check for newly added node */ + { + artwork_new = *artwork_node; + + setString(&artwork_new->identifier, level_node->subdir); + setString(&artwork_new->name, level_node->name); + setString(&artwork_new->name_sorting, level_node->name_sorting); + + artwork_new->sort_priority = level_node->sort_priority; + artwork_new->color = LEVELCOLOR(artwork_new); + } + + free(path); + } + + /* insert artwork info (from old cache or filesystem) into new cache */ + if (artwork_new != NULL) + setArtworkInfoCacheEntry(artwork_new, level_node, type); + } + +#if 1 + if (level_node->level_group || + DelayReached(&progress_delay, progress_delay_value)) + DrawInitText(level_node->name, 150, FC_YELLOW); +#endif + + 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_all); + LoadArtworkInfoFromLevelInfo(&artwork.snd_first, leveldir_first_all); + LoadArtworkInfoFromLevelInfo(&artwork.mus_first, leveldir_first_all); + + SaveArtworkInfoCache(); + + /* needed for reloading level artwork not known at ealier stage */ - artwork.graphics_set_current = artwork.gfx_current->name; - artwork.sounds_set_current = artwork.snd_current->name; - artwork.music_set_current = artwork.mus_current->name; + if (!strEqual(artwork.gfx_current_identifier, setup.graphics_set)) + { + artwork.gfx_current = + getTreeInfoFromIdentifier(artwork.gfx_first, setup.graphics_set); + if (artwork.gfx_current == NULL) + artwork.gfx_current = + getTreeInfoFromIdentifier(artwork.gfx_first, GFX_CLASSIC_SUBDIR); + if (artwork.gfx_current == NULL) + artwork.gfx_current = getFirstValidTreeInfoEntry(artwork.gfx_first); + } + + if (!strEqual(artwork.snd_current_identifier, setup.sounds_set)) + { + artwork.snd_current = + getTreeInfoFromIdentifier(artwork.snd_first, setup.sounds_set); + if (artwork.snd_current == NULL) + artwork.snd_current = + getTreeInfoFromIdentifier(artwork.snd_first, SND_CLASSIC_SUBDIR); + if (artwork.snd_current == NULL) + artwork.snd_current = getFirstValidTreeInfoEntry(artwork.snd_first); + } + + if (!strEqual(artwork.mus_current_identifier, setup.music_set)) + { + artwork.mus_current = + getTreeInfoFromIdentifier(artwork.mus_first, setup.music_set); + if (artwork.mus_current == NULL) + artwork.mus_current = + getTreeInfoFromIdentifier(artwork.mus_first, MUS_CLASSIC_SUBDIR); + 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); + sortTreeInfo(&artwork.gfx_first); + sortTreeInfo(&artwork.snd_first); + sortTreeInfo(&artwork.mus_first); #if 0 dumpTreeInfo(artwork.gfx_first, 0); @@ -1822,6 +3120,7 @@ void LoadArtworkInfo() static void SaveUserLevelInfo() { + LevelDirTree *level_info; char *filename; FILE *file; int i; @@ -1835,35 +3134,52 @@ static void SaveUserLevelInfo() return; } + level_info = newTreeInfo(); + /* always start with reliable default values */ - setTreeInfoToDefaults(&ldi, TREE_TYPE_LEVEL_DIR); + setTreeInfoToDefaults(level_info, TREE_TYPE_LEVEL_DIR); + + setString(&level_info->name, getLoginName()); + setString(&level_info->author, getRealName()); + level_info->levels = 100; + level_info->first_level = 1; - ldi.name = getLoginName(); - ldi.author = getRealName(); - ldi.levels = 100; - ldi.first_level = 1; - ldi.sort_priority = LEVELCLASS_USER_START; - ldi.readonly = FALSE; + token_value_position = TOKEN_VALUE_POSITION_SHORT; fprintf(file, "%s\n\n", getFormattedSetupEntry(TOKEN_STR_FILE_IDENTIFIER, getCookie("LEVELINFO"))); - for (i=0; i/levelsetup.conf */ /* ----------------------------------------------------------------------- */ - filename = getPath2(getSetupDir(), LEVELSETUP_FILENAME); + char *filename = getPath2(getSetupDir(), LEVELSETUP_FILENAME); + SetupFileHash *level_setup_hash = NULL; + + /* always start with reliable default values */ + leveldir_current = getFirstValidTreeInfoEntry(leveldir_first); - 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 = getTreeInfoFromFilename(leveldir_first, - 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, filename, + getCookie("LEVELSETUP")); - freeSetupFileList(level_setup_list); + freeSetupFileHash(level_setup_hash); } else Error(ERR_WARN, "using default setup values"); @@ -1977,17 +3301,15 @@ void LoadLevelSetup_LastSeries() void SaveLevelSetup_LastSeries() { - char *filename; - char *level_subdir = leveldir_current->filename; - FILE *file; - /* ----------------------------------------------------------------------- */ /* ~/./levelsetup.conf */ /* ----------------------------------------------------------------------- */ - InitUserDataDirectory(); + char *filename = getPath2(getSetupDir(), LEVELSETUP_FILENAME); + char *level_subdir = leveldir_current->subdir; + FILE *file; - filename = getPath2(getSetupDir(), LEVELSETUP_FILENAME); + InitUserDataDirectory(); if (!(file = fopen(filename, MODE_WRITE))) { @@ -2002,9 +3324,10 @@ void SaveLevelSetup_LastSeries() level_subdir)); fclose(file); - free(filename); SetFilePermissions(filename, PERMS_PRIVATE); + + free(filename); } static void checkSeriesInfo() @@ -2015,7 +3338,7 @@ static void checkSeriesInfo() /* check for more levels besides the 'levels' field of 'levelinfo.conf' */ - level_directory = getPath2((leveldir_current->user_defined ? + level_directory = getPath2((leveldir_current->in_user_dir ? getUserLevelDir(NULL) : options.level_directory), leveldir_current->fullpath); @@ -2030,7 +3353,7 @@ static void checkSeriesInfo() { if (strlen(dir_entry->d_name) > 4 && dir_entry->d_name[3] == '.' && - strcmp(&dir_entry->d_name[4], LEVELFILE_EXTENSION) == 0) + strEqual(&dir_entry->d_name[4], LEVELFILE_EXTENSION)) { char levelnum_str[4]; int levelnum_value; @@ -2040,6 +3363,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); @@ -2050,6 +3374,7 @@ static void checkSeriesInfo() Error(ERR_WARN, "additional level %d found", levelnum_value); leveldir_current->last_level = levelnum_value; } +#endif } } @@ -2059,8 +3384,8 @@ static void checkSeriesInfo() void LoadLevelSetup_SeriesInfo() { char *filename; - struct SetupFileList *level_setup_list = NULL; - char *level_subdir = leveldir_current->filename; + SetupFileHash *level_setup_hash = NULL; + char *level_subdir = leveldir_current->subdir; /* always start with reliable default values */ level_nr = leveldir_current->first_level; @@ -2071,15 +3396,15 @@ void LoadLevelSetup_SeriesInfo() /* ~/./levelsetup//levelsetup.conf */ /* ----------------------------------------------------------------------- */ - level_subdir = leveldir_current->filename; + level_subdir = leveldir_current->subdir; 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) { @@ -2091,7 +3416,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) { @@ -2102,15 +3427,16 @@ void LoadLevelSetup_SeriesInfo() if (level_nr > leveldir_current->last_level + 1) level_nr = leveldir_current->last_level; - if (leveldir_current->user_defined) + if (leveldir_current->user_defined || !leveldir_current->handicap) level_nr = leveldir_current->last_level; leveldir_current->handicap_level = level_nr; } - checkSetupFileListIdentifier(level_setup_list, getCookie("LEVELSETUP")); + checkSetupFileHashIdentifier(level_setup_hash, filename, + getCookie("LEVELSETUP")); - freeSetupFileList(level_setup_list); + freeSetupFileHash(level_setup_hash); } else Error(ERR_WARN, "using default setup values"); @@ -2121,7 +3447,7 @@ void LoadLevelSetup_SeriesInfo() void SaveLevelSetup_SeriesInfo() { char *filename; - char *level_subdir = leveldir_current->filename; + char *level_subdir = leveldir_current->subdir; char *level_nr_str = int2str(level_nr, 0); char *handicap_level_str = int2str(leveldir_current->handicap_level, 0); FILE *file; @@ -2149,7 +3475,8 @@ void SaveLevelSetup_SeriesInfo() handicap_level_str)); fclose(file); - free(filename); SetFilePermissions(filename, PERMS_PRIVATE); + + free(filename); }