[MAJOR] Simplify the design (#1)

* Simplify design by merging editor item and settings entry concepts

* Remove unnecessary attributes from types fbs

* Update file management according to new design

* Completed the design

* Fix mixing entries between different versions

* Fix using undefined version when the entry has no default buffer

* Add target name to entry

* Fix not updating editor's entry at registration

* Remove duplicated editor message

* Add cpp helpers for RegisterEntry

* Fix compile warnings

* Fix resetting update callback

* Fix locking the same entry twice

* Parameter const nosBuffer* Buffer -> nosBuffer DefaultValueBuffer

* Rename TargetName->UiTargetName

* Rename Main.h->EntryManager.h

* Remove IsEditableFromEditor field

* Rename TryToGetClosestFittingEntry and add a description as comment

* Use const char* instead of nosName

* Remove plugins deciding entry file directory and add it to editor events (default is workspace for now)

* Listen to post unloads for automatic unregistration

Author: fcturan20

Config/EditorEvents.fbs

@@ -13,19 +13,26 @@ attribute "resource";
 attribute "strict_type";
 
 table SettingsUpdateFromEditor{
-	module_name: string;
+	plugin_name: string;
 	entry: nos.sys.settings.SettingsEntry;
 }
 
+enum SettingsEntryFileDirectory : uint{
+	LOCAL = 0,
+	WORKSPACE = 1,
+	GLOBAL = 2
+}
+
 // Editor will use this structure to display settings
 table SettingsEditorItem{
     item_display_name:string (key);
     visualizer: nos.fb.Visualizer;
 	entry: nos.sys.settings.SettingsEntry;
+	directory: SettingsEntryFileDirectory;
 }
 
 // List of items to be displayed in the editor
 table SettingsUpdateFromSubsystem{
-	module_name: string;
+	plugin_name: string;
 	settings: [SettingsEditorItem];
 }

Config/Types.fbs

@@ -1,28 +1,17 @@
 namespace nos.sys.settings;
 
-attribute "hidden_property";
-attribute "units";
-attribute "builtin";
-attribute "skip_make";
-attribute "skip_break";
-attribute "skip_delay";
 attribute "dynamic";
-attribute "resource";
-attribute "strict_type";
 attribute "key";
 
 table SettingsEntry{
     entry_name: string (key);
     type_name: string;
+    ui_target_name: string;
     data: [ubyte] (dynamic: "type_name");
 }
 
-table ModuleSettings{
-    module_name:string;
-    module_version:string;
+// This is the root table for the global settings file.
+// If you change this or any subtable, you should bump minor version
+table SettingsList{
     settings: [SettingsEntry];
-}
-
-table ModuleSettingsList{
-    module_settings: [ModuleSettings];
 }

Include/nosSettingsSubsystem/nosSettingsSubsystem.h

@@ -6,51 +6,46 @@
 #define NOS_SETTINGS_SUBSYSTEM_H_INCLUDED
 #include "Nodos/Types.h"
 
-typedef enum nosSettingsFileDirectory {
-	NOS_SETTINGS_FILE_DIRECTORY_LOCAL, // Module's root folder
-	NOS_SETTINGS_FILE_DIRECTORY_WORKSPACE, // Engine's config folder
-	NOS_SETTINGS_FILE_DIRECTORY_GLOBAL	// AppData folder
-} nosSettingsFileDirectory;
-
-typedef nosResult(*nosPfnSettingsItemUpdate)(const char* entryName, nosBuffer itemValue);
+// NOS_RESULT_SUCCESS: Item value will be serialized to the WriteDirectories
+// NOS_RESULT_FAIL: Default item value will be serialized to the WriteDirectories
+typedef nosResult(*nosPfnSettingsEntryUpdate)(const char* entryName, nosBuffer itemValue);
+typedef uint64_t nosSettingsEntryId;
 
 #if NOS_HAS_CPLUSPLUS_20
-#include "EditorEvents_generated.h"
-typedef nos::sys::settings::editor::SettingsEditorItem nosSettingsEditorItem;
+typedef nos::fb::Visualizer* nosSettingsEditorVisualizer;
 #else
-typedef void* nosSettingsEditorItem;
+typedef void* nosSettingsEditorVisualizer;
 #endif
 
 typedef struct nosSettingsEntryParams {
 	nosName TypeName;
-	nosBuffer Buffer; // Don't forget to free this buffer
+	// Default value of the buffer
+	// If nosPfnSettingsEntryUpdate callback returns NOS_SETTINGS_ENTRY_NON_COMPATIBLE, this will be saved
+	// Don't forget to free this buffer
+	nosBuffer DefaultValueBuffer;
 	const char* EntryName; // If NULL, "default" will be used
-	nosSettingsFileDirectory Directory;
+	nosPfnSettingsEntryUpdate UpdateCallback; // Callback to update the entry value
+	nosSettingsEditorVisualizer Visualizer; // Visualizer for the entry in editor
+	const char* DisplayName;
+	// Target module name, editor can decide where to place this entry
+	// For example, if this is "nos.sys.device", editor can place this entry under "Devices" section
+	const char* UiTargetName;
 } nosSettingsEntryParams;
 
 typedef struct nosSettingsSubsystem
 {
-	// parameters->directory will be set to found directory
-	// if parameters->typeName == 0, it will be set to first typename found in the closest file
-	// parameters->directory is ignored because closest one is chosen
-	nosResult(NOSAPI_CALL *ReadSettingsEntry)(nosSettingsEntryParams* parameters);
-	// parameters->typeName should be a valid typename
-	// if parameters->directory is not set, it will be set to NOS_SETTINGS_FILE_DIRECTORY_LOCAL
-	nosResult(NOSAPI_CALL *WriteSettingsEntry)(const nosSettingsEntryParams* parameters);
-
-
-	// Editor related functions
-
-	nosResult(NOSAPI_CALL *RegisterEditorSettings)(u64 itemCount, const nosSettingsEditorItem** itemList, nosPfnSettingsItemUpdate itemUpdateCallback, nosSettingsFileDirectory saveDirectory);
-	nosResult(NOSAPI_CALL *UnregisterEditorSettings)();
+	nosResult(NOSAPI_CALL *RegisterEntry)(const nosSettingsEntryParams* parameters);
+	nosResult(NOSAPI_CALL* UpdateEntryValue)(const char* entryName, nosBuffer value);
+	// An entry can only be unregistered by the plugin it's registered from
+	void(NOSAPI_CALL* UnregisterEntry)(const char* entryName);
 } nosSettingsSubsystem;
 
 #pragma region Helper Declarations & Macros
 // Make sure these are same with nossys file.
 #define NOS_SETTINGS_SUBSYSTEM_NAME "nos.sys.settings"
 
-#define NOS_SETTINGS_SUBSYSTEM_VERSION_MAJOR 0
-#define NOS_SETTINGS_SUBSYSTEM_VERSION_MINOR 10
+#define NOS_SETTINGS_SUBSYSTEM_VERSION_MAJOR 1
+#define NOS_SETTINGS_SUBSYSTEM_VERSION_MINOR 0
 
 extern struct nosPluginInfo nosSettingsModuleInfo;
 extern nosSettingsSubsystem* nosSettings;
@@ -61,6 +56,43 @@ extern nosSettingsSubsystem* nosSettings;
 
 #define NOS_SETTINGS_IMPORT() NOS_IMPORT_DEP(NOS_SETTINGS_SUBSYSTEM_NAME, nosSettingsModuleInfo, nosSettings)
 
+#if NOS_HAS_CPLUSPLUS_20
+#include "Types_generated.h"
+#include <Nodos/Name.hpp>
+
+namespace nos::sys::settings {
+	inline nosResult RegisterEntry(std::string const& entryName, std::string const& typeName, nosPfnSettingsEntryUpdate updateCallback, std::optional<nosBuffer> defaultVal = std::nullopt, std::optional<std::string> displayName = std::nullopt, std::optional<std::string> targetName = std::nullopt, std::optional<nos::fb::TVisualizer> visualizer = std::nullopt) {
+		nosSettingsEntryParams params{};
+		params.EntryName = entryName.empty() ? NULL : entryName.c_str();
+		params.TypeName = nos::Name(typeName);
+		params.UpdateCallback = updateCallback;
+
+		if (displayName.has_value() && !displayName->empty())
+			params.DisplayName = displayName->c_str();
+		else 
+			params.DisplayName = params.EntryName;
+		
+		if (defaultVal.has_value())
+			params.DefaultValueBuffer = *defaultVal;
+
+		if (targetName.has_value() && !targetName->empty())
+			params.UiTargetName = targetName->c_str();
+		
+		nos::Buffer visualizerBuf;
+		if (visualizer.has_value()) {
+			visualizerBuf = nos::Buffer::From(*visualizer);
+			params.Visualizer = visualizerBuf.As<nos::fb::Visualizer>();
+		}
+
+		return nosSettings->RegisterEntry(&params);
+	}
+
+	inline void UnregisterEntry(std::string const& entryName) {
+		nosSettings->UnregisterEntry(entryName.c_str());
+	}
+}
+#endif // NOS_HAS_CPLUSPLUS_20
+
 #pragma endregion
 
 

Settings.nossys

@@ -2,7 +2,7 @@
     "info": {
         "id": {
             "name": "nos.sys.settings",
-            "version": "0.10.3"
+            "version": "1.0.0"
         },
         "display_name": "Settings Subsystem",
         "description": "Store all module settings",

Source/EntryManager.h

@@ -0,0 +1,59 @@
+// Copyright Nodos AS. All Rights Reserved.
+#include <Nodos/PluginAPI.h>
+#include <nosSettingsSubsystem/nosSettingsSubsystem.h>
+#include <nosSettingsSubsystem/Types_generated.h>
+#include <unordered_map>
+#include <Nodos/Helpers.hpp>
+#include <nosUtil/StringUtils.h>
+#include <nosUtil/VersionUtils.h>
+
+namespace nos::sys::settings
+{
+
+struct RegisteredEntry {
+	nos::Name TypeName;
+	nos::Buffer LastValue;
+	editor::SettingsEntryFileDirectory SaveDir;
+	nos::fb::TVisualizer Visualizer{};
+	std::string UiTargetName;
+	std::string DisplayName;
+	nosPfnSettingsEntryUpdate UpdateCallback = nullptr;
+	// If an entry with the same name from a previous version of this plugin is already read, save according to it
+	nos::util::SemVer ReadEntryPluginVer{};
+};
+
+typedef std::pair<nos::Name, nos::Buffer> EntryTypeNameBufferPair;
+struct ReadEntryList
+{
+	std::shared_mutex FileMutex;
+	// EntryName -> {PluginVer, {TypeName, Buffer}} (sorted by plugin version)
+	std::unordered_map<std::string, std::vector<std::pair<nos::util::SemVer, EntryTypeNameBufferPair>>> Entries;
+};
+
+nosResult UpdateEditorEntriesForPlugin(nos::Name pluginName);
+nosResult UnregisterSettings(nos::Name moduleName);
+void OnEditorConnected(uint64_t editorId);
+void OnMessageFromEditor(uint64_t editorId, nosBuffer message);
+
+struct EntryManager
+{
+	// PluginName -> EntryName -> RegisteredEntry
+	std::unordered_map<nos::Name, std::unordered_map<std::string, RegisteredEntry>> RegisteredEntries;
+	std::shared_mutex RegisteredEntriesMutex;
+	// PluginName -> { PluginVersion, PluginInfo }
+	std::unordered_map<nos::Name, std::pair<nos::util::SemVer, nosPluginInfo>> PluginVersions;
+	// Entries from files
+	// PluginName -> EntryList
+	std::unordered_map<nos::Name, ReadEntryList> GlobalEntries, WorkspaceEntries, LocalEntries;
+	nosResult ReadSettingsFile(std::filesystem::path filePath, ReadEntryList& readEntries);
+	nosResult WriteSettingsFile(nos::Name pluginName, util::SemVer pluginVer, editor::SettingsEntryFileDirectory dir, const ReadEntryList& entries) const;
+	// Searches through local, workspace and global settings files
+	// For each matching entry, calls the UpdateCallback with the entry name and value
+	// First one to return NOS_RESULT_SUCCESS will be used
+	// If no matching entry is found, NOS_RESULT_FAILED will be returned
+	nosResult TryGetOrCreateFromClosestValidEntry(nos::Name pluginName, std::string entryName, RegisteredEntry& entry);
+	// If there is a matching entry with the same plugin version, updates it
+	// If there is not, creates a new entry
+	nosResult UpdateEntry(nos::Name pluginName, nos::util::SemVer pluginVersion, editor::SettingsEntryFileDirectory dir, std::string const& entryName, EntryTypeNameBufferPair entryVal);
+};
+}