Omit untested compilers from generated snippet info

Modified TSnippetDoc base class to filter out compilers without any test
information and to use a special no tests message where no test
compilations have been recorded.

Modified both TTextSnippetDoc & TRTFSnippetDoc to render new "no tests"
message.

Also modified TRTFSnippetDoc to widen spacing between Compiler name and
result in compile results table.

Fixes #143

Author: delphidabbler

Src/URTFSnippetDoc.pas

@@ -93,10 +93,14 @@   TRTFSnippetDoc = class(TSnippetDoc)
     ///  to document.</summary>
     procedure RenderTitledList(const Title: string; List: IStringList);
       override;
-    ///  <summary>Adds given compiler info, preceeded by given heading, to
-    ///  document.</summary>
+    ///  <summary>Output given compiler test info, preceded by given heading.
+    ///  </summary>
     procedure RenderCompilerInfo(const Heading: string;
       const Info: TCompileDocInfoArray); override;
+    ///  <summary>Output message stating that there is no compiler test info,
+    ///  preceded by given heading.</summary>
+    procedure RenderNoCompilerInfo(const Heading, NoCompileTests: string);
+      override;
     ///  <summary>Interprets and adds given extra information to document.
     ///  </summary>
     ///  <remarks>Active text formatting is observed and styled to suit
