special_dir.hpp

Go to the documentation of this file.

#pragma once

 
#include <array>
#include <filesystem>
#include <functional>
#include <optional>
#include <string>
#include <string_view>
 
namespace pulp::platform {
 
enum class SpecialDir {
    home,
    documents,
    desktop,
    music,
    app_data,        
    app_data_shared, 
    config,          
    temp,
    cache,
    logs,
    current_executable,
    bundle_dir,
    user_presets,
};
 
inline constexpr std::array<SpecialDir, 13> kAllSpecialDirs = {
    SpecialDir::home,
    SpecialDir::documents,
    SpecialDir::desktop,
    SpecialDir::music,
    SpecialDir::app_data,
    SpecialDir::app_data_shared,
    SpecialDir::config,
    SpecialDir::temp,
    SpecialDir::cache,
    SpecialDir::logs,
    SpecialDir::current_executable,
    SpecialDir::bundle_dir,
    SpecialDir::user_presets,
};

std::string_view special_dir_name(SpecialDir kind) noexcept;

std::filesystem::path special_dir(SpecialDir kind);

void set_special_dir_override(SpecialDir kind, std::filesystem::path path);
void clear_special_dir_overrides();
 
// ── Pure resolver ───────────────────────────────────────────────────────────

enum class SpecialDirOs { macos, ios, windows, linux_desktop, android, web };

SpecialDirOs host_special_dir_os() noexcept;

struct SpecialDirInputs {
    std::function<std::optional<std::string>(std::string_view)> getenv;
    std::string executable;      
    std::string module;          
    std::string known_documents; 
    std::string known_desktop;
    std::string known_music;
    std::string android_files_dir; 
    std::string android_cache_dir; 
};

std::string special_dir_for(SpecialDirOs os, SpecialDir kind, const SpecialDirInputs& inputs);
 
} // namespace pulp::platform