mirror/OpenRGB
1
0
Fork 0
mirror of https://github.com/CalcProgrammer1/OpenRGB.git synced 2026-05-24 22:45:55 -04:00
Code Issues Packages Projects Releases Wiki Activity

Settings Rework

Browse Source 
* Add JSON string configuration field to RGBController to store device-specific configurations
    * This JSON string holds both configuration and schema
    * Add settings schema tracking to SettingsManager
    * Implement dynamic settings widget that generates a settings UI based on a JSON schema
    * Implement SettingsManager callback for notifying of settings changes and settings schema updates
    * Always enable Entire Device zone option and use it to enable Edit Device
    * Rename SaveSizes to SaveConfiguration in ProfileManager and Sizes.json to Configuration.json
    * Add zone flag for indicating that a zone's geometry may change, informing profile manager to ignore this check
    * Remove Theme setting and Theme Manager, as this didn't work on most setups anyways and Qt6 has proper Windows dark theming
This commit is contained in:
Adam Honse
2026-04-15 11:51:28 -05:00
parent 128dd8ef94
commit c0826fbe83
72 changed files with 3305 additions and 3024 deletions
Download Patch File Download Diff File Expand all files Collapse all files

160
SettingsManager.cpp
View File

@@ -13,17 +13,22 @@
#include <fstream>
#include <iostream>
#include "JsonUtils.h"
#include "LogManager.h"
#include "NetworkClient.h"
#include "ResourceManager.h"
#include "SettingsManager.h"
#include "StringUtils.h"
/*---------------------------------------------------------*\
| SettingsManager name for log entries |
\*---------------------------------------------------------*/
const char* SETTINGSMANAGER = "SettingsManager";
static const std::string ui_settings_keys[7] =
{
"UserInterface",
"AutoStart",
"Theme",
"Plugins",
"Client",
"LogManager",
@@ -59,14 +64,7 @@ json SettingsManager::GetSettings(std::string settings_key)
| If this is a local client, request the settings |
| from the server |
\*-------------------------------------------------*/
try
{
result = nlohmann::json::parse(ResourceManager::get()->GetLocalClient()->SettingsManager_GetSettings(settings_key));
}
catch(...)
{
}
JsonUtils::JsonParse(ResourceManager::get()->GetLocalClient()->SettingsManager_GetSettings(settings_key), result);
}
else
{
@@ -88,6 +86,77 @@ json SettingsManager::GetSettings(std::string settings_key)
return result;
}
json SettingsManager::GetSettingsSchema(std::string settings_key)
{
if(settings_key == "")
{
return(settings_schema);
}
else if(settings_schema.contains(settings_key) && settings_schema[settings_key].contains("properties"))
{
return(settings_schema[settings_key]["properties"]);
}
else
{
nlohmann::json empty;
return(empty);
}
}
void SettingsManager::RegisterSettingsSchema(std::string settings_key, std::string settings_title, json& new_schema)
{
RegisterSettingsSchema(settings_key, settings_title, new_schema, -1);
}
void SettingsManager::RegisterSettingsSchema(std::string settings_key, std::string settings_title, json& new_schema, int order)
{
settings_schema[settings_key]["title"] = settings_title;
settings_schema[settings_key]["type"] = "object";
settings_schema[settings_key]["properties"].update(new_schema, true);
if(order >= 0)
{
settings_schema[settings_key]["order"] = order;
}
SignalSettingsManagerUpdate(SETTINGSMANAGER_UPDATE_REASON_SETTINGS_SCHEMA_UPDATED);
}
void SettingsManager::ModifySettings(std::string settings_key, json new_settings)
{
bool ui_settings_key = false;
for(std::size_t settings_key_idx = 0; settings_key_idx < 7; settings_key_idx++)
{
if(settings_key == ui_settings_keys[settings_key_idx])
{
ui_settings_key = true;
break;
}
}
if(!ui_settings_key && ResourceManager::get()->IsLocalClient() && (ResourceManager::get()->GetLocalClient()->GetSupportsSettingsManagerAPI()))
{
/*-------------------------------------------------*\
| If this is a local client, request the settings |
| from the server |
\*-------------------------------------------------*/
nlohmann::json settings_json;
settings_json[settings_key] = new_settings;
ResourceManager::get()->GetLocalClient()->SettingsManager_SetSettings(settings_json.dump());
}
else
{
mutex.lock();
settings_data[settings_key].update(new_settings, true);
mutex.unlock();
}
SignalSettingsManagerUpdate(SETTINGSMANAGER_UPDATE_REASON_SETTINGS_UPDATED);
}
void SettingsManager::SetSettings(std::string settings_key, json new_settings)
{
bool ui_settings_key = false;
@@ -119,6 +188,8 @@ void SettingsManager::SetSettings(std::string settings_key, json new_settings)
settings_data[settings_key] = new_settings;
mutex.unlock();
}
SignalSettingsManagerUpdate(SETTINGSMANAGER_UPDATE_REASON_SETTINGS_UPDATED);
}
void SettingsManager::SetSettingsFromJsonString(std::string settings_json_str)
@@ -126,7 +197,8 @@ void SettingsManager::SetSettingsFromJsonString(std::string settings_json_str)
/*-----------------------------------------------------*\
| Parse the JSON string |
\*-----------------------------------------------------*/
nlohmann::json settings_json = nlohmann::json::parse(settings_json_str);
nlohmann::json settings_json;
JsonUtils::JsonParse(settings_json_str, settings_json);
/*-----------------------------------------------------*\
| Get key/value pairs from JSON, call SetSettings for |
@@ -214,10 +286,76 @@ void SettingsManager::SaveSettings()
}
catch(const std::exception& e)
{
LOG_ERROR("[SettingsManager] Cannot write to file: %s", e.what());
LOG_ERROR("[%s] Cannot write to file: %s", SETTINGSMANAGER, e.what());
}
settings_file.close();
}
mutex.unlock();
}
/*---------------------------------------------------------*\
| Callback Registration Functions |
\*---------------------------------------------------------*/
void SettingsManager::RegisterSettingsManagerCallback(SettingsManagerCallback new_callback, void * new_callback_arg)
{
SettingsManagerCallbackMutex.lock();
for(size_t idx = 0; idx < SettingsManagerCallbacks.size(); idx++)
{
if(SettingsManagerCallbackArgs[idx] == new_callback && SettingsManagerCallbackArgs[idx] == new_callback_arg)
{
SettingsManagerCallbackMutex.unlock();
LOG_TRACE("[%s] Tried to register an already registered SettingsManager callback, skipping. Total callbacks registered: %d", SETTINGSMANAGER, SettingsManagerCallbacks.size());
return;
}
}
SettingsManagerCallbacks.push_back(new_callback);
SettingsManagerCallbackArgs.push_back(new_callback_arg);
SettingsManagerCallbackMutex.unlock();
LOG_TRACE("[%s] Registered SettingsManager callback. Total callbacks registered: %d", SETTINGSMANAGER, SettingsManagerCallbacks.size());
}
void SettingsManager::UnregisterSettingsManagerCallback(SettingsManagerCallback callback, void * callback_arg)
{
SettingsManagerCallbackMutex.lock();
for(size_t idx = 0; idx < SettingsManagerCallbacks.size(); idx++)
{
if(SettingsManagerCallbacks[idx] == callback && SettingsManagerCallbackArgs[idx] == callback_arg)
{
SettingsManagerCallbacks.erase(SettingsManagerCallbacks.begin() + idx);
SettingsManagerCallbackArgs.erase(SettingsManagerCallbackArgs.begin() + idx);
}
}
SettingsManagerCallbackMutex.unlock();
LOG_TRACE("[%s] Unregistered SettingsManager callback. Total callbacks registered: %d", SETTINGSMANAGER, SettingsManagerCallbackArgs.size());
}
void SettingsManager::SignalSettingsManagerUpdate(unsigned int update_reason)
{
// NetworkServer* server = ResourceManager::get()->GetServer();
//
// if(server)
// {
// server->SignalProfileManagerUpdate(update_reason);
// }
SettingsManagerCallbackMutex.lock();
for(std::size_t callback_idx = 0; callback_idx < SettingsManagerCallbacks.size(); callback_idx++)
{
SettingsManagerCallbacks[callback_idx](SettingsManagerCallbackArgs[callback_idx], update_reason);
}
SettingsManagerCallbackMutex.unlock();
LOG_TRACE("[%s] SettingsManager update signalled: %d", SETTINGSMANAGER, update_reason);
}