src/fileio_func.h

   1 /* $Id: fileio_func.h 25974 2013-11-13 18:57:25Z rubidium $ */
   2
   3 /*
   4  * This file is part of OpenTTD.
   5  * 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.
   6  * 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.
   7  * 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/>.
   8  */
   9
  10 /** @file fileio_func.h Functions for Standard In/Out file operations */
  11
  12 #ifndef FILEIO_FUNC_H
  13 #define FILEIO_FUNC_H
  14
  15 #include "core/enum_type.hpp"
  16 #include "fileio_type.h"
  17
  18 void FioSeekTo(size_t pos, int mode);
  19 void FioSeekToFile(uint slot, size_t pos);
  20 size_t FioGetPos();
  21 const char *FioGetFilename(uint slot);
  22 byte FioReadByte();
  23 uint16 FioReadWord();
  24 uint32 FioReadDword();
  25 void FioCloseAll();
  26 void FioOpenFile(uint slot, const char *filename, Subdirectory subdir);
  27 void FioReadBlock(void *ptr, size_t size);
  28 void FioSkipBytes(int n);
  29
  30 /**
  31  * The search paths OpenTTD could search through.
  32  * At least one of the slots has to be filled with a path.
  33  * nullptr paths tell that there is no such path for the
  34  * current operating system.
  35  */
  36 extern const char *_searchpaths[NUM_SEARCHPATHS];
  37
  38 /**
  39  * Checks whether the given search path is a valid search path
  40  * @param sp the search path to check
  41  * @return true if the search path is valid
  42  */
  43 static inline bool IsValidSearchPath(Searchpath sp)
  44 {
  45         return sp < NUM_SEARCHPATHS && _searchpaths[sp] != nullptr;
  46 }
  47
  48 /** Iterator for all the search paths */
  49 #define FOR_ALL_SEARCHPATHS(sp) for (sp = SP_FIRST_DIR; sp < NUM_SEARCHPATHS; sp++) if (IsValidSearchPath(sp))
  50
  51 void FioFCloseFile(FILE *f);
  52 FILE *FioFOpenFile(const char *filename, const char *mode, Subdirectory subdir, size_t *filesize = nullptr);
  53 bool FioCheckFileExists(const char *filename, Subdirectory subdir);
  54 char *FioGetFullPath(char *buf, const char *last, Searchpath sp, Subdirectory subdir, const char *filename);
  55 char *FioFindFullPath(char *buf, const char *last, Subdirectory subdir, const char *filename);
  56 char *FioAppendDirectory(char *buf, const char *last, Searchpath sp, Subdirectory subdir);
  57 char *FioGetDirectory(char *buf, const char *last, Subdirectory subdir);
  58
  59 const char *FiosGetScreenshotDir();
  60
  61 void SanitizeFilename(char *filename);
  62 bool AppendPathSeparator(char *buf, const char *last);
  63 void DeterminePaths(const char *exe);
  64 void *ReadFileToMem(const char *filename, size_t *lenp, size_t maxsize);
  65 bool FileExists(const char *filename);
  66 const char *FioTarFirstDir(const char *tarname, Subdirectory subdir);
  67 void FioTarAddLink(const char *src, const char *dest, Subdirectory subdir);
  68 bool ExtractTar(const char *tar_filename, Subdirectory subdir);
  69
  70 extern const char *_personal_dir; ///< custom directory for personal settings, saves, newgrf, etc.
  71
  72 /** Helper for scanning for files with a given name */
  73 class FileScanner {
  74 protected:
  75         Subdirectory subdir; ///< The current sub directory we are searching through
  76 public:
  77         /** Destruct the proper one... */
  78         virtual ~FileScanner() {}
  79
  80         uint Scan(const char *extension, Subdirectory sd, bool tars = true, bool recursive = true);
  81         uint Scan(const char *extension, const char *directory, bool recursive = true);
  82
  83         /**
  84          * Add a file with the given filename.
  85          * @param filename        the full path to the file to read
  86          * @param basepath_length amount of characters to chop of before to get a
  87          *                        filename relative to the search path.
  88          * @param tar_filename    the name of the tar file the file is read from.
  89          * @return true if the file is added.
  90          */
  91         virtual bool AddFile(const char *filename, size_t basepath_length, const char *tar_filename) = 0;
  92 };
  93
  94 /** Helper for scanning for files with tar as extension */
  95 class TarScanner : FileScanner {
  96         uint DoScan(Subdirectory sd);
  97 public:
  98         /** The mode of tar scanning. */
  99         enum Mode {
 100                 NONE     = 0,      ///< Scan nothing.
 101                 BASESET  = 1 << 0, ///< Scan for base sets.
 102                 NEWGRF   = 1 << 1, ///< Scan for non-base sets.
 103                 AI       = 1 << 2, ///< Scan for AIs and its libraries.
 104                 SCENARIO = 1 << 3, ///< Scan for scenarios and heightmaps.
 105                 GAME     = 1 << 4, ///< Scan for game scripts.
 106                 ALL      = BASESET | NEWGRF | AI | SCENARIO | GAME, ///< Scan for everything.
 107         };
 108
 109         /* virtual */ bool AddFile(const char *filename, size_t basepath_length, const char *tar_filename = nullptr);
 110
 111         bool AddFile(Subdirectory sd, const char *filename);
 112
 113         /** Do the scan for Tars. */
 114         static uint DoScan(TarScanner::Mode mode);
 115 };
 116
 117 DECLARE_ENUM_AS_BIT_SET(TarScanner::Mode)
 118
 119 /* Implementation of opendir/readdir/closedir for Windows */
 120 #if defined(WIN32)
 121 struct DIR;
 122
 123 struct dirent { // XXX - only d_name implemented
 124         TCHAR *d_name; // name of found file
 125         /* little hack which will point to parent DIR struct which will
 126          * save us a call to GetFileAttributes if we want information
 127          * about the file (for example in function fio_bla) */
 128         DIR *dir;
 129 };
 130
 131 DIR *opendir(const TCHAR *path);
 132 struct dirent *readdir(DIR *d);
 133 int closedir(DIR *d);
 134 #else
 135 /* Use system-supplied opendir/readdir/closedir functions */
 136 # include <sys/types.h>
 137 # include <dirent.h>
 138 #endif /* defined(WIN32) */
 139
 140 /**
 141  * A wrapper around opendir() which will convert the string from
 142  * OPENTTD encoding to that of the filesystem. For all purposes this
 143  * function behaves the same as the original opendir function
 144  * @param path string to open directory of
 145  * @return DIR pointer
 146  */
 147 static inline DIR *ttd_opendir(const char *path)
 148 {
 149         return opendir(OTTD2FS(path));
 150 }
 151
 152 #endif /* FILEIO_FUNC_H */