/* * This file is part of OpenTTD. * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2. * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>. */ /** @file fileio_func.h Functions for Standard In/Out file operations */ #ifndef FILEIO_FUNC_H #define FILEIO_FUNC_H #include "core/enum_type.hpp" #include "fileio_type.h" #include <string> void FioSeekTo(size_t pos, int mode); void FioSeekToFile(uint8 slot, size_t pos); size_t FioGetPos(); const char *FioGetFilename(uint8 slot); byte FioReadByte(); uint16 FioReadWord(); uint32 FioReadDword(); void FioCloseAll(); void FioOpenFile(int slot, const std::string &filename, Subdirectory subdir); void FioReadBlock(void *ptr, size_t size); void FioSkipBytes(int n); /** * Checks whether the given search path is a valid search path * @param sp the search path to check * @return true if the search path is valid */ bool IsValidSearchPath(Searchpath sp); /** Iterator for all the search paths */ #define FOR_ALL_SEARCHPATHS(sp) for (sp = SP_FIRST_DIR; sp < NUM_SEARCHPATHS; sp++) if (IsValidSearchPath(sp)) void FioFCloseFile(FILE *f); FILE *FioFOpenFile(const std::string &filename, const char *mode, Subdirectory subdir, size_t *filesize = nullptr); bool FioCheckFileExists(const std::string &filename, Subdirectory subdir); std::string FioFindFullPath(Subdirectory subdir, const char *filename); std::string FioGetDirectory(Searchpath sp, Subdirectory subdir); std::string FioFindDirectory(Subdirectory subdir); void FioCreateDirectory(const std::string &name); const char *FiosGetScreenshotDir(); void SanitizeFilename(char *filename); void AppendPathSeparator(std::string &buf); void DeterminePaths(const char *exe); std::unique_ptr<char> ReadFileToMem(const std::string &filename, size_t &lenp, size_t maxsize); bool FileExists(const std::string &filename); bool ExtractTar(const std::string &tar_filename, Subdirectory subdir); extern std::string _personal_dir; ///< custom directory for personal settings, saves, newgrf, etc. /** Helper for scanning for files with a given name */ class FileScanner { protected: Subdirectory subdir; ///< The current sub directory we are searching through public: /** Destruct the proper one... */ virtual ~FileScanner() {} uint Scan(const char *extension, Subdirectory sd, bool tars = true, bool recursive = true); uint Scan(const char *extension, const char *directory, bool recursive = true); /** * Add a file with the given filename. * @param filename the full path to the file to read * @param basepath_length amount of characters to chop of before to get a * filename relative to the search path. * @param tar_filename the name of the tar file the file is read from. * @return true if the file is added. */ virtual bool AddFile(const std::string &filename, size_t basepath_length, const std::string &tar_filename) = 0; }; /** Helper for scanning for files with tar as extension */ class TarScanner : FileScanner { uint DoScan(Subdirectory sd); public: /** The mode of tar scanning. */ enum Mode { NONE = 0, ///< Scan nothing. BASESET = 1 << 0, ///< Scan for base sets. NEWGRF = 1 << 1, ///< Scan for non-base sets. AI = 1 << 2, ///< Scan for AIs and its libraries. SCENARIO = 1 << 3, ///< Scan for scenarios and heightmaps. GAME = 1 << 4, ///< Scan for game scripts. ALL = BASESET | NEWGRF | AI | SCENARIO | GAME, ///< Scan for everything. }; bool AddFile(const std::string &filename, size_t basepath_length, const std::string &tar_filename = {}) override; bool AddFile(Subdirectory sd, const std::string &filename); /** Do the scan for Tars. */ static uint DoScan(TarScanner::Mode mode); }; DECLARE_ENUM_AS_BIT_SET(TarScanner::Mode) /* Implementation of opendir/readdir/closedir for Windows */ #if defined(_WIN32) struct DIR; struct dirent { // XXX - only d_name implemented wchar_t *d_name; // name of found file /* little hack which will point to parent DIR struct which will * save us a call to GetFileAttributes if we want information * about the file (for example in function fio_bla) */ DIR *dir; }; DIR *opendir(const wchar_t *path); struct dirent *readdir(DIR *d); int closedir(DIR *d); #else /* Use system-supplied opendir/readdir/closedir functions */ # include <sys/types.h> # include <dirent.h> #endif /* defined(_WIN32) */ /** * A wrapper around opendir() which will convert the string from * OPENTTD encoding to that of the filesystem. For all purposes this * function behaves the same as the original opendir function * @param path string to open directory of * @return DIR pointer */ static inline DIR *ttd_opendir(const char *path) { return opendir(OTTD2FS(path)); } /** Auto-close a file upon scope exit. */ class FileCloser { FILE *f; public: FileCloser(FILE *_f) : f(_f) {} ~FileCloser() { fclose(f); } }; /** Helper to manage a FILE with a \c std::unique_ptr. */ struct FileDeleter { void operator()(FILE *f) { if (f) fclose(f); } }; #endif /* FILEIO_FUNC_H */