The Battle for Wesnoth  1.19.1+dev
filesystem.hpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2003 - 2024
3  by David White <dave@whitevine.net>
4  Part of the Battle for Wesnoth Project https://www.wesnoth.org/
5 
6  This program is free software; you can redistribute it and/or modify
7  it under the terms of the GNU General Public License as published by
8  the Free Software Foundation; either version 2 of the License, or
9  (at your option) any later version.
10  This program is distributed in the hope that it will be useful,
11  but WITHOUT ANY WARRANTY.
12 
13  See the COPYING file for more details.
14 */
15 
16 /**
17  * @file
18  * Declarations for File-IO.
19  */
20 
21 #pragma once
22 
23 #include <ctime>
24 #include <fstream>
25 #include <iosfwd>
26 #include <memory>
27 #include <optional>
28 #include <string>
29 #include <vector>
30 
31 #include "exceptions.hpp"
32 #include "game_version.hpp"
33 #include "global.hpp"
34 
35 namespace game_config {
36 extern std::string path;
37 extern std::string default_preferences_path;
38 extern bool check_migration;
39 
40 /** observer team name used for observer team chat */
41 extern const std::string observer_team_name;
42 
43 extern int cache_compression_level;
44 }
45 
46 class config;
47 class game_config_view;
48 struct SDL_RWops;
49 
50 namespace filesystem {
51 
52 using scoped_istream = std::unique_ptr<std::istream>;
53 using scoped_ostream = std::unique_ptr<std::ostream>;
54 
56 {
57  void operator()(SDL_RWops*) const noexcept;
58 };
59 
60 using rwops_ptr = std::unique_ptr<SDL_RWops, sdl_rwops_deleter>;
61 
62 rwops_ptr make_read_RWops(const std::string &path);
63 rwops_ptr make_write_RWops(const std::string &path);
64 
65 /** An exception object used when an IO error occurs */
66 struct io_exception : public game::error {
67  io_exception() : game::error("") {}
68  io_exception(const std::string& msg) : game::error(msg) {}
69 };
70 
71 struct file_tree_checksum;
72 
76 
77 // default extensions
78 const std::string map_extension = ".map";
79 const std::string mask_extension = ".mask";
80 const std::string wml_extension = ".cfg";
81 
82 // A list of file and directory blacklist patterns
84 {
85 public:
88  {}
89  blacklist_pattern_list(const std::vector<std::string>& file_patterns, const std::vector<std::string>& directory_patterns)
90  : file_patterns_(file_patterns), directory_patterns_(directory_patterns)
91  {}
92 
93  bool match_file(const std::string& name) const;
94 
95  bool match_dir(const std::string& name) const;
96 
97  void add_file_pattern(const std::string& pattern)
98  {
99  file_patterns_.push_back(pattern);
100  }
101 
102  void add_directory_pattern(const std::string& pattern)
103  {
104  directory_patterns_.push_back(pattern);
105  }
106 
107  void remove_blacklisted_files_and_dirs(std::vector<std::string>& files, std::vector<std::string>& directories) const;
108 
109 private:
110  std::vector<std::string> file_patterns_;
111  std::vector<std::string> directory_patterns_;
112 };
113 
115 
116 /**
117  * Get a list of all files and/or directories in a given directory.
118  *
119  * @param dir The directory to examine.
120  * @param[out] files The files in @a dir. Won't be used if nullptr.
121  * @param[out] dirs The directories in @a dir. Won't be used if nullptr.
122  * @param mode Determines whether the entire path or just the filename is retrieved.
123  * @param filter Determines if we skip images and sounds directories.
124  * @param reorder Triggers the special handling of _main.cfg and _final.cfg.
125  * @param[out] checksum Can be used to store checksum info.
126  */
127 void get_files_in_dir(const std::string &dir,
128  std::vector<std::string>* files,
129  std::vector<std::string>* dirs=nullptr,
133  file_tree_checksum* checksum = nullptr);
134 
135 std::string get_dir(const std::string &dir);
136 
137 // The location of various important files/folders:
138 /**
139  * location of preferences file containing preferences that are synced between computers
140  * note that wesnoth does not provide the syncing functionality itself
141  */
142 std::string get_synced_prefs_file();
143 /** location of preferences file containing preferences that aren't synced between computers */
144 std::string get_unsynced_prefs_file();
145 std::string get_credentials_file();
146 std::string get_default_prefs_file();
147 std::string get_save_index_file();
148 std::string get_lua_history_file();
149 /**
150  * parent directory for everything that should be synced between systems.
151  * implemented due to limitations of Steam's AutoCloud (non-SDK) syncing, but will also simplify things if it's ever added for any other platforms.
152  */
153 std::string get_sync_dir();
154 std::string get_saves_dir();
155 std::string get_wml_persist_dir();
156 std::string get_intl_dir();
157 std::string get_screenshot_dir();
158 std::string get_addons_data_dir();
159 std::string get_addons_dir();
160 std::string get_current_editor_dir(const std::string& addon_id);
161 const std::string get_version_path_suffix(const version_info& version);
162 const std::string& get_version_path_suffix();
163 
164 /**
165  * Get the next free filename using "name + number (3 digits) + extension"
166  * maximum 1000 files then start always giving 999
167  */
168 std::string get_next_filename(const std::string& name, const std::string& extension);
169 
171 void set_user_data_dir(std::string path);
172 void set_cache_dir(const std::string& path);
173 
174 std::string get_user_data_dir();
175 std::string get_logs_dir();
176 std::string get_cache_dir();
177 std::string get_legacy_editor_dir();
178 std::string get_core_images_dir();
179 
180 bool rename_dir(const std::string& old_dir, const std::string& new_dir);
181 
183 {
184  /**
185  * Here the version is given as a string instead of a version_info, because the
186  * logic of how many components are significant ("1.16" rather than
187  * "1.16.0") is encapsulated in find_other_version_saves_dirs().
188  */
189  std::string version;
190  std::string path;
191 
192  // constructor because emplace_back() doesn't use aggregate initialization
193  other_version_dir(const std::string& v, const std::string& p)
194  : version(v)
195  , path(p)
196  {
197  }
198 };
199 
200 /**
201  * Searches for directories containing saves created by other versions of Wesnoth.
202  *
203  * The directories returned will exist, but might not contain any saves. Changes to
204  * the filesystem (by running other versions or by deleting old directories) may
205  * change the results returned by the function.
206  */
207 std::vector<other_version_dir> find_other_version_saves_dirs();
208 
209 std::string get_cwd();
210 bool set_cwd(const std::string& dir);
211 
212 std::string get_exe_path();
213 std::string get_exe_dir();
214 std::string get_wesnothd_name();
215 
216 bool make_directory(const std::string& dirname);
217 bool delete_directory(const std::string& dirname, const bool keep_pbl = false);
218 bool delete_file(const std::string& filename);
219 
220 bool looks_like_pbl(const std::string& file);
221 
222 // Basic disk I/O:
223 
224 /** Basic disk I/O - read file. */
225 std::string read_file(const std::string& fname);
226 std::vector<uint8_t> read_file_binary(const std::string& fname);
227 std::string read_file_as_data_uri(const std::string& fname);
228 
229 filesystem::scoped_istream istream_file(const std::string& fname, bool treat_failure_as_error = true);
230 filesystem::scoped_ostream ostream_file(const std::string& fname, std::ios_base::openmode mode = std::ios_base::binary, bool create_directory = true);
231 /** Throws io_exception if an error occurs. */
232 void write_file(const std::string& fname, const std::string& data, std::ios_base::openmode mode = std::ios_base::binary);
233 /**
234  * Read a file and then writes it back out.
235  *
236  * @param src The source file.
237  * @param dest The destination of the copied file.
238  */
239 void copy_file(const std::string& src, const std::string& dest);
240 
241 std::string read_map(const std::string& name);
242 std::string read_scenario(const std::string& name);
243 
244 /**
245  * Creates a directory if it does not exist already.
246  *
247  * @param dirname Path to directory. All parents should exist.
248  * @returns True if the directory exists or could be
249  * successfully created; false otherwise.
250  */
251 bool create_directory_if_missing(const std::string& dirname);
252 /**
253  * Creates a recursive directory tree if it does not exist already
254  * @param dirname Full path of target directory. Non existing parents
255  * will be created
256  * @return True if the directory exists or could be
257  * successfully created; false otherwise.
258  */
259 bool create_directory_if_missing_recursive(const std::string& dirname);
260 
261 /** Returns true if the given file is a directory. */
262 bool is_directory(const std::string& fname);
263 
264 /** Returns true if a file or directory with such name already exists. */
265 bool file_exists(const std::string& name);
266 
267 /** Get the modification time of a file. */
268 std::time_t file_modified_time(const std::string& fname);
269 
270 /** Returns true if the file ends with the mapfile extension. */
271 bool is_map(const std::string& filename);
272 
273 /** Returns true if the file ends with the wmlfile extension. */
274 bool is_cfg(const std::string& filename);
275 
276 /** Returns true if the file ends with the maskfile extension. */
277 bool is_mask(const std::string& filename);
278 
279 /** Returns true if the file ends with '.gz'. */
280 bool is_gzip_file(const std::string& filename);
281 
282 /** Returns true if the file ends with '.bz2'. */
283 bool is_bzip2_file(const std::string& filename);
284 
285 inline bool is_compressed_file(const std::string& filename) {
286  return is_gzip_file(filename) || is_bzip2_file(filename);
287 }
288 
289 /**
290  * Returns whether the given filename is a legal name for a user-created file.
291  *
292  * This is meant to be used for any files created by Wesnoth where user input
293  * is required, including save files and add-on files for uploading to the
294  * add-ons server.
295  *
296  * @param name File name to verify.
297  * @param allow_whitespace Whether whitespace should be allowed.
298  */
299 bool is_legal_user_file_name(const std::string& name, bool allow_whitespace = true);
300 
302 {
304  explicit file_tree_checksum(const config& cfg);
305  void write(config& cfg) const;
306  void reset() {nfiles = 0;modified = 0;sum_size=0;}
307  // @todo make variables private!
308  std::size_t nfiles, sum_size;
309  std::time_t modified;
310  bool operator==(const file_tree_checksum &rhs) const;
311  bool operator!=(const file_tree_checksum &rhs) const
312  { return !operator==(rhs); }
313 };
314 
315 /** Get the time at which the data/ tree was last modified at. */
316 const file_tree_checksum& data_tree_checksum(bool reset = false);
317 
318 /** Returns the size of a file, or -1 if the file doesn't exist. */
319 int file_size(const std::string& fname);
320 
321 /** Returns the sum of the sizes of the files contained in a directory. */
322 int dir_size(const std::string& path);
323 
324 bool ends_with(const std::string& str, const std::string& suffix);
325 
326 /**
327  * Returns the base filename of a file, with directory name stripped.
328  * Equivalent to a portable basename() function.
329  *
330  * If @a remove_extension is true, the filename extension will be stripped
331  * from the returned value.
332  */
333 std::string base_name(const std::string& file, const bool remove_extension = false);
334 
335 /**
336  * Returns the directory name of a file, with filename stripped.
337  * Equivalent to a portable dirname()
338  */
339 std::string directory_name(const std::string& file);
340 
341 /**
342  * Finds the nearest parent in existence for a file or directory.
343  *
344  * @note The file's own existence is not checked.
345  *
346  * @returns An absolute path to the closest parent of the given path, or an
347  * empty string if none could be found. While on POSIX platforms this
348  * cannot happen (unless the original path was already empty), on
349  * Windows it might be the case that the original path refers to a
350  * drive letter or network share that does not exist.
351  */
352 std::string nearest_extant_parent(const std::string& file);
353 
354 /**
355  * Returns the absolute path of a file.
356  *
357  * @param path Original path.
358  * @param normalize_separators Whether to substitute path separators with the
359  * platform's preferred format.
360  * @param resolve_dot_entries Whether to resolve . and .. directory entries.
361  * This requires @a path to refer to a valid
362  * existing object.
363  *
364  * @returns An absolute path -- that is, a path that is independent of the
365  * current working directory for the process. If resolve_dot_entries
366  * is set to true, the returned path has . and .. components resolved;
367  * however, if resolution fails because a component does not exist, an
368  * empty string is returned instead.
369  */
370 std::string normalize_path(const std::string& path,
371  bool normalize_separators = false,
372  bool resolve_dot_entries = false);
373 
374 /** Helper function to convert absolute path to wesnoth relative path */
375 bool to_asset_path(std::string& abs_path,
376  std::string addon_id,
377  std::string asset_type);
378 
379 /**
380  * Sanitizes a path to remove references to the user's name.
381  */
382 std::string sanitize_path(const std::string& path);
383 
384 /**
385  * Returns whether the path is the root of the file hierarchy.
386  *
387  * @note This function is unreliable for paths that do not exist -- it will
388  * always return @a false for those.
389  */
390 bool is_root(const std::string& path);
391 
392 /**
393  * Returns the name of the root device if included in the given path.
394  *
395  * This only properly makes sense on Windows with paths containing a drive
396  * letter or UNC at the start -- otherwise, it will return the empty string. To
397  * ensure that a suitable root name can be found you might want to use
398  * normalize_path() first with @a resolve_dot_entries set to true.
399  */
400 std::string root_name(const std::string& path);
401 
402 /**
403  * Returns whether the path seems to be relative.
404  */
405 bool is_relative(const std::string& path);
406 
407 /**
408  * Returns whether @a c is a path separator.
409  *
410  * @note / is always a path separator. Additionally, on Windows \\ is a
411  * path separator as well.
412  */
413 bool is_path_sep(char c);
414 
415 /**
416  * Returns the standard path separator for the current platform.
417  */
418 char path_separator();
419 
420 /**
421  * The paths manager is responsible for recording the various paths
422  * that binary files may be located at.
423  * It should be passed a config object which holds binary path information.
424  * This is in the format
425  *@verbatim
426  * [binary_path]
427  * path=<path>
428  * [/binary_path]
429  * Binaries will be searched for in [wesnoth-path]/data/<path>/images/
430  *@endverbatim
431  */
433 {
437 
438  void set_paths(const game_config_view& cfg);
439 
440 private:
443 
444  void cleanup();
445 
446  std::vector<std::string> paths_;
447 };
448 
450 
451 /**
452  * Returns a vector with all possible paths to a given type of binary,
453  * e.g. 'images', 'sounds', etc,
454  */
455 NOT_DANGLING const std::vector<std::string>& get_binary_paths(const std::string& type);
456 
457 /**
458  * Returns a complete path to the actual file of a given @a type, if it exists.
459  */
460 std::optional<std::string> get_binary_file_location(const std::string& type, const std::string& filename);
461 
462 /**
463  * Returns a complete path to the actual directory of a given @a type, if it exists.
464  */
465 std::optional<std::string> get_binary_dir_location(const std::string &type, const std::string &filename);
466 
467 /**
468  * Returns a complete path to the actual WML file or directory, if either exists.
469  */
470 std::optional<std::string> get_wml_location(const std::string &filename,
471  const std::string &current_dir = std::string());
472 
473 /**
474  * Returns a short path to @a filename, skipping the (user) data directory.
475  */
476 std::string get_short_wml_path(const std::string &filename);
477 
478 /**
479  * Returns an asset path to @a filename for binary path-independent use in saved games.
480  *
481  * Example:
482  * images, units/konrad-fighter.png ->
483  * data/campaigns/Heir_To_The_Throne/images/units/konrad-fighter.png
484  */
485 std::optional<std::string> get_independent_binary_file_path(const std::string& type, const std::string &filename);
486 
487 /**
488  * Returns the appropriate invocation for a Wesnoth-related binary, assuming
489  * that it is located in the same directory as the running wesnoth binary.
490  * This is just a string-transformation based on argv[0], so the returned
491  * program is not guaranteed to actually exist. '-debug' variants are handled
492  * correctly.
493  */
494 std::string get_program_invocation(const std::string &program_name);
495 
496 /**
497  * Returns the localized version of the given filename, if it exists.
498  */
499 std::optional<std::string> get_localized_path(const std::string& file, const std::string& suff = "");
500 
501 /**
502  * Returns the add-on ID from a path.
503  * aka the directory directly following the "add-ons" folder, or an empty string if none is found.
504  */
505 std::optional<std::string> get_addon_id_from_path(const std::string& location);
506 
507 }
A config object defines a single node in a WML file, with access to child nodes.
Definition: config.hpp:159
std::vector< std::string > file_patterns_
Definition: filesystem.hpp:110
bool match_file(const std::string &name) const
void remove_blacklisted_files_and_dirs(std::vector< std::string > &files, std::vector< std::string > &directories) const
void add_file_pattern(const std::string &pattern)
Definition: filesystem.hpp:97
std::vector< std::string > directory_patterns_
Definition: filesystem.hpp:111
blacklist_pattern_list(const std::vector< std::string > &file_patterns, const std::vector< std::string > &directory_patterns)
Definition: filesystem.hpp:89
void add_directory_pattern(const std::string &pattern)
Definition: filesystem.hpp:102
bool match_dir(const std::string &name) const
A class grating read only view to a vector of config objects, viewed as one config with all children ...
Represents version numbers.
Interfaces for manipulating version numbers of engine, add-ons, etc.
#define NOT_DANGLING
Definition: global.hpp:61
std::string get_legacy_editor_dir()
std::string get_cache_dir()
Definition: filesystem.cpp:803
std::time_t file_modified_time(const std::string &fname)
Get the modification time of a file.
bool is_bzip2_file(const std::string &filename)
Returns true if the file ends with '.bz2'.
int dir_size(const std::string &pname)
Returns the sum of the sizes of the files contained in a directory.
bool is_relative(const std::string &path)
Returns whether the path seems to be relative.
filesystem::scoped_istream istream_file(const std::string &fname, bool treat_failure_as_error)
bool is_root(const std::string &path)
Returns whether the path is the root of the file hierarchy.
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.
Definition: filesystem.cpp:410
const std::string wml_extension
Definition: filesystem.hpp:80
bool is_cfg(const std::string &filename)
Returns true if the file ends with the wmlfile extension.
static bfs::path get_dir(const bfs::path &dirpath)
Definition: filesystem.cpp:335
std::string get_user_data_dir()
Definition: filesystem.cpp:793
std::string base_name(const std::string &file, const bool remove_extension)
Returns the base filename of a file, with directory name stripped.
std::string get_wml_persist_dir()
bool rename_dir(const std::string &old_dir, const std::string &new_dir)
Definition: filesystem.cpp:762
std::string get_exe_path()
Definition: filesystem.cpp:913
std::optional< std::string > get_addon_id_from_path(const std::string &location)
Returns the add-on ID from a path.
void copy_file(const std::string &src, const std::string &dest)
Read a file and then writes it back out.
bool delete_file(const std::string &filename)
bool is_gzip_file(const std::string &filename)
Returns true if the file ends with '.gz'.
std::optional< std::string > get_independent_binary_file_path(const std::string &type, const std::string &filename)
Returns an asset path to filename for binary path-independent use in saved games.
static bool file_exists(const bfs::path &fpath)
Definition: filesystem.cpp:324
std::unique_ptr< SDL_RWops, sdl_rwops_deleter > rwops_ptr
Definition: filesystem.hpp:60
std::string get_exe_dir()
Definition: filesystem.cpp:969
bool is_legal_user_file_name(const std::string &name, bool allow_whitespace=true)
Returns whether the given filename is a legal name for a user-created file.
bool is_directory(const std::string &fname)
Returns true if the given file is a directory.
bool delete_directory(const std::string &dirname, const bool keep_pbl)
Definition: filesystem.cpp:999
std::string get_synced_prefs_file()
location of preferences file containing preferences that are synced between computers note that wesno...
std::string get_saves_dir()
rwops_ptr make_read_RWops(const std::string &path)
const file_tree_checksum & data_tree_checksum(bool reset=false)
Get the time at which the data/ tree was last modified at.
std::string get_program_invocation(const std::string &program_name)
Returns the appropriate invocation for a Wesnoth-related binary, assuming that it is located in the s...
std::string read_file(const std::string &fname)
Basic disk I/O - read file.
std::string get_unsynced_prefs_file()
location of preferences file containing preferences that aren't synced between computers
std::optional< std::string > get_binary_file_location(const std::string &type, const std::string &filename)
Returns a complete path to the actual file of a given type, if it exists.
bool ends_with(const std::string &str, const std::string &suffix)
std::string get_save_index_file()
const std::string map_extension
Definition: filesystem.hpp:78
bool is_compressed_file(const std::string &filename)
Definition: filesystem.hpp:285
filesystem::scoped_ostream ostream_file(const std::string &fname, std::ios_base::openmode mode, bool create_directory)
static bool create_directory_if_missing_recursive(const bfs::path &dirpath)
Definition: filesystem.cpp:382
int file_size(const std::string &fname)
Returns the size of a file, or -1 if the file doesn't exist.
bool is_mask(const std::string &filename)
Returns true if the file ends with the maskfile extension.
std::string get_lua_history_file()
std::string read_file_as_data_uri(const std::string &fname)
void set_cache_dir(const std::string &newcachedir)
Definition: filesystem.cpp:782
std::string read_scenario(const std::string &name)
const std::string mask_extension
Definition: filesystem.hpp:79
std::unique_ptr< std::istream > scoped_istream
Definition: filesystem.hpp:52
void clear_binary_paths_cache()
std::string get_screenshot_dir()
std::string get_credentials_file()
void write_file(const std::string &fname, const std::string &data, std::ios_base::openmode mode)
Throws io_exception if an error occurs.
std::string get_short_wml_path(const std::string &filename)
Returns a short path to filename, skipping the (user) data directory.
std::string root_name(const std::string &path)
Returns the name of the root device if included in the given path.
std::string directory_name(const std::string &file)
Returns the directory name of a file, with filename stripped.
std::string get_logs_dir()
Definition: filesystem.cpp:798
std::unique_ptr< std::ostream > scoped_ostream
Definition: filesystem.hpp:53
std::optional< std::string > get_binary_dir_location(const std::string &type, const std::string &filename)
Returns a complete path to the actual directory of a given type, if it exists.
static bool create_directory_if_missing(const bfs::path &dirpath)
Definition: filesystem.cpp:358
bool is_userdata_initialized()
Definition: filesystem.cpp:574
std::string nearest_extant_parent(const std::string &file)
Finds the nearest parent in existence for a file or directory.
char path_separator()
Returns the standard path separator for the current platform.
std::string get_sync_dir()
parent directory for everything that should be synced between systems.
bool looks_like_pbl(const std::string &file)
std::string get_addons_data_dir()
bool is_map(const std::string &filename)
Returns true if the file ends with the mapfile extension.
bool make_directory(const std::string &dirname)
Definition: filesystem.cpp:988
std::string get_wesnothd_name()
Definition: filesystem.cpp:975
std::string get_default_prefs_file()
bool to_asset_path(std::string &path, std::string addon_id, std::string asset_type)
Helper function to convert absolute path to wesnoth relative path.
const blacklist_pattern_list default_blacklist
Definition: filesystem.cpp:263
std::string get_addons_dir()
bool set_cwd(const std::string &dir)
Definition: filesystem.cpp:898
std::optional< std::string > get_localized_path(const std::string &file, const std::string &suff)
Returns the localized version of the given filename, if it exists.
std::vector< other_version_dir > find_other_version_saves_dirs()
Searches for directories containing saves created by other versions of Wesnoth.
Definition: filesystem.cpp:832
rwops_ptr make_write_RWops(const std::string &path)
std::string get_next_filename(const std::string &name, const std::string &extension)
Get the next free filename using "name + number (3 digits) + extension" maximum 1000 files then start...
Definition: filesystem.cpp:551
std::string get_intl_dir()
std::string get_core_images_dir()
std::vector< uint8_t > read_file_binary(const std::string &fname)
std::string sanitize_path(const std::string &path)
Sanitizes a path to remove references to the user's name.
std::string get_current_editor_dir(const std::string &addon_id)
const std::string get_version_path_suffix(const version_info &version)
Definition: filesystem.cpp:579
bool is_path_sep(char c)
Returns whether c is a path separator.
std::string read_map(const std::string &name)
std::string get_cwd()
Definition: filesystem.cpp:885
std::string normalize_path(const std::string &fpath, bool normalize_separators, bool resolve_dot_entries)
Returns the absolute path of a file.
void set_user_data_dir(std::string newprefdir)
Definition: filesystem.cpp:686
const std::vector< std::string > & get_binary_paths(const std::string &type)
Returns a vector with all possible paths to a given type of binary, e.g.
std::optional< std::string > get_wml_location(const std::string &filename, const std::string &current_dir)
Returns a complete path to the actual WML file or directory, if either exists.
Game configuration data as global variables.
Definition: build_info.cpp:61
std::string path
Definition: filesystem.cpp:89
std::string default_preferences_path
Definition: filesystem.cpp:95
const std::string observer_team_name
observer team name used for observer team chat
Definition: filesystem.cpp:99
int cache_compression_level
Definition: filesystem.cpp:101
bool check_migration
Definition: filesystem.cpp:97
static void msg(const char *act, debug_info &i, const char *to="", const char *result="")
Definition: debugger.cpp:109
std::string_view data
Definition: picture.cpp:194
The paths manager is responsible for recording the various paths that binary files may be located at.
Definition: filesystem.hpp:433
std::vector< std::string > paths_
Definition: filesystem.hpp:446
binary_paths_manager(const binary_paths_manager &o)
binary_paths_manager & operator=(const binary_paths_manager &o)
void set_paths(const game_config_view &cfg)
bool operator==(const file_tree_checksum &rhs) const
bool operator!=(const file_tree_checksum &rhs) const
Definition: filesystem.hpp:311
An exception object used when an IO error occurs.
Definition: filesystem.hpp:66
io_exception(const std::string &msg)
Definition: filesystem.hpp:68
std::string version
Here the version is given as a string instead of a version_info, because the logic of how many compon...
Definition: filesystem.hpp:189
other_version_dir(const std::string &v, const std::string &p)
Definition: filesystem.hpp:193
void operator()(SDL_RWops *) const noexcept
Base class for all the errors encountered by the engine.
Definition: exceptions.hpp:29
mock_char c
mock_party p