pulp::platform::SpecialDirInputs Struct Reference

Everything the resolver may read, so every platform's layout can be computed (and tested) on any host. More...

#include <special_dir.hpp>

Public Attributes
std::function< std::optional< std::string >(std::string_view)>	getenv
	Environment lookup; an unset or empty variable returns nullopt/empty.
std::string	executable
	Absolute path of the running executable.
std::string	module
	Absolute path of the binary holding this code.
std::string	known_documents
	Windows known-folder overrides, else derived.
std::string	known_desktop
std::string	known_music
std::string	android_files_dir
	From the app-data-dir hook.
std::string	android_cache_dir
	Optional; defaults to <files>/cache.

Detailed Description

Everything the resolver may read, so every platform's layout can be computed (and tested) on any host.

Paths are UTF-8 strings written with the separator of the target OS.

Member Data Documentation

android_cache_dir

std::string pulp::platform::SpecialDirInputs::android_cache_dir

Optional; defaults to <files>/cache.

android_files_dir

std::string pulp::platform::SpecialDirInputs::android_files_dir

From the app-data-dir hook.

executable

std::string pulp::platform::SpecialDirInputs::executable

Absolute path of the running executable.

getenv

std::function<std::optional<std::string>(std::string_view)> pulp::platform::SpecialDirInputs::getenv

Environment lookup; an unset or empty variable returns nullopt/empty.

known_desktop

std::string pulp::platform::SpecialDirInputs::known_desktop

known_documents

std::string pulp::platform::SpecialDirInputs::known_documents

Windows known-folder overrides, else derived.

known_music

std::string pulp::platform::SpecialDirInputs::known_music

module

std::string pulp::platform::SpecialDirInputs::module

Absolute path of the binary holding this code.

---

The documentation for this struct was generated from the following file:

• /home/runner/work/pulp/pulp/core/platform/include/pulp/platform/special_dir.hpp