1

/* $Id$ */

     2

     3

/** @file fileio_func.h Functions for Standard In/Out file operations */

     4

     5

#ifndef FILEIO_FUNC_H

     6

#define FILEIO_FUNC_H

     7

     8

#include "fileio_type.h"

     9

    10

void FioSeekTo(size_t pos, int mode);

    11

void FioSeekToFile(uint8 slot, size_t pos);

    12

size_t FioGetPos();

    13

const char *FioGetFilename(uint8 slot);

    14

byte FioReadByte();

    15

uint16 FioReadWord();

    16

uint32 FioReadDword();

    17

void FioCloseAll();

    18

void FioOpenFile(int slot, const char *filename);

    19

void FioReadBlock(void *ptr, size_t size);

    20

void FioSkipBytes(int n);

    21

void FioCreateDirectory(const char *filename);

    22

    23

/**

    24

 * The searchpaths OpenTTD could search through.

    25

 * At least one of the slots has to be filled with a path.

    26

 * NULL paths tell that there is no such path for the

    27

 * current operating system.

    28

 */

    29

extern const char *_searchpaths[NUM_SEARCHPATHS];

    30

    31

/**

    32

 * Checks whether the given search path is a valid search path

    33

 * @param sp the search path to check

    34

 * @return true if the search path is valid

    35

 */

    36

static inline bool IsValidSearchPath(Searchpath sp)

    37

{

    38

	return sp < NUM_SEARCHPATHS && _searchpaths[sp] != NULL;

    39

}

    40

    41

/** Iterator for all the search paths */

    42

#define FOR_ALL_SEARCHPATHS(sp) for (sp = SP_FIRST_DIR; sp < NUM_SEARCHPATHS; sp++) if (IsValidSearchPath(sp))

    43

    44

void FioFCloseFile(FILE *f);

    45

FILE *FioFOpenFile(const char *filename, const char *mode = "rb", Subdirectory subdir = DATA_DIR, size_t *filesize = NULL);

    46

bool FioCheckFileExists(const char *filename, Subdirectory subdir = DATA_DIR);

    47

char *FioGetFullPath(char *buf, size_t buflen, Searchpath sp, Subdirectory subdir, const char *filename);

    48

char *FioFindFullPath(char *buf, size_t buflen, Subdirectory subdir, const char *filename);

    49

char *FioAppendDirectory(char *buf, size_t buflen, Searchpath sp, Subdirectory subdir);

    50

char *FioGetDirectory(char *buf, size_t buflen, Subdirectory subdir);

    51

    52

static inline const char *FioGetSubdirectory(Subdirectory subdir)

    53

{

    54

	extern const char *_subdirs[NUM_SUBDIRS];

    55

	assert(subdir < NUM_SUBDIRS);

    56

	return _subdirs[subdir];

    57

}

    58

    59

void SanitizeFilename(char *filename);

    60

void AppendPathSeparator(char *buf, size_t buflen);

    61

void DeterminePaths(const char *exe);

    62

void *ReadFileToMem(const char *filename, size_t *lenp, size_t maxsize);

    63

bool FileExists(const char *filename);

    64

    65

extern char *_personal_dir; ///< custom directory for personal settings, saves, newgrf, etc.

    66

    67

/** Helper for scanning for files with a given name */

    68

class FileScanner

    69

{

    70

public:

    71

	/** Destruct the proper one... */

    72

	virtual ~FileScanner() {}

    73

    74

	uint Scan(const char *extension, Subdirectory sd, bool tars = true);

    75

    76

	/**

    77

	 * Add a file with the given filename.

    78

	 * @param filename        the full path to the file to read

    79

	 * @param basepath_length amount of characters to chop of before to get a

    80

	 *                        filename relative to the search path.

    81

	 * @return true if the file is added.

    82

	 */

    83

	virtual bool AddFile(const char *filename, size_t basepath_length) = 0;

    84

};

    85

    86

    87

/* Implementation of opendir/readdir/closedir for Windows */

    88

#if defined(WIN32)

    89

#include <windows.h>

    90

struct DIR;

    91

    92

struct dirent { // XXX - only d_name implemented

    93

	TCHAR *d_name; // name of found file

    94

	/* little hack which will point to parent DIR struct which will

    95

	 * save us a call to GetFileAttributes if we want information

    96

	 * about the file (for example in function fio_bla) */

    97

	DIR *dir;

    98

};

    99

   100

struct DIR {

   101

	HANDLE hFind;

   102

	/* the dirent returned by readdir.

   103

	 * note: having only one global instance is not possible because

   104

	 * multiple independent opendir/readdir sequences must be supported. */

   105

	dirent ent;

   106

	WIN32_FIND_DATA fd;

   107

	/* since opendir calls FindFirstFile, we need a means of telling the

   108

	 * first call to readdir that we already have a file.

   109

	 * that's the case iff this is true */

   110

	bool at_first_entry;

   111

};

   112

   113

DIR *opendir(const TCHAR *path);

   114

struct dirent *readdir(DIR *d);

   115

int closedir(DIR *d);

   116

#else

   117

/* Use system-supplied opendir/readdir/closedir functions */

   118

# include <sys/types.h>

   119

# include <dirent.h>

   120

#endif /* defined(WIN32) */

   121

   122

/**

   123

 * A wrapper around opendir() which will convert the string from

   124

 * OPENTTD encoding to that of the filesystem. For all purposes this

   125

 * function behaves the same as the original opendir function

   126

 * @param path string to open directory of

   127

 * @return DIR pointer

   128

 */

   129

static inline DIR *ttd_opendir(const char *path)

   130

{

   131

	return opendir(OTTD2FS(path));

   132

}

   133

   134

#endif /* FILEIO_FUNC_H */