Merge branch 'develop' into feature/issue#13-prefs-dlg

delphidabbler · delphidabbler · commit e5c9d39266a1 · 2021-11-29T13:17:08.000Z
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -12,6 +12,17 @@ This change log begins with the first ever pre-release version of _CodeSnip_. Re
 From v4.1.0 the version numbering has attempted to adhere to the principles of [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 
+## Release v4.18.1 of 29 November 2021
+
+* Improved handling of control and whitespace characters in generated HTML: revised which characters were converted to HTML character attributes / entities.
+* Fixed error in title of _Save Annotated Source_ dialogue box.
+* Replaced use 3rd party `GIFImage` unit with similar `GIFImg` unit from Delphi XE VCL.
+* Corrected help topic for _Dependencies_ dialogue box to describe _Save & Close_ button.
+* Operating system detection code was updated to correctly detect Windows 11 and Windows 10 version 21H2.
+* Some refactoring.
+* Updated license document (`License.html`) following removal of dependency on GIFImage unit.
+
+
 ## Release v4.18.0 of 13 September 2021
 
 * Added support for test compilation with, and detection of, Delphi 11 Alexandria.
diff --git a/Src/3rdParty/PJSysInfo.pas b/Src/3rdParty/PJSysInfo.pas
@@ -3,10 +3,10 @@
  * 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) 2001-2020, Peter Johnson (@delphidabbler).
+ * Copyright (C) 2001-2021, Peter Johnson (@delphidabbler).
  *
- * $Rev: 2069 $
- * $Date: 2021-09-14 16:00:48 +0100 (Tue, 14 Sep 2021) $
+ * $Rev: 2079 $
+ * $Date: 2021-11-27 14:29:47 +0000 (Sat, 27 Nov 2021) $
  *
  * This unit contains various static classes, constants, type definitions and
  * global variables for use in providing information about the host computer and
@@ -1185,9 +1185,12 @@ implementation
       https://en.wikipedia.org/wiki/Windows_Server
       https://en.wikipedia.org/wiki/Windows_Server_2019
       https://en.wikipedia.org/wiki/Windows_Server_2016
-      https://tinyurl.com/y8tfadm2
-      https://tinyurl.com/usupsz4a
+      https://tinyurl.com/y8tfadm2 (MS Windows Server release information)
+      https://tinyurl.com/usupsz4a (Win 11 Version Numbers & Build Versions)
       https://docs.microsoft.com/en-us/lifecycle/products/windows-server-2022
+      https://tinyurl.com/yj5e72jt (MS Win 10 release info)
+      https://tinyurl.com/kd3weeu7 (MS Server release info)
+
 
     Note:
       For Vista and Win 7 we have to add service pack number to these values to
@@ -1218,30 +1221,32 @@ implementation
   Win1020H1Build = 19041;       // Windows 10 20H1 - version 2004
   Win1020H2Build = 19042;       // Windows 10 20H2 - version 20H2
   Win1021H1Build = 19043;       // Windows 10 21H1 - version 21H1
-  { TODO: 2021-09-11
-          - Win 21H2 due late 2021
-          - Update following var name once Win21H2 released}
-  _Win1021H2Build = 19044;      // Windows 10 21H2 - version 21H2
+  Win1021H2Build = 19044;       // Windows 10 21H2 - version 21H2
 
   // Windows 11 ----------------------------------------------------------------
-  { TODO: 2021-09-11
-          - Add more Win11 versions as discovered. }
-  // NOTE: Preview and beta versions of Windows 11 report version 10.0
+  // NOTE: Preview and beta & release versions of Windows 11 report version 10.0
   Win11DevBuild = 21996;          // Windows 11 version Dev
                                   //   - 10.0.21996.1 (Insider version)
   Win11v21H2Build = 22000;        // Version depends on revision # [Rev#]:
-                                  //   Revision # 51..168:
+                                  //   Revision # 51,65,71,100,120,132,168:
                                   //     Windows 11 version 21H2
                                   //       - 10.0.22000.[Rev#] (Insider version)
                                   //   Revision # 184
                                   //     Windows 11 version 21H2
                                   //       - 10.0.22000.184 (Beta Version)
