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

    12

void FioSeekTo(uint32 pos, int mode);

    13

void FioSeekToFile(uint8 slot, uint32 pos);

    14

uint32 FioGetPos();

    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, uint 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

	NUM_SUBDIRS,   ///< Number of subdirectories

    38

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

    39

};

    40

    41

/**

    42

 * Types of searchpaths OpenTTD might use

    43

 */

    44

enum Searchpath {

    45

	SP_FIRST_DIR,

    46

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

    47

	SP_PERSONAL_DIR,               ///< Search in the personal directory

    48

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

    49

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

    50

	SP_INSTALLATION_DIR,           ///< Search in the installation directory

    51

	SP_APPLICATION_BUNDLE_DIR,     ///< Search within the application bundle

    52

	NUM_SEARCHPATHS

    53

};

    54

    55

DECLARE_POSTFIX_INCREMENT(Searchpath);

    56

    57

/**

    58

 * The searchpaths OpenTTD could search through.

    59

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

    60

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

    61

 * current operating system.

    62

 */

    63

extern const char *_searchpaths[NUM_SEARCHPATHS];

    64

    65

/**

    66

 * The define of a TarList.

    67

 */

    68

struct TarListEntry {

    69

	const char *filename;

    70

};

    71

struct TarFileListEntry {

    72

	TarListEntry *tar;

    73

	int size;

    74

	int position;

    75

};

    76

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

    77

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

    78

extern TarList _tar_list;

    79

extern TarFileList _tar_filelist;

    80

    81

/**

    82

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

    83

 * @param sp the search path to check

    84

 * @return true if the search path is valid

    85

 */

    86

static inline bool IsValidSearchPath(Searchpath sp)

    87

{

    88

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

    89

}

    90

    91

/** Iterator for all the search paths */

    92

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

    93

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

    94

    95

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

    96

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

    97

    98

void FioFCloseFile(FILE *f);

    99

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

   100

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

   101

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

   102

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

   103

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

   104

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

   105

   106

static inline const char *FioGetSubdirectory(Subdirectory subdir)

   107

{

   108

	extern const char *_subdirs[NUM_SUBDIRS];

   109

	assert(subdir < NUM_SUBDIRS);

   110

	return _subdirs[subdir];

   111

}

   112

   113

void SanitizeFilename(char *filename);

   114

void AppendPathSeparator(char *buf, size_t buflen);

   115

void DeterminePaths(const char *exe);

   116

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

   117

bool FileExists(const char *filename);

   118

   119

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

   120

   121

#endif /* FILEIO_H */