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

/* Deals with finding savegames */

    27

struct FiosItem {

    28

	byte type;

    29

	uint64 mtime;

    30

	char title[64];

    31

	char name[256 - 12 - 64];

    32

};

    33

    34

enum {

    35

	FIOS_TYPE_DRIVE        =   0,

    36

	FIOS_TYPE_PARENT       =   1,

    37

	FIOS_TYPE_DIR          =   2,

    38

	FIOS_TYPE_FILE         =   3,

    39

	FIOS_TYPE_OLDFILE      =   4,

    40

	FIOS_TYPE_SCENARIO     =   5,

    41

	FIOS_TYPE_OLD_SCENARIO =   6,

    42

	FIOS_TYPE_DIRECT       =   7,

    43

	FIOS_TYPE_PNG          =   8,

    44

	FIOS_TYPE_BMP          =   9,

    45

	FIOS_TYPE_INVALID      = 255,

    46

};

    47

    48

/* Variables to display file lists */

    49

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

    50

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

    51

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

    52

    53

/* Get a list of savegames */

    54

FiosItem *FiosGetSavegameList(int mode);

    55

/* Get a list of scenarios */

    56

FiosItem *FiosGetScenarioList(int mode);

    57

/* Get a list of Heightmaps */

    58

FiosItem *FiosGetHeightmapList(int mode);

    59

/* Free the list of savegames */

    60

void FiosFreeSavegameList();

    61

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

    62

char *FiosBrowseTo(const FiosItem *item);

    63

/* Return path, free space and stringID */

    64

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

    65

/* Delete a name */

    66

bool FiosDelete(const char *name);

    67

/* Make a filename from a name */

    68

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

    69

/* Allocate a new FiosItem */

    70

FiosItem *FiosAlloc();

    71

    72

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

    73

    74

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

    75

#if defined(WIN32)

    76

#include <windows.h>

    77

struct DIR;

    78

    79

struct dirent { // XXX - only d_name implemented

    80

	TCHAR *d_name; // name of found file

    81

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

    82

	 * save us a call to GetFileAttributes if we want information

    83

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

    84

	DIR *dir;

    85

};

    86

    87

struct DIR {

    88

	HANDLE hFind;

    89

	/* the dirent returned by readdir.

    90

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

    91

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

    92

	dirent ent;

    93

	WIN32_FIND_DATA fd;

    94

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

    95

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

    96

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

    97

	bool at_first_entry;

    98

};

    99

   100

DIR *opendir(const TCHAR *path);

   101

struct dirent *readdir(DIR *d);

   102

int closedir(DIR *d);

   103

#else

   104

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

   105

# include <sys/types.h>

   106

# include <dirent.h>

   107

#endif /* defined(WIN32) */

   108

   109

/**

   110

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

   111

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

   112

 * function behaves the same as the original opendir function

   113

 * @param path string to open directory of

   114

 * @return DIR pointer

   115

 */

   116

static inline DIR *ttd_opendir(const char *path)

   117

{

   118

	return opendir(OTTD2FS(path));

   119

}

   120

   121

#endif /* FIOS_H */