path_location_win32_impl.hpp

// Copyright Take Vos 2022.
// Distributed under the Boost Software License, Version 1.0.
// (See accompanying file LICENSE_1_0.txt or copy at https://www.boost.org/LICENSE_1_0.txt)
 
#pragma once
 
#include "../win32_headers.hpp"
 
#include "path_location_intf.hpp"
#include "../metadata/metadata.hpp"
#include "../telemetry/telemetry.hpp"
#include "../utility/utility.hpp"
#include "../macros.hpp"
#include <filesystem>
#include <string>
 
hi_export_module(hikogui.path.path_location : impl);
 
namespace hi::inline v1 {
 
hi_export [[nodiscard]] inline std::filesystem::path get_path_by_id(const KNOWNFOLDERID& folder_id) noexcept
{
    PWSTR wpath = nullptr;
    if (SHGetKnownFolderPath(folder_id, 0, nullptr, &wpath) != S_OK) {
        hi_log_fatal("Could not get known folder path.");
    }
    hilet d = defer{[&] {
        CoTaskMemFree(wpath);
    }};
 
    return std::filesystem::path{wpath} / "";
}
 
hi_export [[nodiscard]] inline std::filesystem::path get_module_path(HMODULE module_handle) noexcept
{
    std::wstring module_path;
    auto buffer_size = MAX_PATH; // initial default value = 256
 
    // iterative buffer resizing to max value of 32768 (256*2^7)
    for (std::size_t i = 0; i < 7; ++i) {
        module_path.resize(buffer_size);
        auto chars = GetModuleFileNameW(module_handle, module_path.data(), buffer_size);
        if (chars < module_path.length()) {
            module_path.resize(chars);
            return std::filesystem::path{module_path};
 
        } else {
            buffer_size *= 2;
        }
    }
    hi_no_default("Could not get module path. It exceeds the buffer length of 32768 chars.");
}
 
hi_export [[nodiscard]] inline std::filesystem::path executable_file() noexcept
{
    return get_module_path(nullptr);
}
 
hi_export [[nodiscard]] inline std::filesystem::path data_dir() noexcept
{
    // "%LOCALAPPDATA%<Application Vendor><Application Name>\"
    // FOLDERID_LocalAppData has the default path: %LOCALAPPDATA% (%USERPROFILE%\AppData\Local)
    hilet local_app_data = get_path_by_id(FOLDERID_LocalAppData);
    return local_app_data / get_application_vendor() / get_application_name() / "";
}
 
hi_export [[nodiscard]] inline std::filesystem::path log_dir() noexcept
{
    // "%LOCALAPPDATA%<Application Vendor><Application Name>\Log\"
    return data_dir() / "Log" / "";
}
 
hi_export [[nodiscard]] inline std::filesystem::path preferences_file() noexcept
{
    // "%LOCALAPPDATA%<Application Vendor><Application Name>\preferences.json"
    return data_dir() / "preferences.json";
}
 
hi_export [[nodiscard]] inline generator<std::filesystem::path> resource_dirs() noexcept
{
    if (auto source_path = source_dir()) {
            // Fallback when the application is executed from its build directory.
            co_yield executable_dir() / "resources" / "";
            co_yield *source_path / "resources" / "";
 
            if (auto install_path = library_install_dir()) {
                co_yield *install_path / "resources" / "";
 
            } else {
                // Fallback when HikoGUI is also still in its build directory.
                co_yield library_source_dir() / "resources" / "";
                co_yield library_build_dir() / "resources" / "";
            }
        } else {
            co_yield executable_dir() / "resources" / "";
            co_yield data_dir() / "resources" / "";
        }
}
 
hi_export [[nodiscard]] inline generator<std::filesystem::path> system_font_dirs() noexcept
{
    co_yield get_path_by_id(FOLDERID_Fonts);
}
 
hi_export [[nodiscard]] inline generator<std::filesystem::path> font_dirs() noexcept
{
    for (hilet& path : resource_dirs()) {
        co_yield path;
    }
    for (hilet& path : system_font_dirs()) {
        co_yield path;
    }
}
 
hi_export [[nodiscard]] inline generator<std::filesystem::path> theme_dirs() noexcept
{
    for (hilet& path : resource_dirs()) {
        co_yield path;
    }
}
 
} // namespace hi::inline v1