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.

static std::string	FiosMakeFilename (const std::string path, const char name, const char *ext)
	Construct a filename from its components in destination buffer buf.

std::string	FiosMakeSavegameName (const char *name)
	Make a save game or scenario filename from a name.

std::string	FiosMakeHeightmapName (const char *name)
	Construct a filename for a height map.

bool	FiosDelete (const char *name)
	Delete a file.

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.

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.

std::tuple< FiosType, std::string >	FiosGetSavegameListCallback (SaveLoadOperation fop, const std::string &file, const std::string_view ext)
	Callback for FiosGetFileList.

void	FiosGetSavegameList (SaveLoadOperation fop, bool show_dirs, FileList &file_list)
	Get a list of savegames.

std::tuple< FiosType, std::string >	FiosGetScenarioListCallback (SaveLoadOperation fop, const std::string &file, const std::string_view ext)
	Callback for FiosGetFileList.

void	FiosGetScenarioList (SaveLoadOperation fop, bool show_dirs, FileList &file_list)
	Get a list of scenarios.

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.

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

void	FiosGetTownDataList (SaveLoadOperation fop, bool show_dirs, FileList &file_list)
	Get a list of town data files.

const char *	FiosGetScreenshotDir ()
	Get the directory for screenshots.

const char *	FindScenario (const ContentInfo *ci, bool md5sum)
	Find a given scenario based on its unique ID.

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

Typedef Documentation

◆ FiosGetTypeAndNameProc

typedef std::tuple< FiosType, std::string > FiosGetTypeAndNameProc(SaveLoadOperation fop, const std::string &filename, const std::string_view ext)

Definition at line 253 of 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 ContentInfo::GetTextfile(), and 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.

Referenced by SaveLoadWindow::OnClick().

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

◆ FiosGetCurrentPath()

std::string FiosGetCurrentPath ( )

Get the current path/working directory.

Definition at line 133 of file fios.cpp.

Referenced by SaveLoadWindow::DrawWidget().

◆ FiosGetDrives()

void FiosGetDrives ( FileList & file_list )

extern

Definition at line 62 of file unix.cpp.

◆ 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.