Merge branch 'release/4.24.1'

delphidabbler · delphidabbler · commit e5c0ce69076d · 2025-04-13T19:12:14.000+01:00
Release v4.24.1
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,11 @@ 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.1 of 13 April 2005
+
+* 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.
@@ -522,6 +522,11 @@   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>This is 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);
@@ -1324,7 +1329,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);
@@ -1514,7 +1518,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);
 
@@ -1582,5 +1585,22 @@ procedure TMainForm.splitVertCanResize(Sender: TObject;
     Accept := False;
 end;
 
+procedure TMainForm.WMPowerBroadcast(var Msg: TMessage);
+begin
+  // 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:
+      // Get ready for isolation
+      fMainDisplayMgr.PrepareForHibernate;
+    PBT_APMPOWERSTATUSCHANGE:
+      // Restore from hibernation: ensure the IView instances are recreeated
+      fMainDisplayMgr.RestoreFromHibernation;
+  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.
@@ -86,6 +86,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
@@ -966,7 +967,12 @@ 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;
 
 function TOverviewFrame.TTVDraw.IsUserDefinedNode(
@@ -979,8 +985,12 @@ function TOverviewFrame.TTVDraw.IsUserDefinedNode(
   ViewItem: IView;  // view item represented by node
 begin
   ViewItem := (Node as TViewItemTreeNode).ViewItem;
-  // TODO -cBug: Exception reported as issue #70 seems to be triggered here
-  Result := ViewItem.IsUserDefined;
+  // Workaround for possibility that ViewItem might be nil when restarting after
+  // hibernation.
+  if Assigned(ViewItem) then
+    Result := ViewItem.IsUserDefined
+  else
+    Result := False;
 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/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.
@@ -291,6 +291,23 @@   TMainDisplayMgr = class(TObject)
 
     /// <summary>Prepares display ready for database to be reloaded.</summary>
     procedure PrepareForDBReload;
+
+    ///  <summary>Gets the overview frame prepared for program hibernation.
+    ///  </summary>
+    ///  <remarks>Saves the overview tree view state ready for restoring after
+    ///  hibernation.</remarks>
+    procedure PrepareForHibernate;
+
+    ///  <summary>Restores the overview's tree view to have the correct IView
+    ///  instances after hibernation restores the previously saved state.
+    ///  </summary>
+    ///  <remarks>Sometimes, Windows quietly recreates the node of the tree view
+    ///  after resuming from hibernation, without restoring the associated IView
+    ///  instances, leading to access violations. This method should be called
+    ///  after resuming from hibernation to recreate the tree view with the
+    ///  correct IView instances.</remarks>
+    procedure RestoreFromHibernation;
+
   end;
 
 
@@ -566,6 +583,12 @@ procedure TMainDisplayMgr.PrepareForDBViewChange(View: IView);
   fPendingViewChange := True;
 end;
 
+procedure TMainDisplayMgr.PrepareForHibernate;
+begin
+  // simply save the state of the overview tree view ready for later restoration
+  (fOverviewMgr as IOverviewDisplayMgr).SaveTreeState;
+end;
+
 procedure TMainDisplayMgr.RedisplayOverview;
 begin
   (fOverviewMgr as IOverviewDisplayMgr).Display(Query.Selection, True);
@@ -593,6 +616,12 @@ procedure TMainDisplayMgr.ReStart;
   (fOverviewMgr as IOverviewDisplayMgr).Display(Query.Selection, True);
 end;
 
+procedure TMainDisplayMgr.RestoreFromHibernation;
+begin
+  (fOverviewMgr as IOverviewDisplayMgr).Display(Query.Selection, True);
+  (fOverviewMgr as IOverviewDisplayMgr).RestoreTreeState;
+end;
+
 procedure TMainDisplayMgr.SelectAll;
 begin
   // Only details pane supports text selection
diff --git a/Src/VersionInfo.vi-inc b/Src/VersionInfo.vi-inc
@@ -1,8 +1,8 @@
 # CodeSnip Version Information Macros for Including in .vi files
 
 # Version & build numbers
-version=4.24.0
-build=272
+version=4.24.1
+build=273
 
 # String file information
 copyright=Copyright © P.D.Johnson, 2005-<YEAR>.
