4 * This file is part of OpenTTD.
5 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
6 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
7 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
10 /** @file bootstrap_gui.cpp Barely used user interface for bootstrapping OpenTTD, i.e. downloading the required content. */
13 #include "base_media_base.h"
14 #include "blitter/factory.hpp"
16 #if defined(ENABLE_NETWORK) && defined(WITH_FREETYPE)
18 #include "core/geometry_func.hpp"
19 #include "fontcache.h"
21 #include "network/network.h"
22 #include "network/network_content_gui.h"
24 #include "strings_func.h"
25 #include "video/video_driver.hpp"
26 #include "window_func.h"
28 #include "widgets/bootstrap_widget.h"
30 #include "table/strings.h"
32 /** Widgets for the background window to prevent smearing. */
33 static const struct NWidgetPart _background_widgets
[] = {
34 NWidget(WWT_PANEL
, COLOUR_DARK_BLUE
, WID_BB_BACKGROUND
), SetResize(1, 1),
38 * Window description for the background window to prevent smearing.
40 static WindowDesc
_background_desc(
41 WDP_MANUAL
, NULL
, 0, 0,
42 WC_BOOTSTRAP
, WC_NONE
,
44 _background_widgets
, lengthof(_background_widgets
)
47 /** The background for the game. */
48 class BootstrapBackground
: public Window
{
50 BootstrapBackground() : Window(&_background_desc
)
53 CLRBITS(this->flags
, WF_WHITE_BORDER
);
54 ResizeWindow(this, _screen
.width
, _screen
.height
);
57 virtual void DrawWidget(const Rect
&r
, int widget
) const
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
);
64 /** Nested widgets for the download window. */
65 static const NWidgetPart _nested_boostrap_download_status_window_widgets
[] = {
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
),
68 NWidget(NWID_SPACER
), SetMinimalSize(350, 0), SetMinimalTextLines(3, WD_FRAMERECT_TOP
+ WD_FRAMERECT_BOTTOM
+ 30),
72 /** Window description for the download window */
73 static WindowDesc
_bootstrap_download_status_window_desc(
74 WDP_CENTER
, NULL
, 0, 0,
75 WC_NETWORK_STATUS_WINDOW
, WC_NONE
,
77 _nested_boostrap_download_status_window_widgets
, lengthof(_nested_boostrap_download_status_window_widgets
)
81 /** Window for showing the download status of content */
82 struct BootstrapContentDownloadStatusWindow
: public BaseNetworkContentDownloadStatusWindow
{
84 /** Simple call the constructor of the superclass. */
85 BootstrapContentDownloadStatusWindow() : BaseNetworkContentDownloadStatusWindow(&_bootstrap_download_status_window_desc
)
89 virtual void OnDownloadComplete(ContentID cid
)
91 /* We have completed downloading. We can trigger finding the right set now. */
92 BaseGraphics::FindSets();
94 /* And continue going into the menu. */
97 /* _exit_game is used to break out of the outer video driver's MainLoop. */
103 /** The widgets for the query. It has no close box as that sprite does not exist yet. */
104 static const NWidgetPart _bootstrap_query_widgets
[] = {
105 NWidget(NWID_HORIZONTAL
),
106 NWidget(WWT_CAPTION
, COLOUR_GREY
), SetDataTip(STR_MISSING_GRAPHICS_SET_CAPTION
, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS
),
108 NWidget(WWT_PANEL
, COLOUR_GREY
),
109 NWidget(WWT_PANEL
, COLOUR_GREY
, WID_BAFD_QUESTION
), EndContainer(),
110 NWidget(NWID_HORIZONTAL
),
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
),
117 /** The window description for the query. */
118 static WindowDesc
_bootstrap_query_desc(
119 WDP_CENTER
, NULL
, 0, 0,
120 WC_CONFIRM_POPUP_QUERY
, WC_NONE
,
122 _bootstrap_query_widgets
, lengthof(_bootstrap_query_widgets
)
125 /** The window for the query. It can't use the generic query window as that uses sprites that don't exist yet. */
126 class BootstrapAskForDownloadWindow
: public Window
, ContentCallback
{
127 Dimension button_size
; ///< The dimension of the button
130 /** Start listening to the content client events. */
131 BootstrapAskForDownloadWindow() : Window(&_bootstrap_query_desc
)
133 this->InitNested(WN_CONFIRM_POPUP_QUERY_BOOTSTRAP
);
134 _network_content_client
.AddCallback(this);
137 /** Stop listening to the content client events. */
138 ~BootstrapAskForDownloadWindow()
140 _network_content_client
.RemoveCallback(this);
143 virtual void UpdateWidgetSize(int widget
, Dimension
*size
, const Dimension
&padding
, Dimension
*fill
, Dimension
*resize
)
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
;
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
;
161 *size
= this->button_size
;
166 virtual void DrawWidget(const Rect
&r
, int widget
) const
168 if (widget
!= 0) return;
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
);
173 virtual void OnClick(Point pt
, int widget
, int click_count
)
177 /* We got permission to connect! Yay! */
178 _network_content_client
.Connect();
190 virtual void OnConnect(bool success
)
192 /* Once connected, request the metadata. */
193 _network_content_client
.RequestContentList(CONTENT_TYPE_BASE_GRAPHICS
);
196 virtual void OnReceiveContentInfo(const ContentInfo
*ci
)
198 /* And once the meta data is received, start downloading it. */
199 _network_content_client
.Select(ci
->id
);
200 new BootstrapContentDownloadStatusWindow();
205 #endif /* defined(ENABLE_NETWORK) && defined(WITH_FREETYPE) */
208 * Handle all procedures for bootstrapping OpenTTD without a base graphics set.
209 * This requires all kinds of trickery that is needed to avoid the use of
210 * sprites from the base graphics set which are pretty interwoven.
211 * @return True if a base set exists, otherwise false.
213 bool HandleBootstrap()
215 if (BaseGraphics::GetUsedSet() != NULL
) return true;
217 /* No user interface, bail out with an error. */
218 if (BlitterFactoryBase::GetCurrentBlitter()->GetScreenDepth() == 0) goto failure
;
220 /* If there is no network or no freetype, then there is nothing we can do. Go straight to failure. */
221 #if defined(ENABLE_NETWORK) && defined(WITH_FREETYPE) && (defined(WITH_FONTCONFIG) || defined(WIN32) || defined(__APPLE__))
222 if (!_network_available
) goto failure
;
224 /* First tell the game we're bootstrapping. */
225 _game_mode
= GM_BOOTSTRAP
;
227 /* Initialise the freetype font code. */
228 InitializeUnicodeGlyphMap();
229 /* Next "force" finding a suitable freetype font as the local font is missing. */
230 CheckForMissingGlyphs(false);
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. */
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
;
242 /* Finally ask the question. */
243 new BootstrapBackground();
244 new BootstrapAskForDownloadWindow();
246 /* Process the user events. */
247 _video_driver
->MainLoop();
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;
255 /* Try to probe the graphics. Should work this time. */
256 if (!BaseGraphics::SetSet(NULL
)) goto failure
;
258 /* Finally we can continue heading for the menu. */
259 _game_mode
= GM_MENU
;
263 /* Failure to get enough working to get a graphics set. */
265 usererror("Failed to find a graphics set. Please acquire a graphics set for OpenTTD. See section 4.1 of readme.txt.");