1

/* $Id$ */

     2

     3

/** @file fileio.h Declarations for Standard In/Out file operations */

     4

     5

#ifndef FILEIO_H

     6

#define FILEIO_H

     7

     8

#include <map>

     9

#include <string>

    10

#include "core/enum_type.hpp"

    11

    15

const char *FioGetFilename(uint8 slot);

    16

byte FioReadByte();

    17

uint16 FioReadWord();

    18

uint32 FioReadDword();

    19

void FioCloseAll();

    20

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

    21

void FioReadBlock(void *ptr, size_t size);

    22

void FioSkipBytes(int n);

    23

void FioCreateDirectory(const char *filename);

    24

    25

/**

    26

 * The different kinds of subdirectories OpenTTD uses

    27

 */

    28

enum Subdirectory {

    29

	BASE_DIR,      ///< Base directory for all subdirectories

    30

	SAVE_DIR,      ///< Base directory for all savegames

    31

	AUTOSAVE_DIR,  ///< Subdirectory of save for autosaves

    32

	SCENARIO_DIR,  ///< Base directory for all scenarios

    33

	HEIGHTMAP_DIR, ///< Subdirectory of scenario for heightmaps

    34

	GM_DIR,        ///< Subdirectory for all music

    35

	DATA_DIR,      ///< Subdirectory for all data (GRFs, sample.cat, intro game)

    36

	LANG_DIR,      ///< Subdirectory for all translation files

    37

	AI_DIR,        ///< Subdirectory for all AI files

    38

	NUM_SUBDIRS,   ///< Number of subdirectories

    39

	NO_DIRECTORY,  ///< A path without any base directory

    40

};

    41

    42

/**

    43

 * Types of searchpaths OpenTTD might use

    44

 */

    45

enum Searchpath {

    46

	SP_FIRST_DIR,

    47

	SP_WORKING_DIR = SP_FIRST_DIR, ///< Search in the working directory

    48

	SP_PERSONAL_DIR,               ///< Search in the personal directory

    49

	SP_SHARED_DIR,                 ///< Search in the shared directory, like 'Shared Files' under Windows

    50

	SP_BINARY_DIR,                 ///< Search in the directory where the binary resides

    51

	SP_INSTALLATION_DIR,           ///< Search in the installation directory

    52

	SP_APPLICATION_BUNDLE_DIR,     ///< Search within the application bundle

    53

	NUM_SEARCHPATHS

    54

};

    55

    56

DECLARE_POSTFIX_INCREMENT(Searchpath);

    57

    58

/**

    59

 * The searchpaths OpenTTD could search through.

    60

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

    61

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

    62

 * current operating system.

    63

 */

    64

extern const char *_searchpaths[NUM_SEARCHPATHS];

    65

    66

/**

    67

 * The define of a TarList.

    68

 */

    69

struct TarListEntry {

    70

	const char *filename;

    71

	const char *dirname;

    72

};

    73

struct TarFileListEntry {

    74

	TarListEntry *tar;

    75

	size_t size;

    76

	size_t position;

    77

};

    78

typedef std::map<std::string, TarListEntry *> TarList;

    79

typedef std::map<std::string, TarFileListEntry> TarFileList;

    80

extern TarList _tar_list;

    81

extern TarFileList _tar_filelist;

    82

    83

/**

    84

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

    85

 * @param sp the search path to check

    86

 * @return true if the search path is valid

    87

 */

    88

static inline bool IsValidSearchPath(Searchpath sp)

    89

{

    90

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

    91

}

    92

    93

/** Iterator for all the search paths */

    94

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

    95

#define FOR_ALL_TARS(tar) for (tar = _tar_filelist.begin(); tar != _tar_filelist.end(); tar++)

    96

    97

typedef bool FioTarFileListCallback(const char *filename, int size, void *userdata);

    98

FILE *FioTarFileList(const char *tar, const char *mode, size_t *filesize, FioTarFileListCallback *callback, void *userdata);

    99

   100

void FioFCloseFile(FILE *f);

   101

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

   102

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

   103

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

   104

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

   105

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

   106

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

   107

   108

static inline const char *FioGetSubdirectory(Subdirectory subdir)

   109

{

   110

	extern const char *_subdirs[NUM_SUBDIRS];

   111

	assert(subdir < NUM_SUBDIRS);

   112

	return _subdirs[subdir];

   113

}

   114

   115

void SanitizeFilename(char *filename);

   116

void AppendPathSeparator(char *buf, size_t buflen);

   117

void DeterminePaths(const char *exe);

   118

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

   119

bool FileExists(const char *filename);

   120

const char *FioTarFirstDir(const char *tarname);

   121

   122

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

   123

   124

#endif /* FILEIO_H */