OpenTTD Source  12.0-beta2
fios_gui.cpp
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 #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"
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 
31 #include "widgets/fios_widget.h"
32 
33 #include "table/sprites.h"
34 #include "table/strings.h"
35 
36 #include "safeguards.h"
37 
39 
40 static bool _fios_path_changed;
41 static bool _savegame_sort_dirty;
42 
43 
48 {
49  this->checkable = false;
50  this->error = INVALID_STRING_ID;
51  free(this->error_data);
52  this->error_data = nullptr;
53 
54  this->map_size_x = this->map_size_y = 256; // Default for old savegames which do not store mapsize.
55  this->current_date = 0;
56  this->settings = {};
57 
58  for (auto &pair : this->companies) {
59  delete pair.second;
60  }
61  companies.clear();
62 
64  this->gamelog_action = nullptr;
65  this->gamelog_actions = 0;
66 
68 }
69 
73  NWidget(WWT_CLOSEBOX, COLOUR_GREY),
74  NWidget(WWT_CAPTION, COLOUR_GREY, WID_SL_CAPTION),
75  NWidget(WWT_DEFSIZEBOX, COLOUR_GREY),
76  EndContainer(),
77  /* Current directory and free space */
78  NWidget(WWT_PANEL, COLOUR_GREY, WID_SL_BACKGROUND), SetFill(1, 0), SetResize(1, 0), EndContainer(),
79 
81  /* Left side : filter box and available files */
82  NWidget(WWT_PANEL, COLOUR_GREY), SetFill(1, 1), SetResize(1, 1),
83  /* Filter box with label */
86  NWidget(WWT_TEXT, COLOUR_GREY), SetFill(0, 1), SetDataTip(STR_SAVELOAD_FILTER_TITLE , STR_NULL),
87  NWidget(WWT_EDITBOX, COLOUR_GREY, WID_SL_FILTER), SetFill(1, 0), SetMinimalSize(50, 12), SetResize(1, 0),
88  SetDataTip(STR_LIST_FILTER_OSKTITLE, STR_LIST_FILTER_TOOLTIP),
89  EndContainer(),
90  /* Sort buttons */
93  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),
94  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),
95  EndContainer(),
96  NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_SL_HOME_BUTTON), SetMinimalSize(12, 12), SetDataTip(SPR_HOUSE_ICON, STR_SAVELOAD_HOME_BUTTON),
97  EndContainer(),
98  /* Files */
101  NWidget(WWT_INSET, COLOUR_GREY, WID_SL_DRIVES_DIRECTORIES_LIST), SetFill(1, 1), SetPadding(2, 1, 2, 2),
102  SetDataTip(0x0, STR_SAVELOAD_LIST_TOOLTIP), SetResize(1, 10), SetScrollbar(WID_SL_SCROLLBAR), EndContainer(),
104  EndContainer(),
107  SetDataTip(STR_INTRO_ONLINE_CONTENT, STR_INTRO_TOOLTIP_ONLINE_CONTENT),
108  EndContainer(),
109  EndContainer(),
110  EndContainer(),
111 
112  /* Right side : game details */
113  NWidget(WWT_PANEL, COLOUR_GREY),
114  NWidget(WWT_EMPTY, INVALID_COLOUR, WID_SL_DETAILS), SetResize(1, 1), SetFill(1, 1),
115  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),
118  NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_SL_NEWGRF_INFO), SetDataTip(STR_INTRO_NEWGRF_SETTINGS, STR_NULL), SetFill(1, 0), SetResize(1, 0),
119  NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_SL_LOAD_BUTTON), SetDataTip(STR_SAVELOAD_LOAD_BUTTON, STR_SAVELOAD_LOAD_TOOLTIP), SetFill(1, 0), SetResize(1, 0),
120  EndContainer(),
121  NWidget(WWT_RESIZEBOX, COLOUR_GREY),
122  EndContainer(),
123  EndContainer(),
124  EndContainer(),
125 };
126 
130  NWidget(WWT_CLOSEBOX, COLOUR_GREY),
131  NWidget(WWT_CAPTION, COLOUR_GREY, WID_SL_CAPTION),
132  NWidget(WWT_DEFSIZEBOX, COLOUR_GREY),
133  EndContainer(),
134  /* Current directory and free space */
135  NWidget(WWT_PANEL, COLOUR_GREY, WID_SL_BACKGROUND), SetFill(1, 0), SetResize(1, 0), EndContainer(),
136 
137  NWidget(WWT_PANEL, COLOUR_GREY), SetFill(1, 1), SetResize(1, 1),
138  /* Filter box with label */
141  NWidget(WWT_TEXT, COLOUR_GREY), SetFill(0, 1), SetDataTip(STR_SAVELOAD_FILTER_TITLE , STR_NULL),
142  NWidget(WWT_EDITBOX, COLOUR_GREY, WID_SL_FILTER), SetFill(1, 0), SetMinimalSize(50, 12), SetResize(1, 0),
143  SetDataTip(STR_LIST_FILTER_OSKTITLE, STR_LIST_FILTER_TOOLTIP),
144  EndContainer(),
145  /* Sort Buttons */
148  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),
149  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),
150  EndContainer(),
151  NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_SL_HOME_BUTTON), SetMinimalSize(12, 12), SetDataTip(SPR_HOUSE_ICON, STR_SAVELOAD_HOME_BUTTON),
152  EndContainer(),
153  /* Files */
156  NWidget(WWT_INSET, COLOUR_GREY, WID_SL_DRIVES_DIRECTORIES_LIST), SetFill(1, 1), SetPadding(2, 1, 2, 2),
157  SetDataTip(0x0, STR_SAVELOAD_LIST_TOOLTIP), SetResize(1, 10), SetScrollbar(WID_SL_SCROLLBAR), EndContainer(),
159  EndContainer(),
161  NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_SL_CONTENT_DOWNLOAD), SetResize(1, 0), SetFill(1, 0),
162  SetDataTip(STR_INTRO_ONLINE_CONTENT, STR_INTRO_TOOLTIP_ONLINE_CONTENT),
163  NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_SL_LOAD_BUTTON), SetResize(1, 0), SetFill(1, 0),
164  SetDataTip(STR_SAVELOAD_LOAD_BUTTON, STR_SAVELOAD_LOAD_HEIGHTMAP_TOOLTIP),
165  NWidget(WWT_RESIZEBOX, COLOUR_GREY),
166  EndContainer(),
167  EndContainer(),
168  EndContainer(),
169 };
170 
174  NWidget(WWT_CLOSEBOX, COLOUR_GREY),
175  NWidget(WWT_CAPTION, COLOUR_GREY, WID_SL_CAPTION),
176  NWidget(WWT_DEFSIZEBOX, COLOUR_GREY),
177  EndContainer(),
178  /* Current directory and free space */
179  NWidget(WWT_PANEL, COLOUR_GREY, WID_SL_BACKGROUND), SetFill(1, 0), SetResize(1, 0), EndContainer(),
181  /* Left side : filter box and available files */
182  NWidget(WWT_PANEL, COLOUR_GREY), SetFill(1, 1), SetResize(1, 1),
183  /* Filter box with label */
186  NWidget(WWT_TEXT, COLOUR_GREY), SetFill(0, 1), SetDataTip(STR_SAVELOAD_FILTER_TITLE , STR_NULL),
187  NWidget(WWT_EDITBOX, COLOUR_GREY, WID_SL_FILTER), SetFill(1, 0), SetMinimalSize(50, 12), SetResize(1, 0),
188  SetDataTip(STR_LIST_FILTER_OSKTITLE, STR_LIST_FILTER_TOOLTIP),
189  EndContainer(),
190  /* Sort buttons */
193  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),
194  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),
195  EndContainer(),
196  NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_SL_HOME_BUTTON), SetMinimalSize(12, 12), SetDataTip(SPR_HOUSE_ICON, STR_SAVELOAD_HOME_BUTTON),
197  EndContainer(),
198  /* Files */
201  NWidget(WWT_INSET, COLOUR_GREY, WID_SL_DRIVES_DIRECTORIES_LIST), SetPadding(2, 1, 0, 2),
202  SetDataTip(0x0, STR_SAVELOAD_LIST_TOOLTIP), SetResize(1, 10), SetScrollbar(WID_SL_SCROLLBAR), EndContainer(),
204  EndContainer(),
205  NWidget(WWT_EDITBOX, COLOUR_GREY, WID_SL_SAVE_OSK_TITLE), SetPadding(3, 2, 2, 2), SetFill(1, 0), SetResize(1, 0),
206  SetDataTip(STR_SAVELOAD_OSKTITLE, STR_SAVELOAD_EDITBOX_TOOLTIP),
207  EndContainer(),
208  /* Save/delete buttons */
210  NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_SL_DELETE_SELECTION), SetDataTip(STR_SAVELOAD_DELETE_BUTTON, STR_SAVELOAD_DELETE_TOOLTIP), SetFill(1, 0), SetResize(1, 0),
211  NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_SL_SAVE_GAME), SetDataTip(STR_SAVELOAD_SAVE_BUTTON, STR_SAVELOAD_SAVE_TOOLTIP), SetFill(1, 0), SetResize(1, 0),
212  EndContainer(),
213  EndContainer(),
214 
215  /* Right side : game details */
216  NWidget(WWT_PANEL, COLOUR_GREY),
217  NWidget(WWT_EMPTY, INVALID_COLOUR, WID_SL_DETAILS), SetResize(1, 1), SetFill(1, 1),
219  NWidget(NWID_SPACER), SetResize(1, 0), SetFill(1, 1),
220  NWidget(WWT_RESIZEBOX, COLOUR_GREY),
221  EndContainer(),
222  EndContainer(),
223  EndContainer(),
224 };
225 
227 static const TextColour _fios_colours[] = {
228  TC_LIGHT_BROWN, // DFT_OLD_GAME_FILE
229  TC_ORANGE, // DFT_GAME_FILE
230  TC_YELLOW, // DFT_HEIGHTMAP_BMP
231  TC_ORANGE, // DFT_HEIGHTMAP_PNG
232  TC_LIGHT_BLUE, // DFT_FIOS_DRIVE
233  TC_DARK_GREEN, // DFT_FIOS_PARENT
234  TC_DARK_GREEN, // DFT_FIOS_DIR
235  TC_ORANGE, // DFT_FIOS_DIRECT
236 };
237 
238 
243 static void SortSaveGameList(FileList &file_list)
244 {
245  size_t sort_start = 0;
246  size_t sort_end = 0;
247 
248  /* Directories are always above the files (FIOS_TYPE_DIR)
249  * Drives (A:\ (windows only) are always under the files (FIOS_TYPE_DRIVE)
250  * Only sort savegames/scenarios, not directories
251  */
252  for (const auto &item : file_list) {
253  switch (item.type) {
254  case FIOS_TYPE_DIR: sort_start++; break;
255  case FIOS_TYPE_PARENT: sort_start++; break;
256  case FIOS_TYPE_DRIVE: sort_end++; break;
257  default: break;
258  }
259  }
260 
261  std::sort(file_list.begin() + sort_start, file_list.end() - sort_end);
262 }
263 
264 struct SaveLoadWindow : public Window {
265 private:
266  static const uint EDITBOX_MAX_SIZE = 50;
267 
269  AbstractFileType abstract_filetype;
275  Scrollbar *vscroll;
276 
279  std::vector<bool> fios_items_shown;
280 
281  static void SaveGameConfirmationCallback(Window *w, bool confirmed)
282  {
283  /* File name has already been written to _file_to_saveload */
284  if (confirmed) _switch_mode = SM_SAVE_GAME;
285  }
286 
287  static void SaveHeightmapConfirmationCallback(Window *w, bool confirmed)
288  {
289  /* File name has already been written to _file_to_saveload */
290  if (confirmed) _switch_mode = SM_SAVE_HEIGHTMAP;
291  }
292 
293 public:
294 
297  {
298  GenerateDefaultSaveName(this->filename_editbox.text.buf, &this->filename_editbox.text.buf[this->filename_editbox.text.max_bytes - 1]);
299  this->filename_editbox.text.UpdateSize();
300  }
301 
303  : Window(desc), filename_editbox(64), abstract_filetype(abstract_filetype), fop(fop), filter_editbox(EDITBOX_MAX_SIZE)
304  {
305  assert(this->fop == SLO_SAVE || this->fop == SLO_LOAD);
306 
307  /* For saving, construct an initial file name. */
308  if (this->fop == SLO_SAVE) {
309  switch (this->abstract_filetype) {
310  case FT_SAVEGAME:
311  this->GenerateFileName();
312  break;
313 
314  case FT_SCENARIO:
315  case FT_HEIGHTMAP:
316  this->filename_editbox.text.Assign("UNNAMED");
317  break;
318 
319  default:
320  NOT_REACHED();
321  }
322  }
324  this->filename_editbox.ok_button = WID_SL_SAVE_GAME;
325 
326  this->CreateNestedTree(true);
327  if (this->fop == SLO_LOAD && this->abstract_filetype == FT_SAVEGAME) {
328  this->GetWidget<NWidgetStacked>(WID_SL_CONTENT_DOWNLOAD_SEL)->SetDisplayedPlane(SZSP_HORIZONTAL);
329  }
330 
331  /* Select caption string of the window. */
332  StringID caption_string;
333  switch (this->abstract_filetype) {
334  case FT_SAVEGAME:
335  caption_string = (this->fop == SLO_SAVE) ? STR_SAVELOAD_SAVE_CAPTION : STR_SAVELOAD_LOAD_CAPTION;
336  break;
337 
338  case FT_SCENARIO:
339  caption_string = (this->fop == SLO_SAVE) ? STR_SAVELOAD_SAVE_SCENARIO : STR_SAVELOAD_LOAD_SCENARIO;
340  break;
341 
342  case FT_HEIGHTMAP:
343  caption_string = (this->fop == SLO_SAVE) ? STR_SAVELOAD_SAVE_HEIGHTMAP : STR_SAVELOAD_LOAD_HEIGHTMAP;
344  break;
345 
346  default:
347  NOT_REACHED();
348  }
349  this->GetWidget<NWidgetCore>(WID_SL_CAPTION)->widget_data = caption_string;
350 
351  this->vscroll = this->GetScrollbar(WID_SL_SCROLLBAR);
352  this->FinishInitNested(0);
353 
355  this->querystrings[WID_SL_FILTER] = &this->filter_editbox;
356  this->filter_editbox.cancel_button = QueryString::ACTION_CLEAR;
357 
358  /* pause is only used in single-player, non-editor mode, non-menu mode. It
359  * will be unpaused in the WE_DESTROY event handler. */
360  if (_game_mode != GM_MENU && !_networking && _game_mode != GM_EDITOR) {
362  }
363  SetObjectToPlace(SPR_CURSOR_ZZZ, PAL_NONE, HT_NONE, WC_MAIN_WINDOW, 0);
364 
366 
368 
369  /* Select the initial directory. */
370  o_dir.type = FIOS_TYPE_DIRECT;
371  std::string dir;
372  switch (this->abstract_filetype) {
373  case FT_SAVEGAME:
374  dir = FioFindDirectory(SAVE_DIR);
375  break;
376 
377  case FT_SCENARIO:
378  dir = FioFindDirectory(SCENARIO_DIR);
379  break;
380 
381  case FT_HEIGHTMAP:
382  dir = FioFindDirectory(HEIGHTMAP_DIR);
383  break;
384 
385  default:
386  dir = _personal_dir;
387  }
388  strecpy(o_dir.name, dir.c_str(), lastof(o_dir.name));
389 
390  switch (this->fop) {
391  case SLO_SAVE:
392  /* Focus the edit box by default in the save window */
394  break;
395 
396  default:
398  }
399  }
400 
401  void Close() override
402  {
403  /* pause is only used in single-player, non-editor mode, non menu mode */
404  if (!_networking && _game_mode != GM_EDITOR && _game_mode != GM_MENU) {
406  }
407  this->Window::Close();
408  }
409 
410  void DrawWidget(const Rect &r, int widget) const override
411  {
412  switch (widget) {
413  case WID_SL_SORT_BYNAME:
414  case WID_SL_SORT_BYDATE:
415  if (((_savegame_sort_order & SORT_BY_NAME) != 0) == (widget == WID_SL_SORT_BYNAME)) {
416  this->DrawSortButtonState(widget, _savegame_sort_order & SORT_DESCENDING ? SBS_DOWN : SBS_UP);
417  }
418  break;
419 
420  case WID_SL_BACKGROUND: {
421  static const char *path = nullptr;
422  static StringID str = STR_ERROR_UNABLE_TO_READ_DRIVE;
423  static uint64 tot = 0;
424 
425  if (_fios_path_changed) {
426  str = FiosGetDescText(&path, &tot);
427  _fios_path_changed = false;
428  }
429 
430  if (str != STR_ERROR_UNABLE_TO_READ_DRIVE) SetDParam(0, tot);
432  DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, r.top + WD_FRAMERECT_TOP, path, TC_BLACK);
433  break;
434  }
435 
437  GfxFillRect(r.left + 1, r.top + 1, r.right, r.bottom, PC_BLACK);
438 
439  uint y = r.top + WD_FRAMERECT_TOP;
440  uint scroll_pos = this->vscroll->GetPosition();
441  for (uint row = 0; row < this->fios_items.size(); row++) {
442  if (!this->fios_items_shown[row]) {
443  /* The current item is filtered out : we do not show it */
444  scroll_pos++;
445  continue;
446  }
447  if (row < scroll_pos) continue;
448  const FiosItem *item = &this->fios_items[row];
449 
450  if (item == this->selected) {
451  GfxFillRect(r.left + 1, y, r.right, y + this->resize.step_height, PC_DARK_BLUE);
452  } else if (item == this->highlighted) {
453  GfxFillRect(r.left + 1, y, r.right, y + this->resize.step_height, PC_VERY_DARK_BLUE);
454  }
455  DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, y, item->title, _fios_colours[GetDetailedFileType(item->type)]);
456  y += this->resize.step_height;
457  if (y >= this->vscroll->GetCapacity() * this->resize.step_height + r.top + WD_FRAMERECT_TOP) break;
458  }
459  break;
460  }
461 
462  case WID_SL_DETAILS: {
465  DrawString(r.left, r.right, r.top + FONT_HEIGHT_NORMAL / 2 + WD_FRAMERECT_TOP, STR_SAVELOAD_DETAIL_CAPTION, TC_FROMSTRING, SA_HOR_CENTER);
466 
467  if (this->selected == nullptr) break;
468 
470  uint y_max = r.bottom - FONT_HEIGHT_NORMAL - WD_FRAMERECT_BOTTOM;
471 
472  if (y > y_max) break;
474  /* Old savegame, no information available */
475  DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, y, STR_SAVELOAD_DETAIL_NOT_AVAILABLE);
476  y += FONT_HEIGHT_NORMAL;
477  } else if (_load_check_data.error != INVALID_STRING_ID) {
478  /* Incompatible / broken savegame */
481  y, r.bottom - WD_FRAMERECT_BOTTOM, _load_check_data.error, TC_RED);
482  } else {
483  /* Mapsize */
484  SetDParam(0, _load_check_data.map_size_x);
485  SetDParam(1, _load_check_data.map_size_y);
486  DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, y, STR_NETWORK_SERVER_LIST_MAP_SIZE);
487  y += FONT_HEIGHT_NORMAL;
488  if (y > y_max) break;
489 
490  /* Climate */
491  byte landscape = _load_check_data.settings.game_creation.landscape;
492  if (landscape < NUM_LANDSCAPE) {
493  SetDParam(0, STR_CHEAT_SWITCH_CLIMATE_TEMPERATE_LANDSCAPE + landscape);
494  DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, y, STR_NETWORK_SERVER_LIST_LANDSCAPE);
495  y += FONT_HEIGHT_NORMAL;
496  }
497 
498  y += WD_PAR_VSEP_NORMAL;
499  if (y > y_max) break;
500 
501  /* Start date (if available) */
502  if (_load_check_data.settings.game_creation.starting_year != 0) {
504  DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, y, STR_NETWORK_SERVER_LIST_START_DATE);
505  y += FONT_HEIGHT_NORMAL;
506  }
507  if (y > y_max) break;
508 
509  /* Hide current date for scenarios */
510  if (this->abstract_filetype != FT_SCENARIO) {
511  /* Current date */
512  SetDParam(0, _load_check_data.current_date);
513  DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, y, STR_NETWORK_SERVER_LIST_CURRENT_DATE);
514  y += FONT_HEIGHT_NORMAL;
515  }
516 
517  /* Hide the NewGRF stuff when saving. We also hide the button. */
518  if (this->fop == SLO_LOAD && (this->abstract_filetype == FT_SAVEGAME || this->abstract_filetype == FT_SCENARIO)) {
519  y += WD_PAR_VSEP_NORMAL;
520  if (y > y_max) break;
521 
522  /* NewGrf compatibility */
523  SetDParam(0, _load_check_data.grfconfig == nullptr ? STR_NEWGRF_LIST_NONE :
524  STR_NEWGRF_LIST_ALL_FOUND + _load_check_data.grf_compatibility);
525  DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, y, STR_SAVELOAD_DETAIL_GRFSTATUS);
526  y += FONT_HEIGHT_NORMAL;
527  }
528  if (y > y_max) break;
529 
530  /* Hide the company stuff for scenarios */
531  if (this->abstract_filetype != FT_SCENARIO) {
532  y += FONT_HEIGHT_NORMAL;
533  if (y > y_max) break;
534 
535  /* Companies / AIs */
536  for (auto &pair : _load_check_data.companies) {
537  SetDParam(0, pair.first + 1);
538  const CompanyProperties &c = *pair.second;
539  if (!c.name.empty()) {
540  SetDParam(1, STR_JUST_RAW_STRING);
541  SetDParamStr(2, c.name);
542  } else {
543  SetDParam(1, c.name_1);
544  SetDParam(2, c.name_2);
545  }
546  DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, y, STR_SAVELOAD_DETAIL_COMPANY_INDEX);
547  y += FONT_HEIGHT_NORMAL;
548  if (y > y_max) break;
549  }
550  }
551  }
552  break;
553  }
554  }
555  }
556 
557  void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
558  {
559  switch (widget) {
560  case WID_SL_BACKGROUND:
562  break;
563 
565  resize->height = FONT_HEIGHT_NORMAL;
566  size->height = resize->height * 10 + WD_FRAMERECT_TOP + WD_FRAMERECT_BOTTOM;
567  break;
568  case WID_SL_SORT_BYNAME:
569  case WID_SL_SORT_BYDATE: {
570  Dimension d = GetStringBoundingBox(this->GetWidget<NWidgetCore>(widget)->widget_data);
571  d.width += padding.width + Window::SortButtonWidth() * 2; // Doubled since the string is centred and it also looks better.
572  d.height += padding.height;
573  *size = maxdim(*size, d);
574  break;
575  }
576  }
577  }
578 
579  void OnPaint() override
580  {
581  if (_savegame_sort_dirty) {
582  _savegame_sort_dirty = false;
583  SortSaveGameList(this->fios_items);
585  }
586 
587  this->DrawWidgets();
588  }
589 
590  void OnClick(Point pt, int widget, int click_count) override
591  {
592  switch (widget) {
593  case WID_SL_SORT_BYNAME: // Sort save names by name
594  _savegame_sort_order = (_savegame_sort_order == SORT_BY_NAME) ?
595  SORT_BY_NAME | SORT_DESCENDING : SORT_BY_NAME;
596  _savegame_sort_dirty = true;
597  this->SetDirty();
598  break;
599 
600  case WID_SL_SORT_BYDATE: // Sort save names by date
601  _savegame_sort_order = (_savegame_sort_order == SORT_BY_DATE) ?
602  SORT_BY_DATE | SORT_DESCENDING : SORT_BY_DATE;
603  _savegame_sort_dirty = true;
604  this->SetDirty();
605  break;
606 
607  case WID_SL_HOME_BUTTON: // OpenTTD 'button', jumps to OpenTTD directory
608  FiosBrowseTo(&o_dir);
610  break;
611 
612  case WID_SL_LOAD_BUTTON: {
613  if (this->selected == nullptr || _load_check_data.HasErrors()) break;
614 
615  const char *name = FiosBrowseTo(this->selected);
616  _file_to_saveload.SetMode(this->selected->type);
618  _file_to_saveload.SetTitle(this->selected->title);
619 
620  if (this->abstract_filetype == FT_HEIGHTMAP) {
621  this->Close();
624  _switch_mode = (_game_mode == GM_EDITOR) ? SM_LOAD_SCENARIO : SM_LOAD_GAME;
626  this->Close();
627  }
628  break;
629  }
630 
631  case WID_SL_NEWGRF_INFO:
632  if (_load_check_data.HasNewGrfs()) {
633  ShowNewGRFSettings(false, false, false, &_load_check_data.grfconfig);
634  }
635  break;
636 
638  if (!_network_available) {
639  ShowErrorMessage(STR_NETWORK_ERROR_NOTAVAILABLE, INVALID_STRING_ID, WL_ERROR);
640  } else if (_load_check_data.HasNewGrfs()) {
642  }
643  break;
644 
645  case WID_SL_DRIVES_DIRECTORIES_LIST: { // Click the listbox
646  int y = this->vscroll->GetScrolledRowFromWidget(pt.y, this, WID_SL_DRIVES_DIRECTORIES_LIST, WD_FRAMERECT_TOP);
647  if (y == INT_MAX) return;
648 
649  /* Get the corresponding non-filtered out item from the list */
650  int i = 0;
651  while (i <= y) {
652  if (!this->fios_items_shown[i]) y++;
653  i++;
654  }
655  const FiosItem *file = &this->fios_items[y];
656 
657  const char *name = FiosBrowseTo(file);
658  if (name == nullptr) {
659  /* Changed directory, need refresh. */
661  break;
662  }
663 
664  if (click_count == 1) {
665  if (this->selected != file) {
666  this->selected = file;
668 
669  if (GetDetailedFileType(file->type) == DFT_GAME_FILE) {
670  /* Other detailed file types cannot be checked before. */
672  }
673 
675  }
676  if (this->fop == SLO_SAVE) {
677  /* Copy clicked name to editbox */
678  this->filename_editbox.text.Assign(file->title);
680  }
681  } else if (!_load_check_data.HasErrors()) {
682  this->selected = file;
683  if (this->fop == SLO_LOAD) {
684  if (this->abstract_filetype == FT_SAVEGAME || this->abstract_filetype == FT_SCENARIO) {
685  this->OnClick(pt, WID_SL_LOAD_BUTTON, 1);
686  } else {
687  assert(this->abstract_filetype == FT_HEIGHTMAP);
688  _file_to_saveload.SetMode(file->type);
690  _file_to_saveload.SetTitle(file->title);
691 
692  this->Close();
694  }
695  }
696  }
697  break;
698  }
699 
701  if (!_network_available) {
702  ShowErrorMessage(STR_NETWORK_ERROR_NOTAVAILABLE, INVALID_STRING_ID, WL_ERROR);
703  } else {
704  assert(this->fop == SLO_LOAD);
705  switch (this->abstract_filetype) {
706  default: NOT_REACHED();
709  }
710  }
711  break;
712 
713  case WID_SL_DELETE_SELECTION: // Delete
714  break;
715 
716  case WID_SL_SAVE_GAME: // Save game
717  /* Note, this is also called via the OSK; and we need to lower the button. */
719  break;
720  }
721  }
722 
723  void OnMouseLoop() override
724  {
725  const Point pt{ _cursor.pos.x - this->left, _cursor.pos.y - this->top };
726  const int widget = GetWidgetFromPos(this, pt.x, pt.y);
727 
728  if (widget == WID_SL_DRIVES_DIRECTORIES_LIST) {
729  int y = this->vscroll->GetScrolledRowFromWidget(pt.y, this, WID_SL_DRIVES_DIRECTORIES_LIST, WD_FRAMERECT_TOP);
730  if (y == INT_MAX) return;
731 
732  /* Get the corresponding non-filtered out item from the list */
733  int i = 0;
734  while (i <= y) {
735  if (!this->fios_items_shown[i]) y++;
736  i++;
737  }
738  const FiosItem *file = &this->fios_items[y];
739 
740  if (file != this->highlighted) {
741  this->highlighted = file;
743  }
744  } else if (this->highlighted != nullptr) {
745  this->highlighted = nullptr;
747  }
748  }
749 
750  EventState OnKeyPress(WChar key, uint16 keycode) override
751  {
752  if (keycode == WKC_ESC) {
753  this->Close();
754  return ES_HANDLED;
755  }
756 
757  return ES_NOT_HANDLED;
758  }
759 
760  void OnTimeout() override
761  {
762  /* Widgets WID_SL_DELETE_SELECTION and WID_SL_SAVE_GAME only exist when saving to a file. */
763  if (this->fop != SLO_SAVE) return;
764 
765  if (this->IsWidgetLowered(WID_SL_DELETE_SELECTION)) { // Delete button clicked
766  if (!FiosDelete(this->filename_editbox.text.buf)) {
767  ShowErrorMessage(STR_ERROR_UNABLE_TO_DELETE_FILE, INVALID_STRING_ID, WL_ERROR);
768  } else {
770  /* Reset file name to current date on successful delete */
771  if (this->abstract_filetype == FT_SAVEGAME) GenerateFileName();
772  }
773  } else if (this->IsWidgetLowered(WID_SL_SAVE_GAME)) { // Save button clicked
774  if (this->abstract_filetype == FT_SAVEGAME || this->abstract_filetype == FT_SCENARIO) {
775  _file_to_saveload.name = FiosMakeSavegameName(this->filename_editbox.text.buf);
777  ShowQuery(STR_SAVELOAD_OVERWRITE_TITLE, STR_SAVELOAD_OVERWRITE_WARNING, this, SaveLoadWindow::SaveGameConfirmationCallback);
778  } else {
780  }
781  } else {
782  _file_to_saveload.name = FiosMakeHeightmapName(this->filename_editbox.text.buf);
784  ShowQuery(STR_SAVELOAD_OVERWRITE_TITLE, STR_SAVELOAD_OVERWRITE_WARNING, this, SaveLoadWindow::SaveHeightmapConfirmationCallback);
785  } else {
787  }
788  }
789 
790  /* In the editor set up the vehicle engines correctly (date might have changed) */
791  if (_game_mode == GM_EDITOR) StartupEngines();
792  }
793  }
794 
795  void OnResize() override
796  {
798  }
799 
805  void OnInvalidateData(int data = 0, bool gui_scope = true) override
806  {
807  switch (data) {
808  case SLIWD_RESCAN_FILES:
809  /* Rescan files */
810  this->selected = nullptr;
812  if (!gui_scope) break;
813 
814  _fios_path_changed = true;
815  this->fios_items.BuildFileList(this->abstract_filetype, this->fop);
816  this->vscroll->SetCount((uint)this->fios_items.size());
817  this->selected = nullptr;
819 
820  /* We reset the files filtered */
822 
823  FALLTHROUGH;
824 
826  /* Selection changes */
827  if (!gui_scope) break;
828 
829  if (this->fop != SLO_LOAD) break;
830 
831  switch (this->abstract_filetype) {
832  case FT_HEIGHTMAP:
833  this->SetWidgetDisabledState(WID_SL_LOAD_BUTTON, this->selected == nullptr || _load_check_data.HasErrors());
834  break;
835 
836  case FT_SAVEGAME:
837  case FT_SCENARIO: {
838  bool disabled = this->selected == nullptr || _load_check_data.HasErrors();
841  }
843  this->SetWidgetDisabledState(WID_SL_NEWGRF_INFO, !_load_check_data.HasNewGrfs());
845  !_load_check_data.HasNewGrfs() || _load_check_data.grf_compatibility == GLC_ALL_GOOD);
846  break;
847  }
848 
849  default:
850  NOT_REACHED();
851  }
852  break;
853 
855  /* Filter changes */
856  this->fios_items_shown.resize(this->fios_items.size());
857  uint items_shown_count = 0;
858  /* We pass through every fios item */
859  for (uint i = 0; i < this->fios_items.size(); i++) {
860  if (this->string_filter.IsEmpty()) {
861  /* We don't filter anything out if the filter editbox is empty */
862  this->fios_items_shown[i] = true;
863  items_shown_count++;
864  } else {
865  this->string_filter.ResetState();
866  this->string_filter.AddLine(this->fios_items[i].title);
867  /* We set the vector to show this fios element as filtered depending on the result of the filter */
868  this->fios_items_shown[i] = this->string_filter.GetState();
869  if (this->fios_items_shown[i]) items_shown_count++;
870 
871  if (&(this->fios_items[i]) == this->selected && !this->fios_items_shown[i]) {
872  /* The selected element has been filtered out */
873  this->selected = nullptr;
875  }
876  }
877  }
878  this->vscroll->SetCount(items_shown_count);
879  break;
880  }
881  }
882 
883  void OnEditboxChanged(int wid) override
884  {
885  if (wid == WID_SL_FILTER) {
886  this->string_filter.SetFilterTerm(this->filter_editbox.text.buf);
888  }
889  }
890 };
891 
894  WDP_CENTER, "load_game", 500, 294,
896  0,
898 );
899 
902  WDP_CENTER, "load_heightmap", 257, 320,
904  0,
906 );
907 
910  WDP_CENTER, "save_game", 500, 294,
912  0,
914 );
915 
922 {
924 
925  WindowDesc *sld;
926  if (fop == SLO_SAVE) {
927  sld = &_save_dialog_desc;
928  } else {
929  /* Dialogue for loading a file. */
930  sld = (abstract_filetype == FT_HEIGHTMAP) ? &_load_heightmap_dialog_desc : &_load_dialog_desc;
931  }
932 
933  new SaveLoadWindow(sld, abstract_filetype, fop);
934 }
ShowNewGRFSettings
void ShowNewGRFSettings(bool editable, bool show_params, bool exec_changes, GRFConfig **config)
Setup the NewGRF gui.
Definition: newgrf_gui.cpp:1995
ES_HANDLED
@ ES_HANDLED
The passed event is handled.
Definition: window_type.h:718
network_content.h
WC_SAVELOAD
@ WC_SAVELOAD
Saveload window; Window numbers:
Definition: window_type.h:136
ShowSaveLoadDialog
void ShowSaveLoadDialog(AbstractFileType abstract_filetype, SaveLoadOperation fop)
Launch save/load dialog in the given mode.
Definition: fios_gui.cpp:921
WD_FRAMERECT_TOP
@ WD_FRAMERECT_TOP
Offset at top to draw the frame rectangular area.
Definition: window_gui.h:64
SaveLoadWindow::UpdateWidgetSize
void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
Update size and resize step of a widget in the window.
Definition: fios_gui.cpp:557
_save_dialog_desc
static WindowDesc _save_dialog_desc(WDP_CENTER, "save_game", 500, 294, WC_SAVELOAD, WC_NONE, 0, _nested_save_dialog_widgets, lengthof(_nested_save_dialog_widgets))
Save game/scenario.
LoadCheckData::checkable
bool checkable
True if the savegame could be checked by SL_LOAD_CHECK. (Old savegames are not checkable....
Definition: fios.h:32
FT_SCENARIO
@ FT_SCENARIO
old or new scenario
Definition: fileio_type.h:19
WID_SL_DELETE_SELECTION
@ WID_SL_DELETE_SELECTION
Delete button, only available for save operations.
Definition: fios_widget.h:26
FiosGetDescText
StringID FiosGetDescText(const char **path, uint64 *total_free)
Get descriptive texts.
Definition: fios.cpp:139
SAVE_DIR
@ SAVE_DIR
Base directory for all savegames.
Definition: fileio_type.h:110
QueryString::ok_button
int ok_button
Widget button of parent window to simulate when pressing OK in OSK.
Definition: querystring_gui.h:27
SaveLoadWindow::filename_editbox
QueryString filename_editbox
Filename editbox.
Definition: fios_gui.cpp:268
SLIWD_RESCAN_FILES
@ SLIWD_RESCAN_FILES
Rescan all files (when changed directory, ...)
Definition: fios.h:21
_nested_load_dialog_widgets
static const NWidgetPart _nested_load_dialog_widgets[]
Load game/scenario with optional content download.
Definition: fios_gui.cpp:71
WChar
char32_t WChar
Type for wide characters, i.e.
Definition: string_type.h:35
querystring_gui.h
SetScrollbar
static NWidgetPart SetScrollbar(int index)
Attach a scrollbar to a widget.
Definition: widget_type.h:1188
landscape_type.h
SM_LOAD_GAME
@ SM_LOAD_GAME
Load game, Play Scenario.
Definition: openttd.h:31
SaveLoadWindow::OnClick
void OnClick(Point pt, int widget, int click_count) override
A click with the left mouse button has been made on the window.
Definition: fios_gui.cpp:590
Dimension
Dimensions (a width and height) of a rectangle in 2D.
Definition: geometry_type.hpp:27
Scrollbar::GetCapacity
uint16 GetCapacity() const
Gets the number of visible elements of the scrollbar.
Definition: widget_type.h:662
command_func.h
Window::DrawSortButtonState
void DrawSortButtonState(int widget, SortButtonState state) const
Draw a sort button's up or down arrow symbol.
Definition: widget.cpp:670
_personal_dir
std::string _personal_dir
custom directory for personal settings, saves, newgrf, etc.
Definition: fileio.cpp:957
SetPadding
static NWidgetPart SetPadding(uint8 top, uint8 right, uint8 bottom, uint8 left)
Widget part function for setting additional space around a widget.
Definition: widget_type.h:1139
SaveLoadWindow::OnTimeout
void OnTimeout() override
Called when this window's timeout has been reached.
Definition: fios_gui.cpp:760
Window::GetScrollbar
const Scrollbar * GetScrollbar(uint widnum) const
Return the Scrollbar to a widget index.
Definition: window.cpp:320
SaveLoadWindow::filter_editbox
QueryString filter_editbox
Filter editbox;.
Definition: fios_gui.cpp:278
ClearGRFConfigList
void ClearGRFConfigList(GRFConfig **config)
Clear a GRF Config list, freeing all nodes.
Definition: newgrf_config.cpp:400
StringFilter::IsEmpty
bool IsEmpty() const
Check whether any filter words were entered.
Definition: stringfilter_type.h:59
LoadCheckData::gamelog_action
struct LoggedAction * gamelog_action
Gamelog actions.
Definition: fios.h:46
GameCreationSettings::landscape
byte landscape
the landscape we're currently in
Definition: settings_type.h:320
FileToSaveLoad::SetTitle
void SetTitle(const char *title)
Set the title of the file.
Definition: saveload.cpp:3431
StringFilter::SetFilterTerm
void SetFilterTerm(const char *str)
Set the term to filter on.
Definition: stringfilter.cpp:27
WWT_CAPTION
@ WWT_CAPTION
Window caption (window title between closebox and stickybox)
Definition: widget_type.h:59
WID_SL_SAVE_OSK_TITLE
@ WID_SL_SAVE_OSK_TITLE
Title textbox, only available for save operations.
Definition: fios_widget.h:25
SaveOrLoad
SaveOrLoadResult SaveOrLoad(const std::string &filename, SaveLoadOperation fop, DetailedFileType dft, Subdirectory sb, bool threaded)
Main Save or Load function where the high-level saveload functions are handled.
Definition: saveload.cpp:3240
WID_SL_SORT_BYDATE
@ WID_SL_SORT_BYDATE
Sort by date button.
Definition: fios_widget.h:17
Textbuf::Assign
void Assign(StringID string)
Render a string into the textbuffer.
Definition: textbuf.cpp:396
SaveLoadOperation
SaveLoadOperation
Operation performed on the file.
Definition: fileio_type.h:47
SaveLoadWindow::OnResize
void OnResize() override
Called after the window got resized.
Definition: fios_gui.cpp:795
FileToSaveLoad::name
std::string name
Name of the file.
Definition: saveload.h:357
WWT_DEFSIZEBOX
@ WWT_DEFSIZEBOX
Default window size box (at top-right of a window, between WWT_SHADEBOX and WWT_STICKYBOX)
Definition: widget_type.h:63
Window::CreateNestedTree
void CreateNestedTree(bool fill_nested=true)
Perform the first part of the initialization of a nested widget tree.
Definition: window.cpp:1760
SaveLoadWindow::DrawWidget
void DrawWidget(const Rect &r, int widget) const override
Draw the contents of a nested widget.
Definition: fios_gui.cpp:410
GamelogFree
void GamelogFree(LoggedAction *gamelog_action, uint gamelog_actions)
Frees the memory allocated by a gamelog.
Definition: gamelog.cpp:98
NWID_HORIZONTAL
@ NWID_HORIZONTAL
Horizontal container.
Definition: widget_type.h:73
ShowNetworkContentListWindow
void ShowNetworkContentListWindow(ContentVector *cv=nullptr, ContentType type1=CONTENT_TYPE_END, ContentType type2=CONTENT_TYPE_END)
Show the content list window with a given set of content.
Definition: network_content_gui.cpp:1113
maxdim
Dimension maxdim(const Dimension &d1, const Dimension &d2)
Compute bounding box of both dimensions.
Definition: geometry_func.cpp:22
WID_SL_CONTENT_DOWNLOAD_SEL
@ WID_SL_CONTENT_DOWNLOAD_SEL
Selection 'stack' to 'hide' the content download.
Definition: fios_widget.h:28
SLO_CHECK
@ SLO_CHECK
Load file for checking and/or preview.
Definition: fileio_type.h:48
ShowMissingContentWindow
void ShowMissingContentWindow(const GRFConfig *list)
Show the content list window with all missing grfs from the given list.
Definition: newgrf_gui.cpp:1543
Scrollbar::SetCount
void SetCount(int num)
Sets the number of elements in the list.
Definition: widget_type.h:710
DFT_GAME_FILE
@ DFT_GAME_FILE
Save game or scenario file.
Definition: fileio_type.h:31
HEIGHTMAP_DIR
@ HEIGHTMAP_DIR
Subdirectory of scenario for heightmaps.
Definition: fileio_type.h:113
LoadCheckData::grfconfig
GRFConfig * grfconfig
NewGrf configuration from save.
Definition: fios.h:43
FileToSaveLoad::SetName
void SetName(const char *name)
Set the name of the file.
Definition: saveload.cpp:3422
TextColour
TextColour
Colour of the strings, see _string_colourmap in table/string_colours.h or docs/ottd-colourtext-palett...
Definition: gfx_type.h:250
SetResize
static NWidgetPart SetResize(int16 dx, int16 dy)
Widget part function for setting the resize step.
Definition: widget_type.h:993
saveload.h
CompanyProperties::name
std::string name
Name of the company if the user changed it.
Definition: company_base.h:58
fileio_func.h
_settings_client
ClientSettings _settings_client
The current settings for this game.
Definition: settings.cpp:52
GetDetailedFileType
DetailedFileType GetDetailedFileType(FiosType fios_type)
Extract the detailed file type from a FiosType.
Definition: fileio_type.h:100
DrawString
int DrawString(int left, int right, int top, const char *str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
Draw string, possibly truncated to make it fit in its allocated space.
Definition: gfx.cpp:642
_nested_load_heightmap_dialog_widgets
static const NWidgetPart _nested_load_heightmap_dialog_widgets[]
Load heightmap with content download.
Definition: fios_gui.cpp:128
SZSP_HORIZONTAL
@ SZSP_HORIZONTAL
Display plane with zero size vertically, and filling and resizing horizontally.
Definition: widget_type.h:422
WWT_EMPTY
@ WWT_EMPTY
Empty widget, place holder to reserve space in widget array.
Definition: widget_type.h:46
StringFilter::AddLine
void AddLine(const char *str)
Pass another text line from the current item to the filter.
Definition: stringfilter.cpp:104
LoadCheckData::HasErrors
bool HasErrors()
Check whether loading the game resulted in errors.
Definition: fios.h:67
WID_SL_CONTENT_DOWNLOAD
@ WID_SL_CONTENT_DOWNLOAD
Content download button, only available for play scenario/heightmap.
Definition: fios_widget.h:24
SM_LOAD_SCENARIO
@ SM_LOAD_SCENARIO
Load scenario from scenario editor.
Definition: openttd.h:36
Scrollbar::GetScrolledRowFromWidget
int GetScrolledRowFromWidget(int clickpos, const Window *const w, int widget, int padding=0) const
Compute the row of a scrolled widget that a user clicked in.
Definition: widget.cpp:2098
Window::HandleButtonClick
void HandleButtonClick(byte widget)
Do all things to make a button look clicked and mark it to be unclicked in a few ticks.
Definition: window.cpp:646
gamelog.h
fios.h
StartupEngines
void StartupEngines()
Start/initialise all our engines.
Definition: engine.cpp:682
Scrollbar
Scrollbar data structure.
Definition: widget_type.h:629
WD_FRAMETEXT_LEFT
@ WD_FRAMETEXT_LEFT
Left offset of the text of the frame.
Definition: window_gui.h:72
FileList
List of file information.
Definition: fios.h:96
SetDParam
static void SetDParam(uint n, uint64 v)
Set a string parameter v at index n in the global string parameter array.
Definition: strings_func.h:196
SaveLoadWindow::selected
const FiosItem * selected
Selected game in fios_items, or nullptr.
Definition: fios_gui.cpp:273
NWidgetPart
Partial widget specification to allow NWidgets to be written nested.
Definition: widget_type.h:971
SetDataTip
static NWidgetPart SetDataTip(uint32 data, StringID tip)
Widget part function for setting the data and tooltip.
Definition: widget_type.h:1107
QueryString
Data stored about a string that can be modified in the GUI.
Definition: querystring_gui.h:20
WID_SL_NEWGRF_INFO
@ WID_SL_NEWGRF_INFO
Button to open NewGgrf configuration.
Definition: fios_widget.h:30
SaveLoadWindow::fios_items_shown
std::vector< bool > fios_items_shown
Map of the filtered out fios items.
Definition: fios_gui.cpp:279
WID_SL_LOAD_BUTTON
@ WID_SL_LOAD_BUTTON
Button to load game/scenario.
Definition: fios_widget.h:31
GetStringBoundingBox
Dimension GetStringBoundingBox(const char *str, FontSize start_fontsize)
Return the string dimension in pixels.
Definition: gfx.cpp:888
CompanyProperties::name_2
uint32 name_2
Parameter of name_1.
Definition: company_base.h:56
Textbuf::buf
char *const buf
buffer in which text is saved
Definition: textbuf_type.h:32
Window::querystrings
SmallMap< int, QueryString * > querystrings
QueryString associated to WWT_EDITBOX widgets.
Definition: window_gui.h:323
ShowErrorMessage
void ShowErrorMessage(StringID summary_msg, StringID detailed_msg, WarningLevel wl, int x=0, int y=0, const GRFFile *textref_stack_grffile=nullptr, uint textref_stack_size=0, const uint32 *textref_stack=nullptr)
Display an error message in a window.
Definition: error_gui.cpp:383
DrawStringMultiLine
int DrawStringMultiLine(int left, int right, int top, int bottom, const char *str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
Draw string, possibly over multiple lines.
Definition: gfx.cpp:787
GameSettings::game_creation
GameCreationSettings game_creation
settings used during the creation of a game (map)
Definition: settings_type.h:576
WID_SL_DETAILS
@ WID_SL_DETAILS
Panel with game details.
Definition: fios_widget.h:29
gfx_func.h
WindowDesc
High level window description.
Definition: window_gui.h:168
AbstractFileType
AbstractFileType
The different abstract types of files that the system knows about.
Definition: fileio_type.h:16
NC_EQUALSIZE
@ NC_EQUALSIZE
Value of the NCB_EQUALSIZE flag.
Definition: widget_type.h:463
_load_dialog_desc
static WindowDesc _load_dialog_desc(WDP_CENTER, "load_game", 500, 294, WC_SAVELOAD, WC_NONE, 0, _nested_load_dialog_widgets, lengthof(_nested_load_dialog_widgets))
Load game/scenario.
ClearErrorMessages
void ClearErrorMessages()
Clear all errors from the queue.
Definition: error_gui.cpp:341
SLO_LOAD
@ SLO_LOAD
File is being loaded.
Definition: fileio_type.h:49
Window::resize
ResizeInfo resize
Resize information.
Definition: window_gui.h:317
SLO_SAVE
@ SLO_SAVE
File is being saved.
Definition: fileio_type.h:50
FiosMakeHeightmapName
std::string FiosMakeHeightmapName(const char *name)
Construct a filename for a height map.
Definition: fios.cpp:243
tilehighlight_func.h
PM_PAUSED_SAVELOAD
@ PM_PAUSED_SAVELOAD
A game paused for saving/loading.
Definition: openttd.h:63
DoCommandP
bool DoCommandP(const CommandContainer *container, bool my_cmd)
Shortcut for the long DoCommandP when having a container with the data.
Definition: command.cpp:541
FiosDelete
bool FiosDelete(const char *name)
Delete a file.
Definition: fios.cpp:256
CMD_PAUSE
@ CMD_PAUSE
pause the game
Definition: command_type.h:256
WWT_EDITBOX
@ WWT_EDITBOX
a textbox for typing
Definition: widget_type.h:69
SM_SAVE_HEIGHTMAP
@ SM_SAVE_HEIGHTMAP
Save heightmap.
Definition: openttd.h:34
SLIWD_FILTER_CHANGES
@ SLIWD_FILTER_CHANGES
The filename filter has changed (via the editbox)
Definition: fios.h:23
LoadCheckData::error_data
char * error_data
Data to pass to SetDParamStr when displaying error.
Definition: fios.h:34
Window::SetDirty
void SetDirty() const
Mark entire window as dirty (in need of re-paint)
Definition: window.cpp:993
LoadCheckData::gamelog_actions
uint gamelog_actions
Number of gamelog actions.
Definition: fios.h:47
WD_FRAMERECT_LEFT
@ WD_FRAMERECT_LEFT
Offset at left to draw the frame rectangular area.
Definition: window_gui.h:62
SaveLoadWindow::fop
SaveLoadOperation fop
Type of file to select.
Definition: fios_gui.cpp:270
FileList::BuildFileList
void BuildFileList(AbstractFileType abstract_filetype, SaveLoadOperation fop)
Construct a file list with the given kind of files, for the stated purpose.
Definition: fios.cpp:72
ConvertYMDToDate
Date ConvertYMDToDate(Year year, Month month, Day day)
Converts a tuple of Year, Month and Day to a Date.
Definition: date.cpp:149
WID_SL_SAVE_GAME
@ WID_SL_SAVE_GAME
Save button, only available for save operations.
Definition: fios_widget.h:27
WD_PAR_VSEP_NORMAL
@ WD_PAR_VSEP_NORMAL
Normal amount of vertical space between two paragraphs of text.
Definition: window_gui.h:139
WD_FRAMERECT_RIGHT
@ WD_FRAMERECT_RIGHT
Offset at right to draw the frame rectangular area.
Definition: window_gui.h:63
ES_NOT_HANDLED
@ ES_NOT_HANDLED
The passed event is not handled.
Definition: window_type.h:719
WD_FRAMERECT_BOTTOM
@ WD_FRAMERECT_BOTTOM
Offset at bottom to draw the frame rectangular area.
Definition: window_gui.h:65
WWT_PUSHTXTBTN
@ WWT_PUSHTXTBTN
Normal push-button (no toggle button) with text caption.
Definition: widget_type.h:104
FiosItem
Deals with finding savegames.
Definition: fios.h:87
GetWidgetFromPos
int GetWidgetFromPos(const Window *w, int x, int y)
Returns the index for the widget located at the given position relative to the window.
Definition: widget.cpp:194
Window::SetWidgetDisabledState
void SetWidgetDisabledState(byte widget_index, bool disab_stat)
Sets the enabled/disabled status of a widget.
Definition: window_gui.h:386
FiosBrowseTo
const char * FiosBrowseTo(const FiosItem *item)
Browse to a new path based on the passed item, starting at #_fios_path.
Definition: fios.cpp:150
safeguards.h
Window::left
int left
x position of left edge of the window
Definition: window_gui.h:312
SCENARIO_DIR
@ SCENARIO_DIR
Base directory for all scenarios.
Definition: fileio_type.h:112
WID_SL_FILTER
@ WID_SL_FILTER
Filter list of files.
Definition: fios_widget.h:18
SLIWD_SELECTION_CHANGES
@ SLIWD_SELECTION_CHANGES
File selection has changed (user click, ...)
Definition: fios.h:22
_networking
bool _networking
are we in networking mode?
Definition: network.cpp:56
HT_NONE
@ HT_NONE
default
Definition: tilehighlight_type.h:20
SaveLoadWindow::highlighted
const FiosItem * highlighted
Item in fios_items highlighted by mouse pointer, or nullptr.
Definition: fios_gui.cpp:274
SaveLoadWindow::string_filter
StringFilter string_filter
Filter for available games.
Definition: fios_gui.cpp:277
SaveLoadWindow::GenerateFileName
void GenerateFileName()
Generate a default save filename.
Definition: fios_gui.cpp:296
WID_SL_FILE_BACKGROUND
@ WID_SL_FILE_BACKGROUND
Background of file selection.
Definition: fios_widget.h:20
sprites.h
Point
Coordinates of a point in 2D.
Definition: geometry_type.hpp:21
error.h
SaveLoadWindow::fios_items
FileList fios_items
Save game list.
Definition: fios_gui.cpp:271
_load_check_data
LoadCheckData _load_check_data
Data loaded from save during SL_LOAD_CHECK.
Definition: fios_gui.cpp:38
date_func.h
WD_FRAMETEXT_RIGHT
@ WD_FRAMETEXT_RIGHT
Right offset of the text of the frame.
Definition: window_gui.h:73
Window::SetFocusedWidget
bool SetFocusedWidget(int widget_index)
Set focus within this window to the given widget.
Definition: window.cpp:506
stdafx.h
FT_SAVEGAME
@ FT_SAVEGAME
old or new savegame
Definition: fileio_type.h:18
PC_BLACK
static const uint8 PC_BLACK
Black palette colour.
Definition: gfx_func.h:190
SM_SAVE_GAME
@ SM_SAVE_GAME
Save game.
Definition: openttd.h:33
GfxFillRect
void GfxFillRect(int left, int top, int right, int bottom, int colour, FillRectMode mode)
Applies a certain FillRectMode-operation to a rectangle [left, right] x [top, bottom] on the screen.
Definition: gfx.cpp:116
ResizeInfo::step_height
uint step_height
Step-size of height resize changes.
Definition: window_gui.h:220
Window::InvalidateData
void InvalidateData(int data=0, bool gui_scope=true)
Mark this window's data as invalid (in need of re-computing)
Definition: window.cpp:3158
_fios_colours
static const TextColour _fios_colours[]
Text colours of DetailedFileType fios entries in the window.
Definition: fios_gui.cpp:227
WC_NONE
@ WC_NONE
No window, redirects to WC_MAIN_WINDOW.
Definition: window_type.h:37
SA_HOR_CENTER
@ SA_HOR_CENTER
Horizontally center the text.
Definition: gfx_type.h:329
LoadCheckData::error
StringID error
Error message from loading. INVALID_STRING_ID if no error.
Definition: fios.h:33
PC_GREY
static const uint8 PC_GREY
Grey palette colour.
Definition: gfx_func.h:192
ShowHeightmapLoad
void ShowHeightmapLoad()
Start with loading a heightmap.
Definition: genworld_gui.cpp:1006
GenerateDefaultSaveName
void GenerateDefaultSaveName(char *buf, const char *last)
Fill the buffer with the default name for a savegame or screenshot.
Definition: saveload.cpp:3360
SaveLoadWindow::OnPaint
void OnPaint() override
The window must be repainted.
Definition: fios_gui.cpp:579
WWT_CLOSEBOX
@ WWT_CLOSEBOX
Close box (at top-left of a window)
Definition: widget_type.h:67
WWT_RESIZEBOX
@ WWT_RESIZEBOX
Resize box (normally at bottom-right of a window)
Definition: widget_type.h:66
SaveLoadWindow
Definition: fios_gui.cpp:264
SaveLoadWindow::OnMouseLoop
void OnMouseLoop() override
Called for every mouse loop run, which is at least once per (game) tick.
Definition: fios_gui.cpp:723
LoadCheckData
Container for loading in mode SL_LOAD_CHECK.
Definition: fios.h:31
LoadCheckData::companies
CompanyPropertiesMap companies
Company information.
Definition: fios.h:41
_switch_mode
SwitchMode _switch_mode
The next mainloop command.
Definition: gfx.cpp:46
StringID
uint32 StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:16
SaveLoadWindow::OnEditboxChanged
void OnEditboxChanged(int wid) override
The text in an editbox has been edited.
Definition: fios_gui.cpp:883
WWT_PUSHIMGBTN
@ WWT_PUSHIMGBTN
Normal push-button (no toggle button) with image caption.
Definition: widget_type.h:105
ShowQuery
void ShowQuery(StringID caption, StringID message, Window *parent, QueryCallbackProc *callback)
Show a modal confirmation window with standard 'yes' and 'no' buttons The window is aligned to the ce...
Definition: misc_gui.cpp:1267
SBS_DOWN
@ SBS_DOWN
Sort ascending.
Definition: window_gui.h:226
QueryString::cancel_button
int cancel_button
Widget button of parent window to simulate when pressing CANCEL in OSK.
Definition: querystring_gui.h:28
_load_heightmap_dialog_desc
static WindowDesc _load_heightmap_dialog_desc(WDP_CENTER, "load_heightmap", 257, 320, WC_SAVELOAD, WC_NONE, 0, _nested_load_heightmap_dialog_widgets, lengthof(_nested_load_heightmap_dialog_widgets))
Load heightmap.
EndContainer
static NWidgetPart EndContainer()
Widget part function for denoting the end of a container (horizontal, vertical, WWT_FRAME,...
Definition: widget_type.h:1092
strings_func.h
NWID_VSCROLLBAR
@ NWID_VSCROLLBAR
Vertical scrollbar.
Definition: widget_type.h:82
FioCheckFileExists
bool FioCheckFileExists(const std::string &filename, Subdirectory subdir)
Check whether the given file exists.
Definition: fileio.cpp:108
LoadCheckData::Clear
void Clear()
Reset read data.
Definition: fios_gui.cpp:47
WWT_TEXT
@ WWT_TEXT
Pure simple text.
Definition: widget_type.h:56
FONT_HEIGHT_NORMAL
#define FONT_HEIGHT_NORMAL
Height of characters in the normal (FS_NORMAL) font.
Definition: gfx_func.h:165
NO_DIRECTORY
@ NO_DIRECTORY
A path without any base directory.
Definition: fileio_type.h:125
NWidget
static NWidgetPart NWidget(WidgetType tp, Colours col, int16 idx=-1)
Widget part function for starting a new 'real' widget.
Definition: widget_type.h:1207
PC_DARK_BLUE
static const uint8 PC_DARK_BLUE
Dark blue palette colour.
Definition: gfx_func.h:210
geometry_func.hpp
SetMinimalSize
static NWidgetPart SetMinimalSize(int16 x, int16 y)
Widget part function for setting the minimal size.
Definition: widget_type.h:1010
_file_to_saveload
FileToSaveLoad _file_to_saveload
File to save or load in the openttd loop.
Definition: saveload.cpp:63
StringFilter::ResetState
void ResetState()
Reset the matching state to process a new item.
Definition: stringfilter.cpp:88
Textbuf::UpdateSize
void UpdateSize()
Update Textbuf type with its actual physical character and screenlength Get the count of characters i...
Definition: textbuf.cpp:430
WWT_PANEL
@ WWT_PANEL
Simple depressed panel.
Definition: widget_type.h:48
Window::IsWidgetLowered
bool IsWidgetLowered(byte widget_index) const
Gets the lowered state of a widget.
Definition: window_gui.h:487
SaveLoadWindow::Close
void Close() override
Hide the window and all its child windows, and mark them for a later deletion.
Definition: fios_gui.cpp:401
WID_SL_CAPTION
@ WID_SL_CAPTION
Caption of the window.
Definition: fios_widget.h:15
EventState
EventState
State of handling an event.
Definition: window_type.h:717
Scrollbar::GetPosition
uint16 GetPosition() const
Gets the position of the first visible element in the list.
Definition: widget_type.h:671
StringFilter::GetState
bool GetState() const
Get the matching state of the current item.
Definition: stringfilter_type.h:69
WID_SL_HOME_BUTTON
@ WID_SL_HOME_BUTTON
Home button.
Definition: fios_widget.h:21
FT_HEIGHTMAP
@ FT_HEIGHTMAP
heightmap file
Definition: fileio_type.h:20
PC_VERY_DARK_BLUE
static const uint8 PC_VERY_DARK_BLUE
Almost-black blue palette colour.
Definition: gfx_func.h:209
WC_MAIN_WINDOW
@ WC_MAIN_WINDOW
Main window; Window numbers:
Definition: window_type.h:43
Window::FinishInitNested
void FinishInitNested(WindowNumber window_number=0)
Perform the second part of the initialization of a nested widget tree.
Definition: window.cpp:1776
GameCreationSettings::starting_year
Year starting_year
starting date
Definition: settings_type.h:305
LoadCheckData::grf_compatibility
GRFListCompatibility grf_compatibility
Summary state of NewGrfs, whether missing files or only compatible found.
Definition: fios.h:44
NWID_SPACER
@ NWID_SPACER
Invisible widget that takes some space.
Definition: widget_type.h:77
WWT_INSET
@ WWT_INSET
Pressed (inset) panel, most commonly used as combo box text area.
Definition: widget_type.h:49
WL_ERROR
@ WL_ERROR
Errors (eg. saving/loading failed)
Definition: error.h:24
QueryString::ACTION_CLEAR
static const int ACTION_CLEAR
Clear editbox.
Definition: querystring_gui.h:24
fios_widget.h
Window::top
int top
y position of top edge of the window
Definition: window_gui.h:313
network.h
SaveLoadWindow::o_dir
FiosItem o_dir
Original dir (home dir for this browser)
Definition: fios_gui.cpp:272
window_func.h
lengthof
#define lengthof(x)
Return the length of an fixed size array.
Definition: stdafx.h:378
stringfilter_type.h
Scrollbar::SetCapacityFromWidget
void SetCapacityFromWidget(Window *w, int widget, int padding=0)
Set capacity of visible elements from the size and resize properties of a widget.
Definition: widget.cpp:2172
Window::SortButtonWidth
static int SortButtonWidth()
Get width of up/down arrow of sort button state.
Definition: widget.cpp:690
SetPIP
static NWidgetPart SetPIP(uint8 pre, uint8 inter, uint8 post)
Widget part function for setting a pre/inter/post spaces.
Definition: widget_type.h:1169
CloseWindowById
void CloseWindowById(WindowClass cls, WindowNumber number, bool force)
Close a window by its class and window number (if it is open).
Definition: window.cpp:1176
WID_SL_SORT_BYNAME
@ WID_SL_SORT_BYNAME
Sort by name button.
Definition: fios_widget.h:16
SetFill
static NWidgetPart SetFill(uint fill_x, uint fill_y)
Widget part function for setting filling.
Definition: widget_type.h:1076
gui.h
SaveLoadWindow::OnInvalidateData
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
Definition: fios_gui.cpp:805
CONTENT_TYPE_SCENARIO
@ CONTENT_TYPE_SCENARIO
The content consists of a scenario.
Definition: tcp_content_type.h:22
LoadCheckData::HasNewGrfs
bool HasNewGrfs()
Check whether the game uses any NewGrfs.
Definition: fios.h:76
Window
Data structure for an opened window.
Definition: window_gui.h:279
SetObjectToPlace
void SetObjectToPlace(CursorID icon, PaletteID pal, HighLightStyle mode, WindowClass window_class, WindowNumber window_num)
Change the cursor and mouse click/drag handling to a mode for performing special operations like tile...
Definition: viewport.cpp:3375
Window::DrawWidgets
void DrawWidgets() const
Paint all widgets of a window.
Definition: widget.cpp:636
FiosMakeSavegameName
std::string FiosMakeSavegameName(const char *name)
Make a save game or scenario filename from a name.
Definition: fios.cpp:231
GLC_ALL_GOOD
@ GLC_ALL_GOOD
All GRF needed by game are present.
Definition: newgrf_config.h:53
_nested_save_dialog_widgets
static const NWidgetPart _nested_save_dialog_widgets[]
Save game/scenario.
Definition: fios_gui.cpp:172
SaveLoadWindow::OnKeyPress
EventState OnKeyPress(WChar key, uint16 keycode) override
A key has been pressed.
Definition: fios_gui.cpp:750
SBS_UP
@ SBS_UP
Sort descending.
Definition: window_gui.h:227
_network_available
bool _network_available
is network mode available?
Definition: network.cpp:58
strecpy
char * strecpy(char *dst, const char *src, const char *last)
Copies characters from one buffer to another.
Definition: string.cpp:112
NWID_SELECTION
@ NWID_SELECTION
Stacked widgets, only one visible at a time (eg in a panel with tabs).
Definition: widget_type.h:78
free
static void free(const void *ptr)
Version of the standard free that accepts const pointers.
Definition: stdafx.h:460
FileToSaveLoad::SetMode
void SetMode(FiosType ft)
Set the mode and file type of the file to save or load based on the type of file entry at the file sy...
Definition: saveload.cpp:3393
Window::SetWidgetDirty
void SetWidgetDirty(byte widget_index) const
Invalidate a widget, i.e.
Definition: window.cpp:608
GUISettings::UserIsAllowedToChangeNewGRFs
bool UserIsAllowedToChangeNewGRFs() const
Returns true when the user has sufficient privileges to edit newgrfs on a running game.
Definition: settings_type.h:197
Rect
Specification of a rectangle with absolute coordinates of all edges.
Definition: geometry_type.hpp:47
CursorVars::pos
Point pos
logical mouse position
Definition: gfx_type.h:117
Window::LowerWidget
void LowerWidget(byte widget_index)
Marks a widget as lowered.
Definition: window_gui.h:468
SortSaveGameList
static void SortSaveGameList(FileList &file_list)
Sort the collected list save games prior to displaying it in the save/load gui.
Definition: fios_gui.cpp:243
CONTENT_TYPE_HEIGHTMAP
@ CONTENT_TYPE_HEIGHTMAP
The content consists of a heightmap.
Definition: tcp_content_type.h:23
lastof
#define lastof(x)
Get the last element of an fixed size array.
Definition: stdafx.h:394
GLC_NOT_FOUND
@ GLC_NOT_FOUND
At least one GRF couldn't be found (higher priority than GLC_COMPATIBLE)
Definition: newgrf_config.h:55
WID_SL_BACKGROUND
@ WID_SL_BACKGROUND
Background of window.
Definition: fios_widget.h:19
ResetObjectToPlace
void ResetObjectToPlace()
Reset the cursor and mouse mode handling back to default (normal cursor, only clicking in windows).
Definition: viewport.cpp:3423
WDP_CENTER
@ WDP_CENTER
Center the window.
Definition: window_gui.h:157
CompanyProperties
Statically loadable part of Company pool item.
Definition: company_base.h:55
WID_SL_DRIVES_DIRECTORIES_LIST
@ WID_SL_DRIVES_DIRECTORIES_LIST
Drives list.
Definition: fios_widget.h:22
StringFilter
String filter and state.
Definition: stringfilter_type.h:31
SetDParamStr
void SetDParamStr(uint n, const char *str)
This function is used to "bind" a C string to a OpenTTD dparam slot.
Definition: strings.cpp:296
INVALID_STRING_ID
static const StringID INVALID_STRING_ID
Constant representing an invalid string (16bit in case it is used in savegames)
Definition: strings_type.h:17
ClientSettings::gui
GUISettings gui
settings related to the GUI
Definition: settings_type.h:593
WID_SL_SCROLLBAR
@ WID_SL_SCROLLBAR
Scrollbar of the file list.
Definition: fios_widget.h:23
CompanyProperties::name_1
StringID name_1
Name of the company if the user did not change it.
Definition: company_base.h:57
engine_func.h
Window::Close
virtual void Close()
Hide the window and all its child windows, and mark them for a later deletion.
Definition: window.cpp:1092
WID_SL_MISSING_NEWGRFS
@ WID_SL_MISSING_NEWGRFS
Button to find missing NewGRFs online.
Definition: fios_widget.h:32