-
-
Notifications
You must be signed in to change notification settings - Fork 991
/
game_config_manager.cpp
580 lines (503 loc) · 18.8 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
/*
Copyright (C) 2013 - 2016 by Andrius Silinskas <silinskas.andrius@gmail.com>
Part of the Battle for Wesnoth Project http://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 "game_config.hpp"
#include "gettext.hpp"
#include "game_classification.hpp"
#include "gui/dialogs/loadscreen.hpp"
#include "gui/dialogs/wml_error.hpp"
#include "hotkey/hotkey_item.hpp"
#include "hotkey/hotkey_command.hpp"
#include "language.hpp"
#include "log.hpp"
#include "preferences.hpp"
#include "scripting/game_lua_kernel.hpp"
#include "terrain/builder.hpp"
#include "terrain/type_data.hpp"
#include "units/types.hpp"
#include "version.hpp"
#include "theme.hpp"
#include "image.hpp"
#include <boost/foreach.hpp>
#include <boost/make_shared.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,
CVideo& video,
const bool jump_to_editor) :
cmdline_opts_(cmdline_opts),
video_(video),
jump_to_editor_(jump_to_editor),
game_config_(),
old_defines_map_(),
paths_manager_(),
cache_(game_config::config_cache::instance())
{
assert(!singleton);
singleton = this;
if(cmdline_opts_.nocache) {
cache_.set_use_cache(false);
}
if(cmdline_opts_.validcache) {
cache_.set_force_valid_cache(true);
}
}
game_config_manager::~game_config_manager()
{
assert(singleton);
singleton = NULL;
}
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", bool(cmdline_opts_.test));
game_config::scoped_preproc_define mptest("MP_TEST", cmdline_opts_.mptest);
game_config::scoped_preproc_define editor("EDITOR", jump_to_editor_);
game_config::scoped_preproc_define title_screen("TITLE_SCREEN",
!cmdline_opts_.multiplayer && !cmdline_opts_.test && !jump_to_editor_);
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);
hotkey::load_hotkeys(game_config(), true);
::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)
{
BOOST_FOREACH(const preproc_map::value_type& pair, special)
{
preproc_map::const_iterator it = general.find(pair.first);
if (it == general.end() || it->second != pair.second) {
return false;
}
}
return true;
}
} // end anonymous namespace
void game_config_manager::load_game_config_with_loadscreen(FORCE_RELOAD_CONFIG force_reload,
game_classification const* classification)
{
gui2::tloadscreen::display(video_, [=]() {
load_game_config(force_reload, classification);
});
}
void game_config_manager::load_game_config(FORCE_RELOAD_CONFIG force_reload,
game_classification const* classification)
{
// 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.
game_config::scoped_preproc_define debug_mode("DEBUG_MODE",
game_config::debug || game_config::mp_debug);
// 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()) {
return;
}
if((force_reload == NO_INCLUDE_RELOAD) && map_includes(old_defines_map_, cache_.get_preproc_map())) {
return;
}
}
// 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.
gui2::tloadscreen::progress("verify cache");
filesystem::data_tree_checksum();
gui2::tloadscreen::progress("create cache");
// Start transaction so macros are shared.
game_config::config_cache_transaction main_transaction;
config cores_cfg;
// Load mainline cores definition file.
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::ENTIRE_FILE_PATH);
}
BOOST_FOREACH(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;
BOOST_FOREACH(const config& core, cores_cfg.child_range("core")) {
const std::string& id = core["id"];
if (id.empty()) {
gui2::twml_error::display(
_("Error validating data core."),
_("Found a core without id attribute.")
+ '\n' + _("Skipping the core."),
video_);
continue;
}
if (*&valid_cores.find_child("core", "id", id)) {
gui2::twml_error::display(
_("Error validating data core."),
_("Core ID: ") + id
+ '\n' + _("The ID is already in use.")
+ '\n' + _("Skipping the core."),
video_);
continue;
}
const std::string& path = core["path"];
if (!filesystem::file_exists(filesystem::get_wml_location(path))) {
gui2::twml_error::display(
_("Error validating data core."),
_("Core ID: ") + id
+ '\n' + _("Core Path: ") + path
+ '\n' + _("File not found.")
+ '\n' + _("Skipping the core."),
video_);
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) {
gui2::twml_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."),
video_);
preferences::set_core_id("default");
}
// check if we have a valid default core which should always be the case.
if (wml_tree_root.empty()) {
gui2::twml_error::display(
_("Error loading core data."),
_("Can't locate the default core.")
+ '\n' + _("The game will now exit."),
video_);
throw;
}
// Load the selected core
cache_.get_config(filesystem::get_wml_location(wml_tree_root), game_config_);
game_config_.append(valid_cores);
main_transaction.lock();
// Put the gfx rules aside so that we can prepend the add-on
// rules to them.
config core_terrain_rules;
core_terrain_rules.splice_children(game_config_, "terrain_graphics");
if (!game_config::no_addons && !cmdline_opts_.noaddons)
load_addons_cfg();
// If multiplayer campaign is being loaded, [scenario] tags should
// become [multiplayer] tags and campaign's id should be added to them
// to allow to recognize which scenarios belongs to a loaded campaign.
if (classification != NULL) {
if (const config& campaign = game_config().find_child("campaign", "id", classification->campaign))
{
const bool require_campaign = campaign["require_campaign"].to_bool(true);
BOOST_FOREACH(config& scenario, game_config_.child_range("scenario"))
{
scenario["require_scenario"] = require_campaign;
BOOST_FOREACH(config& side, scenario.child_range("side"))
{
side["no_leader"] = side["no_leader"].to_bool(true);
}
}
}
}
// Extract the Lua scripts at toplevel.
game_lua_kernel::extract_preload_scripts(game_config_);
game_config_.clear_children("lua");
// Put the gfx rules back to game config.
game_config_.splice_children(core_terrain_rules, "terrain_graphics");
set_multiplayer_hashes();
set_color_info();
set_unit_data();
terrain_builder::set_terrain_rules_cfg(game_config());
tdata_ = boost::make_shared<terrain_type_data>(game_config_);
::init_strings(game_config());
theme::set_known_themes(&game_config());
} catch(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;
gui2::twml_error::display(
_("Error loading custom game configuration files. The game will try without loading add-ons."),
e.message, video_);
load_game_config(force_reload, classification);
} else if (preferences::core_id() != "default") {
gui2::twml_error::display(
_("Error loading custom game configuration files. The game will fallback to the default core files."),
e.message, video_);
preferences::set_core_id("default");
game_config::no_addons = false;
load_game_config(force_reload, classification);
} else {
gui2::twml_error::display(
_("Error loading default core game configuration files. The game will now exit."),
e.message, video_);
throw;
}
}
old_defines_map_ = cache_.get_preproc_map();
// Set new binary paths.
paths_manager_.set_paths(game_config());
}
struct addon_source {
std::string main_cfg;
std::string addon_id;
version_info version;
};
void game_config_manager::load_addons_cfg()
{
const std::string user_campaign_dir = filesystem::get_addons_dir();
std::vector<std::string> error_addons;
std::vector<std::string> user_dirs;
std::vector<std::string> user_files;
std::vector<addon_source> addons_to_load;
filesystem::get_files_in_dir(user_campaign_dir, &user_files, &user_dirs,
filesystem::ENTIRE_FILE_PATH);
std::vector<std::string> error_log;
// Append the $user_campaign_dir/*.cfg files to addons_to_load.
BOOST_FOREACH(const std::string& uc, user_files) {
const std::string file = uc;
const int size_minus_extension = file.size() - 4;
if(file.substr(size_minus_extension, file.size()) == ".cfg") {
const int userdata_loc = file.find("data/add-ons") + 5;
ERR_CONFIG << "error reading usermade add-on '"
<< file << "'\n";
error_addons.push_back(file);
error_log.push_back("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.");
}
}
// 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, &user_files, &user_dirs,
filesystem::FILE_NAME_ONLY);
// Append the $user_campaign_dir/*/_main.cfg files to addons_to_load.
BOOST_FOREACH(const std::string& uc, user_dirs) {
const std::string addon_id = uc;
const std::string addon_dir = user_campaign_dir + "/" + uc;
const std::string main_cfg = addon_dir + "/_main.cfg";
const std::string info_cfg = addon_dir + "/_info.cfg";
addon_source addon;
addon.main_cfg = main_cfg;
addon.addon_id = addon_id;
if (filesystem::file_exists(main_cfg)) {
if (filesystem::file_exists(info_cfg)) {
config info;
cache_.get_config(info_cfg, info);
const config info_tag = info.child_or_empty("info");
std::string core = info_tag["core"];
if (core.empty()) core = "default";
if ( !info_tag.empty() && // Don't skip addons which have no [info], they are most likely manually installed.
info_tag["type"] != "core" && // Don't skip cores, we want them selectable at all times.
core != preferences::core_id() // Don't skip addons matching our current core.
) {
continue; // Skip add-ons not matching our current core.
}
}
// Ask the addon manager to find version info for us (from info, pbl file)
addon.version = get_addon_version_info(addon_id);
addons_to_load.push_back(addon);
}
}
// Load the addons.
BOOST_FOREACH(const addon_source & addon, addons_to_load) {
try {
// Load this addon from the cache, to a config
config umc_cfg;
cache_.get_config(addon.main_cfg, umc_cfg);
// Annotate "era", "modification", and scenario tags with addon_id info
const char * tags_with_addon_id [] = { "era", "modification", "multiplayer", "scenario", NULL };
for (const char ** type = tags_with_addon_id; *type; type++)
{
BOOST_FOREACH(config & cfg, umc_cfg.child_range(*type)) {
cfg["addon_id"] = addon.addon_id;
// Note that this may reformat the string in a canonical form.
cfg["addon_version"] = addon.version.str();
}
}
game_config_.append(umc_cfg);
} catch(config::error& err) {
ERR_CONFIG << "error reading usermade add-on '" << addon.main_cfg << "'" << std::endl;
ERR_CONFIG << err.message << '\n';
error_addons.push_back(addon.main_cfg);
error_log.push_back(err.message);
} catch(preproc_config::error& err) {
ERR_CONFIG << "error reading usermade add-on '" << addon.main_cfg << "'" << std::endl;
ERR_CONFIG << err.message << '\n';
error_addons.push_back(addon.main_cfg);
error_log.push_back(err.message);
} catch(filesystem::io_exception&) {
ERR_CONFIG << "error reading usermade add-on '" << addon.main_cfg << "'" << std::endl;
error_addons.push_back(addon.main_cfg);
}
}
if(error_addons.empty() == false) {
const 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");
gui2::twml_error::display(msg1, msg2, error_addons, report,
video_);
}
}
void game_config_manager::set_multiplayer_hashes()
{
config& hashes = game_config_.add_child("multiplayer_hashes");
BOOST_FOREACH(const config &ch, game_config_.child_range("multiplayer")) {
hashes[ch["id"]] = ch.hash();
}
}
void game_config_manager::set_color_info()
{
config colorsys_info;
colorsys_info.splice_children(game_config_, "color_range");
colorsys_info.splice_children(game_config_, "color_palette");
game_config::add_color_info(colorsys_info);
}
void game_config_manager::set_unit_data()
{
game_config_.merge_children("units");
gui2::tloadscreen::progress("load unit types");
if(config &units = game_config_.child("units")) {
unit_types.set_config(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);
}
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)
{
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.campaign_type == game_classification::CAMPAIGN_TYPE::MULTIPLAYER);
game_config::scoped_preproc_define mptest("MP_TEST", cmdline_opts_.mptest &&
classification.campaign_type == game_classification::CAMPAIGN_TYPE::MULTIPLAYER);
typedef boost::shared_ptr<game_config::scoped_preproc_define> define;
std::deque<define> extra_defines;
BOOST_FOREACH(const std::string& extra_define,
classification.campaign_xtra_defines) {
define new_define
(new game_config::scoped_preproc_define(extra_define));
extra_defines.push_back(new_define);
}
std::deque<define> modification_defines;
BOOST_FOREACH(const std::string& mod_define,
classification.mod_defines) {
define new_define
(new game_config::scoped_preproc_define(mod_define, !mod_define.empty()));
modification_defines.push_back(new_define);
}
try{
load_game_config_with_loadscreen(NO_FORCE_RELOAD, &classification);
}
catch(game::error&) {
cache_.clear_defines();
std::deque<define> previous_defines;
BOOST_FOREACH(const preproc_map::value_type& preproc, old_defines_map_) {
define new_define
(new game_config::scoped_preproc_define(preproc.first));
previous_defines.push_back(new_define);
}
load_game_config_with_loadscreen(NO_FORCE_RELOAD);
throw;
}
}
void game_config_manager::load_game_config_for_create(bool is_mp)
{
game_config::scoped_preproc_define multiplayer("MULTIPLAYER", is_mp);
game_config::scoped_preproc_define mptest("MP_TEST", cmdline_opts_.mptest && is_mp);
///During an mp game the default difficuly define is also defined so better already load it now if we alreeady must reload config cache.
game_config::scoped_preproc_define normal(DEFAULT_DIFFICULTY, !map_includes(old_defines_map_, cache_.get_preproc_map()));
typedef boost::shared_ptr<game_config::scoped_preproc_define> define;
try{
load_game_config(NO_INCLUDE_RELOAD);
}
catch(game::error&) {
cache_.clear_defines();
std::deque<define> previous_defines;
BOOST_FOREACH(const preproc_map::value_type& preproc, old_defines_map_) {
define new_define
(new game_config::scoped_preproc_define(preproc.first));
previous_defines.push_back(new_define);
}
load_game_config(NO_FORCE_RELOAD);
throw;
}
}