Merge branch 'feature/87-add-html5-save-snippet+unit-option' into develop

Fixes #87

Author: delphidabbler

Docs/Design/FileFormats/saved.html

@@ -76,6 +76,9 @@ <h2>
   <li>
     Pascal source files (either .inc or .pas files).
   </li>
+  <li>
+    HTML 5 files.
+  </li>
   <li>
     XHTML files.
   </li>
@@ -85,7 +88,7 @@ <h2>
 </ul>
 
 <p>
-  There is no specific file format for these files, except that XHTML and RTF
+  There is no specific file format for these files, except that HTML 5, XHTML and RTF
   files conform to published specifications.
 </p>
 
@@ -135,6 +138,16 @@ <h2>
       </li>
     </ul>
   </dd>
+  <dt>
+    HTML 5 files
+  </dt>
+  <dd>
+    <ul class="squashed">
+      <li>
+        UTF-8
+      </li>
+    </ul>
+  </dd>
   <dt>
     XHTML files
   </dt>

Src/ActiveText.UHTMLRenderer.pas

@@ -145,7 +145,7 @@ procedure TActiveTextHTML.InitialiseTagInfoMap;
 function TActiveTextHTML.MakeClosingTag(const Elem: IActiveTextActionElem):
   string;
 begin
-  Result := THTML.ClosingTag(fTagInfoMap[Elem.Kind].Name);
+  Result := TXHTML.ClosingTag(fTagInfoMap[Elem.Kind].Name);
 end;
 
 function TActiveTextHTML.MakeOpeningTag(const Elem: IActiveTextActionElem):
@@ -160,7 +160,7 @@ function TActiveTextHTML.MakeOpeningTag(const Elem: IActiveTextActionElem):
       Attrs := THTMLAttributes.Create;
     Attrs.Add('class', fCSSStyles.ElemClasses[Elem.Kind])
   end;
-  Result := THTML.OpeningTag(fTagInfoMap[Elem.Kind].Name, Attrs);
+  Result := TXHTML.OpeningTag(fTagInfoMap[Elem.Kind].Name, Attrs);
 end;
 
 function TActiveTextHTML.Render(ActiveText: IActiveText): string;
@@ -242,7 +242,7 @@ function TActiveTextHTML.RenderText(const TextElem: IActiveTextTextElem):
   end
   else
     Result := '';
-  Result := Result + THTML.Entities(TextElem.Text);
+  Result := Result + TXHTML.Entities(TextElem.Text);
 end;
 
 { TActiveTextHTML.TCSSStyles }

Src/Browser.UHighlighter.pas

