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

    43

enum {

    44

	FIOS_TYPE_DRIVE        =   0,

    45

	FIOS_TYPE_PARENT       =   1,

    46

	FIOS_TYPE_DIR          =   2,

    47

	FIOS_TYPE_FILE         =   3,

    48

	FIOS_TYPE_OLDFILE      =   4,

    49

	FIOS_TYPE_SCENARIO     =   5,

    50

	FIOS_TYPE_OLD_SCENARIO =   6,

    51

	FIOS_TYPE_DIRECT       =   7,

    52

	FIOS_TYPE_PNG          =   8,

    53

	FIOS_TYPE_BMP          =   9,

    54

	FIOS_TYPE_INVALID      = 255,

    55

};

    56

    57

/* Deals with finding savegames */

    58

struct FiosItem {

    59

	byte type;

    60

	uint64 mtime;

    61

	char title[64];

    62

	char name[256 - 12 - 64];

    63

};

    64

    65

/* Deals with the type of the savegame, independent of extension */

    66

struct SmallFiosItem {

    67

	int mode;             ///< savegame/scenario type (old, new)

    69

	char name[MAX_PATH];  ///< name

    70

	char title[255];      ///< internal name of the game

    71

};

    72

    73

/* Variables to display file lists */

    74

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

    75

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

    76

extern SmallFiosItem _file_to_saveload;

    77

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

    78

    79

/* Launch save/load dialog */

    80

void ShowSaveLoadDialog(SaveLoadDialogMode mode);

    81

    82

/* Get a list of savegames */

    83

FiosItem *FiosGetSavegameList(int mode);

    84

/* Get a list of scenarios */

    85

FiosItem *FiosGetScenarioList(int mode);

    86

/* Get a list of Heightmaps */

    87

FiosItem *FiosGetHeightmapList(int mode);

    88

/* Free the list of savegames */

    89

void FiosFreeSavegameList();

    90

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

    91

char *FiosBrowseTo(const FiosItem *item);

    92

/* Return path, free space and stringID */

    93

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

    94

/* Delete a name */

    95

bool FiosDelete(const char *name);

    96

/* Make a filename from a name */

    97

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

    98

/* Allocate a new FiosItem */

    99

FiosItem *FiosAlloc();

   100

   101

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

   102

   103

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

   104

#if defined(WIN32)

   105

#include <windows.h>

   106

struct DIR;

   107

   108

struct dirent { // XXX - only d_name implemented

   109

	TCHAR *d_name; // name of found file

   110

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

   111

	 * save us a call to GetFileAttributes if we want information

   112

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

   113

	DIR *dir;

   114

};

   115

   116

struct DIR {

   117

	HANDLE hFind;

   118

	/* the dirent returned by readdir.

   119

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

   120

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

   121

	dirent ent;

   122

	WIN32_FIND_DATA fd;

   123

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

   124

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

   125

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

   126

	bool at_first_entry;

   127

};

   128

   129

DIR *opendir(const TCHAR *path);

   130

struct dirent *readdir(DIR *d);

   131

int closedir(DIR *d);

   132

#else

   133

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

   134

# include <sys/types.h>

   135

# include <dirent.h>

   136

#endif /* defined(WIN32) */

   137

   138

/**

   139

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

   140

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

   141

 * function behaves the same as the original opendir function

   142

 * @param path string to open directory of

   143

 * @return DIR pointer

   144

 */

   145

static inline DIR *ttd_opendir(const char *path)

   146

{

   147

	return opendir(OTTD2FS(path));

   148

}

   149

   150

#endif /* FIOS_H */