The Battle for Wesnoth  1.15.0-dev
game_launcher.cpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2003 - 2018 by David White <dave@whitevine.net>
3  Part of the Battle for Wesnoth Project https://www.wesnoth.org/
4 
5  This program is free software; you can redistribute it and/or modify
6  it under the terms of the GNU General Public License as published by
7  the Free Software Foundation; either version 2 of the License, or
8  (at your option) any later version.
9  This program is distributed in the hope that it will be useful,
10  but WITHOUT ANY WARRANTY.
11 
12  See the COPYING file for more details.
13 */
14 
15 #include "game_launcher.hpp"
16 #include "game_errors.hpp"
17 
18 #include "ai/manager.hpp" // for manager
20 #include "commandline_options.hpp" // for commandline_options
21 #include "config.hpp" // for config, etc
22 #include "cursor.hpp" // for set, CURSOR_TYPE::NORMAL
23 #include "exceptions.hpp" // for error
24 #include "filesystem.hpp" // for get_user_config_dir, etc
25 #include "game_classification.hpp" // for game_classification, etc
26 #include "game_config.hpp" // for path, no_delay, revision, etc
27 #include "game_config_manager.hpp" // for game_config_manager
28 #include "game_end_exceptions.hpp" // for LEVEL_RESULT, etc
29 #include "generators/map_generator.hpp" // for mapgen_exception
30 #include "gettext.hpp" // for _
32 #include "gui/dialogs/language_selection.hpp" // for language_selection
34 #include "gui/dialogs/message.hpp" //for show error message
36 #include "gui/dialogs/multiplayer/mp_host_game_prompt.hpp" //for host game prompt
38 #include "gui/dialogs/outro.hpp"
40 #include "gui/dialogs/transient_message.hpp" // for show_transient_message
41 #include "gui/dialogs/title_screen.hpp" // for show_debug_clock_button
42 #include "gui/widgets/settings.hpp" // for new_widgets
43 #include "gui/widgets/retval.hpp" // for window, etc
44 #include "language.hpp" // for language_def, etc
45 #include "log.hpp" // for LOG_STREAM, logger, general, etc
46 #include "map/exception.hpp"
47 #include "game_initialization/multiplayer.hpp" // for start_client, etc
49 #include "game_initialization/playcampaign.hpp" // for play_game, etc
50 #include "preferences/general.hpp" // for disable_preferences_save, etc
51 #include "preferences/display.hpp"
52 #include "savegame.hpp" // for clean_saves, etc
54 #include "sdl/surface.hpp" // for surface
55 #include "serialization/compression.hpp" // for format::NONE
56 #include "serialization/string_utils.hpp" // for split
57 #include "game_initialization/singleplayer.hpp" // for sp_create_mode
58 #include "statistics.hpp"
59 #include "tstring.hpp" // for operator==, operator!=
60 #include "utils/general.hpp" // for clamp
61 #include "video.hpp" // for CVideo
63 #include "wml_exception.hpp" // for wml_exception
64 
65 #include <algorithm> // for copy, max, min, stable_sort
66 #include <cstdlib> // for system
67 #include <iostream> // for operator<<, basic_ostream, etc
68 #include <new>
69 #include <utility> // for pair
70 #include <SDL.h> // for SDL_INIT_JOYSTICK, etc
71 
72 #ifdef DEBUG_WINDOW_LAYOUT_GRAPHS
73 #include "gui/widgets/debug.hpp"
74 #endif
75 
76 // For wesnothd launch code.
77 #ifdef _WIN32
78 
79 #define WIN32_LEAN_AND_MEAN
80 #include <windows.h>
81 
82 #endif // _WIN32
83 
85 
86 static lg::log_domain log_config("config");
87 #define ERR_CONFIG LOG_STREAM(err, log_config)
88 #define WRN_CONFIG LOG_STREAM(warn, log_config)
89 #define LOG_CONFIG LOG_STREAM(info, log_config)
90 
91 #define LOG_GENERAL LOG_STREAM(info, lg::general())
92 #define WRN_GENERAL LOG_STREAM(warn, lg::general())
93 #define DBG_GENERAL LOG_STREAM(debug, lg::general())
94 
95 static lg::log_domain log_mp_create("mp/create");
96 #define DBG_MP LOG_STREAM(debug, log_mp_create)
97 
98 static lg::log_domain log_network("network");
99 #define ERR_NET LOG_STREAM(err, log_network)
100 
101 static lg::log_domain log_enginerefac("enginerefac");
102 #define LOG_RG LOG_STREAM(info, log_enginerefac)
103 
104 game_launcher::game_launcher(const commandline_options& cmdline_opts, const char *appname) :
105  cmdline_opts_(cmdline_opts),
106  video_(new CVideo()),
107  font_manager_(),
108  prefs_manager_(),
109  image_manager_(),
110  main_event_context_(),
111  hotkey_manager_(),
112  music_thinker_(),
113  music_muter_(),
114  test_scenario_("test"),
115  screenshot_map_(),
116  screenshot_filename_(),
117  state_(),
118  play_replay_(false),
119  multiplayer_server_(),
120  jump_to_multiplayer_(false),
121  jump_to_campaign_(false, false, -1, "", ""),
122  jump_to_editor_(false),
123  load_data_()
124 {
125  bool no_music = false;
126  bool no_sound = false;
127 
128  // The path can be hardcoded and it might be a relative path.
129  if(!game_config::path.empty() &&
130 #ifdef _WIN32
131  // use c_str to ensure that index 1 points to valid element since c_str() returns null-terminated string
132  game_config::path.c_str()[1] != ':'
133 #else
134  game_config::path[0] != '/'
135 #endif
136  )
137  {
139  // font_manager_.update_font_path()
140  // To update the font path, destroy and recreate the manager
142  new (&font_manager_) font::manager();
143  }
144 
145  const std::string app_basename = filesystem::base_name(appname);
146  jump_to_editor_ = app_basename.find("editor") != std::string::npos;
147 
148  if (cmdline_opts_.core_id) {
150  }
151  if (cmdline_opts_.campaign) {
152  jump_to_campaign_.jump_ = true;
154  std::cerr << "selected campaign id: [" << jump_to_campaign_.campaign_id_ << "]\n";
155 
158  std::cerr << "selected difficulty: [" << jump_to_campaign_.difficulty_ << "]\n";
159  }
160  else
161  jump_to_campaign_.difficulty_ = -1; // let the user choose the difficulty
162 
165  std::cerr << "selected scenario id: [" << jump_to_campaign_.scenario_id_ << "]\n";
166  }
167 
170  }
171  }
172  if (cmdline_opts_.clock)
174  if (cmdline_opts_.debug) {
176  game_config::mp_debug = true;
177  }
178 #ifdef DEBUG_WINDOW_LAYOUT_GRAPHS
179  if (cmdline_opts_.debug_dot_domain)
180  gui2::debug_layout_graph::set_domain (*cmdline_opts_.debug_dot_domain);
181  if (cmdline_opts_.debug_dot_level)
183 #endif
184  if (cmdline_opts_.editor)
185  {
186  jump_to_editor_ = true;
187  if (!cmdline_opts_.editor->empty())
188  load_data_.reset(new savegame::load_game_metadata{ *cmdline_opts_.editor });
189  }
190  if (cmdline_opts_.fps)
193  video().set_fullscreen(true);
194  if (cmdline_opts_.load)
196  if (cmdline_opts_.max_fps) {
197  int fps = utils::clamp(*cmdline_opts_.max_fps, 1, 1000);
198  fps = 1000 / fps;
199  // increase the delay to avoid going above the maximum
200  if(1000 % fps != 0) {
201  ++fps;
202  }
204  }
206  no_sound = true;
208  }
210  gui2::new_widgets = true;
212  game_config::no_delay = true;
214  no_music = true;
216  no_sound = true;
218  const int xres = std::get<0>(*cmdline_opts_.resolution);
219  const int yres = std::get<1>(*cmdline_opts_.resolution);
220  if(xres > 0 && yres > 0) {
221  preferences::_set_resolution(point(xres, yres));
223  }
224  }
226  //TODO it could be simplified to use cmdline_opts_ directly if there is no other way to enter screenshot mode
229  no_sound = true;
231  }
232  if (cmdline_opts_.server){
233  jump_to_multiplayer_ = true;
234  //Do we have any server specified ?
235  if (!cmdline_opts_.server->empty())
237  else //Pick the first server in config
238  {
241  else
242  multiplayer_server_ = "";
243  }
244  if (cmdline_opts_.username) {
247  if (cmdline_opts_.password) {
249  preferences::set_password(*cmdline_opts.server, *cmdline_opts.username, *cmdline_opts_.password);
250  }
251  }
252  }
253  if (cmdline_opts_.test)
254  {
255  if (!cmdline_opts_.test->empty())
257  }
259  {
260  if (!cmdline_opts_.unit_test->empty()) {
262  }
263 
264  }
266  video().set_fullscreen(false);
268  load_data_->show_replay = true;
271 
272  std::cerr
273  << "\nData directory: " << filesystem::sanitize_path(game_config::path)
274  << "\nUser configuration directory: " << filesystem::sanitize_path(filesystem::get_user_config_dir())
275  << "\nUser data directory: " << filesystem::sanitize_path(filesystem::get_user_data_dir())
276  << "\nCache directory: " << filesystem::sanitize_path(filesystem::get_cache_dir())
277  << '\n';
278  std::cerr << '\n';
279 
280  // disable sound in nosound mode, or when sound engine failed to initialize
281  if (no_sound || ((preferences::sound_on() || preferences::music_on() ||
283  !sound::init_sound())) {
284  preferences::set_sound(false);
285  preferences::set_music(false);
288  }
289  else if (no_music) { // else disable the music in nomusic mode
290  preferences::set_music(false);
291  }
292 }
293 
295 {
297  return false;
298 
299  if(SDL_WasInit(SDL_INIT_JOYSTICK) == 0)
300  if(SDL_InitSubSystem(SDL_INIT_JOYSTICK) == -1)
301  return false;
302 
303  int joysticks = SDL_NumJoysticks();
304  if (joysticks == 0) return false;
305 
306  SDL_JoystickEventState(SDL_ENABLE);
307 
308  bool joystick_found = false;
309  for (int i = 0; i<joysticks; i++) {
310 
311  if (SDL_JoystickOpen(i))
312  joystick_found = true;
313  }
314  return joystick_found;
315 }
316 
318 {
319  if(!::load_language_list())
320  return false;
321 
322  language_def locale;
323  if(cmdline_opts_.language) {
324  std::vector<language_def> langs = get_languages();
325  for(const language_def & def : langs) {
326  if(def.localename == *cmdline_opts_.language) {
327  locale = def;
328  break;
329  }
330  }
331  if(locale.localename.empty()) {
332  std::cerr << "Language symbol '" << *cmdline_opts_.language << "' not found.\n";
333  return false;
334  }
335  } else {
336  locale = get_locale();
337  }
338  ::set_language(locale);
339 
340  return true;
341 }
342 
344 {
345  // Handle special commandline launch flags
348  std::cerr << "--nogui flag is only valid with --multiplayer or --screenshot or --plugin flags\n";
349  return false;
350  }
351  video().make_fake();
352  game_config::no_delay = true;
353  return true;
354  }
355 
356  // Initialize a new window
357  video().init_window();
358 
359  // Set window title and icon
361 
362 #if !(defined(__APPLE__))
363  surface icon(image::get_image("icons/icon-game.png", image::UNSCALED));
364  if(icon != nullptr) {
365 
366  video().set_window_icon(icon);
367  }
368 #endif
369  return true;
370 }
371 
373 {
374  bool error = false;
375 
376  std::cerr << "Checking lua scripts... ";
377 
379  plugins_manager::get()->get_kernel_base()->load_package(); //load the "package" package, so that scripts can get what packages they want
380  }
381 
382  // get the application lua kernel, load and execute script file, if script file is present
384  {
386 
387  if (!sf->fail()) {
388  /* Cancel all "jumps" to editor / campaign / multiplayer */
389  jump_to_multiplayer_ = false;
390  jump_to_editor_ = false;
391  jump_to_campaign_.jump_ = false;
392 
393  std::string full_script((std::istreambuf_iterator<char>(*sf)), std::istreambuf_iterator<char>());
394 
395  std::cerr << "\nRunning lua script: " << *cmdline_opts_.script_file << std::endl;
396 
397  plugins_manager::get()->get_kernel_base()->run(full_script.c_str());
398  } else {
399  std::cerr << "Encountered failure when opening script '" << *cmdline_opts_.script_file << "'\n";
400  error = true;
401  }
402  }
403 
405  {
406  std::string filename = *cmdline_opts_.plugin_file;
407 
408  std::cerr << "Loading a plugin file'" << filename << "'...\n";
409 
411 
412  try {
413  if (sf->fail()) {
414  throw std::runtime_error("failed to open plugin file");
415  }
416 
417  /* Cancel all "jumps" to editor / campaign / multiplayer */
418  jump_to_multiplayer_ = false;
419  jump_to_editor_ = false;
420  jump_to_campaign_.jump_ = false;
421 
422  std::string full_plugin((std::istreambuf_iterator<char>(*sf)), std::istreambuf_iterator<char>());
423 
425 
426  std::size_t i = pm.add_plugin(filename, full_plugin);
427 
428  for (std::size_t j = 0 ; j < pm.size(); ++j) {
429  std::cerr << j << ": " << pm.get_name(j) << " -- " << pm.get_detailed_status(j) << std::endl;
430  }
431 
432  std::cerr << "Starting a plugin...\n";
433  pm.start_plugin(i);
434 
435  for (std::size_t j = 0 ; j < pm.size(); ++j) {
436  std::cerr << j << ": " << pm.get_name(j) << " -- " << pm.get_detailed_status(j) << std::endl;
437  }
438 
439  plugins_context pc("init");
440 
441  for (std::size_t repeat = 0; repeat < 5; ++repeat) {
442  std::cerr << "Playing a slice...\n";
443  pc.play_slice();
444 
445  for (std::size_t j = 0 ; j < pm.size(); ++j) {
446  std::cerr << j << ": " << pm.get_name(j) << " -- " << pm.get_detailed_status(j) << std::endl;
447  }
448  }
449 
450  return true;
451  } catch (const std::exception & e) {
452  gui2::show_error_message(std::string("When loading a plugin, error:\n") + e.what());
453  error = true;
454  }
455  }
456 
457  if (!error) {
458  std::cerr << "ok\n";
459  }
460 
461  return !error;
462 }
463 
464 void game_launcher::set_test(const std::string& id)
465 {
466  state_.clear();
467  state_.classification().campaign_type = game_classification::CAMPAIGN_TYPE::TEST;
469 
470  state_.mp_settings().mp_era = "era_default";
471 
473  config {"next_scenario", id}
474  );
475 }
476 
478 {
479  static bool first_time = true;
480 
481  if(!cmdline_opts_.test) {
482  return true;
483  }
484  if(!first_time)
485  return false;
486 
487  first_time = false;
488 
491 
493  load_game_config_for_game(state_.classification());
494 
495  try {
496  campaign_controller ccontroller(state_, game_config_manager::get()->terrain_types());
497  ccontroller.play_game();
498  } catch(const savegame::load_game_exception &e) {
499  load_data_.reset(new savegame::load_game_metadata(std::move(e.data_)));
500  return true;
501  }
502 
503  return false;
504 }
505 
506 // Same as play_test except that we return the results of play_game.
508 {
509  static bool first_time_unit = true;
510 
511  if(!cmdline_opts_.unit_test) {
512  return 0;
513  }
514  if(!first_time_unit)
515  return 0;
516 
517  first_time_unit = false;
518 
519  state_.classification().campaign_type = game_classification::CAMPAIGN_TYPE::TEST;
522  config {"next_scenario", test_scenario_}
523  );
524 
525 
527  load_game_config_for_game(state_.classification());
528 
529  try {
530  campaign_controller ccontroller(state_, game_config_manager::get()->terrain_types(), true);
531  LEVEL_RESULT res = ccontroller.play_game();
532  if (!(res == LEVEL_RESULT::VICTORY) || lg::broke_strict()) {
533  return 1;
534  }
535  } catch(const wml_exception& e) {
536  std::cerr << "Caught WML Exception:" << e.dev_message << std::endl;
537  return 1;
538  }
539 
541 
543  return 0; //we passed, huzzah!
544 
546  save.save_game_automatic(false, "unit_test_replay"); //false means don't check for overwrite
547 
548  load_data_.reset(new savegame::load_game_metadata{ "unit_test_replay" , "", true, true, false });
549 
550  if (!load_game()) {
551  std::cerr << "Failed to load the replay!" << std::endl;
552  return 3; //failed to load replay
553  }
554 
555  try {
556  campaign_controller ccontroller(state_, game_config_manager::get()->terrain_types(), true);
557  LEVEL_RESULT res = ccontroller.play_replay();
558  if (!(res == LEVEL_RESULT::VICTORY) || lg::broke_strict()) {
559  std::cerr << "Observed failure on replay" << std::endl;
560  return 4;
561  }
562  } catch(const wml_exception& e) {
563  std::cerr << "WML Exception while playing replay: " << e.dev_message << std::endl;
564  return 4; //failed with an error during the replay
565  }
566 
567  return 0; //we passed, huzzah!
568 }
569 
571 {
573  return true;
574  }
575 
577 
579 
581  return false;
582 }
583 
585 {
587  return true;
588  }
589 
590  state_.classification().campaign_type = game_classification::CAMPAIGN_TYPE::MULTIPLAYER;
591  DBG_GENERAL << "Current campaign type: " << state_.classification().campaign_type << std::endl;
592 
593  try {
595  load_game_config_for_game(state_.classification());
596  } catch(const config::error& e) {
597  std::cerr << "Error loading game config: " << e.what() << std::endl;
598  return false;
599  }
600 
601  // A default output filename
602  std::string outfile = "wesnoth_image.bmp";
603 
604  // If a output path was given as an argument, use that instead
606  outfile = *cmdline_opts_.render_image_dst;
607  }
608 
610  exit(1);
611  }
612 
613  return false;
614 }
615 
617 {
618  return !!load_data_;
619 }
620 
622 {
623  assert(game_config_manager::get());
624 
625  DBG_GENERAL << "Current campaign type: " << state_.classification().campaign_type << std::endl;
626 
628  if (load_data_) {
629  std::unique_ptr<savegame::load_game_metadata> load_data = std::move(load_data_);
630  load.data() = std::move(*load_data);
631  }
632 
633  try {
634  if(!load.load_game()) {
635  return false;
636  }
637 
638  try {
640  load_game_config_for_game(state_.classification());
641  } catch(const config::error&) {
642  return false;
643  }
644 
645  load.set_gamestate();
646 
647  } catch(const config::error& e) {
648  if(e.message.empty()) {
649  gui2::show_error_message(_("The file you have tried to load is corrupt"));
650  }
651  else {
652  gui2::show_error_message(_("The file you have tried to load is corrupt: '") + e.message + '\'');
653  }
654  return false;
655  } catch(const wml_exception& e) {
656  e.show();
657  return false;
658  } catch(const filesystem::io_exception& e) {
659  if(e.message.empty()) {
660  gui2::show_error_message(_("File I/O Error while reading the game"));
661  } else {
662  gui2::show_error_message(_("File I/O Error while reading the game: '") + e.message + '\'');
663  }
664  return false;
665  } catch(const game::error& e) {
666  if(e.message.empty()) {
667  gui2::show_error_message(_("The file you have tried to load is corrupt"));
668  }
669  else {
670  gui2::show_error_message(_("The file you have tried to load is corrupt: '") + e.message + '\'');
671  }
672  return false;
673  }
674 
675  play_replay_ = load.data().show_replay;
676  LOG_CONFIG << "is middle game savefile: " << (state_.is_mid_game_save() ? "yes" : "no") << "\n";
677  LOG_CONFIG << "show replay: " << (play_replay_ ? "yes" : "no") << "\n";
678  // in case load.data().show_replay && !state_.is_mid_game_save()
679  // there won't be any turns to replay, but the
680  // user gets to watch the intro sequence again ...
681 
682  if(state_.is_mid_game_save() && load.data().show_replay)
683  {
685  }
686 
687  if(state_.classification().campaign_type == game_classification::CAMPAIGN_TYPE::MULTIPLAYER) {
689  }
690 
691  if (load.data().cancel_orders) {
693  }
694 
695  return true;
696 }
697 
699 {
700  state_.clear();
701  state_.classification().campaign_type = game_classification::CAMPAIGN_TYPE::TUTORIAL;
702  state_.classification().campaign_define = "TUTORIAL";
703  state_.mp_settings().mp_era = "era_default";
705  config {"next_scenario", "tutorial"}
706  );
707 
708 }
709 
710 void game_launcher::mark_completed_campaigns(std::vector<config> &campaigns)
711 {
712  for (config &campaign : campaigns) {
713  campaign["completed"] = preferences::is_campaign_completed(campaign["id"]);
714  }
715 }
716 
718 {
719  state_.clear();
721  play_replay_ = false;
722 
724 }
725 
727 {
729 }
730 
732 {
734  if(new_campaign()) {
736  jump_to_campaign_.jump_ = false;
738  }else{
739  jump_to_campaign_.jump_ = false;
740  return false;
741  }
742  }
743  return true;
744 }
745 
747 {
749  jump_to_multiplayer_ = false;
751  ;
752  }else{
753  return false;
754  }
755  }
756  return true;
757 }
758 
760 {
761  if(jump_to_editor_){
762  jump_to_editor_ = false;
763  std::unique_ptr<savegame::load_game_metadata> load_data = std::move(load_data_);
764  if (start_editor(filesystem::normalize_path(load_data ? load_data->filename : "")) ==
766  {
767  return false;
768  }
769  }
770  return true;
771 }
772 
774 {
775  const std::string wesnothd_program =
778 
779  std::string config = filesystem::get_user_config_dir() + "/lan_server.cfg";
780  if (!filesystem::file_exists(config)) {
781  // copy file if it isn't created yet
783  }
784 
785 #ifndef _WIN32
786  std::string command = "\"" + wesnothd_program +"\" -c \"" + config + "\" -d -t 2 -T 5";
787 #else
788  // start wesnoth as background job
789  std::string command = "cmd /C start \"wesnoth server\" /B \"" + wesnothd_program + "\" -c \"" + config + "\" -t 2 -T 5";
790  // Make sure wesnothd's console output is visible on the console window by
791  // disabling SDL's stdio redirection code for this and future child
792  // processes. No need to bother cleaning this up because it's only
793  // meaningful to SDL applications during pre-main initialization.
794  SetEnvironmentVariableA("SDL_STDIO_REDIRECT", "0");
795 #endif
796  LOG_GENERAL << "Starting wesnothd: "<< command << "\n";
797  if (std::system(command.c_str()) == 0) {
798  // Give server a moment to start up
799  SDL_Delay(50);
800  return;
801  }
803 
804  // Couldn't start server so throw error
805  WRN_GENERAL << "Failed to run server start script" << std::endl;
806  throw game::mp_server_error("Starting MP server failed!");
807 }
808 
810 {
811  state_.clear();
812  state_.classification().campaign_type = game_classification::CAMPAIGN_TYPE::MULTIPLAYER;
813 
814  try {
815  if (res == MP_HOST)
816  {
817  try {
818  start_wesnothd();
819  } catch(const game::mp_server_error&)
820  {
822 
823  try {
824  start_wesnothd();
825  } catch(const game::mp_server_error&)
826  {
827  return false;
828  }
829  }
830 
831 
832  }
833 
834  // If a server address wasn't specified, prompt for it now.
835  if(res != MP_LOCAL && multiplayer_server_.empty()) {
836  if(!gui2::dialogs::mp_connect::execute()) {
837  return false;
838  }
839 
840  // The prompt saves its input to preferences.
842 
843  if(multiplayer_server_ != preferences::server_list().front().address) {
845  }
846  }
847 
848  //create_engine already calls game_config_manager::get()->load_config but maybe its better to have MULTIPLAYER defined while we are in the lobby.
850 
851  events::discard_input(); // prevent the "keylogger" effect
853 
854  if(res == MP_LOCAL) {
857  } else {
860  multiplayer_server_.clear();
861  }
862 
863  } catch(const wesnothd_rejected_client_error& e) {
865  } catch(const game::mp_server_error& e) {
866  gui2::show_error_message(_("Error while starting server: ") + e.message);
867  } catch(const game::load_game_failed& e) {
868  gui2::show_error_message(_("The game could not be loaded: ") + e.message);
869  } catch(const game::game_error& e) {
870  gui2::show_error_message(_("Error while playing the game: ") + e.message);
871  } catch (const mapgen_exception& e) {
872  gui2::show_error_message(_("Map generator error: ") + e.message);
873  } catch(const wesnothd_error& e) {
874  if(!e.message.empty()) {
875  ERR_NET << "caught network error: " << e.message << std::endl;
876 
877  std::string user_msg;
878  auto conn_err = dynamic_cast<const wesnothd_connection_error*>(&e);
879 
880  if(conn_err) {
881  // The wesnothd_connection_error subclass is only thrown with messages
882  // from boost::system::error_code which we can't translate ourselves.
883  // It's also the originator of the infamous EOF error that happens when
884  // the server dies. <https://github.com/wesnoth/wesnoth/issues/3005>. It
885  // will provide a translated string instead of that when it happens.
886  user_msg = !conn_err->user_message.empty()
887  ? conn_err->user_message
888  : _("Connection failed: ") + e.message;
889  } else {
890  // This will be a message from the server itself, which we can
891  // probably translate.
892  user_msg = translation::gettext(e.message.c_str());
893  }
894 
895  gui2::show_error_message(user_msg);
896  } else {
897  ERR_NET << "caught network error" << std::endl;
898  }
899  } catch(const config::error& e) {
900  if(!e.message.empty()) {
901  ERR_CONFIG << "caught config::error: " << e.message << std::endl;
903  } else {
904  ERR_CONFIG << "caught config::error" << std::endl;
905  }
906  } catch(const incorrect_map_format_error& e) {
907  gui2::show_error_message(_("The game map could not be loaded: ") + e.message);
908  } catch (const savegame::load_game_exception & e) {
909  load_data_.reset(new savegame::load_game_metadata(std::move(e.data_)));
910  //this will make it so next time through the title screen loop, this game is loaded
911  } catch(const wml_exception& e) {
912  e.show();
913  } catch (const game::error & e) {
914  std::cerr << "caught game::error...\n";
915  gui2::show_error_message(_("Error: ") + e.message);
916  }
917 
918  return false;
919 }
920 
922 {
924  return true;
925  }
926 
927  DBG_MP << "starting multiplayer game from the commandline" << std::endl;
928 
929  // These are all the relevant lines taken literally from play_multiplayer() above
930  state_.clear();
931  state_.classification().campaign_type = game_classification::CAMPAIGN_TYPE::MULTIPLAYER;
932 
934  load_game_config_for_game(state_.classification());
935 
936  events::discard_input(); // prevent the "keylogger" effect
938 
941 
942  return false;
943 }
944 
946 {
947  if(!gui2::dialogs::language_selection::execute()) {
948  return false;
949  }
950 
953  }
954 
955  return true;
956 }
957 
959 {
961 }
962 
964 {
965  assert(!load_data_);
966  if(play_replay_)
967  {
968  play_replay();
969  return;
970  }
971 
972  gui2::dialogs::loading_screen::display([this, reload]() {
973 
975  if(reload == RELOAD_DATA) {
976  try {
978  load_game_config_for_game(state_.classification());
979  } catch(const config::error&) {
980  return;
981  }
982  }
983  });
984 
985  try {
986  campaign_controller ccontroller(state_, game_config_manager::get()->terrain_types());
987  LEVEL_RESULT result = ccontroller.play_game();
988  ai::manager::singleton_ = nullptr;
989  // don't show The End for multiplayer scenario
990  // change this if MP campaigns are implemented
991  if(result == LEVEL_RESULT::VICTORY && !state_.classification().is_normal_mp_game()) {
993 
994  gui2::dialogs::outro::display(state_.classification().end_text, state_.classification().end_text_duration);
995 
997  gui2::dialogs::end_credits::display(state_.classification().campaign);
998  }
999  }
1000  } catch (const savegame::load_game_exception &e) {
1001  load_data_.reset(new savegame::load_game_metadata(std::move(e.data_)));
1002  //this will make it so next time through the title screen loop, this game is loaded
1003  } catch(const wml_exception& e) {
1004  e.show();
1005  } catch(const mapgen_exception& e) {
1006  gui2::show_error_message(_("Map generator error: ") + e.message);
1007  }
1008 }
1009 
1011 {
1012  assert(!load_data_);
1013  try {
1014  campaign_controller ccontroller(state_, game_config_manager::get()->terrain_types());
1015  ccontroller.play_replay();
1016  } catch (const savegame::load_game_exception &e) {
1017  load_data_.reset(new savegame::load_game_metadata(std::move(e.data_)));
1018  //this will make it so next time through the title screen loop, this game is loaded
1019  } catch(const wml_exception& e) {
1020  e.show();
1021  }
1022 }
1023 
1025 {
1026  while(true){
1028 
1030 
1031  editor::EXIT_STATUS res = editor::start(filename);
1032 
1033  if(res != editor::EXIT_RELOAD_DATA)
1034  return res;
1035 
1037  }
1038  return editor::EXIT_ERROR; // not supposed to happen
1039 }
1040 
1042 {
1043  load_data_.reset();
1044 }
1045 
1047 {
1048  try {
1050  } catch (...) {}
1051 }
boost::optional< std::string > core_id
Non-empty if –core was given on the command line. Chooses the core to be loaded. ...
constexpr const T & clamp(const T &value, const T &min, const T &max)
Definition: general.hpp:31
an error occurred inside the underlying network communication code (boost asio) TODO: find a short na...
CVideo & video()
boost::optional< std::string > script_file
File to load lua script from.
An error occurred during when trying to coommunicate with the wesnothd server.
bool new_widgets
Do we wish to use the new library or not.
Definition: settings.cpp:21
surface get_image(const image::locator &i_locator, TYPE type)
function to get the surface corresponding to an image.
Definition: picture.cpp:1022
unsigned int end_text_duration
for how long the end-of-campaign text is shown
void set_window_icon(surface &icon)
Sets the icon of the main window.
Definition: video.cpp:368
bool set_sound(bool ison)
Definition: general.cpp:665
void close_sound()
Definition: sound.cpp:457
std::string get_program_invocation(const std::string &program_name)
Returns the appropriate invocation for a Wesnoth-related binary, assuming that it is located in the s...
LEVEL_RESULT play_replay()
bool load_game()
Load a game with pre-setting information for the load-game dialog.
Definition: savegame.cpp:158
static lg::log_domain log_mp_create("mp/create")
bool turn_bell()
Definition: general.cpp:607
void discard_input()
Discards all input events.
Definition: events.cpp:741
bool end_credits
whether to show the standard credits at the end
void start_local_game_commandline(const config &game_config, saved_game &state, const commandline_options &cmdline_opts)
Starts a multiplayer game in single-user mode.
Error used when the client is rejected by the MP server.
LEVEL_RESULT play_game()
bool is_mid_game_save() const
Definition: saved_game.hpp:93
bool nogui
True if –nogui was given on the command line. Disables GUI.
The class for loading a savefile.
Definition: savegame.hpp:96
bool script_unsafe_mode
Whether to load the "package" package for the scripting environment. (This allows to load arbitrary l...
void set(CURSOR_TYPE type)
Use the default parameter to reset cursors.
Definition: cursor.cpp:173
void _set_maximized(bool ison)
Definition: general.cpp:407
std::string label
Name of the game (e.g.
void disable_preferences_save()
Definition: general.cpp:248
std::string filename
Name of the savefile to be loaded.
Definition: savegame.hpp:40
void set_gamestate()
Generate the gamestate out of the loaded game config.
Definition: savegame.cpp:262
bool cancel_orders
State of the "cancel_orders" checkbox in the load-game dialog.
Definition: savegame.hpp:49
std::vector< game_tip > load(const config &cfg)
Loads the tips from a config.
Definition: tips.cpp:35
Add a special kind of assert to validate whether the input from WML doesn&#39;t contain any problems that...
#define DBG_MP
static l_noret error(LoadState *S, const char *why)
Definition: lundump.cpp:39
Error used when game loading fails.
Definition: game_errors.hpp:30
void show_wesnothd_server_search()
Definition: display.cpp:150
void show_preferences()
Definition: video.hpp:31
static bool file_exists(const bfs::path &fpath)
Definition: filesystem.cpp:271
bool is_campaign_completed(const std::string &campaign_id)
Definition: game.cpp:322
std::string network_host()
Definition: game.cpp:389
void show_transient_message(const std::string &title, const std::string &message, const std::string &image, const bool message_use_markup, const bool title_use_markup, const bool restore_background)
Shows a transient message to the user.
static void progress(loading_stage stage=loading_stage::none)
void unify_controllers()
Definition: saved_game.cpp:641
const language_def & get_locale()
Definition: language.cpp:263
filesystem::scoped_istream istream_file(const std::string &fname, bool treat_failure_as_error)
Definition: filesystem.cpp:865
void _set_resolution(const point &res)
Definition: general.cpp:401
void set_language(const std::string &language, const std::vector< std::string > *)
Definition: gettext.cpp:449
boost::optional< std::string > username
Non-empty if –username was given on the command line. Forces Wesnoth to use this network username...
void mark_completed_campaigns(std::vector< config > &campaigns)
save_result save_image(const locator &i_locator, const std::string &filename)
Definition: picture.cpp:1290
boost::optional< std::string > campaign_scenario
Non-empty if –campaign-scenario was given on the command line. Chooses starting scenario in the camp...
std::string get_default_title_string()
void set_min_translation_percent(int percent)
Definition: language.cpp:132
void clear()
Definition: saved_game.cpp:731
boost::optional< int > max_fps
Max FPS specified by –max-fps option.
bool fps
True if –fps was given on the command line. Shows number of fps.
bool change_language()
void set_network_host(const std::string &host)
Definition: game.cpp:399
std::string normalize_path(const std::string &fpath, bool normalize_separators, bool resolve_dot_entries)
Returns the absolute path of a file.
bool noreplaycheck
True if –noreplaycheck was given on the command line. Dependent on –unit.
Contains the exception interfaces used to signal completion of a scenario, campaign or turn...
std::string jump_to_campaign_id() const
Return the ID of the campaign to jump to (skipping the main menu).
-file util.hpp
Definitions for the interface to Wesnoth Markup Language (WML).
load_game_metadata & data()
Definition: savegame.hpp:115
boost::optional< std::string > plugin_file
File to load a lua plugin (similar to a script) from. Experimental / may replace script.
bool sound_on()
Definition: general.cpp:660
#define DBG_GENERAL
load_game_metadata data_
Definition: savegame.hpp:89
std::string user_message
User-friendly and potentially translated message for use in the UI.
jump_to_campaign_info jump_to_campaign_
boost::optional< std::string > load
Non-empty if –load was given on the command line. Savegame specified to load after start...
bool init_sound()
Definition: sound.cpp:405
static lg::log_domain log_config("config")
bool broke_strict()
Definition: log.cpp:171
bool play_multiplayer(mp_selection res)
std::string get_cwd()
Definition: filesystem.cpp:754
bool with_replay
True if –with-replay was given on the command line. Shows replay of the loaded file.
void set_mp_server_program_name(const std::string &path)
Definition: game.cpp:511
void set_window_title(const std::string &title)
Sets the title of the main window.
Definition: video.cpp:362
void show() const
Shows the error in a dialog.
bool play_render_image_mode()
bool headless_unit_test
True if –unit is used and –showgui is not present.
static game_config_manager * get()
void make_fake()
Definition: video.cpp:172
static UNUSEDNOWARN std::string _(const char *str)
Definition: gettext.hpp:89
#define ERR_CONFIG
bool joystick_support_enabled()
Definition: general.cpp:723
font::manager font_manager_
std::size_t size(const std::string &str)
Length in characters of a UTF-8 string.
Definition: unicode.cpp:86
static lg::log_domain log_enginerefac("enginerefac")
void start_plugin(std::size_t idx)
Definition: manager.cpp:101
std::string get_name(std::size_t idx)
Definition: manager.cpp:94
This file contains the settings handling of the widget library.
bool nodelay
True if –nodelay was given on the command line.
std::string get_user_data_dir()
Definition: filesystem.cpp:720
void write_file(const std::string &fname, const std::string &data)
Throws io_exception if an error occurs.
Definition: filesystem.cpp:926
static lg::log_domain log_network("network")
std::string multiplayer_server_
std::string campaign_define
If there is a define the campaign uses to customize data.
editor::EXIT_STATUS start_editor()
void set_login(const std::string &login)
boost::optional< unsigned int > translation_percent
Non-empty if –all-translations or –translations-over is given on the command line.
std::string localename
Definition: language.hpp:52
void load_package()
Loads the package library into lua environment.
bool windowed
True if –windowed was given on the command line. Starts Wesnoth in windowed mode.
boost::optional< std::string > editor
Non-empty if –editor was given on the command line. Goes directly into editor. If string is longer t...
void set_show_fps(bool value)
Definition: general.cpp:970
const std::vector< game_config::server_info > & server_list()
Definition: game.cpp:372
std::unique_ptr< std::istream > scoped_istream
Definition: filesystem.hpp:39
void set_test(const std::string &id)
std::string end_text
end-of-campaign text
void set_password(const std::string &server, const std::string &login, const std::string &key)
void set_core_id(const std::string &core_id)
Definition: general.cpp:321
std::string path
Definition: game_config.cpp:39
boost::optional< std::string > test
Non-empty if –test was given on the command line. Goes directly into test mode, into a scenario...
void init_textdomains(const config &cfg)
Initializes the list of textdomains from a configuration object.
Definition: language.cpp:303
bool multiplayer
True if –multiplayer was given on the command line. Goes directly into multiplayer mode...
Managing the AIs lifecycle - headers.
bool UI_sound_on()
Definition: general.cpp:631
std::string sanitize_path(const std::string &path)
Sanitizes a path to remove references to the user&#39;s name.
if(win_locale=="af") win_locale
game_launcher(const commandline_options &cmdline_opts, const char *appname)
std::string campaign
The id of the campaign being played.
const char * what() const noexcept
Definition: exceptions.hpp:37
bool clock
True if –clock was given on the command line. Enables.
static UNUSEDNOWARN std::string gettext(const char *str)
Definition: gettext.hpp:66
Error used for any general game error, e.g.
Definition: game_errors.hpp:46
std::string read_file(const std::string &fname)
Basic disk I/O - read file.
Definition: filesystem.cpp:857
std::string screenshot_map_
std::unique_ptr< savegame::load_game_metadata > load_data_
#define LOG_CONFIG
void set_draw_delay(int value)
Definition: general.cpp:980
boost::optional< std::string > render_image
Image path to render. First parameter after –render-image.
void start_client(const config &game_config, saved_game &state, const std::string &host)
Starts a multiplayer game in client mode.
void set_level(const std::string &value)
Definition: game.cpp:713
boost::optional< int > campaign_difficulty
Non-empty if –campaign-difficulty was given on the command line. Numerical difficulty of the campaig...
Helper class, don&#39;t construct this directly.
bool nomusic
True if –nomusic was given on the command line. Disables music.
void run(char const *prog, int nArgs=0)
Runs a plain script.
std::string dev_message
The message for developers telling which problem was triggered, this shouldn&#39;t be translated...
std::string get_cache_dir()
Definition: filesystem.cpp:725
Exception used to signal that the user has decided to abortt a game, and to load another game instead...
Definition: savegame.hpp:74
static void display(const config &game_cfg, const preferences::PREFERENCE_VIEW initial_view=preferences::VIEW_DEFAULT)
The display function – see modal_dialog for more information.
#define WRN_GENERAL
boost::optional< std::string > password
Non-empty if –password was given on the command line. Forces Wesnoth to use this network password...
bool is_loading() const
bool debug
True if –debug was given on the command line. Enables debug mode.
void start_local_game(const config &game_config, saved_game &state)
Starts a multiplayer game in single-user mode.
std::size_t i
Definition: function.cpp:933
std::size_t add_plugin(const std::string &name, const std::string &prog)
Definition: manager.cpp:118
std::string get_mp_server_program_name()
Definition: game.cpp:523
boost::optional< std::string > screenshot_map_file
Map file to make a screenshot of. First parameter given after –screenshot.
std::string get_wml_location(const std::string &filename, const std::string &current_dir)
Returns a complete path to the actual WML file or directory or an empty string if the file isn&#39;t pres...
void clean_saves(const std::string &label)
Delete all autosaves of a certain scenario.
Definition: savegame.cpp:67
void load_game_config_for_create(bool is_mp, bool is_test=false)
Game configuration data as global variables.
Definition: build_info.cpp:47
bool new_widgets
True if –new-widgets was given on the command line. Hidden option to enable the new widget toolkit...
#define ERR_NET
void init_window()
Initializes a new SDL window instance, taking into account any preiously saved states.
Definition: video.cpp:220
An exception object used when an IO error occurs.
Definition: filesystem.hpp:48
bool music_on()
Definition: general.cpp:683
void add_completed_campaign(const std::string &campaign_id, const std::string &difficulty_level)
Definition: game.cpp:318
bool load_language_list()
Definition: language.cpp:92
language_list get_languages()
Definition: language.cpp:115
void set_fullscreen(bool ison)
Definition: video.cpp:532
Holds a 2D point.
Definition: point.hpp:23
bool set_UI_sound(bool ison)
Definition: general.cpp:636
bool goto_multiplayer()
Declarations for File-IO.
static void save(LexState *ls, int c)
Definition: llex.cpp:57
void launch_game(RELOAD_GAME_DATA reload=RELOAD_DATA)
Class for replay saves (either manually or automatically).
Definition: savegame.hpp:256
-file mapgen.hpp
bool campaign_skip_story
True if –skip-story was given on the command line. Skips [story] and [message]s through the end of t...
std::string difficulty
The difficulty level the game is being played on.
boost::optional< std::string > render_image_dst
Output file to put rendered image path in. Optional second parameter after –render-image.
std::string base_name(const std::string &file, const bool remove_extension)
Returns the base filename of a file, with directory name stripped.
static manager * singleton_
Definition: manager.hpp:488
std::string get_user_config_dir()
Definition: filesystem.cpp:691
bool screenshot
True if –screenshot was given on the command line. Starts Wesnoth in screenshot mode.
void cancel_orders()
Definition: saved_game.cpp:624
boost::optional< std::string > unit_test
Non-empty if –unit was given on the command line. Goes directly into unit test mode, into a scenario, if specified.
std::string get_detailed_status(std::size_t idx)
Definition: manager.cpp:83
bool show_replay
State of the "show_replay" checkbox in the load-game dialog.
Definition: savegame.hpp:46
static void display(std::function< void()> f)
const commandline_options & cmdline_opts_
Base class for all the errors encountered by the engine.
Definition: exceptions.hpp:29
game_classification & classification()
Definition: saved_game.hpp:55
std::string screenshot_filename_
void set_carryover_sides_start(config carryover_sides_start)
Definition: saved_game.cpp:129
saved_game state_
bool set_music(bool ison)
Definition: general.cpp:688
Standard logging facilities (interface).
void set_skip_story(bool skip_story)
Definition: saved_game.hpp:126
boost::optional< std::string > screenshot_output_file
Output file to put screenshot in. Second parameter given after –screenshot.
bool set_turn_bell(bool ison)
Definition: general.cpp:612
void clear_loaded_game()
std::string message
Definition: exceptions.hpp:31
EXIT_STATUS start(const std::string &filename, bool take_screenshot, const std::string &screenshot_filename)
Main interface for launching the editor from the title screen.
Definition: editor_main.cpp:28
bool fullscreen
True if –fullscreen was given on the command line. Starts Wesnoth in fullscreen mode.
void show_error_message(const std::string &msg, bool message_use_markup)
Shows an error message to the user.
Definition: message.cpp:205
boost::optional< std::string > language
Non-empty if –language was given on the command line. Sets the language for this session...
#define e
std::string test_scenario_
bool nosound
True if –nosound was given on the command line. Disables sound.
boost::optional< std::pair< int, int > > resolution
Pair of AxB values specified after –resolution. Changes Wesnoth resolution.
bool play_screenshot_mode()
lua_kernel_base * get_kernel_base()
Definition: manager.cpp:63
boost::optional< std::string > campaign
Non-empty if –campaign was given on the command line. ID of the campaign we want to start...
A config object defines a single node in a WML file, with access to child nodes.
Definition: config.hpp:92
void clear_current_scenario()
Definition: statistics.cpp:646
mp_game_settings & mp_settings()
Multiplayer parameters for this game.
Definition: saved_game.hpp:59
bool enter_create_mode(saved_game &state, jump_to_campaign_info jump_to_campaign)
bool init_lua_script()
std::vector< server_info > server_list
Definition: game_config.cpp:94
bool save_game_automatic(bool ask_for_overwrite=false, const std::string &filename="")
Saves a game without user interaction, unless the file exists and it should be asked to overwrite it...
Definition: savegame.cpp:337
boost::optional< std::string > server
Non-empty if –server was given on the command line. Connects Wesnoth to specified server...
bool play_multiplayer_commandline()
void set_debug(bool new_debug)
static plugins_manager * get()
Definition: manager.cpp:58
void play_slice()
Definition: context.cpp:96
#define LOG_GENERAL
bool show_debug_clock_button
Do we wish to show the button for the debug clock.