Files
@ r21266:9fbfc77e83c8
Branch filter:
Location: cpp/openttd-patchpack/source/src/fileio_func.h - annotation
r21266:9fbfc77e83c8
5.5 KiB
text/x-c
(svn r26354) -Update from WebTranslator v3.0:
frisian - 22 changes by Geoloep
frisian - 22 changes by Geoloep
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 | r10039:727fb45b0424 r10039:727fb45b0424 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r10039:727fb45b0424 r10039:727fb45b0424 r10039:727fb45b0424 r10039:727fb45b0424 r10039:727fb45b0424 r18371:8ec67d29c1db r10039:727fb45b0424 r10039:727fb45b0424 r10039:727fb45b0424 r10039:727fb45b0424 r10039:727fb45b0424 r10039:727fb45b0424 r10039:727fb45b0424 r10039:727fb45b0424 r10039:727fb45b0424 r10039:727fb45b0424 r18006:071d51c996ad r10039:727fb45b0424 r10039:727fb45b0424 r10039:727fb45b0424 r10039:727fb45b0424 r17674:8ba1e586d6d1 r10039:727fb45b0424 r10039:727fb45b0424 r10039:727fb45b0424 r10039:727fb45b0424 r10039:727fb45b0424 r10039:727fb45b0424 r10039:727fb45b0424 r10039:727fb45b0424 r10039:727fb45b0424 r10039:727fb45b0424 r10039:727fb45b0424 r10039:727fb45b0424 r10039:727fb45b0424 r10039:727fb45b0424 r10039:727fb45b0424 r10039:727fb45b0424 r10039:727fb45b0424 r10039:727fb45b0424 r10039:727fb45b0424 r10039:727fb45b0424 r18008:ce1722c7e707 r18008:ce1722c7e707 r10039:727fb45b0424 r10039:727fb45b0424 r10039:727fb45b0424 r10039:727fb45b0424 r10039:727fb45b0424 r19849:42900960d059 r19849:42900960d059 r10039:727fb45b0424 r15140:17ee0814362e r10039:727fb45b0424 r10039:727fb45b0424 r10039:727fb45b0424 r18370:7fbb35cad336 r18370:7fbb35cad336 r18370:7fbb35cad336 r10039:727fb45b0424 r20927:6e37de998bbe r10039:727fb45b0424 r10039:727fb45b0424 r18016:ed7b28b213ba r18016:ed7b28b213ba r18016:ed7b28b213ba r10039:727fb45b0424 r10047:088b8b265ea0 r10047:088b8b265ea0 r10047:088b8b265ea0 r11252:706b96dca92b r11252:706b96dca92b r10039:727fb45b0424 r10039:727fb45b0424 r10039:727fb45b0424 r10039:727fb45b0424 r10039:727fb45b0424 r10039:727fb45b0424 r18073:853f8705886d r10039:727fb45b0424 r10039:727fb45b0424 r18073:853f8705886d r10039:727fb45b0424 r10039:727fb45b0424 r15138:94bac05d24df r15138:94bac05d24df r18370:7fbb35cad336 r15138:94bac05d24df r18371:8ec67d29c1db r18371:8ec67d29c1db r18371:8ec67d29c1db r18371:8ec67d29c1db r18371:8ec67d29c1db r18371:8ec67d29c1db r18371:8ec67d29c1db r18747:12d6e8d373e7 r18747:12d6e8d373e7 r18371:8ec67d29c1db r18371:8ec67d29c1db r18073:853f8705886d r15138:94bac05d24df r18388:b05150903c57 r18388:b05150903c57 r15138:94bac05d24df r18371:8ec67d29c1db r15138:94bac05d24df r10039:727fb45b0424 r18371:8ec67d29c1db r18371:8ec67d29c1db r10039:727fb45b0424 r10039:727fb45b0424 r10039:727fb45b0424 r10039:727fb45b0424 r10039:727fb45b0424 r10039:727fb45b0424 r10039:727fb45b0424 r10039:727fb45b0424 r10039:727fb45b0424 r10039:727fb45b0424 r10039:727fb45b0424 r10039:727fb45b0424 r10039:727fb45b0424 r10039:727fb45b0424 r10039:727fb45b0424 r10039:727fb45b0424 r10039:727fb45b0424 r10039:727fb45b0424 r10039:727fb45b0424 r10039:727fb45b0424 r10039:727fb45b0424 r10039:727fb45b0424 r10039:727fb45b0424 r10039:727fb45b0424 r10039:727fb45b0424 r10039:727fb45b0424 r10039:727fb45b0424 r10039:727fb45b0424 r10039:727fb45b0424 r10039:727fb45b0424 r10039:727fb45b0424 r10039:727fb45b0424 r10039:727fb45b0424 r10039:727fb45b0424 | /* $Id$ */
/*
* 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"
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 char *filename, Subdirectory subdir);
void FioReadBlock(void *ptr, size_t size);
void FioSkipBytes(int n);
/**
* The search paths OpenTTD could search through.
* At least one of the slots has to be filled with a path.
* NULL paths tell that there is no such path for the
* current operating system.
*/
extern const char *_searchpaths[NUM_SEARCHPATHS];
/**
* 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
*/
static inline bool IsValidSearchPath(Searchpath sp)
{
return sp < NUM_SEARCHPATHS && _searchpaths[sp] != NULL;
}
/** 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 char *filename, const char *mode, Subdirectory subdir, size_t *filesize = NULL);
bool FioCheckFileExists(const char *filename, Subdirectory subdir);
char *FioGetFullPath(char *buf, size_t buflen, Searchpath sp, Subdirectory subdir, const char *filename);
char *FioFindFullPath(char *buf, size_t buflen, Subdirectory subdir, const char *filename);
char *FioAppendDirectory(char *buf, size_t buflen, Searchpath sp, Subdirectory subdir);
char *FioGetDirectory(char *buf, size_t buflen, Subdirectory subdir);
const char *FiosGetScreenshotDir();
void SanitizeFilename(char *filename);
bool AppendPathSeparator(char *buf, size_t buflen);
void DeterminePaths(const char *exe);
void *ReadFileToMem(const char *filename, size_t *lenp, size_t maxsize);
bool FileExists(const char *filename);
const char *FioTarFirstDir(const char *tarname, Subdirectory subdir);
void FioTarAddLink(const char *src, const char *dest, Subdirectory subdir);
bool ExtractTar(const char *tar_filename, Subdirectory subdir);
extern const char *_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 char *filename, size_t basepath_length, const char *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.
};
/* virtual */ bool AddFile(const char *filename, size_t basepath_length, const char *tar_filename = NULL);
bool AddFile(Subdirectory sd, const char *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
TCHAR *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 TCHAR *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));
}
#endif /* FILEIO_FUNC_H */
|