Merge branch 'feature/153-save-snippet-info-as-html' into develop

Fixes #153

Author: delphidabbler

Src/ActiveText.UHTMLRenderer.pas

@@ -65,6 +65,7 @@       TCSSStyles = class(TObject)
       fTagInfoMap: TTagInfoMap;
       fIsStartOfTextLine: Boolean;
       fLINestingDepth: Cardinal;
+      fTagGen: THTMLClass;
     const
       IndentMult = 2;
     procedure InitialiseTagInfoMap;
@@ -73,7 +74,7 @@       TCSSStyles = class(TObject)
     function MakeOpeningTag(const Elem: IActiveTextActionElem): string;
     function MakeClosingTag(const Elem: IActiveTextActionElem): string;
   public
-    constructor Create;
+    constructor Create(const ATagGenerator: THTMLClass = nil);
     destructor Destroy; override;
     function Render(ActiveText: IActiveText): string;
   end;
@@ -87,13 +88,18 @@ implementation
 
 { TActiveTextHTML }
 
-constructor TActiveTextHTML.Create;
+constructor TActiveTextHTML.Create(const ATagGenerator: THTMLClass);
 begin
   inherited Create;
   fCSSStyles := TCSSStyles.Create;
   fBuilder := TStringBuilder.Create;
   fLINestingDepth := 0;
   InitialiseTagInfoMap;
+  if not Assigned(ATagGenerator) then
+    // default behaviour before ATagGenerator parameter was added
+    fTagGen := TXHTML
+  else
+    fTagGen := ATagGenerator;
 end;
 
 destructor TActiveTextHTML.Destroy;
@@ -145,7 +151,7 @@ procedure TActiveTextHTML.InitialiseTagInfoMap;
 function TActiveTextHTML.MakeClosingTag(const Elem: IActiveTextActionElem):
   string;
 begin
-  Result := TXHTML.ClosingTag(fTagInfoMap[Elem.Kind].Name);
+  Result := fTagGen.ClosingTag(fTagInfoMap[Elem.Kind].Name);
 end;
 
 function TActiveTextHTML.MakeOpeningTag(const Elem: IActiveTextActionElem):
@@ -160,7 +166,7 @@ function TActiveTextHTML.MakeOpeningTag(const Elem: IActiveTextActionElem):
       Attrs := THTMLAttributes.Create;
     Attrs.Add('class', fCSSStyles.ElemClasses[Elem.Kind])
   end;
-  Result := TXHTML.OpeningTag(fTagInfoMap[Elem.Kind].Name, Attrs);
+  Result := fTagGen.OpeningTag(fTagInfoMap[Elem.Kind].Name, Attrs);
 end;
 
 function TActiveTextHTML.Render(ActiveText: IActiveText): string;
@@ -242,7 +248,7 @@ function TActiveTextHTML.RenderText(const TextElem: IActiveTextTextElem):
   end
   else
     Result := '';
-  Result := Result + TXHTML.Entities(TextElem.Text);
+  Result := Result + fTagGen.Entities(TextElem.Text);
 end;
 
 { TActiveTextHTML.TCSSStyles }

Src/CodeSnip.dpr

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

Src/CodeSnip.dproj

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

Src/UCSSBuilder.pas

@@ -77,7 +77,8 @@   TCSSBuilder = class(TObject)
       // Class that maps CSS selector names to selector objects
       TCSSSelectorMap = TObjectDictionary<string,TCSSSelector>;
     var
-      fSelectors: TCSSSelectorMap;  // Maps selector names to selector objects
+      fSelectors: TCSSSelectorMap;    // Maps selector names to selector objects
+      fSelectorNames: TList<string>;  // Lists selector names in order created
     function GetSelector(const Selector: string): TCSSSelector;
       {Read access method for Selectors property. Returns selector object with
       given name.
@@ -105,10 +106,13 @@   TCSSBuilder = class(TObject)
     procedure Clear;
       {Clears all selectors from style sheet and frees selector objects.
       }
+
+    ///  <summary>Generates CSS code representing the style sheet.</summary>
+    ///  <returns><c>string</c>. The required CSS.</returns>
+    ///  <remarks>The selectors are returned in the order they were created.
+    ///  </remarks>
     function AsString: string;
-      {Generates CSS code representing the style sheet.
-        @return Required CSS code.
-      }
+
     property Selectors[const Selector: string]: TCSSSelector
       read GetSelector;
       {Array of CSS selectors in style sheet, indexed by selector name}
@@ -189,26 +193,29 @@ function TCSSBuilder.AddSelector(const Selector: string): TCSSSelector;
 begin
   Result := TCSSSelector.Create(Selector);
   fSelectors.Add(Selector, Result);
+  fSelectorNames.Add(Selector);
 end;
 
 function TCSSBuilder.AsString: string;
-  {Generates CSS code representing the style sheet.
-    @return Required CSS code.
-  }
 var
+  SelectorName: string;   // name of each selector
   Selector: TCSSSelector; // reference to each selector in map
 begin
   Result := '';
-  for Selector in fSelectors.Values do
+  for SelectorName in fSelectorNames do
+  begin
+    Selector := fSelectors[SelectorName];
     if not Selector.IsEmpty then
       Result := Result + Selector.AsString;
+  end;
 end;
 
 procedure TCSSBuilder.Clear;
   {Clears all selectors from style sheet and frees selector objects.
   }
 begin
-  fSelectors.Clear; // frees selector objects in .Values[]
+  fSelectorNames.Clear;
+  fSelectors.Clear;       // frees owened selector objects in dictionary
 end;
 
 constructor TCSSBuilder.Create;
@@ -221,13 +228,15 @@ constructor TCSSBuilder.Create;
   fSelectors := TCSSSelectorMap.Create(
     [doOwnsValues], TTextEqualityComparer.Create
   );
+  fSelectorNames := TList<string>.Create;
 end;
 
 destructor TCSSBuilder.Destroy;
   {Destructor. Tears down object.
   }
 begin
-  fSelectors.Free;    // frees selector objects in fSelectors.Values[]
+  fSelectorNames.Free;
+  fSelectors.Free;    // frees owened selector objects in dictionary
   inherited;
 end;