@@ -194,7 +194,7 @@ function TWBHighlighter.HighlightWord(const Word: string;
     begin
       // Apply highlight to found text by spanning it with highlight style
       SpanAttrs := THTMLAttributes.Create('style', fHighLightStyle);
-      Range.pasteHTML(THTML.CompoundTag('span', SpanAttrs, Range.htmlText));
+      Range.pasteHTML(TXHTML.CompoundTag('span', SpanAttrs, Range.htmlText));
       Inc(Result);
     end
     else

Src/FmAboutDlg.pas

@@ -312,15 +312,15 @@ function TAboutDlg.ContribListHTML(ContribList: IStringList):
   begin
     for Contributor in ContribList do
       Result := Result
-        + THTML.CompoundTag('div', THTML.Entities(Contributor))
+        + TXHTML.CompoundTag('div', TXHTML.Entities(Contributor))
         + EOL;
   end
   else
   begin
     // List couldn't be found: display warning message
     DivAttrs := THTMLAttributes.Create('class', 'warning');
-    Result := THTML.CompoundTag(
-      'div', DivAttrs, THTML.Entities(sNoContributors)
+    Result := TXHTML.CompoundTag(
+      'div', DivAttrs, TXHTML.Entities(sNoContributors)
     );
   end;
 end;
@@ -484,15 +484,15 @@ procedure TAboutDlg.InitHTMLFrames;
           'DBLicense',
           StrIf(
             fMetaData.GetLicenseInfo.URL <> '',
-            THTML.CompoundTag(
+            TXHTML.CompoundTag(
               'a',
               THTMLAttributes.Create([
                 THTMLAttribute.Create('href', fMetaData.GetLicenseInfo.URL),
                 THTMLAttribute.Create('class', 'external-link')
               ]),
-              THTML.Entities(fMetaData.GetLicenseInfo.Name)
+              TXHTML.Entities(fMetaData.GetLicenseInfo.Name)
             ),
-            THTML.Entities(fMetaData.GetLicenseInfo.Name)
+            TXHTML.Entities(fMetaData.GetLicenseInfo.Name)
           )
         );
         Tplt.ResolvePlaceholderHTML(

Src/FmCompErrorDlg.pas

@@ -341,7 +341,7 @@ function TCompErrorDlg.TCompilerLog.LogListHTML: string;
 begin
   Result := '';
   for Line in fLog do
-    Result := Result + THTML.CompoundTag('li', THTML.Entities(Line)) + EOL;
+    Result := Result + TXHTML.CompoundTag('li', TXHTML.Entities(Line)) + EOL;
 end;
 
 end.

Src/FrSourcePrefs.pas

@@ -121,7 +121,8 @@ implementation
 
 resourcestring
   // File type descriptions
-  sHTMLFileDesc = 'HTML';
+  sHTML5FileDesc = 'HTML 5';
+  sXHTMLFileDesc = 'XHTML';
   sRTFFileDesc = 'Rich text';
   sPascalFileDesc = 'Pascal';
   sTextFileDesc = 'Plain text';
@@ -130,7 +131,7 @@ implementation
 const
   // Maps source code file types to descriptions
   cFileDescs: array[TSourceFileType] of string = (
-    sTextFileDesc, sPascalFileDesc, sHTMLFileDesc, sRTFFileDesc
+    sTextFileDesc, sPascalFileDesc, sHTML5FileDesc, sXHTMLFileDesc, sRTFFileDesc
   );
 
 

Src/Help/HTML/dlg_savesnippet.htm

@@ -75,7 +75,13 @@ <h1>
         file except that the extension is .txt rather than .inc.
       </li>
       <li>
-        An HTML file (.html) &ndash; This option writes the source code out as a
+        A HTML 5 file (.html) &ndash; This option writes the source code out as a
+        valid HTML 5 document that uses embedded CSS to format the code. The
+        source code will be syntax highlighted if the <em>Use syntax
+        highlighting</em> check box is checked.
+      </li>
+      <li>
+        An XHTML file (.html) &ndash; This option writes the source code out as a
         valid XHTML document that uses embedded CSS to format the code. The
         source code will be syntax highlighted if the <em>Use syntax
         highlighting</em> check box is checked.

Src/Help/HTML/dlg_saveunit.htm

@@ -60,7 +60,13 @@ <h1>
         file except that the extension is .txt rather than .pas.
       </li>
       <li>
-        An HTML file (.html) &ndash; This option writes the source code out as a
+        A HTML 5 file (.html) &ndash; This option writes the source code out as a
+        valid HTML 5 document that uses embedded CSS to format the code. The
+        source code will be syntax highlighted if the <em>Use syntax
+        highlighting</em> check box is checked.
+      </li>
+      <li>
+        An XHTML file (.html) &ndash; This option writes the source code out as a
         valid XHTML document that uses embedded CSS to format the code. The
         source code will be syntax highlighted if the <em>Use syntax
         highlighting</em> check box is checked.

Src/Help/HTML/menu_file.htm

@@ -37,8 +37,8 @@ <h1>
           to a file. The file contains an annotated fragment of Pascal code. The
           <a href="dlg_savesnippet.htm">Save Annotated Source</a> dialogue box
           is displayed and is used to determine the format of the file being
-          saved. This can be plain text, a Pascal include file, HTML or RTF. The
-          latter two options can be syntax highlighted. This option is available
+          saved. This can be plain text, a Pascal include file, HTML 5, XHTML or RTF. The
+          latter three options can be syntax highlighted. This option is available
           only for <a href="snippet_routine.htm">routine</a> snippets or
           categories containing routines. Any snippets in a category that are
           not routines are ignored.
@@ -74,7 +74,7 @@ <h1>
           snippets and saves it to file. The <a href="dlg_saveunit.htm">Save
           Unit</a> dialogue box is displayed and is used to determine the format
           of the file being saved. The format can be plain text, a Pascal unit
-          file, HTML or RTF. The latter two options can be syntax highlighted.
+          file, HTML 5, XHTML or RTF. The latter three options can be syntax highlighted.
           <a href="snippet_freeform.htm">Freeform</a> snippets are not included
           in the unit.
         </td>

Src/Hiliter.UFileHiliter.pas

@@ -99,7 +99,8 @@ function TFileHiliter.Hilite(const SourceCode, DocTitle: string): TEncodedData;
 begin
   case fFileType of
     sfRTF: HilitedDocCls := TRTFDocumentHiliter;
-    sfHTML: HilitedDocCls := TXHTMLDocumentHiliter;
+    sfXHTML: HilitedDocCls := TXHTMLDocumentHiliter;
+    sfHTML5: HilitedDocCls := THTML5DocumentHiliter;
     else HilitedDocCls := TNulDocumentHiliter;
   end;
   if fWantHiliting and IsHilitingSupported(fFileType) then
@@ -116,7 +117,7 @@ class function TFileHiliter.IsHilitingSupported(
     @return True if file type supports highlighting, false if not.
   }
 begin
-  Result := FileType in [sfHTML, sfRTF];
+  Result := FileType in [sfHTML5, sfXHTML, sfRTF];
 end;
 
 end.

Src/Hiliter.UHiliters.pas

@@ -132,14 +132,16 @@   TNulDocumentHiliter = class sealed(TDocumentHiliter)
   ///  <summary>
   ///  Creates a highlighted source code document in XHTML format.
   ///  </summary>
-  TXHTMLDocumentHiliter = class sealed(TDocumentHiliter)
+  THTMLDocumentHiliter = class abstract(TDocumentHiliter)
   strict private
     ///  <summary>Generates the CSS rules to be used in the document.</summary>
     ///  <param name="Attrs">IHiliteAttrs [in] Highlighting styles used in
     ///  document.</param>
     ///  <returns>string. CSS rules that apply styles specified in Attrs.
     ///  </returns>
     class function GenerateCSSRules(Attrs: IHiliteAttrs): string;
+  strict protected
+    class function BuilderClass: THTMLBuilderClass; virtual; abstract;
   public
     ///  <summary>Creates XHTML document containing highlighted source code.
     ///  </summary>
@@ -154,6 +156,20 @@   TXHTMLDocumentHiliter = class sealed(TDocumentHiliter)
       override;
   end;
 
+  ///  <summary>Creates a highlighted source code document in XHTML format.
+  ///  </summary>
+  TXHTMLDocumentHiliter = class sealed(THTMLDocumentHiliter)
+  strict protected
+    class function BuilderClass: THTMLBuilderClass; override;
+  end;
+
+  ///  <summary>Creates a highlighted source code document in HTML5 format.
+  ///  </summary>
+  THTML5DocumentHiliter = class sealed(THTMLDocumentHiliter)
+  strict protected
+    class function BuilderClass: THTMLBuilderClass; override;
+  end;
+
 type
   ///  <summary>
   ///  Creates a highlighted source code document in rich text format.
@@ -242,55 +258,56 @@   TRTFHiliteRenderer = class(THiliteRenderer, IHiliteRenderer)
   end;
 
 type
-  ///  <summary>
-  ///  Renders highlighted source code in XHTML format. Generated code is
-  ///  recorded in a given HTML code builder object.
+  ///  <summary>Renders highlighted source code in any supported HTML format.
   ///  </summary>
-  ///  <remarks>
-  ///  Designed for use with TSyntaxHiliter objects.
-  ///  </remarks>
+  ///  <remarks>Designed for use with <c>TSyntaxHiliter</c> objects.</remarks>
   THTMLHiliteRenderer = class(THiliteRenderer, IHiliteRenderer)
   strict private
     var
-      ///  <summary>Object used to record generated XHTML code.</summary>
+      ///  <summary>Object used to build up the generated HTML.</summary>
       fBuilder: THTMLBuilder;
-      ///  <summary>Flag indicating if writing first line of output.</summary>
+      ///  <summary>Flag indicating if writing the first line of output.
+      ///  </summary>
       fIsFirstLine: Boolean;
   public
-    ///  <summary>Object constructor. Sets up object to render documents.
-    ///  </summary>
-    ///  <param name="Builder">THTMLBuilder [in] Object that receives generated
-    ///  XHTML code.</param>
-    ///  <param name="Attrs">IHiliteAttrs [in] Specifies required highlighting
-    ///  style. If nil document is not highlighted.</param>
+    ///  <summary>Object constructor. Sets up the object to render HTML
+    ///  documents.</summary>
+    ///  <param name="Builder"><c>THTMLBuilder</c> [in] Object used to build the
+    ///  required HTML. <c>Builder</c> must be an instance of a concreate
+    ///  descendant class of <c>THTMLBuilder</c>, which is abstract. The type of
+    ///  <c>Builder</c> determines the type of HTML that is generated.</param>
+    ///  <param name="Attrs"><c>IHiliteAttrs</c> [in] Specifies required
+    ///  highlighting style. If <c>nil</c> the document is not highlighted.
+    ///  </param>
     constructor Create(const Builder: THTMLBuilder;
       const Attrs: IHiliteAttrs = nil);
-    ///  <summary>Initialises XHTML ready to receive highlighted code.</summary>
-    ///  <remarks>Method of IHiliteRenderer.</remarks>
+    ///  <summary>Initialises the HTML ready to receive highlighted code.
+    ///  </summary>
+    ///  <remarks>Method of <c>IHiliteRenderer</c>.</remarks>
     procedure Initialise;
-    ///  <summary>Tidies up XHTML after all highlighted code processed.
+    ///  <summary>Tidies up the HTML after all highlighted code is processed.
     ///  </summary>
-    ///  <remarks>Method of IHiliteRenderer.</remarks>
+    ///  <remarks>Method of <c>IHiliteRenderer</c>.</remarks>
     procedure Finalise;
-    ///  <summary>Emits new line if necessary.</summary>
-    ///  <remarks>Method of IHiliteRenderer.</remarks>
+    ///  <summary>Emits a new line if necessary.</summary>
+    ///  <remarks>Method of <c>IHiliteRenderer</c>.</remarks>
     procedure BeginLine;
     ///  <summary>Does nothing.</summary>
     ///  <remarks>
-    ///  <para>Handling of new lines is all done by BeginLine.</para>
-    ///  <para>Method of IHiliteRenderer.</para>
+    ///  <para>Handling of new lines is all done by <c>BeginLine</c>.</para>
+    ///  <remarks>Method of <c>IHiliteRenderer</c>.</remarks>
     ///  </remarks>
     procedure EndLine;
-    ///  <summary>Emits any span tag required to style following source code
-    ///  element as specified by Elem.</summary>
-    ///  <remarks>Method of IHiliteRenderer.</remarks>
+    ///  <summary>Emits any &lt;span&gt; tag required to style the following
+    ///  source code element, specified by <c>Elem</c>.</summary>
+    ///  <remarks>Method of <c>IHiliteRenderer</c>.</remarks>
     procedure BeforeElem(Elem: THiliteElement);
-    ///  <summary>Writes given source code element text.</summary>
-    ///  <remarks>Method of IHiliteRenderer.</remarks>
+    ///  <summary>Writes the given source code element text.</summary>
+    ///  <remarks>Method of <c>IHiliteRenderer</c>.</remarks>
     procedure WriteElemText(const Text: string);
-    ///  <summary>Closes any span tag used to style source code element
-    ///  specified by Elem.</summary>
-    ///  <remarks>Method of IHiliteRenderer.</remarks>
+    ///  <summary>Closes any &lt;span&gt; tag used to style the source code
+    ///  element specified by <c>Elem</c>.</summary>
+    ///  <remarks>Method of <c>IHiliteRenderer</c>.</remarks>
     procedure AfterElem(Elem: THiliteElement);
   end;
 
@@ -372,9 +389,9 @@ class function TNulDocumentHiliter.Hilite(const RawCode: string;
   Result := TEncodedData.Create(RawCode, etUnicode);
 end;
 
-{ TXHTMLDocumentHiliter }
+{ THTMLDocumentHiliter }
 
-class function TXHTMLDocumentHiliter.GenerateCSSRules(Attrs: IHiliteAttrs):
+class function THTMLDocumentHiliter.GenerateCSSRules(Attrs: IHiliteAttrs):
   string;
 var
   CSSBuilder: TCSSBuilder;  // builds CSS code
@@ -396,7 +413,7 @@ class function TXHTMLDocumentHiliter.GenerateCSSRules(Attrs: IHiliteAttrs):
   end;
 end;
 
-class function TXHTMLDocumentHiliter.Hilite(const RawCode: string;
+class function THTMLDocumentHiliter.Hilite(const RawCode: string;
   Attrs: IHiliteAttrs; const Title: string): TEncodedData;
 resourcestring
   // Default document title
@@ -405,7 +422,7 @@ class function TXHTMLDocumentHiliter.Hilite(const RawCode: string;
   Renderer: IHiliteRenderer;    // XHTML renderer object
   Builder: THTMLBuilder;        // object used to construct XHTML document
 begin
-  Builder := THTMLBuilder.Create;
+  Builder := BuilderClass.Create;
   try
     if Title <> '' then
       Builder.Title := Title
@@ -420,6 +437,20 @@ class function TXHTMLDocumentHiliter.Hilite(const RawCode: string;
   end;
 end;
 
+{ TXHTMLDocumentHiliter }
+
+class function TXHTMLDocumentHiliter.BuilderClass: THTMLBuilderClass;
+begin
+  Result := TXHTMLBuilder;
+end;
+
+{ THTML5DocumentHiliter }
+
+class function THTML5DocumentHiliter.BuilderClass: THTMLBuilderClass;
+begin
+  Result := THTML5Builder;
+end;
+
 { TRTFDocumentHiliter }
 
 class function TRTFDocumentHiliter.Hilite(const RawCode: string;