X-Git-Url: https://git.artsoft.org/?a=blobdiff_plain;f=src%2Ffiles.c;h=6d858c475be133ebbe2e54027677bbdbb63c9db7;hb=38c26472a6e9f0f037ddfe535d3919c00772b26f;hp=d3e85c3f1417f0fd713d6011d047e1e623c1bb68;hpb=78ec772d11cb8823d8dca05c227b472da8708a07;p=rocksndiamonds.git diff --git a/src/files.c b/src/files.c index d3e85c3f..6d858c47 100644 --- a/src/files.c +++ b/src/files.c @@ -1,299 +1,76 @@ /*********************************************************** -* Rocks'n'Diamonds -- McDuffin Strikes Back! * +* Rocks'n'Diamonds -- McDuffin Strikes Back! * *----------------------------------------------------------* -* (c) 1995-98 Artsoft Entertainment * -* Holger Schemel * -* Oststrasse 11a * -* 33604 Bielefeld * -* phone: ++49 +521 290471 * -* email: aeglos@valinor.owl.de * +* (c) 1995-2002 Artsoft Entertainment * +* Holger Schemel * +* Detmolder Strasse 189 * +* 33604 Bielefeld * +* Germany * +* e-mail: info@artsoft.org * *----------------------------------------------------------* -* files.h * +* files.c * ***********************************************************/ #include -#include #include -#include + +#include "libgame/libgame.h" #include "files.h" #include "tools.h" -#include "misc.h" #include "tape.h" -#include "joystick.h" - -#define MAX_FILENAME_LEN 256 /* maximal filename length */ -#define MAX_LINE_LEN 1000 /* maximal input line length */ -#define CHUNK_ID_LEN 4 /* IFF style chunk id length */ -#define LEVEL_HEADER_SIZE 80 /* size of level file header */ -#define LEVEL_HEADER_UNUSED 16 /* unused level header bytes */ -#define TAPE_HEADER_SIZE 20 /* size of tape file header */ -#define TAPE_HEADER_UNUSED 7 /* unused tape header bytes */ -#define FILE_VERSION_1_0 10 /* old 1.0 file version */ -#define FILE_VERSION_1_2 12 /* actual file version */ - -/* file identifier strings */ -#define LEVEL_COOKIE "ROCKSNDIAMONDS_LEVEL_FILE_VERSION_1.2" -#define SCORE_COOKIE "ROCKSNDIAMONDS_SCORE_FILE_VERSION_1.2" -#define TAPE_COOKIE "ROCKSNDIAMONDS_TAPE_FILE_VERSION_1.2" -#define SETUP_COOKIE "ROCKSNDIAMONDS_SETUP_FILE_VERSION_1.2" -#define LEVELSETUP_COOKIE "ROCKSNDIAMONDS_LEVELSETUP_FILE_VERSION_1.2" -#define LEVELINFO_COOKIE "ROCKSNDIAMONDS_LEVELINFO_FILE_VERSION_1.2" -/* old file identifiers for backward compatibility */ -#define LEVEL_COOKIE_10 "ROCKSNDIAMONDS_LEVEL_FILE_VERSION_1.0" -#define TAPE_COOKIE_10 "ROCKSNDIAMONDS_LEVELREC_FILE_VERSION_1.0" - -/* file names and filename extensions */ -#ifndef MSDOS -#define USERDATA_DIRECTORY ".rocksndiamonds" -#define SETUP_FILENAME "setup.conf" -#define LEVELSETUP_FILENAME "levelsetup.conf" -#define LEVELINFO_FILENAME "levelinfo.conf" -#define LEVELFILE_EXTENSION "level" -#define TAPEFILE_EXTENSION "tape" -#define SCOREFILE_EXTENSION "score" -#else -#define USERDATA_DIRECTORY "userdata" -#define SETUP_FILENAME "setup.cnf" -#define LEVELSETUP_FILENAME "lvlsetup.cnf" -#define LEVELINFO_FILENAME "lvlinfo.cnf" -#define LEVELFILE_EXTENSION "lvl" -#define TAPEFILE_EXTENSION "tap" -#define SCOREFILE_EXTENSION "sco" -#define ERROR_FILENAME "error.out" -#endif - -/* file permissions for newly written files */ -#define MODE_R_ALL (S_IRUSR | S_IRGRP | S_IROTH) -#define MODE_W_ALL (S_IWUSR | S_IWGRP | S_IWOTH) -#define MODE_X_ALL (S_IXUSR | S_IXGRP | S_IXOTH) -#define USERDATA_DIR_MODE (MODE_R_ALL | MODE_X_ALL | S_IWUSR) -#define LEVEL_PERMS (MODE_R_ALL | MODE_W_ALL) -#define SCORE_PERMS LEVEL_PERMS -#define TAPE_PERMS LEVEL_PERMS -#define SETUP_PERMS LEVEL_PERMS - -/* sort priorities of level series (also used as level series classes) */ -#define LEVELCLASS_TUTORIAL_START 10 -#define LEVELCLASS_TUTORIAL_END 99 -#define LEVELCLASS_CLASSICS_START 100 -#define LEVELCLASS_CLASSICS_END 199 -#define LEVELCLASS_CONTRIBUTION_START 200 -#define LEVELCLASS_CONTRIBUTION_END 299 -#define LEVELCLASS_USER_START 300 -#define LEVELCLASS_USER_END 399 - -#define LEVELCLASS_TUTORIAL LEVELCLASS_TUTORIAL_START -#define LEVELCLASS_CLASSICS LEVELCLASS_CLASSICS_START -#define LEVELCLASS_CONTRIBUTION LEVELCLASS_CONTRIBUTION_START -#define LEVELCLASS_USER LEVELCLASS_USER_START -#define LEVELCLASS_UNDEFINED 999 - -#define IS_LEVELCLASS_TUTORIAL(n) \ - (leveldir[n].sort_priority >= LEVELCLASS_TUTORIAL_START && \ - leveldir[n].sort_priority <= LEVELCLASS_TUTORIAL_END) -#define IS_LEVELCLASS_CLASSICS(n) \ - (leveldir[n].sort_priority >= LEVELCLASS_CLASSICS_START && \ - leveldir[n].sort_priority <= LEVELCLASS_CLASSICS_END) -#define IS_LEVELCLASS_CONTRIBUTION(n) \ - (leveldir[n].sort_priority >= LEVELCLASS_CONTRIBUTION_START && \ - leveldir[n].sort_priority <= LEVELCLASS_CONTRIBUTION_END) -#define IS_LEVELCLASS_USER(n) \ - (leveldir[n].sort_priority >= LEVELCLASS_USER_START && \ - leveldir[n].sort_priority <= LEVELCLASS_USER_END) - -#define LEVELCLASS(n) (IS_LEVELCLASS_TUTORIAL(n) ? LEVELCLASS_TUTORIAL : \ - IS_LEVELCLASS_CLASSICS(n) ? LEVELCLASS_CLASSICS : \ - IS_LEVELCLASS_CONTRIBUTION(n) ? LEVELCLASS_CONTRIBUTION : \ - IS_LEVELCLASS_USER(n) ? LEVELCLASS_USER : \ - LEVELCLASS_UNDEFINED) - -#define LEVELCOLOR(n) (IS_LEVELCLASS_TUTORIAL(n) ? FC_BLUE : \ - IS_LEVELCLASS_CLASSICS(n) ? FC_YELLOW : \ - IS_LEVELCLASS_CONTRIBUTION(n) ? FC_GREEN : \ - IS_LEVELCLASS_USER(n) ? FC_RED : FC_BLUE) - -static void SaveUserLevelInfo(); /* for 'InitUserLevelDir()' */ -static char *getSetupLine(char *, int); /* for 'SaveUserLevelInfo()' */ - -static char *getGlobalDataDir() -{ - return GAME_DIR; -} - -char *getUserDataDir() -{ - static char *userdata_dir = NULL; - - if (!userdata_dir) - { - char *home_dir = getHomeDir(); - char *data_dir = USERDATA_DIRECTORY; - - userdata_dir = getPath2(home_dir, data_dir); - } - - return userdata_dir; -} - -static char *getSetupDir() -{ - return getUserDataDir(); -} - -static char *getUserLevelDir(char *level_subdir) -{ - static char *userlevel_dir = NULL; - char *data_dir = getUserDataDir(); - char *userlevel_subdir = LEVELS_DIRECTORY; - - if (userlevel_dir) - free(userlevel_dir); - - if (strlen(level_subdir) > 0) - userlevel_dir = getPath3(data_dir, userlevel_subdir, level_subdir); - else - userlevel_dir = getPath2(data_dir, userlevel_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 (strlen(level_subdir) > 0) - 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 = getGlobalDataDir(); - char *score_subdir = SCORES_DIRECTORY; - - if (score_dir) - free(score_dir); - - if (strlen(level_subdir) > 0) - score_dir = getPath3(data_dir, score_subdir, level_subdir); - else - score_dir = getPath2(data_dir, score_subdir); - - return score_dir; -} - -static char *getLevelFilename(int nr) -{ - static char *filename = NULL; - char basename[MAX_FILENAME_LEN]; - - if (filename != NULL) - free(filename); - - sprintf(basename, "%03d.%s", nr, LEVELFILE_EXTENSION); - filename = getPath3((leveldir[leveldir_nr].user_defined ? - getUserLevelDir("") : - options.level_directory), - leveldir[leveldir_nr].filename, - basename); - - return filename; -} - -static char *getTapeFilename(int nr) -{ - static char *filename = NULL; - char basename[MAX_FILENAME_LEN]; - if (filename != NULL) - free(filename); - sprintf(basename, "%03d.%s", nr, TAPEFILE_EXTENSION); - filename = getPath2(getTapeDir(leveldir[leveldir_nr].filename), basename); - - return filename; -} - -static char *getScoreFilename(int nr) -{ - static char *filename = NULL; - char basename[MAX_FILENAME_LEN]; - - if (filename != NULL) - free(filename); - - sprintf(basename, "%03d.%s", nr, SCOREFILE_EXTENSION); - filename = getPath2(getScoreDir(leveldir[leveldir_nr].filename), basename); - - return filename; -} - -static void createDirectory(char *dir, char *text) -{ - if (access(dir, F_OK) != 0) - if (mkdir(dir, USERDATA_DIR_MODE) != 0) - Error(ERR_WARN, "cannot create %s directory '%s'", text, dir); -} - -static void InitUserDataDirectory() -{ - createDirectory(getUserDataDir(), "user data"); -} - -static void InitTapeDirectory(char *level_subdir) -{ - createDirectory(getUserDataDir(), "user data"); - createDirectory(getTapeDir(""), "main tape"); - createDirectory(getTapeDir(level_subdir), "level tape"); -} +#define CHUNK_ID_LEN 4 /* IFF style chunk id length */ +#define CHUNK_SIZE_UNDEFINED 0 /* undefined chunk size == 0 */ +#define CHUNK_SIZE_NONE -1 /* do not write chunk size */ +#define FILE_VERS_CHUNK_SIZE 8 /* size of file version chunk */ +#define LEVEL_HEADER_SIZE 80 /* size of level file header */ +#define LEVEL_HEADER_UNUSED 14 /* unused level header bytes */ +#define LEVEL_CHUNK_CNT2_SIZE 160 /* size of level CNT2 chunk */ +#define LEVEL_CHUNK_CNT2_UNUSED 11 /* unused CNT2 chunk bytes */ +#define TAPE_HEADER_SIZE 20 /* size of tape file header */ +#define TAPE_HEADER_UNUSED 3 /* unused tape header bytes */ -static void InitScoreDirectory(char *level_subdir) -{ - createDirectory(getScoreDir(""), "main score"); - createDirectory(getScoreDir(level_subdir), "level score"); -} +/* file identifier strings */ +#define LEVEL_COOKIE_TMPL "ROCKSNDIAMONDS_LEVEL_FILE_VERSION_x.x" +#define TAPE_COOKIE_TMPL "ROCKSNDIAMONDS_TAPE_FILE_VERSION_x.x" +#define SCORE_COOKIE "ROCKSNDIAMONDS_SCORE_FILE_VERSION_1.2" -static void InitUserLevelDirectory(char *level_subdir) -{ - if (access(getUserLevelDir(level_subdir), F_OK) != 0) - { - createDirectory(getUserDataDir(), "user data"); - createDirectory(getUserLevelDir(""), "main user level"); - createDirectory(getUserLevelDir(level_subdir), "user level"); - SaveUserLevelInfo(); - } -} +/* ========================================================================= */ +/* level file functions */ +/* ========================================================================= */ static void setLevelInfoToDefaults() { int i, x, y; + level.file_version = FILE_VERSION_ACTUAL; + level.game_version = GAME_VERSION_ACTUAL; + + level.encoding_16bit_field = FALSE; /* default: only 8-bit elements */ + level.encoding_16bit_yamyam = FALSE; /* default: only 8-bit elements */ + level.encoding_16bit_amoeba = FALSE; /* default: only 8-bit elements */ + lev_fieldx = level.fieldx = STD_LEV_FIELDX; lev_fieldy = level.fieldy = STD_LEV_FIELDY; for(x=0; xauthor, ANONYMOUS_NAME) != 0) { - strncpy(level.author, leveldir[leveldir_nr].author, MAX_LEVEL_AUTHOR_LEN); + strncpy(level.author, leveldir_current->author, MAX_LEVEL_AUTHOR_LEN); level.author[MAX_LEVEL_AUTHOR_LEN] = '\0'; } else { - switch (LEVELCLASS(leveldir_nr)) + switch (LEVELCLASS(leveldir_current)) { case LEVELCLASS_TUTORIAL: - strcpy(level.author, PROGRAM_AUTHOR_STRING); - break; + strcpy(level.author, PROGRAM_AUTHOR_STRING); + break; case LEVELCLASS_CONTRIBUTION: - strncpy(level.author, leveldir[leveldir_nr].name,MAX_LEVEL_AUTHOR_LEN); - level.author[MAX_LEVEL_AUTHOR_LEN] = '\0'; - break; + strncpy(level.author, leveldir_current->name,MAX_LEVEL_AUTHOR_LEN); + level.author[MAX_LEVEL_AUTHOR_LEN] = '\0'; + break; case LEVELCLASS_USER: - strncpy(level.author, getRealName(), MAX_LEVEL_AUTHOR_LEN); - level.author[MAX_LEVEL_AUTHOR_LEN] = '\0'; - break; + strncpy(level.author, getRealName(), MAX_LEVEL_AUTHOR_LEN); + level.author[MAX_LEVEL_AUTHOR_LEN] = '\0'; + break; default: - /* keep default value */ - break; + /* keep default value */ + break; } } } -void LoadLevel(int level_nr) +static int checkLevelElement(int element) { - int i, x, y; - char *filename = getLevelFilename(level_nr); - char cookie[MAX_LINE_LEN]; - char chunk[CHUNK_ID_LEN + 1]; - int file_version = FILE_VERSION_1_2; /* last version of level files */ - int chunk_length; - FILE *file; - - /* always start with reliable default values */ - setLevelInfoToDefaults(); - - if (!(file = fopen(filename, "r"))) + if (element >= NUM_FILE_ELEMENTS) { - Error(ERR_WARN, "cannot read level '%s' - creating new level", filename); - return; + Error(ERR_WARN, "invalid level element %d", element); + element = EL_CHAR_QUESTION; } + else if (element == EL_PLAYER_OBSOLETE) + element = EL_PLAYER1; + else if (element == EL_KEY_OBSOLETE) + element = EL_KEY1; - /* check file identifier */ - fgets(cookie, MAX_LINE_LEN, file); - if (strlen(cookie) > 0 && cookie[strlen(cookie) - 1] == '\n') - cookie[strlen(cookie) - 1] = '\0'; + return element; +} - if (strcmp(cookie, LEVEL_COOKIE_10) == 0) /* old 1.0 level format */ - file_version = FILE_VERSION_1_0; - else if (strcmp(cookie, LEVEL_COOKIE) != 0) /* unknown level format */ - { - Error(ERR_WARN, "wrong file identifier of level file '%s'", filename); - fclose(file); - return; - } +static int LoadLevel_VERS(FILE *file, int chunk_size, struct LevelInfo *level) +{ + level->file_version = getFileVersion(file); + level->game_version = getFileVersion(file); - /* read chunk "HEAD" */ - if (file_version >= FILE_VERSION_1_2) - { - getFileChunk(file, chunk, &chunk_length, BYTE_ORDER_BIG_ENDIAN); - if (strcmp(chunk, "HEAD") || chunk_length != LEVEL_HEADER_SIZE) - { - Error(ERR_WARN, "wrong 'HEAD' chunk of level file '%s'", filename); - fclose(file); - return; - } - } + return chunk_size; +} + +static int LoadLevel_HEAD(FILE *file, int chunk_size, struct LevelInfo *level) +{ + int i, x, y; - lev_fieldx = level.fieldx = fgetc(file); - lev_fieldy = level.fieldy = fgetc(file); + lev_fieldx = level->fieldx = fgetc(file); + lev_fieldy = level->fieldy = fgetc(file); - level.time = getFile16BitInteger(file, BYTE_ORDER_BIG_ENDIAN); - level.gems_needed = getFile16BitInteger(file, BYTE_ORDER_BIG_ENDIAN); + level->time = getFile16BitBE(file); + level->gems_needed = getFile16BitBE(file); for(i=0; iname[i] = fgetc(file); + level->name[MAX_LEVEL_NAME_LEN] = 0; for(i=0; iscore[i] = fgetc(file); - level.num_yam_contents = STD_ELEMENT_CONTENTS; - for(i=0; inum_yam_contents = STD_ELEMENT_CONTENTS; + for(i=0; i= FILE_VERSION_1_2) - { - getFileChunk(file, chunk, &chunk_length, BYTE_ORDER_BIG_ENDIAN); - - /* look for optional author chunk */ - if (strcmp(chunk, "AUTH") == 0 && chunk_length == MAX_LEVEL_AUTHOR_LEN) - { - for(i=0; iyam_content[i][x][y] = checkLevelElement(fgetc(file)); - getFileChunk(file, chunk, &chunk_length, BYTE_ORDER_BIG_ENDIAN); - } + level->amoeba_speed = fgetc(file); + level->time_magic_wall = fgetc(file); + level->time_wheel = fgetc(file); + level->amoeba_content = checkLevelElement(fgetc(file)); + level->double_speed = (fgetc(file) == 1 ? TRUE : FALSE); + level->gravity = (fgetc(file) == 1 ? TRUE : FALSE); + level->encoding_16bit_field = (fgetc(file) == 1 ? TRUE : FALSE); + level->em_slippery_gems = (fgetc(file) == 1 ? TRUE : FALSE); - /* next check body chunk identifier and chunk length */ - if (strcmp(chunk, "BODY") || chunk_length != lev_fieldx * lev_fieldy) - { - Error(ERR_WARN, "wrong 'BODY' chunk of level file '%s'", filename); - fclose(file); - return; - } - } + ReadUnusedBytesFromFile(file, LEVEL_HEADER_UNUSED); - /* clear all other level fields (needed if resized in level editor later) */ - for(x=0; xauthor[i] = fgetc(file); + level->author[MAX_LEVEL_NAME_LEN] = 0; - /* player was faster than monsters in pre-1.0 levels */ - if (file_version == FILE_VERSION_1_0 && - IS_LEVELCLASS_CONTRIBUTION(leveldir_nr)) - { - Error(ERR_WARN, "level file '%s' has version number 1.0", filename); - Error(ERR_WARN, "using high speed movement for player"); - level.double_speed = TRUE; - } + return chunk_size; } -void SaveLevel(int level_nr) +static int LoadLevel_CONT(FILE *file, int chunk_size, struct LevelInfo *level) { int i, x, y; - char *filename = getLevelFilename(level_nr); - FILE *file; + int header_size = 4; + int content_size = MAX_ELEMENT_CONTENTS * 3 * 3; + int chunk_size_expected = header_size + content_size; - if (!(file = fopen(filename, "w"))) - { - Error(ERR_WARN, "cannot save level file '%s'", filename); - return; - } + /* Note: "chunk_size" was wrong before version 2.0 when elements are + stored with 16-bit encoding (and should be twice as big then). + Even worse, playfield data was stored 16-bit when only yamyam content + contained 16-bit elements and vice versa. */ - fputs(LEVEL_COOKIE, file); /* file identifier */ - fputc('\n', file); + if (level->encoding_16bit_field && level->file_version >= FILE_VERSION_2_0) + chunk_size_expected += content_size; - putFileChunk(file, "HEAD", LEVEL_HEADER_SIZE, BYTE_ORDER_BIG_ENDIAN); + if (chunk_size_expected != chunk_size) + { + ReadUnusedBytesFromFile(file, chunk_size); + return chunk_size_expected; + } - fputc(level.fieldx, file); - fputc(level.fieldy, file); + fgetc(file); + level->num_yam_contents = fgetc(file); + fgetc(file); + fgetc(file); - putFile16BitInteger(file, level.time, BYTE_ORDER_BIG_ENDIAN); - putFile16BitInteger(file, level.gems_needed, BYTE_ORDER_BIG_ENDIAN); + /* correct invalid number of content fields -- should never happen */ + if (level->num_yam_contents < 1 || + level->num_yam_contents > MAX_ELEMENT_CONTENTS) + level->num_yam_contents = STD_ELEMENT_CONTENTS; - for(i=0; iyam_content[i][x][y] = + checkLevelElement(level->encoding_16bit_field ? + getFile16BitBE(file) : fgetc(file)); + return chunk_size; +} - for(i=0; ifieldx * level->fieldy; - putFileChunk(file, "AUTH", MAX_LEVEL_AUTHOR_LEN, BYTE_ORDER_BIG_ENDIAN); + /* Note: "chunk_size" was wrong before version 2.0 when elements are + stored with 16-bit encoding (and should be twice as big then). + Even worse, playfield data was stored 16-bit when only yamyam content + contained 16-bit elements and vice versa. */ - for(i=0; iencoding_16bit_field && level->file_version >= FILE_VERSION_2_0) + chunk_size_expected *= 2; - putFileChunk(file, "CONT", 4 + MAX_ELEMENT_CONTENTS * 3 * 3, - BYTE_ORDER_BIG_ENDIAN); + if (chunk_size_expected != chunk_size) + { + ReadUnusedBytesFromFile(file, chunk_size); + return chunk_size_expected; + } - fputc(EL_MAMPFER, file); - fputc(level.num_yam_contents, file); - fputc(0, file); - fputc(0, file); + for(y=0; yfieldy; y++) + for(x=0; xfieldx; x++) + Feld[x][y] = Ur[x][y] = + checkLevelElement(level->encoding_16bit_field ? + getFile16BitBE(file) : fgetc(file)); + return chunk_size; +} + +static int LoadLevel_CNT2(FILE *file, int chunk_size, struct LevelInfo *level) +{ + int i, x, y; + int element; + int num_contents, content_xsize, content_ysize; + int content_array[MAX_ELEMENT_CONTENTS][3][3]; + + element = checkLevelElement(getFile16BitBE(file)); + num_contents = fgetc(file); + content_xsize = fgetc(file); + content_ysize = fgetc(file); + ReadUnusedBytesFromFile(file, LEVEL_CHUNK_CNT2_UNUSED); for(i=0; i MAX_ELEMENT_CONTENTS) + num_contents = STD_ELEMENT_CONTENTS; - for(y=0; ynum_yam_contents = num_contents; - fclose(file); + for(i=0; iyam_content[i][x][y] = content_array[i][x][y]; + } + else if (element == EL_BD_AMOEBA) + { + level->amoeba_content = content_array[0][0][0]; + } + else + { + Error(ERR_WARN, "cannot load content for element '%d'", element); + } - chmod(filename, LEVEL_PERMS); + return chunk_size; } -void LoadTape(int level_nr) +void LoadLevelFromFilename(char *filename) { - int i, j; - char *filename = getTapeFilename(level_nr); char cookie[MAX_LINE_LEN]; - char chunk[CHUNK_ID_LEN + 1]; + char chunk_name[CHUNK_ID_LEN + 1]; + int chunk_size; FILE *file; - int num_participating_players; - int file_version = FILE_VERSION_1_2; /* last version of tape files */ - int chunk_length; - - /* always start with reliable default values (empty tape) */ - TapeErase(); - - /* default values (also for pre-1.2 tapes) with only the first player */ - tape.player_participates[0] = TRUE; - for(i=1; i 0 && cookie[strlen(cookie) - 1] == '\n') - cookie[strlen(cookie) - 1] = '\0'; + /* always start with reliable default values */ + setLevelInfoToDefaults(); - if (strcmp(cookie, TAPE_COOKIE_10) == 0) /* old 1.0 tape format */ - file_version = FILE_VERSION_1_0; - else if (strcmp(cookie, TAPE_COOKIE) != 0) /* unknown tape format */ + if (!(file = fopen(filename, MODE_READ))) { - Error(ERR_WARN, "wrong file identifier of tape file '%s'", filename); - fclose(file); + level.no_level_file = TRUE; + + Error(ERR_WARN, "cannot read level '%s' - creating new level", filename); return; } - /* read chunk "HEAD" */ - if (file_version >= FILE_VERSION_1_2) + getFileChunkBE(file, chunk_name, NULL); + if (strcmp(chunk_name, "RND1") == 0) { - getFileChunk(file, chunk, &chunk_length, BYTE_ORDER_BIG_ENDIAN); - if (strcmp(chunk, "HEAD") || chunk_length != TAPE_HEADER_SIZE) + getFile32BitBE(file); /* not used */ + + getFileChunkBE(file, chunk_name, NULL); + if (strcmp(chunk_name, "CAVE") != 0) { - Error(ERR_WARN, "wrong 'HEAD' chunk of tape file '%s'", filename); + Error(ERR_WARN, "unknown format of level file '%s'", filename); fclose(file); return; } } - - tape.random_seed = getFile32BitInteger(file, BYTE_ORDER_BIG_ENDIAN); - tape.date = getFile32BitInteger(file, BYTE_ORDER_BIG_ENDIAN); - tape.length = getFile32BitInteger(file, BYTE_ORDER_BIG_ENDIAN); - - /* read header fields that are new since version 1.2 */ - if (file_version >= FILE_VERSION_1_2) + else /* check for pre-2.0 file format with cookie string */ { - byte store_participating_players = fgetc(file); + strcpy(cookie, chunk_name); + fgets(&cookie[4], MAX_LINE_LEN - 4, file); + if (strlen(cookie) > 0 && cookie[strlen(cookie) - 1] == '\n') + cookie[strlen(cookie) - 1] = '\0'; - for(i=0; i= FILE_VERSION_1_2) - { - getFileChunk(file, chunk, &chunk_length, BYTE_ORDER_BIG_ENDIAN); - if (strcmp(chunk, "BODY") || - chunk_length != (num_participating_players + 1) * tape.length) + if ((level.file_version = getFileVersionFromCookieString(cookie)) == -1) { - Error(ERR_WARN, "wrong 'BODY' chunk of tape file '%s'", filename); + Error(ERR_WARN, "unsupported version of level file '%s'", filename); fclose(file); return; } + + /* pre-2.0 level files have no game version, so use file version here */ + level.game_version = level.file_version; } - for(i=0; i= MAX_TAPELEN) - break; - - for(j=0; j 0) - tape.pos[i + num_moves].delay = 0; - num_moves++; + Error(ERR_WARN, "wrong size (%d) of chunk '%s' in level file '%s'", + chunk_size, chunk_name, filename); } } - - if (num_moves > 1) - { - num_moves--; - i += num_moves; - tape.length += num_moves; - } } - - if (feof(file)) - break; } fclose(file); - if (i != tape.length) - Error(ERR_WARN, "level recording file '%s' corrupted", filename); + if (leveldir_current == NULL) /* only when dumping level */ + return; - tape.length_seconds = GetTapeLength(); + if (IS_LEVELCLASS_CONTRIBUTION(leveldir_current) || + IS_LEVELCLASS_USER(leveldir_current)) + { + /* For user contributed and private levels, use the version of + the game engine the levels were created for. + Since 2.0.1, the game engine version is now directly stored + in the level file (chunk "VERS"), so there is no need anymore + to set the game version from the file version (except for old, + pre-2.0 levels, where the game version is still taken from the + file format version used to store the level -- see above). */ + + /* do some special adjustments to support older level versions */ + if (level.file_version == FILE_VERSION_1_0) + { + Error(ERR_WARN, "level file '%s' has version number 1.0", filename); + Error(ERR_WARN, "using high speed movement for player"); + + /* player was faster than monsters in (pre-)1.0 levels */ + level.double_speed = TRUE; + } + + /* Default behaviour for EM style gems was "slippery" only in 2.0.1 */ + if (level.game_version == VERSION_IDENT(2,0,1)) + level.em_slippery_gems = TRUE; + } + else + { + /* Always use the latest version of the game engine for all but + user contributed and private levels; this allows for actual + corrections in the game engine to take effect for existing, + converted levels (from "classic" or other existing games) to + make the game emulation more accurate, while (hopefully) not + breaking existing levels created from other players. */ + + level.game_version = GAME_VERSION_ACTUAL; + + /* Set special EM style gems behaviour: EM style gems slip down from + normal, steel and growing wall. As this is a more fundamental change, + it seems better to set the default behaviour to "off" (as it is more + natural) and make it configurable in the level editor (as a property + of gem style elements). Already existing converted levels (neither + private nor contributed levels) are changed to the new behaviour. */ + + if (level.file_version < FILE_VERSION_2_0) + level.em_slippery_gems = TRUE; + } + + /* determine border element for this level */ + SetBorderElement(); } -void SaveTape(int level_nr) +void LoadLevel(int level_nr) +{ + char *filename = getLevelFilename(level_nr); + + LoadLevelFromFilename(filename); +} + +static void SaveLevel_VERS(FILE *file, struct LevelInfo *level) +{ + putFileVersion(file, level->file_version); + putFileVersion(file, level->game_version); +} + +static void SaveLevel_HEAD(FILE *file, struct LevelInfo *level) +{ + int i, x, y; + + fputc(level->fieldx, file); + fputc(level->fieldy, file); + + putFile16BitBE(file, level->time); + putFile16BitBE(file, level->gems_needed); + + for(i=0; iname[i], file); + + for(i=0; iscore[i], file); + + for(i=0; iencoding_16bit_yamyam ? EL_EMPTY : + level->yam_content[i][x][y]), + file); + fputc(level->amoeba_speed, file); + fputc(level->time_magic_wall, file); + fputc(level->time_wheel, file); + fputc((level->encoding_16bit_amoeba ? EL_EMPTY : level->amoeba_content), + file); + fputc((level->double_speed ? 1 : 0), file); + fputc((level->gravity ? 1 : 0), file); + fputc((level->encoding_16bit_field ? 1 : 0), file); + fputc((level->em_slippery_gems ? 1 : 0), file); + + WriteUnusedBytesToFile(file, LEVEL_HEADER_UNUSED); +} + +static void SaveLevel_AUTH(FILE *file, struct LevelInfo *level) { int i; - char *filename = getTapeFilename(level_nr); - FILE *file; - boolean new_tape = TRUE; - byte store_participating_players; - int num_participating_players; - InitTapeDirectory(leveldir[leveldir_nr].filename); + for(i=0; iauthor[i], file); +} - /* if a tape still exists, ask to overwrite it */ - if (access(filename, F_OK) == 0) +#if 0 +static void SaveLevel_CONT(FILE *file, struct LevelInfo *level) +{ + int i, x, y; + + fputc(EL_YAMYAM, file); + fputc(level->num_yam_contents, file); + fputc(0, file); + fputc(0, file); + + for(i=0; iencoding_16bit_field) + putFile16BitBE(file, level->yam_content[i][x][y]); + else + fputc(level->yam_content[i][x][y], file); +} +#endif + +static void SaveLevel_BODY(FILE *file, struct LevelInfo *level) +{ + int x, y; + + for(y=0; yfieldy; y++) + for(x=0; xfieldx; x++) + if (level->encoding_16bit_field) + putFile16BitBE(file, Ur[x][y]); + else + fputc(Ur[x][y], file); +} + +static void SaveLevel_CNT2(FILE *file, struct LevelInfo *level, int element) +{ + int i, x, y; + int num_contents, content_xsize, content_ysize; + int content_array[MAX_ELEMENT_CONTENTS][3][3]; + + if (element == EL_YAMYAM) { - new_tape = FALSE; - if (!Request("Replace old tape ?", REQ_ASK)) - return; + num_contents = level->num_yam_contents; + content_xsize = 3; + content_ysize = 3; + + for(i=0; iyam_content[i][x][y]; } + else if (element == EL_BD_AMOEBA) + { + num_contents = 1; + content_xsize = 1; + content_ysize = 1; - /* count number of players and set corresponding bits for compact storage */ - store_participating_players = 0; - num_participating_players = 0; - for(i=0; iamoeba_content; + } + else { - if (tape.player_participates[i]) - { - num_participating_players++; - store_participating_players |= (1 << i); - } + /* chunk header already written -- write empty chunk data */ + WriteUnusedBytesToFile(file, LEVEL_CHUNK_CNT2_SIZE); + + Error(ERR_WARN, "cannot save content for element '%d'", element); + return; } - if (!(file = fopen(filename, "w"))) + putFile16BitBE(file, element); + fputc(num_contents, file); + fputc(content_xsize, file); + fputc(content_ysize, file); + + WriteUnusedBytesToFile(file, LEVEL_CHUNK_CNT2_UNUSED); + + for(i=0; i 255) + level.encoding_16bit_field = TRUE; - putFile32BitInteger(file, tape.random_seed, BYTE_ORDER_BIG_ENDIAN); - putFile32BitInteger(file, tape.date, BYTE_ORDER_BIG_ENDIAN); - putFile32BitInteger(file, tape.length, BYTE_ORDER_BIG_ENDIAN); + /* check yamyam content for 16-bit elements */ + level.encoding_16bit_yamyam = FALSE; + for(i=0; i 255) + level.encoding_16bit_yamyam = TRUE; - fputc(store_participating_players, file); + /* check amoeba content for 16-bit elements */ + level.encoding_16bit_amoeba = FALSE; + if (level.amoeba_content > 255) + level.encoding_16bit_amoeba = TRUE; - for(i=0; ifile_version, level->game_version); + printf_line('-', 79); + + printf("Level Author: '%s'\n", level->author); + printf("Level Title: '%s'\n", level->name); + printf("\n"); + printf("Playfield Size: %d x %d\n", level->fieldx, level->fieldy); + printf("\n"); + printf("Level Time: %d seconds\n", level->time); + printf("Gems needed: %d\n", level->gems_needed); + printf("\n"); + printf("Time for Magic Wall: %d seconds\n", level->time_magic_wall); + printf("Time for Wheel: %d seconds\n", level->time_wheel); + printf("Time for Light: %d seconds\n", level->time_light); + printf("Time for Timegate: %d seconds\n", level->time_timegate); + printf("\n"); + printf("Amoeba Speed: %d\n", level->amoeba_speed); + printf("\n"); + printf("Gravity: %s\n", (level->gravity ? "yes" : "no")); + printf("Double Speed Movement: %s\n", (level->double_speed ? "yes" : "no")); + printf("EM style slippery gems: %s\n", (level->em_slippery_gems ? "yes" : "no")); + + printf_line('-', 79); +} + +/* ========================================================================= */ +/* tape file functions */ +/* ========================================================================= */ + +static void setTapeInfoToDefaults() +{ + int i; + + /* always start with reliable default values (empty tape) */ + TapeErase(); + + /* default values (also for pre-1.2 tapes) with only the first player */ + tape.player_participates[0] = TRUE; + for(i=1; ifile_version = getFileVersion(file); + tape->game_version = getFileVersion(file); + + return chunk_size; +} + +static int LoadTape_HEAD(FILE *file, int chunk_size, struct TapeInfo *tape) { int i; - char *filename = getScoreFilename(level_nr); - char cookie[MAX_LINE_LEN]; - char line[MAX_LINE_LEN]; - char *line_ptr; - FILE *file; - /* always start with reliable default values */ - for(i=0; irandom_seed = getFile32BitBE(file); + tape->date = getFile32BitBE(file); + tape->length = getFile32BitBE(file); + + /* read header fields that are new since version 1.2 */ + if (tape->file_version >= FILE_VERSION_1_2) { - strcpy(highscore[i].Name, EMPTY_PLAYER_NAME); - highscore[i].Score = 0; + byte store_participating_players = fgetc(file); + int engine_version; + + /* since version 1.2, tapes store which players participate in the tape */ + tape->num_participating_players = 0; + for(i=0; iplayer_participates[i] = FALSE; + + if (store_participating_players & (1 << i)) + { + tape->player_participates[i] = TRUE; + tape->num_participating_players++; + } + } + + ReadUnusedBytesFromFile(file, TAPE_HEADER_UNUSED); + + engine_version = getFileVersion(file); + if (engine_version > 0) + tape->engine_version = engine_version; } - if (!(file = fopen(filename, "r"))) - return; + return chunk_size; +} - /* check file identifier */ - fgets(cookie, MAX_LINE_LEN, file); - if (strlen(cookie) > 0 && cookie[strlen(cookie) - 1] == '\n') - cookie[strlen(cookie) - 1] = '\0'; +static int LoadTape_BODY(FILE *file, int chunk_size, struct TapeInfo *tape) +{ + int i, j; + int chunk_size_expected = + (tape->num_participating_players + 1) * tape->length; - if (strcmp(cookie, SCORE_COOKIE) != 0) + if (chunk_size_expected != chunk_size) { - Error(ERR_WARN, "wrong file identifier of score file '%s'", filename); - fclose(file); - return; + ReadUnusedBytesFromFile(file, chunk_size); + return chunk_size_expected; } - for(i=0; ilength; i++) { - fscanf(file, "%d", &highscore[i].Score); - fgets(line, MAX_LINE_LEN, file); + if (i >= MAX_TAPELEN) + break; - if (line[strlen(line)-1] == '\n') - line[strlen(line)-1] = '\0'; + for(j=0; jpos[i].action[j] = MV_NO_MOVING; - for (line_ptr = line; *line_ptr; line_ptr++) + if (tape->player_participates[j]) + tape->pos[i].action[j] = fgetc(file); + } + + tape->pos[i].delay = fgetc(file); + + if (tape->file_version == FILE_VERSION_1_0) { - if (*line_ptr != ' ' && *line_ptr != '\t' && *line_ptr != '\0') + /* eliminate possible diagonal moves in old tapes */ + /* this is only for backward compatibility */ + + byte joy_dir[4] = { JOY_LEFT, JOY_RIGHT, JOY_UP, JOY_DOWN }; + byte action = tape->pos[i].action[0]; + int k, num_moves = 0; + + for (k=0; k<4; k++) { - strncpy(highscore[i].Name, line_ptr, MAX_NAMELEN - 1); - highscore[i].Name[MAX_NAMELEN - 1] = '\0'; - break; + if (action & joy_dir[k]) + { + tape->pos[i + num_moves].action[0] = joy_dir[k]; + if (num_moves > 0) + tape->pos[i + num_moves].delay = 0; + num_moves++; + } + } + + if (num_moves > 1) + { + num_moves--; + i += num_moves; + tape->length += num_moves; } } + else if (tape->file_version < FILE_VERSION_2_0) + { + /* convert pre-2.0 tapes to new tape format */ + + if (tape->pos[i].delay > 1) + { + /* action part */ + tape->pos[i + 1] = tape->pos[i]; + tape->pos[i + 1].delay = 1; + + /* delay part */ + for(j=0; jpos[i].action[j] = MV_NO_MOVING; + tape->pos[i].delay--; + + i++; + tape->length++; + } + } + + if (feof(file)) + break; } - fclose(file); + if (i != tape->length) + chunk_size = (tape->num_participating_players + 1) * i; + + return chunk_size; } -void SaveScore(int level_nr) +void LoadTapeFromFilename(char *filename) { - int i; - char *filename = getScoreFilename(level_nr); + char cookie[MAX_LINE_LEN]; + char chunk_name[CHUNK_ID_LEN + 1]; FILE *file; + int chunk_size; - InitScoreDirectory(leveldir[leveldir_nr].filename); + /* always start with reliable default values */ + setTapeInfoToDefaults(); - if (!(file = fopen(filename, "w"))) - { - Error(ERR_WARN, "cannot save score for level %d", level_nr); + if (!(file = fopen(filename, MODE_READ))) return; + + getFileChunkBE(file, chunk_name, NULL); + if (strcmp(chunk_name, "RND1") == 0) + { + getFile32BitBE(file); /* not used */ + + getFileChunkBE(file, chunk_name, NULL); + if (strcmp(chunk_name, "TAPE") != 0) + { + Error(ERR_WARN, "unknown format of tape file '%s'", filename); + fclose(file); + return; + } } + else /* check for pre-2.0 file format with cookie string */ + { + strcpy(cookie, chunk_name); + fgets(&cookie[4], MAX_LINE_LEN - 4, file); + if (strlen(cookie) > 0 && cookie[strlen(cookie) - 1] == '\n') + cookie[strlen(cookie) - 1] = '\0'; - fprintf(file, "%s\n\n", SCORE_COOKIE); + if (!checkCookieString(cookie, TAPE_COOKIE_TMPL)) + { + Error(ERR_WARN, "unknown format of tape file '%s'", filename); + fclose(file); + return; + } - for(i=0; ifile_version); + putFileVersion(file, tape->game_version); +} -static char *string_tolower(char *s) +static void SaveTape_HEAD(FILE *file, struct TapeInfo *tape) { - static char s_lower[100]; int i; + byte store_participating_players = 0; - if (strlen(s) >= 100) - return s; + /* set bits for participating players for compact storage */ + for(i=0; iplayer_participates[i]) + store_participating_players |= (1 << i); + + putFile32BitBE(file, tape->random_seed); + putFile32BitBE(file, tape->date); + putFile32BitBE(file, tape->length); - strcpy(s_lower, s); + fputc(store_participating_players, file); - for (i=0; iengine_version); } -static int get_string_integer_value(char *s) +static void SaveTape_BODY(FILE *file, struct TapeInfo *tape) { - 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; - for (i=0; i<13; i++) - for (j=0; j<3; j++) - if (strcmp(string_tolower(s), number_text[i][j]) == 0) - return i; - - return atoi(s); -} + for(i=0; ilength; i++) + { + for(j=0; jplayer_participates[j]) + fputc(tape->pos[i].action[j], file); -static boolean get_string_boolean_value(char *s) -{ - if (strcmp(string_tolower(s), "true") == 0 || - strcmp(string_tolower(s), "yes") == 0 || - strcmp(string_tolower(s), "on") == 0 || - get_string_integer_value(s) == 1) - return TRUE; - else - return FALSE; + fputc(tape->pos[i].delay, file); + } } -static char *getFormattedSetupEntry(char *token, char *value) +void SaveTape(int level_nr) { int i; - static char entry[MAX_LINE_LEN]; - - sprintf(entry, "%s:", token); - for (i=strlen(entry); ifilename); - return entry; -} + /* if a tape still exists, ask to overwrite it */ + if (access(filename, F_OK) == 0) + { + new_tape = FALSE; + if (!Request("Replace old tape ?", REQ_ASK)) + return; + } -static void freeSetupFileList(struct SetupFileList *setup_file_list) -{ - if (!setup_file_list) + if (!(file = fopen(filename, MODE_WRITE))) + { + Error(ERR_WARN, "cannot save level recording file '%s'", filename); return; + } - if (setup_file_list->token) - free(setup_file_list->token); - if (setup_file_list->value) - free(setup_file_list->value); - if (setup_file_list->next) - freeSetupFileList(setup_file_list->next); - free(setup_file_list); -} + tape.file_version = FILE_VERSION_ACTUAL; + tape.game_version = GAME_VERSION_ACTUAL; -static struct SetupFileList *newSetupFileList(char *token, char *value) -{ - struct SetupFileList *new = checked_malloc(sizeof(struct SetupFileList)); + /* count number of participating players */ + for(i=0; itoken = checked_malloc(strlen(token) + 1); - strcpy(new->token, token); + body_chunk_size = (num_participating_players + 1) * tape.length; - new->value = checked_malloc(strlen(value) + 1); - strcpy(new->value, value); + putFileChunkBE(file, "RND1", CHUNK_SIZE_UNDEFINED); + putFileChunkBE(file, "TAPE", CHUNK_SIZE_NONE); - new->next = NULL; + putFileChunkBE(file, "VERS", FILE_VERS_CHUNK_SIZE); + SaveTape_VERS(file, &tape); - return new; -} + putFileChunkBE(file, "HEAD", TAPE_HEADER_SIZE); + SaveTape_HEAD(file, &tape); -static char *getTokenValue(struct SetupFileList *setup_file_list, - char *token) -{ - if (!setup_file_list) - return NULL; + putFileChunkBE(file, "BODY", body_chunk_size); + SaveTape_BODY(file, &tape); - if (strcmp(setup_file_list->token, token) == 0) - return setup_file_list->value; - else - return getTokenValue(setup_file_list->next, token); + fclose(file); + + SetFilePermissions(filename, PERMS_PRIVATE); + + tape.changed = FALSE; + + if (new_tape) + Request("tape saved !", REQ_CONFIRM); } -static void setTokenValue(struct SetupFileList *setup_file_list, - char *token, char *value) +void DumpTape(struct TapeInfo *tape) { - if (!setup_file_list) - return; + int i, j; - if (strcmp(setup_file_list->token, token) == 0) + if (TAPE_IS_EMPTY(*tape)) { - free(setup_file_list->value); - setup_file_list->value = checked_malloc(strlen(value) + 1); - strcpy(setup_file_list->value, value); + Error(ERR_WARN, "no tape available for level %d", tape->level_nr); + return; } - else if (setup_file_list->next == NULL) - setup_file_list->next = newSetupFileList(token, value); - else - setTokenValue(setup_file_list->next, token, value); -} -#ifdef DEBUG -static void printSetupFileList(struct SetupFileList *setup_file_list) -{ - if (!setup_file_list) - return; + printf_line('-', 79); + printf("Tape of Level %03d (file version %06d, game version %06d)\n", + tape->level_nr, tape->file_version, tape->game_version); + printf_line('-', 79); + + for(i=0; ilength; i++) + { + if (i >= MAX_TAPELEN) + break; + + printf("%03d: ", i); + + for(j=0; jplayer_participates[j]) + { + int action = tape->pos[i].action[j]; + + printf("%d:%02x ", j, action); + printf("[%c%c%c%c|%c%c] - ", + (action & JOY_LEFT ? '<' : ' '), + (action & JOY_RIGHT ? '>' : ' '), + (action & JOY_UP ? '^' : ' '), + (action & JOY_DOWN ? 'v' : ' '), + (action & JOY_BUTTON_1 ? '1' : ' '), + (action & JOY_BUTTON_2 ? '2' : ' ')); + } + } - printf("token: '%s'\n", setup_file_list->token); - printf("value: '%s'\n", setup_file_list->value); + printf("(%03d)\n", tape->pos[i].delay); + } - printSetupFileList(setup_file_list->next); + printf_line('-', 79); } -#endif -static struct SetupFileList *loadSetupFileList(char *filename) + +/* ========================================================================= */ +/* score file functions */ +/* ========================================================================= */ + +void LoadScore(int level_nr) { - int line_len; + int i; + char *filename = getScoreFilename(level_nr); + char cookie[MAX_LINE_LEN]; char line[MAX_LINE_LEN]; - char *token, *value, *line_ptr; - struct SetupFileList *setup_file_list = newSetupFileList("", ""); - struct SetupFileList *first_valid_list_entry; - + char *line_ptr; FILE *file; - if (!(file = fopen(filename, "r"))) + /* always start with reliable default values */ + for(i=0; i line; line_ptr--) - if ((*line_ptr == ' ' || *line_ptr == '\t') && line_ptr[1] == '\0') - *line_ptr = '\0'; + /* check file identifier */ + fgets(cookie, MAX_LINE_LEN, file); + if (strlen(cookie) > 0 && cookie[strlen(cookie) - 1] == '\n') + cookie[strlen(cookie) - 1] = '\0'; - /* ignore empty lines */ - if (*line == '\0') - continue; + if (!checkCookieString(cookie, SCORE_COOKIE)) + { + Error(ERR_WARN, "unknown format of score file '%s'", filename); + fclose(file); + return; + } - line_len = strlen(line); + for(i=0; ifilename); - if (*token && *value) - setTokenValue(setup_file_list, token, value); + if (!(file = fopen(filename, MODE_WRITE))) + { + Error(ERR_WARN, "cannot save score for level %d", level_nr); + return; } + fprintf(file, "%s\n\n", SCORE_COOKIE); + + for(i=0; inext; + SetFilePermissions(filename, PERMS_PUBLIC); +} + - /* free empty list header */ - setup_file_list->next = NULL; - freeSetupFileList(setup_file_list); +/* ========================================================================= */ +/* setup file functions */ +/* ========================================================================= */ - if (first_valid_list_entry == NULL) - Error(ERR_WARN, "configuration file '%s' is empty", filename); +#define TOKEN_STR_PLAYER_PREFIX "player_" - return first_valid_list_entry; -} +/* global setup */ +#define SETUP_TOKEN_PLAYER_NAME 0 +#define SETUP_TOKEN_SOUND 1 +#define SETUP_TOKEN_SOUND_LOOPS 2 +#define SETUP_TOKEN_SOUND_MUSIC 3 +#define SETUP_TOKEN_SOUND_SIMPLE 4 +#define SETUP_TOKEN_TOONS 5 +#define SETUP_TOKEN_SCROLL_DELAY 6 +#define SETUP_TOKEN_SOFT_SCROLLING 7 +#define SETUP_TOKEN_FADING 8 +#define SETUP_TOKEN_AUTORECORD 9 +#define SETUP_TOKEN_QUICK_DOORS 10 +#define SETUP_TOKEN_TEAM_MODE 11 +#define SETUP_TOKEN_HANDICAP 12 +#define SETUP_TOKEN_TIME_LIMIT 13 +#define SETUP_TOKEN_FULLSCREEN 14 +#define SETUP_TOKEN_ASK_ON_ESCAPE 15 +#define SETUP_TOKEN_GRAPHICS_SET 16 +#define SETUP_TOKEN_SOUNDS_SET 17 +#define SETUP_TOKEN_MUSIC_SET 18 +#define SETUP_TOKEN_OVERRIDE_LEVEL_GRAPHICS 19 +#define SETUP_TOKEN_OVERRIDE_LEVEL_SOUNDS 20 +#define SETUP_TOKEN_OVERRIDE_LEVEL_MUSIC 21 + +#define NUM_GLOBAL_SETUP_TOKENS 22 + +/* editor setup */ +#define SETUP_TOKEN_EDITOR_EL_BOULDERDASH 0 +#define SETUP_TOKEN_EDITOR_EL_EMERALD_MINE 1 +#define SETUP_TOKEN_EDITOR_EL_MORE 2 +#define SETUP_TOKEN_EDITOR_EL_SOKOBAN 3 +#define SETUP_TOKEN_EDITOR_EL_SUPAPLEX 4 +#define SETUP_TOKEN_EDITOR_EL_DIAMOND_CAVES 5 +#define SETUP_TOKEN_EDITOR_EL_DX_BOULDERDASH 6 +#define SETUP_TOKEN_EDITOR_EL_CHARS 7 +#define SETUP_TOKEN_EDITOR_EL_CUSTOM 8 + +#define NUM_EDITOR_SETUP_TOKENS 9 + +/* shortcut setup */ +#define SETUP_TOKEN_SHORTCUT_SAVE_GAME 0 +#define SETUP_TOKEN_SHORTCUT_LOAD_GAME 1 +#define SETUP_TOKEN_SHORTCUT_TOGGLE_PAUSE 2 + +#define NUM_SHORTCUT_SETUP_TOKENS 3 + +/* player setup */ +#define SETUP_TOKEN_PLAYER_USE_JOYSTICK 0 +#define SETUP_TOKEN_PLAYER_JOY_DEVICE_NAME 1 +#define SETUP_TOKEN_PLAYER_JOY_XLEFT 2 +#define SETUP_TOKEN_PLAYER_JOY_XMIDDLE 3 +#define SETUP_TOKEN_PLAYER_JOY_XRIGHT 4 +#define SETUP_TOKEN_PLAYER_JOY_YUPPER 5 +#define SETUP_TOKEN_PLAYER_JOY_YMIDDLE 6 +#define SETUP_TOKEN_PLAYER_JOY_YLOWER 7 +#define SETUP_TOKEN_PLAYER_JOY_SNAP 8 +#define SETUP_TOKEN_PLAYER_JOY_BOMB 9 +#define SETUP_TOKEN_PLAYER_KEY_LEFT 10 +#define SETUP_TOKEN_PLAYER_KEY_RIGHT 11 +#define SETUP_TOKEN_PLAYER_KEY_UP 12 +#define SETUP_TOKEN_PLAYER_KEY_DOWN 13 +#define SETUP_TOKEN_PLAYER_KEY_SNAP 14 +#define SETUP_TOKEN_PLAYER_KEY_BOMB 15 + +#define NUM_PLAYER_SETUP_TOKENS 16 + +static struct SetupInfo si; +static struct SetupEditorInfo sei; +static struct SetupShortcutInfo ssi; +static struct SetupInputInfo sii; -static void checkSetupFileListIdentifier(struct SetupFileList *setup_file_list, - char *identifier) +static struct TokenInfo global_setup_tokens[] = { - if (!setup_file_list) - return; + /* global setup */ + { TYPE_STRING, &si.player_name, "player_name" }, + { TYPE_SWITCH, &si.sound, "sound" }, + { TYPE_SWITCH, &si.sound_loops, "repeating_sound_loops" }, + { TYPE_SWITCH, &si.sound_music, "background_music" }, + { TYPE_SWITCH, &si.sound_simple, "simple_sound_effects" }, + { TYPE_SWITCH, &si.toons, "toons" }, + { TYPE_SWITCH, &si.scroll_delay, "scroll_delay" }, + { TYPE_SWITCH, &si.soft_scrolling, "soft_scrolling" }, + { TYPE_SWITCH, &si.fading, "screen_fading" }, + { TYPE_SWITCH, &si.autorecord, "automatic_tape_recording" }, + { TYPE_SWITCH, &si.quick_doors, "quick_doors" }, + { TYPE_SWITCH, &si.team_mode, "team_mode" }, + { TYPE_SWITCH, &si.handicap, "handicap" }, + { TYPE_SWITCH, &si.time_limit, "time_limit" }, + { TYPE_SWITCH, &si.fullscreen, "fullscreen" }, + { TYPE_SWITCH, &si.ask_on_escape, "ask_on_escape" }, + { TYPE_STRING, &si.graphics_set, "graphics_set" }, + { TYPE_STRING, &si.sounds_set, "sounds_set" }, + { TYPE_STRING, &si.music_set, "music_set" }, + { TYPE_SWITCH, &si.override_level_graphics, "override_level_graphics" }, + { TYPE_SWITCH, &si.override_level_sounds, "override_level_sounds" }, + { TYPE_SWITCH, &si.override_level_music, "override_level_music" }, +}; - if (strcmp(setup_file_list->token, TOKEN_STR_FILE_IDENTIFIER) == 0) - { - if (strcmp(setup_file_list->value, identifier) != 0) - { - Error(ERR_WARN, "configuration file has wrong version"); - return; - } - else - return; - } +static struct TokenInfo editor_setup_tokens[] = +{ + /* shortcut setup */ + { TYPE_SWITCH, &sei.el_boulderdash, "editor.el_boulderdash" }, + { TYPE_SWITCH, &sei.el_emerald_mine, "editor.el_emerald_mine" }, + { TYPE_SWITCH, &sei.el_more, "editor.el_more" }, + { TYPE_SWITCH, &sei.el_sokoban, "editor.el_sokoban" }, + { TYPE_SWITCH, &sei.el_supaplex, "editor.el_supaplex" }, + { TYPE_SWITCH, &sei.el_diamond_caves, "editor.el_diamond_caves" }, + { TYPE_SWITCH, &sei.el_dx_boulderdash,"editor.el_dx_boulderdash" }, + { TYPE_SWITCH, &sei.el_chars, "editor.el_chars" }, + { TYPE_SWITCH, &sei.el_custom, "editor.el_custom" }, +}; - if (setup_file_list->next) - checkSetupFileListIdentifier(setup_file_list->next, identifier); - else - { - Error(ERR_WARN, "configuration file has no version information"); - return; - } -} +static struct TokenInfo shortcut_setup_tokens[] = +{ + /* shortcut setup */ + { TYPE_KEY_X11, &ssi.save_game, "shortcut.save_game" }, + { TYPE_KEY_X11, &ssi.load_game, "shortcut.load_game" }, + { TYPE_KEY_X11, &ssi.toggle_pause, "shortcut.toggle_pause" } +}; -static void setLevelDirInfoToDefaults(struct LevelDirInfo *ldi) +static struct TokenInfo player_setup_tokens[] = { - ldi->name = getStringCopy(ANONYMOUS_NAME); - ldi->author = getStringCopy(ANONYMOUS_NAME); - ldi->levels = 0; - ldi->first_level = 0; - ldi->sort_priority = LEVELCLASS_UNDEFINED; /* default: least priority */ - ldi->readonly = TRUE; -} + /* player setup */ + { TYPE_BOOLEAN, &sii.use_joystick, ".use_joystick" }, + { TYPE_STRING, &sii.joy.device_name, ".joy.device_name" }, + { TYPE_INTEGER, &sii.joy.xleft, ".joy.xleft" }, + { TYPE_INTEGER, &sii.joy.xmiddle, ".joy.xmiddle" }, + { TYPE_INTEGER, &sii.joy.xright, ".joy.xright" }, + { TYPE_INTEGER, &sii.joy.yupper, ".joy.yupper" }, + { TYPE_INTEGER, &sii.joy.ymiddle, ".joy.ymiddle" }, + { TYPE_INTEGER, &sii.joy.ylower, ".joy.ylower" }, + { TYPE_INTEGER, &sii.joy.snap, ".joy.snap_field" }, + { TYPE_INTEGER, &sii.joy.bomb, ".joy.place_bomb" }, + { TYPE_KEY_X11, &sii.key.left, ".key.move_left" }, + { TYPE_KEY_X11, &sii.key.right, ".key.move_right" }, + { TYPE_KEY_X11, &sii.key.up, ".key.move_up" }, + { TYPE_KEY_X11, &sii.key.down, ".key.move_down" }, + { TYPE_KEY_X11, &sii.key.snap, ".key.snap_field" }, + { TYPE_KEY_X11, &sii.key.bomb, ".key.place_bomb" } +}; static void setSetupInfoToDefaults(struct SetupInfo *si) { @@ -1267,11 +1403,37 @@ static void setSetupInfoToDefaults(struct SetupInfo *si) si->fading = FALSE; si->autorecord = TRUE; si->quick_doors = FALSE; + si->team_mode = FALSE; + si->handicap = TRUE; + si->time_limit = TRUE; + si->fullscreen = FALSE; + si->ask_on_escape = TRUE; + + si->graphics_set = getStringCopy(GRAPHICS_SUBDIR); + si->sounds_set = getStringCopy(SOUNDS_SUBDIR); + si->music_set = getStringCopy(MUSIC_SUBDIR); + si->override_level_graphics = FALSE; + si->override_level_sounds = FALSE; + si->override_level_music = FALSE; + + si->editor.el_boulderdash = TRUE; + si->editor.el_emerald_mine = TRUE; + si->editor.el_more = TRUE; + si->editor.el_sokoban = TRUE; + si->editor.el_supaplex = TRUE; + si->editor.el_diamond_caves = TRUE; + si->editor.el_dx_boulderdash = TRUE; + si->editor.el_chars = TRUE; + si->editor.el_custom = FALSE; + + si->shortcut.save_game = DEFAULT_KEY_SAVE_GAME; + si->shortcut.load_game = DEFAULT_KEY_LOAD_GAME; + si->shortcut.toggle_pause = DEFAULT_KEY_TOGGLE_PAUSE; for (i=0; iinput[i].use_joystick = FALSE; - si->input[i].joy.device_name = getStringCopy(joystick_device_name[i]); + si->input[i].joy.device_name=getStringCopy(getDeviceNameFromJoystickNr(i)); si->input[i].joy.xleft = JOYSTICK_XLEFT; si->input[i].joy.xmiddle = JOYSTICK_XMIDDLE; si->input[i].joy.xright = JOYSTICK_XRIGHT; @@ -1280,47 +1442,12 @@ static void setSetupInfoToDefaults(struct SetupInfo *si) si->input[i].joy.ylower = JOYSTICK_YLOWER; si->input[i].joy.snap = (i == 0 ? JOY_BUTTON_1 : 0); si->input[i].joy.bomb = (i == 0 ? JOY_BUTTON_2 : 0); - si->input[i].key.left = (i == 0 ? DEFAULT_KEY_LEFT : KEY_UNDEFINDED); - si->input[i].key.right = (i == 0 ? DEFAULT_KEY_RIGHT : KEY_UNDEFINDED); - si->input[i].key.up = (i == 0 ? DEFAULT_KEY_UP : KEY_UNDEFINDED); - si->input[i].key.down = (i == 0 ? DEFAULT_KEY_DOWN : KEY_UNDEFINDED); - si->input[i].key.snap = (i == 0 ? DEFAULT_KEY_SNAP : KEY_UNDEFINDED); - si->input[i].key.bomb = (i == 0 ? DEFAULT_KEY_BOMB : KEY_UNDEFINDED); - } -} - -static void setSetupInfo(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_string_boolean_value(token_value); - break; - - case TYPE_KEYSYM: - *(KeySym *)setup_value = getKeySymFromX11KeyName(token_value); - break; - - case TYPE_INTEGER: - *(int *)setup_value = get_string_integer_value(token_value); - break; - - case TYPE_STRING: - if (*(char **)setup_value != NULL) - free(*(char **)setup_value); - *(char **)setup_value = getStringCopy(token_value); - break; - - default: - break; + si->input[i].key.left = (i == 0 ? DEFAULT_KEY_LEFT : KSYM_UNDEFINED); + si->input[i].key.right = (i == 0 ? DEFAULT_KEY_RIGHT : KSYM_UNDEFINED); + si->input[i].key.up = (i == 0 ? DEFAULT_KEY_UP : KSYM_UNDEFINED); + si->input[i].key.down = (i == 0 ? DEFAULT_KEY_DOWN : KSYM_UNDEFINED); + si->input[i].key.snap = (i == 0 ? DEFAULT_KEY_SNAP : KSYM_UNDEFINED); + si->input[i].key.bomb = (i == 0 ? DEFAULT_KEY_BOMB : KSYM_UNDEFINED); } } @@ -1331,13 +1458,28 @@ static void decodeSetupFileList(struct SetupFileList *setup_file_list) if (!setup_file_list) return; - /* handle global setup values */ + /* global setup */ si = setup; - for (i=FIRST_GLOBAL_SETUP_TOKEN; i<=LAST_GLOBAL_SETUP_TOKEN; i++) - setSetupInfo(i, getTokenValue(setup_file_list, token_info[i].text)); + for (i=0; i leveldir[level_series_nr].last_level) - last_level_nr = leveldir[level_series_nr].last_level; - } - - return last_level_nr; -} - -static int compareLevelDirInfoEntries(const void *object1, const void *object2) -{ - const struct LevelDirInfo *entry1 = object1; - const struct LevelDirInfo *entry2 = object2; - int compare_result; - - if (entry1->sort_priority != entry2->sort_priority) - compare_result = entry1->sort_priority - entry2->sort_priority; - else - { - char *name1 = getStringToLower(entry1->name); - char *name2 = getStringToLower(entry2->name); - - compare_result = strcmp(name1, name2); - - free(name1); - free(name2); - } - - return compare_result; -} - -static int LoadLevelInfoFromLevelDir(char *level_directory, int start_entry) -{ - DIR *dir; - struct stat file_status; - char *directory = NULL; - char *filename = NULL; - struct SetupFileList *setup_file_list = NULL; - struct dirent *dir_entry; - int i, current_entry = start_entry; - - if ((dir = opendir(level_directory)) == NULL) - { - Error(ERR_WARN, "cannot read level directory '%s'", level_directory); - return current_entry; - } - - while (current_entry < MAX_LEVDIR_ENTRIES) - { - if ((dir_entry = readdir(dir)) == NULL) /* last directory entry */ - break; - - /* skip entries for current and parent directory */ - if (strcmp(dir_entry->d_name, ".") == 0 || - strcmp(dir_entry->d_name, "..") == 0) - continue; - - /* find out if directory entry is itself a directory */ - directory = getPath2(level_directory, dir_entry->d_name); - if (stat(directory, &file_status) != 0 || /* cannot stat file */ - (file_status.st_mode & S_IFMT) != S_IFDIR) /* not a directory */ - { - free(directory); - continue; - } - - filename = getPath2(directory, LEVELINFO_FILENAME); - setup_file_list = loadSetupFileList(filename); - - if (setup_file_list) - { - checkSetupFileListIdentifier(setup_file_list, LEVELINFO_COOKIE); - setLevelDirInfoToDefaults(&leveldir[current_entry]); - - ldi = leveldir[current_entry]; - for (i=FIRST_LEVELINFO_TOKEN; i<=LAST_LEVELINFO_TOKEN; i++) - setSetupInfo(i, getTokenValue(setup_file_list, token_info[i].text)); - leveldir[current_entry] = ldi; - - leveldir[current_entry].filename = getStringCopy(dir_entry->d_name); - leveldir[current_entry].last_level = - leveldir[current_entry].first_level + - leveldir[current_entry].levels - 1; - leveldir[current_entry].user_defined = - (level_directory == options.level_directory ? FALSE : TRUE); - leveldir[current_entry].color = LEVELCOLOR(current_entry); - - freeSetupFileList(setup_file_list); - current_entry++; - } - else - Error(ERR_WARN, "ignoring level directory '%s'", directory); - - free(directory); - free(filename); - } - - if (current_entry == MAX_LEVDIR_ENTRIES) - Error(ERR_WARN, "using %d level directories -- ignoring the rest", - current_entry); - - closedir(dir); - - if (current_entry == start_entry) - Error(ERR_WARN, "cannot find any valid level series in directory '%s'", - level_directory); - - return current_entry; -} - -void LoadLevelInfo() -{ - InitUserLevelDirectory(getLoginName()); - - num_leveldirs = 0; - leveldir_nr = 0; - - num_leveldirs = LoadLevelInfoFromLevelDir(options.level_directory, - num_leveldirs); - num_leveldirs = LoadLevelInfoFromLevelDir(getUserLevelDir(""), - num_leveldirs); - - if (num_leveldirs == 0) - Error(ERR_EXIT, "cannot find any valid level series in any directory"); - - if (num_leveldirs > 1) - qsort(leveldir, num_leveldirs, sizeof(struct LevelDirInfo), - compareLevelDirInfoEntries); -} - -static void SaveUserLevelInfo() -{ - char *filename; - FILE *file; - int i; - - filename = getPath2(getUserLevelDir(getLoginName()), LEVELINFO_FILENAME); - - if (!(file = fopen(filename, "w"))) - { - Error(ERR_WARN, "cannot write level info file '%s'", filename); - free(filename); - return; - } - - /* always start with reliable default values */ - setLevelDirInfoToDefaults(&ldi); - - ldi.name = getLoginName(); - ldi.author = getRealName(); - ldi.levels = 100; - ldi.first_level = 1; - ldi.sort_priority = LEVELCLASS_USER_START; - ldi.readonly = FALSE; - - fprintf(file, "%s\n\n", - getFormattedSetupEntry(TOKEN_STR_FILE_IDENTIFIER, LEVELINFO_COOKIE)); - - for (i=FIRST_LEVELINFO_TOKEN; i<=LAST_LEVELINFO_TOKEN; i++) - fprintf(file, "%s\n", getSetupLine("", i)); - - fclose(file); - free(filename); - - chmod(filename, SETUP_PERMS); -} - void LoadSetup() { - char *filename; + char *filename = getSetupFilename(); struct SetupFileList *setup_file_list = NULL; /* always start with reliable default values */ setSetupInfoToDefaults(&setup); - filename = getPath2(getSetupDir(), SETUP_FILENAME); - setup_file_list = loadSetupFileList(filename); if (setup_file_list) { - checkSetupFileListIdentifier(setup_file_list, SETUP_COOKIE); + checkSetupFileListIdentifier(setup_file_list, getCookie("SETUP")); decodeSetupFileList(setup_file_list); setup.direct_draw = !setup.double_buffering; @@ -1574,11 +1519,11 @@ void LoadSetup() freeSetupFileList(setup_file_list); /* needed to work around problems with fixed length strings */ - if (strlen(setup.player_name) >= MAX_NAMELEN) - setup.player_name[MAX_NAMELEN - 1] = '\0'; - else if (strlen(setup.player_name) < MAX_NAMELEN - 1) + if (strlen(setup.player_name) > MAX_PLAYER_NAME_LEN) + setup.player_name[MAX_PLAYER_NAME_LEN] = '\0'; + else if (strlen(setup.player_name) < MAX_PLAYER_NAME_LEN) { - char *new_name = checked_malloc(MAX_NAMELEN); + char *new_name = checked_malloc(MAX_PLAYER_NAME_LEN + 1); strcpy(new_name, setup.player_name); free(setup.player_name); @@ -1587,106 +1532,51 @@ void LoadSetup() } else Error(ERR_WARN, "using default setup values"); - - free(filename); -} - -static char *getSetupLine(char *prefix, int token_nr) -{ - int i; - static char entry[MAX_LINE_LEN]; - int token_type = token_info[token_nr].type; - void *setup_value = token_info[token_nr].value; - char *token_text = token_info[token_nr].text; - - /* start with the prefix, token and some spaces to format output line */ - sprintf(entry, "%s%s:", prefix, token_text); - for (i=strlen(entry); itoken, TOKEN_STR_FILE_IDENTIFIER) != 0) - fprintf(file, "%s\n", - getFormattedSetupEntry(list_entry->token, list_entry->value)); - - /* just to make things nicer :) */ - if (strcmp(list_entry->token, TOKEN_STR_LAST_LEVEL_SERIES) == 0) - fprintf(file, "\n"); - - list_entry = list_entry->next; + for (i=0; i