Merge remote-tracking branch 'origin/master' into vault

delphidabbler · delphidabbler · commit 46cb53482f6b · 2025-04-15T17:50:23.000+01:00
Brings vault up to date with the CodeSnip v4.24.2 code base.

Resolved conflicts:

* Rejected incoming changes from 'origin/master' in Src/VersionInfo.vi-inc

* Manually resolved conflicts in Src/FrOverview.pas
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,18 @@ Releases are listed in reverse version number order.
 
 > Note that _CodeSnip_ v4 was developed in parallel with v3 for a while. As a consequence some v3 releases have later release dates than early v4 releases.
 
+## Release v4.24.2 of 14 April 2025
+
+Hotfix release.
+
+* Updated bug fix implemented in v4.24.1 to avoid relying on a potentially problematic windows event [issue #70 (2nd attempt)].
+* Corrected release date error for v4.24.1 in `CHANGELOG.md`.
+
+## Release v4.24.1 of 13 April 2025
+
+* Fixed bug where CodeSnip occasionally crashes after a computer resumes from hibernation [issue #70].
+* Bumped some copyright dates for 2025.
+
 ## Release v4.24.0 of 23 October 2024
 
 * Compilers with which a snippet has not been tested are now omitted from snippet information that is copied to the clipboard and included in print outs [issue #143].
diff --git a/Docs/License.html b/Docs/License.html
@@ -1,7 +1,7 @@
 ﻿<!DOCTYPE HTML>
 
 <!--
- * Copyright (C) 2012-2024, Peter Johnson (gravatar.com/delphidabbler).
+ * Copyright (C) 2012-2025, Peter Johnson (gravatar.com/delphidabbler).
  *
  * CodeSnip license.
  *
@@ -231,7 +231,7 @@ <h2>
     Executable Program
   </h2>
   <p>
-    DelphiDabbler <em>CodeSnip</em> is copyright &copy; 2005-2024 by <a
+    DelphiDabbler <em>CodeSnip</em> is copyright &copy; 2005-2025 by <a
       href="https://gravatar.com/delphidabbler"
     >Peter D Johnson</a>.
   </p>
@@ -1801,7 +1801,7 @@ <h2 id="ddab-exclusive">
   </h2>
 
   <p>
-    Files covered by this license are original work, copyright &copy; 2012-2024, <a href="https://gravatar.com/delphidabbler">Peter D Johnson</a>.
+    Files covered by this license are original work, copyright &copy; 2012-2025, <a href="https://gravatar.com/delphidabbler">Peter D Johnson</a>.
   </p>
 
   <p>
diff --git a/Src/FmMain.pas b/Src/FmMain.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 https://mozilla.org/MPL/2.0/
  *
- * Copyright (C) 2005-2024, Peter Johnson (gravatar.com/delphidabbler).
+ * Copyright (C) 2005-2025, Peter Johnson (gravatar.com/delphidabbler).
  *
  * Application's main form. Handles the program's main window display and user
  * interaction.
@@ -521,6 +521,12 @@   TMainForm = class(THelpAwareForm)
       ///  <summary>Object that manages favourites.</summary>
       fFavouritesMgr: TFavouritesManager;
 
+    ///  <summary>Handles the <c>WM_POWERBROADCAST</c> messages to detect and
+    ///  respond to hibernation messages.</summary>
+    ///  <remarks>!! HACK necessary as part of the fix for an obscure bug. See
+    ///  https://github.com/delphidabbler/codesnip/issues/70</remarks>
+    procedure WMPowerBroadcast(var Msg: TMessage); message WM_POWERBROADCAST;
+
     ///  <summary>Displays view item given by TViewItemAction instance
     ///  referenced by Sender and adds to history list.</summary>
     procedure ActViewItemExecute(Sender: TObject);
@@ -1345,7 +1351,6 @@ procedure TMainForm.FormDestroy(Sender: TObject);
   // fStatusBarMgr MUST be nilled: otherwise it can be called after status bar
   // control has been freed and so cause AV when trying to use the control
   FreeAndNil(fStatusBarMgr);
-
 end;
 
 procedure TMainForm.FormResize(Sender: TObject);
@@ -1531,7 +1536,6 @@ procedure TMainForm.InitForm;
     // Create object to handle compilation and assoicated UI and dialogues
     fCompileMgr := TMainCompileMgr.Create(Self);  // auto-freed
 
-
     // Set event handler for snippets database
     Database.AddChangeEventHandler(DBChangeHandler);
 
@@ -1599,5 +1603,19 @@ procedure TMainForm.splitVertCanResize(Sender: TObject;
     Accept := False;
 end;
 
+procedure TMainForm.WMPowerBroadcast(var Msg: TMessage);
+begin
+  // !! HACK
+  // Sometimes when the computer is resumed from hibernation the tree view in
+  // the overview frame is destroyed and recreated by Windows. Unfortunately the
+  // IView instances associated with the recreated tree nodes are lost.
+  // Attempting to read those (now nil) IView instances was resulting in an
+  // access violation.
+  case Msg.WParam of
+    PBT_APMSUSPEND:
+      fMainDisplayMgr._HACK_PrepareForHibernate;
+  end;
+end;
+
 end.
 
diff --git a/Src/FrOverview.pas b/Src/FrOverview.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 https://mozilla.org/MPL/2.0/
  *
- * Copyright (C) 2005-2023, Peter Johnson (gravatar.com/delphidabbler).
+ * Copyright (C) 2005-2025, Peter Johnson (gravatar.com/delphidabbler).
  *
  * Implements a titled frame that displays lists of snippets, arranged in
  * different ways, and manages user interaction with the displayed items.
@@ -41,6 +41,29 @@ interface
 
 type
 
+  // !! HACK
+  // Horrible hack to expose CreateWnd for overiding TTreeView.CreateWnd for the
+  // existing TTreeView component of TOverviewFrame. The hack avoids having to
+  // remove the component and replacing it with a descendant class that is
+  // manually constructed at run time.
+  // This is here to enable the tree view to be recreated with correctly
+  // instantiated TViewItemTreeNode nodes after Windows recreates the tree
+  // behind the scenes after resuming from hibernation.
+  // I am deeply ashamed of this hack.
+  TTreeView = class(ComCtrls.TTreeView)
+  strict private
+    var
+      _HACK_fOnAfterCreateNilViews: TNotifyEvent;
+  protected
+    procedure CreateWnd; override;
+  public
+    ///  <summary>!! HACK. Event triggered after the inherited CreateWnd is
+    ///  called. Only called if the tree view has nil references to IView
+    ///  objects.</summary>
+    property _HACK_OnAfterCreateNilViews: TNotifyEvent
+      read _HACK_fOnAfterCreateNilViews write _HACK_fOnAfterCreateNilViews;
+  end;
+
   {
   TOverviewFrame:
     Titled frame that displays lists of snippets grouped in various ways and
@@ -105,6 +128,7 @@       TTVDraw = class(TSnippetsTVDraw)
             @return True if node is a section header, False if not.
           }
       end;
+
     var
       fTVDraw: TTVDraw;             // Object that renders tree view nodes
       fNotifier: INotifier;         // Notifies app of user initiated events
@@ -232,6 +256,10 @@       TTVDraw = class(TSnippetsTVDraw)
     procedure RestoreTreeState;
       {Restores last saved treeview expansion state from memory.
       }
+    ///  <summary>!! HACK: Sets an event handler on the tree view to work
+    ///  around a bug that can occur after resuming from hibernation.</summary>
+    ///  <remarks>Method of IOverviewDisplayMgr.</remarks>
+    procedure _HACK_SetHibernateHandler(const AHandler: TNotifyEvent);
     { IPaneInfo }
     function IsInteractive: Boolean;
       {Checks if the pane is currently interactive with user.
@@ -975,6 +1003,12 @@ procedure TOverviewFrame.UpdateTreeState(const State: TTreeNodeAction);
   end;
 end;
 
+procedure TOverviewFrame._HACK_SetHibernateHandler(
+  const AHandler: TNotifyEvent);
+begin
+  tvSnippets._HACK_OnAfterCreateNilViews := AHandler;
+end;
+
 { TOverviewFrame.TTVDraw }
 
 function TOverviewFrame.TTVDraw.GetVaultID(const Node: TTreeNode): TVaultID;
@@ -984,7 +1018,7 @@ function TOverviewFrame.TTVDraw.GetVaultID(const Node: TTreeNode): TVaultID;
 begin
   // TODO -cBug: Exception reported as issue #70 could have moved here
   ViewItem := (Node as TViewItemTreeNode).ViewItem;
-  if Supports(ViewItem, ISnippetView, SnippetView) then
+  if Assigned(ViewItem) and Supports(ViewItem, ISnippetView, SnippetView) then
     Result := SnippetView.Snippet.VaultID
   else
     Result := TVaultID.CreateNull;
@@ -1000,7 +1034,31 @@ function TOverviewFrame.TTVDraw.IsSectionHeadNode(
   ViewItem: IView;  // view item represented by node
 begin
   ViewItem := (Node as TViewItemTreeNode).ViewItem;
-  Result := ViewItem.IsGrouping;
+  // Workaround for possibility that ViewItem might be nil when restarting after
+  // hibernation.
+  if Assigned(ViewItem) then
+    Result := ViewItem.IsGrouping
+  else
+    Result := False;
+end;
+
+{ TTreeView }
+
+procedure TTreeView.CreateWnd;
+var
+  HasNilViews: Boolean;
+  Node: TTreeNode;
+begin
+  inherited;
+  HasNilViews := False;
+  for Node in Items do
+  begin
+    HasNilViews := not Assigned((Node as TViewItemTreeNode).ViewItem);
+    if HasNilViews then
+      Break;
+  end;
+  if HasNilViews and Assigned(_HACK_fOnAfterCreateNilViews) then
+    _HACK_fOnAfterCreateNilViews(Self);
 end;
 
 end.
diff --git a/Src/Help/HTML/license.htm b/Src/Help/HTML/license.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 https://mozilla.org/MPL/2.0/
  *
- * Copyright (C) 2012-2024, Peter Johnson (gravatar.com/delphidabbler).
+ * Copyright (C) 2012-2025, Peter Johnson (gravatar.com/delphidabbler).
  *
  * Help topic containing summary of CodeSnip license.
 -->
@@ -27,7 +27,7 @@ <h1>
       <a name="license"></a>Summary of End User License Agreement
     </h1>
     <p>
-      DelphiDabbler <em>CodeSnip</em> is copyright &copy; 2005-2024 by Peter D
+      DelphiDabbler <em>CodeSnip</em> is copyright &copy; 2005-2025 by Peter D
       Johnson, <a
         href="https://gravatar.com/delphidabbler"
         class="weblink"
diff --git a/Src/Install/Assets/License.rtf b/Src/Install/Assets/License.rtf
@@ -1,7 +1,7 @@
 {\rtf1\ansi\ansicpg1252\deff0\nouicompat\deftab709{\fonttbl{\f0\fswiss\fprq2\fcharset0 Arial;}}
 {\colortbl ;\red0\green0\blue255;}
 {\*\generator Riched20 10.0.18362}\viewkind4\uc1 
-\pard\sa113\f0\fs18\lang1033 DelphiDabbler CodeSnip is copyright \'a9 2005-2024 by Peter D Johnson, {{\field{\*\fldinst{HYPERLINK https://en.gravatar.com/delphidabbler }}{\fldrslt{https://en.gravatar.com/delphidabbler\ul0\cf0}}}}\f0\fs18 . \par
+\pard\sa113\f0\fs18\lang1033 DelphiDabbler CodeSnip is copyright \'a9 2005-2025 by Peter D Johnson, {{\field{\*\fldinst{HYPERLINK https://en.gravatar.com/delphidabbler }}{\fldrslt{https://en.gravatar.com/delphidabbler\ul0\cf0}}}}\f0\fs18 . \par
 The executable version of CodeSnip is made available under the terms of the Mozilla Public License 2.0 ({{\field{\*\fldinst{HYPERLINK https://www.mozilla.org/MPL/2.0/ }}{\fldrslt{https://www.mozilla.org/MPL/2.0/\ul0\cf0}}}}\f0\fs18 ). This means you can use, copy and distribute CodeSnip as you wish.\par
 You may also modify CodeSnip as you wish and you may distribute copies of your modified version under the terms of the Mozilla Public License. The only exception is that you may not use the CodeSnip name or branding (e.g. the program icon) in any modification you distribute unless you have the explicit permission of the copyright holder. \par
 For full information see the file \i License.html\i0  installed with this program.\fs24\lang2057\par
diff --git a/Src/IntfFrameMgrs.pas b/Src/IntfFrameMgrs.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 https://mozilla.org/MPL/2.0/
  *
- * Copyright (C) 2005-2021, Peter Johnson (gravatar.com/delphidabbler).
+ * Copyright (C) 2005-2025, Peter Johnson (gravatar.com/delphidabbler).
  *
  * Declares interfaces, constants and enumerations required to manage various
  * parts of CodeSnip's UI.
@@ -19,6 +19,7 @@ interface
 uses
   // Delphi
   SHDocVw, ActiveX,
+  Classes, // !! For HACK
   // Project
   Browser.IntfDocHostUI,
   DB.Snippets,
@@ -149,6 +150,9 @@ interface
     ///  <summary>Restore expand / collapse state of treeview to last save
     ///  state.</summary>
     procedure RestoreTreeState;
+    ///  <summary>!! HACK: Sets an event handler on the tree view to work
+    ///  around a bug that can occur after resuming from hibernation.</summary>
+    procedure _HACK_SetHibernateHandler(const AHandler: TNotifyEvent);
   end;
 
 type
diff --git a/Src/UMainDisplayMgr.pas b/Src/UMainDisplayMgr.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 https://mozilla.org/MPL/2.0/
  *
- * Copyright (C) 2005-2021, Peter Johnson (gravatar.com/delphidabbler).
+ * Copyright (C) 2005-2025, Peter Johnson (gravatar.com/delphidabbler).
  *
  * Class that manages and co-ordinates the display of the program's main UI.
  * Calls into subsidiary manager objects to perform display operations.
@@ -165,6 +165,11 @@   TMainDisplayMgr = class(TObject)
     procedure DisplayViewItem(ViewItem: IView; Mode: TDetailPageDisplayMode);
       overload;
 
+    ///  <summary>!! HACK event handle to redisplay the overview pane treeview.
+    ///  Called only if Windows has mysteriously recreated the treeview and lost
+    ///  necessary object references.</summary>
+    procedure _HACK_HibernateHandler(Sender: TObject);
+
   public
     ///  <summary>Object contructor. Sets up object to work with given frame
     ///  manager objects.</summary>
@@ -291,6 +296,14 @@   TMainDisplayMgr = class(TObject)
 
     /// <summary>Prepares display ready for database to be reloaded.</summary>
     procedure PrepareForDBReload;
+
+    ///  <summary>!!HACK: gets the overview frame prepared for program
+    ///  hibernation.</summary>
+    ///  <remarks>Saves the overview tree view state ready for restoring after
+    ///  hibernation if Windows has recreated the overview pane's treeview,
+    ///  losing necessary IView object references..</remarks>
+    procedure _HACK_PrepareForHibernate;
+
   end;
 
 
@@ -693,5 +706,21 @@ procedure TMainDisplayMgr.UpdateOverviewTreeState(const State: TTreeNodeAction);
   (fOverviewMgr as IOverviewDisplayMgr).UpdateTreeState(State);
 end;
 
+procedure TMainDisplayMgr._HACK_HibernateHandler(Sender: TObject);
+begin
+  (fOverviewMgr as IOverviewDisplayMgr).Display(Query.Selection, True);
+  (fOverviewMgr as IOverviewDisplayMgr).RestoreTreeState;
+  // disable this handler until next resume from hibernation
+  (fOverviewMgr as IOverviewDisplayMgr)._HACK_SetHibernateHandler(nil);
+end;
+
+procedure TMainDisplayMgr._HACK_PrepareForHibernate;
+begin
+  (fOverviewMgr as IOverviewDisplayMgr).SaveTreeState;
+  (fOverviewMgr as IOverviewDisplayMgr)._HACK_SetHibernateHandler(
+    _HACK_HibernateHandler
+  );
+end;
+
 end.
 
