Merge branch 'feature/100-refactor-RTFUtils' into develop

Fixes #100

Author: delphidabbler

Src/ClassHelpers.RichEdit.pas

@@ -0,0 +1,53 @@
+{
+ * This Source Code Form is subject to the terms of the Mozilla Public License,
+ * 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) 2025, Peter Johnson (gravatar.com/delphidabbler).
+ *
+ * Class helper for TRichEdit.
+}
+
+unit ClassHelpers.RichEdit;
+
+interface
+
+uses
+  // Delphi
+  ComCtrls,
+  // Project
+  URTFUtils;
+
+type
+  TRichEditHelper = class helper for TRichEdit
+  public
+    procedure Load(const ARTFMarkup: TRTFMarkup);
+  end;
+
+implementation
+
+uses
+  // Delphi
+  SysUtils,
+  Classes;
+
+{ TRichEditHelper }
+
+procedure TRichEditHelper.Load(const ARTFMarkup: TRTFMarkup);
+var
+  Stream: TStream;
+begin
+  PlainText := False;
+  Stream := TMemoryStream.Create;
+  try
+    ARTFMarkup.ToStream(Stream);
+    Stream.Position := 0;
+    // must set MaxLength or long documents may not display
+    MaxLength := Stream.Size;
+    Lines.LoadFromStream(Stream, TEncoding.ASCII);
+  finally
+    Stream.Free;
+  end;
+end;
+
+end.

Src/CodeSnip.dpr

@@ -375,7 +375,8 @@ uses
   FmRegisterCompilersDlg in 'FmRegisterCompilersDlg.pas' {RegisterCompilersDlg},
   ClassHelpers.UGraphics in 'ClassHelpers.UGraphics.pas',
   ClassHelpers.UActions in 'ClassHelpers.UActions.pas',
-  USaveInfoMgr in 'USaveInfoMgr.pas';
+  USaveInfoMgr in 'USaveInfoMgr.pas',
+  ClassHelpers.RichEdit in 'ClassHelpers.RichEdit.pas';
 
 // Include resources
 {$Resource ExternalObj.tlb}       // Type library file

Src/CodeSnip.dproj

@@ -582,6 +582,7 @@
 			<DCCReference Include="ClassHelpers.UGraphics.pas"/>
 			<DCCReference Include="ClassHelpers.UActions.pas"/>
 			<DCCReference Include="USaveInfoMgr.pas"/>
+			<DCCReference Include="ClassHelpers.RichEdit.pas"/>
 			<None Include="CodeSnip.todo"/>
 			<BuildConfiguration Include="Base">
 				<Key>Base</Key>

Src/FrHiliterPrefs.pas

@@ -131,7 +131,7 @@   THiliterPrefsFrame = class(TPrefsBaseFrame)
     ///  <summary>Generates and returns RTF representation of currently selected
     ///  highlighter element.</summary>
     ///  <remarks>This RTF is used to display elememt in preview pane.</remarks>
-    function GenerateRTF: TRTF;
+    function GenerateRTF: TRTFMarkup;
   public
     ///  <summary>Constructs frame instance and initialises controls.</summary>
     ///  <param name="AOwner">TComponent [in] Component that owns the frame.
@@ -178,6 +178,7 @@ implementation
   // Delphi
   SysUtils, ExtCtrls, Windows, Graphics, Dialogs,
   // Project
+  ClassHelpers.RichEdit,
   FmPreferencesDlg, FmNewHiliterNameDlg, FmUserHiliterMgrDlg, Hiliter.UAttrs,
   IntfCommon, UCtrlArranger, UFontHelper, UIStringList, UMessageBox,
   URTFBuilder, URTFStyles, UUtils;
@@ -478,7 +479,7 @@ function THiliterPrefsFrame.DisplayName: string;
   Result := sDisplayName;
 end;
 
-function THiliterPrefsFrame.GenerateRTF: TRTF;
+function THiliterPrefsFrame.GenerateRTF: TRTFMarkup;
 var
   RTFBuilder: TRTFBuilder;  // object used to create and render RTFBuilder
   EgLines: IStringList;     // list of lines in the example
@@ -614,7 +615,7 @@ procedure THiliterPrefsFrame.UpdatePopupMenu;
 
 procedure THiliterPrefsFrame.UpdatePreview;
 begin
-  TRichEditHelper.Load(frmExample.RichEdit, GenerateRTF);
+  frmExample.RichEdit.Load(GenerateRTF);
 end;
 
 initialization

Src/FrPrintingPrefs.pas

