Files
@ r10452:e64515b3ea5c
Branch filter:
Location: cpp/openttd-patchpack/source/src/fileio_func.h - annotation
r10452:e64515b3ea5c
4.2 KiB
text/x-c
(svn r14707) -Cleanup: Replace an 'int' by 'Trackdir'.
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 | 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 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 r10039:727fb45b0424 r10039:727fb45b0424 r10047:088b8b265ea0 r10047:088b8b265ea0 r10047:088b8b265ea0 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 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$ */
/** @file fileio_func.h Functions for Standard In/Out file operations */
#ifndef FILEIO_FUNC_H
#define FILEIO_FUNC_H
#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);
void FioReadBlock(void *ptr, size_t size);
void FioSkipBytes(int n);
void FioCreateDirectory(const char *filename);
/**
* The searchpaths 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 = "rb", Subdirectory subdir = DATA_DIR, size_t *filesize = NULL);
bool FioCheckFileExists(const char *filename, Subdirectory subdir = DATA_DIR);
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);
static inline const char *FioGetSubdirectory(Subdirectory subdir)
{
extern const char *_subdirs[NUM_SUBDIRS];
assert(subdir < NUM_SUBDIRS);
return _subdirs[subdir];
}
void SanitizeFilename(char *filename);
void 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);
extern char *_personal_dir; ///< custom directory for personal settings, saves, newgrf, etc.
/** Helper for scanning for files with a given name */
class FileScanner
{
public:
/** Destruct the proper one... */
virtual ~FileScanner() {}
uint Scan(const char *extension, Subdirectory sd, bool tars = 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.
* @return true if the file is added.
*/
virtual bool AddFile(const char *filename, size_t basepath_length) = 0;
};
/* Implementation of opendir/readdir/closedir for Windows */
#if defined(WIN32)
#include <windows.h>
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;
};
struct DIR {
HANDLE hFind;
/* the dirent returned by readdir.
* note: having only one global instance is not possible because
* multiple independent opendir/readdir sequences must be supported. */
dirent ent;
WIN32_FIND_DATA fd;
/* since opendir calls FindFirstFile, we need a means of telling the
* first call to readdir that we already have a file.
* that's the case iff this is true */
bool at_first_entry;
};
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 */
|