OpenTTD
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"
17 
18 
24 };
25 
27 
31 struct LoadCheckData {
32  bool checkable;
34  char *error_data;
35 
36  uint32 map_size_x, map_size_y;
37  Date current_date;
38 
39  GameSettings settings;
40 
42 
45 
48 
49  LoadCheckData() : error_data(nullptr), grfconfig(nullptr),
50  grf_compatibility(GLC_NOT_FOUND), gamelog_action(nullptr), gamelog_actions(0)
51  {
52  this->Clear();
53  }
54 
59  {
60  this->Clear();
61  }
62 
67  bool HasErrors()
68  {
69  return this->checkable && this->error != INVALID_STRING_ID;
70  }
71 
76  bool HasNewGrfs()
77  {
78  return this->checkable && this->error == INVALID_STRING_ID && this->grfconfig != nullptr;
79  }
80 
81  void Clear();
82 };
83 
85 
86 
87 enum FileSlots {
100 };
101 
103 struct FiosItem {
104  FiosType type;
105  uint64 mtime;
106  char title[64];
107  char name[MAX_PATH];
108  bool operator< (const FiosItem &other) const;
109 };
110 
112 class FileList {
113 public:
114  ~FileList();
115 
120  inline FiosItem *Append()
121  {
122  /*C++17: return &*/ this->files.emplace_back();
123  return &this->files.back();
124  }
125 
130  inline size_t Length() const
131  {
132  return this->files.size();
133  }
134 
139  inline const FiosItem *Begin() const
140  {
141  return this->files.data();
142  }
143 
148  inline const FiosItem *End() const
149  {
150  return this->Begin() + this->Length();
151  }
152 
157  inline const FiosItem *Get(size_t index) const
158  {
159  return this->files.data() + index;
160  }
161 
166  inline FiosItem *Get(size_t index)
167  {
168  return this->files.data() + index;
169  }
170 
171  inline const FiosItem &operator[](size_t index) const
172  {
173  return this->files[index];
174  }
175 
180  inline FiosItem &operator[](size_t index)
181  {
182  return this->files[index];
183  }
184 
186  inline void Clear()
187  {
188  this->files.clear();
189  }
190 
192  inline void Compact()
193  {
194  this->files.shrink_to_fit();
195  }
196 
197  void BuildFileList(AbstractFileType abstract_filetype, SaveLoadOperation fop);
198  const FiosItem *FindItem(const char *file);
199 
200  std::vector<FiosItem> files;
201 };
202 
203 enum SortingBits {
204  SORT_ASCENDING = 0,
205  SORT_DESCENDING = 1,
206  SORT_BY_DATE = 0,
207  SORT_BY_NAME = 2
208 };
209 DECLARE_ENUM_AS_BIT_SET(SortingBits)
210 
211 /* Variables to display file lists */
212 extern SortingBits _savegame_sort_order;
213 
214 void ShowSaveLoadDialog(AbstractFileType abstract_filetype, SaveLoadOperation fop);
215 
216 void FiosGetSavegameList(SaveLoadOperation fop, FileList &file_list);
217 void FiosGetScenarioList(SaveLoadOperation fop, FileList &file_list);
218 void FiosGetHeightmapList(SaveLoadOperation fop, FileList &file_list);
219 
220 const char *FiosBrowseTo(const FiosItem *item);
221 
222 StringID FiosGetDescText(const char **path, uint64 *total_free);
223 bool FiosDelete(const char *name);
224 void FiosMakeHeightmapName(char *buf, const char *name, const char *last);
225 void FiosMakeSavegameName(char *buf, const char *name, const char *last);
226 
227 FiosType FiosGetSavegameListCallback(SaveLoadOperation fop, const char *file, const char *ext, char *title, const char *last);
228 
229 #endif /* FIOS_H */
FiosType
Elements of a file system that are recognized.
Definition: fileio_type.h:67
AbstractFileType
The different abstract types of files that the system knows about.
Definition: fileio_type.h:16
Slot for the sound.
Definition: fios.h:95
First slot usable for (New)GRFs used during the game.
Definition: fios.h:97
DECLARE_ENUM_AS_BIT_SET(GenderEthnicity) enum CompanyManagerFaceVariable
Bitgroups of the CompanyManagerFace variable.
Definition of stuff that is very close to a company, like the company struct itself.
const FiosItem * Get(size_t index) const
Get a pointer to the indicated file information.
Definition: fios.h:157
void FiosMakeHeightmapName(char *buf, const char *name, const char *last)
Construct a filename for a height map.
Definition: fios.cpp:239
Container for loading in mode SL_LOAD_CHECK.
Definition: fios.h:31
void Clear()
Remove all items from the list.
Definition: fios.h:186
All settings together for the game.
struct LoggedAction * gamelog_action
Gamelog actions.
Definition: fios.h:46
std::vector< FiosItem > files
The list of files.
Definition: fios.h:200
size_t Length() const
Get the number of files in the list.
Definition: fios.h:130
void FiosGetSavegameList(SaveLoadOperation fop, FileList &file_list)
Get a list of savegames.
Definition: fios.cpp:492
GRFConfig * grfconfig
NewGrf configuration from save.
Definition: fios.h:43
SaveLoadInvalidateWindowData
Special values for save-load window for the data parameter of InvalidateWindowData.
Definition: fios.h:20
Maximum number of slots.
Definition: fios.h:99
const FiosItem * Begin() const
Get a pointer to the first file information.
Definition: fios.h:139
void FiosMakeSavegameName(char *buf, const char *name, const char *last)
Make a save game or scenario filename from a name.
Definition: fios.cpp:226
File selection has changed (user click, ...)
Definition: fios.h:22
Slot used for the GRF scanning and such.
Definition: fios.h:93
bool FiosDelete(const char *name)
Delete a file.
Definition: fios.cpp:253
Deals with finding savegames.
Definition: fios.h:103
bool checkable
True if the savegame could be checked by SL_LOAD_CHECK. (Old savegames are not checkable.)
Definition: fios.h:32
LoadCheckData _load_check_data
Data loaded from save during SL_LOAD_CHECK.
Definition: fios_gui.cpp:38
const FiosItem * End() const
Get a pointer behind the last file information.
Definition: fios.h:148
void FiosGetScenarioList(SaveLoadOperation fop, FileList &file_list)
Get a list of scenarios.
Definition: fios.cpp:547
FiosItem * Get(size_t index)
Get a pointer to the indicated file information.
Definition: fios.h:166
Contains information about one logged action that caused at least one logged change.
Information about GRF, used in the game and (part of it) in savegames.
StringID FiosGetDescText(const char **path, uint64 *total_free)
Get descriptive texts.
Definition: fios.cpp:139
CompanyPropertiesMap companies
Company information.
Definition: fios.h:41
const char * FiosBrowseTo(const FiosItem *item)
Browse to a new path based on the passed item, starting at #_fios_path.
Definition: fios.cpp:150
void Clear()
Reset read data.
Definition: fios_gui.cpp:47
char * error_data
Data to pass to SetDParamStr when displaying error.
Definition: fios.h:34
bool HasErrors()
Check whether loading the game resulted in errors.
Definition: fios.h:67
Basic functions to receive and send TCP packets to/from the content server.
The filename filter has changed (via the editbox)
Definition: fios.h:23
StringID error
Error message from loading. INVALID_STRING_ID if no error.
Definition: fios.h:33
uint32 StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:16
SaveLoadOperation
Operation performed on the file.
Definition: fileio_type.h:47
void FiosGetHeightmapList(SaveLoadOperation fop, FileList &file_list)
Get a list of heightmaps.
Definition: fios.cpp:618
Functions to find and configure NewGRFs.
void Compact()
Compact the list down to the smallest block size boundary.
Definition: fios.h:192
void ShowSaveLoadDialog(AbstractFileType abstract_filetype, SaveLoadOperation fop)
Launch save/load dialog in the given mode.
Definition: fios_gui.cpp:888
GRFListCompatibility
Status of post-gameload GRF compatibility check.
Definition: newgrf_config.h:51
FileSlots
Definition: fios.h:87
List of file information.
Definition: fios.h:112
At least one GRF couldn&#39;t be found (higher priority than GLC_COMPATIBLE)
Definition: newgrf_config.h:54
uint gamelog_actions
Number of gamelog actions.
Definition: fios.h:47
Rescan all files (when changed directory, ...)
Definition: fios.h:21
~LoadCheckData()
Don&#39;t leak memory at program exit.
Definition: fios.h:58
static const StringID INVALID_STRING_ID
Constant representing an invalid string (16bit in case it is used in savegames)
Definition: strings_type.h:17
int32 Date
The type to store our dates in.
Definition: date_type.h:14
FiosItem & operator[](size_t index)
Get a reference to the indicated file information.
Definition: fios.h:180
bool HasNewGrfs()
Check whether the game uses any NewGrfs.
Definition: fios.h:76
FiosItem * Append()
Construct a new entry in the file list.
Definition: fios.h:120
GRFListCompatibility grf_compatibility
Summary state of NewGrfs, whether missing files or only compatible found.
Definition: fios.h:44
Types related to the graphics and/or input devices.
FiosType FiosGetSavegameListCallback(SaveLoadOperation fop, const char *file, const char *ext, char *title, const char *last)
Callback for FiosGetFileList.
Definition: fios.cpp:459