bpf::system::Paths class
#include <Base/include/Framework/System/Paths.hpp>

Contents

Class to represent various path for the application to work with

Constructors, destructors, conversion operators

Paths(const io::File& root, const io::File& data, const io::File& home, const io::File& tmp)

Public variables

const io::File AppRoot
const io::File DataDir
const io::File UserHome
const io::File TempDir
const io::File ThirdParty
const io::File CacheDir

Function documentation

bpf::system::Paths::Paths(const io::File& root, const io::File& data, const io::File& home, const io::File& tmp)

Parameters
root the application root directory (may be read-only)
data the application data directory (must be read-write)
home the user's home directory (access not defined on restrictive-by-design systems)
tmp the system temporary directory for that application (must be read-write)

Constructs a set of application paths

Variable documentation

const io::File bpf::system::Paths::AppRoot

The application root folder WARNING: In certain cases this path may be read-only

const io::File bpf::system::Paths::DataDir

The application data directory, this directory can be assumed always read-write

const io::File bpf::system::Paths::UserHome

System defined user's home directory WARNING: Restricive-by-design systems may not allow accessing this folder

const io::File bpf::system::Paths::TempDir

System defined temporary directory (usually cleared after system reboot)

const io::File bpf::system::Paths::ThirdParty

The location for third party dependencies (will be used as fallback to search for non-system dependencies)

const io::File bpf::system::Paths::CacheDir

Application's persistent cache directory