@@ -101,9 +101,10 @@ implementation
   // Delphi
   SysUtils, Windows, Graphics, Math, ComCtrls,
   // Project
+  ClassHelpers.RichEdit,
   FmPreferencesDlg, Hiliter.UAttrs, Hiliter.UHiliters, IntfCommon, UColours,
   UConsts, UEncodings, UFontHelper, UKeysHelper, UPrintInfo, URTFBuilder,
-  URTFStyles, URTFUtils, UStrUtils, UUtils;
+  URTFStyles, UStrUtils, UUtils;
 
 
 {$R *.dfm}
@@ -379,7 +380,7 @@ procedure TPrintingPrefsPreview.Generate(const UseColor, SyntaxPrint: Boolean);
     HiliteSource(UseColor, SyntaxPrint, Builder);
     Builder.EndPara;
     // Load document into rich edit
-    TRichEditHelper.Load(fRe, Builder.Render);
+    fRe.Load(Builder.Render);
   finally
     FreeAndNil(Builder);
   end;

Src/FrRTFPreview.pas

@@ -59,6 +59,7 @@ implementation
 
 uses
   // Project
+  ClassHelpers.RichEdit,
   URTFUtils;
 
 
@@ -80,7 +81,7 @@ procedure TRTFPreviewFrame.LoadContent(const DocContent: TEncodedData);
     @param DocContent [in] Valid RTF document to be displayed.
   }
 begin
-  TRichEditHelper.Load(reView, TRTF.Create(DocContent));
+  reView.Load(TRTFMarkup.Create(DocContent));
 end;
 
 procedure TRTFPreviewFrame.SetPopupMenu(const Menu: TPopupMenu);

Src/FrSourcePrefs.pas

@@ -112,6 +112,7 @@ implementation
   // Delphi
   SysUtils, Math,
   // Project
+  ClassHelpers.RichEdit,
   FmPreferencesDlg, Hiliter.UAttrs, Hiliter.UFileHiliter, Hiliter.UHiliters,
   IntfCommon, UConsts, UCtrlArranger, URTFUtils;
 
@@ -159,7 +160,7 @@   TSourcePrefsPreview = class(TObject)
         @param HiliteAttrs [in] Attributes of highlighter used to render
           preview.
       }
-    function Generate: TRTF;
+    function Generate: TRTFMarkup;
       {Generate RTF code used to render preview.
         @return Required RTF code.
       }
@@ -358,8 +359,7 @@ procedure TSourcePrefsFrame.UpdatePreview;
   // Generate and display preview with required comment style
   Preview := TSourcePrefsPreview.Create(GetCommentStyle, fHiliteAttrs);
   try
-    // Display preview
-    TRichEditHelper.Load(frmPreview.RichEdit, Preview.Generate);
+    frmPreview.RichEdit.Load(Preview.Generate);
   finally
     Preview.Free;
   end;
