This file contains functions for building file lists for the save/load dialogs. More...
#include "stdafx.h"
#include "fios.h"
#include "fileio_func.h"
#include "tar_type.h"
#include "string_func.h"
#include <sys/stat.h>
#include <unistd.h>
#include "table/strings.h"
#include "network/network_content.h"
#include "3rdparty/md5/md5.h"
Go to the source code of this file.
Data Structures | |
class | FiosFileScanner |
Scanner to scan for a particular type of FIOS file. More... | |
struct | ScenarioIdentifier |
Basic data to distinguish a scenario. More... | |
class | ScenarioScanner |
Scanner to find the unique IDs of scenarios. More... | |
Typedefs | |
typedef FiosType | fios_getlist_callback_proc (SaveLoadDialogMode mode, const char *filename, const char *ext, char *title, const char *last) |
Functions | |
bool | FiosIsRoot (const char *path) |
bool | FiosIsValidFile (const char *path, const struct dirent *ent, struct stat *sb) |
bool | FiosIsHiddenFile (const struct dirent *ent) |
void | FiosGetDrives () |
bool | FiosGetDiskFreeSpace (const char *path, uint64 *tot) |
void | GetOldSaveGameName (const char *file, char *title, const char *last) |
int CDECL | CompareFiosItems (const FiosItem *da, const FiosItem *db) |
Compare two FiosItem's. | |
void | FiosFreeSavegameList () |
Clear the list. | |
StringID | FiosGetDescText (const char **path, uint64 *total_free) |
Get descriptive texts. | |
const char * | FiosBrowseTo (const FiosItem *item) |
Browse to a new path based on the passed item. | |
void | FiosMakeSavegameName (char *buf, const char *name, size_t size) |
bool | FiosDelete (const char *name) |
bool | FileExists (const char *filename) |
static void | FiosGetFileList (SaveLoadDialogMode mode, fios_getlist_callback_proc *callback_proc, Subdirectory subdir) |
Fill the list of the files in a directory, according to some arbitrary rule. | |
static void | GetFileTitle (const char *file, char *title, const char *last) |
Get the title of a file, which (if exists) is stored in a file named the same as the data file but with '.title' added to it. | |
FiosType | FiosGetSavegameListCallback (SaveLoadDialogMode mode, const char *file, const char *ext, char *title, const char *last) |
Callback for FiosGetFileList. | |
void | FiosGetSavegameList (SaveLoadDialogMode mode) |
Get a list of savegames. | |
static FiosType | FiosGetScenarioListCallback (SaveLoadDialogMode mode, const char *file, const char *ext, char *title, const char *last) |
Callback for FiosGetFileList. | |
void | FiosGetScenarioList (SaveLoadDialogMode mode) |
Get a list of scenarios. | |
static FiosType | FiosGetHeightmapListCallback (SaveLoadDialogMode mode, const char *file, const char *ext, char *title, const char *last) |
void | FiosGetHeightmapList (SaveLoadDialogMode mode) |
bool | HasScenario (const ContentInfo *ci, bool md5sum) |
Check whether we've got a given scenario based on its unique ID. | |
void | ScanScenarios () |
Force a (re)scan of the scenarios. | |
Variables | |
SmallVector< FiosItem, 32 > | _fios_items |
static char * | _fios_path |
SmallFiosItem | _file_to_saveload |
SortingBits | _savegame_sort_order = SORT_BY_DATE | SORT_DESCENDING |
static ScenarioScanner | _scanner |
Scanner for scenarios. |
This file contains functions for building file lists for the save/load dialogs.
Definition in file fios.cpp.
Compare two FiosItem's.
Used with sort when sorting the file list.
da | A pointer to the first FiosItem to compare. | |
db | A pointer to the second FiosItem to compare. |
Definition at line 52 of file fios.cpp.
Referenced by FiosGetFileList().
const char* FiosBrowseTo | ( | const FiosItem * | item | ) |
Browse to a new path based on the passed item.
*item | FiosItem object telling us what to do. |
NULL
. Definition at line 91 of file fios.cpp.
Referenced by SaveLoadWindow::OnClick().
StringID FiosGetDescText | ( | const char ** | path, | |
uint64 * | total_free | |||
) |
Get descriptive texts.
Returns the path and free space left on the device
path | string describing the path | |
total_free | total free space in megabytes, optional (can be NULL) |
Definition at line 80 of file fios.cpp.
Referenced by SaveLoadWindow::DrawWidget().
static void FiosGetFileList | ( | SaveLoadDialogMode | mode, | |
fios_getlist_callback_proc * | callback_proc, | |||
Subdirectory | subdir | |||
) | [static] |
Fill the list of the files in a directory, according to some arbitrary rule.
mode | The mode we are in. Some modes don't allow 'parent'. | |
callback_proc | The function that is called where you need to do the filtering. | |
subdir | The directory from where to start (global) searching. |
Definition at line 270 of file fios.cpp.
References SmallVector< T, S >::Append(), SmallVector< T, S >::Begin(), SmallVector< T, S >::Clear(), SmallVector< T, S >::Compact(), CompareFiosItems(), FS2OTTD(), SmallVector< T, S >::Get(), lastof, SmallVector< T, S >::Length(), lengthof, NO_DIRECTORY, QSortT(), FileScanner::Scan(), str_validate(), strecpy(), and ttd_opendir().
Referenced by FiosGetSavegameList(), and FiosGetScenarioList().
void FiosGetSavegameList | ( | SaveLoadDialogMode | mode | ) |
Get a list of savegames.
mode | Save/load mode. |
Definition at line 400 of file fios.cpp.
References FiosGetFileList(), FiosGetSavegameListCallback(), NO_DIRECTORY, and SAVE_DIR.
FiosType FiosGetSavegameListCallback | ( | SaveLoadDialogMode | mode, | |
const char * | file, | |||
const char * | ext, | |||
char * | title, | |||
const char * | last | |||
) |
Callback for FiosGetFileList.
It tells if a file is a savegame or not.
mode | Save/load mode. | |
file | Name of the file to check. | |
ext | A pointer to the extension identifier inside file | |
title | Buffer if a callback wants to lookup the title of the file; NULL to skip the lookup | |
last | Last available byte in buffer (to prevent buffer overflows); not used when title == NULL |
Definition at line 371 of file fios.cpp.
References GetFileTitle().
Referenced by FiosGetSavegameList().
void FiosGetScenarioList | ( | SaveLoadDialogMode | mode | ) |
Get a list of scenarios.
mode | Save/load mode. |
Definition at line 452 of file fios.cpp.
References FiosGetFileList(), FiosGetScenarioListCallback(), NO_DIRECTORY, and SCENARIO_DIR.
static FiosType FiosGetScenarioListCallback | ( | SaveLoadDialogMode | mode, | |
const char * | file, | |||
const char * | ext, | |||
char * | title, | |||
const char * | last | |||
) | [static] |
Callback for FiosGetFileList.
It tells if a file is a scenario or not.
mode | Save/load mode. | |
file | Name of the file to check. | |
ext | A pointer to the extension identifier inside file | |
title | Buffer if a callback wants to lookup the title of the file | |
last | Last available byte in buffer (to prevent buffer overflows) |
Definition at line 425 of file fios.cpp.
References GetFileTitle().
Referenced by FiosGetScenarioList().
static void GetFileTitle | ( | const char * | file, | |
char * | title, | |||
const char * | last | |||
) | [static] |
Get the title of a file, which (if exists) is stored in a file named the same as the data file but with '.title' added to it.
file | filename to get the title for | |
title | the title buffer to fill | |
last | the last element in the title buffer |
Definition at line 344 of file fios.cpp.
References FioFCloseFile(), FioFOpenFile(), lastof, str_validate(), strecat(), and strecpy().
Referenced by FiosGetSavegameListCallback(), and FiosGetScenarioListCallback().
bool HasScenario | ( | const ContentInfo * | ci, | |
bool | md5sum | |||
) |
Check whether we've got a given scenario based on its unique ID.
ci | the content info to compare it to | |
md5sum | whether to look at the md5sum or the id |
Definition at line 620 of file fios.cpp.
References SmallVector< T, S >::Begin(), SmallVector< T, S >::End(), ContentInfo::md5sum, ScenarioScanner::Scan(), and ContentInfo::unique_id.