1

/* $Id$ */

     2

     3

/** @file fios.h Declarations for savegames operations */

     4

     5

#ifndef FIOS_H

     6

#define FIOS_H

     7

     8

enum {

     9

	/**

    10

	 * Slot used for the GRF scanning and such. This slot cannot be reused

    11

	 * as it will otherwise cause issues when pressing "rescan directories".

    12

	 * It can furthermore not be larger than LAST_GRF_SLOT as that complicates

    13

	 * the testing for "too much NewGRFs".

    14

	 */

    15

	CONFIG_SLOT    =  0,

    16

	/** Slot for the sound. */

    17

	SOUND_SLOT     =  1,

    18

	/** First slot useable for (New)GRFs used during the game. */

    19

	FIRST_GRF_SLOT =  2,

    20

	/** Last slot useable for (New)GRFs used during the game. */

    21

	LAST_GRF_SLOT  = 63,

    22

	/** Maximum number of slots. */

    23

	MAX_FILE_SLOTS = 64

    24

};

    25

    26

enum SaveLoadDialogMode{

    27

	SLD_LOAD_GAME,

    28

	SLD_LOAD_SCENARIO,

    29

	SLD_SAVE_GAME,

    30

	SLD_SAVE_SCENARIO,

    31

	SLD_LOAD_HEIGHTMAP,

    32

	SLD_NEW_GAME,

    33

};

    34

    35

enum {

    36

	FIOS_TYPE_DRIVE        =   0,

    37

	FIOS_TYPE_PARENT       =   1,

    38

	FIOS_TYPE_DIR          =   2,

    39

	FIOS_TYPE_FILE         =   3,

    40

	FIOS_TYPE_OLDFILE      =   4,

    41

	FIOS_TYPE_SCENARIO     =   5,

    42

	FIOS_TYPE_OLD_SCENARIO =   6,

    43

	FIOS_TYPE_DIRECT       =   7,

    44

	FIOS_TYPE_PNG          =   8,

    45

	FIOS_TYPE_BMP          =   9,

    46

	FIOS_TYPE_INVALID      = 255,

    47

};

    48

    64

/* Variables to display file lists */

    65

extern FiosItem *_fios_list; ///< defined in misc_gui.cpp

    66

extern int _fios_num;        ///< defined in fios.cpp, read_only version of _fios_count

    68

extern SaveLoadDialogMode _saveload_mode;   ///< defined in misc_gui.cpp

    69

    70

/* Launch save/load dialog */

    71

void ShowSaveLoadDialog(SaveLoadDialogMode mode);

    72

    73

/* Get a list of savegames */

    74

FiosItem *FiosGetSavegameList(int mode);

    75

/* Get a list of scenarios */

    76

FiosItem *FiosGetScenarioList(int mode);

    77

/* Get a list of Heightmaps */

    78

FiosItem *FiosGetHeightmapList(int mode);

    79

/* Free the list of savegames */

    80

void FiosFreeSavegameList();

    81

/* Browse to. Returns a filename w/path if we reached a file. */

    82

char *FiosBrowseTo(const FiosItem *item);

    83

/* Return path, free space and stringID */

    84

StringID FiosGetDescText(const char **path, uint32 *total_free);

    85

/* Delete a name */

    86

bool FiosDelete(const char *name);

    87

/* Make a filename from a name */

    88

void FiosMakeSavegameName(char *buf, const char *name, size_t size);

    89

/* Allocate a new FiosItem */

    90

FiosItem *FiosAlloc();

    91

    92

int CDECL compare_FiosItems(const void *a, const void *b);

    93

    94

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

    95

#if defined(WIN32)

    96

#include <windows.h>

    97

struct DIR;

    98

    99

struct dirent { // XXX - only d_name implemented

   100

	TCHAR *d_name; // name of found file

   101

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

   102

	 * save us a call to GetFileAttributes if we want information

   103

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

   104

	DIR *dir;

   105

};

   106

   107

struct DIR {

   108

	HANDLE hFind;

   109

	/* the dirent returned by readdir.

   110

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

   111

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

   112

	dirent ent;

   113

	WIN32_FIND_DATA fd;

   114

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

   115

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

   116

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

   117

	bool at_first_entry;

   118

};

   119

   120

DIR *opendir(const TCHAR *path);

   121

struct dirent *readdir(DIR *d);

   122

int closedir(DIR *d);

   123

#else

   124

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

   125

# include <sys/types.h>

   126

# include <dirent.h>

   127

#endif /* defined(WIN32) */

   128

   129

/**

   130

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

   131

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

   132

 * function behaves the same as the original opendir function

   133

 * @param path string to open directory of

   134

 * @return DIR pointer

   135

 */

   136

static inline DIR *ttd_opendir(const char *path)

   137

{

   138

	return opendir(OTTD2FS(path));

   139

}

   140

   141

#endif /* FIOS_H */