Renamed the configuration namespace to settings; more progress on the configuration file parser; partially implemented the memory settings store

git-svn-id: file:///srv/devel/repo-conversion/nusu@299 d2e56fa2-650e-0410-a79f-9358c0239efd

Source/Settings/ConfigurationFileStore.Parsing.cs

@@ -0,0 +1,217 @@
+#region CPL License
+/*
+Nuclex Framework
+Copyright (C) 2002-2014 Nuclex Development Labs
+
+This library is free software; you can redistribute it and/or
+modify it under the terms of the IBM Common Public License as
+published by the IBM Corporation; either version 1.0 of the
+License, or (at your option) any later version.
+
+This library 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
+IBM Common Public License for more details.
+
+You should have received a copy of the IBM Common Public
+License along with this library
+*/
+#endregion
+
+using System;
+using System.IO;
+
+using Nuclex.Support.Parsing;
+
+namespace Nuclex.Support.Settings {
+
+  partial class ConfigurationFileStore {
+
+    #region class ParserState
+
+    /// <summary>Remembers the target store and current category of the parser</summary>
+    private class ParserState {
+
+      /// <summary>Store to which the parsed categories and options will be added</summary>
+      public ConfigurationFileStore Store;
+
+      /// <summary>Current category options belong to</summary>
+      public Category Category;
+
+    }
+
+    #endregion // class ParserState
+
+    /// <summary>Parses a configuration file from the specified text reader</summary>
+    /// <param name="reader">Reader the configuration file will be parsed from</param>
+    /// <returns>The configuration file parsed from the specified reader</returns>
+    public static ConfigurationFileStore Parse(TextReader reader) {
+      var store = new ConfigurationFileStore();
+      var state = new ParserState() {
+        Store = store,
+        Category = store.RootCategory
+      };
+
+      for(; ; ) {
+        string line = reader.ReadLine();
+        if(line == null) {
+          break;
+        }
+
+        parseLine(state, line);
+      }
+
+      return store;
+    }
+
+    /// <summary>Incrementally parses a line read from a configuration file</summary>
+    /// <param name="state">Current parser state</param>
+    /// <param name="line">Line that has been read</param>
+    private static void parseLine(ParserState state, string line) {
+      state.Store.lines.Add(line);
+
+      // If the line is empty, ignore it
+      int length = line.Length;
+      if(length == 0) {
+        return;
+      }
+
+      // Skip all spaces at the beginning of the line
+      int firstCharacterIndex = 0;
+      ParserHelper.SkipSpaces(line, ref firstCharacterIndex);
+
+      // If the line contained nothing but spaces, ignore it
+      if(firstCharacterIndex == length) {
+        return;
+      }
+
+      // If the line is a comment, ignore it
+      if((line[firstCharacterIndex] == '#') || (line[firstCharacterIndex] == ';')) {
+        return;
+      }
+
+      // Now the line is either a category definition or some attempt to set an option
+      if(line[firstCharacterIndex] == '[') {
+        parseCategory(state, line, firstCharacterIndex);
+      } else {
+        parseOption(state, line, firstCharacterIndex);
+      }
+    }
+
+    /// <summary>Parses a category definition encountered on a line</summary>
+    /// <param name="state">Current parser state</param>
+    /// <param name="line">Line containing the category definition</param>
+    /// <param name="firstCharacterIndex">Index of the definition's first character</param>
+    private static void parseCategory(
+      ParserState state, string line, int firstCharacterIndex
+    ) {
+      throw new NotImplementedException();
+    }
+
+    /// <summary>Parses an option definition encountered on a line</summary>
+    /// <param name="state">Current parser state</param>
+    /// <param name="line">Line containing the option definition</param>
+    /// <param name="firstCharacterIndex">Index of the definition's first character</param>
+    private static void parseOption(
+      ParserState state, string line, int firstCharacterIndex
+    ) {
+      Option option = new Option() {
+        LineIndex = state.Store.lines.Count - 1
+      };
+      throw new NotImplementedException();
+    }
+
+    /// <summary>Determines the best matching type for an option value</summary>
+    /// <param name="value">Value for which the best matching type will be found</param>
+    /// <returns>The best matching type for the specified option value</returns>
+    private static Type getBestMatchingType(ref StringSegment value) {
+      if(value.Count == 0) {
+        return typeof(string);
+      }
+
+      // If there are at least two characters, it may be an integer with
+      // a sign in front of it
+      if(value.Count >= 2) {
+        int index = value.Offset;
+        if(ParserHelper.SkipInteger(value.Text, ref index)) {
+          if(index < value.Offset + value.Count) {
+            if(value.Text[index] == '.') {
+              return typeof(float);
+            }
+          }
+
+          return typeof(int);
+        }
+      } else if(value.Count >= 1) { // If it's at least one character, it may be a number
+        int index = value.Offset;
+        ParserHelper.SkipNumericals(value.Text, ref index);
+        if(index > value.Offset) {
+          return typeof(int);
+        }
+      }
+
+      // If it parses as a boolean literal, then it must be a boolean
+      if(parseBooleanLiteral(ref value) != null) {
+        return typeof(bool);
+      }
+
+      return typeof(string);
+    }
+
+    /// <summary>Tried to parse a boolean literal</summary>
+    /// <param name="value">Value that will be parsed as a boolean literal</param>
+    /// <returns>
+    ///   True or false if the value was a boolean literal, null if it wasn't
+    /// </returns>
+    private static bool? parseBooleanLiteral(ref StringSegment value) {
+      switch(value.Count) {
+
+        // If the string spells 'no', it is considered a boolean
+        case 2: {
+          bool isSpellingNo =
+            ((value.Text[value.Offset + 0] == 'n') || (value.Text[value.Offset + 0] == 'N')) &&
+            ((value.Text[value.Offset + 1] == 'o') || (value.Text[value.Offset + 1] == 'O'));
+          return isSpellingNo ? new Nullable<bool>(false) : null;
+        }
+
+        // If the string spells 'yes', it is considered a boolean
+        case 3: {
+          bool isSpellingYes =
+            ((value.Text[value.Offset + 0] == 'y') || (value.Text[value.Offset + 0] == 'Y')) &&
+            ((value.Text[value.Offset + 1] == 'e') || (value.Text[value.Offset + 1] == 'E')) &&
+            ((value.Text[value.Offset + 2] == 's') || (value.Text[value.Offset + 2] == 'S'));
+          return isSpellingYes ? new Nullable<bool>(true) : null;
+        }
+
+        // If the string spells 'true', it is considered a boolean
+        case 4: {
+          bool isSpellingTrue =
+            ((value.Text[value.Offset + 0] == 't') || (value.Text[value.Offset + 0] == 'T')) &&
+            ((value.Text[value.Offset + 1] == 'r') || (value.Text[value.Offset + 1] == 'R')) &&
+            ((value.Text[value.Offset + 2] == 'u') || (value.Text[value.Offset + 2] == 'U')) &&
+            ((value.Text[value.Offset + 3] == 'e') || (value.Text[value.Offset + 3] == 'E'));
+          return isSpellingTrue ? new Nullable<bool>(true) : null;
+        }
+
+        // If the string spells 'false', it is considered a boolean
+        case 5: {
+          bool isSpellingFalse =
+            ((value.Text[value.Offset + 0] == 'f') || (value.Text[value.Offset + 0] == 'F')) &&
+            ((value.Text[value.Offset + 1] == 'a') || (value.Text[value.Offset + 1] == 'A')) &&
+            ((value.Text[value.Offset + 2] == 'l') || (value.Text[value.Offset + 2] == 'L')) &&
+            ((value.Text[value.Offset + 3] == 's') || (value.Text[value.Offset + 3] == 'S')) &&
+            ((value.Text[value.Offset + 4] == 'e') || (value.Text[value.Offset + 4] == 'E'));
+          return isSpellingFalse ? new Nullable<bool>(false) : null;
+        }
+
+        // Anything else is not considered a boolean
+        default: {
+          return null;
+        }
+
+      }
+    }
+
+  }
+
+} // namespace Nuclex.Support.Configuration

