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

    11

void FioSeekTo(uint32 pos, int mode);

    12

void FioSeekToFile(uint8 slot, uint32 pos);

    13

uint32 FioGetPos();

    14

const char *FioGetFilename();

    15

byte FioReadByte();

    16

uint16 FioReadWord();

    17

uint32 FioReadDword();

    18

void FioCloseAll();

    19

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

    20

void FioReadBlock(void *ptr, uint size);

    21

void FioSkipBytes(int n);

    22

void FioCreateDirectory(const char *filename);

    23

    24

/**

    25

 * The different kinds of subdirectories OpenTTD uses

    26

 */

    27

enum Subdirectory {

    28

	BASE_DIR,      ///< Base directory for all subdirectories

    29

	SAVE_DIR,      ///< Base directory for all savegames

    30

	AUTOSAVE_DIR,  ///< Subdirectory of save for autosaves

    31

	SCENARIO_DIR,  ///< Base directory for all scenarios

    32

	HEIGHTMAP_DIR, ///< Subdirectory of scenario for heightmaps

    33

	GM_DIR,        ///< Subdirectory for all music

    34

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

    35

	LANG_DIR,      ///< Subdirectory for all translation files

    36

	NUM_SUBDIRS,   ///< Number of subdirectories

    37

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

    38

};

    39

    40

/**

    41

 * Types of searchpaths OpenTTD might use

    42

 */

    43

enum Searchpath {

    44

	SP_FIRST_DIR,

    45

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

    46

	SP_PERSONAL_DIR,               ///< Search in the personal directory

    47

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

    48

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

    49

	SP_INSTALLATION_DIR,           ///< Search in the installation directory

    50

	SP_APPLICATION_BUNDLE_DIR,     ///< Search within the application bundle

    51

	NUM_SEARCHPATHS

    52

};

    53

    54

DECLARE_POSTFIX_INCREMENT(Searchpath);

    55

    56

/**

    57

 * The searchpaths OpenTTD could search through.

    58

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

    59

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

    60

 * current operating system.

    61

 */

    62

extern const char *_searchpaths[NUM_SEARCHPATHS];

    63

    64

/**

    65

 * The define of a TarList.

    66

 */

    67

struct TarListEntry {

    68

	const char *filename;

    69

};

    70

struct TarFileListEntry {

    71

	TarListEntry *tar;

    72

	int size;

    73

	int position;

    74

};

    75

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

    76

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

    77

extern TarList _tar_list;

    78

extern TarFileList _tar_filelist;

    79

    80

/**

    81

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

    82

 * @param sp the search path to check

    83

 * @return true if the search path is valid

    84

 */

    85

static inline bool IsValidSearchPath(Searchpath sp)

    86

{

    87

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

    88

}

    89

    90

/** Iterator for all the search paths */

    91

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

    92

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

    93

    94

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

    95

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

    96

    97

void FioFCloseFile(FILE *f);

    98

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

    99

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

   100

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

   101

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

   102

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

   103

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

   104

   105

static inline const char *FioGetSubdirectory(Subdirectory subdir)

   106

{

   107

	extern const char *_subdirs[NUM_SUBDIRS];

   108

	assert(subdir < NUM_SUBDIRS);

   109

	return _subdirs[subdir];

   110

}

   111

   112

void SanitizeFilename(char *filename);

   113

void AppendPathSeparator(char *buf, size_t buflen);

   114

void DeterminePaths(const char *exe);

   115

   116

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

   117

   118

#endif /* FILEIO_H */