Changeset 2369

Timestamp:

11/7/2011 11:56:39 AM (19 months ago)

Author:

lowjoel

Message:

Move the Settings class to Eraser.Plugins for plugins to store persistent state information. This will be passed to plugins as part of the Init function, where the PluginInfo? instance will be provided, including the Persistent Store for the plugin.

Location:

branches/eraser6/pluginsRewrite

Files:

• Eraser.Manager/Settings.cs (modified) (1 diff)
• Eraser.Plugins/Eraser.Plugins.csproj (modified) (1 diff)
• Eraser.Plugins/IPlugin.cs (modified) (1 diff)
• Eraser.Plugins/PersistentStore.cs (added)
• Eraser.Plugins/PluginInfo.cs (modified) (3 diffs)

branches/eraser6/pluginsRewrite/Eraser.Manager/Settings.cs

@@ -60 +60 @@
     }
 
-    /// <summary>
-    /// Settings class. Represents settings to a given client.
-    /// </summary>
-    public abstract class Settings
-    {
-        /// <summary>
-        /// Gets the setting for the given name, coercing the object stored in the backend
-        /// to the given type <typeparamref name="T"/>.
-        /// </summary>
-        /// <typeparam name="T">The type of the setting that is currently stored in the
-        /// backend.</typeparam>
-        /// <param name="name">The name of the setting that is used to uniquely refer
-        /// to the value.</param>
-        /// <param name="defaultValue">The default to return if the no data is assocated
-        /// with the given setting.</param>
-        /// <returns>The value stored in the backend, or null if none exists.</returns>
-        public abstract T GetValue<T>(string name, T defaultValue);
-
-        /// <summary>
-        /// Overload for <see cref="GetValue"/> which returns a default for the given type.
-        /// </summary>
-        /// <typeparam name="T">The type of the setting that is currently stored in the
-        /// backend.</typeparam>
-        /// <param name="name">The name of the setting that is used to uniquely refer
-        /// to the value.</param>
-        /// <param name="defaultValue">The default to return if the no data is assocated
-        /// with the given setting.</param>
-        /// <returns>The value stored in the backend, or null if none exists.</returns>
-        public T GetValue<T>(string name)
-        {
-            return GetValue<T>(name, default(T));
-        }
-
-        /// <summary>
-        /// Sets the setting with the given name.
-        /// </summary>
-        /// <param name="name">The name of the setting.</param>
-        /// <param name="value">The value to store in the backend. This may be serialised.</param>
-        public abstract void SetValue(string name, object value);
-
-        /// <summary>
-        /// Gets or sets the given setting, without type hinting. This will not attempt to coerce
-        /// a type from an old version of the assembly to its current type.
-        /// </summary>
-        /// <param name="setting">The name of the setting.</param>
-        /// <returns>The object stored in the settings database, or null if undefined.</returns>
-        [Obsolete("Use the GetValue<T> and SetValue functions instead")]
-        public object this[string setting]
-        {
-            get
-            {
-                return GetValue<object>(setting);
-            }
-            set
-            {
-                SetValue(setting, value);
-            }
-        }
-    }
-
     #region Default attributes
     /// <summary>

branches/eraser6/pluginsRewrite/Eraser.Plugins/Eraser.Plugins.csproj

@@ -63 +63 @@
     <Compile Include="IRegistrar.cs" />
     <Compile Include="LoadingPolicy.cs" />
+    <Compile Include="PersistentStore.cs" />
     <Compile Include="PluginInfo.cs" />
     <Compile Include="PluginLoadedEventArgs.cs" />

branches/eraser6/pluginsRewrite/Eraser.Plugins/IPlugin.cs

@@ -37 +37 @@
         /// Initializer.
         /// </summary>
-        /// <param name="host">The host object which can be used for two-way
-        /// communication with the program.</param>
-        void Initialize(Host host);
+        /// <param name="info">The Plugin Information structure describing the
+        /// current plugin.</param>
+        void Initialize(PluginInfo info);
 
         /// <summary>

branches/eraser6/pluginsRewrite/Eraser.Plugins/PluginInfo.cs

@@ -64 +64 @@
         /// Executes the plugin's initialisation routine.
         /// </summary>
-        /// <param name="host">The host for the plugin</param>
         internal void Load(Host host)
         {
@@ -78 +77 @@
                 //Initialize the plugin
                 Plugin = (IPlugin)Activator.CreateInstance(typePlugin);
-                Plugin.Initialize(host);
+                Plugin.Initialize(this);
             }
             catch (InvalidOperationException e)
@@ -143 +142 @@
 
         /// <summary>
+        /// Gets the Persistent Data Store for this plugin.
+        /// </summary>
+        public PersistentStore PersistentStore { get; private set; }
+
+        /// <summary>
         /// Gets whether this particular plugin is currently loaded in memory.
         /// </summary>