Rename TRTF as TRTFMarkup

Also renamed some related variables etc.

Updated all affected code.

Author: delphidabbler

Src/ClassHelpers.RichEdit.pas

@@ -21,7 +21,7 @@ interface
 type
   TRichEditHelper = class helper for TRichEdit
   public
-    procedure Load(const ARTF: TRTF);
+    procedure Load(const ARTFMarkup: TRTFMarkup);
   end;
 
 implementation
@@ -33,14 +33,14 @@ implementation
 
 { TRichEditHelper }
 
-procedure TRichEditHelper.Load(const ARTF: TRTF);
+procedure TRichEditHelper.Load(const ARTFMarkup: TRTFMarkup);
 var
   Stream: TStream;
 begin
   PlainText := False;
   Stream := TMemoryStream.Create;
   try
-    ARTF.ToStream(Stream);
+    ARTFMarkup.ToStream(Stream);
     Stream.Position := 0;
     // must set MaxLength or long documents may not display
     MaxLength := Stream.Size;

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.
@@ -479,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

Src/FrRTFPreview.pas

@@ -81,7 +81,7 @@ procedure TRTFPreviewFrame.LoadContent(const DocContent: TEncodedData);
     @param DocContent [in] Valid RTF document to be displayed.
   }
 begin
-  reView.Load(TRTF.Create(DocContent));
+  reView.Load(TRTFMarkup.Create(DocContent));
 end;
 
 procedure TRTFPreviewFrame.SetPopupMenu(const Menu: TPopupMenu);

Src/FrSourcePrefs.pas

@@ -160,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.
       }
@@ -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>
@@ -95,7 +95,7 @@ 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

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

Src/URTFBuilder.pas

@@ -189,7 +189,7 @@   TRTFBuilder = class(TObject)
     ///  according to given RTF style.</summary>
     procedure ApplyStyle(const Style: TRTFStyle);
     ///  <summary>Generates RTF code for whole document.</summary>
-    function Render: TRTF;
+    function Render: TRTFMarkup;
     ///  <summary>Table of colours used in document.</summary>
     property ColourTable: TRTFColourTable
       read fColourTable write fColourTable;
@@ -320,9 +320,9 @@ procedure TRTFBuilder.EndPara;
   fInControls := False;
 end;
 
-function TRTFBuilder.Render: TRTF;
+function TRTFBuilder.Render: TRTFMarkup;
 begin
-  Result := TRTF.Create(AsString);
+  Result := TRTFMarkup.Create(AsString);
 end;
 
 procedure TRTFBuilder.ResetCharStyle;

Src/URTFUtils.pas

@@ -75,7 +75,7 @@ interface
 type
   ///  <summary>Encapsulate rich text markup code.</summary>
   ///  <remarks>Valid rich text markup contains only ASCII characters.</remarks>
-  TRTF = record
+  TRTFMarkup = record
   strict private
     var
       ///  <summary>Byte array that stores RTF code as bytes</summary>
@@ -127,8 +127,8 @@   TRTF = record
   end;
 
 type
-  ///  <summary>Class of exception raised by TRTF</summary>
-  ERTF = class(Exception);
+  ///  <summary>Class of exception raised by TRTFMarkup</summary>
+  ERTFMarkup = class(Exception);
 
 ///  <summary>Returns a parameterless RTF control word of given kind.</summary>
 function RTFControl(const Ctrl: TRTFControl): ASCIIString; overload;
@@ -277,9 +277,9 @@ function RTFUnicodeSafeDestination(const DestCtrl: TRTFControl;
   end;
 end;
 
-{ TRTF }
+{ TRTFMarkup }
 
-constructor TRTF.Create(const AStream: TStream; const ReadAll: Boolean);
+constructor TRTFMarkup.Create(const AStream: TStream; const ReadAll: Boolean);
 var
   ByteCount: Integer;
 begin
@@ -290,12 +290,12 @@ constructor TRTF.Create(const AStream: TStream; const ReadAll: Boolean);
   AStream.ReadBuffer(Pointer(fData)^, ByteCount);
 end;
 
-constructor TRTF.Create(const ABytes: TBytes);
+constructor TRTFMarkup.Create(const ABytes: TBytes);
 begin
   fData := Copy(ABytes);
 end;
 
-constructor TRTF.Create(const AData: TEncodedData);
+constructor TRTFMarkup.Create(const AData: TEncodedData);
 resourcestring
   sErrorMsg = 'Encoded data must contain only valid ASCII characters';
 var
@@ -307,41 +307,41 @@ constructor TRTF.Create(const AData: TEncodedData);
   begin
     DataStr := AData.ToString;
     if not IsValidRTFCode(DataStr) then
-      raise ERTF.Create(sErrorMsg);
+      raise ERTFMarkup.Create(sErrorMsg);
     fData := TEncoding.ASCII.GetBytes(DataStr);
   end;
 end;
 
-constructor TRTF.Create(const ARTFCode: ASCIIString);
+constructor TRTFMarkup.Create(const ARTFCode: ASCIIString);
 begin
   fData := BytesOf(ARTFCode);
 end;
 
-constructor TRTF.Create(const AStr: UnicodeString);
+constructor TRTFMarkup.Create(const AStr: UnicodeString);
 resourcestring
   sErrorMsg = 'String "%s" must contain only valid ASCII characters';
 begin
   if not IsValidRTFCode(AStr) then
-    raise ERTF.CreateFmt(sErrorMsg, [AStr]);
+    raise ERTFMarkup.CreateFmt(sErrorMsg, [AStr]);
   fData := TEncoding.ASCII.GetBytes(AStr);
 end;
 
-function TRTF.IsValidRTFCode(const AStr: UnicodeString): Boolean;
+function TRTFMarkup.IsValidRTFCode(const AStr: UnicodeString): Boolean;
 begin
   Result := EncodingSupportsString(AStr, TEncoding.ASCII);
 end;
 
-function TRTF.ToBytes: TBytes;
+function TRTFMarkup.ToBytes: TBytes;
 begin
   Result := Copy(fData);
 end;
 
-function TRTF.ToRTFCode: ASCIIString;
+function TRTFMarkup.ToRTFCode: ASCIIString;
 begin
   Result := BytesToASCIIString(fData);
 end;
 
-procedure TRTF.ToStream(const Stream: TStream; const Overwrite: Boolean);
+procedure TRTFMarkup.ToStream(const Stream: TStream; const Overwrite: Boolean);
 begin
   if Overwrite then
   begin
@@ -351,7 +351,7 @@ procedure TRTF.ToStream(const Stream: TStream; const Overwrite: Boolean);
   Stream.WriteBuffer(Pointer(fData)^, Length(fData));
 end;
 
-function TRTF.ToString: UnicodeString;
+function TRTFMarkup.ToString: UnicodeString;
 begin
   Result := TEncoding.ASCII.GetString(fData);
 end;