Source/Settings/ConfigurationFileStore.cs

@@ -0,0 +1,191 @@
+#region CPL License
+/*
+Nuclex Framework
+Copyright (C) 2002-2014 Nuclex Development Labs
+
+This library is free software; you can redistribute it and/or
+modify it under the terms of the IBM Common Public License as
+published by the IBM Corporation; either version 1.0 of the
+License, or (at your option) any later version.
+
+This library 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
+IBM Common Public License for more details.
+
+You should have received a copy of the IBM Common Public
+License along with this library
+*/
+#endregion
+
+using System;
+using System.Collections.Generic;
+using System.IO;
+
+using Nuclex.Support.Parsing;
+
+namespace Nuclex.Support.Settings {
+
+  /// <summary>Represents an ini- or cfg-like configuration file</summary>
+  /// <remarks>
+  ///   This class tries its best to preserve the formatting of configuration files.
+  ///   Changing a value will keep the line it appears in intact.
+  /// </remarks>
+  public partial class ConfigurationFileStore : ISettingsStore {
+
+    #region class Category
+
+    /// <summary>Stores informations about a category found in the configuration file</summary>
+    private class Category {
+
+      /// <summary>Index of the line the category is defined in</summary>
+      public int LineIndex;
+
+      /// <summary>Name of the category as a string</summary>
+      public StringSegment CategoryName;
+
+      /// <summary>Lookup table for the options in this category</summary>
+      public IDictionary<string, Option> OptionLookup;
+
+    }
+
+    #endregion // class Category
+
+    #region class Option
+
+    /// <summary>Stores informations about an option found in the configuration file</summary>
+    private class Option {
+
+      /// <summary>Index of the line the option is defined in</summary>
+      public int LineIndex;
+
+      /// <summary>Name of the option as a string</summary>
+      public StringSegment OptionName;
+
+      /// <summary>Value of the option as a string</summary>
+      public StringSegment OptionValue;
+
+    }
+
+    #endregion // class Option
+
+    /// <summary>Initializes a new, empty configuration file</summary>
+    public ConfigurationFileStore() {
+      this.lines = new List<string>();
+      this.categories = new List<Category>();
+      this.options = new List<Option>();
+      this.categoryLookup = new Dictionary<string, Category>();
+      this.RootCategory = new Category() {
+        LineIndex = -1,
+        OptionLookup = new Dictionary<string, Option>()
+      };
+    }
+
+    /// <summary>Saves the configuration file into the specified writer</summary>
+    /// <param name="writer">Writer the configuration file will be saved into</param>
+    public void Save(TextWriter writer) {
+      for(int index = 0; index < this.lines.Count; ++index) {
+        writer.WriteLine(this.lines[index]);
+      }
+    }
+
+    /// <summary>Enumerates the categories defined in the configuration</summary>
+    /// <returns>An enumerable list of all used categories</returns>
+    public IEnumerable<string> EnumerateCategories() {
+      for(int index = 0; index < this.categories.Count; ++index) {
+        yield return this.categories[index].CategoryName.ToString();
+      }
+    }
+
+    /// <summary>Enumerates the options stored under the specified category</summary>
+    /// <param name="category">Category whose options will be enumerated</param>
+    /// <returns>An enumerable list of all options in the category</returns>
+    public IEnumerable<OptionInfo> EnumerateOptions(string category = null) {
+      Category enumeratedCategory;
+
+      if(string.IsNullOrEmpty(category)) {
+        enumeratedCategory = this.RootCategory;
+      } else if(!this.categoryLookup.TryGetValue(category, out enumeratedCategory)) {
+        throw new KeyNotFoundException(
+          "There is no category named '" + category + "' in the configuration file"
+        );
+      }
+
+      foreach(Option option in this.RootCategory.OptionLookup.Values) {
+        OptionInfo optionInfo = new OptionInfo() {
+          Name = option.OptionName.ToString(),
+          OptionType = getBestMatchingType(ref option.OptionValue)
+        };
+        yield return optionInfo;
+      }
+    }
+
+    /// <summary>Retrieves the value of the specified option</summary>
+    /// <typeparam name="TValue">Type the option will be converted to</typeparam>
+    /// <param name="category">Category the option can be found in. Can be null.</param>
+    /// <param name="optionName">Name of the option that will be looked up</param>
+    /// <returns>The value of the option with the specified name</returns>
+    public TValue Get<TValue>(string category, string optionName) {
+      TValue value;
+      if(TryGet<TValue>(category, optionName, out value)) {
+        return value;
+      } else {
+        if(string.IsNullOrEmpty(category)) {
+          throw new KeyNotFoundException(
+            "There is no option named '" + optionName + "' in the configuration file"
+          );
+        } else {
+          throw new KeyNotFoundException(
+            "There is no option named '" + optionName + "' under the category '" +
+            category + "' in the configuration file"
+          );
+        }
+      }
+    }
+
+    /// <summary>Tries to retrieve the value of the specified option</summary>
+    /// <typeparam name="TValue">Type the option will be converted to</typeparam>
+    /// <param name="category">Category the option can be found in. Can be null.</param>
+    /// <param name="optionName">Name of the option that will be looked up</param>
+    /// <param name="value">Will receive the value of the option, if found</param>
+    /// <returns>
+    ///   True if the option existed and its value was written into the <paramref name="value" />
+    ///   parameter, false otherwise
+    /// </returns>
+    public bool TryGet<TValue>(string category, string optionName, out TValue value) {
+      throw new NotImplementedException();
+    }
+
+    /// <summary>Saves an option in the settings store</summary>
+    /// <typeparam name="TValue">Type of value that will be saved</typeparam>
+    /// <param name="category">Category the option will be placed in. Can be null.</param>
+    /// <param name="optionName">Name of the option that will be saved</param>
+    /// <param name="value">The value under which the option will be saved</param>
+    public void Set<TValue>(string category, string optionName, TValue value) {
+      throw new NotImplementedException();
+    }
+
+    /// <summary>Removes the option with the specified name</summary>
+    /// <param name="category">Category the option is found in. Can be null.</param>
+    /// <param name="optionName">Name of the option that will be removed</param>
+    /// <returns>True if the option was found and removed</returns>
+    public bool Remove(string category, string optionName) {
+      throw new NotImplementedException();
+    }
+
+    /// <summary>Lines contained in the configuration file</summary>
+    private IList<string> lines;
+
+    /// <summary>Records where categories are stored in the configuration file</summary>
+    private IList<Category> categories;
+    /// <summary>Records where options are stored in the configuration file</summary>
+    private IList<Option> options;
+
+    /// <summary>Root category where options above any category definition go</summary>
+    private Category RootCategory;
+    /// <summary>Lookup table for all categories by their name</summary>
+    private IDictionary<string, Category> categoryLookup;
+
+  }
+
+} // namespace Nuclex.Support.Settings

