Merge branch 'feature/config-file-viewer' into develop

Added buttons to Path (now Path & Files) tab of About box that enable user
to view the content of the program's config files.

Author: DelphiDabbler

Src/FirstRun.UInstallInfo.pas

@@ -3,7 +3,7 @@
  * v. 2.0. If a copy of the MPL was not distributed with this file, You can
  * obtain one at http://mozilla.org/MPL/2.0/
  *
- * Copyright (C) 2008-2013, Peter Johnson (www.delphidabbler.com).
+ * Copyright (C) 2008-2016, Peter Johnson (www.delphidabbler.com).
  *
  * $Rev$
  * $Date$
@@ -170,13 +170,12 @@ constructor TInstallInfo.Create;
 
 function TInstallInfo.CurrentCommonConfigFileName: string;
 begin
-  Result := IncludeTrailingPathDelimiter(TAppInfo.CommonAppDir)
-    + 'Common.config';
+  Result := TAppInfo.AppConfigFileName;
 end;
 
 class function TInstallInfo.CurrentUserConfigFileName: string;
 begin
-  Result := MakeFullUserPath(UserConfigFileNames[CurrentVersionID]);
+  Result := TAppInfo.UserConfigFileName;
 end;
 
 class function TInstallInfo.CurrentUserDatabaseDir: string;

Src/FmAboutDlg.dfm

@@ -5,7 +5,7 @@ inherited AboutDlg: TAboutDlg
   ClientHeight = 384
   ClientWidth = 485
   ExplicitWidth = 491
-  ExplicitHeight = 410
+  ExplicitHeight = 413
   PixelsPerInch = 96
   TextHeight = 13
   inherited pnlBody: TPanel
@@ -33,10 +33,6 @@ inherited AboutDlg: TAboutDlg
       OnMouseDown = pcDetailMouseDown
       object tsProgram: TTabSheet
         Caption = 'About The Program'
-        ExplicitLeft = 0
-        ExplicitTop = 0
-        ExplicitWidth = 0
-        ExplicitHeight = 0
         inline frmProgram: THTMLTpltDlgFrame
           Left = 0
           Top = 0
@@ -70,10 +66,6 @@ inherited AboutDlg: TAboutDlg
       object tsDatabase: TTabSheet
         Caption = 'About The Database'
         ImageIndex = 1
-        ExplicitLeft = 0
-        ExplicitTop = 0
-        ExplicitWidth = 0
-        ExplicitHeight = 0
         inline frmDatabase: THTMLTpltDlgFrame
           Left = 0
           Top = 0
@@ -107,10 +99,24 @@ inherited AboutDlg: TAboutDlg
       object tsPaths: TTabSheet
         Caption = 'Paths'
         ImageIndex = 2
-        ExplicitLeft = 0
-        ExplicitTop = 0
-        ExplicitWidth = 0
-        ExplicitHeight = 0
+        object btnViewAppConfig: TButton
+          Left = 3
+          Top = 144
+          Width = 170
+          Height = 25
+          Caption = 'View Application Config File...'
+          TabOrder = 1
+          OnClick = btnViewAppConfigClick
+        end
+        object btnViewUserConfig: TButton
+          Left = 192
+          Top = 144
+          Width = 170
+          Height = 25
+          Caption = 'View Per-User Config File...'
+          TabOrder = 0
+          OnClick = btnViewUserConfigClick
+        end
       end
     end
     object pnlTitle: TPanel

Src/FmAboutDlg.pas

@@ -3,7 +3,7 @@
  * v. 2.0. If a copy of the MPL was not distributed with this file, You can
  * obtain one at http://mozilla.org/MPL/2.0/
  *
- * Copyright (C) 2005-2014, Peter Johnson (www.delphidabbler.com).
+ * Copyright (C) 2005-2016, Peter Johnson (www.delphidabbler.com).
  *
  * $Rev$
  * $Date$
@@ -89,6 +89,8 @@   TAboutDlg = class(TGenericViewDlg)
     pnlTitle: TPanel;
     frmTitle: THTMLTpltDlgFrame;
     tsPaths: TTabSheet;
+    btnViewAppConfig: TButton;
+    btnViewUserConfig: TButton;
     procedure btnRegisterClick(Sender: TObject);
     procedure FormCreate(Sender: TObject);
     procedure FormDestroy(Sender: TObject);
@@ -98,6 +100,8 @@   TAboutDlg = class(TGenericViewDlg)
     ///  a tab is clicked.</remarks>
     procedure pcDetailMouseDown(Sender: TObject; Button: TMouseButton;
       Shift: TShiftState; X, Y: Integer);
+    procedure btnViewAppConfigClick(Sender: TObject);
+    procedure btnViewUserConfigClick(Sender: TObject);
   strict private
     fMainDBPathGp: TPathInfoBox;  // control that displays main database folder
     fUserDBPathGp: TPathInfoBox;  // control that displays user database folder
@@ -120,6 +124,12 @@   TAboutDlg = class(TGenericViewDlg)
           determines names that are displayed.
         @return Required HTML.
       }