@@ -400,12 +400,14 @@ constructor TSourcePrefsPreview.Create(const CommentStyle: TCommentStyle;
   fHiliteAttrs := HiliteAttrs;
 end;
 
-function TSourcePrefsPreview.Generate: TRTF;
+function TSourcePrefsPreview.Generate: TRTFMarkup;
   {Generate RTF code used to render preview.
     @return Required RTF code.
   }
 begin
-  Result := TRTF.Create(TRTFDocumentHiliter.Hilite(SourceCode, fHiliteAttrs));
+  Result := TRTFMarkup.Create(
+    TRTFDocumentHiliter.Hilite(SourceCode, fHiliteAttrs)
+  );
 end;
 
 function TSourcePrefsPreview.SourceCode: string;

Src/UCopyViewMgr.pas

@@ -66,20 +66,20 @@ class procedure TCopyViewMgr.Execute(View: IView);
 var
   Clip: TClipboardHelper;     // object used to update clipboard
   UnicodeText: UnicodeString; // Unicode plain text representation of view
-  RTF: TRTF;                  // rich text representation of view
+  RTFMarkup: TRTFMarkup;      // rich text representation of view
 begin
   Assert(Assigned(View), ClassName + '.Execute: View is nil');
   Assert(CanHandleView(View), ClassName + '.Execute: View not supported');
   // Generate plain text and rich text representation of view
   UnicodeText := GeneratePlainText(View).ToString;
-  RTF := TRTF.Create(GenerateRichText(View));
+  RTFMarkup := TRTFMarkup.Create(GenerateRichText(View));
   // Open clipboard and add both plain and rich text representations of snippet
   Clip := TClipboardHelper.Create;
   try
     Clip.Open;
     try
       Clip.AddUnicodeText(UnicodeText);
-      Clip.AddRTF(RTF.ToRTFCode);
+      Clip.AddRTF(RTFMarkup.ToRTFCode);
     finally
       Clip.Close;
     end;

Src/UPrintDocuments.pas

@@ -31,7 +31,7 @@ interface
   IPrintDocument = interface(IInterface)
     ['{56E4CA97-7F04-427A-A95F-03CE55910DC0}']
     ///  <summary>Generates and returns print document.</summary>
-    function Generate: TRTF;
+    function Generate: TRTFMarkup;
   end;
 
 type
@@ -53,7 +53,7 @@   TSnippetPrintDocument = class(TInterfacedObject,
     constructor Create(const Snippet: TSnippet);
     ///  <summary>Generates and returns print document.</summary>
     ///  <remarks>Method of IPrintDocument.</remarks>
-    function Generate: TRTF;
+    function Generate: TRTFMarkup;
   end;
 
 type
@@ -72,7 +72,7 @@   TCategoryPrintDocument = class(TInterfacedObject,
     constructor Create(const Category: TCategory);
     ///  <summary>Generates and returns print document.</summary>
     ///  <remarks>Method of IPrintDocument.</remarks>
-    function Generate: TRTF;
+    function Generate: TRTFMarkup;
   end;
 
 implementation
@@ -91,15 +91,15 @@ constructor TSnippetPrintDocument.Create(const Snippet: TSnippet);
   fSnippet := Snippet;
 end;
 
-function TSnippetPrintDocument.Generate: TRTF;
+function TSnippetPrintDocument.Generate: TRTFMarkup;
 var
   Doc: TRTFSnippetDoc;  // object that renders snippet document in RTF
 begin
   Doc := TRTFSnippetDoc.Create(
     GetHiliteAttrs, poUseColor in PrintInfo.PrintOptions
   );
   try
-    Result := TRTF.Create(Doc.Generate(fSnippet));
+    Result := TRTFMarkup.Create(Doc.Generate(fSnippet));
   finally
     Doc.Free;
   end;
@@ -127,13 +127,13 @@ constructor TCategoryPrintDocument.Create(const Category: TCategory);
   fCategory := Category;
 end;
 
-function TCategoryPrintDocument.Generate: TRTF;
+function TCategoryPrintDocument.Generate: TRTFMarkup;
 var
   Doc: TRTFCategoryDoc; // object that renders category document in RTF
 begin
   Doc := TRTFCategoryDoc.Create(poUseColor in PrintInfo.PrintOptions);
   try
-    Result := TRTF.Create(Doc.Generate(fCategory));
+    Result := TRTFMarkup.Create(Doc.Generate(fCategory));
   finally
     Doc.Free;
   end;

Src/UPrintEngine.pas

@@ -48,7 +48,7 @@   TPrintEngine = class(THiddenRichEdit)
     function GetPrintMargins: TPrintMargins;
   public
     ///  <summary>Prints given RTF document.</summary>
-    procedure Print(const Document: TRTF);
+    procedure Print(const Document: TRTFMarkup);
     ///  <summary>Title of document that appears in print spooler.</summary>
     ///  <remarks>A default title is used if Title is not set or is set to
     ///  empty string.</remarks>
@@ -63,6 +63,7 @@ implementation
   // Delphi
   Printers,
   // Project
+  ClassHelpers.RichEdit,
   UMeasurement, UPrintInfo;
 
 
@@ -94,15 +95,15 @@ function TPrintEngine.GetPrintMargins: TPrintMargins;
   Result.Bottom := InchesToPixelsY(MMToInches(PrintInfo.PageMargins.Bottom));
 end;
 
-procedure TPrintEngine.Print(const Document: TRTF);
+procedure TPrintEngine.Print(const Document: TRTFMarkup);
 var
   PrintMargins: TPrintMargins;  // page margins
   DocTitle: string;             // document title for print spooler
 resourcestring
   sDefTitle = 'CodeSnip document';  // default document title
 begin
   // Load document into engine
-  TRichEditHelper.Load(RichEdit, Document);
+  RichEdit.Load(Document);
   // Set up page margins
   PrintMargins := GetPrintMargins;
   RichEdit.PageRect := Rect(

Src/UPrintMgr.pas

@@ -85,7 +85,7 @@ class function TPrintMgr.CanPrint(ViewItem: IView): Boolean;
 procedure TPrintMgr.DoPrint;
 var
   PrintEngine: TPrintEngine;  // object that prints the print document
-  Document: TRTF;             // generated print document
+  Document: TRTFMarkup;       // generated print document
 begin
   PrintEngine := TPrintEngine.Create;
   try