/*
* Copyright (c) 2008-2024 Jonathan Schleifer <js@nil.im>
*
* All rights reserved.
*
* This program is free software: you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License version 3.0 only,
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
* version 3.0 for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* version 3.0 along with this program. If not, see
* <https://www.gnu.org/licenses/>.
*/
#import "OFObject.h"
#import "OFString.h"
#include <windows.h>
OF_ASSUME_NONNULL_BEGIN
@class OFData;
/**
* @class OFWindowsRegistryKey OFWindowsRegistryKey.h ObjFW/ObjFW.h
*/
OF_SUBCLASSING_RESTRICTED
@interface OFWindowsRegistryKey: OFObject
{
HKEY _hKey;
bool _close;
}
/**
* @brief Returns the OFWindowsRegistryKey for the HKEY_CLASSES_ROOT key.
*
* @return The OFWindowsRegistryKey for the HKEY_CLASSES_ROOT key
*/
+ (instancetype)classesRootKey;
/**
* @brief Returns the OFWindowsRegistryKey for the HKEY_CURRENT_CONFIG key.
*
* @return The OFWindowsRegistryKey for the HKEY_CURRENT_CONFIG key
*/
+ (instancetype)currentConfigKey;
/**
* @brief Returns the OFWindowsRegistryKey for the HKEY_CURRENT_USER key.
*
* @return The OFWindowsRegistryKey for the HKEY_CURRENT_USER key
*/
+ (instancetype)currentUserKey;
/**
* @brief Returns the OFWindowsRegistryKey for the HKEY_LOCAL_MACHINE key.
*
* @return The OFWindowsRegistryKey for the HKEY_LOCAL_MACHINE key
*/
+ (instancetype)localMachineKey;
/**
* @brief Returns the OFWindowsRegistryKey for the HKEY_USERS key.
*
* @return The OFWindowsRegistryKey for the HKEY_USERS key
*/
+ (instancetype)usersKey;
- (instancetype)init OF_UNAVAILABLE;
/**
* @brief Opens the subkey at the specified path.
*
* @param path The path of the subkey to open
* @param accessRights Please refer to the `RegOpenKeyEx()` documentation for
* `samDesired`
* @param options Please refer to the `RegOpenKeyEx()` documentation for
* `ulOptions`. Usually 0.
* @return The subkey with the specified path
* @throw OFOpenWindowsRegistryKeyFailedException Opening the key failed
*/
- (OFWindowsRegistryKey *)openSubkeyAtPath: (OFString *)path
accessRights: (REGSAM)accessRights
options: (DWORD)options;
/**
* @brief Creates a subkey at the specified path or opens it if it already
* exists.
*
* @param path The path of the subkey to create
* @param accessRights Please refer to the `RegCreateKeyEx()` documentation for
* `samDesired`
* @param securityAttributes Please refer to the `RegCreateKeyEx()`
* documentation for `lpSecurityAttributes`. Usually
* NULL.
* @param options Please refer to the `RegCreateKeyEx()` documentation for
* `dwOptions`. Usually 0.
* @param disposition A pointer to a variable that will be set to whether the
* key was created or already existed, or `NULL`. Please
* refer to the `RegCreateKeyEx()` documentation for
* `lpdwDisposition`.
* @return The subkey with the specified path
* @throw OFCreateWindowsRegistryKeyFailedException Creating the key failed
*/
- (OFWindowsRegistryKey *)
createSubkeyAtPath: (OFString *)path
accessRights: (REGSAM)accessRights
securityAttributes: (nullable SECURITY_ATTRIBUTES *)securityAttributes
options: (DWORD)options
disposition: (nullable DWORD *)disposition;
/**
* @brief Returns the data for the specified value at the specified path.
*
* @param name The name of the value to return
* @param type A pointer to store the type of the value, or NULL
* @return The data for the specified value
* @throw OFGetWindowsRegistryValueFailedException Getting the value failed
*/
- (nullable OFData *)dataForValueNamed: (nullable OFString *)name
type: (nullable DWORD *)type;
/**
* @brief Sets the data for the specified value.
*
* @param data The data to set the value to
* @param name The name of the value to set
* @param type The type for the value
* @throw OFSetWindowsRegistryValueFailedException Setting the value failed
*/
- (void)setData: (nullable OFData *)data
forValueNamed: (nullable OFString *)name
type: (DWORD)type;
/**
* @brief Returns the string for the specified value at the specified path.
*
* @param name The name of the value to return
* @return The string for the specified value
* @throw OFGetWindowsRegistryValueFailedException Getting the value failed
* @throw OFInvalidEncodingException The encoding of the value is invalid
*/
- (nullable OFString *)stringForValueNamed: (nullable OFString *)name;
/**
* @brief Returns the string for the specified value at the specified path.
*
* @param name The name of the value to return
* @param type A pointer to store the type of the value, or NULL
* @return The string for the specified value
* @throw OFGetWindowsRegistryValueFailedException Getting the value failed
* @throw OFInvalidEncodingException The encoding of the value is invalid
*/
- (nullable OFString *)stringForValueNamed: (nullable OFString *)name
type: (nullable DWORD *)type;
/**
* @brief Sets the string for the specified value.
*
* @param string The string to set the value to
* @param name The name of the value to set
* @throw OFSetWindowsRegistryValueFailedException Setting the value failed
*/
- (void)setString: (nullable OFString *)string
forValueNamed: (nullable OFString *)name;
/**
* @brief Sets the string for the specified value.
*
* @param string The string to set the value to
* @param name The name of the value to set
* @param type The type for the value
* @throw OFSetWindowsRegistryValueFailedException Setting the value failed
*/
- (void)setString: (nullable OFString *)string
forValueNamed: (nullable OFString *)name
type: (DWORD)type;
/**
* @brief Returns the DWORD for the specified value at the specified path.
*
* @param name The name of the value to return
* @return The DWORD for the specified value
* @throw OFGetWindowsRegistryValueFailedException Getting the value failed
* @throw OFUndefinedKeyException There is no value with the specified key
*/
- (uint32_t)DWORDForValueNamed: (nullable OFString *)name;
/**
* @brief Sets the DWORD for the specified value.
*
* @param dword The DWORD to set the value to
* @param name The name of the value to set
* @throw OFSetWindowsRegistryValueFailedException Setting the value failed
*/
- (void)setDWORD: (uint32_t)dword forValueNamed: (nullable OFString *)name;
/**
* @brief Returns the QWORD for the specified value at the specified path.
*
* @param name The name of the value to return
* @return The QWORD for the specified value
* @throw OFGetWindowsRegistryValueFailedException Getting the value failed
* @throw OFUndefinedKeyException There is no value with the specified key
*/
- (uint64_t)QWORDForValueNamed: (nullable OFString *)name;
/**
* @brief Sets the QWORD for the specified value.
*
* @param qword The QWORD to set the value to
* @param name The name of the value to set
* @throw OFSetWindowsRegistryValueFailedException Setting the value failed
*/
- (void)setQWORD: (uint64_t)qword forValueNamed: (nullable OFString *)name;
/**
* @brief Deletes the specified value.
*
* @param name The value to delete
* @throw OFDeleteWindowsRegistryValueFailedException Deleting the value failed
*/
- (void)deleteValueNamed: (nullable OFString *)name;
/**
* @brief Deletes the specified subkey.
*
* @param subkeyPath The path of the subkey to delete
* @throw OFDeleteWindowsRegistryKeyFailedException Deleting the key failed
*/
- (void)deleteSubkeyAtPath: (OFString *)subkeyPath;
@end
OF_ASSUME_NONNULL_END