-
-
Notifications
You must be signed in to change notification settings - Fork 988
/
game_config_manager.cpp
768 lines (648 loc) · 24.7 KB
/
game_config_manager.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
/*
Copyright (C) 2013 - 2018 by Andrius Silinskas <silinskas.andrius@gmail.com>
Part of the Battle for Wesnoth Project https://www.wesnoth.org/
This program 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; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY.
See the COPYING file for more details.
*/
#include "game_config_manager.hpp"
#include "about.hpp"
#include "addon/manager.hpp"
#include "ai/configuration.hpp"
#include "cursor.hpp"
#include "events.hpp"
#include "formatter.hpp"
#include "game_classification.hpp"
#include "game_config.hpp"
#include "game_version.hpp"
#include "gettext.hpp"
#include "gui/dialogs/loading_screen.hpp"
#include "gui/dialogs/wml_error.hpp"
#include "hotkey/hotkey_command.hpp"
#include "hotkey/hotkey_item.hpp"
#include "language.hpp"
#include "log.hpp"
#include "picture.hpp"
#include "preferences/advanced.hpp"
#include "preferences/general.hpp"
#include "scripting/game_lua_kernel.hpp"
#include "serialization/schema_validator.hpp"
#include "sound.hpp"
#include "terrain/builder.hpp"
#include "terrain/type_data.hpp"
#include "theme.hpp"
#include "units/types.hpp"
static lg::log_domain log_config("config");
#define ERR_CONFIG LOG_STREAM(err, log_config)
#define WRN_CONFIG LOG_STREAM(warn, log_config)
#define LOG_CONFIG LOG_STREAM(info, log_config)
static game_config_manager* singleton;
game_config_manager::game_config_manager(const commandline_options& cmdline_opts)
: cmdline_opts_(cmdline_opts)
, game_config_()
, game_config_view_()
, addon_cfgs_()
, active_addons_()
, old_defines_map_()
, paths_manager_()
, cache_(game_config::config_cache::instance())
{
assert(!singleton);
singleton = this;
// All of the validation options imply --nocache, as the validation happens during cache
// rebuilding. If the cache isn't rebuilt, validation is silently skipped.
if(cmdline_opts_.nocache || cmdline_opts_.any_validation_option()) {
cache_.set_use_cache(false);
}
if(cmdline_opts_.validcache) {
cache_.set_force_valid_cache(true);
}
// Clean the cache of any old Wesnoth version's cache data
if(const std::string last_cleaned = preferences::get("_last_cache_cleaned_ver"); !last_cleaned.empty()) {
if(version_info{last_cleaned} < game_config::wesnoth_version) {
if(cache_.clean_cache()) {
preferences::set("_last_cache_cleaned_ver", game_config::wesnoth_version.str());
}
}
} else {
// If the preference wasn't set, set it, else the cleaning will never happen :P
preferences::set("_last_cache_cleaned_ver", game_config::wesnoth_version.str());
}
}
game_config_manager::~game_config_manager()
{
assert(singleton);
singleton = nullptr;
}
game_config_manager* game_config_manager::get()
{
return singleton;
}
bool game_config_manager::init_game_config(FORCE_RELOAD_CONFIG force_reload)
{
// Add preproc defines according to the command line arguments.
game_config::scoped_preproc_define multiplayer("MULTIPLAYER", cmdline_opts_.multiplayer);
game_config::scoped_preproc_define test("TEST", cmdline_opts_.test.has_value());
game_config::scoped_preproc_define mptest("MP_TEST", cmdline_opts_.mptest);
game_config::scoped_preproc_define editor("EDITOR", cmdline_opts_.editor.has_value());
game_config::scoped_preproc_define title_screen("TITLE_SCREEN",
!cmdline_opts_.multiplayer && !cmdline_opts_.test && !cmdline_opts_.editor);
game_config::reset_color_info();
load_game_config_with_loadscreen(force_reload);
game_config::load_config(game_config().child("game_config"));
hotkey::deactivate_all_scopes();
hotkey::set_scope_active(hotkey::SCOPE_MAIN_MENU);
// Load the standard hotkeys, then apply any player customizations.
hotkey::load_hotkeys(game_config(), true);
preferences::load_hotkeys();
// TODO: consider making this part of preferences::manager in some fashion
preferences::init_advanced_manager(game_config());
::init_textdomains(game_config());
about::set_about(game_config());
ai::configuration::init(game_config());
return true;
}
namespace
{
/** returns true if every define in special is also defined in general */
bool map_includes(const preproc_map& general, const preproc_map& special)
{
return std::all_of(special.begin(), special.end(), [&general](const auto& pair) {
const auto it = general.find(pair.first);
return it != general.end() && it->second == pair.second;
});
}
} // end anonymous namespace
void game_config_manager::load_game_config_with_loadscreen(
FORCE_RELOAD_CONFIG force_reload, game_classification const*, std::optional<std::set<std::string>> active_addons)
{
if(!lg::info().dont_log(log_config)) {
auto out = formatter();
out << "load_game_config: defines:";
for(const auto& pair : cache_.get_preproc_map()) {
out << pair.first << ",";
}
out << "\n add_ons:";
if(active_addons) {
for(const auto& str : *active_addons) {
out << str << ",";
}
} else {
out << "\n Everything:";
}
out << "\n";
FORCE_LOG_TO(lg::info(), log_config) << out.str();
}
game_config::scoped_preproc_define debug_mode("DEBUG_MODE",
game_config::debug || game_config::mp_debug);
bool reload_everything = true;
// Game_config already holds requested config in memory.
if(!game_config_.empty()) {
if((force_reload == NO_FORCE_RELOAD) && old_defines_map_ == cache_.get_preproc_map()) {
reload_everything = false;
}
if((force_reload == NO_INCLUDE_RELOAD) && map_includes(old_defines_map_, cache_.get_preproc_map())) {
reload_everything = false;
}
if(!reload_everything && active_addons == active_addons_) {
LOG_CONFIG << "load_game_config aborting\n";
return;
}
}
active_addons_ = active_addons;
LOG_CONFIG << "load_game_config: everything:" << reload_everything << "\n";
gui2::dialogs::loading_screen::display([this, reload_everything]() {
load_game_config(reload_everything);
});
}
void game_config_manager::load_game_config(bool reload_everything)
{
// Make sure that 'debug mode' symbol is set
// if command line parameter is selected
// also if we're in multiplayer and actual debug mode is disabled.
// The loadscreen will erase the titlescreen.
// NOTE: even without loadscreen, needed after MP lobby.
try {
// Read all game configs.
// First we load all core configs, the mainline one and the ones from the addons.
// Validate the cores and discard the invalid.
// Then find the path to the selected core.
// Load the selected core.
// Handle terrains so that they are last loaded from the core.
// Load every compatible addon.
if(reload_everything) {
gui2::dialogs::loading_screen::progress(loading_stage::verify_cache);
filesystem::data_tree_checksum();
gui2::dialogs::loading_screen::progress(loading_stage::create_cache);
// Start transaction so macros are shared.
game_config::config_cache_transaction main_transaction;
// Load mainline cores definition file.
config cores_cfg;
cache_.get_config(game_config::path + "/data/cores.cfg", cores_cfg);
// Append the $user_campaign_dir/*/cores.cfg files to the cores.
std::vector<std::string> user_dirs;
{
const std::string user_campaign_dir = filesystem::get_addons_dir();
std::vector<std::string> user_files;
filesystem::get_files_in_dir(
user_campaign_dir, &user_files, &user_dirs, filesystem::name_mode::ENTIRE_FILE_PATH);
}
for(const std::string& umc : user_dirs) {
const std::string cores_file = umc + "/cores.cfg";
if(filesystem::file_exists(cores_file)) {
config cores;
cache_.get_config(cores_file, cores);
cores_cfg.append(cores);
}
}
// Validate every core
config valid_cores;
bool current_core_valid = false;
std::string wml_tree_root;
for(const config& core : cores_cfg.child_range("core")) {
const std::string& id = core["id"];
if(id.empty()) {
events::call_in_main_thread([&]() {
gui2::dialogs::wml_error::display(
_("Error validating data core."),
_("Found a core without id attribute.")
+ '\n' + _("Skipping the core."));
});
continue;
}
if(*&valid_cores.find_child("core", "id", id)) {
events::call_in_main_thread([&]() {
gui2::dialogs::wml_error::display(
_("Error validating data core."),
_("Core ID: ") + id
+ '\n' + _("The ID is already in use.")
+ '\n' + _("Skipping the core."));
});
continue;
}
const std::string& path = core["path"];
if(!filesystem::file_exists(filesystem::get_wml_location(path))) {
events::call_in_main_thread([&]() {
gui2::dialogs::wml_error::display(
_("Error validating data core."),
_("Core ID: ") + id
+ '\n' + _("Core Path: ") + path
+ '\n' + _("File not found.")
+ '\n' + _("Skipping the core."));
});
continue;
}
if(id == "default" && !current_core_valid) {
wml_tree_root = path;
}
if(id == preferences::core_id()) {
current_core_valid = true;
wml_tree_root = path;
}
valid_cores.add_child("core", core); // append(core);
}
if(!current_core_valid) {
events::call_in_main_thread([&]() {
gui2::dialogs::wml_error::display(
_("Error loading core data."),
_("Core ID: ") + preferences::core_id()
+ '\n' + _("Error loading the core with named id.")
+ '\n' + _("Falling back to the default core."));
});
preferences::set_core_id("default");
}
// check if we have a valid default core which should always be the case.
if(wml_tree_root.empty()) {
events::call_in_main_thread([&]() {
gui2::dialogs::wml_error::display(
_("Error loading core data."),
_("Can't locate the default core.")
+ '\n' + _("The game will now exit."));
});
throw;
}
// Load the selected core
std::unique_ptr<schema_validation::schema_validator> validator;
if(cmdline_opts_.validate_core) {
validator.reset(new schema_validation::schema_validator(filesystem::get_wml_location("schema/game_config.cfg")));
validator->set_create_exceptions(false); // Don't crash if there's an error, just go ahead anyway
}
cache_.get_config(filesystem::get_wml_location(wml_tree_root), game_config_, validator.get());
game_config_.append(valid_cores);
main_transaction.lock();
if(!game_config::no_addons && !cmdline_opts_.noaddons) {
load_addons_cfg();
}
}
if(active_addons_) {
set_enabled_addon(*active_addons_);
} else {
set_enabled_addon_all();
}
// Extract the Lua scripts at toplevel.
game_lua_kernel::extract_preload_scripts(game_config());
set_unit_data();
terrain_builder::set_terrain_rules_cfg(game_config());
tdata_ = std::make_shared<terrain_type_data>(game_config());
::init_strings(game_config());
theme::set_known_themes(&game_config());
set_multiplayer_hashes();
game_config::add_color_info(game_config());
} catch(const game::error& e) {
ERR_CONFIG << "Error loading game configuration files\n" << e.message << '\n';
// Try reloading without add-ons
if(!game_config::no_addons) {
game_config::no_addons = true;
events::call_in_main_thread([&]() {
gui2::dialogs::wml_error::display(
_("Error loading custom game configuration files. The game will try without loading add-ons."),
e.message);
});
load_game_config(reload_everything);
} else if(preferences::core_id() != "default") {
events::call_in_main_thread([&]() {
gui2::dialogs::wml_error::display(
_("Error loading custom game configuration files. The game will fallback to the default core files."),
e.message);
});
preferences::set_core_id("default");
game_config::no_addons = false;
load_game_config(reload_everything);
} else {
events::call_in_main_thread([&]() {
gui2::dialogs::wml_error::display(
_("Error loading default core game configuration files. The game will now exit."),
e.message);
});
throw;
}
}
old_defines_map_ = cache_.get_preproc_map();
// Set new binary paths.
paths_manager_.set_paths(game_config());
}
void game_config_manager::load_addons_cfg()
{
const std::string user_campaign_dir = filesystem::get_addons_dir();
std::vector<std::string> error_log;
std::vector<std::string> error_addons;
std::vector<std::string> user_dirs;
std::vector<std::string> user_files;
filesystem::get_files_in_dir(user_campaign_dir, &user_files, &user_dirs, filesystem::name_mode::ENTIRE_FILE_PATH);
// Warn player about addons using the no-longer-supported single-file format.
for(const std::string& file : user_files) {
const int size_minus_extension = file.size() - 4;
if(file.substr(size_minus_extension, file.size()) == ".cfg") {
ERR_CONFIG << "error reading usermade add-on '" << file << "'\n";
error_addons.push_back(file);
const int userdata_loc = file.find("data/add-ons") + 5;
const std::string log_msg = formatter()
<< "The format '~"
<< file.substr(userdata_loc)
<< "' (for single-file add-ons) is not supported anymore, use '~"
<< file.substr(userdata_loc, size_minus_extension - userdata_loc)
<< "/_main.cfg' instead.";
error_log.push_back(log_msg);
}
}
// Rerun the directory scan using filename only, to get the addon_ids more easily.
user_files.clear();
user_dirs.clear();
filesystem::get_files_in_dir(user_campaign_dir, nullptr, &user_dirs,
filesystem::name_mode::FILE_NAME_ONLY);
// Load the addons.
for(const std::string& addon_id : user_dirs) {
log_scope2(log_config, "Loading add-on '" + addon_id + "'");
const std::string addon_dir = user_campaign_dir + "/" + addon_id;
const std::string main_cfg = addon_dir + "/_main.cfg";
const std::string info_cfg = addon_dir + "/_info.cfg";
if(!filesystem::file_exists(main_cfg)) {
continue;
}
// Try to find this addon's metadata. Author publishing info (_server.pbl) is given
// precedence over addon sever-generated info (_info.cfg). If neither are found, it
// probably means the addon was installed manually and certain defaults will be used.
config metadata;
if(have_addon_pbl_info(addon_id)) {
// Publishing info needs to be read from disk.
try {
metadata = get_addon_pbl_info(addon_id);
} catch(const invalid_pbl_exception& e) {
const std::string log_msg = formatter()
<< "The provided addon has an invalid pbl file"
<< " for addon "
<< addon_id;
error_addons.push_back(e.message);
error_log.push_back(log_msg);
}
} else if(filesystem::file_exists(info_cfg)) {
// Addon server-generated info can be fetched from cache.
config temp;
cache_.get_config(info_cfg, temp);
metadata = temp.child_or_empty("info");
}
std::string using_core = metadata["core"];
if(using_core.empty()) {
using_core = "default";
}
// Skip add-ons not matching our current core. Cores themselves should be selectable
// at all times, so they aren't considered here.
if(!metadata.empty() && metadata["type"] != "core" && using_core != preferences::core_id()) {
continue;
}
std::string addon_title = metadata["title"].str();
if(addon_title.empty()) {
addon_title = addon_id;
}
version_info addon_version(metadata["version"]);
try {
std::unique_ptr<schema_validation::schema_validator> validator;
if(cmdline_opts_.validate_addon && *cmdline_opts_.validate_addon == addon_id) {
validator.reset(new schema_validation::schema_validator(filesystem::get_wml_location("schema/game_config.cfg")));
validator->set_create_exceptions(false); // Don't crash if there's an error, just go ahead anyway
}
// Load this addon from the cache to a config.
config umc_cfg;
cache_.get_config(main_cfg, umc_cfg, validator.get());
static const std::set<std::string> tags_with_addon_id {
"era",
"modification",
"resource",
"multiplayer",
"scenario",
"campaign",
"test"
};
// Annotate appropriate addon types with addon_id info.
for(auto child : umc_cfg.all_children_range()) {
if(tags_with_addon_id.count(child.key) > 0) {
auto& cfg = child.cfg;
cfg["addon_id"] = addon_id;
cfg["addon_title"] = addon_title;
// Note that this may reformat the string in a canonical form.
cfg["addon_version"] = addon_version.str();
}
}
config advancefroms;
for(auto& units : umc_cfg.child_range("units")) {
for(auto& unit_type : units.child_range("unit_type")) {
for(const auto& advancefrom : units.child_range("advancefrom")) {
config modify_unit_type {
"type", unit_type["id"],
"add_advancement", advancefrom["unit"],
"set_experience", advancefrom["experience"]
};
deprecated_message(
"[advancefrom]",
DEP_LEVEL::FOR_REMOVAL,
{1, 17, 0},
_("Use [modify_unit_type]\n") + modify_unit_type.debug() + "\n [/modify_unit_type] instead in [campaign]"
);
advancefroms.add_child("modify_unit_type", modify_unit_type);
}
unit_type.remove_children("advancefrom", [](const config&){return true;});
}
}
// hardcoded list of 1.14 advancement macros, just used for the error mesage below.
static const std::set<std::string> deprecated_defines {
"ENABLE_PARAGON",
"DISABLE_GRAND_MARSHAL",
"ENABLE_ARMAGEDDON_DRAKE",
"ENABLE_DWARVISH_ARCANISTER",
"ENABLE_DWARVISH_RUNESMITH",
"ENABLE_WOLF_ADVANCEMENT",
"ENABLE_NIGHTBLADE",
"ENABLE_TROLL_SHAMAN",
"ENABLE_ANCIENT_LICH",
"ENABLE_DEATH_KNIGHT",
"ENABLE_WOSE_SHAMAN"
};
for(auto& campaign : umc_cfg.child_range("campaign")) {
campaign.append_children(std::move(advancefroms));
for(auto str : utils::split(campaign["extra_defines"])) {
if(deprecated_defines.count(str) > 0) {
//TODO: we could try to implement a compatibility path by
// somehow getting the content of that macro from the
// cache_ object, but considering that 1) the breakage
// isn't that bad (just one disabled unit) and 2)
// it before also didn't work in all cases (see #4402)
// i don't think it is worth it.
deprecated_message(
"extra_defines=" + str,
DEP_LEVEL::REMOVED,
{1, 15, 4},
_("instead, use the macro with the same name in the [campaign] tag")
);
}
}
}
static const std::set<std::string> entry_tags {
"era",
"modification",
"resource",
"multiplayer",
"scenario",
"campaign"
};
for(const std::string& tagname : entry_tags) {
game_config_.append_children_by_move(umc_cfg, tagname);
}
addon_cfgs_[addon_id] = std::move(umc_cfg);
} catch(const config::error& err) {
ERR_CONFIG << "error reading usermade add-on '" << main_cfg << "'" << std::endl;
ERR_CONFIG << err.message << '\n';
error_addons.push_back(main_cfg);
error_log.push_back(err.message);
} catch(const preproc_config::error& err) {
ERR_CONFIG << "error reading usermade add-on '" << main_cfg << "'" << std::endl;
ERR_CONFIG << err.message << '\n';
error_addons.push_back(main_cfg);
error_log.push_back(err.message);
} catch(const filesystem::io_exception&) {
ERR_CONFIG << "error reading usermade add-on '" << main_cfg << "'" << std::endl;
error_addons.push_back(main_cfg);
}
}
if(cmdline_opts_.validate_addon) {
if(!addon_cfgs_.count(*cmdline_opts_.validate_addon)) {
ERR_CONFIG << "Didn’t find an add-on for --validate-addon - check whether the id has a typo" << std::endl;
const std::string log_msg = formatter()
<< "Didn't find an add-on for --validate-addon - check whether the id has a typo";
error_log.push_back(log_msg);
throw game::error("Did not find an add-on for --validate-addon");
}
WRN_CONFIG << "Note: for --validate-addon to find errors, you have to play (in the GUI) a game that uses the add-on.";
}
if(!error_addons.empty()) {
const std::size_t n = error_addons.size();
const std::string& msg1 =
_n("The following add-on had errors and could not be loaded:",
"The following add-ons had errors and could not be loaded:",
n);
const std::string& msg2 =
_n("Please report this to the author or maintainer of this add-on.",
"Please report this to the respective authors or maintainers of these add-ons.",
n);
const std::string& report = utils::join(error_log, "\n\n");
events::call_in_main_thread([&]() {
gui2::dialogs::wml_error::display(msg1, msg2, error_addons, report);
});
}
}
void game_config_manager::set_multiplayer_hashes()
{
config& hashes = game_config_.add_child("multiplayer_hashes");
for(const config& ch : game_config().child_range("multiplayer")) {
hashes[ch["id"].str()] = ch.hash();
}
}
void game_config_manager::set_unit_data()
{
gui2::dialogs::loading_screen::progress(loading_stage::load_unit_types);
unit_types.set_config(game_config().merged_children_view("units"));
}
void game_config_manager::reload_changed_game_config()
{
// Rebuild addon version info cache.
refresh_addon_version_info_cache();
// Force a reload of configuration information.
cache_.recheck_filetree_checksum();
old_defines_map_.clear();
filesystem::clear_binary_paths_cache();
init_game_config(FORCE_RELOAD);
image::flush_cache();
sound::flush_cache();
}
void game_config_manager::load_game_config_for_editor()
{
game_config::scoped_preproc_define editor("EDITOR");
load_game_config_with_loadscreen(NO_FORCE_RELOAD);
}
void game_config_manager::load_game_config_for_game(
const game_classification& classification, const std::string& scenario_id)
{
game_config::scoped_preproc_define difficulty(classification.difficulty,
!classification.difficulty.empty());
game_config::scoped_preproc_define campaign(classification.campaign_define,
!classification.campaign_define.empty());
game_config::scoped_preproc_define scenario(classification.scenario_define,
!classification.scenario_define.empty());
game_config::scoped_preproc_define era(classification.era_define,
!classification.era_define.empty());
game_config::scoped_preproc_define multiplayer("MULTIPLAYER",
classification.is_multiplayer());
game_config::scoped_preproc_define mptest("MP_TEST", cmdline_opts_.mptest &&
classification.is_multiplayer());
//
// NOTE: these deques aren't used here, but the objects within are utilized as RAII helpers.
//
std::deque<game_config::scoped_preproc_define> extra_defines;
for(const std::string& extra_define : classification.campaign_xtra_defines) {
extra_defines.emplace_back(extra_define);
}
std::deque<game_config::scoped_preproc_define> modification_defines;
for(const std::string& mod_define : classification.mod_defines) {
modification_defines.emplace_back(mod_define, !mod_define.empty());
}
try {
load_game_config_with_loadscreen(NO_FORCE_RELOAD, &classification, classification.active_addons(scenario_id));
} catch(const game::error&) {
cache_.clear_defines();
std::deque<game_config::scoped_preproc_define> previous_defines;
for(const preproc_map::value_type& preproc : old_defines_map_) {
previous_defines.emplace_back(preproc.first);
}
load_game_config_with_loadscreen(NO_FORCE_RELOAD);
throw;
}
// This needs to be done in the main thread since this function (load_game_config_for_game)
// might be called from a loading screen worker thread (and currently is, in fact). If the
// image cache is purged from the worker thread, there's a possibility for a data race where
// the main thread accesses the image cache and the worker thread simultaneously clears it.
events::call_in_main_thread([]() { image::flush_cache(); });
}
void game_config_manager::load_game_config_for_create(bool is_mp, bool is_test)
{
game_config::scoped_preproc_define multiplayer("MULTIPLAYER", is_mp);
game_config::scoped_preproc_define test("TEST", is_test);
game_config::scoped_preproc_define mptest("MP_TEST", cmdline_opts_.mptest && is_mp);
/** During an mp game the default difficulty define is also defined so better already load it now if we already must reload config cache. */
game_config::scoped_preproc_define normal(
DEFAULT_DIFFICULTY, !map_includes(old_defines_map_, cache_.get_preproc_map()));
try {
load_game_config_with_loadscreen(NO_INCLUDE_RELOAD);
} catch(const game::error&) {
cache_.clear_defines();
std::deque<game_config::scoped_preproc_define> previous_defines;
for (const preproc_map::value_type& preproc : old_defines_map_) {
previous_defines.emplace_back(preproc.first);
}
load_game_config_with_loadscreen(NO_FORCE_RELOAD);
throw;
}
}
void game_config_manager::set_enabled_addon(std::set<std::string> addon_ids)
{
auto& vec = game_config_view_.data();
vec.clear();
vec.push_back(game_config_);
for(const std::string& id : addon_ids) {
auto it = addon_cfgs_.find(id);
if(it != addon_cfgs_.end()) {
vec.push_back(it->second);
}
}
}
void game_config_manager::set_enabled_addon_all()
{
auto& vec = game_config_view_.data();
vec.clear();
vec.push_back(game_config_);
for(const auto& pair : addon_cfgs_) {
vec.push_back(pair.second);
}
}