19 #include "addon/manager.hpp"
46 #define ERR_CONFIG LOG_STREAM(err, log_config)
47 #define WRN_CONFIG LOG_STREAM(warn, log_config)
48 #define LOG_CONFIG LOG_STREAM(info, log_config)
55 : cmdline_opts_(cmdline_opts)
79 if(
const std::string last_cleaned =
preferences::get(
"_last_cache_cleaned_ver"); !last_cleaned.empty()) {
143 return std::all_of(special.begin(), special.end(), [&
general](
const auto& pair) {
144 const auto it = general.find(pair.first);
145 return it != general.end() && it->second == pair.second;
155 out <<
"load_game_config: defines:";
158 out << pair.first <<
",";
168 bool reload_everything =
true;
173 reload_everything =
false;
177 reload_everything =
false;
181 LOG_CONFIG <<
"load_game_config reload everything: " << reload_everything;
204 if(reload_everything) {
218 std::vector<std::string> user_dirs;
221 std::vector<std::string> user_files;
226 for(
const std::string& umc : user_dirs) {
227 const std::string cores_file = umc +
"/cores.cfg";
237 bool current_core_valid =
false;
238 std::string wml_tree_root;
241 const std::string&
id = core[
"id"];
245 _(
"Error validating data core."),
246 _(
"Found a core without id attribute.")
247 +
'\n' +
_(
"Skipping the core."));
252 if(valid_cores.
find_child(
"core",
"id",
id)) {
255 _(
"Error validating data core."),
257 +
'\n' +
_(
"The ID is already in use.")
258 +
'\n' +
_(
"Skipping the core."));
263 const std::string&
path = core[
"path"];
267 _(
"Error validating data core."),
269 +
'\n' +
_(
"Core Path: ") +
path
270 +
'\n' +
_(
"File not found.")
271 +
'\n' +
_(
"Skipping the core."));
276 if(
id ==
"default" && !current_core_valid) {
277 wml_tree_root =
path;
280 current_core_valid =
true;
281 wml_tree_root =
path;
287 if(!current_core_valid) {
290 _(
"Error loading core data."),
292 +
'\n' +
_(
"Error loading the core with named id.")
293 +
'\n' +
_(
"Falling back to the default core."));
299 if(wml_tree_root.empty()) {
302 _(
"Error loading core data."),
303 _(
"Can't locate the default core.")
304 +
'\n' +
_(
"The game will now exit."));
310 std::unique_ptr<schema_validation::schema_validator> validator;
313 validator->set_create_exceptions(
false);
319 main_transaction.
lock();
333 LOG_CONFIG <<
"Configs not reloaded and active add-ons remain the same; returning early.";
358 ERR_CONFIG <<
"Error loading game configuration files\n" <<
e.message;
365 _(
"Error loading custom game configuration files. The game will try without loading add-ons."),
372 _(
"Error loading custom game configuration files. The game will fallback to the default core files."),
381 _(
"Error loading default core game configuration files. The game will now exit."),
396 for(
auto&
unit_type : units.child_range(
"unit_type")) {
397 for(
const auto& advancefrom :
unit_type.child_range(
"advancefrom")) {
399 {
"lower_level", advancefrom[
"unit"]},
406 "Error: [advancefrom] no longer works. ‘$lower_level’ units will not be able to advance to ‘$higher_level’; please ask the add-on author to use [modify_unit_type] instead.",
410 unit_type.remove_children(
"advancefrom", [](
const config&){
return true;});
416 static const std::set<std::string> deprecated_defines {
418 "DISABLE_GRAND_MARSHAL",
419 "ENABLE_ARMAGEDDON_DRAKE",
420 "ENABLE_DWARVISH_ARCANISTER",
421 "ENABLE_DWARVISH_RUNESMITH",
422 "ENABLE_WOLF_ADVANCEMENT",
424 "ENABLE_TROLL_SHAMAN",
425 "ENABLE_ANCIENT_LICH",
426 "ENABLE_DEATH_KNIGHT",
430 for(
auto& campaign : umc_cfg.
child_range(
"campaign")) {
431 for(
auto str :
utils::split(campaign[
"extra_defines"])) {
432 if(deprecated_defines.count(str) > 0) {
440 "campaign id='" + campaign[
"id"].str() +
"' has extra_defines=" + str,
443 _(
"instead, use the macro with the same name in the [campaign] tag")
454 std::vector<std::string> error_log;
455 std::vector<std::string> error_addons;
456 std::vector<std::string> user_dirs;
457 std::vector<std::string> user_files;
462 for(
const std::string& file : user_files) {
463 const int size_minus_extension = file.size() - 4;
465 if(file.substr(size_minus_extension, file.size()) ==
".cfg") {
466 ERR_CONFIG <<
"error reading usermade add-on '" << file <<
"'";
468 error_addons.push_back(file);
470 const int userdata_loc = file.find(
"data/add-ons") + 5;
473 << file.substr(userdata_loc)
474 <<
"' (for single-file add-ons) is not supported anymore, use '~"
475 << file.substr(userdata_loc, size_minus_extension - userdata_loc)
476 <<
"/_main.cfg' instead.";
478 error_log.push_back(log_msg);
482 loading_screen::spin();
491 loading_screen::spin();
494 for(
const std::string& addon_id : user_dirs) {
496 const std::string addon_dir = user_campaign_dir +
"/" + addon_id;
498 const std::string main_cfg = addon_dir +
"/_main.cfg";
499 const std::string info_cfg = addon_dir +
"/_info.cfg";
505 loading_screen::spin();
518 <<
"The provided addon has an invalid pbl file"
522 error_addons.push_back(
e.message);
523 error_log.push_back(log_msg);
533 std::string using_core = metadata[
"core"];
534 if(using_core.empty()) {
535 using_core =
"default";
544 std::string addon_title = metadata[
"title"].str();
545 if(addon_title.empty()) {
546 addon_title = addon_id;
552 std::unique_ptr<schema_validation::schema_validator> validator;
555 validator->set_create_exceptions(
false);
558 loading_screen::spin();
564 static const std::set<std::string> tags_with_addon_id {
576 if(tags_with_addon_id.count(child.key) > 0) {
577 auto& cfg = child.cfg;
578 cfg[
"addon_id"] = addon_id;
579 cfg[
"addon_title"] = addon_title;
581 cfg[
"addon_version"] = addon_version.
str();
585 loading_screen::spin();
589 loading_screen::spin();
591 static const std::set<std::string> entry_tags {
600 for(
const std::string& tagname : entry_tags) {
604 loading_screen::spin();
608 ERR_CONFIG <<
"config error reading usermade add-on '" << main_cfg <<
"'";
610 error_addons.push_back(main_cfg);
611 error_log.push_back(
err.message);
613 ERR_CONFIG <<
"preprocessor config error reading usermade add-on '" << main_cfg <<
"'";
615 error_addons.push_back(main_cfg);
616 error_log.push_back(
err.message);
618 ERR_CONFIG <<
"filesystem I/O error reading usermade add-on '" << main_cfg <<
"'";
619 error_addons.push_back(main_cfg);
625 ERR_CONFIG <<
"Didn’t find an add-on for --validate-addon - check whether the id has a typo";
627 <<
"Didn't find an add-on for --validate-addon - check whether the id has a typo";
628 error_log.push_back(log_msg);
629 throw game::error(
"Did not find an add-on for --validate-addon");
632 WRN_CONFIG <<
"Note: for --validate-addon to find errors, you have to play (in the GUI) a game that uses the add-on.";
635 if(!error_addons.empty()) {
636 const std::size_t
n = error_addons.size();
637 const std::string& msg1 =
638 _n(
"The following add-on had errors and could not be loaded:",
639 "The following add-ons had errors and could not be loaded:",
641 const std::string& msg2 =
642 _n(
"Please report this to the author or maintainer of this add-on.",
643 "Please report this to the respective authors or maintainers of these add-ons.",
646 const std::string& report =
utils::join(error_log,
"\n\n");
657 hashes[ch[
"id"].str()] = ch.
hash();
708 std::deque<game_config::scoped_preproc_define> extra_defines;
710 extra_defines.emplace_back(extra_define);
713 std::deque<game_config::scoped_preproc_define> modification_defines;
715 modification_defines.emplace_back(mod_define, !mod_define.empty());
723 std::deque<game_config::scoped_preproc_define> previous_defines;
725 previous_defines.emplace_back(preproc.first);
753 std::deque<game_config::scoped_preproc_define> previous_defines;
755 previous_defines.emplace_back(preproc.first);
769 for(
const std::string&
id : addon_ids) {
773 vec.push_back(it->second);
775 ERR_CONFIG <<
"Attempted to enable add-on '" <<
id <<
"' but its config could not be found";
788 LOG_CONFIG <<
"Enabling add-on " << pair.first;
789 vec.push_back(pair.second);
config get_addon_pbl_info(const std::string &addon_name, bool do_validate)
Gets the publish information for an add-on.
bool have_addon_pbl_info(const std::string &addon_name)
Returns whether a .pbl file is present for the specified add-on or not.
void refresh_addon_version_info_cache()
Refreshes the per-session cache of add-on's version information structs.
Definitions for the terrain builder.
void reload()
Reads the mainline achievements.cfg and then all the achievements of each installed add-on.
static void init(const game_config_view &game_config)
Init the parameters of ai configuration parser.
std::optional< std::string > validate_addon
Non-empty if –validate-addon was given on the command line.
bool mptest
True if –mp-test was given on the command line.
bool multiplayer
True if –multiplayer was given on the command line.
bool validcache
True if –validcache was given on the command line.
bool noaddons
True if –noaddons was given on the command line.
std::optional< std::string > test
Non-empty if –test was given on the command line.
bool any_validation_option() const
True if the –validate or any of the –validate-* options are given.
bool validate_core
True if –validate-core was given on the command line.
bool nocache
True if –nocache was given on the command line.
std::optional< std::string > editor
Non-empty if –editor was given on the command line.
A config object defines a single node in a WML file, with access to child nodes.
void append(const config &cfg)
Append data from another config object to this one.
const config & child_or_empty(config_key_type key) const
Returns the first child with the given key, or an empty config if there is none.
void append_children_by_move(config &cfg, const std::string &key)
Moves children with the given name from the given config to this one.
optional_config_impl< config > find_child(config_key_type key, const std::string &name, const std::string &value)
Returns the first child of tag key with a name attribute containing value.
const_all_children_itors all_children_range() const
In-order iteration over all children.
child_itors child_range(config_key_type key)
const attribute_value * get(config_key_type key) const
Returns a pointer to the attribute with the given key or nullptr if it does not exist.
config & add_child(config_key_type key)
std::vector< std::string > campaign_xtra_defines
more customization of data
std::vector< std::string > mod_defines
If there are defines the modifications use to customize data.
std::set< std::string > active_addons(const std::string &scenario_id) const
std::string scenario_define
If there is a define the scenario uses to customize data.
std::string difficulty
The difficulty level the game is being played on.
std::string era_define
If there is a define the era uses to customize data.
std::string campaign_define
If there is a define the campaign uses to customize data.
bool is_multiplayer() const
Used to share macros between cache objects You have to create transaction object to load all macros t...
void lock()
Lock the transaction so no more macros are added.
void recheck_filetree_checksum()
Force cache checksum validation.
void set_use_cache(bool use)
Enable/disable caching.
const preproc_map & get_preproc_map() const
void clear_defines()
Clear stored defines map to default values.
bool clean_cache()
Deletes stale cache files not in use by the game.
void set_force_valid_cache(bool force)
Enable/disable cache validation.
void get_config(const std::string &path, config &cfg, abstract_validator *validator=nullptr)
Gets a config object from given path.
Used to set and unset scoped defines to preproc_map.
void load_game_config_with_loadscreen(FORCE_RELOAD_CONFIG force_reload, const game_classification *classification, const std::string &scenario_id)
@ FORCE_RELOAD
Always reload config.
@ NO_INCLUDE_RELOAD
Don't reload if the previous defines include the new defines.
@ NO_FORCE_RELOAD
Don't reload if the previous defines equal the new defines.
std::map< std::string, config > addon_cfgs_
bool init_game_config(FORCE_RELOAD_CONFIG force_reload)
achievements achievements_
static game_config_manager * get()
void load_game_config_for_game(const game_classification &classification, const std::string &scenario_id)
void load_game_config(bool reload_everything, const game_classification *classification, const std::string &scenario_id)
std::set< std::string > active_addons_
void load_game_config_for_create(bool is_mp, bool is_test=false)
filesystem::binary_paths_manager paths_manager_
void set_enabled_addon_all()
game_config_view game_config_view_
preproc_map old_defines_map_
game_config::config_cache & cache_
std::shared_ptr< terrain_type_data > tdata_
void set_multiplayer_hashes()
void reload_changed_game_config()
game_config_manager(const commandline_options &cmdline_opts)
void set_enabled_addon(std::set< std::string > addon_ids)
const game_config_view & game_config() const
const commandline_options & cmdline_opts_
void load_game_config_for_editor()
config_array_view & data()
static void extract_preload_scripts(const game_config_view &game_config)
static void progress(loading_stage stage=loading_stage::none)
Report what is being loaded to the loading screen.
static void display(std::function< void()> f)
static void display(const std::string &summary, const std::string &post_summary, const std::vector< std::string > &files, const std::string &details)
The display function; see modal_dialog for more information.
Realization of serialization/validator.hpp abstract validator.
static void set_terrain_rules_cfg(const game_config_view &cfg)
Set the config where we will parse the global terrain rules.
static void set_known_themes(const game_config_view *cfg)
Copies the theme configs from the main game config.
void set_config(const game_config_view &cfg)
Resets all data based on the provided config.
A single unit type that the player may recruit.
Represents version numbers.
std::string str() const
Serializes the version number into string form.
Managing the AIs configuration - headers.
std::string deprecated_message(const std::string &elem_name, DEP_LEVEL level, const version_info &version, const std::string &detail)
const std::string DEFAULT_DIFFICULTY
The default difficulty setting for campaigns.
static game_config_manager * singleton
static void show_deprecated_warnings(config &umc_cfg)
static lg::log_domain log_config("config")
Interfaces for manipulating version numbers of engine, add-ons, etc.
static std::string _n(const char *str1, const char *str2, int n)
static std::string _(const char *str)
std::string id
Text to match against addon_info.tags()
void init_textdomains(const game_config_view &cfg)
Initializes the list of textdomains from a configuration object.
bool init_strings(const game_config_view &cfg)
Initializes certain English strings.
Standard logging facilities (interface).
#define log_scope2(domain, description)
#define FORCE_LOG_TO(logger, domain)
void set_about(const game_config_view &cfg)
Regenerates the credits data.
void call_in_main_thread(const std::function< void(void)> &f)
void get_files_in_dir(const std::string &dir, std::vector< std::string > *files, std::vector< std::string > *dirs, name_mode mode, filter_mode filter, reorder_mode reorder, file_tree_checksum *checksum)
Get a list of all files and/or directories in a given directory.
static bool file_exists(const bfs::path &fpath)
std::string get_wml_location(const std::string &filename, const std::string ¤t_dir)
Returns a complete path to the actual WML file or directory or an empty string if the file isn't pres...
const file_tree_checksum & data_tree_checksum(bool reset=false)
Get the time at which the data/ tree was last modified at.
void clear_binary_paths_cache()
std::string get_addons_dir()
Game configuration data as global variables.
const version_info wesnoth_version(VERSION)
static void add_color_info(const game_config_view &v, bool build_defaults)
void load_config(const config &v)
void load_default_hotkeys(const game_config_view &cfg)
Registers all hotkeys present in this config.
constexpr uint32_t scope_main
void flush_cache()
Purges all image caches.
void set_core_id(const std::string &core_id)
void set(const std::string &key, bool value)
void init_advanced_manager(const game_config_view &gc)
Initializes the manager singleton.
std::string get(const std::string &key)
game_classification * classification
std::string join(const T &v, const std::string &s=",")
Generates a new string joining container items in a list.
std::map< std::string, t_string > string_map
std::vector< std::string > split(const config_attribute_value &val)
std::map< std::string, struct preproc_define > preproc_map
One of the realizations of serialization/validator.hpp abstract validator.
void set_paths(const game_config_view &cfg)
An exception object used when an IO error occurs.
Base class for all the errors encountered by the engine.
Exception thrown when the WML parser fails to read a .pbl file.
static map_location::DIRECTION n
Definitions related to theme-support.
unit_type_data unit_types