registry_key.hpp

浏览该文件的文档.

#ifndef NEFORCE_CORE_SYSTEM_REGISTRY_KEY_HPP__
#define NEFORCE_CORE_SYSTEM_REGISTRY_KEY_HPP__

 
#include "NeForce/core/config/windef.hpp"
#ifdef NEFORCE_PLATFORM_WINDOWS
#    include "NeForce/core/exception/system_exception.hpp"
#    include <windef.h>
#    include <winreg.h>
NEFORCE_BEGIN_NAMESPACE__


struct registry_key_exception final : system_exception {
    explicit registry_key_exception(const char* info = "Registry Key Operation Failed.",
                                    const error_code code = last_error()) noexcept :
    system_exception(info, code) {}
 
    explicit registry_key_exception(const exception& e) :
    system_exception(e) {}
 
    ~registry_key_exception() override = default;
 
    NEFORCE_NODISCARD const char* type() const noexcept override { return "registry_key_exception"; }
};
 // Exceptions


class NEFORCE_API registry_key {
public:
    struct root_key {
        static ::HKEY classes_root() noexcept { return HKEY_CLASSES_ROOT; }

        static ::HKEY current_user() noexcept { return HKEY_CURRENT_USER; }

        static ::HKEY local_machine() noexcept { return HKEY_LOCAL_MACHINE; }

        static ::HKEY users() noexcept { return HKEY_USERS; }

        static ::HKEY current_config() noexcept { return HKEY_CURRENT_CONFIG; }
    };

    enum class value_type : ::DWORD {
        none = REG_NONE,               
        string = REG_SZ,               
        expand_string = REG_EXPAND_SZ, 
        binary = REG_BINARY,           
        dword = REG_DWORD,             
        qword = REG_QWORD,             
        multi_string = REG_MULTI_SZ    
    };

    enum wow64_view : ::REGSAM {
        view_default = 0,             
        view_32bit = KEY_WOW64_32KEY, 
        view_64bit = KEY_WOW64_64KEY, 
    };

    struct NEFORCE_API value_info {
        wstring name;        
        value_type type;     
        vector<byte_t> data; 

        NEFORCE_NODISCARD wstring to_string() const;

        NEFORCE_NODISCARD ::DWORD to_dword() const noexcept;

        NEFORCE_NODISCARD ::ULONGLONG to_qword() const noexcept;

        NEFORCE_NODISCARD vector<wstring> to_multi_string() const;
    };
 
private:
    ::HKEY hkey_ = nullptr;    
    bool owns_handle_ = false; 
 
    void close() noexcept;
    void throw_if_invalid() const;
    NEFORCE_NODISCARD value_info get_value_info(const wstring& name) const;
 
public:
    registry_key() = default;

    explicit registry_key(::HKEY key);

    ~registry_key();
 
    registry_key(const registry_key&) = delete;
    registry_key& operator=(const registry_key&) = delete;

    registry_key(registry_key&& other) noexcept;

    registry_key& operator=(registry_key&& other) noexcept;

    NEFORCE_NODISCARD bool is_valid() const noexcept { return hkey_ != nullptr; }

    explicit operator bool() const noexcept { return is_valid(); }

    void create_sub_key(const wstring& name);

    void open(::HKEY root, const wstring& path, ::REGSAM sam_desired = KEY_READ | KEY_WRITE);

    NEFORCE_NODISCARD registry_key open_sub_key(const wstring& name, REGSAM sam_desired = KEY_READ) const;

    void delete_sub_key(const wstring& name);

    void delete_value(const wstring& name);

    static void delete_key_tree(::HKEY root, const wstring& path);

    NEFORCE_NODISCARD bool has_sub_key(const wstring& name) const;

    NEFORCE_NODISCARD bool has_value(const wstring& name) const;

    NEFORCE_NODISCARD vector<wstring> enum_sub_key_names() const;

    NEFORCE_NODISCARD vector<value_info> enum_values() const;

    void set_string_value(const wstring& name, const wstring& value);

    void set_expand_string_value(const wstring& name, const wstring& value);

    void set_dword_value(const wstring& name, ::DWORD value);

    void set_qword_value(const wstring& name, ::ULONGLONG value);

    void set_binary_value(const wstring& name, const ::BYTE* data, ::DWORD size);

    void set_multi_string_value(const wstring& name, const vector<wstring>& values);

    NEFORCE_NODISCARD wstring get_string_value(const wstring& name, const wstring& default_val = L"") const;

    NEFORCE_NODISCARD ::DWORD get_dword_value(const wstring& name, DWORD default_val = 0) const noexcept;

    NEFORCE_NODISCARD ::ULONGLONG get_qword_value(const wstring& name, ULONGLONG default_val = 0) const noexcept;

    NEFORCE_NODISCARD vector<byte_t> get_binary_value(const wstring& name) const;

    NEFORCE_NODISCARD vector<wstring> get_multi_string_value(const wstring& name) const;

    NEFORCE_NODISCARD ::HKEY native_handle() const noexcept { return hkey_; }

    void open(::HKEY root, const wstring& path, wow64_view view, ::REGSAM sam_desired = KEY_READ | KEY_WRITE);

    bool notify_change(bool watch_subtree = true, int timeout_ms = -1);
};
 // Registry
 
NEFORCE_END_NAMESPACE__
#endif
#endif // NEFORCE_CORE_SYSTEM_REGISTRY_KEY_HPP__