OpenTTD Source
20241121-master-g67a0fccfad
|
This file contains functions for building file lists for the save/load dialogs. More...
#include "stdafx.h"
#include "3rdparty/md5/md5.h"
#include "fileio_func.h"
#include "fios.h"
#include "network/network_content.h"
#include "screenshot.h"
#include "string_func.h"
#include "strings_func.h"
#include "tar_type.h"
#include <sys/stat.h>
#include <charconv>
#include <filesystem>
#include "table/strings.h"
#include "safeguards.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 std::tuple< FiosType, std::string > | FiosGetTypeAndNameProc(SaveLoadOperation fop, const std::string &filename, const std::string_view ext) |
Functions | |
bool | FiosIsRoot (const std::string &path) |
bool | FiosIsHiddenFile (const std::filesystem::path &path) |
void | FiosGetDrives (FileList &file_list) |
std::string | GetOldSaveGameName (const std::string &file) |
std::string | FiosGetCurrentPath () |
Get the current path/working directory. | |
bool | FiosBrowseTo (const FiosItem *item) |
Browse to a new path based on the passed item, starting at #_fios_path. More... | |
static std::string | FiosMakeFilename (const std::string *path, const char *name, const char *ext) |
Construct a filename from its components in destination buffer buf. More... | |
std::string | FiosMakeSavegameName (const char *name) |
Make a save game or scenario filename from a name. More... | |
std::string | FiosMakeHeightmapName (const char *name) |
Construct a filename for a height map. More... | |
bool | FiosDelete (const char *name) |
Delete a file. More... | |
static void | FiosGetFileList (SaveLoadOperation fop, bool show_dirs, FiosGetTypeAndNameProc *callback_proc, Subdirectory subdir, FileList &file_list) |
Fill the list of the files in a directory, according to some arbitrary rule. More... | |
static std::string | GetFileTitle (const std::string &file, Subdirectory subdir) |
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. More... | |
std::tuple< FiosType, std::string > | FiosGetSavegameListCallback (SaveLoadOperation fop, const std::string &file, const std::string_view ext) |
Callback for FiosGetFileList. More... | |
void | FiosGetSavegameList (SaveLoadOperation fop, bool show_dirs, FileList &file_list) |
Get a list of savegames. More... | |
std::tuple< FiosType, std::string > | FiosGetScenarioListCallback (SaveLoadOperation fop, const std::string &file, const std::string_view ext) |
Callback for FiosGetFileList. More... | |
void | FiosGetScenarioList (SaveLoadOperation fop, bool show_dirs, FileList &file_list) |
Get a list of scenarios. More... | |
std::tuple< FiosType, std::string > | FiosGetHeightmapListCallback (SaveLoadOperation, const std::string &file, const std::string_view ext) |
void | FiosGetHeightmapList (SaveLoadOperation fop, bool show_dirs, FileList &file_list) |
Get a list of heightmaps. More... | |
static std::tuple< FiosType, std::string > | FiosGetTownDataListCallback (SaveLoadOperation fop, const std::string &file, const std::string_view ext) |
Callback for FiosGetTownDataList. More... | |
void | FiosGetTownDataList (SaveLoadOperation fop, bool show_dirs, FileList &file_list) |
Get a list of town data files. More... | |
const char * | FiosGetScreenshotDir () |
Get the directory for screenshots. More... | |
const char * | FindScenario (const ContentInfo *ci, bool md5sum) |
Find a given scenario based on its unique ID. More... | |
bool | HasScenario (const ContentInfo *ci, bool md5sum) |
Check whether we've got a given scenario based on its unique ID. More... | |
void | ScanScenarios () |
Force a (re)scan of the scenarios. | |
Variables | |
static std::string * | _fios_path = nullptr |
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.
const char* FindScenario | ( | const ContentInfo * | ci, |
bool | md5sum | ||
) |
Find 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. |
nullptr
. Definition at line 690 of file fios.cpp.
References _scanner, ContentInfo::md5sum, ScenarioScanner::Scan(), and ContentInfo::unique_id.
Referenced by HasScenario().
bool FiosBrowseTo | ( | const FiosItem * | item | ) |
bool FiosDelete | ( | const char * | name | ) |
Delete a file.
name | Filename to delete. |
Definition at line 248 of file fios.cpp.
References FioRemove(), and FiosMakeSavegameName().
Referenced by SaveLoadWindow::OnTimeout().
|
static |
Fill the list of the files in a directory, according to some arbitrary rule.
fop | Purpose of collecting the list. |
show_dirs | Whether to list directories. |
callback_proc | The function that is called where you need to do the filtering. |
subdir | The directory from where to start (global) searching. |
file_list | Destination of the found files. |
void FiosGetHeightmapList | ( | SaveLoadOperation | fop, |
bool | show_dirs, | ||
FileList & | file_list | ||
) |
Get a list of heightmaps.
fop | Purpose of collecting the list. |
show_dirs | Whether to show directories. |
file_list | Destination of the found files. |
Definition at line 549 of file fios.cpp.
Referenced by FileList::BuildFileList().
void FiosGetSavegameList | ( | SaveLoadOperation | fop, |
bool | show_dirs, | ||
FileList & | file_list | ||
) |
Get a list of savegames.
fop | Purpose of collecting the list. |
show_dirs | Whether to show directories. |
file_list | Destination of the found files. |
Definition at line 442 of file fios.cpp.
Referenced by FileList::BuildFileList().
std::tuple<FiosType, std::string> FiosGetSavegameListCallback | ( | SaveLoadOperation | fop, |
const std::string & | file, | ||
const std::string_view | ext | ||
) |
Callback for FiosGetFileList.
It tells if a file is a savegame or not.
fop | Purpose of collecting the list. |
file | Name of the file to check. |
ext | A pointer to the extension identifier inside file |
Definition at line 413 of file fios.cpp.
References StrEqualsIgnoreCase().
void FiosGetScenarioList | ( | SaveLoadOperation | fop, |
bool | show_dirs, | ||
FileList & | file_list | ||
) |
Get a list of scenarios.
fop | Purpose of collecting the list. |
show_dirs | Whether to show directories. |
file_list | Destination of the found files. |
Definition at line 489 of file fios.cpp.
Referenced by FileList::BuildFileList().
std::tuple<FiosType, std::string> FiosGetScenarioListCallback | ( | SaveLoadOperation | fop, |
const std::string & | file, | ||
const std::string_view | ext | ||
) |
Callback for FiosGetFileList.
It tells if a file is a scenario or not.
fop | Purpose of collecting the list. |
file | Name of the file to check. |
ext | A pointer to the extension identifier inside file |
Definition at line 462 of file fios.cpp.
References StrEqualsIgnoreCase().
const char* FiosGetScreenshotDir | ( | ) |
Get the directory for screenshots.
Definition at line 602 of file fios.cpp.
Referenced by NewGRFProfiler::GetOutputFilename().
void FiosGetTownDataList | ( | SaveLoadOperation | fop, |
bool | show_dirs, | ||
FileList & | file_list | ||
) |
Get a list of town data files.
fop | Purpose of collecting the list. |
show_dirs | Whether to show directories. |
file_list | Destination of the found files. |
Definition at line 585 of file fios.cpp.
Referenced by FileList::BuildFileList().
|
static |
Callback for FiosGetTownDataList.
fop | Purpose of collecting the list. |
file | Name of the file to check. |
Definition at line 568 of file fios.cpp.
References SLO_LOAD, and StrEqualsIgnoreCase().
|
static |
Construct a filename from its components in destination buffer buf.
path | Directory path, may be nullptr . |
name | Filename. |
ext | Filename extension (use "" for no extension). |
Definition at line 201 of file fios.cpp.
Referenced by FiosMakeHeightmapName().
std::string FiosMakeHeightmapName | ( | const char * | name | ) |
Construct a filename for a height map.
name | Filename. |
Definition at line 235 of file fios.cpp.
References FiosMakeFilename(), and GetCurrentScreenshotExtension().
Referenced by SaveLoadWindow::OnTimeout().
std::string FiosMakeSavegameName | ( | const char * | name | ) |
Make a save game or scenario filename from a name.
name | Name of the file. |
Definition at line 223 of file fios.cpp.
Referenced by FiosDelete(), and SaveLoadWindow::OnTimeout().
|
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 |
subdir | the sub directory to search in |
Definition at line 392 of file fios.cpp.
References FioFOpenFile(), lengthof, and StrMakeValid().
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 710 of file fios.cpp.
References FindScenario().
Referenced by ClientNetworkContentSocketHandler::Receive_SERVER_INFO().