-                                  //   Revision # >=185
-                                  //     Windows 11 (unknown version)
-  Win11c21H2PreRel1Build = 22449; // Windows 11 version 21H2
+                                  //   Revision # 194
+                                  //     Windows 11 version 21H2
+                                  //       - ** 1st Public Release **
+  Win11v21H2PreRel1Build = 22449; // Windows 11 version 21H2
                                   //   - 10.0.22449.000 (RSPRERELEASE)
-  Win11c21H2PreRel2Build = 22454; // Windows 11 version 21H2
+  Win11v21H2PreRel2Build = 22454; // Windows 11 version 21H2
                                   //   - 10.0.22454.1000 (RSPRERELEASE)
+  Win11v21H2PreRel3Build = 22458; // Windows 11 version 21H2
+                                  //   - 10.0.22458.1000 (RSPRERELEASE)
+  Win11v21H2PreRel4Build = 22463; // Windows 11 version 21H2
+                                  //   - 10.0.22463.1000 (RSPRERELEASE)
+  Win11v21H2PreRel5Build = 22468; // Windows 11 version 21H2
+                                  //   - 10.0.22468.1000 (RSPRERELEASE)
 
   Win11FirstBuild = Win11DevBuild;  // First build number of Windows 11
 
@@ -1724,13 +1729,16 @@ procedure InitPlatformIdEx;
       begin
         case InternalMinorVersion of
           0:
+          // ** As of 2021/10/05 all releases of Windows 10 **and**
+          //    Windows 11 report major version 10 and minor version 0
           if (Win32ProductType <> VER_NT_DOMAIN_CONTROLLER)
             and (Win32ProductType <> VER_NT_SERVER) then
           begin
             if IsBuildNumber(Win10TH1Build) then
             begin
+              // First public release of Window 10
               InternalBuildNumber := Win10TH1Build;
-              InternalExtraUpdateInfo := 'Version 1507';  // 1st Win 10 version
+              InternalExtraUpdateInfo := 'Version 1507';
             end
             else if IsBuildNumber(Win10TH2Build) then
             begin
@@ -1789,25 +1797,16 @@ procedure InitPlatformIdEx;
               InternalBuildNumber := Win1021H1Build;
               InternalExtraUpdateInfo := 'Version 21H1';
             end
-            else if IsBuildNumber(_Win1021H2Build) then
+            else if IsBuildNumber(Win1021H2Build) then
             begin
-              { TODO: Added 2021/09/11
-                      - Release expected late 2021
-                      - Fix build number if necessary
-                      - Remove underscore prefix from const name
-                      - Fix value of InternalExtraUpdateInfo as required }
-              InternalBuildNumber := _Win1021H2Build;
+              // From 21H2 Windows 10 moves from a 6 monthly update cycle to a
+              // yearly cycle
+              InternalBuildNumber := Win1021H2Build;
               InternalExtraUpdateInfo := 'Version 21H2';
             end
             // As of 2021-09-11, Win 11 pre-releases are reporting v10.0
             // Details taken from: https://tinyurl.com/usupsz4a
-            // Correct according to above web oage as of 2021-09-11
-            { TODO: Added 2021-09-11
-                    - Revisit URL to check for change following official release
-                      of Windows 11
-                    - Add any further pre-release versions
-                    - Check if final release has major version 11
-            }
+            // Correct according to above web page as of 2021-09-11
             else if IsBuildNumber(Win11DevBuild) then
             begin
               InternalBuildNumber := Win11DevBuild;
@@ -1821,49 +1820,74 @@ procedure InitPlatformIdEx;
               // There are several Win 11 releases with this build number
               // Which release we're talking about depends on the revision
               // number.
+              // *** Amazingly one of them, revision 194, is the 1st public
+              //     release of Win 11 -- well hidden eh?!
               InternalBuildNumber := Win11v21H2Build;
