OpenTTD Source  1.11.0-beta2
bootstrap_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 "base_media_base.h"
12 #include "blitter/factory.hpp"
13 
14 #if defined(WITH_FREETYPE) || defined(WITH_UNISCRIBE) || defined(WITH_COCOA)
15 
16 #include "core/geometry_func.hpp"
17 #include "fontcache.h"
18 #include "gfx_func.h"
19 #include "network/network.h"
21 #include "openttd.h"
22 #include "strings_func.h"
23 #include "video/video_driver.hpp"
24 #include "window_func.h"
25 
27 
28 #include "table/strings.h"
29 
30 #include "safeguards.h"
31 
33 static const struct NWidgetPart _background_widgets[] = {
34  NWidget(WWT_PANEL, COLOUR_DARK_BLUE, WID_BB_BACKGROUND), SetResize(1, 1),
35 };
36 
41  WDP_MANUAL, nullptr, 0, 0,
43  0,
45 );
46 
48 class BootstrapBackground : public Window {
49 public:
51  {
52  this->InitNested(0);
54  ResizeWindow(this, _screen.width, _screen.height);
55  }
56 
57  void DrawWidget(const Rect &r, int widget) const override
58  {
59  GfxFillRect(r.left, r.top, r.right, r.bottom, 4, FILLRECT_OPAQUE);
60  GfxFillRect(r.left, r.top, r.right, r.bottom, 0, FILLRECT_CHECKER);
61  }
62 };
63 
66  NWidget(WWT_CAPTION, COLOUR_GREY), SetDataTip(STR_CONTENT_DOWNLOAD_TITLE, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
67  NWidget(WWT_PANEL, COLOUR_GREY, WID_NCDS_BACKGROUND),
69  EndContainer(),
70 };
71 
74  WDP_CENTER, nullptr, 0, 0,
76  WDF_MODAL,
78 );
79 
80 
83 public:
86  {
87  }
88 
89  void OnDownloadComplete(ContentID cid) override
90  {
91  /* We have completed downloading. We can trigger finding the right set now. */
93 
94  /* And continue going into the menu. */
95  _game_mode = GM_MENU;
96 
97  /* _exit_game is used to break out of the outer video driver's MainLoop. */
98  _exit_game = true;
99  delete this;
100  }
101 };
102 
106  NWidget(WWT_CAPTION, COLOUR_GREY), SetDataTip(STR_MISSING_GRAPHICS_SET_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
107  EndContainer(),
108  NWidget(WWT_PANEL, COLOUR_GREY),
111  NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_BAFD_YES), SetDataTip(STR_MISSING_GRAPHICS_YES_DOWNLOAD, STR_NULL),
112  NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_BAFD_NO), SetDataTip(STR_MISSING_GRAPHICS_NO_QUIT, STR_NULL),
113  EndContainer(),
114  EndContainer(),
115 };
116 
119  WDP_CENTER, nullptr, 0, 0,
121  0,
123 );
124 
128 
129 public:
132  {
135  }
136 
139  {
141  }
142 
143  void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
144  {
145  /* We cache the button size. This is safe as no reinit can happen here. */
146  if (this->button_size.width == 0) {
147  this->button_size = maxdim(GetStringBoundingBox(STR_MISSING_GRAPHICS_YES_DOWNLOAD), GetStringBoundingBox(STR_MISSING_GRAPHICS_NO_QUIT));
148  this->button_size.width += WD_FRAMETEXT_LEFT + WD_FRAMETEXT_RIGHT;
149  this->button_size.height += WD_FRAMETEXT_TOP + WD_FRAMETEXT_BOTTOM;
150  }
151 
152  switch (widget) {
153  case WID_BAFD_QUESTION:
154  /* The question is twice as wide as the buttons, and determine the height based on the width. */
155  size->width = this->button_size.width * 2;
156  size->height = GetStringHeight(STR_MISSING_GRAPHICS_SET_MESSAGE, size->width - WD_FRAMETEXT_LEFT - WD_FRAMETEXT_RIGHT) + WD_FRAMETEXT_BOTTOM + WD_FRAMETEXT_TOP;
157  break;
158 
159  case WID_BAFD_YES:
160  case WID_BAFD_NO:
161  *size = this->button_size;
162  break;
163  }
164  }
165 
166  void DrawWidget(const Rect &r, int widget) const override
167  {
168  if (widget != 0) return;
169 
170  DrawStringMultiLine(r.left + WD_FRAMETEXT_LEFT, r.right - WD_FRAMETEXT_RIGHT, r.top + WD_FRAMETEXT_TOP, r.bottom - WD_FRAMETEXT_BOTTOM, STR_MISSING_GRAPHICS_SET_MESSAGE, TC_FROMSTRING, SA_CENTER);
171  }
172 
173  void OnClick(Point pt, int widget, int click_count) override
174  {
175  switch (widget) {
176  case WID_BAFD_YES:
177  /* We got permission to connect! Yay! */
179  break;
180 
181  case WID_BAFD_NO:
182  _exit_game = true;
183  break;
184 
185  default:
186  break;
187  }
188  }
189 
190  void OnConnect(bool success) override
191  {
192  /* Once connected, request the metadata. */
194  }
195 
196  void OnReceiveContentInfo(const ContentInfo *ci) override
197  {
198  /* And once the meta data is received, start downloading it. */
201  delete this;
202  }
203 };
204 
205 #endif /* defined(WITH_FREETYPE) */
206 
214 {
215  if (BaseGraphics::GetUsedSet() != nullptr) return true;
216 
217  /* No user interface, bail out with an error. */
218  if (BlitterFactory::GetCurrentBlitter()->GetScreenDepth() == 0) goto failure;
219 
220  /* If there is no network or no freetype, then there is nothing we can do. Go straight to failure. */
221 #if (defined(_WIN32) && defined(WITH_UNISCRIBE)) || (defined(WITH_FREETYPE) && (defined(WITH_FONTCONFIG) || defined(__APPLE__))) || defined(WITH_COCOA)
222  if (!_network_available) goto failure;
223 
224  /* First tell the game we're bootstrapping. */
225  _game_mode = GM_BOOTSTRAP;
226 
227  /* Initialise the freetype font code. */
229  /* Next "force" finding a suitable freetype font as the local font is missing. */
230  CheckForMissingGlyphs(false);
231 
232  /* Initialise the palette. The biggest step is 'faking' some recolour sprites.
233  * This way the mauve and gray colours work and we can show the user interface. */
234  GfxInitPalettes();
235  static const int offsets[] = { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0x80, 0, 0, 0, 0x04, 0x08 };
236  for (uint i = 0; i != 16; i++) {
237  for (int j = 0; j < 8; j++) {
238  _colour_gradient[i][j] = offsets[i] + j;
239  }
240  }
241 
242  /* Finally ask the question. */
243  new BootstrapBackground();
245 
246  /* Process the user events. */
248 
249  /* _exit_game is used to get out of the video driver's main loop.
250  * In case GM_BOOTSTRAP is still set we did not exit it via the
251  * "download complete" event, so it was a manual exit. Obey it. */
252  _exit_game = _game_mode == GM_BOOTSTRAP;
253  if (_exit_game) return false;
254 
255  /* Try to probe the graphics. Should work this time. */
256  if (!BaseGraphics::SetSet({})) goto failure;
257 
258  /* Finally we can continue heading for the menu. */
259  _game_mode = GM_MENU;
260  return true;
261 #endif
262 
263  /* Failure to get enough working to get a graphics set. */
264 failure:
265  usererror("Failed to find a graphics set. Please acquire a graphics set for OpenTTD. See section 1.4 of README.md.");
266  return false;
267 }
HandleBootstrap
bool HandleBootstrap()
Handle all procedures for bootstrapping OpenTTD without a base graphics set.
Definition: bootstrap_gui.cpp:213
WD_FRAMERECT_TOP
@ WD_FRAMERECT_TOP
Offset at top to draw the frame rectangular area.
Definition: window_gui.h:62
ContentCallback
Callbacks for notifying others about incoming data.
Definition: network_content.h:27
factory.hpp
usererror
void CDECL usererror(const char *s,...)
Error handling for fatal user errors.
Definition: openttd.cpp:100
Dimension
Dimensions (a width and height) of a rectangle in 2D.
Definition: geometry_type.hpp:27
WWT_CAPTION
@ WWT_CAPTION
Window caption (window title between closebox and stickybox)
Definition: widget_type.h:59
NWID_HORIZONTAL
@ NWID_HORIZONTAL
Horizontal container.
Definition: widget_type.h:73
maxdim
Dimension maxdim(const Dimension &d1, const Dimension &d2)
Compute bounding box of both dimensions.
Definition: geometry_func.cpp:22
CONTENT_TYPE_BASE_GRAPHICS
@ CONTENT_TYPE_BASE_GRAPHICS
The content consists of base graphics.
Definition: tcp_content.h:23
_bootstrap_query_desc
static WindowDesc _bootstrap_query_desc(WDP_CENTER, nullptr, 0, 0, WC_CONFIRM_POPUP_QUERY, WC_NONE, 0, _bootstrap_query_widgets, lengthof(_bootstrap_query_widgets))
The window description for the query.
FILLRECT_CHECKER
@ FILLRECT_CHECKER
Draw only every second pixel, used for greying-out.
Definition: gfx_type.h:288
BootstrapAskForDownloadWindow::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: bootstrap_gui.cpp:173
SetResize
static NWidgetPart SetResize(int16 dx, int16 dy)
Widget part function for setting the resize step.
Definition: widget_type.h:929
WC_BOOTSTRAP
@ WC_BOOTSTRAP
Bootstrap; Window numbers:
Definition: window_type.h:637
WD_FRAMETEXT_TOP
@ WD_FRAMETEXT_TOP
Top offset of the text of the frame.
Definition: window_gui.h:72
base_media_base.h
BaseNetworkContentDownloadStatusWindow
Base window for showing the download status of content.
Definition: network_content_gui.h:18
SA_CENTER
@ SA_CENTER
Center both horizontally and vertically.
Definition: gfx_func.h:106
WD_FRAMETEXT_LEFT
@ WD_FRAMETEXT_LEFT
Left offset of the text of the frame.
Definition: window_gui.h:70
_colour_gradient
byte _colour_gradient[COLOUR_END][8]
All 16 colour gradients 8 colours per gradient from darkest (0) to lightest (7)
Definition: gfx.cpp:52
Window::Window
Window(WindowDesc *desc)
Empty constructor, initialization has been moved to InitNested() called from the constructor of the d...
Definition: window.cpp:1871
NWidgetPart
Partial widget specification to allow NWidgets to be written nested.
Definition: widget_type.h:909
SetDataTip
static NWidgetPart SetDataTip(uint32 data, StringID tip)
Widget part function for setting the data and tooltip.
Definition: widget_type.h:1013
GetStringBoundingBox
Dimension GetStringBoundingBox(const char *str, FontSize start_fontsize)
Return the string dimension in pixels.
Definition: gfx.cpp:842
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:763
BootstrapAskForDownloadWindow::BootstrapAskForDownloadWindow
BootstrapAskForDownloadWindow()
Start listening to the content client events.
Definition: bootstrap_gui.cpp:131
BootstrapAskForDownloadWindow::DrawWidget
void DrawWidget(const Rect &r, int widget) const override
Draw the contents of a nested widget.
Definition: bootstrap_gui.cpp:166
BootstrapContentDownloadStatusWindow::BootstrapContentDownloadStatusWindow
BootstrapContentDownloadStatusWindow()
Simple call the constructor of the superclass.
Definition: bootstrap_gui.cpp:85
gfx_func.h
WindowDesc
High level window description.
Definition: window_gui.h:166
ClientNetworkContentSocketHandler::RequestContentList
void RequestContentList(ContentType type)
Request the content list for the given type.
Definition: network_content.cpp:185
WC_CONFIRM_POPUP_QUERY
@ WC_CONFIRM_POPUP_QUERY
Popup with confirm question; Window numbers:
Definition: window_type.h:123
Window::resize
ResizeInfo resize
Resize information.
Definition: window_gui.h:322
Window::InitNested
void InitNested(WindowNumber number=0)
Perform complete initialization of the Window with nested widgets, to allow use.
Definition: window.cpp:1861
BootstrapAskForDownloadWindow::button_size
Dimension button_size
The dimension of the button.
Definition: bootstrap_gui.cpp:127
BootstrapContentDownloadStatusWindow::OnDownloadComplete
void OnDownloadComplete(ContentID cid) override
We have finished downloading a file.
Definition: bootstrap_gui.cpp:89
_nested_boostrap_download_status_window_widgets
static const NWidgetPart _nested_boostrap_download_status_window_widgets[]
Nested widgets for the download window.
Definition: bootstrap_gui.cpp:65
WF_WHITE_BORDER
@ WF_WHITE_BORDER
Window white border counter bit mask.
Definition: window_gui.h:240
_background_desc
static WindowDesc _background_desc(WDP_MANUAL, nullptr, 0, 0, WC_BOOTSTRAP, WC_NONE, 0, _background_widgets, lengthof(_background_widgets))
Window description for the background window to prevent smearing.
BootstrapAskForDownloadWindow
The window for the query.
Definition: bootstrap_gui.cpp:126
ContentInfo
Container for all important information about a piece of content.
Definition: tcp_content.h:54
WD_FRAMERECT_BOTTOM
@ WD_FRAMERECT_BOTTOM
Offset at bottom to draw the frame rectangular area.
Definition: window_gui.h:63
WWT_PUSHTXTBTN
@ WWT_PUSHTXTBTN
Normal push-button (no toggle button) with text caption.
Definition: widget_type.h:102
WD_FRAMETEXT_BOTTOM
@ WD_FRAMETEXT_BOTTOM
Bottom offset of the text of the frame.
Definition: window_gui.h:73
WID_BAFD_QUESTION
@ WID_BAFD_QUESTION
The question whether to download.
Definition: bootstrap_widget.h:20
BlitterFactory::GetCurrentBlitter
static Blitter * GetCurrentBlitter()
Get the current active blitter (always set by calling SelectBlitter).
Definition: factory.hpp:140
safeguards.h
Window::flags
WindowFlags flags
Window flags.
Definition: window_gui.h:310
WID_BB_BACKGROUND
@ WID_BB_BACKGROUND
Background of the window.
Definition: bootstrap_widget.h:15
WDF_MODAL
@ WDF_MODAL
The window is a modal child of some other window, meaning the parent is 'inactive'.
Definition: window_gui.h:209
Point
Coordinates of a point in 2D.
Definition: geometry_type.hpp:21
WID_NCDS_BACKGROUND
@ WID_NCDS_BACKGROUND
Background of the window.
Definition: network_content_widget.h:17
ClientNetworkContentSocketHandler::RemoveCallback
void RemoveCallback(ContentCallback *cb)
Remove a callback.
Definition: network_content.h:143
WD_FRAMETEXT_RIGHT
@ WD_FRAMETEXT_RIGHT
Right offset of the text of the frame.
Definition: window_gui.h:71
stdafx.h
_bootstrap_query_widgets
static const NWidgetPart _bootstrap_query_widgets[]
The widgets for the query.
Definition: bootstrap_gui.cpp:104
_background_widgets
static const struct NWidgetPart _background_widgets[]
Widgets for the background window to prevent smearing.
Definition: bootstrap_gui.cpp: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:114
VideoDriver::GetInstance
static VideoDriver * GetInstance()
Get the currently active instance of the video driver.
Definition: video_driver.hpp:168
WC_NONE
@ WC_NONE
No window, redirects to WC_MAIN_WINDOW.
Definition: window_type.h:38
WID_BAFD_NO
@ WID_BAFD_NO
An negative answer to the question.
Definition: bootstrap_widget.h:22
bootstrap_widget.h
FILLRECT_OPAQUE
@ FILLRECT_OPAQUE
Fill rectangle with a single colour.
Definition: gfx_type.h:287
GetStringHeight
int GetStringHeight(const char *str, int maxw, FontSize fontsize)
Calculates height of string (in pixels).
Definition: gfx.cpp:689
_network_content_client
ClientNetworkContentSocketHandler _network_content_client
The client we use to connect to the server.
Definition: network_content.cpp:35
EndContainer
static NWidgetPart EndContainer()
Widget part function for denoting the end of a container (horizontal, vertical, WWT_FRAME,...
Definition: widget_type.h:998
BootstrapBackground
The background for the game.
Definition: bootstrap_gui.cpp:48
strings_func.h
WN_CONFIRM_POPUP_QUERY_BOOTSTRAP
@ WN_CONFIRM_POPUP_QUERY_BOOTSTRAP
Query popup confirm for bootstrap.
Definition: window_type.h:25
ClientNetworkContentSocketHandler::Connect
void Connect()
Connect with the content server.
Definition: network_content.cpp:757
video_driver.hpp
NWidget
static NWidgetPart NWidget(WidgetType tp, Colours col, int16 idx=-1)
Widget part function for starting a new 'real' widget.
Definition: widget_type.h:1113
geometry_func.hpp
SetMinimalSize
static NWidgetPart SetMinimalSize(int16 x, int16 y)
Widget part function for setting the minimal size.
Definition: widget_type.h:946
WC_NETWORK_STATUS_WINDOW
@ WC_NETWORK_STATUS_WINDOW
Network status window; Window numbers:
Definition: window_type.h:485
WWT_PANEL
@ WWT_PANEL
Simple depressed panel.
Definition: widget_type.h:48
network_content_gui.h
BaseMedia< GraphicsSet >::FindSets
static uint FindSets()
Do the scan for files.
Definition: base_media_base.h:189
ClientNetworkContentSocketHandler::Select
void Select(ContentID cid)
Select a specific content id.
Definition: network_content.cpp:829
openttd.h
NWID_SPACER
@ NWID_SPACER
Invisible widget that takes some space.
Definition: widget_type.h:77
BootstrapAskForDownloadWindow::OnConnect
void OnConnect(bool success) override
Callback for when the connection has finished.
Definition: bootstrap_gui.cpp:190
InitializeUnicodeGlyphMap
static void InitializeUnicodeGlyphMap()
Initialize the glyph map.
Definition: fontcache.h:182
ClientNetworkContentSocketHandler::AddCallback
void AddCallback(ContentCallback *cb)
Add a callback to this class.
Definition: network_content.h:141
network.h
window_func.h
CheckForMissingGlyphs
void CheckForMissingGlyphs(bool base_font, MissingGlyphSearcher *searcher)
Check whether the currently loaded language pack uses characters that the currently loaded font does ...
Definition: strings.cpp:2101
WID_BAFD_YES
@ WID_BAFD_YES
An affirmative answer to the question.
Definition: bootstrap_widget.h:21
lengthof
#define lengthof(x)
Return the length of an fixed size array.
Definition: stdafx.h:367
BootstrapBackground::DrawWidget
void DrawWidget(const Rect &r, int widget) const override
Draw the contents of a nested widget.
Definition: bootstrap_gui.cpp:57
WDP_MANUAL
@ WDP_MANUAL
Manually align the window (so no automatic location finding)
Definition: window_gui.h:153
VideoDriver::MainLoop
virtual void MainLoop()=0
Perform the actual drawing.
ContentID
ContentID
Unique identifier for the content.
Definition: tcp_content.h:49
fontcache.h
Window
Data structure for an opened window.
Definition: window_gui.h:276
BaseMedia< GraphicsSet >::GetUsedSet
static const GraphicsSet * GetUsedSet()
Return the used set.
Definition: base_media_func.h:357
_network_available
bool _network_available
is network mode available?
Definition: network.cpp:54
_bootstrap_download_status_window_desc
static WindowDesc _bootstrap_download_status_window_desc(WDP_CENTER, nullptr, 0, 0, WC_NETWORK_STATUS_WINDOW, WC_NONE, WDF_MODAL, _nested_boostrap_download_status_window_widgets, lengthof(_nested_boostrap_download_status_window_widgets))
Window description for the download window.
ContentInfo::id
ContentID id
Unique (server side) ID for the content.
Definition: tcp_content.h:66
Rect
Specification of a rectangle with absolute coordinates of all edges.
Definition: geometry_type.hpp:47
BootstrapAskForDownloadWindow::~BootstrapAskForDownloadWindow
~BootstrapAskForDownloadWindow()
Stop listening to the content client events.
Definition: bootstrap_gui.cpp:138
CLRBITS
#define CLRBITS(x, y)
Clears several bits in a variable.
Definition: bitmath_func.hpp:166
WDP_CENTER
@ WDP_CENTER
Center the window.
Definition: window_gui.h:155
BootstrapContentDownloadStatusWindow
Window for showing the download status of content.
Definition: bootstrap_gui.cpp:82
SetMinimalTextLines
static NWidgetPart SetMinimalTextLines(uint8 lines, uint8 spacing, FontSize size=FS_NORMAL)
Widget part function for setting the minimal text lines.
Definition: widget_type.h:964
BootstrapAskForDownloadWindow::OnReceiveContentInfo
void OnReceiveContentInfo(const ContentInfo *ci) override
We received a content info.
Definition: bootstrap_gui.cpp:196
ResizeWindow
void ResizeWindow(Window *w, int delta_x, int delta_y, bool clamp_to_screen)
Resize the window.
Definition: window.cpp:2153
BootstrapAskForDownloadWindow::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: bootstrap_gui.cpp:143
BaseMedia< GraphicsSet >::SetSet
static bool SetSet(const std::string &name)
Set the set to be used.
Definition: base_media_func.h:228