1

/* $Id$ */

     2

     3

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

     4

     5

#ifndef FIOS_H

     6

#define FIOS_H

     7

     8

#include "strings_type.h"

     9

    10

enum {

    11

	/**

    12

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

    13

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

    14

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

    15

	 * the testing for "too much NewGRFs".

    16

	 */

    17

	CONFIG_SLOT    =  0,

    18

	/** Slot for the sound. */

    19

	SOUND_SLOT     =  1,

    20

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

    21

	FIRST_GRF_SLOT =  2,

    22

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

    23

	LAST_GRF_SLOT  = 63,

    24

	/** Maximum number of slots. */

    25

	MAX_FILE_SLOTS = 64

    26

};

    27

    28

enum SaveLoadDialogMode{

    29

	SLD_LOAD_GAME,

    30

	SLD_LOAD_SCENARIO,

    31

	SLD_SAVE_GAME,

    32

	SLD_SAVE_SCENARIO,

    33

	SLD_LOAD_HEIGHTMAP,

    34

	SLD_NEW_GAME,

    35

};

    36

    37

/* The different types of files been handled by the system */

    38

enum FileType {

    39

	FT_NONE,      ///< nothing to do

    40

	FT_SAVEGAME,  ///< old or new savegame

    41

	FT_SCENARIO,  ///< old or new scenario

    42

	FT_HEIGHTMAP, ///< heightmap file

    43

};

    44

    45

enum {

    46

	FIOS_TYPE_DRIVE        =   0,

    47

	FIOS_TYPE_PARENT       =   1,

    48

	FIOS_TYPE_DIR          =   2,

    49

	FIOS_TYPE_FILE         =   3,

    50

	FIOS_TYPE_OLDFILE      =   4,

    51

	FIOS_TYPE_SCENARIO     =   5,

    52

	FIOS_TYPE_OLD_SCENARIO =   6,

    53

	FIOS_TYPE_DIRECT       =   7,

    54

	FIOS_TYPE_PNG          =   8,

    55

	FIOS_TYPE_BMP          =   9,

    56

	FIOS_TYPE_INVALID      = 255,

    57

};

    58

    59

/* Deals with finding savegames */

    60

struct FiosItem {

    61

	byte type;

    62

	uint64 mtime;

    63

	char title[64];

    64

	char name[256 - 12 - 64];

    65

};

    66

    67

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

    68

struct SmallFiosItem {

    69

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

    70

	FileType filetype;    ///< what type of file are we dealing with

    71

	char name[MAX_PATH];  ///< name

    72

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

    73

};

    74

    75

/* Variables to display file lists */

    76

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

    77

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

    78

extern SmallFiosItem _file_to_saveload;

    79

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

    80

    81

/* Launch save/load dialog */

    82

void ShowSaveLoadDialog(SaveLoadDialogMode mode);

    83

    84

/* Get a list of savegames */

    85

FiosItem *FiosGetSavegameList(int mode);

    86

/* Get a list of scenarios */

    87

FiosItem *FiosGetScenarioList(int mode);

    88

/* Get a list of Heightmaps */

    89

FiosItem *FiosGetHeightmapList(int mode);

    90

/* Free the list of savegames */

    91

void FiosFreeSavegameList();

    92

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

    93

char *FiosBrowseTo(const FiosItem *item);

    94

/* Return path, free space and stringID */

    95

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

    96

/* Delete a name */

    97

bool FiosDelete(const char *name);

    98

/* Make a filename from a name */

    99

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

   100

/* Allocate a new FiosItem */

   101

FiosItem *FiosAlloc();

   102

   103

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

   104

   105

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

   106

#if defined(WIN32)

   107

#include <windows.h>

   108

struct DIR;

   109

   110

struct dirent { // XXX - only d_name implemented

   111

	TCHAR *d_name; // name of found file

   112

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

   113

	 * save us a call to GetFileAttributes if we want information

   114

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

   115

	DIR *dir;

   116

};

   117

   118

struct DIR {

   119

	HANDLE hFind;

   120

	/* the dirent returned by readdir.

   121

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

   122

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

   123

	dirent ent;

   124

	WIN32_FIND_DATA fd;

   125

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

   126

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

   127

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

   128

	bool at_first_entry;

   129

};

   130

   131

DIR *opendir(const TCHAR *path);

   132

struct dirent *readdir(DIR *d);

   133

int closedir(DIR *d);

   134

#else

   135

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

   136

# include <sys/types.h>

   137

# include <dirent.h>

   138

#endif /* defined(WIN32) */

   139

   140

/**

   141

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

   142

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

   143

 * function behaves the same as the original opendir function

   144

 * @param path string to open directory of

   145

 * @return DIR pointer

   146

 */

   147

static inline DIR *ttd_opendir(const char *path)

   148

{

   149

	return opendir(OTTD2FS(path));

   150

}

   151

   152

#endif /* FIOS_H */