The Battle for Wesnoth  1.15.1+dev
loading_screen.cpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2016 - 2018 by the Battle for Wesnoth Project https://www.wesnoth.org/
3 
4  This program is free software; you can redistribute it and/or modify
5  it under the terms of the GNU General Public License as published by
6  the Free Software Foundation; either version 2 of the License, or
7  (at your option) any later version.
8  This program is distributed in the hope that it will be useful,
9  but WITHOUT ANY WARRANTY.
10 
11  See the COPYING file for more details.
12 */
13 
14 /**
15  * @file
16  * Screen with logo and loading status info during program-startup.
17  */
18 
19 #define GETTEXT_DOMAIN "wesnoth-lib"
20 
22 
23 #include "cursor.hpp"
24 #include "gettext.hpp"
26 #include "gui/core/timer.hpp"
27 #include "gui/widgets/label.hpp"
28 #include "gui/widgets/settings.hpp"
29 #include "gui/widgets/window.hpp"
30 #include "log.hpp"
31 #include "preferences/general.hpp"
32 #include "utils/functional.hpp"
33 #include "video.hpp"
34 
35 #include <chrono>
36 #include <cstdlib>
37 
38 static lg::log_domain log_loadscreen("loadscreen");
39 #define ERR_LS LOG_STREAM(err, log_loadscreen)
40 #define WRN_LS LOG_STREAM(warn, log_loadscreen)
41 
42 static const std::map<loading_stage, std::string> stage_names {
43  { loading_stage::build_terrain, N_("Building terrain rules") },
44  { loading_stage::create_cache, N_("Reading files and creating cache") },
45  { loading_stage::init_display, N_("Initializing display") },
46  { loading_stage::init_fonts, N_("Reinitialize fonts for the current language") },
47  { loading_stage::init_teams, N_("Initializing teams") },
48  { loading_stage::init_theme, N_("Initializing display") },
49  { loading_stage::load_config, N_("Loading game configuration") },
50  { loading_stage::load_data, N_("Loading data files") },
51  { loading_stage::load_level, N_("Loading level") },
52  { loading_stage::init_lua, N_("Initializing scripting engine") },
53  { loading_stage::init_whiteboard, N_("Initializing planning mode") },
54  { loading_stage::load_unit_types, N_("Reading unit files") },
55  { loading_stage::load_units, N_("Loading units") },
56  { loading_stage::refresh_addons, N_("Searching for installed add-ons") },
57  { loading_stage::start_game, N_("Starting game") },
58  { loading_stage::verify_cache, N_("Verifying cache") },
59  { loading_stage::connect_to_server, N_("Connecting to server") },
60  { loading_stage::login_response, N_("Logging in") },
61  { loading_stage::waiting, N_("Waiting for server") },
62  { loading_stage::redirect, N_("Connecting to redirected server") },
63  { loading_stage::next_scenario, N_("Waiting for next scenario") },
64  { loading_stage::download_level_data, N_("Getting game data") },
65  { loading_stage::download_lobby_data, N_("Downloading lobby data") },
66 };
67 
68 namespace gui2
69 {
70 namespace dialogs
71 {
72 REGISTER_DIALOG(loading_screen)
73 
74 loading_screen* loading_screen::singleton_ = nullptr;
75 
76 loading_screen::loading_screen(std::function<void()> f)
77  : animation_counter_(0)
78  , load_func_(f)
79  , worker_result_()
80  , cursor_setter_()
81  , progress_stage_label_(nullptr)
82  , animation_label_(nullptr)
83  , current_stage_(loading_stage::none)
84  , visible_stages_()
85  , animation_stages_()
86  , current_visible_stage_()
87 {
88  for(const auto& pair : stage_names) {
89  visible_stages_[pair.first] = t_string(pair.second, "wesnoth-lib") + "...";
90  }
91 
92  animation_stages_.reserve(20);
93 
94  for(int i = 0; i != 20; ++i) {
95  std::string s(20, ' ');
96  s[i] = '.';
97  animation_stages_.push_back(std::move(s));
98  }
99 
101  singleton_ = this;
102 }
103 
105 {
106  window.set_enter_disabled(true);
107  window.set_escape_disabled(true);
108 
110 
111  if(load_func_) {
112  // Run the load function in its own thread.
113  try {
114  worker_result_ = std::async(std::launch::async, [this]() {
115  try {
116  load_func_();
117  } catch(...) {
118  // TODO: guard this with a mutex.
119  exception_ = std::current_exception();
120  }
121  });
122  } catch(const std::system_error& e) {
123  ERR_LS << "Failed to create worker thread: " << e.what() << "\n";
124  throw;
125  }
126  }
127 
128  progress_stage_label_ = find_widget<label>(&window, "status", false, true);
129  animation_label_ = find_widget<label>(&window, "test_animation", false, true);
130 
131  // Add a draw callback to handle the animation, et al.
132  window.connect_signal<event::DRAW>(
134 }
135 
137 {
138  cursor_setter_.reset();
139 }
140 
142 {
143  if(singleton_ && stage != loading_stage::none) {
144  singleton_->current_stage_.store(stage, std::memory_order_release);
145  }
146 }
147 
149 {
150  if(!load_func_ || loading_complete()) {
151  if(exception_) {
152  std::rethrow_exception(exception_);
153  }
154 
155  get_window()->close();
156  }
157 }
158 
160 {
161  loading_stage stage = current_stage_.load(std::memory_order_acquire);
162 
163  if(stage != loading_stage::none && (current_visible_stage_ == visible_stages_.end() || stage != current_visible_stage_->first)) {
164  auto iter = visible_stages_.find(stage);
165  if(iter == visible_stages_.end()) {
166  WRN_LS << "Stage missing description." << std::endl;
167  return;
168  }
169 
170  current_visible_stage_ = iter;
171  progress_stage_label_->set_label(iter->second);
172  }
173 
175  if(animation_counter_ % 2 == 0) {
177  }
178 }
179 
181 {
182  /* If the worker thread is running, exit the application to prevent memory corruption.
183  * TODO: this is still not optimal. The main problem is that this code assumes that this
184  * happened because the window was closed, which is not necessarily the case (other
185  * possibilities might be a 'dialog doesn't fit on screen' exception caused by resizing
186  * the window).
187  *
188  * Another approach might be to add exit points (boost::this_thread::interruption_point())
189  * to the worker functions (filesystem.cpp, config parsing code, etc.) and then use that
190  * to end the thread faster.
191  */
192  if(!loading_complete()) {
193 #if defined(_LIBCPP_VERSION) || defined(__MINGW32__)
194  std::_Exit(0);
195 #else
196  std::quick_exit(0);
197 #endif
198  }
199 
200  singleton_ = nullptr;
201 }
202 
203 void loading_screen::display(std::function<void()> f)
204 {
205  const bool use_loadingscreen_animation = !preferences::disable_loadingscreen_animation();
206 
207  if(singleton_ || CVideo::get_singleton().faked()) {
208  f();
209  } else if(use_loadingscreen_animation) {
210  loading_screen(f).show();
211  } else {
212  loading_screen(std::function<void()>()).show();
213  f();
214  }
215 }
216 
218 {
219  using namespace std::chrono_literals;
220  return worker_result_.wait_for(0ms) == std::future_status::ready;
221 }
222 
223 } // namespace dialogs
224 } // namespace gui2
virtual void pre_show(window &window) override
Inherited from modal_dialog.
static lg::log_domain log_loadscreen("loadscreen")
#define WRN_LS
void close()
Requests to close the window.
Definition: window.hpp:183
stage_map::const_iterator current_visible_stage_
std::atomic< loading_stage > current_stage_
This file contains the window object, this object is a top level container which has the event manage...
static void progress(loading_stage stage=loading_stage::none)
static CVideo & get_singleton()
Definition: video.hpp:43
void set_escape_disabled(const bool escape_disabled)
Disable the escape key.
Definition: window.hpp:300
window * get_window() const
Returns a pointer to the dialog&#39;s window.
std::enable_if_t< has_key< set_event, E >::value > connect_signal(const signal_function &signal, const queue_position position=back_child)
Connect a signal for callback in set_event.
Definition: dispatcher.hpp:393
#define ERR_LS
-file util.hpp
Generic file dialog.
Definition: field-fwd.hpp:22
loading_stage
Loading screen stage IDs.
virtual void set_label(const t_string &label)
std::vector< t_string > animation_stages_
static const std::map< loading_stage, std::string > stage_names
This file contains the settings handling of the widget library.
Periodic redraw request.
Definition: handler.hpp:57
std::future< void > worker_result_
bool loading_complete() const
Checks whether the worker thread has returned and loading is complete.
Various uncategorised dialogs.
virtual void process(events::pump_info &) override
Inherited from events::pump_monitor.
std::size_t i
Definition: function.cpp:933
static map_location::DIRECTION s
virtual void post_show(window &window) override
Inherited from modal_dialog.
Contains the gui2 timer routines.
void draw_callback()
Callback to handle drawing the progress animation.
#define N_(String)
Definition: gettext.hpp:99
std::unique_ptr< cursor::setter > cursor_setter_
static loading_screen * singleton_
bool disable_loadingscreen_animation()
Definition: general.cpp:1057
static void display(std::function< void()> f)
#define f
std::function< void()> load_func_
Standard logging facilities (interface).
#define e
loading_screen(std::function< void()> f)
base class of top level items, the only item which needs to store the final canvases to draw on ...
Definition: window.hpp:63
void set_enter_disabled(const bool enter_disabled)
Disable the enter key.
Definition: window.hpp:287