Renderer.cs

using System.Collections.Generic;
using System.Text;
using System.Threading.Tasks;
using Waher.Content.Markdown.Model;
using Waher.Content.Markdown.Model.BlockElements;
using Waher.Content.Markdown.Model.SpanElements;
using Waher.Runtime.Collections;
 
namespace Waher.Content.Markdown.Rendering
{
    public abstract class Renderer : IRenderer
    {
        public readonly StringBuilder Output;
 
        public MarkdownDocument Document;
 
        public Renderer()
            : this(new StringBuilder())
        {
        }
 
        public Renderer(StringBuilder Output)
        {
            this.Output = Output;
        }
 
        public Renderer(MarkdownDocument Document)
            : this(new StringBuilder(), Document)
        {
        }
 
        public Renderer(StringBuilder Output, MarkdownDocument Document)
        {
            this.Output = Output;
            this.Document = Document;
        }
 
        public virtual void Dispose()
        {
            // Do nothing by default.
        }
 
        public virtual async Task RenderDocument(MarkdownDocument Document, bool Inclusion)
        {
            MarkdownDocument DocBak = this.Document;
 
            this.Document = Document;
 
            if (!Inclusion && this.Document.TryGetMetaData("BODYONLY", out KeyValuePair<string, bool>[] Values))
            {
                if (CommonTypes.TryParse(Values[0].Key, out bool b) && b)
                    Inclusion = true;
            }
 
            if (!Inclusion)
                await this.RenderDocumentHeader();
 
            await this.Render(this.Document.Elements);
 
            if (this.Document.NeedsToDisplayFootnotes)
                await this.RenderFootnotes();
 
            if (!Inclusion)
                await this.RenderDocumentFooter();
 
            this.Document = DocBak;
        }
 
        public virtual Task RenderDocumentHeader()
        {
            return Task.CompletedTask;  // Do nothing by default.
        }
 
        public virtual Task RenderFootnotes()
        {
            return Task.CompletedTask;  // Do nothing by default.
        }
 
        public virtual Task RenderDocumentFooter()
        {
            return Task.CompletedTask;  // Do nothing by default.
        }
 
        public override string ToString()
        {
            return this.Output.ToString();
        }
 
        public void Clear()
        {
            this.Output.Clear();
        }
 
        public Task RenderChildren(MarkdownElementChildren Element)
        {
            ChunkedList<MarkdownElement> Children = Element.Children;
            if (!(Children is null))
                return this.Render(Children);
            else
                return Task.CompletedTask;
        }
 
        public async Task RenderChildren(MarkdownElement Element)
        {
            ChunkNode<MarkdownElement> Loop = Element.Children?.FirstChunk;
            int i, c;
 
            while (!(Loop is null))
            {
                for (i = Loop.Start, c = Loop.Pos; i < c; i++)
                    await Loop[i].Render(this);
 
                Loop = Loop.Next;
            }
        }
 
        public Task RenderChild(MarkdownElementSingleChild Element)
        {
            if (Element.Child is null)
                return Task.CompletedTask;
            else
                return Element.Child.Render(this);
        }
 
        public async Task<bool> Render(ChunkedList<MarkdownElement> Elements)
        {
            ChunkNode<MarkdownElement> Loop = Elements.FirstChunk;
            int i, c;
            bool Rendered = false;
 
            while (!(Loop is null))
            {
                for (i = Loop.Start, c = Loop.Pos; i < c; i++)
                {
                    await Loop[i].Render(this);
                    Rendered = true;
                }
 
                Loop = Loop.Next;
            }
 
            return Rendered;
        }
 
        #region Span Elements
 
        public abstract Task Render(Abbreviation Element);
 
        public abstract Task Render(AutomaticLinkMail Element);
 
        public abstract Task Render(AutomaticLinkUrl Element);
 
        public abstract Task Render(Delete Element);
 
        public abstract Task Render(DetailsReference Element);
 
        public abstract Task Render(EmojiReference Element);
 
        public abstract Task Render(Emphasize Element);
 
        public abstract Task Render(FootnoteReference Element);
 
        public abstract Task Render(HashTag Element);
 
        public abstract Task Render(HtmlEntity Element);
 
        public abstract Task Render(HtmlEntityUnicode Element);
 
        public abstract Task Render(InlineCode Element);
 
        public abstract Task Render(InlineHTML Element);
 
        public abstract Task Render(InlineScript Element);
 
        public abstract Task Render(InlineText Element);
 
        public abstract Task Render(Insert Element);
 
        public abstract Task Render(LineBreak Element);
 
        public abstract Task Render(Link Element);
 
        public abstract Task Render(LinkReference Element);
 
        public abstract Task Render(MetaReference Element);
 
        public abstract Task Render(Model.SpanElements.Multimedia Element);
 
        public abstract Task Render(MultimediaReference Element);
 
        public abstract Task Render(StrikeThrough Element);
 
        public abstract Task Render(Strong Element);
 
        public abstract Task Render(SubScript Element);
 
        public abstract Task Render(SuperScript Element);
 
        public abstract Task Render(Underline Element);
 
        #endregion
 
        #region Block elements
 
        public abstract Task Render(BlockQuote Element);
 
        public abstract Task Render(BulletList Element);
 
        public abstract Task Render(CenterAligned Element);
 
        public abstract Task Render(CodeBlock Element);
 
        public abstract Task Render(CommentBlock Element);
 
        public abstract Task Render(DefinitionDescriptions Element);
 
        public abstract Task Render(DefinitionList Element);
 
        public abstract Task Render(DefinitionTerms Element);
 
        public abstract Task Render(DeleteBlocks Element);
 
        public abstract Task Render(Footnote Element);
 
        public abstract Task Render(Header Element);
 
        public abstract Task Render(HorizontalRule Element);
 
        public abstract Task Render(HtmlBlock Element);
 
        public abstract Task Render(InsertBlocks Element);
 
        public abstract Task Render(InvisibleBreak Element);
 
        public abstract Task Render(LeftAligned Element);
 
        public abstract Task Render(MarginAligned Element);
 
        public abstract Task Render(NestedBlock Element);
 
        public abstract Task Render(NumberedItem Element);
 
        public abstract Task Render(NumberedList Element);
 
        public abstract Task Render(Paragraph Element);
 
        public abstract Task Render(RightAligned Element);
 
        public abstract Task Render(Sections Element);
 
        public abstract Task Render(SectionSeparator Element);
 
        public abstract Task Render(Table Element);
 
        public abstract Task Render(TaskItem Element);
 
        public abstract Task Render(TaskList Element);
 
        public abstract Task Render(UnnumberedItem Element);
 
        #endregion
    }
}