OpenTTD: src/fios.h Source File

OpenTTD

- Main Page
- Related Pages
- Modules
- Namespaces
- Data Structures
- Files

- File List
- Globals

fios.h
Go to the documentation of this file.
1 /* $Id: fios.h 27729 2017-01-14 13:12:49Z frosch $ */
2
3 /*
4 * This file is part of OpenTTD.
5 * 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.
6 * 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.
7 * 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/>.
8 */
9
12 #ifndef FIOS_H
13 #define FIOS_H
14
15 #include "gfx_type.h"
16 #include "company_base.h"
17 #include "newgrf_config.h"
18 #include "network/core/tcp_content.h"
19
20
21 typedef SmallMap<uint, CompanyProperties *> CompanyPropertiesMap;
22
26 struct LoadCheckData {
27 bool checkable;
28 StringID error;
29 char *error_data;
30
31 uint32 map_size_x, map_size_y;
32 Date current_date;
33
34 GameSettings settings;
35
36 CompanyPropertiesMap companies;
37
38 GRFConfig *grfconfig;
39 GRFListCompatibility grf_compatibility;
40
41 struct LoggedAction *gamelog_action;
42 uint gamelog_actions;
43
44 LoadCheckData() : error_data(NULL), grfconfig(NULL),
45 grf_compatibility(GLC_NOT_FOUND), gamelog_action(NULL), gamelog_actions(0)
46 {
47 this->Clear();
48 }
49
53 ~LoadCheckData()
54 {
55 this->Clear();
56 }
57
62 bool HasErrors()
63 {
64 return this->checkable && this->error != INVALID_STRING_ID;
65 }
66
71 bool HasNewGrfs()
72 {
73 return this->checkable && this->error == INVALID_STRING_ID && this->grfconfig != NULL;
74 }
75
76 void Clear();
77 };
78
79 extern LoadCheckData _load_check_data;
80
81
82 enum FileSlots {
88 CONFIG_SLOT = 0,
90 SOUND_SLOT = 1,
92 FIRST_GRF_SLOT = 2,
94 MAX_FILE_SLOTS = 128,
95 };
96
98 struct FiosItem {
99 FiosType type;
100 uint64 mtime;
101 char title[64];
102 char name[MAX_PATH];
103 };
104
106 class FileList {
107 public:
108 ~FileList();
109
114 inline FiosItem *Append()
115 {
116 return this->files.Append();
117 }
118
123 inline uint Length() const
124 {
125 return this->files.Length();
126 }
127
132 inline const FiosItem *Begin() const
133 {
134 return this->files.Begin();
135 }
136
141 inline const FiosItem *End() const
142 {
143 return this->files.End();
144 }
145
150 inline const FiosItem *Get(uint index) const
151 {
152 return this->files.Get(index);
153 }
154
159 inline FiosItem *Get(uint index)
160 {
161 return this->files.Get(index);
162 }
163
164 inline const FiosItem &operator[](uint index) const
165 {
166 return this->files[index];
167 }
168
173 inline FiosItem &operator[](uint index)
174 {
175 return this->files[index];
176 }
177
179 inline void Clear()
180 {
181 this->files.Clear();
182 }
183
185 inline void Compact()
186 {
187 this->files.Compact();
188 }
189
190 void BuildFileList(AbstractFileType abstract_filetype, SaveLoadOperation fop);
191 const FiosItem *FindItem(const char *file);
192
193 SmallVector<FiosItem, 32> files;
194 };
195
196 enum SortingBits {
197 SORT_ASCENDING = 0,
198 SORT_DESCENDING = 1,
199 SORT_BY_DATE = 0,
200 SORT_BY_NAME = 2
201 };
202 DECLARE_ENUM_AS_BIT_SET(SortingBits)
203
204 /* Variables to display file lists */
205 extern SortingBits _savegame_sort_order;
206
207 void ShowSaveLoadDialog(AbstractFileType abstract_filetype, SaveLoadOperation fop);
208
209 void FiosGetSavegameList(SaveLoadOperation fop, FileList &file_list);
210 void FiosGetScenarioList(SaveLoadOperation fop, FileList &file_list);
211 void FiosGetHeightmapList(SaveLoadOperation fop, FileList &file_list);
212
213 const char *FiosBrowseTo(const FiosItem *item);
214
215 StringID FiosGetDescText(const char **path, uint64 *total_free);
216 bool FiosDelete(const char *name);
217 void FiosMakeHeightmapName(char *buf, const char *name, const char *last);
218 void FiosMakeSavegameName(char *buf, const char *name, const char *last);
219
220 FiosType FiosGetSavegameListCallback(SaveLoadOperation fop, const char *file, const char *ext, char *title, const char *last);
221
222 int CDECL CompareFiosItems(const FiosItem *a, const FiosItem *b);
223
224 #endif /* FIOS_H */