Merge branch 'feature/81+82-reml-lists-not-rendered-in-plain-text-or-rtf' into develop

Resolved conflicts:
*	Src/ActiveText.UHTMLRenderer.pas
*	Src/ActiveText.UMain.pas
*	Src/ActiveText.UTextRenderer.pas
*	Src/USourceGen.pas
*	Src/UTextSnippetDoc.pas

All resolved in favour of the incoming changes from the feature branch.

Fixes #81. Fixes #82.

Author: delphidabbler

Docs/Design/reml.html

@@ -279,19 +279,19 @@ <h2>
   </p>
   <ul class="half-spaced">
     <li>
-      <code class="value">&lt;p&gt;...&lt;/p&gt;</code> &ndash; Renders the enclosed markup as a simple paragraph.
+      <code class="value">&lt;p&gt;...&lt;/p&gt;</code> &ndash; Renders the enclosed markup as a simple paragraph. 
     </li>
     <li>
       <code class="value">&lt;heading&gt;...&lt;/heading&gt;</code> &ndash; Renders the enclosed markup as a heading.
     </li>
     <li>
-      <code class="value">&lt;ol&gt;...&lt;/ol&gt;</code> &ndash; Renders the enclosed HTML as an ordered list. <span class="very-strong">Must</span> contain <code class="value">&lt;li&gt;...&lt;/li&gt</code> blocks and nothing else.
+      <code class="value">&lt;ol&gt;...&lt;/ol&gt;</code> &ndash; Renders the enclosed markup as an ordered list.
     </li>
     <li>
-      <code class="value">&lt;ul&gt;...&lt;/ul&gt;</code> &ndash; Renders the enclosed HTML as an unordered list. <span class="very-strong">Must</span> contain <code class="value">&lt;li&gt;...&lt;/li&gt</code> blocks and nothing else.
+      <code class="value">&lt;ul&gt;...&lt;/ul&gt;</code> &ndash; Renders the enclosed markup as an unordered list.
     </li>
     <li>
-      <code class="value">&lt;li&gt;...&lt;/li&gt;</code> &ndash; Renders the enclosed HTML as a list item. <span class="very-strong">Must</span> only be used within <code class="value">&lt;ol&gt;...&lt;/ol&gt;</code> and <code class="value">&lt;ul&gt;...&lt;/ul&gt;</code> blocks.
+      <code class="value">&lt;li&gt;...&lt;/li&gt;</code> &ndash; Renders the enclosed markup as a list item.
     </li>
   </ul>
   <p>
@@ -308,7 +308,7 @@ <h2>
       <code class="value">&lt;ol&gt;...&lt;/ol&gt;</code> and <code class="value">&lt;ul&gt;...&lt;/ul&gt;</code> blocks <span class="very-strong">must only</span> contain one or more <code class="value">&lt;li&gt;...&lt;/li&gt;</code> blocks.
     </li>
     <li>
-      <code class="value">&lt;li&gt;...&lt;/li&gt;</code> blocks <span class="very-strong">must not</span> contain <code class="value">&lt;p&gt;...&lt;/p&gt;</code>, <code class="value">&lt;heading&gt;...&lt;/heading&gt;</code> or other <code class="value">&lt;li&gt;...&lt;/li&gt;</code> blocks directly, but <em>may</em> contain <code class="value">&lt;ol&gt;...&lt;/ol&gt;</code> and <code class="value">&lt;ul&gt;...&lt;/ul&gt;</code> blocks.
+      <code class="value">&lt;li&gt;...&lt;/li&gt;</code> blocks <span class="very-strong">must</span> only be used within <code class="value">&lt;ol&gt;...&lt;/ol&gt;</code> and <code class="value">&lt;ul&gt;...&lt;/ul&gt;</code> blocks. <em>May</em> contain <code class="value">&lt;p&gt;...&lt;/p&gt;</code> and <code class="value">&lt;heading&gt;...&lt;/heading&gt;</code> blocks, but it is permitted to include text and inline tags directly without enclosing them one of the permitted blocks. Nested lists are permitted by including further <code class="value">&lt;ul&gt;...&lt;/ul&gt;</code> and <code class="value">&lt;ol&gt;...&lt;/ol&gt;</code> blocks.
     </li>
     <li>
       All text <em>should</em> be embedded within <code class="value">&lt;p&gt;...&lt;/p&gt;</code>, <code class="value">&lt;heading&gt;...&lt;/heading&gt;</code> or <code class="value">&lt;li&gt;...&lt;/li&gt;</code> block level tags, e.g. <code class="value">&lt;heading&gt;heading&lt;/heading&gt;&lt;p&gt;text&lt;/p&gt;</code> or simply <code class="value">&lt;p&gt;text&lt;/p&gt;</code>.
