src/main_gui.cpp

   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 main_gui.cpp Handling of the main viewport. */
   9
  10 #include "stdafx.h"
  11 #include "currency.h"
  12 #include "spritecache.h"
  13 #include "window_gui.h"
  14 #include "window_func.h"
  15 #include "textbuf_gui.h"
  16 #include "viewport_func.h"
  17 #include "command_func.h"
  18 #include "console_gui.h"
  19 #include "progress.h"
  20 #include "transparency_gui.h"
  21 #include "map_func.h"
  22 #include "sound_func.h"
  23 #include "transparency.h"
  24 #include "strings_func.h"
  25 #include "zoom_func.h"
  26 #include "company_base.h"
  27 #include "company_func.h"
  28 #include "toolbar_gui.h"
  29 #include "statusbar_gui.h"
  30 #include "linkgraph/linkgraph_gui.h"
  31 #include "tilehighlight_func.h"
  32 #include "hotkeys.h"
  33 #include "error.h"
  34 #include "news_gui.h"
  35 #include "misc_cmd.h"
  36 #include "timer/timer.h"
  37 #include "timer/timer_window.h"
  38
  39 #include "saveload/saveload.h"
  40
  41 #include "widgets/main_widget.h"
  42
  43 #include "network/network.h"
  44 #include "network/network_func.h"
  45 #include "network/network_gui.h"
  46 #include "network/network_base.h"
  47
  48 #include "table/sprites.h"
  49 #include "table/strings.h"
  50
  51 #include "safeguards.h"
  52
  53 /**
  54  * This code is shared for the majority of the pushbuttons.
  55  * Handles e.g. the pressing of a button (to build things), playing of click sound and sets certain parameters
  56  *
  57  * @param w Window which called the function
  58  * @param widget ID of the widget (=button) that called this function
  59  * @param cursor How should the cursor image change? E.g. cursor with depot image in it
  60  * @param mode Tile highlighting mode, e.g. drawing a rectangle or a dot on the ground
  61  * @return true if the button is clicked, false if it's unclicked
  62  */
  63 bool HandlePlacePushButton(Window *w, WidgetID widget, CursorID cursor, HighLightStyle mode)
  64 {
  65         if (w->IsWidgetDisabled(widget)) return false;
  66
  67         if (_settings_client.sound.click_beep) SndPlayFx(SND_15_BEEP);
  68         w->SetDirty();
  69
  70         if (w->IsWidgetLowered(widget)) {
  71                 ResetObjectToPlace();
  72                 return false;
  73         }
  74
  75         SetObjectToPlace(cursor, PAL_NONE, mode, w->window_class, w->window_number);
  76         w->LowerWidget(widget);
  77         return true;
  78 }
  79
  80
  81 void CcPlaySound_EXPLOSION(Commands, const CommandCost &result, TileIndex tile)
  82 {
  83         if (result.Succeeded() && _settings_client.sound.confirm) SndPlayTileFx(SND_12_EXPLOSION, tile);
  84 }
  85
  86 /**
  87  * Zooms a viewport in a window in or out.
  88  * @param how Zooming direction.
  89  * @param w   Window owning the viewport.
  90  * @return Returns \c true if zooming step could be done, \c false if further zooming is not possible.
  91  * @note No button handling or what so ever is done.
  92  */
  93 bool DoZoomInOutWindow(ZoomStateChange how, Window *w)
  94 {
  95         Viewport *vp;
  96
  97         assert(w != nullptr);
  98         vp = w->viewport;
  99
 100         switch (how) {
 101                 case ZOOM_NONE:
 102                         /* On initialisation of the viewport we don't do anything. */
 103                         break;
 104
 105                 case ZOOM_IN:
 106                         if (vp->zoom <= _settings_client.gui.zoom_min) return false;
 107                         vp->zoom = (ZoomLevel)((int)vp->zoom - 1);
 108                         vp->virtual_width >>= 1;
 109                         vp->virtual_height >>= 1;
 110
 111                         w->viewport->scrollpos_x += vp->virtual_width >> 1;
 112                         w->viewport->scrollpos_y += vp->virtual_height >> 1;
 113                         w->viewport->dest_scrollpos_x = w->viewport->scrollpos_x;
 114                         w->viewport->dest_scrollpos_y = w->viewport->scrollpos_y;
 115                         w->viewport->follow_vehicle = INVALID_VEHICLE;
 116                         break;
 117                 case ZOOM_OUT:
 118                         if (vp->zoom >= _settings_client.gui.zoom_max) return false;
 119                         vp->zoom = (ZoomLevel)((int)vp->zoom + 1);
 120
 121                         w->viewport->scrollpos_x -= vp->virtual_width >> 1;
 122                         w->viewport->scrollpos_y -= vp->virtual_height >> 1;
 123                         w->viewport->dest_scrollpos_x = w->viewport->scrollpos_x;
 124                         w->viewport->dest_scrollpos_y = w->viewport->scrollpos_y;
 125
 126                         vp->virtual_width <<= 1;
 127                         vp->virtual_height <<= 1;
 128                         w->viewport->follow_vehicle = INVALID_VEHICLE;
 129                         break;
 130         }
 131         if (vp != nullptr) { // the vp can be null when how == ZOOM_NONE
 132                 vp->virtual_left = w->viewport->scrollpos_x;
 133                 vp->virtual_top = w->viewport->scrollpos_y;
 134         }
 135         /* Update the windows that have zoom-buttons to perhaps disable their buttons */
 136         w->InvalidateData();
 137         return true;
 138 }
 139
 140 void ZoomInOrOutToCursorWindow(bool in, Window *w)
 141 {
 142         assert(w != nullptr);
 143
 144         if (_game_mode != GM_MENU) {
 145                 Viewport *vp = w->viewport;
 146                 if ((in && vp->zoom <= _settings_client.gui.zoom_min) || (!in && vp->zoom >= _settings_client.gui.zoom_max)) return;
 147
 148                 Point pt = GetTileZoomCenterWindow(in, w);
 149                 if (pt.x != -1) {
 150                         ScrollWindowTo(pt.x, pt.y, -1, w, true);
 151
 152                         DoZoomInOutWindow(in ? ZOOM_IN : ZOOM_OUT, w);
 153                 }
 154         }
 155 }
 156
 157 void FixTitleGameZoom(int zoom_adjust)
 158 {
 159         if (_game_mode != GM_MENU) return;
 160
 161         Viewport *vp = GetMainWindow()->viewport;
 162
 163         /* Adjust the zoom in/out.
 164          * Can't simply add, since operator+ is not defined on the ZoomLevel type. */
 165         vp->zoom = _gui_zoom;
 166         while (zoom_adjust < 0 && vp->zoom != _settings_client.gui.zoom_min) {
 167                 vp->zoom--;
 168                 zoom_adjust++;
 169         }
 170         while (zoom_adjust > 0 && vp->zoom != _settings_client.gui.zoom_max) {
 171                 vp->zoom++;
 172                 zoom_adjust--;
 173         }
 174
 175         vp->virtual_width = ScaleByZoom(vp->width, vp->zoom);
 176         vp->virtual_height = ScaleByZoom(vp->height, vp->zoom);
 177 }
 178
 179 static constexpr NWidgetPart _nested_main_window_widgets[] = {
 180         NWidget(NWID_VIEWPORT, INVALID_COLOUR, WID_M_VIEWPORT), SetResize(1, 1),
 181 };
 182
 183 enum {
 184         GHK_QUIT,
 185         GHK_ABANDON,
 186         GHK_CONSOLE,
 187         GHK_BOUNDING_BOXES,
 188         GHK_DIRTY_BLOCKS,
 189         GHK_WIDGET_OUTLINES,
 190         GHK_CENTER,
 191         GHK_CENTER_ZOOM,
 192         GHK_RESET_OBJECT_TO_PLACE,
 193         GHK_DELETE_WINDOWS,
 194         GHK_DELETE_NONVITAL_WINDOWS,
 195         GHK_DELETE_ALL_MESSAGES,
 196         GHK_REFRESH_SCREEN,
 197         GHK_CRASH,
 198         GHK_MONEY,
 199         GHK_UPDATE_COORDS,
 200         GHK_TOGGLE_TRANSPARENCY,
 201         GHK_TOGGLE_INVISIBILITY = GHK_TOGGLE_TRANSPARENCY + 9,
 202         GHK_TRANSPARENCY_TOOLBAR = GHK_TOGGLE_INVISIBILITY + 8,
 203         GHK_TRANSPARANCY,
 204         GHK_CHAT,
 205         GHK_CHAT_ALL,
 206         GHK_CHAT_COMPANY,
 207         GHK_CHAT_SERVER,
 208         GHK_CLOSE_NEWS,
 209         GHK_CLOSE_ERROR,
 210 };
 211
 212 struct MainWindow : Window
 213 {
 214         MainWindow(WindowDesc *desc) : Window(desc)
 215         {
 216                 this->InitNested(0);
 217                 CLRBITS(this->flags, WF_WHITE_BORDER);
 218                 ResizeWindow(this, _screen.width, _screen.height);
 219
 220                 NWidgetViewport *nvp = this->GetWidget<NWidgetViewport>(WID_M_VIEWPORT);
 221                 nvp->InitializeViewport(this, TileXY(32, 32), ScaleZoomGUI(ZOOM_LVL_VIEWPORT));
 222
 223                 this->viewport->overlay = std::make_shared<LinkGraphOverlay>(this, WID_M_VIEWPORT, 0, 0, 2);
 224                 this->refresh_timeout.Reset();
 225         }
 226
 227         /** Refresh the link-graph overlay. */
 228         void RefreshLinkGraph()
 229         {
 230                 if (this->viewport->overlay->GetCargoMask() == 0 ||
 231                                 this->viewport->overlay->GetCompanyMask() == 0) {
 232                         return;
 233                 }
 234
 235                 this->viewport->overlay->SetDirty();
 236                 this->GetWidget<NWidgetBase>(WID_M_VIEWPORT)->SetDirty(this);
 237         }
 238
 239         /** Refresh the link-graph overlay on a regular interval. */
 240         IntervalTimer<TimerWindow> refresh_interval = {std::chrono::milliseconds(7650), [this](auto) {
 241                 RefreshLinkGraph();
 242         }};
 243
 244         /**
 245          * Sometimes when something happened, force an update to the link-graph a bit sooner.
 246          *
 247          * We don't do it instantly on those changes, as for example when you are scrolling,
 248          * constantly refreshing the link-graph would be very slow. So we delay it a bit,
 249          * and only draw it once the scrolling settles down.
 250          */
 251         TimeoutTimer<TimerWindow> refresh_timeout = {std::chrono::milliseconds(450), [this]() {
 252                 RefreshLinkGraph();
 253         }};
 254
 255         void OnPaint() override
 256         {
 257                 this->DrawWidgets();
 258                 if (_game_mode == GM_MENU) {
 259                         static const SpriteID title_sprites[] = {SPR_OTTD_O, SPR_OTTD_P, SPR_OTTD_E, SPR_OTTD_N, SPR_OTTD_T, SPR_OTTD_T, SPR_OTTD_D};
 260                         uint letter_spacing = ScaleGUITrad(10);
 261                         int name_width = (lengthof(title_sprites) - 1) * letter_spacing;
 262
 263                         for (uint i = 0; i < lengthof(title_sprites); i++) {
 264                                 name_width += GetSpriteSize(title_sprites[i]).width;
 265                         }
 266                         int off_x = (this->width - name_width) / 2;
 267
 268                         for (uint i = 0; i < lengthof(title_sprites); i++) {
 269                                 DrawSprite(title_sprites[i], PAL_NONE, off_x, ScaleGUITrad(50));
 270                                 off_x += GetSpriteSize(title_sprites[i]).width + letter_spacing;
 271                         }
 272                 }
 273         }
 274
 275         EventState OnHotkey(int hotkey) override
 276         {
 277                 if (hotkey == GHK_QUIT) {
 278                         HandleExitGameRequest();
 279                         return ES_HANDLED;
 280                 }
 281
 282                 /* Disable all key shortcuts, except quit shortcuts when
 283                  * generating the world, otherwise they create threading
 284                  * problem during the generating, resulting in random
 285                  * assertions that are hard to trigger and debug */
 286                 if (HasModalProgress()) return ES_NOT_HANDLED;
 287
 288                 switch (hotkey) {
 289                         case GHK_ABANDON:
 290                                 /* No point returning from the main menu to itself */
 291                                 if (_game_mode == GM_MENU) return ES_HANDLED;
 292                                 if (_settings_client.gui.autosave_on_exit) {
 293                                         DoExitSave();
 294                                         _switch_mode = SM_MENU;
 295                                 } else {
 296                                         AskExitToGameMenu();
 297                                 }
 298                                 return ES_HANDLED;
 299
 300                         case GHK_CONSOLE:
 301                                 IConsoleSwitch();
 302                                 return ES_HANDLED;
 303
 304                         case GHK_BOUNDING_BOXES:
 305                                 ToggleBoundingBoxes();
 306                                 return ES_HANDLED;
 307
 308                         case GHK_DIRTY_BLOCKS:
 309                                 ToggleDirtyBlocks();
 310                                 return ES_HANDLED;
 311
 312                         case GHK_WIDGET_OUTLINES:
 313                                 ToggleWidgetOutlines();
 314                                 return ES_HANDLED;
 315                 }
 316
 317                 if (_game_mode == GM_MENU) return ES_NOT_HANDLED;
 318
 319                 switch (hotkey) {
 320                         case GHK_CENTER:
 321                         case GHK_CENTER_ZOOM: {
 322                                 Point pt = GetTileBelowCursor();
 323                                 if (pt.x != -1) {
 324                                         bool instant = (hotkey == GHK_CENTER_ZOOM && this->viewport->zoom != _settings_client.gui.zoom_min);
 325                                         if (hotkey == GHK_CENTER_ZOOM) MaxZoomInOut(ZOOM_IN, this);
 326                                         ScrollMainWindowTo(pt.x, pt.y, -1, instant);
 327                                 }
 328                                 break;
 329                         }
 330
 331                         case GHK_RESET_OBJECT_TO_PLACE: ResetObjectToPlace(); break;
 332                         case GHK_DELETE_WINDOWS: CloseNonVitalWindows(); break;
 333                         case GHK_DELETE_NONVITAL_WINDOWS: CloseAllNonVitalWindows(); break;
 334                         case GHK_DELETE_ALL_MESSAGES: DeleteAllMessages(); break;
 335                         case GHK_REFRESH_SCREEN: MarkWholeScreenDirty(); break;
 336
 337                         case GHK_CRASH: // Crash the game
 338                                 *(volatile byte *)nullptr = 0;
 339                                 break;
 340
 341                         case GHK_MONEY: // Gimme money
 342                                 /* You can only cheat for money in singleplayer mode. */
 343                                 if (!_networking) Command<CMD_MONEY_CHEAT>::Post(10000000);
 344                                 break;
 345
 346                         case GHK_UPDATE_COORDS: // Update the coordinates of all station signs
 347                                 UpdateAllVirtCoords();
 348                                 break;
 349
 350                         case GHK_TOGGLE_TRANSPARENCY:
 351                         case GHK_TOGGLE_TRANSPARENCY + 1:
 352                         case GHK_TOGGLE_TRANSPARENCY + 2:
 353                         case GHK_TOGGLE_TRANSPARENCY + 3:
 354                         case GHK_TOGGLE_TRANSPARENCY + 4:
 355                         case GHK_TOGGLE_TRANSPARENCY + 5:
 356                         case GHK_TOGGLE_TRANSPARENCY + 6:
 357                         case GHK_TOGGLE_TRANSPARENCY + 7:
 358                         case GHK_TOGGLE_TRANSPARENCY + 8:
 359                                 /* Transparency toggle hot keys */
 360                                 ToggleTransparency((TransparencyOption)(hotkey - GHK_TOGGLE_TRANSPARENCY));
 361                                 MarkWholeScreenDirty();
 362                                 break;
 363
 364                         case GHK_TOGGLE_INVISIBILITY:
 365                         case GHK_TOGGLE_INVISIBILITY + 1:
 366                         case GHK_TOGGLE_INVISIBILITY + 2:
 367                         case GHK_TOGGLE_INVISIBILITY + 3:
 368                         case GHK_TOGGLE_INVISIBILITY + 4:
 369                         case GHK_TOGGLE_INVISIBILITY + 5:
 370                         case GHK_TOGGLE_INVISIBILITY + 6:
 371                         case GHK_TOGGLE_INVISIBILITY + 7:
 372                                 /* Invisibility toggle hot keys */
 373                                 ToggleInvisibilityWithTransparency((TransparencyOption)(hotkey - GHK_TOGGLE_INVISIBILITY));
 374                                 MarkWholeScreenDirty();
 375                                 break;
 376
 377                         case GHK_TRANSPARENCY_TOOLBAR:
 378                                 ShowTransparencyToolbar();
 379                                 break;
 380
 381                         case GHK_TRANSPARANCY:
 382                                 ResetRestoreAllTransparency();
 383                                 break;
 384
 385                         case GHK_CHAT: // smart chat; send to team if any, otherwise to all
 386                                 if (_networking) {
 387                                         const NetworkClientInfo *cio = NetworkClientInfo::GetByClientID(_network_own_client_id);
 388                                         if (cio == nullptr) break;
 389
 390                                         ShowNetworkChatQueryWindow(NetworkClientPreferTeamChat(cio) ? DESTTYPE_TEAM : DESTTYPE_BROADCAST, cio->client_playas);
 391                                 }
 392                                 break;
 393
 394                         case GHK_CHAT_ALL: // send text message to all clients
 395                                 if (_networking) ShowNetworkChatQueryWindow(DESTTYPE_BROADCAST, 0);
 396                                 break;
 397
 398                         case GHK_CHAT_COMPANY: // send text to all team mates
 399                                 if (_networking) {
 400                                         const NetworkClientInfo *cio = NetworkClientInfo::GetByClientID(_network_own_client_id);
 401                                         if (cio == nullptr) break;
 402
 403                                         ShowNetworkChatQueryWindow(DESTTYPE_TEAM, cio->client_playas);
 404                                 }
 405                                 break;
 406
 407                         case GHK_CHAT_SERVER: // send text to the server
 408                                 if (_networking && !_network_server) {
 409                                         ShowNetworkChatQueryWindow(DESTTYPE_CLIENT, CLIENT_ID_SERVER);
 410                                 }
 411                                 break;
 412
 413                         case GHK_CLOSE_NEWS: // close active news window
 414                                 if (!HideActiveNewsMessage()) return ES_NOT_HANDLED;
 415                                 break;
 416
 417                         case GHK_CLOSE_ERROR: // close active error window
 418                                 if (!HideActiveErrorMessage()) return ES_NOT_HANDLED;
 419                                 break;
 420
 421                         default: return ES_NOT_HANDLED;
 422                 }
 423                 return ES_HANDLED;
 424         }
 425
 426         void OnScroll(Point delta) override
 427         {
 428                 this->viewport->scrollpos_x += ScaleByZoom(delta.x, this->viewport->zoom);
 429                 this->viewport->scrollpos_y += ScaleByZoom(delta.y, this->viewport->zoom);
 430                 this->viewport->dest_scrollpos_x = this->viewport->scrollpos_x;
 431                 this->viewport->dest_scrollpos_y = this->viewport->scrollpos_y;
 432                 this->refresh_timeout.Reset();
 433         }
 434
 435         void OnMouseWheel(int wheel) override
 436         {
 437                 if (_settings_client.gui.scrollwheel_scrolling != 2) {
 438                         ZoomInOrOutToCursorWindow(wheel < 0, this);
 439                 }
 440         }
 441
 442         void OnResize() override
 443         {
 444                 if (this->viewport != nullptr) {
 445                         NWidgetViewport *nvp = this->GetWidget<NWidgetViewport>(WID_M_VIEWPORT);
 446                         nvp->UpdateViewportCoordinates(this);
 447                         this->refresh_timeout.Reset();
 448                 }
 449         }
 450
 451         bool OnTooltip([[maybe_unused]] Point pt, WidgetID widget, TooltipCloseCondition close_cond) override
 452         {
 453                 if (widget != WID_M_VIEWPORT) return false;
 454                 return this->viewport->overlay->ShowTooltip(pt, close_cond);
 455         }
 456
 457         /**
 458          * Some data on this window has become invalid.
 459          * @param data Information about the changed data.
 460          * @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.
 461          */
 462         void OnInvalidateData([[maybe_unused]] int data = 0, [[maybe_unused]] bool gui_scope = true) override
 463         {
 464                 if (!gui_scope) return;
 465                 /* Forward the message to the appropriate toolbar (ingame or scenario editor) */
 466                 InvalidateWindowData(WC_MAIN_TOOLBAR, 0, data, true);
 467         }
 468
 469         static inline HotkeyList hotkeys{"global", {
 470                 Hotkey({'Q' | WKC_CTRL, 'Q' | WKC_META}, "quit", GHK_QUIT),
 471                 Hotkey({'W' | WKC_CTRL, 'W' | WKC_META}, "abandon", GHK_ABANDON),
 472                 Hotkey(WKC_BACKQUOTE, "console", GHK_CONSOLE),
 473                 Hotkey('B' | WKC_CTRL, "bounding_boxes", GHK_BOUNDING_BOXES),
 474                 Hotkey('I' | WKC_CTRL, "dirty_blocks", GHK_DIRTY_BLOCKS),
 475                 Hotkey('O' | WKC_CTRL, "widget_outlines", GHK_WIDGET_OUTLINES),
 476                 Hotkey('C', "center", GHK_CENTER),
 477                 Hotkey('Z', "center_zoom", GHK_CENTER_ZOOM),
 478                 Hotkey(WKC_ESC, "reset_object_to_place", GHK_RESET_OBJECT_TO_PLACE),
 479                 Hotkey(WKC_DELETE, "delete_windows", GHK_DELETE_WINDOWS),
 480                 Hotkey(WKC_DELETE | WKC_SHIFT, "delete_all_windows", GHK_DELETE_NONVITAL_WINDOWS),
 481                 Hotkey(WKC_DELETE | WKC_CTRL, "delete_all_messages", GHK_DELETE_ALL_MESSAGES),
 482                 Hotkey('R' | WKC_CTRL, "refresh_screen", GHK_REFRESH_SCREEN),
 483 #if defined(_DEBUG)
 484                 Hotkey('0' | WKC_ALT, "crash_game", GHK_CRASH),
 485                 Hotkey('1' | WKC_ALT, "money", GHK_MONEY),
 486                 Hotkey('2' | WKC_ALT, "update_coordinates", GHK_UPDATE_COORDS),
 487 #endif
 488                 Hotkey('1' | WKC_CTRL, "transparency_signs", GHK_TOGGLE_TRANSPARENCY),
 489                 Hotkey('2' | WKC_CTRL, "transparency_trees", GHK_TOGGLE_TRANSPARENCY + 1),
 490                 Hotkey('3' | WKC_CTRL, "transparency_houses", GHK_TOGGLE_TRANSPARENCY + 2),
 491                 Hotkey('4' | WKC_CTRL, "transparency_industries", GHK_TOGGLE_TRANSPARENCY + 3),
 492                 Hotkey('5' | WKC_CTRL, "transparency_buildings", GHK_TOGGLE_TRANSPARENCY + 4),
 493                 Hotkey('6' | WKC_CTRL, "transparency_bridges", GHK_TOGGLE_TRANSPARENCY + 5),
 494                 Hotkey('7' | WKC_CTRL, "transparency_structures", GHK_TOGGLE_TRANSPARENCY + 6),
 495                 Hotkey('8' | WKC_CTRL, "transparency_catenary", GHK_TOGGLE_TRANSPARENCY + 7),
 496                 Hotkey('9' | WKC_CTRL, "transparency_loading", GHK_TOGGLE_TRANSPARENCY + 8),
 497                 Hotkey('1' | WKC_CTRL | WKC_SHIFT, "invisibility_signs", GHK_TOGGLE_INVISIBILITY),
 498                 Hotkey('2' | WKC_CTRL | WKC_SHIFT, "invisibility_trees", GHK_TOGGLE_INVISIBILITY + 1),
 499                 Hotkey('3' | WKC_CTRL | WKC_SHIFT, "invisibility_houses", GHK_TOGGLE_INVISIBILITY + 2),
 500                 Hotkey('4' | WKC_CTRL | WKC_SHIFT, "invisibility_industries", GHK_TOGGLE_INVISIBILITY + 3),
 501                 Hotkey('5' | WKC_CTRL | WKC_SHIFT, "invisibility_buildings", GHK_TOGGLE_INVISIBILITY + 4),
 502                 Hotkey('6' | WKC_CTRL | WKC_SHIFT, "invisibility_bridges", GHK_TOGGLE_INVISIBILITY + 5),
 503                 Hotkey('7' | WKC_CTRL | WKC_SHIFT, "invisibility_structures", GHK_TOGGLE_INVISIBILITY + 6),
 504                 Hotkey('8' | WKC_CTRL | WKC_SHIFT, "invisibility_catenary", GHK_TOGGLE_INVISIBILITY + 7),
 505                 Hotkey('X' | WKC_CTRL, "transparency_toolbar", GHK_TRANSPARENCY_TOOLBAR),
 506                 Hotkey('X', "toggle_transparency", GHK_TRANSPARANCY),
 507                 Hotkey({WKC_RETURN, 'T'}, "chat", GHK_CHAT),
 508                 Hotkey({WKC_SHIFT | WKC_RETURN, WKC_SHIFT | 'T'}, "chat_all", GHK_CHAT_ALL),
 509                 Hotkey({WKC_CTRL | WKC_RETURN, WKC_CTRL | 'T'}, "chat_company", GHK_CHAT_COMPANY),
 510                 Hotkey({WKC_CTRL | WKC_SHIFT | WKC_RETURN, WKC_CTRL | WKC_SHIFT | 'T'}, "chat_server", GHK_CHAT_SERVER),
 511                 Hotkey(WKC_SPACE, "close_news", GHK_CLOSE_NEWS),
 512                 Hotkey(WKC_SPACE, "close_error", GHK_CLOSE_ERROR),
 513         }};
 514 };
 515
 516 static WindowDesc _main_window_desc(__FILE__, __LINE__,
 517         WDP_MANUAL, nullptr, 0, 0,
 518         WC_MAIN_WINDOW, WC_NONE,
 519         WDF_NO_CLOSE,
 520         std::begin(_nested_main_window_widgets), std::end(_nested_main_window_widgets),
 521         &MainWindow::hotkeys
 522 );
 523
 524 /**
 525  * Does the given keycode match one of the keycodes bound to 'quit game'?
 526  * @param keycode The keycode that was pressed by the user.
 527  * @return True iff the keycode matches one of the hotkeys for 'quit'.
 528  */
 529 bool IsQuitKey(uint16_t keycode)
 530 {
 531         int num = MainWindow::hotkeys.CheckMatch(keycode);
 532         return num == GHK_QUIT;
 533 }
 534
 535
 536 void ShowSelectGameWindow();
 537
 538 /**
 539  * Initialise the default colours (remaps and the likes), and load the main windows.
 540  */
 541 void SetupColoursAndInitialWindow()
 542 {
 543         for (uint i = 0; i != 16; i++) {
 544                 const byte *b = GetNonSprite(GENERAL_SPRITE_COLOUR(i), SpriteType::Recolour);
 545
 546                 assert(b);
 547                 memcpy(_colour_gradient[i], b + 0xC6, sizeof(_colour_gradient[i]));
 548         }
 549
 550         new MainWindow(&_main_window_desc);
 551
 552         /* XXX: these are not done */
 553         switch (_game_mode) {
 554                 default: NOT_REACHED();
 555                 case GM_MENU:
 556                         ShowSelectGameWindow();
 557                         break;
 558
 559                 case GM_NORMAL:
 560                 case GM_EDITOR:
 561                         ShowVitalWindows();
 562                         break;
 563         }
 564 }
 565
 566 /**
 567  * Show the vital in-game windows.
 568  */
 569 void ShowVitalWindows()
 570 {
 571         AllocateToolbar();
 572
 573         /* Status bad only for normal games */
 574         if (_game_mode == GM_EDITOR) return;
 575
 576         ShowStatusBar();
 577 }
 578
 579 /**
 580  * Size of the application screen changed.
 581  * Adapt the game screen-size, re-allocate the open windows, and repaint everything
 582  */
 583 void GameSizeChanged()
 584 {
 585         _cur_resolution.width  = _screen.width;
 586         _cur_resolution.height = _screen.height;
 587         ScreenSizeChanged();
 588         RelocateAllWindows(_screen.width, _screen.height);
 589         MarkWholeScreenDirty();
 590 }