Merge tag 'version-4.21.0' into develop

delphidabbler · delphidabbler · commit 4acb8c8ac3be · 2022-12-16T16:53:57.000Z
CodeSnip release v4.21.0
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -10,6 +10,26 @@ 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.21.0 of 16 December 2022
+
+* Updated to support [REML version 5](https://htmlpreview.github.io/?https://github.com/delphidabbler/codesnip/blob/version-4.21.0`/Docs/Design/reml.html) in snippet description & extra information [issue #71]:
+  * Numerous new character entities supported. 
+  * New list tags: `<ol>`, `<ul>` & `<li>`.
+* Program now automatically detects new (supported) Delphi installations at startup and offers to register the compiler(s) to be used for test compiling snippets. This feature is on by default but can be turned off completely or for specifically excluded compilers [issue #19].
+* Modified Configure Compilers dialogue box:
+  * Added facility to customise automatic compiler detection on per-compiler or global basis.
+  * Changed manually triggered compiler detection to ignore excluded compilers.
+* Some refactoring [including issues #73 and #75].
+* Minor changes to program license
+  * Changed required image attribution in `Docs/License.html` [issue #63]
+  * Corrected copyright date & fix typo in licenses displayed by installer and help file [issue #65 & PR #72].
+* Bump per-user config file to version 19.
+* Documentation updates:
+  * Updated `README.md` re abandoned and new Git repo branches.
+  * Updated config file, database, export file & REML documentation re changes in this release [including issue #74].
+  * Help file updated with details of changes in this release.
+  * Updated development tool chain requirements in `Build.html`. 
+
 ## Release v4.20.2 of 04 November 2022
 
 * Fixes bug where an exception was raised when selecting a main menu item with the cursor keys then pressing F1. [issue 54]
diff --git a/Docs/Design/FileFormats/config.html b/Docs/Design/FileFormats/config.html
@@ -167,7 +167,7 @@ <h3>
 </p>
 
 <p>
-  There have been several versions of this file. The current one is version 18 &laquo;&laquo;TODO&raquo;&raquo;. The change to version 18 came with CodeSnip v4.20.0&laquo;&laquo;TODO&raquo;&raquo; and the addition of the [Prefs] section.
+  There have been several versions of this file. The current one is version 19. The change to version 19 came with CodeSnip v4.21.0 and the addition of the [Compilers] section and the <code class="key">CanAutoInstall</code> key in the [Cmp:XXX] sections.
 </p>
 
 <p>
@@ -762,7 +762,7 @@ <h4>
       The version number of the config file. Incremented whenever the file format changes. If this section or this value is missing then the default value is <code class="value">1</code>.
     </div>
     <div class="half-spaced">
-      The current value is <code class="value">16</code>.
+      The current value is <code class="value">19</code>.
     </div>
   </dd>
   <dt>
diff --git a/Docs/Design/FileFormats/export.html b/Docs/Design/FileFormats/export.html
@@ -175,7 +175,7 @@ <h2>
         <em>version</em>
       </dt>
       <dd>
-        Identifies version of file. Determines which tags are valid and
+        Identifies major version of file. Determines which tags are valid and
         establishes rules concerning content. Valid versions are 1 to 7.
       </dd>
     </dl>
@@ -979,10 +979,10 @@ <h2>
         Updated with CodeSnip v4.18.0 to add support for Delphi 11.x Alexandria.
       </dd>
       <dt>
-        <em>Version 7.3 - &laquo;&laquo;TODO&raquo;&raquo;</em>
+        <em>Version 7.3 - 16 December 2022</em>
       </dt>
       <dd>
-        Updated with CodeSnip v&laquo;&laquo;TODO&raquo;&raquo; to add support for REML v5, which is backward compatible with REML v4.
+        Updated with CodeSnip v4.21.0 to add support for REML v5, which is backward compatible with REML v4.
       </dd>
     </dl>
   </dd>
diff --git a/Docs/Design/FileFormats/user-db.html b/Docs/Design/FileFormats/user-db.html
@@ -199,7 +199,7 @@ <h3 id="xml-file">
         <em>version</em>
       </dt>
       <dd>
-        Identifies version of file. Determines which tags are valid and rules
+        Identifies major version of file. Determines which tags are valid and rules
         concerning content. Valid versions are 1..6.
       </dd>
     </dl>
@@ -1015,10 +1015,10 @@ <h2>
         Updated with CodeSnip v4.18.0 to add support for Delphi 11.x Alexandria.
       </dd>
       <dt>
-        <em>Version 6.11 - &laquo;&laquo;TODO&raquo;&raquo;</em>
+        <em>Version 6.11 - 16 December 2022</em>
       </dt>
       <dd>
-        Updated with CodeSnip v&laquo;&laquo;TODO&raquo;&raquo; to add support for REML v5, which is backwards compatible with REML v4.
+        Updated with CodeSnip v4.21.0 to add support for REML v5, which is backwards compatible with REML v4.
       </dd>
     </dl>
   </dd>
diff --git a/Docs/Design/reml.html b/Docs/Design/reml.html
@@ -625,11 +625,11 @@ <h1>Change Log</h1>
   </ul>
 
   <p>
-    <strong>v5 of &laquo;&laquo;TODO&raquo;&raquo;</strong>
+    <strong>v5 of 2022-12-16</strong>
   </p>
 
   <p>
-    Introduced in CodeSnip &laquo;&laquo;TODO&raquo;&raquo;
+    Introduced in CodeSnip v4.21.0
   </p>
 
   <ul>
diff --git a/Src/FirstRun.UConfigFile.pas b/Src/FirstRun.UConfigFile.pas
@@ -82,7 +82,7 @@   TUserConfigFileUpdater = class(TConfigFileUpdater)
   strict private
     const
       ///  <summary>Current user config file version.</summary>
-      FileVersion = 18;
+      FileVersion = 19;
   strict protected
     ///  <summary>Returns current user config file version.</summary>
     class function GetFileVersion: Integer; override;
diff --git a/Src/FmMain.pas b/Src/FmMain.pas
@@ -1219,7 +1219,8 @@ procedure TMainForm.AfterShowForm;
   fMainDisplayMgr.Initialise(fWindowSettings.OverviewTab);
   fMainDisplayMgr.ShowWelcomePage;
   // check for registerable Delphi compiler installations
-  fCompileMgr.CheckForNewCompilerInstalls;
+  if fCompileMgr.CheckForNewCompilerInstalls then
+    fMainDisplayMgr.Refresh;
 end;
 
 function TMainForm.appEventsHelp(Command: Word; Data: Integer;
diff --git a/Src/UCompileMgr.pas b/Src/UCompileMgr.pas
@@ -116,12 +116,14 @@   TMainCompileMgr = class(TCompileMgr)
     ///  <summary>Check for new compiler installations, get user permission to
     ///  install any that are found and register any compilers that user
     ///  selects.</summary>
+    ///  <returns>Boolean. True if any compilers were registered, False if not.
+    ///  </returns>
     ///  <remarks>
     ///  <para>Does nothing if compiler detection is disabled or if there are
     ///  no installed but unregistered compilers.</para>
     ///  <para>Should be called at program startup.</para>
     ///  </remarks>
-    procedure CheckForNewCompilerInstalls;
+    function CheckForNewCompilerInstalls: Boolean;
   end;
 
 
@@ -264,7 +266,7 @@ function TMainCompileMgr.CanCompile(View: IView): Boolean;
     and SnippetView.Snippet.CanCompile;
 end;
 
-procedure TMainCompileMgr.CheckForNewCompilerInstalls;
+function TMainCompileMgr.CheckForNewCompilerInstalls: Boolean;
 var
   CandidateCompilers: TCompilerList;  // compilers available for registration
   SelectedCompilers: TCompilerList;   // compilers chosen for registration
@@ -290,7 +292,7 @@ procedure TMainCompileMgr.CheckForNewCompilerInstalls;
       if (SelectedCompilers.IndexOf(Compiler) >= 0)
         and Compiler.IsAvailable then
       begin
-        CompList := CompList + '� ' + Compiler.GetName + EOL;
+        CompList := CompList + #$2022' ' + Compiler.GetName + EOL;
         Inc(RegCount);
       end;
     end;
@@ -313,6 +315,7 @@ procedure TMainCompileMgr.CheckForNewCompilerInstalls;
   end;
 
 begin
+  Result := False;
   if not TCompilerSettings.PermitStartupDetection then
     Exit;
   SelectedCompilers := nil;
@@ -345,6 +348,7 @@ procedure TMainCompileMgr.CheckForNewCompilerInstalls;
         Persister.Save(Compilers);
         // tell user what got registered
         NotifyResults;
+        Result := True;
       end
       else
         // User didn't select a file: tell them
@@ -381,4 +385,3 @@ function TMainCompileMgr.IsLastCompiledView(View: IView): Boolean;
 end;
 
 end.
-
diff --git a/Src/UREMLDataIO.pas b/Src/UREMLDataIO.pas
@@ -598,6 +598,7 @@ function TREMLWriter.RenderTag(
       begin
         Dec(fLevel);
         Result := EOL + StrOfSpaces(IndentMult * fLevel) + Result + EOL;
+        fIsStartOfTextLine := True;
       end;
     end;
     fsOpen:
@@ -620,6 +621,14 @@ function TREMLWriter.RenderTag(
         Result := EOL + StrOfSpaces(IndentMult * fLevel) + Result + EOL;
         Inc(fLevel);
         fIsStartOfTextLine := True;
+      end
+      else if TActiveTextElemCaps.DisplayStyleOf(TagElem.Kind) = dsInline then
+      begin
+        if fIsStartOfTextLine then
+        begin
+          Result := StrOfSpaces(IndentMult * fLevel) + Result;
+          fIsStartOfTextLine := False;
+        end;
       end;
     end;
   end;
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.22.2
-build=266
+version=4.21.0
+build=267
 
 # String file information
 copyright=Copyright © P.D.Johnson, 2005-<YEAR>.
