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 "core/enum_type.hpp"

     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 different kinds of subdirectories OpenTTD uses

    25

 */

    26

enum Subdirectory {

    27

	BASE_DIR,      ///< Base directory for all subdirectories

    28

	SAVE_DIR,      ///< Base directory for all savegames

    29

	AUTOSAVE_DIR,  ///< Subdirectory of save for autosaves

    30

	SCENARIO_DIR,  ///< Base directory for all scenarios

    31

	HEIGHTMAP_DIR, ///< Subdirectory of scenario for heightmaps

    32

	GM_DIR,        ///< Subdirectory for all music

    33

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

    34

	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

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

    66

 * @param sp the search path to check

    67

 * @return true if the search path is valid

    68

 */

    69

static inline bool IsValidSearchPath(Searchpath sp)

    70

{

    71

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

    72

}

    73

    74

/** Iterator for all the search paths */

    75

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

    76

    77

void FioFCloseFile(FILE *f);

    78

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

    79

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

    80

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

    81

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

    82

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

    83

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

    84

    85

static inline const char *FioGetSubdirectory(Subdirectory subdir)

    86

{

    87

	extern const char *_subdirs[NUM_SUBDIRS];

    88

	assert(subdir < NUM_SUBDIRS);

    89

	return _subdirs[subdir];

    90

}

    91

    92

void SanitizeFilename(char *filename);

    93

void AppendPathSeparator(char *buf, size_t buflen);

    94

void DeterminePaths(const char *exe);

    95

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

    96

bool FileExists(const char *filename);

    97

    98

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

    99

   100

#endif /* FILEIO_H */