OpenTTD Source 20241224-master-gf74b0cf984
fios.h
Go to the documentation of this file.
1/*
2 * This file is part of OpenTTD.
3 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
4 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
5 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
6 */
7
10#ifndef FIOS_H
11#define FIOS_H
12
13#include "gfx_type.h"
14#include "company_base.h"
15#include "newgrf_config.h"
16#include "gamelog.h"
19
20
27
28using CompanyPropertiesMap = std::map<uint, std::unique_ptr<CompanyProperties>>;
29
34 bool checkable;
36 std::string error_msg;
37
38 uint32_t map_size_x, map_size_y;
39 TimerGameCalendar::Date current_date;
40
41 GameSettings settings;
42
43 CompanyPropertiesMap companies;
44
47
49
50 LoadCheckData() : grfconfig(nullptr),
52 {
53 }
54
59 bool HasErrors()
60 {
61 return this->checkable && this->error != INVALID_STRING_ID;
62 }
63
69 {
70 return this->checkable && this->error == INVALID_STRING_ID && this->grfconfig != nullptr;
71 }
72
73 void Clear();
74};
75
77
79struct FiosItem {
80 FiosType type;
81 int64_t mtime;
82 std::string title;
83 std::string name;
84 bool operator< (const FiosItem &other) const;
85};
86
88class FileList : public std::vector<FiosItem> {
89public:
90 void BuildFileList(AbstractFileType abstract_filetype, SaveLoadOperation fop, bool show_dirs);
91 const FiosItem *FindItem(const std::string_view file);
92};
93
94enum SortingBits {
95 SORT_ASCENDING = 0,
96 SORT_DESCENDING = 1,
97 SORT_BY_DATE = 0,
98 SORT_BY_NAME = 2
99};
100DECLARE_ENUM_AS_BIT_SET(SortingBits)
101
102/* Variables to display file lists */
103extern SortingBits _savegame_sort_order;
104
105void ShowSaveLoadDialog(AbstractFileType abstract_filetype, SaveLoadOperation fop);
106
107void FiosGetSavegameList(SaveLoadOperation fop, bool show_dirs, FileList &file_list);
108void FiosGetScenarioList(SaveLoadOperation fop, bool show_dirs, FileList &file_list);
109void FiosGetHeightmapList(SaveLoadOperation fop, bool show_dirs, FileList &file_list);
110void FiosGetTownDataList(SaveLoadOperation fop, bool show_dirs, FileList &file_list);
111
112bool FiosBrowseTo(const FiosItem *item);
113
114std::string FiosGetCurrentPath();
115std::optional<uint64_t> FiosGetDiskFreeSpace(const std::string &path);
116bool FiosDelete(const char *name);
117std::string FiosMakeHeightmapName(const char *name);
118std::string FiosMakeSavegameName(const char *name);
119
120std::tuple<FiosType, std::string> FiosGetSavegameListCallback(SaveLoadOperation fop, const std::string &file, const std::string_view ext);
121std::tuple<FiosType, std::string> FiosGetScenarioListCallback(SaveLoadOperation fop, const std::string &file, const std::string_view ext);
122std::tuple<FiosType, std::string> FiosGetHeightmapListCallback(SaveLoadOperation fop, const std::string &file, const std::string_view ext);
123
124void ScanScenarios();
125const char *FindScenario(const ContentInfo *ci, bool md5sum);
126
131 FiosNumberedSaveName(const std::string &prefix);
132 std::string Filename();
133 std::string Extension();
134private:
135 std::string prefix;
136 int number;
137};
138
139#endif /* FIOS_H */
List of file information.
Definition fios.h:88
const FiosItem * FindItem(const std::string_view file)
Find file information of a file by its name from the file list.
Definition fios.cpp:102
void BuildFileList(AbstractFileType abstract_filetype, SaveLoadOperation fop, bool show_dirs)
Construct a file list with the given kind of files, for the stated purpose.
Definition fios.cpp:66
Definition of stuff that is very close to a company, like the company struct itself.
#define DECLARE_ENUM_AS_BIT_SET(enum_type)
Operators to allow to work with enum as with type safe bit set in C++.
Definition enum_type.hpp:35
AbstractFileType
The different abstract types of files that the system knows about.
Definition fileio_type.h:16
FiosType
Elements of a file system that are recognized.
Definition fileio_type.h:73
SaveLoadOperation
Operation performed on the file.
Definition fileio_type.h:53
void ShowSaveLoadDialog(AbstractFileType abstract_filetype, SaveLoadOperation fop)
Launch save/load dialog in the given mode.
Definition fios_gui.cpp:986
const char * FindScenario(const ContentInfo *ci, bool md5sum)
Find a given scenario based on its unique ID.
Definition fios.cpp:690
SaveLoadInvalidateWindowData
Special values for save-load window for the data parameter of InvalidateWindowData.
Definition fios.h:22
@ SLIWD_FILTER_CHANGES
The filename filter has changed (via the editbox)
Definition fios.h:25
@ SLIWD_SELECTION_CHANGES
File selection has changed (user click, ...)
Definition fios.h:24
@ SLIWD_RESCAN_FILES
Rescan all files (when changed directory, ...)
Definition fios.h:23
std::string FiosGetCurrentPath()
Get the current path/working directory.
Definition fios.cpp:133
std::string FiosMakeSavegameName(const char *name)
Make a save game or scenario filename from a name.
Definition fios.cpp:223
void FiosGetSavegameList(SaveLoadOperation fop, bool show_dirs, FileList &file_list)
Get a list of savegames.
Definition fios.cpp:442
void FiosGetHeightmapList(SaveLoadOperation fop, bool show_dirs, FileList &file_list)
Get a list of heightmaps.
Definition fios.cpp:549
void ScanScenarios()
Force a (re)scan of the scenarios.
Definition fios.cpp:718
void FiosGetScenarioList(SaveLoadOperation fop, bool show_dirs, FileList &file_list)
Get a list of scenarios.
Definition fios.cpp:489
std::tuple< FiosType, std::string > FiosGetSavegameListCallback(SaveLoadOperation fop, const std::string &file, const std::string_view ext)
Callback for FiosGetFileList.
Definition fios.cpp:413
std::tuple< FiosType, std::string > FiosGetScenarioListCallback(SaveLoadOperation fop, const std::string &file, const std::string_view ext)
Callback for FiosGetFileList.
Definition fios.cpp:462
LoadCheckData _load_check_data
Data loaded from save during SL_LOAD_CHECK.
Definition fios_gui.cpp:41
std::string FiosMakeHeightmapName(const char *name)
Construct a filename for a height map.
Definition fios.cpp:235
bool FiosDelete(const char *name)
Delete a file.
Definition fios.cpp:248
bool FiosBrowseTo(const FiosItem *item)
Browse to a new path based on the passed item, starting at _fios_path.
Definition fios.cpp:143
void FiosGetTownDataList(SaveLoadOperation fop, bool show_dirs, FileList &file_list)
Get a list of town data files.
Definition fios.cpp:585
Functions to be called to log fundamental changes to the game.
Types related to the graphics and/or input devices.
Functions to find and configure NewGRFs.
GRFListCompatibility
Status of post-gameload GRF compatibility check.
@ GLC_NOT_FOUND
At least one GRF couldn't be found (higher priority than GLC_COMPATIBLE)
uint32_t StringID
Numeric value that represents a string, independent of the selected language.
static const StringID INVALID_STRING_ID
Constant representing an invalid string (16bit in case it is used in savegames)
Container for all important information about a piece of content.
Deals with finding savegames.
Definition fios.h:79
bool operator<(const FiosItem &other) const
Compare two FiosItem's.
Definition fios.cpp:47
A savegame name automatically numbered.
Definition fios.h:130
std::string Filename()
Generate a savegame name and number according to _settings_client.gui.max_num_autosaves.
Definition fios.cpp:764
std::string Extension()
Generate an extension for a savegame name.
Definition fios.cpp:774
Information about GRF, used in the game and (part of it) in savegames.
All settings together for the game.
Container for loading in mode SL_LOAD_CHECK.
Definition fios.h:33
bool checkable
True if the savegame could be checked by SL_LOAD_CHECK. (Old savegames are not checkable....
Definition fios.h:34
bool HasNewGrfs()
Check whether the game uses any NewGrfs.
Definition fios.h:68
std::string error_msg
Data to pass to SetDParamStr when displaying error.
Definition fios.h:36
CompanyPropertiesMap companies
Company information.
Definition fios.h:43
StringID error
Error message from loading. INVALID_STRING_ID if no error.
Definition fios.h:35
GRFConfig * grfconfig
NewGrf configuration from save.
Definition fios.h:45
Gamelog gamelog
Gamelog actions.
Definition fios.h:48
bool HasErrors()
Check whether loading the game resulted in errors.
Definition fios.h:59
void Clear()
Reset read data.
Definition fios_gui.cpp:49
GRFListCompatibility grf_compatibility
Summary state of NewGrfs, whether missing files or only compatible found.
Definition fios.h:46
Templated helper to make a type-safe 'typedef' representing a single POD value.
Basic types related to the content on the content server.
Definition of the game-calendar-timer.