+    procedure ViewConfigFile(const FileName, DlgTitle: string);
+      {Displays content of a config file in a preview dialogue box. If file
+      does not exist an error message is displayed.
+        @param FileName [in] Name of config file.
+        @param DlgTitle [in] Title of preview dialogue box.
+      }
   strict protected
     procedure ConfigForm; override;
       {Configures form by creating custom controls and initialising HTML frames.
@@ -162,9 +172,9 @@ implementation
   // Delphi
   SysUtils, Graphics, Math, Windows, ShellAPI, IOUtils,
   // Project
-  FmEasterEgg, FmRegistrationDlg, UAppInfo, UColours, UConsts, UCSSUtils,
-  UCtrlArranger, UFontHelper, UGraphicUtils, UHTMLUtils, UHTMLTemplate,
-  UResourceUtils, UThemesEx;
+  FmEasterEgg, FmPreviewDlg, FmRegistrationDlg, UAppInfo, UColours, UConsts,
+  UCSSUtils, UCtrlArranger, UEncodings, UFontHelper, UGraphicUtils, UHTMLUtils,
+  UHTMLTemplate, UIOUtils, UMessageBox, UResourceUtils, UThemesEx;
 
 
 {
@@ -215,7 +225,15 @@ procedure TAboutDlg.ArrangeForm;
 begin
   fMainDBPathGp.Top := TCtrlArranger.BottomOf(fInstallPathGp, 8);
   fUserDBPathGp.Top := TCtrlArranger.BottomOf(fMainDBPathGp, 8);
-  PathTabHeight := TCtrlArranger.BottomOf(fUserDBPathGp);
+  TCtrlArranger.AlignTops(
+    [btnViewAppConfig, btnViewUserConfig],
+    TCtrlArranger.BottomOf(fUserDBPathGp, 8)
+  );
+  PathTabHeight := TCtrlArranger.BottomOf(
+    [btnViewUserConfig, btnViewAppConfig]
+  );
+  TCtrlArranger.AlignLefts([fUserDBPathGp, btnViewAppConfig]);
+  TCtrlArranger.AlignRights([fUserDBPathGp, btnViewUserConfig]);
   // Set height of title frame and page control
   pnlTitle.Height := frmTitle.DocHeight;
   pcDetail.ClientHeight :=
@@ -240,15 +258,31 @@ procedure TAboutDlg.btnRegisterClick(Sender: TObject);
     btnRegister.Hide; // hide registration button now that program registered OK
 end;
 
+procedure TAboutDlg.btnViewAppConfigClick(Sender: TObject);
+resourcestring
+  sTitle = 'Application Config File';
+begin
+  ViewConfigFile(TAppInfo.AppConfigFileName, sTitle);
+end;
+
+procedure TAboutDlg.btnViewUserConfigClick(Sender: TObject);
+resourcestring
+  sTitle = 'Per-User Config File';
+begin
+  ViewConfigFile(TAppInfo.UserConfigFileName, sTitle);
+end;
+
 procedure TAboutDlg.ConfigForm;
   {Configures form by creating custom controls and initialising HTML frames.
   Called from ancestor class.
   }
 
-  function CreatePathInfoBox(const Caption, Path: string): TPathInfoBox;
+  function CreatePathInfoBox(const Caption, Path: string;
+    const TabOrder: Integer): TPathInfoBox;
     {Creates and initialises a custom path information control.
       @param Caption [in] Group box caption.
       @param Path [in] Path to be displayed.
+      @param TabOrder [in] Tab order of info box.
       @return New control.
     }
   begin
@@ -257,6 +291,7 @@ procedure TAboutDlg.ConfigForm;
     Result.SetBounds(8, 8, tsPaths.ClientWidth - 16, 0);
     Result.Caption := Caption;
     Result.Path := Path;
+    Result.TabOrder := TabOrder;
   end;
 
 resourcestring
@@ -268,14 +303,16 @@ procedure TAboutDlg.ConfigForm;
   inherited;
   // Creates required custom controls
   fInstallPathGp := CreatePathInfoBox(
-    sInstallPathGpCaption, TAppInfo.AppExeDir
+    sInstallPathGpCaption, TAppInfo.AppExeDir, 0
   );
   fMainDBPathGp := CreatePathInfoBox(
-    sMainDBPathGpCaption, TAppInfo.AppDataDir
+    sMainDBPathGpCaption, TAppInfo.AppDataDir, 1
   );
   fUserDBPathGp := CreatePathInfoBox(
-    sUserDBPathGpCaption, TAppInfo.UserDataDir
+    sUserDBPathGpCaption, TAppInfo.UserDataDir, 2
   );
+  btnViewAppConfig.TabOrder := fUserDBPathGp.TabOrder + 1;
+  btnViewUserConfig.TabOrder := btnViewAppConfig.TabOrder + 1;
   // Load content into HTML frames
   InitHTMLFrames;
 end;
@@ -551,6 +588,24 @@ procedure TAboutDlg.UpdateTitleCSS(Sender: TObject;
   end;
 end;
 
+procedure TAboutDlg.ViewConfigFile(const FileName, DlgTitle: string);
+var
+  Data: TEncodedData;
+resourcestring
+  sErrorMsg = 'Sorry, this config file does not (yet) exist.';
+begin
+  if not TFile.Exists(FileName) then
+  begin
+    TMessageBox.Error(Self, sErrorMsg);
+    Exit;
+  end;
+  Data := TEncodedData.Create(
+    TFileIO.ReadAllText(FileName, TEncoding.Unicode, True),
+    etUTF16LE
+  );
+  TPreviewDlg.Execute(Self, Data, dtPlainText, DlgTitle);
+end;
+
 { TPathInfoBox }
 
 procedure TPathInfoBox.BtnClick(Sender: TObject);

Src/Help/HTML/dlg_about.htm

@@ -4,7 +4,7 @@
  * v. 2.0. If a copy of the MPL was not distributed with this file, You can
  * obtain one at http://mozilla.org/MPL/2.0/
  *
- * Copyright (C) 2005-2014, Peter Johnson (www.delphidabbler.com).
+ * Copyright (C) 2005-2016, Peter Johnson (www.delphidabbler.com).
  *
  * $Rev$
  * $Date$
@@ -81,11 +81,17 @@ <h2>
       </li>
     </ul>
     <h2>
-      Paths
+      Paths &amp; Files
     </h2>
     <p>
       This tab gives information about various directories used by
-      <em>CodeSnip</em>. They are:
+      <em>CodeSnip</em> and enables the program's config files to be viewed.
+    </p>
+    <h3>
+      Directories
+    </h3>
+    <p>
+      The directories for which information is available are:
     </p>
     <ul class="unspaced">
       <li>
@@ -114,6 +120,22 @@ <h2>
       directory in Windows Explorer. If the directory does not exist then the
       button will be disabled.
     </p>
+    <h3>
+      Config Files
+    </h3>
+    <p>
+      The content of the program's application wide and per-user config files
+      can be displayed by clicking the <em>View Application Config File</em> and
+      <em>View Per-User Config File</em> buttons respectively.
+    </p>
+    <p>
+      You can find documentation of the meaning of the config file entries in
+      <em>CodeSnip<em>'s <a
+        href="https://github.com/delphidabbler/codesnip"
+        class="weblink"
+        target="_blank"
+      >Git repository</a>.
+    </p>
   </body>
 </html>
 

Src/UAppInfo.pas

@@ -3,7 +3,7 @@
  * v. 2.0. If a copy of the MPL was not distributed with this file, You can
  * obtain one at http://mozilla.org/MPL/2.0/
  *
- * Copyright (C) 2005-2013, Peter Johnson (www.delphidabbler.com).
+ * Copyright (C) 2005-2016, Peter Johnson (www.delphidabbler.com).
  *
  * $Rev$
  * $Date$
@@ -97,6 +97,12 @@   TAppInfo = class(TNoConstructObject)
       {Returns fully specified name of CodeSnip's help file.
         @return Name of help file.
       }
+    class function AppConfigFileName: string;
+      {Returns fully specified name of application config file.
+      }
+    class function UserConfigFileName: string;
+      {Returns fully specified name of per-user config file.
+      }
     class function ProgramReleaseInfo: string;
       {Gets information about the current program release. Includes any special
       build information if present in version information.
@@ -146,6 +152,11 @@ implementation
 
 { TAppInfo }
 
+class function TAppInfo.AppConfigFileName: string;
+begin
+  Result := CommonAppDir + '\Common.config';
+end;
+
 class function TAppInfo.AppDataDir: string;
   {Returns the directory where CodeSnip stores the "database" files.
     @return Full path to database sub directory.
@@ -347,6 +358,11 @@ class function TAppInfo.UserAppDir: string;
   {$ENDIF}
 end;
 
+class function TAppInfo.UserConfigFileName: string;
+begin
+  Result := UserAppDir + '\User.config';
+end;
+
 class function TAppInfo.UserDataDir: string;
   {Returns the directory where CodeSnip stores the user's "database" files.
     @return Full path to database sub directory.

Src/USettings.pas

@@ -3,7 +3,7 @@
  * v. 2.0. If a copy of the MPL was not distributed with this file, You can
  * obtain one at http://mozilla.org/MPL/2.0/
  *
- * Copyright (C) 2006-2013, Peter Johnson (www.delphidabbler.com).
+ * Copyright (C) 2006-2016, Peter Johnson (www.delphidabbler.com).
  *
  * $Rev$
  * $Date$
@@ -595,9 +595,9 @@ function TIniSettingsBase.StorageName(
 begin
   case Storage of
     ssUser:
-      Result := TAppInfo.UserAppDir + '\User.config';
+      Result := TAppInfo.UserConfigFileName;
     ssCommon:
-      Result := TAppInfo.CommonAppDir + '\Common.config';
+      Result := TAppInfo.AppConfigFileName;
     else
       raise EBug.Create(ClassName + '.StorageName: unknown storage type');
   end;