@@ -320,20 +320,23 @@ <h2>
   <p>
     Here is a valid example:
   </p>
-  <pre class="sample">&lt;p&gt;Hello World&lt;/p&gt;
-&lt;heading&gt;Hello&lt;/heading&gt;
+  <pre class="sample">&lt;heading&gt;Hello&lt;/heading&gt;
 &lt;p&gt;Hello World&lt;/p&gt;
 &lt;ol&gt;
   &lt;li&gt;one&lt;/li&gt;
-  &lt;li&gt;two&lt;/li&gt;
+  &lt;li&gt;&lt;p&gt;two&lt;/p&gt;&lt;/li&gt;
+  &lt;ul&gt;
+    &lt;li&gt;two A&lt;/li&gt;
+    &lt;li&gt;two B&lt;/li&gt;
+  &lt;ul&gt;
   &lt;li&gt;three&lt;/li&gt;
 &lt;/ol&gt;</pre>
   <p>
     Strictly speaking, the following example is invalid code &ndash; all occurrences of <code class="value">wrong</code> are in error because they are not contained within block tags.
   </p>
   <pre class="sample">wrong &lt;heading&gt;blah&lt;/heading&gt; wrong &lt;p&gt;blah&lt;/p&gt; wrong</pre>
   <p>
-    However interpreting code <em>may</em> interpret this permissively. If this is done the text outside blocks <span class="very-strong">must</span> be interpreted as if it was enclosed in <code class="value">&lt;p&gt;</code> and <code class="value">&lt;/p&gt;</code> tags. Therefore the above code would be interpreted as:
+    However interpreting code <em>may</em> interpret this permissively. If this is done the text outside blocks <em>should</em> be interpreted as if it was enclosed in <code class="value">&lt;p&gt;</code> and <code class="value">&lt;/p&gt;</code> tags. Therefore the above code would be interpreted as:
   </p>
   <pre class="sample">&lt;p&gt;wrong &lt;/p&gt;&lt;heading&gt;blah&lt;/heading&gt;&lt;p&gt;wrong &lt;/p&gt;&lt;p&gt;blah&lt;/p&gt;&lt;p&gt;wrong&lt;/p&gt;</pre>
   <aside>
@@ -375,13 +378,13 @@ <h2>
   </p>
   <ul class="unspaced">
     <li>
-      In-line tags <span class="very-strong">must</span> be embedded inside a block level tag. E.g. <code class="value">&lt;p&gt;one&lt;strong&gt;two&lt;/strong&gt;three&lt;/p&gt;</code>.
+      In-line tags <span class="very-strong">must</span> be embedded inside a valid block level tag. E.g. <code class="value">&lt;p&gt;one&lt;strong&gt;two&lt;/strong&gt;three&lt;/p&gt;</code>.
     </li>
     <li>
       Tags <span class="very-strong">must</span> match. E.g. <code class="value">&lt;em&gt;</code> must be matched with <code class="value">&lt;/em&gt;</code>.
     </li>
     <li>
-      Tags may be nested, providing the tags match. E.g. <code class="value">&lt;em&gt;blah &lt;var&gt;blah&lt;/var&gt;&lt;/em&gt;</code> is valid but <code class="value">&lt;em&gt;blah &lt;var&gt;blah&lt;/em&gt;&lt;/var&gt;</code> is not.
+      Tags may be nested, providing the tags are balanced. E.g. <code class="value">&lt;em&gt;blah &lt;var&gt;blah&lt;/var&gt;&lt;/em&gt;</code> is valid but <code class="value">&lt;em&gt;blah &lt;var&gt;blah&lt;/em&gt;&lt;/var&gt;</code> is not.
     </li>
   </ul>
   <p>

Src/ActiveText.UHTMLRenderer.pas

@@ -47,43 +47,43 @@       TTagInfo = class(TObject)
       TCSSStyles = class(TObject)
       strict private
         var
-          fWrapperClass: string;
           fElemClassMap: array[TActiveTextActionElemKind] of string;
         procedure SetElemClass(ElemKind: TActiveTextActionElemKind;
           const Value: string); inline;
         function GetElemClass(ElemKind: TActiveTextActionElemKind): string;
           inline;
       public
         constructor Create;
