Merge branch 'feature/101-text+rtf+snippet-doc-format-bug' into develop

Fixes #101

Author: delphidabbler

Src/UGraphicUtils.pas

@@ -17,10 +17,7 @@ interface
 
 uses
   // Delphi
-  Windows, Graphics,
-  // Project
-  UStructs;
-
+  Windows, Graphics;
 
 function CreateDisplayDC: HDC;
   {Creates a display device context.
@@ -45,6 +42,28 @@ function StringExtent(const S: string; const Font: TFont): TSize; overload;
     @return Structure containing width and height of string in pixels.
   }
 
+///  <summary>Returns width, in pixels, of the widest of the given strings when
+///  rendered a specified font.</summary>
+///  <param name="AStrings"><c>array of string</c> [in] Strings whose rendered
+///  width is to be measured.</param>
+///  <param name="AFont"><c>TFont</c> [in] Font in which strings are to be
+///  rendered.</param>
+///  <returns><c>SmallInt</c>. Width of widest string in array in pixels.
+///  </returns>
+function MaxStringWidthPx(const AStrings: array of string; const AFont: TFont):
+  SmallInt;
+
+///  <summary>Returns width, in twips, of the widest of the given strings when
+///  rendered a specified font.</summary>
+///  <param name="AStrings"><c>array of string</c> [in] Strings whose rendered
+///  width is to be measured.</param>
+///  <param name="AFont"><c>TFont</c> [in] Font in which strings are to be
+///  rendered.</param>
+///  <returns><c>SmallInt</c>. Width of widest string in array in twips.
+///  </returns>
+function MaxStringWidthTwips(const AStrings: array of string;
+  const AFont: TFont): SmallInt;
+
 function GetTextRect(const Text: string; const Canvas: TCanvas;
   const Rect: TRect; const Flags: Longint): TRect;
   {Gets rectangle of size required to display text in a specified canvas.
@@ -59,8 +78,10 @@ implementation
 
 
 uses
+  // Delphi
+  SysUtils,
   // Project
-  SysUtils;
+  UStructs;
 
 
 { Helper routines }
@@ -91,6 +112,43 @@ procedure FreeDisplayCanvas(var Canvas: TCanvas);
     end;
 end;
 
+///  <summary>Returns width of the widest of the given strings when rendered a
+///  specified font.</summary>
+///  <remarks>Width is calculated in pixels, but is converted to returned value
+///  by closure passed as a parameter.</remarks>
+///  <param name="AStrings"><c>array of string</c> [in] Strings whose rendered
+///  width is to be measured.</param>
+///  <param name="AFont"><c>TFont</c> [in] Font in which strings are to be
+///  rendered.</param>
+///  <param name="AConverter"><c>TFunc&lt;HDC, Integer, SmallInt&gt;</c> [in]
+///  Converter function used to convert result to required units, using the
+///  handle of the font canvas.</param>
+///  <returns><c>SmallInt</c>. Width of widest string in array in twips.
+///  </returns>
+function InternalMaxStringWidth(const AStrings: array of string;
+  const AFont: TFont; const AConverter: TFunc<HDC, Integer, SmallInt>):
+  SmallInt;
+var
+  Str: string;
+  StrWidth: Integer;
+  MaxStrWidth: Integer;
+  Canvas: TCanvas; // canvas used to measure text extent
+begin
+  MaxStrWidth := 0;
+  Canvas := CreateDisplayCanvas(AFont);
+  try
+    for Str in AStrings do
+    begin
+      StrWidth := Canvas.TextExtent(Str).cx;
+      if StrWidth > MaxStrWidth then
+        MaxStrWidth := StrWidth;
+    end;
+    Result := AConverter(Canvas.Handle, MaxStrWidth);
+  finally
+    FreeDisplayCanvas(Canvas);
+  end;
+end;
+
 { Public routines }
 
 function CreateDisplayDC: HDC;
@@ -144,6 +202,39 @@ function StringExtent(const S: string; const Font: TFont): TSize; overload;
   end;
 end;
 
+function MaxStringWidthTwips(const AStrings: array of string;
+  const AFont: TFont): SmallInt;
+begin
+  Result := InternalMaxStringWidth(
+    AStrings,
+    AFont,
+    function (CanvasHandle: HDC; MaxStrWidthPx: Integer): SmallInt
+    var
+      PxPerInchX: Integer;
+    const
+      TwipsPerInch = 1440;
+    begin
+      // convert pixels to twips
+      PxPerInchX := GetDeviceCaps(CanvasHandle, LOGPIXELSX);
+      Result := SmallInt(Round(MaxStrWidthPx * TwipsPerInch / PxPerInchX));
+    end
+  );
+end;
+
+function MaxStringWidthPx(const AStrings: array of string; const AFont: TFont):
+  SmallInt;
+begin
+  Result := InternalMaxStringWidth(
+    AStrings,
+    AFont,
+    function (CanvasHandle: HDC; StrWidthPx: Integer): SmallInt
+    begin
+      // no conversion
+      Result := SmallInt(StrWidthPx);
+    end
+  );
+end;
+
 function GetTextRect(const Text: string; const Canvas: TCanvas;
   const Rect: TRect; const Flags: Longint): TRect;
   {Gets rectangle of size required to display text in a specified canvas.

Src/URTFSnippetDoc.pas

@@ -17,11 +17,9 @@ interface
 
 
 uses
-  // Delphi
-  Graphics,
   // Project
   ActiveText.UMain, ActiveText.URTFRenderer, Hiliter.UGlobals, UEncodings,
-  UIStringList, USnippetDoc, URTFBuilder, URTFStyles, URTFUtils;
+  UIStringList, USnippetDoc, URTFBuilder, URTFStyles;
 
 
 type
@@ -128,9 +126,9 @@ implementation
 
 uses
   // Delphi
-  SysUtils,
+  Graphics,
   // Project
-  Hiliter.UHiliters, UColours, UConsts, UPreferences, UStrUtils;
+  Hiliter.UHiliters, UColours, UConsts, UGraphicUtils, UPreferences;
 
 
 { TRTFSnippetDoc }
@@ -316,9 +314,35 @@ procedure TRTFSnippetDoc.InitStyles;
 
 procedure TRTFSnippetDoc.RenderCompilerInfo(const Heading: string;
   const Info: TCompileDocInfoArray);
+
+  // Calculate length of longest compiler name, in twips, when rendered on font
+  // to be used to display them
+  function MaxCompilerNameLenInTwips: SmallInt;
+  var
+    CompilerInfo: TCompileDocInfo;  // info about each compiler
+    CompilerNames: IStringList;     // list of all compiler names
+    Font: TFont;                    // font in which compile info displayed
+  begin
+    Font := TFont.Create;
+    try
+      Font.Name := MainFontName;
+      Font.Size := ParaFontSize;
+      CompilerNames := TIStringList.Create;
+      for CompilerInfo in Info do
+        CompilerNames.Add(CompilerInfo.Compiler);
+      Result := MaxStringWidthTwips(CompilerNames.ToArray, Font);
+    finally
+      Font.Free;
+    end;
+  end;
+
 var
-  Idx: Integer; // loops compiler information table
+  CompilerInfo: TCompileDocInfo;  // info about each compiler
+  TabStop: SmallInt;              // tab stop where compile result displayed
 begin
+  // Calculate tab stop where compile results are displayed
+  TabStop := (MaxCompilerNameLenInTwips div IndentDelta) * IndentDelta + IndentDelta;
+  // Display heading
   fBuilder.SetFontStyle([fsBold]);
   fBuilder.SetParaSpacing(
     TRTFParaSpacing.Create(ParaSpacing, ParaSpacing / 3)
@@ -328,13 +352,15 @@ procedure TRTFSnippetDoc.RenderCompilerInfo(const Heading: string;
   fBuilder.EndPara;
   fBuilder.ClearParaFormatting;
   fBuilder.SetFontSize(ParaFontSize);
-  for Idx := Low(Info) to High(Info) do
+  // Display compiler table
+  fBuilder.SetTabStops([TabStop]);
+  for CompilerInfo in Info do
   begin
-    fBuilder.AddText(Info[Idx].Compiler);
+    fBuilder.AddText(CompilerInfo.Compiler);
     fBuilder.AddText(TAB);
     fBuilder.BeginGroup;
     fBuilder.SetFontStyle([fsItalic]);
-    fBuilder.AddText(Info[Idx].Result);
+    fBuilder.AddText(CompilerInfo.Result);
     fBuilder.EndGroup;
     fBuilder.EndPara;
   end;

Src/UTextSnippetDoc.pas

@@ -123,12 +123,21 @@ procedure TTextSnippetDoc.RenderActiveText(ActiveText: IActiveText);
 procedure TTextSnippetDoc.RenderCompilerInfo(const Heading: string;
   const Info: TCompileDocInfoArray);
 var
-  Idx: Integer; // loops compiler information table
+  MaxNameLength: Integer;
+  CompilerInfo: TCompileDocInfo;
 begin
+  // Calculate length of longest compiler name
+  MaxNameLength := 0;
+  for CompilerInfo in Info do
+    if Length(CompilerInfo.Compiler) > MaxNameLength then
+      MaxNameLength := Length(CompilerInfo.Compiler);
+  // Write out compilers with results
   fWriter.WriteLine;
   fWriter.WriteLine(Heading);
-  for Idx := Low(Info) to High(Info) do
-    fWriter.WriteLine('%-20s%s', [Info[Idx].Compiler, Info[Idx].Result]);
+  for CompilerInfo in Info do
+    fWriter.WriteLine(
+      '%-*s%s', [MaxNameLength + 4, CompilerInfo.Compiler, CompilerInfo.Result]
+    );
 end;
 
 procedure TTextSnippetDoc.RenderDBInfo(const Text: string);