-              if InternalRevisionNumber in [51, 65, 71, 100, 120, 132, 168] then
-              begin
-                InternalExtraUpdateInfo := Format(
-                  'Version 21H2 [Insider v10.0.%d.%d]',
-                  [InternalBuildNumber, InternalRevisionNumber]
-                );
-              end
-              else if InternalRevisionNumber = 184 then
-              begin
-                InternalExtraUpdateInfo := Format(
-                  'Version 21H2 [Beta v10.0.%d.%d]',
-                  [InternalBuildNumber, InternalRevisionNumber]
-                );
-              end
-              else
-              begin
-                InternalExtraUpdateInfo := Format(
-                  'Unknown release v10.0.%d.%d',
-                  [InternalBuildNumber, InternalRevisionNumber]
-                );
+              case InternalBuildNumber of
+                194:
+                  // First public release of Windows 11
+                  InternalExtraUpdateInfo := 'Version 21H2';
+                51, 65, 71, 100, 120, 132, 168:
+                  InternalExtraUpdateInfo := Format(
+                    'Version 21H2 [Insider v10.0.%d.%d]',
+                    [InternalBuildNumber, InternalRevisionNumber]
+                  );
+                184:
+                  InternalExtraUpdateInfo := Format(
+                    'Version 21H2 [Beta v10.0.%d.%d]',
+                    [InternalBuildNumber, InternalRevisionNumber]
+                  );
+                else
+                  InternalExtraUpdateInfo := Format(
+                    'Unknown release v10.0.%d.%d',
+                    [InternalBuildNumber, InternalRevisionNumber]
+                  );
               end;
             end
-            else if IsBuildNumber(Win11c21H2PreRel1Build) then
+            else if IsBuildNumber(Win11v21H2PreRel1Build) then
             begin
-              InternalBuildNumber := Win11c21H2PreRel1Build;
+              InternalBuildNumber := Win11v21H2PreRel1Build;
               InternalExtraUpdateInfo := Format(
                 'Version 21H2 [RSPRERELEASE v10.0.%d.%d]',
                 [InternalBuildNumber, InternalRevisionNumber]
               );
             end
-            else if IsBuildNumber(Win11c21H2PreRel2Build) then
+            else if IsBuildNumber(Win11v21H2PreRel2Build) then
             begin
-              InternalBuildNumber := Win11c21H2PreRel2Build;
+              InternalBuildNumber := Win11v21H2PreRel2Build;
               InternalExtraUpdateInfo := Format(
                 'Version 21H2 [RSPRERELEASE v10.0.%d.%d]',
                 [InternalBuildNumber, InternalRevisionNumber]
               );
-            end;
+            end
+            else if IsBuildNumber(Win11v21H2PreRel3Build) then
+            begin
+              InternalBuildNumber := Win11v21H2PreRel3Build;
+              InternalExtraUpdateInfo := Format(
+                'Version 21H2 [RSPRERELEASE v10.0.%d.%d]',
+                [InternalBuildNumber, InternalRevisionNumber]
+              );
+            end
+            else if IsBuildNumber(Win11v21H2PreRel4Build) then
+            begin
+              InternalBuildNumber := Win11v21H2PreRel4Build;
+              InternalExtraUpdateInfo := Format(
+                'Version 21H2 [RSPRERELEASE v10.0.%d.%d]',
+                [InternalBuildNumber, InternalRevisionNumber]
+              );
+            end
+            else if IsBuildNumber(Win11v21H2PreRel5Build) then
+            begin
+              InternalBuildNumber := Win11v21H2PreRel5Build;
+              InternalExtraUpdateInfo := Format(
+                'Version 21H2 [RSPRERELEASE v10.0.%d.%d]',
+                [InternalBuildNumber, InternalRevisionNumber]
+              );
+            end
           end
-          else
+          else // Win32ProductType in [VER_NT_DOMAIN_CONTROLLER, VER_NT_SERVER]
           begin
-            // Check for Win Server 2016 echnical previews.
+            // Check for Win Server 2016 technical previews.
             // We don't check for TP1 // here because that reported version 6.4,
             // not version 10!
             if IsBuildNumber(Win2016TP2Build) then
@@ -2685,7 +2709,7 @@ class function TPJOSInfo.Product: TPJOSProduct;
                 if InternalBuildNumber < Win11FirstBuild then
                   Result := osWin10
                 else
-                  // As of 2021-09-11 Win 11 is reporting version 10.0
+                  // ** As of 2021-10-05 Win 11 is reporting version 10.0!
                   Result := osWin11;
               end
               else
diff --git a/Src/Help/HTML/dlg_dependencies.htm b/Src/Help/HTML/dlg_dependencies.htm
@@ -29,12 +29,18 @@ <h1>
     <p>
       This dialogue box is displayed by choosing the <em>View |
       Dependencies</em> menu item or by pressing
-      <span class="smallcaps">Ctrl+D</span>. It has two tabs:
-      <em>Depends Upon</em> and <em>Required By</em>.
+      <span class="smallcaps">Ctrl+D</span>.
     </p>
     <h2>
