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

#include "core/smallvec_type.hpp"

    10

    11

enum {

    12

	/**

    13

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

    14

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

    15

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

    16

	 * the testing for "too much NewGRFs".

    17

	 */

    18

	CONFIG_SLOT    =  0,

    19

	/** Slot for the sound. */

    20

	SOUND_SLOT     =  1,

    21

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

    22

	FIRST_GRF_SLOT =  2,

    23

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

    24

	LAST_GRF_SLOT  = 63,

    25

	/** Maximum number of slots. */

    26

	MAX_FILE_SLOTS = 64

    27

};

    28

    29

enum SaveLoadDialogMode{

    30

	SLD_LOAD_GAME,

    31

	SLD_LOAD_SCENARIO,

    32

	SLD_SAVE_GAME,

    33

	SLD_SAVE_SCENARIO,

    34

	SLD_LOAD_HEIGHTMAP,

    35

	SLD_NEW_GAME,

    36

};

    37

    38

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

    39

enum FileType {

    40

	FT_NONE,      ///< nothing to do

    41

	FT_SAVEGAME,  ///< old or new savegame

    42

	FT_SCENARIO,  ///< old or new scenario

    43

	FT_HEIGHTMAP, ///< heightmap file

    44

};

    45

    46

enum FiosType {

    47

	FIOS_TYPE_DRIVE,

    48

	FIOS_TYPE_PARENT,

    49

	FIOS_TYPE_DIR,

    50

	FIOS_TYPE_FILE,

    51

	FIOS_TYPE_OLDFILE,

    52

	FIOS_TYPE_SCENARIO,

    53

	FIOS_TYPE_OLD_SCENARIO,

    54

	FIOS_TYPE_DIRECT,

    55

	FIOS_TYPE_PNG,

    56

	FIOS_TYPE_BMP,

    57

	FIOS_TYPE_INVALID = 255,

    58

};

    59

    60

/* Deals with finding savegames */

    61

struct FiosItem {

    62

	FiosType type;

    63

	uint64 mtime;

    64

	char title[64];

    65

	char name[256 - 12 - 64];

    66

};

    67

    68

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

    69

struct SmallFiosItem {

    70

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

    71

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

    72

	char name[MAX_PATH];  ///< name

    73

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

    74

};

    75

    76

enum {

    77

	SORT_ASCENDING  = 0,

    78

	SORT_DESCENDING = 1,

    79

	SORT_BY_DATE    = 0,

    80

	SORT_BY_NAME    = 2

    81

};

    82

    83

/* Variables to display file lists */

    84

extern SmallVector<FiosItem, 32> _fios_items; ///< defined in fios.cpp

    85

extern SmallFiosItem _file_to_saveload;

    86

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

    87

extern byte _savegame_sort_order;

    88

    89

/* Launch save/load dialog */

    90

void ShowSaveLoadDialog(SaveLoadDialogMode mode);

    91

    92

/* Get a list of savegames */

    93

void FiosGetSavegameList(SaveLoadDialogMode mode);

    94

/* Get a list of scenarios */

    95

void FiosGetScenarioList(SaveLoadDialogMode mode);

    96

/* Get a list of Heightmaps */

    97

void FiosGetHeightmapList(SaveLoadDialogMode mode);

    98

/* Free the list of savegames */

    99

void FiosFreeSavegameList();

   100

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

   101

char *FiosBrowseTo(const FiosItem *item);

   102

/* Return path, free space and stringID */

   103

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

   104

/* Delete a name */

   105

bool FiosDelete(const char *name);

   106

/* Make a filename from a name */

   107

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

   108

   109

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

   110

   111

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

   112

#if defined(WIN32)

   113

#include <windows.h>

   114

struct DIR;

   115

   116

struct dirent { // XXX - only d_name implemented

   117

	TCHAR *d_name; // name of found file

   118

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

   119

	 * save us a call to GetFileAttributes if we want information

   120

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

   121

	DIR *dir;

   122

};

   123

   124

struct DIR {

   125

	HANDLE hFind;

   126

	/* the dirent returned by readdir.

   127

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

   128

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

   129

	dirent ent;

   130

	WIN32_FIND_DATA fd;

   131

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

   132

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

   133

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

   134

	bool at_first_entry;

   135

};

   136

   137

DIR *opendir(const TCHAR *path);

   138

struct dirent *readdir(DIR *d);

   139

int closedir(DIR *d);

   140

#else

   141

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

   142

# include <sys/types.h>

   143

# include <dirent.h>

   144

#endif /* defined(WIN32) */

   145

   146

/**

   147

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

   148

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

   149

 * function behaves the same as the original opendir function

   150

 * @param path string to open directory of

   151

 * @return DIR pointer

   152

 */

   153

static inline DIR *ttd_opendir(const char *path)

   154

{

   155

	return opendir(OTTD2FS(path));

   156

}

   157

   158

#endif /* FIOS_H */