-        property WrapperClass: string read fWrapperClass write fWrapperClass;
         property ElemClasses[Kind: TActiveTextActionElemKind]: string
           read GetElemClass write SetElemClass;
       end;
   strict private
     var
       fCSSStyles: TCSSStyles;
       fBuilder: TStringBuilder;
-      fInBlock: Boolean;
+      fLevel: Integer;
       fTagInfoMap: TTagInfoMap;
+      fIsStartOfTextLine: Boolean;
       fLINestingDepth: Cardinal;
+    const
+      IndentMult = 2;
     procedure InitialiseTagInfoMap;
-    procedure InitialiseRender;
-    procedure RenderTextElem(Elem: IActiveTextTextElem);
-    procedure RenderBlockActionElem(Elem: IActiveTextActionElem);
-    procedure RenderInlineActionElem(Elem: IActiveTextActionElem);
-    procedure FinaliseRender;
+    function RenderTag(const TagElem: IActiveTextActionElem): string;
+    function RenderText(const TextElem: IActiveTextTextElem): string;
     function MakeOpeningTag(const Elem: IActiveTextActionElem): string;
     function MakeClosingTag(const Elem: IActiveTextActionElem): string;
   public
     constructor Create;
     destructor Destroy; override;
     function Render(ActiveText: IActiveText): string;
-    property Styles: TCSSStyles read fCSSStyles;
   end;
 
 
 implementation
 
+uses
+  UConsts, UIStringList, UStrUtils;
+
 
 { TActiveTextHTML }
 
@@ -107,22 +107,6 @@ destructor TActiveTextHTML.Destroy;
   inherited;
 end;
 
-procedure TActiveTextHTML.FinaliseRender;
-begin
-  fBuilder.AppendLine(THTML.ClosingTag('div'));
-end;
-
-procedure TActiveTextHTML.InitialiseRender;
-var
-  WrapperClassAttr: IHTMLAttributes;
-begin
-  if fCSSStyles.WrapperClass <> '' then
-    WrapperClassAttr := THTMLAttributes.Create('class', fCSSStyles.WrapperClass)
-  else
-    WrapperClassAttr := nil;
-  fBuilder.AppendLine(THTML.OpeningTag('div', WrapperClassAttr));
-end;
-
 procedure TActiveTextHTML.InitialiseTagInfoMap;
 var
   NullAttrs: TTagInfo.TTagAttrCallback;
@@ -131,7 +115,10 @@ procedure TActiveTextHTML.InitialiseTagInfoMap;
   ElemKind: TActiveTextActionElemKind;
 const
   Tags: array[TActiveTextActionElemKind] of string = (
-    'a', 'strong', 'em', 'var', 'p', 'span', 'h2', 'code', 'ul', 'ol', 'li'
+    'a' {ekLink}, 'strong' {ekStrong}, 'em' {ekEm}, 'var' {ekVar}, 'p' {ekPara},
+    'span' {ekWarning}, 'h2' {ekHeading}, 'code' {ekMono},
+    'ul' {ekUnorderedList}, 'ol' {ekUnorderedList}, 'li' {ekListItem},
+    'div' {ekBlock}, 'div' {ekDocument}
   );
 begin
   NullAttrs := function(Elem: IActiveTextActionElem): IHTMLAttributes
@@ -178,80 +165,100 @@ function TActiveTextHTML.MakeOpeningTag(const Elem: IActiveTextActionElem):
 
 function TActiveTextHTML.Render(ActiveText: IActiveText): string;
 var
-  Elem: IActiveTextElem;
-  TextElem: IActiveTextTextElem;
-  ActionElem: IActiveTextActionElem;
+  Elem: IActiveTextElem;          // each element in active text object
+  TextElem: IActiveTextTextElem;  // an active text text element
+  TagElem: IActiveTextActionElem; // an active text action element
+  Text: string;
+  SrcLines: IStringList;
+  SrcLine: string;
+  DestLines: IStringList;
+  DestLine: string;
 begin
-  fBuilder.Clear;
-  fInBlock := False;
-  InitialiseRender;
+  if ActiveText.IsEmpty then
+    Exit('');
+  Text := '';
+  fLevel := 0;
   for Elem in ActiveText do
   begin
     if Supports(Elem, IActiveTextTextElem, TextElem) then
-      RenderTextElem(TextElem)
-    else if Supports(Elem, IActiveTextActionElem, ActionElem) then
-    begin
-      if TActiveTextElemCaps.DisplayStyleOf(ActionElem.Kind) = dsBlock then
-        RenderBlockActionElem(ActionElem)
-      else
-        RenderInlineActionElem(ActionElem);
-    end;
+      Text := Text + RenderText(TextElem)
+    else if Supports(Elem, IActiveTextActionElem, TagElem) then
+      Text := Text + RenderTag(TagElem);
   end;