@@ -341,7 +345,8 @@ procedure TRTFSnippetDoc.RenderCompilerInfo(const Heading: string;
   TabStop: SmallInt;              // tab stop where compile result displayed
 begin
   // Calculate tab stop where compile results are displayed
-  TabStop := (MaxCompilerNameLenInTwips div IndentDelta) * IndentDelta + IndentDelta;
+  TabStop := (MaxCompilerNameLenInTwips div IndentDelta) * IndentDelta
+    + 2 * IndentDelta;
   // Display heading
   fBuilder.SetFontStyle([fsBold]);
   fBuilder.SetParaSpacing(
@@ -423,6 +428,23 @@ procedure TRTFSnippetDoc.RenderHeading(const Heading: string;
   fBuilder.EndPara;
 end;
 
+procedure TRTFSnippetDoc.RenderNoCompilerInfo(const Heading,
+  NoCompileTests: string);
+begin
+  // Display heading
+  fBuilder.SetFontStyle([fsBold]);
+  fBuilder.SetParaSpacing(
+    TRTFParaSpacing.Create(ParaSpacing, ParaSpacing / 3)
+  );
+  fBuilder.AddText(Heading);
+  fBuilder.ResetCharStyle;
+  fBuilder.EndPara;
+  fBuilder.ClearParaFormatting;
+  fBuilder.SetFontSize(ParaFontSize);
+  fBuilder.AddText(NoCompileTests);
+  fBuilder.EndPara;
+end;
+
 procedure TRTFSnippetDoc.RenderSourceCode(const SourceCode: string);
 var
   Renderer: IHiliteRenderer;  // renders highlighted source as RTF

Src/USnippetDoc.pas

@@ -39,7 +39,7 @@   TCompileDocInfo = record
 
 type
   ///  <summary>Array of textual compiler result information.</summary>
-  TCompileDocInfoArray = array of TCompileDocInfo;
+  TCompileDocInfoArray = TArray<TCompileDocInfo>;
 
 type
   ///  <summary>Abstract base class for classes that render documents that
@@ -76,10 +76,14 @@   TSnippetDoc = class(TObject)
     ///  title.</summary>
     procedure RenderTitledList(const Title: string; List: IStringList);
       virtual; abstract;
-    ///  <summary>Output given compiler info, preceeded by given heading.
+    ///  <summary>Output given compiler test info, preceded by given heading.
     ///  </summary>
     procedure RenderCompilerInfo(const Heading: string;
       const Info: TCompileDocInfoArray); virtual; abstract;
+    ///  <summary>Output message stating that there is no compiler test info,
+    ///  preceded by given heading.</summary>
+    procedure RenderNoCompilerInfo(const Heading, NoCompileTests: string);
+      virtual; abstract;
     ///  <summary>Output given extra information to document.</summary>
     ///  <remarks>Active text must be interpreted in a manner that makes sense
     ///  for document format.</remarks>
@@ -109,6 +113,7 @@ implementation
 uses
   // Delphi
   SysUtils,
+  Generics.Collections,
   // Project
   Compilers.UCompilers,
   DB.UMain,
@@ -136,17 +141,24 @@ function TSnippetDoc.CompilerInfo(const Snippet: TSnippet):
 var
   Compilers: ICompilers;  // provided info about compilers
   Compiler: ICompiler;    // each supported compiler
-  InfoIdx: Integer;       // index into output array
+  ResList: TList<TCompileDocInfo>;
 begin
   Compilers := TCompilersFactory.CreateAndLoadCompilers;
   SetLength(Result, Compilers.Count);
-  InfoIdx := 0;
-  for Compiler in Compilers do
-  begin
-    Result[InfoIdx] := TCompileDocInfo.Create(
-      Compiler.GetName, Snippet.Compatibility[Compiler.GetID]
-    );
-    Inc(InfoIdx);
+  ResList := TList<TCompileDocInfo>.Create;
+  try
+    for Compiler in Compilers do
+    begin
+      if Snippet.Compatibility[Compiler.GetID] <> crQuery then
+      ResList.Add(
+        TCompileDocInfo.Create(
+          Compiler.GetName, Snippet.Compatibility[Compiler.GetID]
+        )
+      );
+    end;
+    Result := ResList.ToArray;
+  finally
+    ResList.Free;
   end;
 end;
 
@@ -158,7 +170,10 @@ function TSnippetDoc.Generate(const Snippet: TSnippet): TEncodedData;
   sUnitListTitle = 'Required units:';
   sDependListTitle = 'Required snippets:';
   sXRefListTitle = 'See also:';
-  sCompilers = 'Supported compilers:';
+  sCompilers = 'Compiler test results:';
+  sNoCompilerTests = 'No compiler tests were carried out.';
+var
+  CompileResults: TCompileDocInfoArray;
 begin
   Assert(Assigned(Snippet), ClassName + '.Create: Snippet is nil');
   // generate document
@@ -176,7 +191,13 @@ function TSnippetDoc.Generate(const Snippet: TSnippet): TEncodedData;
   RenderTitledList(sDependListTitle, SnippetsToStrings(Snippet.Depends));
   RenderTitledList(sXRefListTitle, SnippetsToStrings(Snippet.XRef));
   if Snippet.Kind <> skFreeform then
-    RenderCompilerInfo(sCompilers, CompilerInfo(Snippet));
+  begin
+    CompileResults := CompilerInfo(Snippet);
+    if Length(CompileResults) > 0 then
+      RenderCompilerInfo(sCompilers, CompilerInfo(Snippet))
+    else
+      RenderNoCompilerInfo(sCompilers, sNoCompilerTests);
+  end;
   if Snippet.Extra.HasContent then
     RenderExtra(Snippet.Extra);
   if not Snippet.UserDefined then

Src/UTextSnippetDoc.pas

@@ -63,10 +63,14 @@   TTextSnippetDoc = class(TSnippetDoc)
     ///  to document.</summary>
     procedure RenderTitledList(const Title: string; List: IStringList);
       override;
-    ///  <summary>Adds given compiler info, preceeded by given heading, to
+    ///  <summary>Adds given compiler info, preceded by given heading, to
     ///  document.</summary>
     procedure RenderCompilerInfo(const Heading: string;
       const Info: TCompileDocInfoArray); override;
+    ///  <summary>Output message stating that there is no compiler test info,
+    ///  preceded by given heading.</summary>
+    procedure RenderNoCompilerInfo(const Heading, NoCompileTests: string);
+      override;
     ///  <summary>Interprets and adds given extra information to document.
     ///  </summary>
     ///  <remarks>Active text is converted to word-wrapped plain text
@@ -166,6 +170,15 @@ procedure TTextSnippetDoc.RenderHeading(const Heading: string;
   fWriter.WriteLine(Heading);
 end;
 
+procedure TTextSnippetDoc.RenderNoCompilerInfo(const Heading,
+  NoCompileTests: string);
+begin
+  // Write out compilers with results
+  fWriter.WriteLine;
+  fWriter.WriteLine(Heading);
+  fWriter.WriteLine(NoCompileTests);
+end;
+
 procedure TTextSnippetDoc.RenderSourceCode(const SourceCode: string);
 begin
   fWriter.WriteLine;