Remove support for multiple config files - only use per user config file now

Author: delphidabbler

Src/USettings.pas

@@ -160,27 +160,15 @@ interface
     property ItemCount: Integer read GetItemCount;
   end;
 
-type
-  ///  <summary>
-  ///  <para>Enumeration of the different storage locations that can store
-  ///  settings.</para>
-  ///  <para>- ssUser - Storage for per-user settings.</para>
-  ///  <para>- ssCommon - Storage for common (application-wde) settings.</para>
-  ///  </summary>
-  TSettingsStorageId = (ssUser, ssCommon);
-
 type
 
-  { TODO -cSettings: Investigate why ssApplication section no longer used.
-                     Update below and in docs once found out. }
   ///  <summary>
   ///  <para>Enumeration of recognised sections within persistent storage.
   ///  </para>
   ///  <para>-ssFindText - info about last text search</para>
   ///  <para>-ssFindCompiler - info about last compiler search</para>
   ///  <para>-ssFindXRefs - info about last XRef search</para>
   ///  <para>-ssCompilerInfo - info about each supported compiler</para>
-  ///  <para>-ssApplication - info about the application</para>
   ///  <para>-ssPreferences - info about program preferences</para>
   ///  <para>-ssUserInfo - info about user</para>
   ///  <para>-ssUnits - list of default units</para>
@@ -193,7 +181,7 @@ interface
   ///  <para>-ssUpdateChecks - info about update checks</para>
   ///  </summary>
   TSettingsSectionId = (
-    ssFindText, ssFindCompiler, ssFindXRefs, ssCompilerInfo, ssApplication,
+    ssFindText, ssFindCompiler, ssFindXRefs, ssCompilerInfo,
     ssPreferences, ssUserInfo, ssUnits, ssDuplicateSnippet,
     ssFavourites, ssWindowState, ssDatabase
   );
@@ -241,42 +229,32 @@ implementation
 
 uses
   // Delphi
-  Classes, IniFiles, IOUtils,
+  Classes,
+  IniFiles,
+  IOUtils,
   // Project
-  UAppInfo, UEncryptor, UExceptions, UHexUtils, UIOUtils, UStrUtils;
+  UAppInfo,
+  UEncryptor,
+  UHexUtils,
+  UIOUtils,
+  UStrUtils;
 
 
 var
   // Private global variable: stores reference to settings singleton object
   pvtSettings: ISettings = nil;
 
-
 type
-  ///  <summary>Base class for all settings classes, regardless of storage
-  ///  medium used.</summary>
-  TSettingsBase = class(TInterfacedObject)
-  strict protected
-    ///  <summary>Determines and returns identifier of the storage entity on
-    ///  which a section is stored.</summary>
-    ///  <param name="Section">TSettingsSectionId [in] Id of section.</param>
-    ///  <returns>Id of required storage.</returns>
-    function SectionStorage(const Section: TSettingsSectionId):
-      TSettingsStorageId;
-  end;
-
-type
-  ///  <summary>Base class for all settings classes that use ini files for
-  ///  persisent storage.</summary>
+  ///  <summary>Base class for all settings classes that use setting ini file
+  /// for persisent storage.</summary>
   ///  <remarks>Implements core ini file functionality.</remarks>
-  TIniSettingsBase = class(TSettingsBase)
+  TIniSettingsBase = class(TInterfacedObject)
   strict protected
-    ///  <summary>Maps the given storage id to the storage file name.</summary>
-    function StorageName(const Storage: TSettingsStorageId): string;
-    ///  <summary>Creates and returns a TIniFile instance onto the ini file
-    ///  for the given storage id.</summary>
+    ///  <summary>Creates and returns a TIniFile instance onto the settings ini
+    ///  file.</summary>
     ///  <remarks>The caller is responsible for freeing the returned instance.
     ///  </remarks>
-    function CreateIniFile(const Storage: TSettingsStorageId): TIniFile;
+    function CreateIniFile: TIniFile;
   public
     ///  <summary>Constructs new object instance.</summary>
     constructor Create;
@@ -348,8 +326,6 @@   TIniSettingsSection = class(TIniSettingsBase, ISettingsSection)
     var
       ///  <summary>Name of section.</summary>
       fSectionName: string;
-      ///  <summary>Id of storage to be used.</summary>
-      fStorage: TSettingsStorageId;
       ///  <summary>Stores section's data as name=value pairs.</summary>
       fValues: TStringList;
 
@@ -374,10 +350,7 @@   TIniSettingsSection = class(TIniSettingsBase, ISettingsSection)
     ///  <summary>Construct a new object instance that encapsulates an empty
     ///  section.</summary>
     ///  <param name="Section">string [in] Name of section in ini file.</param>