-  FinaliseRender;
-  Result := fBuilder.ToString;
+  SrcLines := TIStringList.Create(Text, EOL, False);
+  DestLines := TIStringList.Create;
+  for SrcLine in SrcLines do
+  begin
+    DestLine := StrTrimRight(SrcLine);
+    if not StrIsEmpty(DestLine) then
+      DestLines.Add(DestLine);
+  end;
+  Result := DestLines.GetText(EOL, False);
 end;
 
-procedure TActiveTextHTML.RenderBlockActionElem(Elem: IActiveTextActionElem);
+function TActiveTextHTML.RenderTag(const TagElem: IActiveTextActionElem):
+  string;
 begin
-  case Elem.State of
-    fsOpen:
-    begin
-      if Elem.Kind = ekListItem then
-        Inc(fLINestingDepth);
-      fBuilder.Append(MakeOpeningTag(Elem));
-      fInBlock := True;
-    end;
+  Result := '';
+  case TagElem.State of
     fsClose:
     begin
-      fInBlock := False;
-      fBuilder.AppendLine(MakeClosingTag(Elem));
-      if Elem.Kind = ekListItem then
-        Dec(fLINestingDepth);
+      Result := MakeClosingTag(TagElem);
+      if TActiveTextElemCaps.DisplayStyleOf(TagElem.Kind) = dsBlock then
+      begin
+        Dec(fLevel);
+        Result := EOL + StrOfSpaces(IndentMult * fLevel) + Result + EOL;
+        fIsStartOfTextLine := True;
+      end;
     end;
-  end;
-end;
-
-procedure TActiveTextHTML.RenderInlineActionElem(Elem: IActiveTextActionElem);
-begin
-  if not fInBlock and (fLINestingDepth = 0) then
-    Exit;
-  case Elem.State of
     fsOpen:
-      fBuilder.Append(MakeOpeningTag(Elem));
-    fsClose:
-      fBuilder.Append(MakeClosingTag(Elem));
+    begin
+      Result := MakeOpeningTag(TagElem);
+      if TActiveTextElemCaps.DisplayStyleOf(TagElem.Kind) = dsBlock then
+      begin
+        Result := EOL + StrOfSpaces(IndentMult * fLevel) + Result + EOL;
+        Inc(fLevel);
+        fIsStartOfTextLine := True;
+      end
+      else if TActiveTextElemCaps.DisplayStyleOf(TagElem.Kind) = dsInline then
+      begin
+        if fIsStartOfTextLine then
+        begin
+          Result := StrOfSpaces(IndentMult * fLevel) + Result;
+          fIsStartOfTextLine := False;
+        end;
+      end;
+    end;
   end;
 end;
 
-procedure TActiveTextHTML.RenderTextElem(Elem: IActiveTextTextElem);
+function TActiveTextHTML.RenderText(const TextElem: IActiveTextTextElem):
+  string;
 begin
-  if not fInBlock and (fLINestingDepth = 0) then
-    Exit;
-  fBuilder.Append(THTML.Entities(Elem.Text));
+  if fIsStartOfTextLine then
+  begin
+    Result := StrOfSpaces(IndentMult * fLevel);
+    fIsStartOfTextLine := False;
+  end
+  else
+    Result := '';
+  Result := Result + THTML.Entities(TextElem.Text);
 end;
 
 { TActiveTextHTML.TCSSStyles }
 
 constructor TActiveTextHTML.TCSSStyles.Create;
 const
   DefaultClasses: array[TActiveTextActionElemKind] of string = (
-    'external-link', '', '', '', '', 'warning', '', '', '', '', ''
+    'external-link' {ekLink}, '' {ekStrong}, '' {ekEm}, '' {ekVar}, '' {ekPara},
+    'warning' {ekWarning}, '' {ekHeading}, '' {ekMono}, '' {ekUnorderedList},
+    '' {ekOrderedList}, '' {ekListItem}, '' {ekBlock},
+    'active-text' {ekDocument}
   );
 var
   ElemKind: TActiveTextActionElemKind;
 begin
   inherited Create;
-  fWrapperClass := 'active-text';
   for ElemKind := Low(TActiveTextActionElemKind)
     to High(TActiveTextActionElemKind) do
     SetElemClass(ElemKind, DefaultClasses[ElemKind]);