The Battle for Wesnoth  1.15.9+dev
commandline_options.cpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2011 - 2018 by Lukasz Dobrogowski <lukasz.dobrogowski@gmail.com>
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 lfooater 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 "commandline_options.hpp"
16 
17 #include "config.hpp"
18 #include "formatter.hpp"
19 #include "lexical_cast.hpp"
20 #include "log.hpp" // for logger, set_strict_severity, etc
21 #include "serialization/string_utils.hpp" // for split
22 #include "utils/general.hpp" // for clamp
23 
24 #include <boost/any.hpp> // for any
25 #include <boost/program_options/cmdline.hpp>
26 #include <boost/program_options/errors.hpp> // for validation_error, etc
27 #include <boost/program_options/parsers.hpp>
28 #include <boost/program_options/positional_options.hpp>
29 #include <boost/program_options/value_semantic.hpp> // for value, etc
30 #include <boost/program_options/variables_map.hpp> // for variables_map, etc
31 
32 #include <array>
33 #include <iostream> // for operator<<, basic_ostream, etc
34 
35 namespace po = boost::program_options;
36 
37 class two_strings : public std::pair<std::string,std::string> {};
38 
39 static void validate(boost::any& v, const std::vector<std::string>& values,
40  two_strings*, int)
41 {
42  two_strings ret_val;
43  if (values.size() != 2) {
44  throw po::validation_error(po::validation_error::invalid_option_value);
45  }
46  ret_val.first = values.at(0);
47  ret_val.second = values.at(1);
48  v = ret_val;
49 }
50 
52  : error(formatter() << "Invalid resolution \"" << resolution
53  << "\" (WIDTHxHEIGHT expected)")
54 {
55 }
56 
58  const std::string& expected_format)
59  : error(formatter() << "Invalid value set \"" << str
60  << "\" (" << expected_format << " expected)")
61 {
62 }
63 
64 commandline_options::commandline_options(const std::vector<std::string>& args)
65  : bunzip2()
66  , bzip2()
67  , campaign()
68  , campaign_difficulty()
69  , campaign_scenario()
70  , campaign_skip_story(false)
71  , clock(false)
72  , core_id()
73  , data_path(false)
74  , data_dir()
75  , debug(false)
76  , debug_lua(false)
77 #ifdef DEBUG_WINDOW_LAYOUT_GRAPHS
78  , debug_dot_domain()
79  , debug_dot_level()
80 #endif
81  , editor()
82  , fps(false)
83  , fullscreen(false)
84  , gunzip()
85  , gzip()
86  , help()
87  , language()
88  , log()
89  , load()
90  , logdomains()
91  , log_precise_timestamps(false)
92  , multiplayer(false)
93  , multiplayer_ai_config()
94  , multiplayer_algorithm()
95  , multiplayer_controller()
96  , multiplayer_era()
97  , multiplayer_exit_at_end()
98  , multiplayer_ignore_map_settings()
99  , multiplayer_label()
100  , multiplayer_parm()
101  , multiplayer_repeat()
102  , multiplayer_scenario()
103  , multiplayer_side()
104  , multiplayer_turns()
105  , max_fps()
106  , noaddons(false)
107  , nocache(false)
108  , nodelay(false)
109  , nogui(false)
110  , nomusic(false)
111  , nosound(false)
112  , new_widgets(false)
113  , preprocess(false)
114  , preprocess_defines()
115  , preprocess_input_macros()
116  , preprocess_output_macros()
117  , preprocess_path()
118  , preprocess_target()
119  , resolution()
120  , rng_seed()
121  , server()
122  , username()
123  , password()
124  , render_image()
125  , render_image_dst()
126  , screenshot(false)
127  , screenshot_map_file()
128  , screenshot_output_file()
129  , script_file()
130  , plugin_file()
131  , script_unsafe_mode(false)
132  , strict_validation(false)
133  , test()
134  , unit_test()
135  , headless_unit_test(false)
136  , noreplaycheck(false)
137  , mptest(false)
138  , userconfig_path(false)
139  , userconfig_dir()
140  , userdata_path(false)
141  , userdata_dir()
142  , validcache(false)
143  , validate_core(false)
144  , validate_addon()
145  , validate_schema()
146  , validate_wml()
147  , validate_with()
148  , do_diff()
149  , do_patch()
150  , diff_left()
151  , diff_right()
152  , version(false)
153  , report(false)
154  , windowed(false)
155  , with_replay(false)
156  , translation_percent()
157  , args_(args.begin() + 1, args.end())
158  , args0_(*args.begin())
159  , all_()
160  , visible_()
161  , hidden_()
162 {
163  // When adding items don't forget to update doc/man/wesnoth.6
164  // Options are sorted alphabetically by --long-option.
165  po::options_description general_opts("General options");
166  general_opts.add_options()
167  ("all-translations", "Show all translations, even incomplete ones.")
168  ("bunzip2", po::value<std::string>(), "decompresses a file (<arg>.bz2) in bzip2 format and stores it without the .bz2 suffix. <arg>.bz2 will be removed.")
169  ("bzip2", po::value<std::string>(), "compresses a file (<arg>) in bzip2 format, stores it as <arg>.bz2 and removes <arg>.")
170  ("clock", "Adds the option to show a clock for testing the drawing timer.")
171  ("config-dir", po::value<std::string>(), "sets the path of the userdata directory to $HOME/<arg> or My Documents\\My Games\\<arg> for Windows. You can specify also an absolute path outside the $HOME or My Documents\\My Games directory. DEPRECATED: use userdata-dir instead.")
172  ("config-path", "prints the path of the userdata directory and exits. DEPRECATED: use userdata-path instead.")
173  ("core", po::value<std::string>(), "overrides the loaded core with the one whose id is specified.")
174  ("data-dir", po::value<std::string>(), "overrides the data directory with the one specified.")
175  ("data-path", "prints the path of the data directory and exits.")
176  ("debug,d", "enables additional command mode options in-game.")
177  ("debug-lua", "enables some Lua debugging mechanisms")
178 #ifdef DEBUG_WINDOW_LAYOUT_GRAPHS
179  ("debug-dot-level", po::value<std::string>(), "sets the level of the debug dot files. <arg> should be a comma separated list of levels. These files are used for debugging the widgets especially the for the layout engine. When enabled the engine will produce dot files which can be converted to images with the dot tool. Available levels: size (generate the size info of the widget), state (generate the state info of the widget).")
180  ("debug-dot-domain", po::value<std::string>(), "sets the domain of the debug dot files. <arg> should be a comma separated list of domains. See --debug-dot-level for more info. Available domains: show (generate the data when the dialog is about to be shown), layout (generate the data during the layout phase - might result in multiple files). The data can also be generated when the F12 is pressed in a dialog.")
181 #endif
182  ("editor,e", po::value<std::string>()->implicit_value(std::string()), "starts the in-game map editor directly. If file <arg> is specified, equivalent to -e --load <arg>.")
183  ("gunzip", po::value<std::string>(), "decompresses a file (<arg>.gz) in gzip format and stores it without the .gz suffix. <arg>.gz will be removed.")
184  ("gzip", po::value<std::string>(), "compresses a file (<arg>) in gzip format, stores it as <arg>.gz and removes <arg>.")
185  ("help,h", "prints this message and exits.")
186  ("language,L", po::value<std::string>(), "uses language <arg> (symbol) this session. Example: --language ang_GB@latin")
187  ("load,l", po::value<std::string>(), "loads the save <arg> from the standard save game directory. When launching the map editor via -e, the map <arg> is loaded, relative to the current directory. If it is a directory, the editor will start with a load map dialog opened there.")
188  ("noaddons", "disables the loading of all add-ons.")
189  ("nocache", "disables caching of game data.")
190  ("nodelay", "runs the game without any delays.")
191  ("nomusic", "runs the game without music.")
192  ("nosound", "runs the game without sounds and music.")
193  ("password", po::value<std::string>(), "uses <password> when connecting to a server, ignoring other preferences.")
194  ("plugin", po::value<std::string>(), "(experimental) load a script which defines a wesnoth plugin. similar to --script below, but Lua file should return a function which will be run as a coroutine and periodically woken up with updates.")
195  ("render-image", po::value<two_strings>()->multitoken(), "takes two arguments: <image> <output>. Like screenshot, but instead of a map, takes a valid Wesnoth 'image path string' with image path functions, and writes it to a .png file."
196 #ifdef _WIN32
197  " Implies --wconsole."
198 #endif // _WIN32
199  )
200  ("report,R", "initializes game directories, prints build information suitable for use in bug reports, and exits."
201 #ifdef _WIN32
202  " Implies --wconsole."
203 #endif // _WIN32
204  )
205  ("rng-seed", po::value<unsigned int>(), "seeds the random number generator with number <arg>. Example: --rng-seed 0")
206  ("screenshot", po::value<two_strings>()->multitoken(), "takes two arguments: <map> <output>. Saves a screenshot of <map> to <output> without initializing a screen. Editor must be compiled in for this to work."
207 #ifdef _WIN32
208  " Implies --wconsole."
209 #endif // _WIN32
210  )
211  ("script", po::value<std::string>(), "(experimental) file containing a Lua script to control the client")
212  ("server,s", po::value<std::string>()->implicit_value(std::string()), "connects to the host <arg> if specified or to the first host in your preferences.")
213  ("strict-validation", "makes validation errors fatal")
214  ("translations-over", po::value<unsigned int>(), "Specify the standard for determining whether a translation is complete.")
215  ("unsafe-scripts", "makes the \'package\' package available to Lua scripts, so that they can load arbitrary packages. Do not do this with untrusted scripts! This action gives ua the same permissions as the Wesnoth executable.")
216  ("userconfig-dir", po::value<std::string>(), "sets the path of the user config directory to $HOME/<arg> or My Documents\\My Games\\<arg> for Windows. You can specify also an absolute path outside the $HOME or My Documents\\My Games directory. Defaults to $HOME/.config/wesnoth on X11 and to the userdata-dir on other systems.")
217  ("userconfig-path", "prints the path of the user config directory and exits.")
218  ("userdata-dir", po::value<std::string>(), "sets the path of the userdata directory to $HOME/<arg> or My Documents\\My Games\\<arg> for Windows. You can specify also an absolute path outside the $HOME or My Documents\\My Games directory.")
219  ("userdata-path", "prints the path of the userdata directory and exits.")
220  ("username", po::value<std::string>(), "uses <username> when connecting to a server, ignoring other preferences.")
221  ("validcache", "assumes that the cache is valid. (dangerous)")
222  ("version,v", "prints the game's version number and exits.")
223  ("with-replay", "replays the file loaded with the --load option.")
224 #ifdef _WIN32
225  ("wconsole", "attaches a console window on startup (Windows only). Implied by any option that prints something and exits.")
226 #endif // _WIN32
227  ;
228 
229  po::options_description campaign_opts("Campaign options");
230  campaign_opts.add_options()
231  ("campaign,c", po::value<std::string>()->implicit_value(std::string()), "goes directly to the campaign with id <arg>. A selection menu will appear if no id was specified.")
232  ("campaign-difficulty", po::value<int>(), "The difficulty of the specified campaign (1 to max). If none specified, the campaign difficulty selection widget will appear.")
233  ("campaign-scenario", po::value<std::string>(),"The id of the scenario from the specified campaign. The default is the first scenario.")
234  ("campaign-skip-story", "Skip [story] tags of the specified campaign.")
235  ;
236 
237  po::options_description display_opts("Display options");
238  display_opts.add_options()
239  ("fps", "displays the number of frames per second the game is currently running at, in a corner of the screen. Min/avg/max don't take the FPS limiter into account, act does.")
240  ("fullscreen,f", "runs the game in full screen mode.")
241  ("max-fps", po::value<int>(), "the maximum fps the game tries to run at. Values should be between 1 and 1000, the default is the display's refresh rate.")
242  ("new-widgets", "there is a new WIP widget toolkit this switch enables the new toolkit (VERY EXPERIMENTAL don't file bug reports since most are known). Parts of the library are deemed stable and will work without this switch.")
243  ("resolution,r", po::value<std::string>(), "sets the screen resolution. <arg> should have format XxY. Example: --resolution 800x600")
244  ("windowed,w", "runs the game in windowed mode.")
245  ;
246 
247  po::options_description logging_opts("Logging options");
248  logging_opts.add_options()
249  ("logdomains", po::value<std::string>()->implicit_value(std::string()), "lists defined log domains (only the ones containing <arg> filter if such is provided) and exits.")
250  ("log-error", po::value<std::string>(), "sets the severity level of the specified log domain(s) to 'error'. <arg> should be given as a comma-separated list of domains, wildcards are allowed. Example: --log-error=network,gui/*,engine/enemies")
251  ("log-warning", po::value<std::string>(), "sets the severity level of the specified log domain(s) to 'warning'. Similar to --log-error.")
252  ("log-info", po::value<std::string>(), "sets the severity level of the specified log domain(s) to 'info'. Similar to --log-error.")
253  ("log-debug", po::value<std::string>(), "sets the severity level of the specified log domain(s) to 'debug'. Similar to --log-error.")
254  ("log-none", po::value<std::string>(), "sets the severity level of the specified log domain(s) to 'none'. Similar to --log-error.")
255  ("log-precise", "shows the timestamps in log output with more precision.")
256  ;
257 
258  po::options_description multiplayer_opts("Multiplayer options");
259  multiplayer_opts.add_options()
260  ("multiplayer,m", "Starts a multiplayer game. There are additional options that can be used as explained below:")
261  ("ai-config", po::value<std::vector<std::string>>()->composing(), "selects a configuration file to load for this side. <arg> should have format side:value")
262  ("algorithm", po::value<std::vector<std::string>>()->composing(), "selects a non-standard algorithm to be used by the AI controller for this side. <arg> should have format side:value")
263  ("controller", po::value<std::vector<std::string>>()->composing(), "selects the controller for this side. <arg> should have format side:value")
264  ("era", po::value<std::string>(), "selects the era to be played in by its id.")
265  ("exit-at-end", "exit Wesnoth at the end of the scenario.")
266  ("ignore-map-settings", "do not use map settings.")
267  ("label", po::value<std::string>(), "sets the label for AIs.") //TODO is the description precise? this option was undocumented before.
268  ("multiplayer-repeat", po::value<unsigned int>(), "repeats a multiplayer game after it is finished <arg> times.")
269  ("nogui", "runs the game without the GUI.")
270  ("parm", po::value<std::vector<std::string>>()->composing(), "sets additional parameters for this side. <arg> should have format side:name:value.")
271  ("scenario", po::value<std::string>(), "selects a multiplayer scenario. The default scenario is \"multiplayer_The_Freelands\".")
272  ("side", po::value<std::vector<std::string>>()->composing(), "selects a faction of the current era for this side by id. <arg> should have format side:value.")
273  ("turns", po::value<std::string>(), "sets the number of turns. By default no turn limit is set.")
274  ;
275 
276  po::options_description testing_opts("Testing options");
277  testing_opts.add_options()
278  ("test,t", po::value<std::string>()->implicit_value(std::string()), "runs the game in a small test scenario. If specified, scenario <arg> will be used instead.")
279  ("unit,u", po::value<std::vector<std::string>>(), "runs a unit test scenario. The GUI is not shown and the exit code of the program reflects the victory / defeat conditions of the scenario.\n\t0 - PASS\n\t1 - FAIL\n\t3 - FAIL (INVALID REPLAY)\n\t4 - FAIL (ERRORED REPLAY)\n\t5 - FAIL (BROKE STRICT)\n\t6 - FAIL (WML EXCEPTION)\n\tMultiple tests can be run by giving this option multiple times, in this case the test run will stop immediately after any test which doesn't PASS and the return code will be the status of the test that caused the stop.")
280  ("showgui", "don't run headlessly (for debugging a failing test)")
281  ("log-strict", po::value<std::string>(), "sets the strict level of the logger. any messages sent to log domains of this level or more severe will cause the unit test to fail regardless of the victory result.")
282  ("noreplaycheck", "don't try to validate replay of unit test.")
283  ("mp-test", "load the test mp scenarios.")
284  ;
285 
286  po::options_description parsing_opts("WML parsing options");
287  parsing_opts.add_options()
288  ("use-schema,S", po::value<std::string>(), "specify a schema to validate WML against (defaults to the core schema)")
289  ("validate,V", po::value<std::string>(), "validate a specified WML file against a schema")
290  ("validate-addon", po::value<std::string>(), "validate the specified addon's WML against the schema. Requires the user to play the campaign (in the GUI) to trigger the validation.")
291  ("validate-core", "validate the core WML against the schema")
292  ("validate-schema", po::value<std::string>(), "validate a specified WML schema")
293  ("diff,D", po::value<two_strings>()->multitoken(), "diff two preprocessed WML documents")
294  ("output,o", po::value<std::string>(), "output to specified file")
295  ("patch,P", po::value<two_strings>()->multitoken(), "apply a patch to a preprocessed WML document")
296  ("preprocess,p", po::value<two_strings>()->multitoken(), "requires two arguments: <file/folder> <target directory>. Preprocesses a specified file/folder. The preprocessed file(s) will be written in the specified target directory: a plain cfg file and a processed cfg file.")
297  ("preprocess-defines", po::value<std::string>(), "comma separated list of defines to be used by '--preprocess' command. If 'SKIP_CORE' is in the define list the data/core won't be preprocessed. Example: --preprocess-defines=FOO,BAR")
298  ("preprocess-input-macros", po::value<std::string>(), "used only by the '--preprocess' command. Specifies source file <arg> that contains [preproc_define]s to be included before preprocessing.")
299  ("preprocess-output-macros", po::value<std::string>()->implicit_value(std::string()), "used only by the '--preprocess' command. Will output all preprocessed macros in the target file <arg>. If the file is not specified the output will be file '_MACROS_.cfg' in the target directory of preprocess's command.")
300  ;
301 
302  //hidden_.add_options()
303  // ("example-hidden-option", "")
304  // ;
305  visible_.add(general_opts).add(campaign_opts).add(display_opts).add(logging_opts).add(multiplayer_opts).add(testing_opts).add(parsing_opts);
306 
307  all_.add(visible_).add(hidden_);
308 
309  po::positional_options_description positional;
310  positional.add("data-dir",1);
311 
312  po::variables_map vm;
313  const int parsing_style = po::command_line_style::default_style ^ po::command_line_style::allow_guessing;
314  po::store(po::command_line_parser(args_).options(all_).positional(positional).style(parsing_style).run(),vm);
315 
316  if (vm.count("ai-config"))
317  multiplayer_ai_config = parse_to_uint_string_tuples_(vm["ai-config"].as<std::vector<std::string>>());
318  if (vm.count("algorithm"))
319  multiplayer_algorithm = parse_to_uint_string_tuples_(vm["algorithm"].as<std::vector<std::string>>());
320  if (vm.count("bunzip2"))
321  bunzip2 = vm["bunzip2"].as<std::string>();
322  if (vm.count("bzip2"))
323  bzip2 = vm["bzip2"].as<std::string>();
324  if (vm.count("campaign"))
325  campaign = vm["campaign"].as<std::string>();
326  if (vm.count("campaign-difficulty"))
327  campaign_difficulty = vm["campaign-difficulty"].as<int>();
328  if (vm.count("campaign-scenario"))
329  campaign_scenario = vm["campaign-scenario"].as<std::string>();
330  if (vm.count("campaign-skip-story"))
331  campaign_skip_story = true;
332  if (vm.count("clock"))
333  clock = true;
334  if (vm.count("core"))
335  core_id = vm["core"].as<std::string>();
336  if (vm.count("config-dir"))
337  userdata_dir = vm["config-dir"].as<std::string>(); //TODO: complain and remove
338  if (vm.count("config-path"))
339  userdata_path = true; //TODO: complain and remove
340  if (vm.count("controller"))
341  multiplayer_controller = parse_to_uint_string_tuples_(vm["controller"].as<std::vector<std::string>>());
342  if (vm.count("data-dir"))
343  data_dir = vm["data-dir"].as<std::string>();
344  if (vm.count("data-path"))
345  data_path = true;
346  if (vm.count("debug"))
347  debug = true;
348  if (vm.count("debug-lua"))
349  debug_lua = true;
350 #ifdef DEBUG_WINDOW_LAYOUT_GRAPHS
351  if (vm.count("debug-dot-domain")) {
352  debug_dot_domain = vm["debug-dot-domain"].as<std::string>();
353  }
354  if (vm.count("debug-dot-level")) {
355  debug_dot_level = vm["debug-dot-level"].as<std::string>();
356  }
357 #endif
358  if (vm.count("editor"))
359  editor = vm["editor"].as<std::string>();
360  if (vm.count("era"))
361  multiplayer_era = vm["era"].as<std::string>();
362  if (vm.count("exit-at-end"))
364  if (vm.count("fps"))
365  fps = true;
366  if (vm.count("fullscreen"))
367  fullscreen = true;
368  if (vm.count("gunzip"))
369  gunzip = vm["gunzip"].as<std::string>();
370  if (vm.count("gzip"))
371  gzip = vm["gzip"].as<std::string>();
372  if (vm.count("help"))
373  help = true;
374  if (vm.count("ignore-map-settings"))
376  if (vm.count("label"))
377  multiplayer_label = vm["label"].as<std::string>();
378  if (vm.count("language"))
379  language = vm["language"].as<std::string>();
380  if (vm.count("load"))
381  load = vm["load"].as<std::string>();
382  if (vm.count("log-error"))
383  parse_log_domains_(vm["log-error"].as<std::string>(),lg::err().get_severity());
384  if (vm.count("log-warning"))
385  parse_log_domains_(vm["log-warning"].as<std::string>(),lg::warn().get_severity());
386  if (vm.count("log-info"))
387  parse_log_domains_(vm["log-info"].as<std::string>(),lg::info().get_severity());
388  if (vm.count("log-debug"))
389  parse_log_domains_(vm["log-debug"].as<std::string>(),lg::debug().get_severity());
390  if (vm.count("log-none"))
391  parse_log_domains_(vm["log-none"].as<std::string>(),-1);
392  if (vm.count("logdomains"))
393  logdomains = vm["logdomains"].as<std::string>();
394  if (vm.count("log-precise"))
395  log_precise_timestamps = true;
396  if (vm.count("log-strict"))
397  parse_log_strictness(vm["log-strict"].as<std::string>());
398  if (vm.count("max-fps"))
399  max_fps = vm["max-fps"].as<int>();
400  if (vm.count("mp-test"))
401  mptest = true;
402  if (vm.count("multiplayer"))
403  multiplayer = true;
404  if (vm.count("multiplayer-repeat"))
405  multiplayer_repeat = vm["multiplayer-repeat"].as<unsigned int>();
406  if (vm.count("new-widgets"))
407  new_widgets = true;
408  if (vm.count("noaddons"))
409  noaddons = true;
410  if (vm.count("nocache"))
411  nocache = true;
412  if (vm.count("nodelay"))
413  nodelay = true;
414  if (vm.count("nomusic"))
415  nomusic = true;
416  if (vm.count("noreplaycheck"))
417  noreplaycheck = true;
418  if (vm.count("nosound"))
419  nosound = true;
420  if (vm.count("nogui"))
421  nogui = true;
422  if (vm.count("parm"))
423  multiplayer_parm = parse_to_uint_string_string_tuples_(vm["parm"].as<std::vector<std::string>>());
424  if (vm.count("preprocess"))
425  {
426  preprocess = true;
427  preprocess_path = vm["preprocess"].as<two_strings>().first;
428  preprocess_target = vm["preprocess"].as<two_strings>().second;
429  }
430  if (vm.count("diff"))
431  {
432  do_diff = true;
433  diff_left = vm["diff"].as<two_strings>().first;
434  diff_right = vm["diff"].as<two_strings>().second;
435  }
436  if (vm.count("patch"))
437  {
438  do_patch = true;
439  diff_left = vm["patch"].as<two_strings>().first;
440  diff_right = vm["patch"].as<two_strings>().second;
441  }
442  if (vm.count("output"))
443  {
444  output_file = vm["output"].as<std::string>();
445  }
446  if (vm.count("preprocess-defines"))
447  preprocess_defines = utils::split(vm["preprocess-defines"].as<std::string>(), ',');
448  if (vm.count("preprocess-input-macros"))
449  preprocess_input_macros = vm["preprocess-input-macros"].as<std::string>();
450  if (vm.count("preprocess-output-macros"))
451  preprocess_output_macros = vm["preprocess-output-macros"].as<std::string>();
452  if (vm.count("resolution"))
453  parse_resolution_(vm["resolution"].as<std::string>());
454  if (vm.count("rng-seed"))
455  rng_seed = vm["rng-seed"].as<unsigned int>();
456  if (vm.count("scenario"))
457  multiplayer_scenario = vm["scenario"].as<std::string>();
458  if (vm.count("render-image"))
459  {
460  render_image = vm["render-image"].as<two_strings>().first;
461  render_image_dst = vm["render-image"].as<two_strings>().second;
462  }
463  if (vm.count("screenshot"))
464  {
465  screenshot = true;
466  screenshot_map_file = vm["screenshot"].as<two_strings>().first;
467  screenshot_output_file = vm["screenshot"].as<two_strings>().second;
468  }
469  if (vm.count("script"))
470  script_file = vm["script"].as<std::string>();
471  if (vm.count("unsafe-scripts"))
472  script_unsafe_mode = true;
473  if (vm.count("plugin"))
474  plugin_file = vm["plugin"].as<std::string>();
475  if (vm.count("server"))
476  server = vm["server"].as<std::string>();
477  if (vm.count("username"))
478  username = vm["username"].as<std::string>();
479  if (vm.count("password"))
480  password = vm["password"].as<std::string>();
481  if (vm.count("report"))
482  report = true;
483  if (vm.count("side"))
484  multiplayer_side = parse_to_uint_string_tuples_(vm["side"].as<std::vector<std::string>>());
485  if (vm.count("test"))
486  test = vm["test"].as<std::string>();
487  if (vm.count("unit"))
488  {
489  unit_test = vm["unit"].as<std::vector<std::string>>();
490  headless_unit_test = true;
491  }
492  if (vm.count("showgui"))
493  headless_unit_test = false;
494  if (vm.count("noreplaycheck"))
495  noreplaycheck = true;
496  if (vm.count("turns"))
497  multiplayer_turns = vm["turns"].as<std::string>();
498  if (vm.count("strict-validation"))
499  strict_validation = true;
500  if (vm.count("userconfig-dir"))
501  userconfig_dir = vm["userconfig-dir"].as<std::string>();
502  if (vm.count("userconfig-path"))
503  userconfig_path = true;
504  if (vm.count("userdata-dir"))
505  userdata_dir = vm["userdata-dir"].as<std::string>();
506  if (vm.count("userdata-path"))
507  userdata_path = true;
508  if (vm.count("validcache"))
509  validcache = true;
510  // If you add a new validate-* option, remember the any_validation_option() function
511  if (vm.count("validate"))
512  validate_wml = vm["validate"].as<std::string>();
513  if (vm.count("validate-core"))
514  validate_core = true;
515  if (vm.count("validate-addon"))
516  validate_addon = vm["validate-addon"].as<std::string>();
517  if (vm.count("validate-schema"))
518  validate_schema = vm["validate-schema"].as<std::string>();
519  // If you add a new validate-* option, remember the any_validation_option() function
520  if (vm.count("use-schema"))
521  validate_with = vm["use-schema"].as<std::string>();;
522  if (vm.count("version"))
523  version = true;
524  if (vm.count("windowed"))
525  windowed = true;
526  if (vm.count("with-replay"))
527  with_replay = true;
528  if(vm.count("all-translations"))
530  else if(vm.count("translations-over"))
531  translation_percent = std::clamp<unsigned int>(vm["translations-over"].as<unsigned int>(), 0, 100);
532 }
533 
534 void commandline_options::parse_log_domains_(const std::string &domains_string, const int severity)
535 {
536  const std::vector<std::string> domains = utils::split(domains_string, ',');
537  for (const std::string& domain : domains)
538  {
539  if (!log)
540  log = std::vector<std::pair<int, std::string>>();
541  log->emplace_back(severity, domain);
542  }
543 }
544 
545 void commandline_options::parse_log_strictness (const std::string & severity ) {
546  static const std::array<lg::logger const*, 4> loggers {{&lg::err(), &lg::warn(), &lg::info(), &lg::debug()}};
547  for (const lg::logger * l : loggers ) {
548  if (severity == l->get_name()) {
550  return ;
551  }
552  }
553  std::cerr << "Unrecognized argument to --log-strict : " << severity << " . \nDisabling strict mode logging." << std::endl;
555 }
556 
557 void commandline_options::parse_resolution_ ( const std::string& resolution_string )
558 {
559  const std::vector<std::string> tokens = utils::split(resolution_string, 'x');
560  if (tokens.size() != 2) {
561  throw bad_commandline_resolution(resolution_string);
562  }
563 
564  int xres, yres;
565 
566  try {
567  xres = std::stoi(tokens[0]);
568  yres = std::stoi(tokens[1]);
569  } catch(const std::invalid_argument &) {
570  throw bad_commandline_resolution(resolution_string);
571  }
572 
573  resolution = std::make_pair(xres, yres);
574 }
575 
576 std::vector<std::pair<unsigned int,std::string>> commandline_options::parse_to_uint_string_tuples_(const std::vector<std::string> &strings, char separator)
577 {
578  std::vector<std::pair<unsigned int,std::string>> vec;
579  const std::string& expected_format
580  = std::string() + "UINT" + separator + "STRING";
581 
582  for (const std::string &s : strings)
583  {
584  const std::vector<std::string> tokens = utils::split(s, separator);
585  if(tokens.size() != 2) {
586  throw bad_commandline_tuple(s, expected_format);
587  }
588 
589  unsigned int temp;
590  try {
591  temp = lexical_cast<unsigned int>(tokens[0]);
592  } catch (const bad_lexical_cast &) {
593  throw bad_commandline_tuple(s, expected_format);
594  }
595 
596  vec.emplace_back(temp, tokens[1]);
597  }
598  return vec;
599 }
600 
601 std::vector<std::tuple<unsigned int,std::string,std::string>> commandline_options::parse_to_uint_string_string_tuples_(const std::vector<std::string> &strings, char separator)
602 {
603  std::vector<std::tuple<unsigned int,std::string,std::string>> vec;
604  const std::string& expected_format
605  = std::string() + "UINT" + separator + "STRING" + separator + "STRING";
606 
607  for (const std::string &s : strings)
608  {
609  const std::vector<std::string> tokens = utils::split(s, separator);
610  if(tokens.size() != 3) {
611  throw bad_commandline_tuple(s, expected_format);
612  }
613 
614  unsigned int temp;
615  try {
616  temp = lexical_cast<unsigned int>(tokens[0]);
617  } catch (const bad_lexical_cast &) {
618  throw bad_commandline_tuple(s, expected_format);
619  }
620 
621  vec.emplace_back(temp, tokens[1], tokens[2]);
622  }
623  return vec;
624 }
625 
626 std::ostream& operator<<(std::ostream &os, const commandline_options& cmdline_opts)
627 {
628  os << "Usage: " << cmdline_opts.args0_ << " [<options>] [<data-directory>]\n";
629  os << cmdline_opts.visible_;
630  return os;
631 }
632 
634  config ret;
635  if (server) {
636  ret["server"] = *server;
637  }
638  if (username) {
639  ret["username"] = *username;
640  }
641  if (password) {
642  ret["password"] = *password;
643  }
644  return ret;
645 }
646 
648 {
650 }
bool log_precise_timestamps
True if –log-precise was given on the command line.
bool new_widgets
Do we wish to use the new library or not.
Definition: settings.cpp:24
std::vector< std::string > args_
std::optional< std::string > preprocess_path
Path to parse that was given to the –preprocess option.
std::optional< std::string > output_file
Output filename for WML diff or preprocessing.
std::optional< std::string > core_id
Non-empty if –core was given on the command line.
bool any_validation_option() const
True if the –validate or any of the –validate-* options are given.
std::optional< std::string > preprocess_output_macros
Non-empty if –preprocess-output-macros was given on the command line.
bool mptest
True if –mp-test was given on the command line.
static domain_map * domains
Definition: log.cpp:74
boost::program_options::options_description all_
bool nogui
True if –nogui was given on the command line.
bool script_unsafe_mode
Whether to load the "package" package for the scripting environment.
std::optional< std::string > test
Non-empty if –test was given on the command line.
std::optional< std::vector< std::pair< unsigned int, std::string > > > multiplayer_ai_config
Non-empty if –ai-config was given on the command line.
std::vector< game_tip > load(const config &cfg)
Loads the tips from a config.
Definition: tips.cpp:35
commandline_options(const std::vector< std::string > &args)
std::vector< std::tuple< unsigned int, std::string, std::string > > parse_to_uint_string_string_tuples_(const std::vector< std::string > &strings, char separator=':')
A helper function splitting vector of strings of format unsigned int:string:string to vector of tuple...
std::optional< std::string > password
Non-empty if –password was given on the command line.
boost::program_options::options_description hidden_
static l_noret error(LoadState *S, const char *why)
Definition: lundump.cpp:39
bool noaddons
True if –noaddons was given on the command line.
std::optional< unsigned int > translation_percent
Non-empty if –all-translations or –translations-over is given on the command line.
New lexcical_cast header.
logger & info()
Definition: log.cpp:91
void parse_log_domains_(const std::string &domains_string, const int severity)
bool userdata_path
True if –userdata-path was given on the command line.
bool multiplayer_ignore_map_settings
True if –ignore-map-settings was given at the command line.
std::optional< std::string > preprocess_target
Target (output) path that was given to the –preprocess option.
std::optional< std::string > preprocess_input_macros
Non-empty if –preprocess-input-macros was given on the command line.
std::optional< std::string > multiplayer_label
Non-empty if –label was given on the command line.
std::optional< std::vector< std::tuple< unsigned int, std::string, std::string > > > multiplayer_parm
Non-empty if –parm was given on the command line.
std::optional< std::string > userconfig_dir
Non-empty if –userconfig-dir was given on the command line.
bool fps
True if –fps was given on the command line.
std::vector< std::string > unit_test
Non-empty if –unit was given on the command line.
bool noreplaycheck
True if –noreplaycheck was given on the command line.
std::optional< std::string > load
Non-empty if –load was given on the command line.
std::optional< int > max_fps
Max FPS specified by –max-fps option.
void parse_resolution_(const std::string &resolution_string)
To lexical_cast(From value)
Lexical cast converts one type to another.
Definitions for the interface to Wesnoth Markup Language (WML).
bad_commandline_tuple(const std::string &str, const std::string &expected_format)
std::string diff_left
Files for diffing or patching.
bool preprocess
True if –preprocess was given on the command line.
bool with_replay
True if –with-replay was given on the command line.
bool headless_unit_test
True if –unit is used and –showgui is not present.
const config & options()
Definition: game.cpp:563
std::optional< std::string > render_image_dst
Output file to put rendered image path in.
bool report
True if –report was given on the command line.
std::optional< std::string > gzip
Non-empty if –gzip was given on the command line.
std::ostringstream wrapper.
Definition: formatter.hpp:38
bool nodelay
True if –nodelay was given on the command line.
std::optional< unsigned int > rng_seed
RNG seed specified by –rng-seed option.
std::optional< std::vector< std::pair< int, std::string > > > log
Contains parsed arguments of –log-* (e.g.
std::optional< std::string > validate_addon
Non-empty if –validate-addon was given on the command line.
bool fullscreen()
Definition: general.cpp:393
std::optional< int > campaign_difficulty
Non-empty if –campaign-difficulty was given on the command line.
bool windowed
True if –windowed was given on the command line.
std::optional< std::string > bunzip2
Non-empty if –bunzip2 was given on the command line.
std::vector< std::pair< unsigned int, std::string > > parse_to_uint_string_tuples_(const std::vector< std::string > &strings, char separator=':')
A helper function splitting vector of strings of format unsigned int:string to vector of tuples (unsi...
bool multiplayer
True if –multiplayer was given on the command line.
std::optional< std::vector< std::pair< unsigned int, std::string > > > multiplayer_algorithm
Non-empty if –algorithm was given on the command line.
Manage the empty-palette in the editor.
Definition: action.cpp:29
logger & debug()
Definition: log.cpp:97
bool clock
True if –clock was given on the command line.
bool userconfig_path
True if –userconfig-path was given on the command line.
std::optional< std::string > bzip2
Non-empty if –bzip2 was given on the command line.
std::optional< std::string > logdomains
Non-empty if –logdomains was given on the command line.
std::optional< std::string > render_image
Image path to render.
bool nomusic
True if –nomusic was given on the command line.
std::optional< std::string > multiplayer_era
Non-empty if –era was given on the command line.
std::optional< std::string > campaign
Non-empty if –campaign was given on the command line.
bool debug
True if –debug was given on the command line.
bool debug_lua
True if –debug-lua was given in the commandline.
bool nocache
True if –nocache was given on the command line.
logger & err()
Definition: log.cpp:79
void set_strict_severity(int severity)
Definition: log.cpp:162
bool new_widgets
True if –new-widgets was given on the command line.
std::optional< std::string > screenshot_output_file
Output file to put screenshot in.
std::optional< std::string > gunzip
Non-empty if –gunzip was given on the command line.
std::optional< std::vector< std::pair< unsigned int, std::string > > > multiplayer_side
Non-empty if –side was given on the command line.
static map_location::DIRECTION s
std::string password(const std::string &server, const std::string &login)
std::optional< std::string > userdata_dir
Non-empty if –userdata-dir was given on the command line.
std::string language()
Definition: general.cpp:474
bad_commandline_resolution(const std::string &resolution)
static void validate(boost::any &v, const std::vector< std::string > &values, two_strings *, int)
std::optional< std::string > script_file
File to load lua script from.
#define debug(x)
std::optional< std::string > username
Non-empty if –username was given on the command line.
std::optional< std::string > data_dir
Non-empty if –data-dir was given on the command line.
std::optional< std::string > multiplayer_scenario
Non-empty if –scenario was given on the command line.
bool campaign_skip_story
True if –skip-story was given on the command line.
std::string core_id()
Definition: general.cpp:312
void parse_log_strictness(const std::string &severity)
std::optional< std::string > server
Non-empty if –server was given on the command line.
bool data_path
True if –data-path was given on the command line.
bool screenshot
True if –screenshot was given on the command line.
logger & warn()
Definition: log.cpp:85
std::vector< std::string > split(const config_attribute_value &val)
bool version
True if –version was given on the command line.
bool validate_core
True if –validate-core was given on the command line.
std::optional< std::string > screenshot_map_file
Map file to make a screenshot of.
Standard logging facilities (interface).
std::optional< std::string > validate_with
Non-empty if –use-schema was given on the command line.
std::optional< std::string > validate_wml
Non-empty if –validate was given on the command line.
bool fullscreen
True if –fullscreen was given on the command line.
bool validcache
True if –validcache was given on the command line.
bool strict_validation
True if –strict-validation was given on the command line.
std::optional< std::string > multiplayer_turns
Non-empty if –turns was given on the command line.
point resolution()
Definition: general.cpp:372
std::optional< std::vector< std::string > > preprocess_defines
Defines that were given to the –preprocess option.
Definition: help.cpp:55
std::optional< unsigned int > multiplayer_repeat
Repeats specified by –multiplayer-repeat option.
bool nosound
True if –nosound was given on the command line.
std::optional< std::vector< std::pair< unsigned int, std::string > > > multiplayer_controller
Non-empty if –controller was given on the command line.
boost::program_options::options_description visible_
friend std::ostream & operator<<(std::ostream &os, const commandline_options &cmdline_opts)
To be used for printing help to the commandline.
int style
Definition: sdl_ttf.cpp:57
bool multiplayer_exit_at_end
True if –exit-at-and was given on the command line.
A config object defines a single node in a WML file, with access to child nodes.
Definition: config.hpp:60
std::optional< std::string > campaign_scenario
Non-empty if –campaign-scenario was given on the command line.
std::optional< std::string > validate_schema
Non-empty if –validate-schema was given on the command line.
int get_severity() const
Definition: log.hpp:147
std::optional< std::pair< int, int > > resolution
Pair of AxB values specified after –resolution.
Thrown when a lexical_cast fails.
std::optional< std::string > plugin_file
File to load a lua plugin (similar to a script) from.
std::optional< std::string > language
Non-empty if –language was given on the command line.