winreg.hpp

// Copyright Take Vos 2023.
// 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 "../macros.hpp"
#include "base.hpp"
#include <string_view>
#include <string>
#include <vector>
#include <cstdint>
#include <optional>
#include <cassert>
 
hi_export_module(hikogui.win32.winreg);
 
hi_export namespace hi { inline namespace v1 {
 
hi_inline win32_error win32_RegDeleteKeyValue(HKEY key, std::string_view path, std::string_view name) noexcept
{
    auto const wpath = win32_MultiByteToWideChar(path);
    if (not wpath) {
        return wpath.error();
    }
 
    auto const wname = win32_MultiByteToWideChar(name);
    if (not wname) {
        return wname.error();
    }
 
    return static_cast<win32_error>(::RegDeleteKeyValueW(key, wpath->c_str(), wname->c_str()));
}
 
hi_inline win32_error win32_RegDeleteKey(HKEY key, std::string_view path) noexcept
{
    auto const wpath = win32_MultiByteToWideChar(path);
    if (not wpath) {
        return wpath.error();
    }
 
    return static_cast<win32_error>(::RegDeleteKeyW(key, wpath->c_str()));
}
 
[[nodiscard]] hi_inline win32_error win32_RegSetKeyValue(HKEY key, std::string_view path, std::string_view name, uint32_t value)
{
    auto const wpath = win32_MultiByteToWideChar(path);
    if (not wpath) {
        return wpath.error();
    }
 
    auto const wname = win32_MultiByteToWideChar(name);
    if (not wname) {
        return wname.error();
    }
 
    auto const dvalue = static_cast<DWORD>(value);
 
    return static_cast<win32_error>(::RegSetKeyValueW(key, wpath->c_str(), wname->c_str(), REG_DWORD, &dvalue, sizeof(dvalue)));
}
 
[[nodiscard]] hi_inline win32_error win32_RegSetKeyValue(HKEY key, std::string_view path, std::string_view name, std::string_view value)
{
    auto const wpath = win32_MultiByteToWideChar(path);
    if (not wpath) {
        return wpath.error();
    }
 
    auto const wname = win32_MultiByteToWideChar(name);
    if (not wname) {
        return wname.error();
    }
 
    auto const wvalue = win32_MultiByteToWideChar(value);
    if (not wvalue) {
        return wvalue.error();
    }
 
    auto const wvalue_size = static_cast<DWORD>((wvalue->size() + 1) * sizeof(wchar_t));
 
    return static_cast<win32_error>(::RegSetKeyValueW(key, wpath->c_str(), wname->c_str(), REG_SZ, wvalue->c_str(), wvalue_size));
}
 
[[nodiscard]] hi_inline std::expected<void, win32_error> win32_RegGetValue_void(HKEY key, std::string_view path, std::string_view name)
{
    auto const wpath = win32_MultiByteToWideChar(path);
    if (not wpath) {
        return std::unexpected{wpath.error()};
    }
 
    auto const wname = win32_MultiByteToWideChar(name);
    if (not wname) {
        return std::unexpected{wname.error()};
    }
 
    auto status = static_cast<win32_error>(::RegGetValueW(key, wpath->c_str(), wname->c_str(), RRF_RT_ANY, NULL, NULL, NULL));
    if (status == win32_error::success) {
        return {};
    } else {
        return std::unexpected{status};
    }
}
 
[[nodiscard]] hi_inline std::expected<uint32_t, win32_error> win32_RegGetValue_dword(HKEY key, std::string_view path, std::string_view name) noexcept
{
    auto const wpath = win32_MultiByteToWideChar(path);
    if (not wpath) {
        return std::unexpected{wpath.error()};
    }
 
    auto const wname = win32_MultiByteToWideChar(name);
    if (not wname) {
        return std::unexpected{wname.error()};
    }
 
    DWORD result;
    DWORD result_length = sizeof(result);
    DWORD result_type = 0;
    auto const status = static_cast<win32_error>(::RegGetValueW(key, wpath->c_str(), wname->c_str(), RRF_RT_ANY, &result_type, &result, &result_length));
 
    if (static_cast<bool>(status)) {
        return std::unexpected{status};
    }
   
    return static_cast<uint32_t>(result);
}
 
[[nodiscard]] hi_inline std::expected<std::string, win32_error> win32_RegGetValue_string(HKEY key, std::string_view path, std::string_view name) noexcept
{
    auto const wpath = win32_MultiByteToWideChar(path);
    if (not wpath) {
        return std::unexpected{wpath.error()};
    }
 
    auto const wname = win32_MultiByteToWideChar(name);
    if (not wname) {
        return std::unexpected{wname.error()};
    }
 
    auto result = std::wstring{};
 
    auto expected_size = size_t{64};
    for (auto repeat = 0; repeat != 5; ++repeat) {
        auto status = win32_error{};
 
        result.resize_and_overwrite(expected_size, [&](auto p, auto n) {
            // size includes the null-terminator.
            auto result_length = static_cast<DWORD>((n + 1) * sizeof(wchar_t));
            status = static_cast<win32_error>(::RegGetValueW(key, wpath->c_str(), wname->c_str(), RRF_RT_REG_SZ, NULL, p, &result_length));
 
            expected_size = (result_length / sizeof(wchar_t)) - 1;
            return std::min(n, expected_size);
        });
 
        switch (status) {
        case win32_error::success:
            return win32_WideCharToMultiByte(result);
        case win32_error::more_data:
            continue;
        default:
            return std::unexpected{status};
        }
    }
 
    // Data size keeps changing.
    return std::unexpected{win32_error::more_data};
}
 
[[nodiscard]] hi_inline std::expected<std::vector<std::string>, win32_error>
win32_RegGetValue_multi_string(HKEY key, std::string_view path, std::string_view name) noexcept
{
    auto const wpath = win32_MultiByteToWideChar(path);
    if (not wpath) {
        return std::unexpected{wpath.error()};
    }
 
    auto const wname = win32_MultiByteToWideChar(name);
    if (not wname) {
        return std::unexpected{wname.error()};
    }
 
    auto result = std::wstring{};
    result.resize(64);
 
    for (auto repeat = 0; repeat != 5; ++repeat) {
        auto result_length = static_cast<DWORD>(result.size() * sizeof(wchar_t));
        auto const status =
            static_cast<win32_error>(::RegGetValueW(key, wpath->c_str(), wname->c_str(), RRF_RT_REG_MULTI_SZ, NULL, result.data(), &result_length));
 
        switch (status) {
        case win32_error::success:
            return win32_MultiSZToStringVector(result.data(), result.data() + result_length);
 
        case win32_error::more_data:
            assert(result_length % 2 == 0);
            result.resize(result_length / sizeof(wchar_t));
            break;
 
        default:
            return std::unexpected{status};
        }
    }
 
    // Data size keeps changing.
    return std::unexpected{win32_error::more_data};
}
 
template<typename T>
[[nodiscard]] std::expected<T, win32_error> win32_RegGetValue(HKEY key, std::string_view path, std::string_view name) = delete;
 
template<>
[[nodiscard]] hi_inline std::expected<void, win32_error> win32_RegGetValue(HKEY key, std::string_view path, std::string_view name)
{
    return win32_RegGetValue_void(key, path, name);
}
 
template<std::integral T>
[[nodiscard]] hi_inline std::expected<T, win32_error> win32_RegGetValue(HKEY key, std::string_view path, std::string_view name)
{
    if (auto const tmp = win32_RegGetValue_dword(key, path, name)) {
        return static_cast<T>(*tmp);
    } else {
        return std::unexpected{tmp.error()};
    }
}
 
template<>
[[nodiscard]] hi_inline std::expected<std::string, win32_error> win32_RegGetValue(HKEY key, std::string_view path, std::string_view name)
{
    return win32_RegGetValue_string(key, path, name);
}
 
template<>
[[nodiscard]] hi_inline std::expected<std::vector<std::string>, win32_error>
win32_RegGetValue(HKEY key, std::string_view path, std::string_view name)
{
    return win32_RegGetValue_multi_string(key, path, name);
}
 
}} // namespace hi::inline v1