-    ///  <param name="Storage">TSettingsStorageId [in] Identifies the storage
-    ///  (i.e. ini file) to be used.</param>
-    constructor Create(const Section: string;
-      const Storage: TSettingsStorageId);
+    constructor Create(const Section: string);
 
     ///  <summary>Destroys object instance.</summary>
     destructor Destroy; override;
@@ -541,30 +514,6 @@ function Settings: ISettings;
   Result := pvtSettings;
 end;
 
-{ TSettingsBase }
-
-function TSettingsBase.SectionStorage(
-  const Section: TSettingsSectionId): TSettingsStorageId;
-const
-  // Map of known sections onto storage that contains them
-  cSectionStorageMap: array[TSettingsSectionId] of TSettingsStorageId = (
-    ssUser,     // ssFindText
-    ssUser,     // ssFindCompiler
-    ssUser,     // ssFindXRefs
-    ssUser,     // ssCompilerInfo
-    ssCommon,   // ssApplication
-    ssUser,     // ssPreferences
-    ssUser,     // ssUserInfo
-    ssUser,     // ssUnits
-    ssUser,     // ssDuplicateSnippet
-    ssUser,     // ssFavourites
-    ssUser,     // ssWindowState
-    ssUser      // ssDatabase
-  );
-begin
-  Result := cSectionStorageMap[Section];
-end;
-
 { TIniSettingsBase }
 
 constructor TIniSettingsBase.Create;
@@ -575,40 +524,23 @@ constructor TIniSettingsBase.Create;
   TDirectory.CreateDirectory(TAppInfo.CommonAppDir);
 end;
 
-function TIniSettingsBase.CreateIniFile(
-  const Storage: TSettingsStorageId): TIniFile;
+function TIniSettingsBase.CreateIniFile: TIniFile;
 var
   FileName: string; // name if ini file
 begin
-  FileName := StorageName(Storage);
+  FileName := TAppInfo.UserConfigFileName;
   if not TFile.Exists(FileName, False) then
     // create empty Unicode text file with BOM to force Win API to write Unicode
     TFileIO.WriteAllText(FileName, '', TEncoding.Unicode, True);
   Result := TIniFile.Create(FileName);
 end;
 
-function TIniSettingsBase.StorageName(
-  const Storage: TSettingsStorageId): string;
-begin
-  case Storage of
-    ssUser:
-      Result := TAppInfo.UserConfigFileName;
-    ssCommon:
-      Result := TAppInfo.AppConfigFileName;
-    else
-      raise EBug.Create(ClassName + '.StorageName: unknown storage type');
-  end;
-end;
-
 { TIniSettings }
 
 function TIniSettings.CreateSection(const SectionID: TSettingsSectionId;
   const SubSection: string): ISettingsSection;
 begin
-  Result := TIniSettingsSection.Create(
-    SectionName(SectionID, SubSection),
-    SectionStorage(SectionID)
-  );
+  Result := TIniSettingsSection.Create(SectionName(SectionID, SubSection));
 end;
 
 function TIniSettings.EmptySection(const Section: TSettingsSectionId;
@@ -633,7 +565,6 @@ function TIniSettings.SectionName(const Id: TSettingsSectionId;
     'FindCompiler',     // ssFindCompiler
     'FindXRefs',        // ssFindXRefs
     'Cmp',              // ssCompilerInfo
-    'Application',      // ssApplication
     'Prefs',            // ssPreferences
     'UserInfo',         // ssUserInfo
     'UnitList',         // ssUnits
@@ -655,13 +586,11 @@ procedure TIniSettingsSection.ClearItems;
   fValues.Clear;
 end;
 
-constructor TIniSettingsSection.Create(const Section: string;
-  const Storage: TSettingsStorageId);
+constructor TIniSettingsSection.Create(const Section: string);
 begin
   inherited Create;
   fValues := TStringList.Create;
   fSectionName := Section;
-  fStorage := Storage;
 end;
 
 procedure TIniSettingsSection.DeleteItem(const Name: string);
@@ -759,7 +688,7 @@ function TIniSettingsSection.ItemExists(const Name: string): Boolean;
 procedure TIniSettingsSection.Load;
 begin
   // Read all values from section in app's ini file to data item storage
-  with CreateIniFile(fStorage) do
+  with CreateIniFile do
     try
       ReadSectionValues(fSectionName, fValues);
     finally
@@ -788,7 +717,7 @@ procedure TIniSettingsSection.Save;
   Idx: Integer; // loops thru all data items in section
 begin
   // Open application's ini file
-  with CreateIniFile(fStorage) do
+  with CreateIniFile do
     try
       // Delete any existing section with same name
       EraseSection(fSectionName);