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"

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.

Detailed Description

This file contains functions for building file lists for the save/load dialogs.

Definition in file fios.cpp.

Function Documentation

◆ FindScenario()

const char* FindScenario	(	const ContentInfo *	ci,
		bool	md5sum
	)

Find a given scenario based on its unique ID.

Parameters

ci	The content info to compare it to.
md5sum	Whether to look at the md5sum or the id.

Returns: The filename of the file, else nullptr.

Definition at line 690 of file fios.cpp.

References _scanner, ContentInfo::md5sum, ScenarioScanner::Scan(), and ContentInfo::unique_id.

Referenced by HasScenario().

◆ FiosBrowseTo()

bool FiosBrowseTo ( const FiosItem * item )

Browse to a new path based on the passed item, starting at #_fios_path.

Parameters

*item Item telling us what to do.

Returns: true when the path got changed.

Definition at line 143 of file fios.cpp.

◆ FiosDelete()

bool FiosDelete ( const char * name )

Delete a file.

Parameters

name	Filename to delete.

Returns: Whether the file deletion was successful.

Definition at line 248 of file fios.cpp.

References FioRemove(), and FiosMakeSavegameName().

Referenced by SaveLoadWindow::OnTimeout().

◆ FiosGetFileList()

static void FiosGetFileList	(	SaveLoadOperation	fop,
		bool	show_dirs,
		FiosGetTypeAndNameProc *	callback_proc,
		Subdirectory	subdir,
		FileList &	file_list
	)

static

Fill the list of the files in a directory, according to some arbitrary rule.

Parameters

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.

Definition at line 327 of file fios.cpp.

◆ FiosGetHeightmapList()

void FiosGetHeightmapList	(	SaveLoadOperation	fop,
		bool	show_dirs,
		FileList &	file_list
	)

Get a list of heightmaps.

Parameters

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().

◆ FiosGetSavegameList()

void FiosGetSavegameList	(	SaveLoadOperation	fop,
		bool	show_dirs,
		FileList &	file_list
	)

Get a list of savegames.

Parameters

fop	Purpose of collecting the list.
show_dirs	Whether to show directories.
file_list	Destination of the found files.

See also: FiosGetFileList

Definition at line 442 of file fios.cpp.

Referenced by FileList::BuildFileList().

◆ FiosGetSavegameListCallback()

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.

Parameters

fop	Purpose of collecting the list.
file	Name of the file to check.
ext	A pointer to the extension identifier inside file

Returns: a FIOS_TYPE_* type of the found file, FIOS_TYPE_INVALID if not a savegame, and the title of the file (if any).

See also: FiosGetFileList; FiosGetSavegameList

Definition at line 413 of file fios.cpp.

References StrEqualsIgnoreCase().

◆ FiosGetScenarioList()

void FiosGetScenarioList	(	SaveLoadOperation	fop,
		bool	show_dirs,
		FileList &	file_list
	)

Get a list of scenarios.

Parameters

fop	Purpose of collecting the list.
show_dirs	Whether to show directories.
file_list	Destination of the found files.

See also: FiosGetFileList

Definition at line 489 of file fios.cpp.

Referenced by FileList::BuildFileList().

◆ FiosGetScenarioListCallback()

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.

Parameters

fop	Purpose of collecting the list.
file	Name of the file to check.
ext	A pointer to the extension identifier inside file

Returns: a FIOS_TYPE_* type of the found file, FIOS_TYPE_INVALID if not a scenario and the title of the file (if any).

See also: FiosGetFileList; FiosGetScenarioList

Definition at line 462 of file fios.cpp.

References StrEqualsIgnoreCase().

◆ FiosGetScreenshotDir()

const char* FiosGetScreenshotDir ( )

Get the directory for screenshots.

Returns: path to screenshots

Definition at line 602 of file fios.cpp.

Referenced by NewGRFProfiler::GetOutputFilename().

◆ FiosGetTownDataList()

void FiosGetTownDataList	(	SaveLoadOperation	fop,
		bool	show_dirs,
		FileList &	file_list
	)

Get a list of town data files.

Parameters

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().

◆ FiosGetTownDataListCallback()

static std::tuple<FiosType, std::string> FiosGetTownDataListCallback	(	SaveLoadOperation	fop,
		const std::string &	file,
		const std::string_view	ext
	)

static

Callback for FiosGetTownDataList.

Parameters

fop	Purpose of collecting the list.
file	Name of the file to check.

Returns: a FIOS_TYPE_JSON type of the found file, FIOS_TYPE_INVALID if not a valid JSON file, and the title of the file (if any).

Definition at line 568 of file fios.cpp.

References SLO_LOAD, and StrEqualsIgnoreCase().

◆ FiosMakeFilename()

static std::string FiosMakeFilename	(	const std::string *	path,
		const char *	name,
		const char *	ext
	)

static

Construct a filename from its components in destination buffer buf.

Parameters

path	Directory path, may be `nullptr`.
name	Filename.
ext	Filename extension (use `""` for no extension).

Returns: The completed filename.

Definition at line 201 of file fios.cpp.

Referenced by FiosMakeHeightmapName().

◆ FiosMakeHeightmapName()

std::string FiosMakeHeightmapName ( const char * name )

Construct a filename for a height map.

Parameters

name Filename.

Returns: The completed filename.

Definition at line 235 of file fios.cpp.

References FiosMakeFilename(), and GetCurrentScreenshotExtension().

Referenced by SaveLoadWindow::OnTimeout().

◆ FiosMakeSavegameName()

std::string FiosMakeSavegameName ( const char * name )

Make a save game or scenario filename from a name.

Parameters

name	Name of the file.

Returns: The completed filename.

Definition at line 223 of file fios.cpp.

Referenced by FiosDelete(), and SaveLoadWindow::OnTimeout().

◆ GetFileTitle()

static std::string GetFileTitle	(	const std::string &	file,
		Subdirectory	subdir
	)

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.

Parameters

file	filename to get the title for
subdir	the sub directory to search in

Returns: The file title.

Definition at line 392 of file fios.cpp.

References FioFOpenFile(), lengthof, and StrMakeValid().

◆ HasScenario()

bool HasScenario	(	const ContentInfo *	ci,
		bool	md5sum
	)

Check whether we've got a given scenario based on its unique ID.

Parameters

ci	The content info to compare it to.
md5sum	Whether to look at the md5sum or the id.

Returns: True iff we've got the scenario.

Definition at line 710 of file fios.cpp.

References FindScenario().

Referenced by ClientNetworkContentSocketHandler::Receive_SERVER_INFO().

Data Structures

Typedefs

Functions

Variables

Detailed Description

Function Documentation

◆ FindScenario()

◆ FiosBrowseTo()

◆ FiosDelete()

◆ FiosGetFileList()

◆ FiosGetHeightmapList()

◆ FiosGetSavegameList()

◆ FiosGetSavegameListCallback()

◆ FiosGetScenarioList()

◆ FiosGetScenarioListCallback()

◆ FiosGetScreenshotDir()

◆ FiosGetTownDataList()

◆ FiosGetTownDataListCallback()

◆ FiosMakeFilename()

◆ FiosMakeHeightmapName()

◆ FiosMakeSavegameName()

◆ GetFileTitle()

◆ HasScenario()