Source/Settings/ISettingsStore.cs

@@ -0,0 +1,80 @@
+#region CPL License
+/*
+Nuclex Framework
+Copyright (C) 2002-2014 Nuclex Development Labs
+
+This library is free software; you can redistribute it and/or
+modify it under the terms of the IBM Common Public License as
+published by the IBM Corporation; either version 1.0 of the
+License, or (at your option) any later version.
+
+This library 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
+IBM Common Public License for more details.
+
+You should have received a copy of the IBM Common Public
+License along with this library
+*/
+#endregion
+
+using System;
+using System.Collections.Generic;
+
+namespace Nuclex.Support.Settings {
+
+  /// <summary>Interface by which settings and configuration data can be accessed</summary>
+  public interface ISettingsStore {
+
+    /// <summary>Enumerates the categories defined in the configuration</summary>
+    /// <returns>An enumerable list of all used categories</returns>
+    IEnumerable<string> EnumerateCategories();
+
+    /// <summary>Enumerates the options stored under the specified category</summary>
+    /// <param name="category">Category whose options will be enumerated</param>
+    /// <returns>An enumerable list of all options in the category</returns>
+    IEnumerable<OptionInfo> EnumerateOptions(string category = null);
+
+    /// <summary>Retrieves the value of the specified option</summary>
+    /// <typeparam name="TValue">Type the option will be converted to</typeparam>
+    /// <param name="category">Category the option can be found in. Can be null.</param>
+    /// <param name="optionName">Name of the option that will be looked up</param>
+    /// <returns>The value of the option with the specified name</returns>
+    TValue Get<TValue>(string category, string optionName);
+
+    /// <summary>Tries to retrieve the value of the specified option</summary>
+    /// <typeparam name="TValue">Type the option will be converted to</typeparam>
+    /// <param name="category">Category the option can be found in. Can be null.</param>
+    /// <param name="optionName">Name of the option that will be looked up</param>
+    /// <param name="value">Will receive the value of the option, if found</param>
+    /// <returns>
+    ///   True if the option existed and its value was written into the <paramref name="value" />
+    ///   parameter, false otherwise
+    /// </returns>
+    bool TryGet<TValue>(string category, string optionName, out TValue value);
+
+    /// <summary>Saves an option in the settings store</summary>
+    /// <typeparam name="TValue">Type of value that will be saved</typeparam>
+    /// <param name="category">Category the option will be placed in. Can be null.</param>
+    /// <param name="optionName">Name of the option that will be saved</param>
+    /// <param name="value">The value under which the option will be saved</param>
+    void Set<TValue>(string category, string optionName, TValue value);
+
+    /// <summary>Removes the option with the specified name</summary>
+    /// <param name="category">Category the option is found in. Can be null.</param>
+    /// <param name="optionName">Name of the option that will be removed</param>
+    /// <returns>True if the option was found and removed</returns>
+    bool Remove(string category, string optionName);
+
+  }
+
+} // namespace Nuclex.Support.Settings
+
+#if WANT_TO_SUPPORT_MESSED_UP_CONFIGURATION_FILES
+    /// <remarks>
+    ///   Some settings stores allow multiple options with the same name to exist.
+    ///   If you request a collection of values (IEnumerable, ICollection, IList or their
+    ///   generic variants), you will be given a collection of all values appearing
+    ///   in the scope you specified.
+    /// </remarks>
+#endif

