?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
Feature: Wide rivers
[openttd-github.git] / src / fios_gui.cpp
blob95fcc41cfb271a62ca36485644e2077366bf42c4
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
8 /** @file fios_gui.cpp GUIs for loading/saving games, scenarios, heightmaps, ... */
9
10 #include "stdafx.h"
11 #include "saveload/saveload.h"
12 #include "error.h"
13 #include "gui.h"
14 #include "gfx_func.h"
15 #include "command_func.h"
16 #include "network/network.h"
17 #include "network/network_content.h"
18 #include "strings_func.h"
19 #include "fileio_func.h"
20 #include "fios.h"
21 #include "window_func.h"
22 #include "tilehighlight_func.h"
23 #include "querystring_gui.h"
24 #include "engine_func.h"
25 #include "landscape_type.h"
26 #include "date_func.h"
27 #include "core/geometry_func.hpp"
28 #include "gamelog.h"
29 #include "stringfilter_type.h"
30 #include "misc_cmd.h"
31
32 #include "widgets/fios_widget.h"
33
34 #include "table/sprites.h"
35 #include "table/strings.h"
36
37 #include "safeguards.h"
38
39 LoadCheckData _load_check_data; ///< Data loaded from save during SL_LOAD_CHECK.
40
41 static bool _fios_path_changed;
42 static bool _savegame_sort_dirty;
43
44
45 /**
46 * Reset read data.
47 */
48 void LoadCheckData::Clear()
49 {
50 this->checkable = false;
51 this->error = INVALID_STRING_ID;
52 free(this->error_data);
53 this->error_data = nullptr;
54
55 this->map_size_x = this->map_size_y = 256; // Default for old savegames which do not store mapsize.
56 this->current_date = 0;
57 this->settings = {};
58
59 for (auto &pair : this->companies) {
60 delete pair.second;
61 }
62 companies.clear();
63
64 GamelogFree(this->gamelog_action, this->gamelog_actions);
65 this->gamelog_action = nullptr;
66 this->gamelog_actions = 0;
67
68 ClearGRFConfigList(&this->grfconfig);
69 }
70
71 /** Load game/scenario with optional content download */
72 static const NWidgetPart _nested_load_dialog_widgets[] = {
73 NWidget(NWID_HORIZONTAL),
74 NWidget(WWT_CLOSEBOX, COLOUR_GREY),
75 NWidget(WWT_CAPTION, COLOUR_GREY, WID_SL_CAPTION),
76 NWidget(WWT_DEFSIZEBOX, COLOUR_GREY),
77 EndContainer(),
78 /* Current directory and free space */
79 NWidget(WWT_PANEL, COLOUR_GREY, WID_SL_BACKGROUND), SetFill(1, 0), SetResize(1, 0), EndContainer(),
80
81 NWidget(NWID_HORIZONTAL, NC_EQUALSIZE),
82 /* Left side : filter box and available files */
83 NWidget(NWID_VERTICAL),
84 /* Filter box with label */
85 NWidget(WWT_PANEL, COLOUR_GREY), SetFill(1, 1), SetResize(1, 1),
86 NWidget(NWID_HORIZONTAL), SetPadding(WD_FRAMERECT_TOP, 0, WD_FRAMERECT_BOTTOM, 0),
87 SetPIP(WD_FRAMETEXT_LEFT, WD_FRAMETEXT_RIGHT, 0),
88 NWidget(WWT_TEXT, COLOUR_GREY), SetFill(0, 1), SetDataTip(STR_SAVELOAD_FILTER_TITLE , STR_NULL),
89 NWidget(WWT_EDITBOX, COLOUR_GREY, WID_SL_FILTER), SetFill(1, 0), SetMinimalSize(50, 12), SetResize(1, 0),
90 SetDataTip(STR_LIST_FILTER_OSKTITLE, STR_LIST_FILTER_TOOLTIP),
91 EndContainer(),
92 EndContainer(),
93 /* Sort buttons */
94 NWidget(NWID_HORIZONTAL),
95 NWidget(NWID_HORIZONTAL, NC_EQUALSIZE),
96 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_SL_SORT_BYNAME), SetDataTip(STR_SORT_BY_CAPTION_NAME, STR_TOOLTIP_SORT_ORDER), SetFill(1, 0), SetResize(1, 0),
97 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_SL_SORT_BYDATE), SetDataTip(STR_SORT_BY_CAPTION_DATE, STR_TOOLTIP_SORT_ORDER), SetFill(1, 0), SetResize(1, 0),
98 EndContainer(),
99 NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_SL_HOME_BUTTON), SetMinimalSize(12, 12), SetDataTip(SPR_HOUSE_ICON, STR_SAVELOAD_HOME_BUTTON),
100 EndContainer(),
101 /* Files */
102 NWidget(NWID_HORIZONTAL),
103 NWidget(WWT_PANEL, COLOUR_GREY, WID_SL_FILE_BACKGROUND),
104 NWidget(WWT_INSET, COLOUR_GREY, WID_SL_DRIVES_DIRECTORIES_LIST), SetFill(1, 1), SetPadding(2, 2, 2, 2),
105 SetDataTip(0x0, STR_SAVELOAD_LIST_TOOLTIP), SetResize(1, 10), SetScrollbar(WID_SL_SCROLLBAR), EndContainer(),
106 EndContainer(),
107 NWidget(NWID_VSCROLLBAR, COLOUR_GREY, WID_SL_SCROLLBAR),
108 EndContainer(),
109 /* Online Content button */
110 NWidget(NWID_SELECTION, INVALID_COLOUR, WID_SL_CONTENT_DOWNLOAD_SEL),
111 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_SL_CONTENT_DOWNLOAD), SetResize(1, 0),
112 SetDataTip(STR_INTRO_ONLINE_CONTENT, STR_INTRO_TOOLTIP_ONLINE_CONTENT),
113 EndContainer(),
114 EndContainer(),
115
116 /* Right side : game details */
117 NWidget(NWID_VERTICAL),
118 NWidget(WWT_PANEL, COLOUR_GREY, WID_SL_DETAILS), SetResize(1, 1), SetFill(1, 1),
119 EndContainer(),
120 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_SL_MISSING_NEWGRFS), SetDataTip(STR_NEWGRF_SETTINGS_FIND_MISSING_CONTENT_BUTTON, STR_NEWGRF_SETTINGS_FIND_MISSING_CONTENT_TOOLTIP), SetFill(1, 0), SetResize(1, 0),
121 NWidget(NWID_HORIZONTAL),
122 NWidget(NWID_HORIZONTAL, NC_EQUALSIZE),
123 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_SL_NEWGRF_INFO), SetDataTip(STR_INTRO_NEWGRF_SETTINGS, STR_NULL), SetFill(1, 0), SetResize(1, 0),
124 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_SL_LOAD_BUTTON), SetDataTip(STR_SAVELOAD_LOAD_BUTTON, STR_SAVELOAD_LOAD_TOOLTIP), SetFill(1, 0), SetResize(1, 0),
125 EndContainer(),
126 NWidget(WWT_RESIZEBOX, COLOUR_GREY),
127 EndContainer(),
128 EndContainer(),
129 EndContainer(),
130 };
131
132 /** Load heightmap with content download */
133 static const NWidgetPart _nested_load_heightmap_dialog_widgets[] = {
134 NWidget(NWID_HORIZONTAL),
135 NWidget(WWT_CLOSEBOX, COLOUR_GREY),
136 NWidget(WWT_CAPTION, COLOUR_GREY, WID_SL_CAPTION),
137 NWidget(WWT_DEFSIZEBOX, COLOUR_GREY),
138 EndContainer(),
139 /* Current directory and free space */
140 NWidget(WWT_PANEL, COLOUR_GREY, WID_SL_BACKGROUND), SetFill(1, 0), SetResize(1, 0), EndContainer(),
141
142 /* Filter box with label */
143 NWidget(WWT_PANEL, COLOUR_GREY), SetFill(1, 1), SetResize(1, 1),
144 NWidget(NWID_HORIZONTAL), SetPadding(WD_FRAMERECT_TOP, 0, WD_FRAMERECT_BOTTOM, 0),
145 SetPIP(WD_FRAMETEXT_LEFT, WD_FRAMETEXT_RIGHT, 0),
146 NWidget(WWT_TEXT, COLOUR_GREY), SetFill(0, 1), SetDataTip(STR_SAVELOAD_FILTER_TITLE , STR_NULL),
147 NWidget(WWT_EDITBOX, COLOUR_GREY, WID_SL_FILTER), SetFill(1, 0), SetMinimalSize(50, 12), SetResize(1, 0),
148 SetDataTip(STR_LIST_FILTER_OSKTITLE, STR_LIST_FILTER_TOOLTIP),
149 EndContainer(),
150 EndContainer(),
151 /* Sort Buttons */
152 NWidget(NWID_HORIZONTAL),
153 NWidget(NWID_HORIZONTAL, NC_EQUALSIZE),
154 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_SL_SORT_BYNAME), SetDataTip(STR_SORT_BY_CAPTION_NAME, STR_TOOLTIP_SORT_ORDER), SetFill(1, 0), SetResize(1, 0),
155 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_SL_SORT_BYDATE), SetDataTip(STR_SORT_BY_CAPTION_DATE, STR_TOOLTIP_SORT_ORDER), SetFill(1, 0), SetResize(1, 0),
156 EndContainer(),
157 NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_SL_HOME_BUTTON), SetMinimalSize(12, 12), SetDataTip(SPR_HOUSE_ICON, STR_SAVELOAD_HOME_BUTTON),
158 EndContainer(),
159 /* Files */
160 NWidget(NWID_HORIZONTAL),
161 NWidget(WWT_PANEL, COLOUR_GREY, WID_SL_FILE_BACKGROUND),
162 NWidget(WWT_INSET, COLOUR_GREY, WID_SL_DRIVES_DIRECTORIES_LIST), SetFill(1, 1), SetPadding(2, 2, 2, 2),
163 SetDataTip(0x0, STR_SAVELOAD_LIST_TOOLTIP), SetResize(1, 10), SetScrollbar(WID_SL_SCROLLBAR), EndContainer(),
164 EndContainer(),
165 NWidget(NWID_VSCROLLBAR, COLOUR_GREY, WID_SL_SCROLLBAR),
166 EndContainer(),
167 /* Online Content and Load button */
168 NWidget(NWID_HORIZONTAL, NC_EQUALSIZE),
169 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_SL_CONTENT_DOWNLOAD), SetResize(1, 0), SetFill(1, 0),
170 SetDataTip(STR_INTRO_ONLINE_CONTENT, STR_INTRO_TOOLTIP_ONLINE_CONTENT),
171 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_SL_LOAD_BUTTON), SetResize(1, 0), SetFill(1, 0),
172 SetDataTip(STR_SAVELOAD_LOAD_BUTTON, STR_SAVELOAD_LOAD_HEIGHTMAP_TOOLTIP),
173 NWidget(WWT_RESIZEBOX, COLOUR_GREY),
174 EndContainer(),
175 };
176
177 /** Save game/scenario */
178 static const NWidgetPart _nested_save_dialog_widgets[] = {
179 NWidget(NWID_HORIZONTAL),
180 NWidget(WWT_CLOSEBOX, COLOUR_GREY),
181 NWidget(WWT_CAPTION, COLOUR_GREY, WID_SL_CAPTION),
182 NWidget(WWT_DEFSIZEBOX, COLOUR_GREY),
183 EndContainer(),
184 /* Current directory and free space */
185 NWidget(WWT_PANEL, COLOUR_GREY, WID_SL_BACKGROUND), SetFill(1, 0), SetResize(1, 0), EndContainer(),
186 NWidget(NWID_HORIZONTAL, NC_EQUALSIZE),
187 /* Left side : filter box and available files */
188 NWidget(NWID_VERTICAL),
189 /* Filter box with label */
190 NWidget(WWT_PANEL, COLOUR_GREY), SetFill(1, 1), SetResize(1, 1),
191 NWidget(NWID_HORIZONTAL), SetPadding(WD_FRAMERECT_TOP, 0, WD_FRAMERECT_BOTTOM, 0),
192 SetPIP(WD_FRAMETEXT_LEFT, WD_FRAMETEXT_RIGHT, 0),
193 NWidget(WWT_TEXT, COLOUR_GREY), SetFill(0, 1), SetDataTip(STR_SAVELOAD_FILTER_TITLE , STR_NULL),
194 NWidget(WWT_EDITBOX, COLOUR_GREY, WID_SL_FILTER), SetFill(1, 0), SetMinimalSize(50, 12), SetResize(1, 0),
195 SetDataTip(STR_LIST_FILTER_OSKTITLE, STR_LIST_FILTER_TOOLTIP),
196 EndContainer(),
197 EndContainer(),
198 /* Sort buttons */
199 NWidget(NWID_HORIZONTAL),
200 NWidget(NWID_HORIZONTAL, NC_EQUALSIZE),
201 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_SL_SORT_BYNAME), SetDataTip(STR_SORT_BY_CAPTION_NAME, STR_TOOLTIP_SORT_ORDER), SetFill(1, 0), SetResize(1, 0),
202 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_SL_SORT_BYDATE), SetDataTip(STR_SORT_BY_CAPTION_DATE, STR_TOOLTIP_SORT_ORDER), SetFill(1, 0), SetResize(1, 0),
203 EndContainer(),
204 NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_SL_HOME_BUTTON), SetMinimalSize(12, 12), SetDataTip(SPR_HOUSE_ICON, STR_SAVELOAD_HOME_BUTTON),
205 EndContainer(),
206 /* Files */
207 NWidget(NWID_HORIZONTAL),
208 NWidget(WWT_PANEL, COLOUR_GREY, WID_SL_FILE_BACKGROUND),
209 NWidget(WWT_INSET, COLOUR_GREY, WID_SL_DRIVES_DIRECTORIES_LIST), SetPadding(2, 2, 2, 2),
210 SetDataTip(0x0, STR_SAVELOAD_LIST_TOOLTIP), SetResize(1, 10), SetScrollbar(WID_SL_SCROLLBAR), EndContainer(),
211 EndContainer(),
212 NWidget(NWID_VSCROLLBAR, COLOUR_GREY, WID_SL_SCROLLBAR),
213 EndContainer(),
214 NWidget(WWT_PANEL, COLOUR_GREY),
215 NWidget(WWT_EDITBOX, COLOUR_GREY, WID_SL_SAVE_OSK_TITLE), SetPadding(2, 2, 2, 2), SetFill(1, 0), SetResize(1, 0),
216 SetDataTip(STR_SAVELOAD_OSKTITLE, STR_SAVELOAD_EDITBOX_TOOLTIP),
217 EndContainer(),
218 /* Save/delete buttons */
219 NWidget(NWID_HORIZONTAL),
220 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_SL_DELETE_SELECTION), SetDataTip(STR_SAVELOAD_DELETE_BUTTON, STR_SAVELOAD_DELETE_TOOLTIP), SetFill(1, 0), SetResize(1, 0),
221 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_SL_SAVE_GAME), SetDataTip(STR_SAVELOAD_SAVE_BUTTON, STR_SAVELOAD_SAVE_TOOLTIP), SetFill(1, 0), SetResize(1, 0),
222 EndContainer(),
223 EndContainer(),
224
225 /* Right side : game details */
226 NWidget(WWT_PANEL, COLOUR_GREY),
227 NWidget(WWT_EMPTY, INVALID_COLOUR, WID_SL_DETAILS), SetResize(1, 1), SetFill(1, 1),
228 NWidget(NWID_HORIZONTAL),
229 NWidget(NWID_SPACER), SetResize(1, 0), SetFill(1, 1),
230 NWidget(WWT_RESIZEBOX, COLOUR_GREY),
231 EndContainer(),
232 EndContainer(),
233 EndContainer(),
234 };
235
236 /** Text colours of #DetailedFileType fios entries in the window. */
237 static const TextColour _fios_colours[] = {
238 TC_LIGHT_BROWN, // DFT_OLD_GAME_FILE
239 TC_ORANGE, // DFT_GAME_FILE
240 TC_YELLOW, // DFT_HEIGHTMAP_BMP
241 TC_ORANGE, // DFT_HEIGHTMAP_PNG
242 TC_LIGHT_BLUE, // DFT_FIOS_DRIVE
243 TC_DARK_GREEN, // DFT_FIOS_PARENT
244 TC_DARK_GREEN, // DFT_FIOS_DIR
245 TC_ORANGE, // DFT_FIOS_DIRECT
246 };
247
248
249 /**
250 * Sort the collected list save games prior to displaying it in the save/load gui.
251 * @param[in,out] file_list List of save game files found in the directory.
252 */
253 static void SortSaveGameList(FileList &file_list)
254 {
255 size_t sort_start = 0;
256 size_t sort_end = 0;
257
258 /* Directories are always above the files (FIOS_TYPE_DIR)
259 * Drives (A:\ (windows only) are always under the files (FIOS_TYPE_DRIVE)
260 * Only sort savegames/scenarios, not directories
261 */
262 for (const auto &item : file_list) {
263 switch (item.type) {
264 case FIOS_TYPE_DIR: sort_start++; break;
265 case FIOS_TYPE_PARENT: sort_start++; break;
266 case FIOS_TYPE_DRIVE: sort_end++; break;
267 default: break;
268 }
269 }
270
271 std::sort(file_list.begin() + sort_start, file_list.end() - sort_end);
272 }
273
274 struct SaveLoadWindow : public Window {
275 private:
276 static const uint EDITBOX_MAX_SIZE = 50;
277
278 QueryString filename_editbox; ///< Filename editbox.
279 AbstractFileType abstract_filetype; /// Type of file to select.
280 SaveLoadOperation fop; ///< File operation to perform.
281 FileList fios_items; ///< Save game list.
282 FiosItem o_dir; ///< Original dir (home dir for this browser)
283 const FiosItem *selected; ///< Selected game in #fios_items, or \c nullptr.
284 const FiosItem *highlighted; ///< Item in fios_items highlighted by mouse pointer, or \c nullptr.
285 Scrollbar *vscroll;
286
287 StringFilter string_filter; ///< Filter for available games.
288 QueryString filter_editbox; ///< Filter editbox;
289 std::vector<bool> fios_items_shown; ///< Map of the filtered out fios items
290
291 static void SaveGameConfirmationCallback(Window *w, bool confirmed)
292 {
293 /* File name has already been written to _file_to_saveload */
294 if (confirmed) _switch_mode = SM_SAVE_GAME;
295 }
296
297 static void SaveHeightmapConfirmationCallback(Window *w, bool confirmed)
298 {
299 /* File name has already been written to _file_to_saveload */
300 if (confirmed) _switch_mode = SM_SAVE_HEIGHTMAP;
301 }
302
303 public:
304
305 /** Generate a default save filename. */
306 void GenerateFileName()
307 {
308 GenerateDefaultSaveName(this->filename_editbox.text.buf, &this->filename_editbox.text.buf[this->filename_editbox.text.max_bytes - 1]);
309 this->filename_editbox.text.UpdateSize();
310 }
311
312 SaveLoadWindow(WindowDesc *desc, AbstractFileType abstract_filetype, SaveLoadOperation fop)
313 : Window(desc), filename_editbox(64), abstract_filetype(abstract_filetype), fop(fop), filter_editbox(EDITBOX_MAX_SIZE)
314 {
315 assert(this->fop == SLO_SAVE || this->fop == SLO_LOAD);
316
317 /* For saving, construct an initial file name. */
318 if (this->fop == SLO_SAVE) {
319 switch (this->abstract_filetype) {
320 case FT_SAVEGAME:
321 this->GenerateFileName();
322 break;
323
324 case FT_SCENARIO:
325 case FT_HEIGHTMAP:
326 this->filename_editbox.text.Assign("UNNAMED");
327 break;
328
329 default:
330 NOT_REACHED();
331 }
332 }
333 this->querystrings[WID_SL_SAVE_OSK_TITLE] = &this->filename_editbox;
334 this->filename_editbox.ok_button = WID_SL_SAVE_GAME;
335
336 this->CreateNestedTree(true);
337 if (this->fop == SLO_LOAD && this->abstract_filetype == FT_SAVEGAME) {
338 this->GetWidget<NWidgetStacked>(WID_SL_CONTENT_DOWNLOAD_SEL)->SetDisplayedPlane(SZSP_HORIZONTAL);
339 }
340
341 /* Select caption string of the window. */
342 StringID caption_string;
343 switch (this->abstract_filetype) {
344 case FT_SAVEGAME:
345 caption_string = (this->fop == SLO_SAVE) ? STR_SAVELOAD_SAVE_CAPTION : STR_SAVELOAD_LOAD_CAPTION;
346 break;
347
348 case FT_SCENARIO:
349 caption_string = (this->fop == SLO_SAVE) ? STR_SAVELOAD_SAVE_SCENARIO : STR_SAVELOAD_LOAD_SCENARIO;
350 break;
351
352 case FT_HEIGHTMAP:
353 caption_string = (this->fop == SLO_SAVE) ? STR_SAVELOAD_SAVE_HEIGHTMAP : STR_SAVELOAD_LOAD_HEIGHTMAP;
354 break;
355
356 default:
357 NOT_REACHED();
358 }
359 this->GetWidget<NWidgetCore>(WID_SL_CAPTION)->widget_data = caption_string;
360
361 this->vscroll = this->GetScrollbar(WID_SL_SCROLLBAR);
362 this->FinishInitNested(0);
363
364 this->LowerWidget(WID_SL_DRIVES_DIRECTORIES_LIST);
365 this->querystrings[WID_SL_FILTER] = &this->filter_editbox;
366 this->filter_editbox.cancel_button = QueryString::ACTION_CLEAR;
367
368 /* pause is only used in single-player, non-editor mode, non-menu mode. It
369 * will be unpaused in the WE_DESTROY event handler. */
370 if (_game_mode != GM_MENU && !_networking && _game_mode != GM_EDITOR) {
371 Command<CMD_PAUSE>::Post(PM_PAUSED_SAVELOAD, true);
372 }
373 SetObjectToPlace(SPR_CURSOR_ZZZ, PAL_NONE, HT_NONE, WC_MAIN_WINDOW, 0);
374
375 this->OnInvalidateData(SLIWD_RESCAN_FILES);
376
377 ResetObjectToPlace();
378
379 /* Select the initial directory. */
380 o_dir.type = FIOS_TYPE_DIRECT;
381 std::string dir;
382 switch (this->abstract_filetype) {
383 case FT_SAVEGAME:
384 dir = FioFindDirectory(SAVE_DIR);
385 break;
386
387 case FT_SCENARIO:
388 dir = FioFindDirectory(SCENARIO_DIR);
389 break;
390
391 case FT_HEIGHTMAP:
392 dir = FioFindDirectory(HEIGHTMAP_DIR);
393 break;
394
395 default:
396 dir = _personal_dir;
397 }
398 strecpy(o_dir.name, dir.c_str(), lastof(o_dir.name));
399
400 switch (this->fop) {
401 case SLO_SAVE:
402 /* Focus the edit box by default in the save window */
403 this->SetFocusedWidget(WID_SL_SAVE_OSK_TITLE);
404 break;
405
406 default:
407 this->SetFocusedWidget(WID_SL_FILTER);
408 }
409 }
410
411 void Close() override
412 {
413 /* pause is only used in single-player, non-editor mode, non menu mode */
414 if (!_networking && _game_mode != GM_EDITOR && _game_mode != GM_MENU) {
415 Command<CMD_PAUSE>::Post(PM_PAUSED_SAVELOAD, false);
416 }
417 this->Window::Close();
418 }
419
420 void DrawWidget(const Rect &r, int widget) const override
421 {
422 switch (widget) {
423 case WID_SL_SORT_BYNAME:
424 case WID_SL_SORT_BYDATE:
425 if (((_savegame_sort_order & SORT_BY_NAME) != 0) == (widget == WID_SL_SORT_BYNAME)) {
426 this->DrawSortButtonState(widget, _savegame_sort_order & SORT_DESCENDING ? SBS_DOWN : SBS_UP);
427 }
428 break;
429
430 case WID_SL_BACKGROUND: {
431 static const char *path = nullptr;
432 static StringID str = STR_ERROR_UNABLE_TO_READ_DRIVE;
433 static uint64 tot = 0;
434
435 if (_fios_path_changed) {
436 str = FiosGetDescText(&path, &tot);
437 _fios_path_changed = false;
438 }
439
440 if (str != STR_ERROR_UNABLE_TO_READ_DRIVE) SetDParam(0, tot);
441 DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, r.top + FONT_HEIGHT_NORMAL + WD_FRAMERECT_TOP, str);
442 DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, r.top + WD_FRAMERECT_TOP, path, TC_BLACK);
443 break;
444 }
445
446 case WID_SL_DRIVES_DIRECTORIES_LIST: {
447 GfxFillRect(r.left + 1, r.top + 1, r.right - 1, r.bottom - 1, PC_BLACK);
448
449 uint y = r.top + WD_FRAMERECT_TOP;
450 uint scroll_pos = this->vscroll->GetPosition();
451 for (uint row = 0; row < this->fios_items.size(); row++) {
452 if (!this->fios_items_shown[row]) {
453 /* The current item is filtered out : we do not show it */
454 scroll_pos++;
455 continue;
456 }
457 if (row < scroll_pos) continue;
458 const FiosItem *item = &this->fios_items[row];
459
460 if (item == this->selected) {
461 GfxFillRect(r.left + 1, y, r.right - 1, y + this->resize.step_height - 1, PC_DARK_BLUE);
462 } else if (item == this->highlighted) {
463 GfxFillRect(r.left + 1, y, r.right - 1, y + this->resize.step_height - 1, PC_VERY_DARK_BLUE);
464 }
465 DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, y, item->title, _fios_colours[GetDetailedFileType(item->type)]);
466 y += this->resize.step_height;
467 if (y >= this->vscroll->GetCapacity() * this->resize.step_height + r.top + WD_FRAMERECT_TOP) break;
468 }
469 break;
470 }
471
472 case WID_SL_DETAILS: {
473 GfxFillRect(r.left + 1, r.top + 1, r.right - 1, r.top + FONT_HEIGHT_NORMAL * 2 + WD_FRAMERECT_TOP + WD_FRAMERECT_BOTTOM, PC_GREY);
474 DrawString(r.left, r.right, r.top + FONT_HEIGHT_NORMAL / 2 + WD_FRAMERECT_TOP, STR_SAVELOAD_DETAIL_CAPTION, TC_FROMSTRING, SA_HOR_CENTER);
475
476 if (this->selected == nullptr) break;
477
478 uint y = r.top + FONT_HEIGHT_NORMAL * 2 + WD_PAR_VSEP_NORMAL + WD_FRAMERECT_TOP + WD_FRAMERECT_BOTTOM;
479 uint y_max = r.bottom - FONT_HEIGHT_NORMAL - WD_FRAMERECT_BOTTOM;
480
481 if (y > y_max) break;
482 if (!_load_check_data.checkable) {
483 /* Old savegame, no information available */
484 DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, y, STR_SAVELOAD_DETAIL_NOT_AVAILABLE);
485 y += FONT_HEIGHT_NORMAL;
486 } else if (_load_check_data.error != INVALID_STRING_ID) {
487 /* Incompatible / broken savegame */
488 SetDParamStr(0, _load_check_data.error_data);
489 y = DrawStringMultiLine(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT,
490 y, r.bottom - WD_FRAMERECT_BOTTOM, _load_check_data.error, TC_RED);
491 } else {
492 /* Mapsize */
493 SetDParam(0, _load_check_data.map_size_x);
494 SetDParam(1, _load_check_data.map_size_y);
495 DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, y, STR_NETWORK_SERVER_LIST_MAP_SIZE);
496 y += FONT_HEIGHT_NORMAL;
497 if (y > y_max) break;
498
499 /* Climate */
500 byte landscape = _load_check_data.settings.game_creation.landscape;
501 if (landscape < NUM_LANDSCAPE) {
502 SetDParam(0, STR_CHEAT_SWITCH_CLIMATE_TEMPERATE_LANDSCAPE + landscape);
503 DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, y, STR_NETWORK_SERVER_LIST_LANDSCAPE);
504 y += FONT_HEIGHT_NORMAL;
505 }
506
507 y += WD_PAR_VSEP_NORMAL;
508 if (y > y_max) break;
509
510 /* Start date (if available) */
511 if (_load_check_data.settings.game_creation.starting_year != 0) {
512 SetDParam(0, ConvertYMDToDate(_load_check_data.settings.game_creation.starting_year, 0, 1));
513 DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, y, STR_NETWORK_SERVER_LIST_START_DATE);
514 y += FONT_HEIGHT_NORMAL;
515 }
516 if (y > y_max) break;
517
518 /* Hide current date for scenarios */
519 if (this->abstract_filetype != FT_SCENARIO) {
520 /* Current date */
521 SetDParam(0, _load_check_data.current_date);
522 DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, y, STR_NETWORK_SERVER_LIST_CURRENT_DATE);
523 y += FONT_HEIGHT_NORMAL;
524 }
525
526 /* Hide the NewGRF stuff when saving. We also hide the button. */
527 if (this->fop == SLO_LOAD && (this->abstract_filetype == FT_SAVEGAME || this->abstract_filetype == FT_SCENARIO)) {
528 y += WD_PAR_VSEP_NORMAL;
529 if (y > y_max) break;
530
531 /* NewGrf compatibility */
532 SetDParam(0, _load_check_data.grfconfig == nullptr ? STR_NEWGRF_LIST_NONE :
533 STR_NEWGRF_LIST_ALL_FOUND + _load_check_data.grf_compatibility);
534 DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, y, STR_SAVELOAD_DETAIL_GRFSTATUS);
535 y += FONT_HEIGHT_NORMAL;
536 }
537 if (y > y_max) break;
538
539 /* Hide the company stuff for scenarios */
540 if (this->abstract_filetype != FT_SCENARIO) {
541 y += FONT_HEIGHT_NORMAL;
542 if (y > y_max) break;
543
544 /* Companies / AIs */
545 for (auto &pair : _load_check_data.companies) {
546 SetDParam(0, pair.first + 1);
547 const CompanyProperties &c = *pair.second;
548 if (!c.name.empty()) {
549 SetDParam(1, STR_JUST_RAW_STRING);
550 SetDParamStr(2, c.name);
551 } else {
552 SetDParam(1, c.name_1);
553 SetDParam(2, c.name_2);
554 }
555 DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, y, STR_SAVELOAD_DETAIL_COMPANY_INDEX);
556 y += FONT_HEIGHT_NORMAL;
557 if (y > y_max) break;
558 }
559 }
560 }
561 break;
562 }
563 }
564 }
565
566 void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
567 {
568 switch (widget) {
569 case WID_SL_BACKGROUND:
570 size->height = 2 * FONT_HEIGHT_NORMAL + WD_FRAMERECT_TOP + WD_FRAMERECT_BOTTOM;
571 break;
572
573 case WID_SL_DRIVES_DIRECTORIES_LIST:
574 resize->height = FONT_HEIGHT_NORMAL;
575 size->height = resize->height * 10 + WD_FRAMERECT_TOP + WD_FRAMERECT_BOTTOM;
576 break;
577 case WID_SL_SORT_BYNAME:
578 case WID_SL_SORT_BYDATE: {
579 Dimension d = GetStringBoundingBox(this->GetWidget<NWidgetCore>(widget)->widget_data);
580 d.width += padding.width + Window::SortButtonWidth() * 2; // Doubled since the string is centred and it also looks better.
581 d.height += padding.height;
582 *size = maxdim(*size, d);
583 break;
584 }
585 }
586 }
587
588 void OnPaint() override
589 {
590 if (_savegame_sort_dirty) {
591 _savegame_sort_dirty = false;
592 SortSaveGameList(this->fios_items);
593 this->OnInvalidateData(SLIWD_FILTER_CHANGES);
594 }
595
596 this->DrawWidgets();
597 }
598
599 void OnClick(Point pt, int widget, int click_count) override
600 {
601 switch (widget) {
602 case WID_SL_SORT_BYNAME: // Sort save names by name
603 _savegame_sort_order = (_savegame_sort_order == SORT_BY_NAME) ?
604 SORT_BY_NAME | SORT_DESCENDING : SORT_BY_NAME;
605 _savegame_sort_dirty = true;
606 this->SetDirty();
607 break;
608
609 case WID_SL_SORT_BYDATE: // Sort save names by date
610 _savegame_sort_order = (_savegame_sort_order == SORT_BY_DATE) ?
611 SORT_BY_DATE | SORT_DESCENDING : SORT_BY_DATE;
612 _savegame_sort_dirty = true;
613 this->SetDirty();
614 break;
615
616 case WID_SL_HOME_BUTTON: // OpenTTD 'button', jumps to OpenTTD directory
617 FiosBrowseTo(&o_dir);
618 this->InvalidateData(SLIWD_RESCAN_FILES);
619 break;
620
621 case WID_SL_LOAD_BUTTON: {
622 if (this->selected == nullptr || _load_check_data.HasErrors()) break;
623
624 const char *name = FiosBrowseTo(this->selected);
625 _file_to_saveload.SetMode(this->selected->type);
626 _file_to_saveload.SetName(name);
627 _file_to_saveload.SetTitle(this->selected->title);
628
629 if (this->abstract_filetype == FT_HEIGHTMAP) {
630 this->Close();
631 ShowHeightmapLoad();
632 } else if (!_load_check_data.HasNewGrfs() || _load_check_data.grf_compatibility != GLC_NOT_FOUND || _settings_client.gui.UserIsAllowedToChangeNewGRFs()) {
633 _switch_mode = (_game_mode == GM_EDITOR) ? SM_LOAD_SCENARIO : SM_LOAD_GAME;
634 ClearErrorMessages();
635 this->Close();
636 }
637 break;
638 }
639
640 case WID_SL_NEWGRF_INFO:
641 if (_load_check_data.HasNewGrfs()) {
642 ShowNewGRFSettings(false, false, false, &_load_check_data.grfconfig);
643 }
644 break;
645
646 case WID_SL_MISSING_NEWGRFS:
647 if (!_network_available) {
648 ShowErrorMessage(STR_NETWORK_ERROR_NOTAVAILABLE, INVALID_STRING_ID, WL_ERROR);
649 } else if (_load_check_data.HasNewGrfs()) {
650 ShowMissingContentWindow(_load_check_data.grfconfig);
651 }
652 break;
653
654 case WID_SL_DRIVES_DIRECTORIES_LIST: { // Click the listbox
655 int y = this->vscroll->GetScrolledRowFromWidget(pt.y, this, WID_SL_DRIVES_DIRECTORIES_LIST, WD_FRAMERECT_TOP);
656 if (y == INT_MAX) return;
657
658 /* Get the corresponding non-filtered out item from the list */
659 int i = 0;
660 while (i <= y) {
661 if (!this->fios_items_shown[i]) y++;
662 i++;
663 }
664 const FiosItem *file = &this->fios_items[y];
665
666 const char *name = FiosBrowseTo(file);
667 if (name == nullptr) {
668 /* Changed directory, need refresh. */
669 this->InvalidateData(SLIWD_RESCAN_FILES);
670 break;
671 }
672
673 if (click_count == 1) {
674 if (this->selected != file) {
675 this->selected = file;
676 _load_check_data.Clear();
677
678 if (GetDetailedFileType(file->type) == DFT_GAME_FILE) {
679 /* Other detailed file types cannot be checked before. */
680 SaveOrLoad(name, SLO_CHECK, DFT_GAME_FILE, NO_DIRECTORY, false);
681 }
682
683 this->InvalidateData(SLIWD_SELECTION_CHANGES);
684 }
685 if (this->fop == SLO_SAVE) {
686 /* Copy clicked name to editbox */
687 this->filename_editbox.text.Assign(file->title);
688 this->SetWidgetDirty(WID_SL_SAVE_OSK_TITLE);
689 }
690 } else if (!_load_check_data.HasErrors()) {
691 this->selected = file;
692 if (this->fop == SLO_LOAD) {
693 if (this->abstract_filetype == FT_SAVEGAME || this->abstract_filetype == FT_SCENARIO) {
694 this->OnClick(pt, WID_SL_LOAD_BUTTON, 1);
695 } else {
696 assert(this->abstract_filetype == FT_HEIGHTMAP);
697 _file_to_saveload.SetMode(file->type);
698 _file_to_saveload.SetName(name);
699 _file_to_saveload.SetTitle(file->title);
700
701 this->Close();
702 ShowHeightmapLoad();
703 }
704 }
705 }
706 break;
707 }
708
709 case WID_SL_CONTENT_DOWNLOAD:
710 if (!_network_available) {
711 ShowErrorMessage(STR_NETWORK_ERROR_NOTAVAILABLE, INVALID_STRING_ID, WL_ERROR);
712 } else {
713 assert(this->fop == SLO_LOAD);
714 switch (this->abstract_filetype) {
715 default: NOT_REACHED();
716 case FT_SCENARIO: ShowNetworkContentListWindow(nullptr, CONTENT_TYPE_SCENARIO); break;
717 case FT_HEIGHTMAP: ShowNetworkContentListWindow(nullptr, CONTENT_TYPE_HEIGHTMAP); break;
718 }
719 }
720 break;
721
722 case WID_SL_DELETE_SELECTION: // Delete
723 break;
724
725 case WID_SL_SAVE_GAME: // Save game
726 /* Note, this is also called via the OSK; and we need to lower the button. */
727 this->HandleButtonClick(WID_SL_SAVE_GAME);
728 break;
729 }
730 }
731
732 void OnMouseOver(Point pt, int widget) override
733 {
734 if (widget == WID_SL_DRIVES_DIRECTORIES_LIST) {
735 int y = this->vscroll->GetScrolledRowFromWidget(pt.y, this, WID_SL_DRIVES_DIRECTORIES_LIST, WD_FRAMERECT_TOP);
736 if (y == INT_MAX) return;
737
738 /* Get the corresponding non-filtered out item from the list */
739 int i = 0;
740 while (i <= y) {
741 if (!this->fios_items_shown[i]) y++;
742 i++;
743 }
744 const FiosItem *file = &this->fios_items[y];
745
746 if (file != this->highlighted) {
747 this->highlighted = file;
748 this->SetWidgetDirty(WID_SL_DRIVES_DIRECTORIES_LIST);
749 }
750 } else if (this->highlighted != nullptr) {
751 this->highlighted = nullptr;
752 this->SetWidgetDirty(WID_SL_DRIVES_DIRECTORIES_LIST);
753 }
754 }
755
756 EventState OnKeyPress(WChar key, uint16 keycode) override
757 {
758 if (keycode == WKC_ESC) {
759 this->Close();
760 return ES_HANDLED;
761 }
762
763 return ES_NOT_HANDLED;
764 }
765
766 void OnTimeout() override
767 {
768 /* Widgets WID_SL_DELETE_SELECTION and WID_SL_SAVE_GAME only exist when saving to a file. */
769 if (this->fop != SLO_SAVE) return;
770
771 if (this->IsWidgetLowered(WID_SL_DELETE_SELECTION)) { // Delete button clicked
772 if (!FiosDelete(this->filename_editbox.text.buf)) {
773 ShowErrorMessage(STR_ERROR_UNABLE_TO_DELETE_FILE, INVALID_STRING_ID, WL_ERROR);
774 } else {
775 this->InvalidateData(SLIWD_RESCAN_FILES);
776 /* Reset file name to current date on successful delete */
777 if (this->abstract_filetype == FT_SAVEGAME) GenerateFileName();
778 }
779 } else if (this->IsWidgetLowered(WID_SL_SAVE_GAME)) { // Save button clicked
780 if (this->abstract_filetype == FT_SAVEGAME || this->abstract_filetype == FT_SCENARIO) {
781 _file_to_saveload.name = FiosMakeSavegameName(this->filename_editbox.text.buf);
782 if (FioCheckFileExists(_file_to_saveload.name, Subdirectory::SAVE_DIR)) {
783 ShowQuery(STR_SAVELOAD_OVERWRITE_TITLE, STR_SAVELOAD_OVERWRITE_WARNING, this, SaveLoadWindow::SaveGameConfirmationCallback);
784 } else {
785 _switch_mode = SM_SAVE_GAME;
786 }
787 } else {
788 _file_to_saveload.name = FiosMakeHeightmapName(this->filename_editbox.text.buf);
789 if (FioCheckFileExists(_file_to_saveload.name, Subdirectory::SAVE_DIR)) {
790 ShowQuery(STR_SAVELOAD_OVERWRITE_TITLE, STR_SAVELOAD_OVERWRITE_WARNING, this, SaveLoadWindow::SaveHeightmapConfirmationCallback);
791 } else {
792 _switch_mode = SM_SAVE_HEIGHTMAP;
793 }
794 }
795
796 /* In the editor set up the vehicle engines correctly (date might have changed) */
797 if (_game_mode == GM_EDITOR) StartupEngines();
798 }
799 }
800
801 void OnResize() override
802 {
803 this->vscroll->SetCapacityFromWidget(this, WID_SL_DRIVES_DIRECTORIES_LIST);
804 }
805
806 /**
807 * Some data on this window has become invalid.
808 * @param data Information about the changed data.
809 * @param gui_scope Whether the call is done from GUI scope. You may not do everything when not in GUI scope. See #InvalidateWindowData() for details.
810 */
811 void OnInvalidateData(int data = 0, bool gui_scope = true) override
812 {
813 switch (data) {
814 case SLIWD_RESCAN_FILES:
815 /* Rescan files */
816 this->selected = nullptr;
817 _load_check_data.Clear();
818 if (!gui_scope) break;
819
820 _fios_path_changed = true;
821 this->fios_items.BuildFileList(this->abstract_filetype, this->fop);
822 this->vscroll->SetCount((uint)this->fios_items.size());
823 this->selected = nullptr;
824 _load_check_data.Clear();
825
826 /* We reset the files filtered */
827 this->OnInvalidateData(SLIWD_FILTER_CHANGES);
828
829 FALLTHROUGH;
830
831 case SLIWD_SELECTION_CHANGES:
832 /* Selection changes */
833 if (!gui_scope) break;
834
835 if (this->fop != SLO_LOAD) break;
836
837 switch (this->abstract_filetype) {
838 case FT_HEIGHTMAP:
839 this->SetWidgetDisabledState(WID_SL_LOAD_BUTTON, this->selected == nullptr || _load_check_data.HasErrors());
840 break;
841
842 case FT_SAVEGAME:
843 case FT_SCENARIO: {
844 bool disabled = this->selected == nullptr || _load_check_data.HasErrors();
845 if (!_settings_client.gui.UserIsAllowedToChangeNewGRFs()) {
846 disabled |= _load_check_data.HasNewGrfs() && _load_check_data.grf_compatibility == GLC_NOT_FOUND;
847 }
848 this->SetWidgetDisabledState(WID_SL_LOAD_BUTTON, disabled);
849 this->SetWidgetDisabledState(WID_SL_NEWGRF_INFO, !_load_check_data.HasNewGrfs());
850 this->SetWidgetDisabledState(WID_SL_MISSING_NEWGRFS,
851 !_load_check_data.HasNewGrfs() || _load_check_data.grf_compatibility == GLC_ALL_GOOD);
852 break;
853 }
854
855 default:
856 NOT_REACHED();
857 }
858 break;
859
860 case SLIWD_FILTER_CHANGES:
861 /* Filter changes */
862 this->fios_items_shown.resize(this->fios_items.size());
863 uint items_shown_count = 0; ///< The number of items shown in the list
864 /* We pass through every fios item */
865 for (uint i = 0; i < this->fios_items.size(); i++) {
866 if (this->string_filter.IsEmpty()) {
867 /* We don't filter anything out if the filter editbox is empty */
868 this->fios_items_shown[i] = true;
869 items_shown_count++;
870 } else {
871 this->string_filter.ResetState();
872 this->string_filter.AddLine(this->fios_items[i].title);
873 /* We set the vector to show this fios element as filtered depending on the result of the filter */
874 this->fios_items_shown[i] = this->string_filter.GetState();
875 if (this->fios_items_shown[i]) items_shown_count++;
876
877 if (&(this->fios_items[i]) == this->selected && !this->fios_items_shown[i]) {
878 /* The selected element has been filtered out */
879 this->selected = nullptr;
880 this->OnInvalidateData(SLIWD_SELECTION_CHANGES);
881 }
882 }
883 }
884 this->vscroll->SetCount(items_shown_count);
885 break;
886 }
887 }
888
889 void OnEditboxChanged(int wid) override
890 {
891 if (wid == WID_SL_FILTER) {
892 this->string_filter.SetFilterTerm(this->filter_editbox.text.buf);
893 this->InvalidateData(SLIWD_FILTER_CHANGES);
894 }
895 }
896 };
897
898 /** Load game/scenario */
899 static WindowDesc _load_dialog_desc(
900 WDP_CENTER, "load_game", 500, 294,
901 WC_SAVELOAD, WC_NONE,
902 0,
903 _nested_load_dialog_widgets, lengthof(_nested_load_dialog_widgets)
904 );
905
906 /** Load heightmap */
907 static WindowDesc _load_heightmap_dialog_desc(
908 WDP_CENTER, "load_heightmap", 257, 320,
909 WC_SAVELOAD, WC_NONE,
910 0,
911 _nested_load_heightmap_dialog_widgets, lengthof(_nested_load_heightmap_dialog_widgets)
912 );
913
914 /** Save game/scenario */
915 static WindowDesc _save_dialog_desc(
916 WDP_CENTER, "save_game", 500, 294,
917 WC_SAVELOAD, WC_NONE,
918 0,
919 _nested_save_dialog_widgets, lengthof(_nested_save_dialog_widgets)
920 );
921
922 /**
923 * Launch save/load dialog in the given mode.
924 * @param abstract_filetype Kind of file to handle.
925 * @param fop File operation to perform (load or save).
926 */
927 void ShowSaveLoadDialog(AbstractFileType abstract_filetype, SaveLoadOperation fop)
928 {
929 CloseWindowById(WC_SAVELOAD, 0);
930
931 WindowDesc *sld;
932 if (fop == SLO_SAVE) {
933 sld = &_save_dialog_desc;
934 } else {
935 /* Dialogue for loading a file. */
936 sld = (abstract_filetype == FT_HEIGHTMAP) ? &_load_heightmap_dialog_desc : &_load_dialog_desc;
937 }
938
939 new SaveLoadWindow(sld, abstract_filetype, fop);
940 }
OpenTTD is an open source simulation game based upon Transport Tycoon Deluxe