Class ConfigFile¶

Defined in File config_file.h

Class Documentation¶

class ConfigFile¶

Utility to locate and monitor either a singular configuration file, or a base configuration file and its overrides.

Remark

MirAL 5.1

Public Types

enum class Mode¶

Mode of reloading.

no_reloading: files are loaded on startup and not reloaded

reload_on_change: files are loaded on startup and when either the user-specific configuration file base ($XDG_CONFIG_HOME or $HOME/.config), or the supplied path that is monitored for changes.

Values:

enumerator no_reloading¶

enumerator reload_on_change¶

using Loader = std::function<void(std::istream &istream, std::filesystem::path const &path)>¶: Loader functor is passed both the open stream and the actual path (for use in reporting problems).

using OverrideLoader = std::move_only_function<void(live_config::OverridesList const&)>¶: Provides access to OverridesList which allows access to the full list of unchanged, modified, added, and dropped files.

Public Functions

ConfigFile(MirRunner &runner, std::filesystem::path file, Mode mode, Loader load_config)¶: Utility to locate and monitor a configuration file via the XDG Base Directory Specification. Vis: ($XDG_CONFIG_HOME or $HOME/.config followed by $XDG_CONFIG_DIRS). If, instead of a filename, a path is given, then the base directories are not applied.

ConfigFile(MirRunner &runner, std::filesystem::path base_config, Mode mode, OverrideLoader load_config, std::string_view extension)¶

Loads the base configuration file together with any override (drop-in) files from <base-config-name>.d/ directories across all XDG config roots.

If the base_config is only a filename and not a path, finds the highest-priority file with that name in $XDG_CONFIG_HOME, $HOME/.config, and $XDG_CONFIG_DIRS respectively. Otherwise, the base config is used as is.

If the base config file is not found, load_config is not invoked.

Override files are sorted lexicographically by basename. If multiple roots provide an override drop-in file with the same basename, only the highest-priority root’s copy is used. Root priority follows the order used in the base config search process: $XDG_CONFIG_HOME > $HOME/.config > $XDG_CONFIG_DIRS (in order).

Files can be added or removed at runtime in any of the aforementioned configuration roots. In this case, priority is re-evaluated, and higher priority base config or override files take precedence over lower priority ones. If a higher priority file is removed, the next-highest priority file is used instead.

Remark

since MirAL 5.9