Source/Settings/MemoryStore.cs

@@ -0,0 +1,121 @@
+#region CPL License
+/*
+Nuclex Framework
+Copyright (C) 2002-2014 Nuclex Development Labs
+
+This library is free software; you can redistribute it and/or
+modify it under the terms of the IBM Common Public License as
+published by the IBM Corporation; either version 1.0 of the
+License, or (at your option) any later version.
+
+This library 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
+IBM Common Public License for more details.
+
+You should have received a copy of the IBM Common Public
+License along with this library
+*/
+#endregion
+
+using System;
+using System.Collections.Generic;
+
+namespace Nuclex.Support.Settings {
+
+  /// <summary>Stores settings in memory</summary>
+  public class MemoryStore : ISettingsStore {
+
+    /// <summary>Initializes a new settings store managing settings in memory</summary>
+    public MemoryStore() {
+      this.options = new Dictionary<string, IDictionary<string, object>>();
+      this.rootOptions = new Dictionary<string, object>();
+    }
+
+    /// <summary>Enumerates the categories defined in the configuration</summary>
+    /// <returns>An enumerable list of all used categories</returns>
+    public IEnumerable<string> EnumerateCategories() {
+      return this.options.Keys;
+    }
+
+    /// <summary>Enumerates the options stored under the specified category</summary>
+    /// <param name="category">Category whose options will be enumerated</param>
+    /// <returns>An enumerable list of all options in the category</returns>
+    public IEnumerable<OptionInfo> EnumerateOptions(string category = null) {
+      IDictionary<string, object> categoryOptions;
+      if(string.IsNullOrEmpty(category)) {
+        categoryOptions = this.rootOptions;
+      } else if(!this.options.TryGetValue(category, out categoryOptions)) {
+        yield break;
+      }
+
+      foreach(KeyValuePair<string, object> option in categoryOptions) {
+        OptionInfo optionInfo = new OptionInfo() {
+          Name = option.Key,
+          OptionType = option.Value.GetType()
+        };
+        yield return optionInfo;
+      }
+    }
+
+    /// <summary>Retrieves the value of the specified option</summary>
+    /// <typeparam name="TValue">Type the option will be converted to</typeparam>
+    /// <param name="category">Category the option can be found in. Can be null.</param>
+    /// <param name="optionName">Name of the option that will be looked up</param>
+    /// <returns>The value of the option with the specified name</returns>
+    public TValue Get<TValue>(string category, string optionName) {
+      TValue value;
+      if(TryGet<TValue>(category, optionName, out value)) {
+        return value;
+      } else {
+        if(string.IsNullOrEmpty(category)) {
+          throw new KeyNotFoundException(
+            "There is no option named '" + optionName + "' in the settings"
+          );
+        } else {
+          throw new KeyNotFoundException(
+            "There is no option named '" + optionName + "' under the category '" +
+            category + "' in the settings"
+          );
+        }
+      }
+    }
+
+    /// <summary>Tries to retrieve the value of the specified option</summary>
+    /// <typeparam name="TValue">Type the option will be converted to</typeparam>
+    /// <param name="category">Category the option can be found in. Can be null.</param>
+    /// <param name="optionName">Name of the option that will be looked up</param>
+    /// <param name="value">Will receive the value of the option, if found</param>
+    /// <returns>
+    ///   True if the option existed and its value was written into the <paramref name="value" />
+    ///   parameter, false otherwise
+    /// </returns>
+    public bool TryGet<TValue>(string category, string optionName, out TValue value) {
+      throw new NotImplementedException();
+    }
+
+    /// <summary>Saves an option in the settings store</summary>
+    /// <typeparam name="TValue">Type of value that will be saved</typeparam>
+    /// <param name="category">Category the option will be placed in. Can be null.</param>
+    /// <param name="optionName">Name of the option that will be saved</param>
+    /// <param name="value">The value under which the option will be saved</param>
+    public void Set<TValue>(string category, string optionName, TValue value) {
+      throw new NotImplementedException();
+    }
+
+    /// <summary>Removes the option with the specified name</summary>
+    /// <param name="category">Category the option is found in. Can be null.</param>
+    /// <param name="optionName">Name of the option that will be removed</param>
+    /// <returns>True if the option was found and removed</returns>
+    public bool Remove(string category, string optionName) {
+      throw new NotImplementedException();
+    }
+
+    /// <summary>Categories and the options stored in them</summary>
+    private IDictionary<string, IDictionary<string, object>> options;
+    /// <summary>Options stored at the root level</summary>
+    private IDictionary<string, object> rootOptions;
+
+  }
+
+} // namespace Nuclex.Support.Settings