-      <em>Depends Upon</em> Tab
+      Tabs
     </h2>
+    <p>
+      The dialogue box has two tabs: <em>Depends Upon</em> and <em>Required
+      By</em>.
+    </p>
+    <h3>
+      <em>Depends Upon</em> Tab
+    </h3>
     <p>
       If the selected snippet has dependencies (i.e. snippets it depends upon in
       order to compile) a tree of snippets is displayed that shows the direct
@@ -47,13 +53,27 @@ <h2>
       error message is displayed. Such a dependency indicates there is an error
       in the database.
     </p>
-    <h2>
+    <h3>
       <em>Required By</em> Tab
-    </h2>
+    </h3>
     <p>
       This tab displays a simple list of snippets that immediately depend on the
       selected snippet. Again, if there are no snippets to list, a message is
       displayed to that effect.
     </p>
+    <h2>
+      <em>Select &amp; Close</em> button
+    </h2>
+    <p>
+      This button appears to the left of the <em>Close</em> and <em>Help</em>
+      buttons. It's purpose is to select the snippets listed on the currently
+      active tab and to display that selection when the dialogue box is closed.
+      If the active tab lists no snippets then the button is disabled.
+    </p>
+    <p>
+      <strong class="warning">Warning:</strong> Any selection made using this
+      button will replace any search results that were previously displayed. No
+      warning will be displayed.
+    </p>
   </body>
 </html>
diff --git a/Src/UConsts.pas b/Src/UConsts.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) 2009-2020, Peter Johnson (gravatar.com/delphidabbler).
+ * Copyright (C) 2009-2021, Peter Johnson (gravatar.com/delphidabbler).
  *
  * Defines various character, string and resource id constants.
 }
@@ -29,8 +29,12 @@ interface
   CR          = #13;    // carriage return character
   SUB         = #26;    // ASCII SUB character
   ESC         = #27;    // escape character
+
   SINGLEQUOTE = '''';   // single quote character
   DOUBLEQUOTE = '"';    // double quote character
+  AMPERSAND   = '&';    // ampersand character
+  GT          = '>';    // greater-than / closing angle bracket character
+  LT          = '<';    // less-than / opening angle bracket character
 
   CRLF  = CR + LF;      // carriage return followed by line feed
   EOL   = CRLF;         // end of line character sequence for Windows systems
diff --git a/Src/UHTMLUtils.pas b/Src/UHTMLUtils.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-2020, Peter Johnson (gravatar.com/delphidabbler).
+ * Copyright (C) 2005-2021, Peter Johnson (gravatar.com/delphidabbler).
  *
  * Helper interfaces and classes used to generate HTML.
 }
@@ -227,18 +227,12 @@ class function THTML.Entities(const Text: string): string;
     for Ch in Text do
     begin
       case Ch of
-        '<':
-          SB.Append('&lt;');
-        '>':
-          SB.Append('&gt;');
-        '&':
-          SB.Append('&amp;');
-        DOUBLEQUOTE:
-          SB.Append('&quot;');
-        #0..#9, #11, #12, #14..#31:
-          SB.Append('&#' + IntToStr(Ord(Ch)) + ';')
-        else
-          SB.Append(Ch);
+        LT:           SB.Append('&lt;');
+        GT:           SB.Append('&gt;');
+        SINGLEQUOTE:  SB.Append('&apos;');
+        DOUBLEQUOTE:  SB.Append('&quot;');
+        AMPERSAND:    SB.Append('&amp;');
+        else          SB.Append(Ch);
       end;
     end;
     Result := SB.ToString;
diff --git a/Src/VCodeSnip.vi b/Src/VCodeSnip.vi
@@ -8,8 +8,8 @@
 
 
 [Fixed File Info]
-File Version #=4, 18, 0, 261
-Product Version #=4, 18, 0, 0
+File Version #=4, 18, 1, 262
+Product Version #=4, 18, 1, 0
 File OS=4
 File Type=1
 File Sub-Type=0
diff --git a/Src/VCodeSnipPortable.vi b/Src/VCodeSnipPortable.vi
@@ -8,8 +8,8 @@
 
 
 [Fixed File Info]
-File Version #=4, 18, 0, 261
-Product Version #=4, 18, 0, 0
+File Version #=4, 18, 1, 262
+Product Version #=4, 18, 1, 0
 File OS=4
 File Type=1
 File Sub-Type=0