Source/Settings/OptionInfo.cs

@@ -0,0 +1,35 @@
+#region CPL License
+/*
+Nuclex Framework
+Copyright (C) 2002-2014 Nuclex Development Labs
+
+This library is free software; you can redistribute it and/or
+modify it under the terms of the IBM Common Public License as
+published by the IBM Corporation; either version 1.0 of the
+License, or (at your option) any later version.
+
+This library 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
+IBM Common Public License for more details.
+
+You should have received a copy of the IBM Common Public
+License along with this library
+*/
+#endregion
+
+using System;
+
+namespace Nuclex.Support.Settings {
+
+  /// <summary>Informations about an option stored in a settings container</summary>
+  public struct OptionInfo {
+
+    /// <summary>Name of the option</summary>
+    public string Name;
+    /// <summary>Data type of the option</summary>
+    public Type OptionType;
+
+  }
+
+} // namespace Nuclex.Support.Settings

Source/Settings/WindowsRegistryStore.cs

@@ -0,0 +1,101 @@
+#region CPL License
+/*
+Nuclex Framework
+Copyright (C) 2002-2014 Nuclex Development Labs
+
+This library is free software; you can redistribute it and/or
+modify it under the terms of the IBM Common Public License as
+published by the IBM Corporation; either version 1.0 of the
+License, or (at your option) any later version.
+
+This library 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
+IBM Common Public License for more details.
+
+You should have received a copy of the IBM Common Public
+License along with this library
+*/
+#endregion
+
+using System;
+using System.Collections.Generic;
+
+namespace Nuclex.Support.Settings {
+
+  /// <summary>Stores settings in the registry on Windows operating systems</summary>
+  public class WindowsRegistryStore : ISettingsStore, IDisposable {
+
+    /// <summary>Immediately releases all resources owned by the instance</summary>
+    public void Dispose() {
+    }
+
+    /// <summary>Enumerates the categories defined in the configuration</summary>
+    /// <returns>An enumerable list of all used categories</returns>
+    public IEnumerable<string> EnumerateCategories() {
+      throw new NotImplementedException();
+    }
+
+    /// <summary>Enumerates the options stored under the specified category</summary>
+    /// <param name="category">Category whose options will be enumerated</param>
+    /// <returns>An enumerable list of all options in the category</returns>
+    public IEnumerable<OptionInfo> EnumerateOptions(string category = null) {
+      throw new NotImplementedException();
+    }
+
+    /// <summary>Retrieves the value of the specified option</summary>
+    /// <typeparam name="TValue">Type the option will be converted to</typeparam>
+    /// <param name="category">Category the option can be found in. Can be null.</param>
+    /// <param name="optionName">Name of the option that will be looked up</param>
+    /// <returns>The value of the option with the specified name</returns>
+    public TValue Get<TValue>(string category, string optionName) {
+      TValue value;
+      if(TryGet<TValue>(category, optionName, out value)) {
+        return value;
+      } else {
+        if(string.IsNullOrEmpty(category)) {
+          throw new KeyNotFoundException(
+            "There is no option named '" + optionName + "' in the registry"
+          );
+        } else {
+          throw new KeyNotFoundException(
+            "There is no option named '" + optionName + "' under the category '" +
+            category + "' in the registry"
+          );
+        }
+      }
+    }
+
+    /// <summary>Tries to retrieve the value of the specified option</summary>
+    /// <typeparam name="TValue">Type the option will be converted to</typeparam>
+    /// <param name="category">Category the option can be found in. Can be null.</param>
+    /// <param name="optionName">Name of the option that will be looked up</param>
+    /// <param name="value">Will receive the value of the option, if found</param>
+    /// <returns>
+    ///   True if the option existed and its value was written into the <paramref name="value" />
+    ///   parameter, false otherwise
+    /// </returns>
+    public bool TryGet<TValue>(string category, string optionName, out TValue value) {
+      throw new NotImplementedException();
+    }
+
+    /// <summary>Saves an option in the settings store</summary>
+    /// <typeparam name="TValue">Type of value that will be saved</typeparam>
+    /// <param name="category">Category the option will be placed in. Can be null.</param>
+    /// <param name="optionName">Name of the option that will be saved</param>
+    /// <param name="value">The value under which the option will be saved</param>
+    public void Set<TValue>(string category, string optionName, TValue value) {
+      throw new NotImplementedException();
+    }
+
+    /// <summary>Removes the option with the specified name</summary>
+    /// <param name="category">Category the option is found in. Can be null.</param>
+    /// <param name="optionName">Name of the option that will be removed</param>
+    /// <returns>True if the option was found and removed</returns>
+    public bool Remove(string category, string optionName) {
+      throw new NotImplementedException();
+    }
+
+  }
+
+} // namespace Nuclex.Support.Settings