From 9d52732f180d189ed59331b119c51c04c29edd47 Mon Sep 17 00:00:00 2001 From: Alexandre Mutel Date: Mon, 27 Jun 2016 22:25:32 +0900 Subject: [PATCH 01/14] wip normalize (issue #17) --- .../Renderers/Normalize/CodeBlockRenderer.cs | 52 +++ .../Renderers/Normalize/HeadingRenderer.cs | 35 ++ .../Normalize/NormalizeObjectRenderer.cs | 16 + .../Renderers/Normalize/NormalizeRenderer.cs | 323 ++++++++++++++++++ .../Renderers/Normalize/QuoteBlockRenderer.cs | 21 ++ src/Markdig/Renderers/TextRendererBase.cs | 33 ++ 6 files changed, 480 insertions(+) create mode 100644 src/Markdig/Renderers/Normalize/CodeBlockRenderer.cs create mode 100644 src/Markdig/Renderers/Normalize/HeadingRenderer.cs create mode 100644 src/Markdig/Renderers/Normalize/NormalizeObjectRenderer.cs create mode 100644 src/Markdig/Renderers/Normalize/NormalizeRenderer.cs create mode 100644 src/Markdig/Renderers/Normalize/QuoteBlockRenderer.cs diff --git a/src/Markdig/Renderers/Normalize/CodeBlockRenderer.cs b/src/Markdig/Renderers/Normalize/CodeBlockRenderer.cs new file mode 100644 index 00000000..4dce78cc --- /dev/null +++ b/src/Markdig/Renderers/Normalize/CodeBlockRenderer.cs @@ -0,0 +1,52 @@ +// Copyright (c) Alexandre Mutel. All rights reserved. +// This file is licensed under the BSD-Clause 2 license. +// See the license.txt file in the project root for more information. + +using Markdig.Renderers.Html; +using Markdig.Syntax; + +namespace Markdig.Renderers.Normalize +{ + /// + /// An Normalize renderer for a and . + /// + /// + public class CodeBlockRenderer : NormalizeObjectRenderer + { + public bool OutputAttributesOnPre { get; set; } + + protected override void Write(NormalizeRenderer renderer, CodeBlock obj) + { + var fencedCodeBlock = obj as FencedCodeBlock; + if (fencedCodeBlock != null) + { + var opening = new string(fencedCodeBlock.FencedChar, fencedCodeBlock.FencedCharCount); + renderer.Write(opening); + if (fencedCodeBlock.Info != null) + { + renderer.Write(fencedCodeBlock.Info); + } + if (fencedCodeBlock.Arguments != null) + { + renderer.Write(" ").Write(fencedCodeBlock.Arguments); + } + + var attributes = obj.TryGetAttributes(); + if (attributes != null) + { + renderer.Write(" "); + renderer.Write(attributes); + } + renderer.WriteLine(); + + renderer.WriteLeafRawLines(obj, true, false); + renderer.WriteLine(opening); + } + else + { + renderer.WriteLeafRawLines(obj, true, false, true); + renderer.WriteLine(); + } + } + } +} \ No newline at end of file diff --git a/src/Markdig/Renderers/Normalize/HeadingRenderer.cs b/src/Markdig/Renderers/Normalize/HeadingRenderer.cs new file mode 100644 index 00000000..9554eb7a --- /dev/null +++ b/src/Markdig/Renderers/Normalize/HeadingRenderer.cs @@ -0,0 +1,35 @@ +// Copyright (c) Alexandre Mutel. All rights reserved. +// This file is licensed under the BSD-Clause 2 license. +// See the license.txt file in the project root for more information. +using System.Globalization; +using Markdig.Syntax; + +namespace Markdig.Renderers.Normalize +{ + /// + /// An Normalize renderer for a . + /// + /// + public class HeadingRenderer : NormalizeObjectRenderer + { + private static readonly string[] HeadingTexts = { + "#", + "##", + "###", + "####", + "#####", + "######", + }; + + protected override void Write(NormalizeRenderer renderer, HeadingBlock obj) + { + var headingText = obj.Level > 0 && obj.Level <= 6 + ? HeadingTexts[obj.Level - 1] + : new string('#', obj.Level); + + renderer.Write(headingText).Write(' '); + renderer.WriteLeafInline(obj); + renderer.WriteLine(); + } + } +} \ No newline at end of file diff --git a/src/Markdig/Renderers/Normalize/NormalizeObjectRenderer.cs b/src/Markdig/Renderers/Normalize/NormalizeObjectRenderer.cs new file mode 100644 index 00000000..f24daef2 --- /dev/null +++ b/src/Markdig/Renderers/Normalize/NormalizeObjectRenderer.cs @@ -0,0 +1,16 @@ +// Copyright (c) Alexandre Mutel. All rights reserved. +// This file is licensed under the BSD-Clause 2 license. +// See the license.txt file in the project root for more information. +using Markdig.Syntax; + +namespace Markdig.Renderers.Normalize +{ + /// + /// A base class for Normalize rendering and Markdown objects. + /// + /// The type of the object. + /// + public abstract class NormalizeObjectRenderer : MarkdownObjectRenderer where TObject : MarkdownObject + { + } +} \ No newline at end of file diff --git a/src/Markdig/Renderers/Normalize/NormalizeRenderer.cs b/src/Markdig/Renderers/Normalize/NormalizeRenderer.cs new file mode 100644 index 00000000..6b79d028 --- /dev/null +++ b/src/Markdig/Renderers/Normalize/NormalizeRenderer.cs @@ -0,0 +1,323 @@ +// Copyright (c) Alexandre Mutel. All rights reserved. +// This file is licensed under the BSD-Clause 2 license. +// See the license.txt file in the project root for more information. + +using System; +using System.IO; +using System.Runtime.CompilerServices; +using System.Text; +using Markdig.Helpers; +using Markdig.Renderers.Html; +using Markdig.Syntax; + +namespace Markdig.Renderers.Normalize +{ + /// + /// Default HTML renderer for a Markdown object. + /// + /// + public class NormalizeRenderer : TextRendererBase + { + /// + /// Initializes a new instance of the class. + /// + /// The writer. + public NormalizeRenderer(TextWriter writer) : base(writer) + { + // Default block renderers + ObjectRenderers.Add(new CodeBlockRenderer()); + //ObjectRenderers.Add(new ListRenderer()); + ObjectRenderers.Add(new HeadingRenderer()); + //ObjectRenderers.Add(new HtmlBlockRenderer()); + //ObjectRenderers.Add(new ParagraphRenderer()); + ObjectRenderers.Add(new QuoteBlockRenderer()); + //ObjectRenderers.Add(new ThematicBreakRenderer()); + + // Default inline renderers + //ObjectRenderers.Add(new AutolinkInlineRenderer()); + //ObjectRenderers.Add(new CodeInlineRenderer()); + //ObjectRenderers.Add(new DelimiterInlineRenderer()); + //ObjectRenderers.Add(new EmphasisInlineRenderer()); + //ObjectRenderers.Add(new LineBreakInlineRenderer()); + //ObjectRenderers.Add(new HtmlInlineRenderer()); + //ObjectRenderers.Add(new HtmlEntityInlineRenderer()); + //ObjectRenderers.Add(new LinkInlineRenderer()); + //ObjectRenderers.Add(new LiteralInlineRenderer()); + + EnableHtmlForInline = true; + EnableHtmlEscape = true; + } + + /// + /// Gets or sets a value indicating whether to ouput HTML tags when rendering. See remarks. + /// + /// + /// This is used by some renderers to disable HTML tags when rendering some inlines (for image links). + /// + public bool EnableHtmlForInline { get; set; } + + public bool EnableHtmlEscape { get; set; } + + /// + /// Gets or sets a value indicating whether to use implicit paragraph (optional <p>) + /// + public bool ImplicitParagraph { get; set; } + + /// + /// Writes the content escaped for HTML. + /// + /// The content. + /// This instance + [MethodImpl(MethodImplOptionPortable.AggressiveInlining)] + public NormalizeRenderer WriteEscape(string content) + { + if (string.IsNullOrEmpty(content)) + return this; + + WriteEscape(content, 0, content.Length); + return this; + } + + /// + /// Writes the content escaped for HTML. + /// + /// The slice. + /// This instance + [MethodImpl(MethodImplOptionPortable.AggressiveInlining)] + public NormalizeRenderer WriteEscape(ref StringSlice slice) + { + if (slice.Start > slice.End) + { + return this; + } + return WriteEscape(slice.Text, slice.Start, slice.Length); + } + + /// + /// Writes the content escaped for HTML. + /// + /// The slice. + /// This instance + [MethodImpl(MethodImplOptionPortable.AggressiveInlining)] + public NormalizeRenderer WriteEscape(StringSlice slice) + { + return WriteEscape(ref slice); + } + + /// + /// Writes the content escaped for HTML. + /// + /// The content. + /// The offset. + /// The length. + /// This instance + public NormalizeRenderer WriteEscape(string content, int offset, int length) + { + if (string.IsNullOrEmpty(content) || length == 0) + return this; + + var end = offset + length; + int previousOffset = offset; + for (;offset < end; offset++) + { + switch (content[offset]) + { + case '<': + Write(content, previousOffset, offset - previousOffset); + if (EnableHtmlEscape) + { + Write("<"); + } + previousOffset = offset + 1; + break; + case '>': + Write(content, previousOffset, offset - previousOffset); + if (EnableHtmlEscape) + { + Write(">"); + } + previousOffset = offset + 1; + break; + case '&': + Write(content, previousOffset, offset - previousOffset); + if (EnableHtmlEscape) + { + Write("&"); + } + previousOffset = offset + 1; + break; + case '"': + Write(content, previousOffset, offset - previousOffset); + if (EnableHtmlEscape) + { + Write("""); + } + previousOffset = offset + 1; + break; + } + } + + Write(content, previousOffset, end - previousOffset); + return this; + } + + /// + /// Writes the URL escaped for HTML. + /// + /// The content. + /// This instance + public NormalizeRenderer WriteEscapeUrl(string content) + { + if (content == null) + return this; + + int previousPosition = 0; + int length = content.Length; + + for (var i = 0; i < length; i++) + { + var c = content[i]; + + if (c < 128) + { + var escape = HtmlHelper.EscapeUrlCharacter(c); + if (escape != null) + { + Write(content, previousPosition, i - previousPosition); + previousPosition = i + 1; + Write(escape); + } + } + else + { + Write(content, previousPosition, i - previousPosition); + previousPosition = i + 1; + + byte[] bytes; + if (c >= '\ud800' && c <= '\udfff' && previousPosition < length) + { + bytes = Encoding.UTF8.GetBytes(new[] { c, content[previousPosition] }); + // Skip next char as it is decoded above + i++; + previousPosition = i + 1; + } + else + { + bytes = Encoding.UTF8.GetBytes(new[] { c }); + } + + for (var j = 0; j < bytes.Length; j++) + { + Write($"%{bytes[j]:X2}"); + } + } + } + + Write(content, previousPosition, length - previousPosition); + return this; + } + + /// + /// Writes the attached on the specified . + /// + /// The object. + /// + public NormalizeRenderer WriteAttributes(MarkdownObject obj) + { + if (obj == null) throw new ArgumentNullException(nameof(obj)); + return WriteAttributes(obj.TryGetAttributes()); + } + + /// + /// Writes the specified . + /// + /// The attributes to render. + /// This instance + public NormalizeRenderer WriteAttributes(HtmlAttributes attributes) + { + if (attributes == null) + { + return this; + } + + if (attributes.Id != null) + { + Write(" id=\"").WriteEscape(attributes.Id).Write("\""); + } + + if (attributes.Classes != null && attributes.Classes.Count > 0) + { + Write(" class=\""); + for (int i = 0; i < attributes.Classes.Count; i++) + { + var cssClass = attributes.Classes[i]; + if (i > 0) + { + Write(" "); + } + WriteEscape(cssClass); + } + Write("\""); + } + + if (attributes.Properties != null && attributes.Properties.Count > 0) + { + foreach (var property in attributes.Properties) + { + Write(" ").Write(property.Key); + if (property.Value != null) + { + Write("=").Write("\""); + WriteEscape(property.Value); + Write("\""); + } + } + } + + return this; + } + + /// + /// Writes the lines of a + /// + /// The leaf block. + /// if set to true write end of lines. + /// if set to true escape the content for HTML + /// This instance + public NormalizeRenderer WriteLeafRawLines(LeafBlock leafBlock, bool writeEndOfLines, bool escape, bool indent = false) + { + if (leafBlock == null) throw new ArgumentNullException(nameof(leafBlock)); + if (leafBlock.Lines.Lines != null) + { + var lines = leafBlock.Lines; + var slices = lines.Lines; + for (int i = 0; i < lines.Count; i++) + { + if (!writeEndOfLines && i > 0) + { + WriteLine(); + } + + if (indent) + { + Write(" "); + } + + if (escape) + { + WriteEscape(ref slices[i].Slice); + } + else + { + Write(ref slices[i].Slice); + } + if (writeEndOfLines) + { + WriteLine(); + } + } + } + return this; + } + } +} \ No newline at end of file diff --git a/src/Markdig/Renderers/Normalize/QuoteBlockRenderer.cs b/src/Markdig/Renderers/Normalize/QuoteBlockRenderer.cs new file mode 100644 index 00000000..bd4329fe --- /dev/null +++ b/src/Markdig/Renderers/Normalize/QuoteBlockRenderer.cs @@ -0,0 +1,21 @@ +// Copyright (c) Alexandre Mutel. All rights reserved. +// This file is licensed under the BSD-Clause 2 license. +// See the license.txt file in the project root for more information. +using Markdig.Syntax; + +namespace Markdig.Renderers.Normalize +{ + /// + /// A Normalize renderer for a . + /// + /// + public class QuoteBlockRenderer : NormalizeObjectRenderer + { + protected override void Write(NormalizeRenderer renderer, QuoteBlock obj) + { + renderer.PushIndent(obj.QuoteChar + " "); + renderer.WriteChildren(obj); + renderer.PopIndent(); + } + } +} \ No newline at end of file diff --git a/src/Markdig/Renderers/TextRendererBase.cs b/src/Markdig/Renderers/TextRendererBase.cs index b4ac3649..8c24758b 100644 --- a/src/Markdig/Renderers/TextRendererBase.cs +++ b/src/Markdig/Renderers/TextRendererBase.cs @@ -2,6 +2,7 @@ // This file is licensed under the BSD-Clause 2 license. // See the license.txt file in the project root for more information. using System; +using System.Collections.Generic; using System.IO; using System.Runtime.CompilerServices; using Markdig.Helpers; @@ -70,6 +71,7 @@ namespace Markdig.Renderers { private bool previousWasLine; private char[] buffer; + private readonly List indents; /// /// Initializes a new instance of the class. @@ -80,6 +82,7 @@ namespace Markdig.Renderers buffer = new char[1024]; // We assume that we are starting as if we had previously a newline previousWasLine = true; + indents = new List(); } /// @@ -95,6 +98,31 @@ namespace Markdig.Renderers return (T)this; } + public void PushIndent(string indent) + { + if (indent == null) throw new ArgumentNullException(nameof(indent)); + indents.Add(indent); + } + + public void PopIndent() + { + // TODO: Check + indents.RemoveAt(indents.Count - 1); + } + + private void WriteIndent() + { + if (previousWasLine) + { + previousWasLine = false; + for (int i = 0; i < indents.Count; i++) + { + Writer.Write(indents[i]); + } + } + } + + /// /// Writes the specified content. /// @@ -103,6 +131,7 @@ namespace Markdig.Renderers [MethodImpl(MethodImplOptionPortable.AggressiveInlining)] public T Write(string content) { + WriteIndent(); previousWasLine = false; Writer.Write(content); return (T) this; @@ -142,6 +171,7 @@ namespace Markdig.Renderers [MethodImpl(MethodImplOptionPortable.AggressiveInlining)] public T Write(char content) { + WriteIndent(); previousWasLine = content == '\n'; Writer.Write(content); return (T) this; @@ -161,6 +191,7 @@ namespace Markdig.Renderers return (T) this; } + WriteIndent(); previousWasLine = false; if (offset == 0 && content.Length == length) { @@ -189,6 +220,7 @@ namespace Markdig.Renderers [MethodImpl(MethodImplOptionPortable.AggressiveInlining)] public T WriteLine() { + WriteIndent(); Writer.WriteLine(); previousWasLine = true; return (T) this; @@ -202,6 +234,7 @@ namespace Markdig.Renderers [MethodImpl(MethodImplOptionPortable.AggressiveInlining)] public T WriteLine(string content) { + WriteIndent(); previousWasLine = true; Writer.WriteLine(content); return (T) this; From 6ac2429e2a237a09b683b899abc6a79fbc789078 Mon Sep 17 00:00:00 2001 From: Alexandre Mutel Date: Tue, 28 Jun 2016 23:37:52 +0900 Subject: [PATCH 02/14] Add normalize renderers for core CommonMark components (wip #17) --- src/Markdig.Tests/Markdig.Tests.csproj | 1 + src/Markdig.Tests/TestNormalize.cs | 121 +++++++ src/Markdig/Markdown.cs | 37 ++ src/Markdig/Parsers/ThematicBreakParser.cs | 4 +- .../Renderers/Normalize/CodeBlockRenderer.cs | 4 +- .../Renderers/Normalize/HeadingRenderer.cs | 2 +- .../Inlines/AutolinkInlineRenderer.cs | 19 ++ .../Normalize/Inlines/CodeInlineRenderer.cs | 21 ++ .../Inlines/DelimiterInlineRenderer.cs | 20 ++ .../Inlines/EmphasisInlineRenderer.cs | 22 ++ .../Inlines/LineBreakInlineRenderer.cs | 25 ++ .../Normalize/Inlines/LinkInlineRenderer.cs | 38 +++ .../Inlines/LiteralInlineRenderer.cs | 19 ++ .../NormalizeHtmlEntityInlineRenderer.cs | 18 + .../Inlines/NormalizeHtmlInlineRenderer.cs | 18 + .../Renderers/Normalize/ListRenderer.cs | 73 ++++ .../Renderers/Normalize/NormalizeRenderer.cs | 320 ++++-------------- .../Renderers/Normalize/ParagraphRenderer.cs | 21 ++ .../Normalize/ThematicBreakRenderer.cs | 19 ++ src/Markdig/Syntax/ThematicBreakBlock.cs | 4 + 20 files changed, 553 insertions(+), 253 deletions(-) create mode 100644 src/Markdig.Tests/TestNormalize.cs create mode 100644 src/Markdig/Renderers/Normalize/Inlines/AutolinkInlineRenderer.cs create mode 100644 src/Markdig/Renderers/Normalize/Inlines/CodeInlineRenderer.cs create mode 100644 src/Markdig/Renderers/Normalize/Inlines/DelimiterInlineRenderer.cs create mode 100644 src/Markdig/Renderers/Normalize/Inlines/EmphasisInlineRenderer.cs create mode 100644 src/Markdig/Renderers/Normalize/Inlines/LineBreakInlineRenderer.cs create mode 100644 src/Markdig/Renderers/Normalize/Inlines/LinkInlineRenderer.cs create mode 100644 src/Markdig/Renderers/Normalize/Inlines/LiteralInlineRenderer.cs create mode 100644 src/Markdig/Renderers/Normalize/Inlines/NormalizeHtmlEntityInlineRenderer.cs create mode 100644 src/Markdig/Renderers/Normalize/Inlines/NormalizeHtmlInlineRenderer.cs create mode 100644 src/Markdig/Renderers/Normalize/ListRenderer.cs create mode 100644 src/Markdig/Renderers/Normalize/ParagraphRenderer.cs create mode 100644 src/Markdig/Renderers/Normalize/ThematicBreakRenderer.cs diff --git a/src/Markdig.Tests/Markdig.Tests.csproj b/src/Markdig.Tests/Markdig.Tests.csproj index 412202bb..287acd6e 100644 --- a/src/Markdig.Tests/Markdig.Tests.csproj +++ b/src/Markdig.Tests/Markdig.Tests.csproj @@ -64,6 +64,7 @@ + diff --git a/src/Markdig.Tests/TestNormalize.cs b/src/Markdig.Tests/TestNormalize.cs new file mode 100644 index 00000000..269c7467 --- /dev/null +++ b/src/Markdig.Tests/TestNormalize.cs @@ -0,0 +1,121 @@ +// Copyright (c) Alexandre Mutel. All rights reserved. +// This file is licensed under the BSD-Clause 2 license. +// See the license.txt file in the project root for more information. + +using System; +using NUnit.Framework; + +namespace Markdig.Tests +{ + [TestFixture] + public class TestNormalize + { + + [Test] + public void TestParagraph() + { + AssertNormalize("This is a plain paragraph"); + AssertNormalize(@"This +is +a +plain +paragraph"); + } + + [Test] + public void TestParagraphMulti() + { + AssertNormalize(@"line1 + +line2 + +line3"); + } + + [Test] + public void TestListUnordered() + { + AssertNormalize(@" +- a +- b +- c +"); + } + + [Test] + public void TestListOrdered() + { + AssertNormalize(@" +1. a +2. b +3. c +"); + } + + [Test] + public void TestHeaderAndParagraph() + { + AssertNormalize(@" +# heading + +paragraph +"); + } + + + [Test] + public void TestQuote() + { + AssertNormalize(@" +> test1 +> +> test2 +"); + } + + + [Test] + public void TestEmphasis() + { + AssertNormalize("This is a plain **paragraph**"); + AssertNormalize("This is a plain *paragraph*"); + AssertNormalize("This is a plain _paragraph_"); + AssertNormalize("This is a plain __paragraph__"); + AssertNormalize("This is a pl*ai*n **paragraph**"); + } + + [Test] + public void TestLinks() + { + AssertNormalize("This is a [link](http://company.com)"); + AssertNormalize("This is an ![image](http://company.com)"); + } + + + public void AssertNormalize(string input, string expected = null) + { + expected = expected ?? input; + input = NormText(input); + expected = NormText(expected); + + var result = Markdown.Normalize(input); + result = NormText(result); + + Console.WriteLine("```````````````````Source"); + Console.WriteLine(TestParser.DisplaySpaceAndTabs(input)); + Console.WriteLine("```````````````````Result"); + Console.WriteLine(TestParser.DisplaySpaceAndTabs(result)); + Console.WriteLine("```````````````````Expected"); + Console.WriteLine(TestParser.DisplaySpaceAndTabs(expected)); + Console.WriteLine("```````````````````"); + Console.WriteLine(); + + TextAssert.AreEqual(expected, result); + } + + private static string NormText(string text) + { + return text.Trim().Replace("\r\n", "\n").Replace('\r', '\n'); + } + } +} \ No newline at end of file diff --git a/src/Markdig/Markdown.cs b/src/Markdig/Markdown.cs index ae030995..fc754313 100644 --- a/src/Markdig/Markdown.cs +++ b/src/Markdig/Markdown.cs @@ -6,6 +6,7 @@ using System.IO; using Markdig.Extensions.SelfPipeline; using Markdig.Parsers; using Markdig.Renderers; +using Markdig.Renderers.Normalize; using Markdig.Syntax; namespace Markdig @@ -15,6 +16,42 @@ namespace Markdig /// public static partial class Markdown { + /// + /// Normalizes the specified markdown to a normalized markdown text. + /// + /// The markdown. + /// The pipeline. + /// A normalized markdown text. + public static string Normalize(string markdown, MarkdownPipeline pipeline = null) + { + var writer = new StringWriter(); + Normalize(markdown, writer, pipeline); + return writer.ToString(); + } + + /// + /// Normalizes the specified markdown to a normalized markdown text. + /// + /// The markdown. + /// The destination that will receive the result of the conversion. + /// The pipeline. + /// A normalized markdown text. + public static MarkdownDocument Normalize(string markdown, TextWriter writer, MarkdownPipeline pipeline = null) + { + pipeline = pipeline ?? new MarkdownPipelineBuilder().Build(); + pipeline = CheckForSelfPipeline(pipeline, markdown); + + // We override the renderer with our own writer + var renderer = new NormalizeRenderer(writer); + pipeline.Setup(renderer); + + var document = Parse(markdown, pipeline); + renderer.Render(document); + writer.Flush(); + + return document; + } + /// /// Converts a Markdown string to HTML. /// diff --git a/src/Markdig/Parsers/ThematicBreakParser.cs b/src/Markdig/Parsers/ThematicBreakParser.cs index b29c7cb0..d55fbf11 100644 --- a/src/Markdig/Parsers/ThematicBreakParser.cs +++ b/src/Markdig/Parsers/ThematicBreakParser.cs @@ -88,7 +88,9 @@ namespace Markdig.Parsers processor.NewBlocks.Push(new ThematicBreakBlock(this) { Column = processor.Column, - Span = new SourceSpan(startPosition, line.End) + Span = new SourceSpan(startPosition, line.End), + ThematicChar = breakChar, + ThematicCharCount = breakCharCount }); return BlockState.BreakDiscard; } diff --git a/src/Markdig/Renderers/Normalize/CodeBlockRenderer.cs b/src/Markdig/Renderers/Normalize/CodeBlockRenderer.cs index 4dce78cc..c7ab8f60 100644 --- a/src/Markdig/Renderers/Normalize/CodeBlockRenderer.cs +++ b/src/Markdig/Renderers/Normalize/CodeBlockRenderer.cs @@ -39,12 +39,12 @@ namespace Markdig.Renderers.Normalize } renderer.WriteLine(); - renderer.WriteLeafRawLines(obj, true, false); + renderer.WriteLeafRawLines(obj, true); renderer.WriteLine(opening); } else { - renderer.WriteLeafRawLines(obj, true, false, true); + renderer.WriteLeafRawLines(obj, true, true); renderer.WriteLine(); } } diff --git a/src/Markdig/Renderers/Normalize/HeadingRenderer.cs b/src/Markdig/Renderers/Normalize/HeadingRenderer.cs index 9554eb7a..ee7c91d3 100644 --- a/src/Markdig/Renderers/Normalize/HeadingRenderer.cs +++ b/src/Markdig/Renderers/Normalize/HeadingRenderer.cs @@ -29,7 +29,7 @@ namespace Markdig.Renderers.Normalize renderer.Write(headingText).Write(' '); renderer.WriteLeafInline(obj); - renderer.WriteLine(); + renderer.WriteLine().WriteLine(); } } } \ No newline at end of file diff --git a/src/Markdig/Renderers/Normalize/Inlines/AutolinkInlineRenderer.cs b/src/Markdig/Renderers/Normalize/Inlines/AutolinkInlineRenderer.cs new file mode 100644 index 00000000..6dede810 --- /dev/null +++ b/src/Markdig/Renderers/Normalize/Inlines/AutolinkInlineRenderer.cs @@ -0,0 +1,19 @@ +// Copyright (c) Alexandre Mutel. All rights reserved. +// This file is licensed under the BSD-Clause 2 license. +// See the license.txt file in the project root for more information. +using Markdig.Syntax.Inlines; + +namespace Markdig.Renderers.Normalize.Inlines +{ + /// + /// A Normalize renderer for an . + /// + /// + public class AutolinkInlineRenderer : NormalizeObjectRenderer + { + protected override void Write(NormalizeRenderer renderer, AutolinkInline obj) + { + renderer.Write('<').Write(obj.Url).Write('>'); + } + } +} \ No newline at end of file diff --git a/src/Markdig/Renderers/Normalize/Inlines/CodeInlineRenderer.cs b/src/Markdig/Renderers/Normalize/Inlines/CodeInlineRenderer.cs new file mode 100644 index 00000000..7eace1e4 --- /dev/null +++ b/src/Markdig/Renderers/Normalize/Inlines/CodeInlineRenderer.cs @@ -0,0 +1,21 @@ +// Copyright (c) Alexandre Mutel. All rights reserved. +// This file is licensed under the BSD-Clause 2 license. +// See the license.txt file in the project root for more information. +using Markdig.Syntax.Inlines; + +namespace Markdig.Renderers.Normalize.Inlines +{ + /// + /// A Normalize renderer for a . + /// + /// + public class CodeInlineRenderer : NormalizeObjectRenderer + { + protected override void Write(NormalizeRenderer renderer, CodeInline obj) + { + renderer.Write(obj.Delimiter); + renderer.Write(obj.Content); // TODO: escape ` + renderer.Write(obj.Delimiter); + } + } +} \ No newline at end of file diff --git a/src/Markdig/Renderers/Normalize/Inlines/DelimiterInlineRenderer.cs b/src/Markdig/Renderers/Normalize/Inlines/DelimiterInlineRenderer.cs new file mode 100644 index 00000000..54709ea4 --- /dev/null +++ b/src/Markdig/Renderers/Normalize/Inlines/DelimiterInlineRenderer.cs @@ -0,0 +1,20 @@ +// Copyright (c) Alexandre Mutel. All rights reserved. +// This file is licensed under the BSD-Clause 2 license. +// See the license.txt file in the project root for more information. +using Markdig.Syntax.Inlines; + +namespace Markdig.Renderers.Normalize.Inlines +{ + /// + /// A Normalize renderer for a . + /// + /// + public class DelimiterInlineRenderer : NormalizeObjectRenderer + { + protected override void Write(NormalizeRenderer renderer, DelimiterInline obj) + { + renderer.Write(obj.ToLiteral()); + renderer.WriteChildren(obj); + } + } +} \ No newline at end of file diff --git a/src/Markdig/Renderers/Normalize/Inlines/EmphasisInlineRenderer.cs b/src/Markdig/Renderers/Normalize/Inlines/EmphasisInlineRenderer.cs new file mode 100644 index 00000000..36633f99 --- /dev/null +++ b/src/Markdig/Renderers/Normalize/Inlines/EmphasisInlineRenderer.cs @@ -0,0 +1,22 @@ +// Copyright (c) Alexandre Mutel. All rights reserved. +// This file is licensed under the BSD-Clause 2 license. +// See the license.txt file in the project root for more information. +using Markdig.Syntax.Inlines; + +namespace Markdig.Renderers.Normalize.Inlines +{ + /// + /// A Normalize renderer for an . + /// + /// + public class EmphasisInlineRenderer : NormalizeObjectRenderer + { + protected override void Write(NormalizeRenderer renderer, EmphasisInline obj) + { + var emphasisText = new string(obj.DelimiterChar, obj.IsDouble ? 2 : 1); + renderer.Write(emphasisText); + renderer.WriteChildren(obj); + renderer.Write(emphasisText); + } + } +} \ No newline at end of file diff --git a/src/Markdig/Renderers/Normalize/Inlines/LineBreakInlineRenderer.cs b/src/Markdig/Renderers/Normalize/Inlines/LineBreakInlineRenderer.cs new file mode 100644 index 00000000..4cdad0fe --- /dev/null +++ b/src/Markdig/Renderers/Normalize/Inlines/LineBreakInlineRenderer.cs @@ -0,0 +1,25 @@ +// Copyright (c) Alexandre Mutel. All rights reserved. +// This file is licensed under the BSD-Clause 2 license. +// See the license.txt file in the project root for more information. +using Markdig.Syntax.Inlines; + +namespace Markdig.Renderers.Normalize.Inlines +{ + /// + /// A Normalize renderer for a . + /// + /// + public class LineBreakInlineRenderer : NormalizeObjectRenderer + { + /// + /// Gets or sets a value indicating whether to render this softline break as a Normalize hardline break tag (<br />) + /// + public bool RenderAsHardlineBreak { get; set; } + + protected override void Write(NormalizeRenderer renderer, LineBreakInline obj) + { + // TODO: handle hard + renderer.WriteLine(); + } + } +} \ No newline at end of file diff --git a/src/Markdig/Renderers/Normalize/Inlines/LinkInlineRenderer.cs b/src/Markdig/Renderers/Normalize/Inlines/LinkInlineRenderer.cs new file mode 100644 index 00000000..a2dddac8 --- /dev/null +++ b/src/Markdig/Renderers/Normalize/Inlines/LinkInlineRenderer.cs @@ -0,0 +1,38 @@ +// Copyright (c) Alexandre Mutel. All rights reserved. +// This file is licensed under the BSD-Clause 2 license. +// See the license.txt file in the project root for more information. +using Markdig.Syntax.Inlines; + +namespace Markdig.Renderers.Normalize.Inlines +{ + /// + /// A Normalize renderer for a . + /// + /// + public class LinkInlineRenderer : NormalizeObjectRenderer + { + protected override void Write(NormalizeRenderer renderer, LinkInline link) + { + if (link.IsImage) + { + renderer.Write('!'); + } + renderer.Write('['); + renderer.WriteChildren(link); + renderer.Write(']'); + if (!string.IsNullOrEmpty(link.Url)) + { + renderer.Write('(').Write(link.Url); + + if (!string.IsNullOrEmpty(link.Title)) + { + renderer.Write(" \""); + renderer.Write(link.Title); // TODO: escape " + renderer.Write("\""); + } + + renderer.Write(')'); + } + } + } +} \ No newline at end of file diff --git a/src/Markdig/Renderers/Normalize/Inlines/LiteralInlineRenderer.cs b/src/Markdig/Renderers/Normalize/Inlines/LiteralInlineRenderer.cs new file mode 100644 index 00000000..3b4e410f --- /dev/null +++ b/src/Markdig/Renderers/Normalize/Inlines/LiteralInlineRenderer.cs @@ -0,0 +1,19 @@ +// Copyright (c) Alexandre Mutel. All rights reserved. +// This file is licensed under the BSD-Clause 2 license. +// See the license.txt file in the project root for more information. +using Markdig.Syntax.Inlines; + +namespace Markdig.Renderers.Normalize.Inlines +{ + /// + /// A Normalize renderer for a . + /// + /// + public class LiteralInlineRenderer : NormalizeObjectRenderer + { + protected override void Write(NormalizeRenderer renderer, LiteralInline obj) + { + renderer.Write(ref obj.Content); + } + } +} \ No newline at end of file diff --git a/src/Markdig/Renderers/Normalize/Inlines/NormalizeHtmlEntityInlineRenderer.cs b/src/Markdig/Renderers/Normalize/Inlines/NormalizeHtmlEntityInlineRenderer.cs new file mode 100644 index 00000000..2d7883c7 --- /dev/null +++ b/src/Markdig/Renderers/Normalize/Inlines/NormalizeHtmlEntityInlineRenderer.cs @@ -0,0 +1,18 @@ +// Copyright (c) Alexandre Mutel. All rights reserved. +// This file is licensed under the BSD-Clause 2 license. +// See the license.txt file in the project root for more information. +using Markdig.Syntax.Inlines; + +namespace Markdig.Renderers.Normalize.Inlines +{ + /// + /// A Normalize renderer for a . + /// + public class NormalizeHtmlEntityInlineRenderer : NormalizeObjectRenderer + { + protected override void Write(NormalizeRenderer renderer, HtmlEntityInline obj) + { + renderer.Write(obj.Transcoded); + } + } +} \ No newline at end of file diff --git a/src/Markdig/Renderers/Normalize/Inlines/NormalizeHtmlInlineRenderer.cs b/src/Markdig/Renderers/Normalize/Inlines/NormalizeHtmlInlineRenderer.cs new file mode 100644 index 00000000..33bc8536 --- /dev/null +++ b/src/Markdig/Renderers/Normalize/Inlines/NormalizeHtmlInlineRenderer.cs @@ -0,0 +1,18 @@ +// Copyright (c) Alexandre Mutel. All rights reserved. +// This file is licensed under the BSD-Clause 2 license. +// See the license.txt file in the project root for more information. +using Markdig.Syntax.Inlines; + +namespace Markdig.Renderers.Normalize.Inlines +{ + /// + /// A Normalize renderer for a . + /// + public class NormalizeHtmlInlineRenderer : NormalizeObjectRenderer + { + protected override void Write(NormalizeRenderer renderer, HtmlInline obj) + { + renderer.Write(obj.Tag); + } + } +} \ No newline at end of file diff --git a/src/Markdig/Renderers/Normalize/ListRenderer.cs b/src/Markdig/Renderers/Normalize/ListRenderer.cs new file mode 100644 index 00000000..bf204740 --- /dev/null +++ b/src/Markdig/Renderers/Normalize/ListRenderer.cs @@ -0,0 +1,73 @@ +// Copyright (c) Alexandre Mutel. All rights reserved. +// This file is licensed under the BSD-Clause 2 license. +// See the license.txt file in the project root for more information. +using System.Globalization; +using Markdig.Syntax; + +namespace Markdig.Renderers.Normalize +{ + /// + /// A Normalize renderer for a . + /// + /// + public class ListRenderer : NormalizeObjectRenderer + { + protected override void Write(NormalizeRenderer renderer, ListBlock listBlock) + { + renderer.EnsureLine(); + if (listBlock.IsOrdered) + { + int index = 0; + if (listBlock.OrderedStart != null) + { + switch (listBlock.BulletType) + { + case '1': + int.TryParse(listBlock.OrderedStart, out index); + break; + } + } + foreach (var item in listBlock) + { + var listItem = (ListItemBlock)item; + renderer.EnsureLine(); + + renderer.Write(index + ""); + renderer.Write(listBlock.OrderedDelimiter); + renderer.Write(' '); + renderer.PushIndent(" "); // TODO: output accurate indent + renderer.WriteChildren(listItem); + renderer.PopIndent(); + if (!listBlock.IsLoose) + { + renderer.WriteLine(); + } + + switch (listBlock.BulletType) + { + case '1': + index++; + break; + } + } + } + else + { + foreach (var item in listBlock) + { + var listItem = (ListItemBlock)item; + renderer.EnsureLine(); + renderer.Write("- "); + renderer.PushIndent(" "); + renderer.WriteChildren(listItem); + renderer.PopIndent(); + if (!listBlock.IsLoose) + { + renderer.WriteLine(); + } + } + } + renderer.WriteLine(); + } + } +} \ No newline at end of file diff --git a/src/Markdig/Renderers/Normalize/NormalizeRenderer.cs b/src/Markdig/Renderers/Normalize/NormalizeRenderer.cs index 6b79d028..585ad7f0 100644 --- a/src/Markdig/Renderers/Normalize/NormalizeRenderer.cs +++ b/src/Markdig/Renderers/Normalize/NormalizeRenderer.cs @@ -9,6 +9,7 @@ using System.Text; using Markdig.Helpers; using Markdig.Renderers.Html; using Markdig.Syntax; +using Markdig.Renderers.Normalize.Inlines; namespace Markdig.Renderers.Normalize { @@ -26,265 +27,92 @@ namespace Markdig.Renderers.Normalize { // Default block renderers ObjectRenderers.Add(new CodeBlockRenderer()); - //ObjectRenderers.Add(new ListRenderer()); + ObjectRenderers.Add(new ListRenderer()); ObjectRenderers.Add(new HeadingRenderer()); - //ObjectRenderers.Add(new HtmlBlockRenderer()); - //ObjectRenderers.Add(new ParagraphRenderer()); + ObjectRenderers.Add(new HtmlBlockRenderer()); + ObjectRenderers.Add(new ParagraphRenderer()); ObjectRenderers.Add(new QuoteBlockRenderer()); - //ObjectRenderers.Add(new ThematicBreakRenderer()); + ObjectRenderers.Add(new ThematicBreakRenderer()); // Default inline renderers - //ObjectRenderers.Add(new AutolinkInlineRenderer()); - //ObjectRenderers.Add(new CodeInlineRenderer()); - //ObjectRenderers.Add(new DelimiterInlineRenderer()); - //ObjectRenderers.Add(new EmphasisInlineRenderer()); - //ObjectRenderers.Add(new LineBreakInlineRenderer()); - //ObjectRenderers.Add(new HtmlInlineRenderer()); - //ObjectRenderers.Add(new HtmlEntityInlineRenderer()); - //ObjectRenderers.Add(new LinkInlineRenderer()); - //ObjectRenderers.Add(new LiteralInlineRenderer()); - - EnableHtmlForInline = true; - EnableHtmlEscape = true; + ObjectRenderers.Add(new AutolinkInlineRenderer()); + ObjectRenderers.Add(new CodeInlineRenderer()); + ObjectRenderers.Add(new DelimiterInlineRenderer()); + ObjectRenderers.Add(new EmphasisInlineRenderer()); + ObjectRenderers.Add(new LineBreakInlineRenderer()); + ObjectRenderers.Add(new NormalizeHtmlInlineRenderer()); + ObjectRenderers.Add(new NormalizeHtmlEntityInlineRenderer()); + ObjectRenderers.Add(new LinkInlineRenderer()); + ObjectRenderers.Add(new LiteralInlineRenderer()); } - /// - /// Gets or sets a value indicating whether to ouput HTML tags when rendering. See remarks. - /// - /// - /// This is used by some renderers to disable HTML tags when rendering some inlines (for image links). - /// - public bool EnableHtmlForInline { get; set; } + ///// + ///// Writes the attached on the specified . + ///// + ///// The object. + ///// + //public NormalizeRenderer WriteAttributes(MarkdownObject obj) + //{ + // if (obj == null) throw new ArgumentNullException(nameof(obj)); + // return WriteAttributes(obj.TryGetAttributes()); + //} - public bool EnableHtmlEscape { get; set; } + ///// + ///// Writes the specified . + ///// + ///// The attributes to render. + ///// This instance + //public NormalizeRenderer WriteAttributes(HtmlAttributes attributes) + //{ + // if (attributes == null) + // { + // return this; + // } - /// - /// Gets or sets a value indicating whether to use implicit paragraph (optional <p>) - /// - public bool ImplicitParagraph { get; set; } + // if (attributes.Id != null) + // { + // Write(" id=\"").WriteEscape(attributes.Id).Write("\""); + // } - /// - /// Writes the content escaped for HTML. - /// - /// The content. - /// This instance - [MethodImpl(MethodImplOptionPortable.AggressiveInlining)] - public NormalizeRenderer WriteEscape(string content) - { - if (string.IsNullOrEmpty(content)) - return this; + // if (attributes.Classes != null && attributes.Classes.Count > 0) + // { + // Write(" class=\""); + // for (int i = 0; i < attributes.Classes.Count; i++) + // { + // var cssClass = attributes.Classes[i]; + // if (i > 0) + // { + // Write(" "); + // } + // WriteEscape(cssClass); + // } + // Write("\""); + // } - WriteEscape(content, 0, content.Length); - return this; - } + // if (attributes.Properties != null && attributes.Properties.Count > 0) + // { + // foreach (var property in attributes.Properties) + // { + // Write(" ").Write(property.Key); + // if (property.Value != null) + // { + // Write("=").Write("\""); + // WriteEscape(property.Value); + // Write("\""); + // } + // } + // } - /// - /// Writes the content escaped for HTML. - /// - /// The slice. - /// This instance - [MethodImpl(MethodImplOptionPortable.AggressiveInlining)] - public NormalizeRenderer WriteEscape(ref StringSlice slice) - { - if (slice.Start > slice.End) - { - return this; - } - return WriteEscape(slice.Text, slice.Start, slice.Length); - } - - /// - /// Writes the content escaped for HTML. - /// - /// The slice. - /// This instance - [MethodImpl(MethodImplOptionPortable.AggressiveInlining)] - public NormalizeRenderer WriteEscape(StringSlice slice) - { - return WriteEscape(ref slice); - } - - /// - /// Writes the content escaped for HTML. - /// - /// The content. - /// The offset. - /// The length. - /// This instance - public NormalizeRenderer WriteEscape(string content, int offset, int length) - { - if (string.IsNullOrEmpty(content) || length == 0) - return this; - - var end = offset + length; - int previousOffset = offset; - for (;offset < end; offset++) - { - switch (content[offset]) - { - case '<': - Write(content, previousOffset, offset - previousOffset); - if (EnableHtmlEscape) - { - Write("<"); - } - previousOffset = offset + 1; - break; - case '>': - Write(content, previousOffset, offset - previousOffset); - if (EnableHtmlEscape) - { - Write(">"); - } - previousOffset = offset + 1; - break; - case '&': - Write(content, previousOffset, offset - previousOffset); - if (EnableHtmlEscape) - { - Write("&"); - } - previousOffset = offset + 1; - break; - case '"': - Write(content, previousOffset, offset - previousOffset); - if (EnableHtmlEscape) - { - Write("""); - } - previousOffset = offset + 1; - break; - } - } - - Write(content, previousOffset, end - previousOffset); - return this; - } - - /// - /// Writes the URL escaped for HTML. - /// - /// The content. - /// This instance - public NormalizeRenderer WriteEscapeUrl(string content) - { - if (content == null) - return this; - - int previousPosition = 0; - int length = content.Length; - - for (var i = 0; i < length; i++) - { - var c = content[i]; - - if (c < 128) - { - var escape = HtmlHelper.EscapeUrlCharacter(c); - if (escape != null) - { - Write(content, previousPosition, i - previousPosition); - previousPosition = i + 1; - Write(escape); - } - } - else - { - Write(content, previousPosition, i - previousPosition); - previousPosition = i + 1; - - byte[] bytes; - if (c >= '\ud800' && c <= '\udfff' && previousPosition < length) - { - bytes = Encoding.UTF8.GetBytes(new[] { c, content[previousPosition] }); - // Skip next char as it is decoded above - i++; - previousPosition = i + 1; - } - else - { - bytes = Encoding.UTF8.GetBytes(new[] { c }); - } - - for (var j = 0; j < bytes.Length; j++) - { - Write($"%{bytes[j]:X2}"); - } - } - } - - Write(content, previousPosition, length - previousPosition); - return this; - } - - /// - /// Writes the attached on the specified . - /// - /// The object. - /// - public NormalizeRenderer WriteAttributes(MarkdownObject obj) - { - if (obj == null) throw new ArgumentNullException(nameof(obj)); - return WriteAttributes(obj.TryGetAttributes()); - } - - /// - /// Writes the specified . - /// - /// The attributes to render. - /// This instance - public NormalizeRenderer WriteAttributes(HtmlAttributes attributes) - { - if (attributes == null) - { - return this; - } - - if (attributes.Id != null) - { - Write(" id=\"").WriteEscape(attributes.Id).Write("\""); - } - - if (attributes.Classes != null && attributes.Classes.Count > 0) - { - Write(" class=\""); - for (int i = 0; i < attributes.Classes.Count; i++) - { - var cssClass = attributes.Classes[i]; - if (i > 0) - { - Write(" "); - } - WriteEscape(cssClass); - } - Write("\""); - } - - if (attributes.Properties != null && attributes.Properties.Count > 0) - { - foreach (var property in attributes.Properties) - { - Write(" ").Write(property.Key); - if (property.Value != null) - { - Write("=").Write("\""); - WriteEscape(property.Value); - Write("\""); - } - } - } - - return this; - } + // return this; + //} /// /// Writes the lines of a /// /// The leaf block. /// if set to true write end of lines. - /// if set to true escape the content for HTML /// This instance - public NormalizeRenderer WriteLeafRawLines(LeafBlock leafBlock, bool writeEndOfLines, bool escape, bool indent = false) + public NormalizeRenderer WriteLeafRawLines(LeafBlock leafBlock, bool writeEndOfLines, bool indent = false) { if (leafBlock == null) throw new ArgumentNullException(nameof(leafBlock)); if (leafBlock.Lines.Lines != null) @@ -303,14 +131,8 @@ namespace Markdig.Renderers.Normalize Write(" "); } - if (escape) - { - WriteEscape(ref slices[i].Slice); - } - else - { - Write(ref slices[i].Slice); - } + Write(ref slices[i].Slice); + if (writeEndOfLines) { WriteLine(); diff --git a/src/Markdig/Renderers/Normalize/ParagraphRenderer.cs b/src/Markdig/Renderers/Normalize/ParagraphRenderer.cs new file mode 100644 index 00000000..81d747d5 --- /dev/null +++ b/src/Markdig/Renderers/Normalize/ParagraphRenderer.cs @@ -0,0 +1,21 @@ +// Copyright (c) Alexandre Mutel. All rights reserved. +// This file is licensed under the BSD-Clause 2 license. +// See the license.txt file in the project root for more information. +using Markdig.Syntax; + +namespace Markdig.Renderers.Normalize +{ + /// + /// A Normalize renderer for a . + /// + /// + public class ParagraphRenderer : NormalizeObjectRenderer + { + protected override void Write(NormalizeRenderer renderer, ParagraphBlock obj) + { + renderer.EnsureLine(); + renderer.WriteLeafInline(obj); + renderer.WriteLine().WriteLine(); + } + } +} \ No newline at end of file diff --git a/src/Markdig/Renderers/Normalize/ThematicBreakRenderer.cs b/src/Markdig/Renderers/Normalize/ThematicBreakRenderer.cs new file mode 100644 index 00000000..2aa90c15 --- /dev/null +++ b/src/Markdig/Renderers/Normalize/ThematicBreakRenderer.cs @@ -0,0 +1,19 @@ +// Copyright (c) Alexandre Mutel. All rights reserved. +// This file is licensed under the BSD-Clause 2 license. +// See the license.txt file in the project root for more information. +using Markdig.Syntax; + +namespace Markdig.Renderers.Normalize +{ + /// + /// A Normalize renderer for a . + /// + /// + public class ThematicBreakRenderer : NormalizeObjectRenderer + { + protected override void Write(NormalizeRenderer renderer, ThematicBreakBlock obj) + { + renderer.WriteLine(new string(obj.ThematicChar, obj.ThematicCharCount)); + } + } +} \ No newline at end of file diff --git a/src/Markdig/Syntax/ThematicBreakBlock.cs b/src/Markdig/Syntax/ThematicBreakBlock.cs index ebf66bb1..c6839373 100644 --- a/src/Markdig/Syntax/ThematicBreakBlock.cs +++ b/src/Markdig/Syntax/ThematicBreakBlock.cs @@ -17,5 +17,9 @@ namespace Markdig.Syntax public ThematicBreakBlock(BlockParser parser) : base(parser) { } + + public char ThematicChar { get; set; } + + public int ThematicCharCount { get; set; } } } \ No newline at end of file From b20b1113855d30a6da0c9e9026fca453ae199b34 Mon Sep 17 00:00:00 2001 From: Alexandre Mutel Date: Tue, 28 Jun 2016 23:55:01 +0900 Subject: [PATCH 03/14] Try to workaround tight/loose lists and paragraphs (wip #17) --- src/Markdig.Tests/TestNormalize.cs | 2 +- src/Markdig/Renderers/Normalize/ListRenderer.cs | 13 ++++--------- .../Renderers/Normalize/NormalizeRenderer.cs | 2 ++ .../Renderers/Normalize/ParagraphRenderer.cs | 11 +++++++++-- 4 files changed, 16 insertions(+), 12 deletions(-) diff --git a/src/Markdig.Tests/TestNormalize.cs b/src/Markdig.Tests/TestNormalize.cs index 269c7467..fae3f763 100644 --- a/src/Markdig.Tests/TestNormalize.cs +++ b/src/Markdig.Tests/TestNormalize.cs @@ -68,7 +68,7 @@ paragraph { AssertNormalize(@" > test1 -> +> > test2 "); } diff --git a/src/Markdig/Renderers/Normalize/ListRenderer.cs b/src/Markdig/Renderers/Normalize/ListRenderer.cs index bf204740..a60c8cea 100644 --- a/src/Markdig/Renderers/Normalize/ListRenderer.cs +++ b/src/Markdig/Renderers/Normalize/ListRenderer.cs @@ -15,6 +15,8 @@ namespace Markdig.Renderers.Normalize protected override void Write(NormalizeRenderer renderer, ListBlock listBlock) { renderer.EnsureLine(); + var compact = renderer.CompactParagraph; + renderer.CompactParagraph = !listBlock.IsLoose; if (listBlock.IsOrdered) { int index = 0; @@ -38,11 +40,6 @@ namespace Markdig.Renderers.Normalize renderer.PushIndent(" "); // TODO: output accurate indent renderer.WriteChildren(listItem); renderer.PopIndent(); - if (!listBlock.IsLoose) - { - renderer.WriteLine(); - } - switch (listBlock.BulletType) { case '1': @@ -61,12 +58,10 @@ namespace Markdig.Renderers.Normalize renderer.PushIndent(" "); renderer.WriteChildren(listItem); renderer.PopIndent(); - if (!listBlock.IsLoose) - { - renderer.WriteLine(); - } } } + + renderer.CompactParagraph = compact; renderer.WriteLine(); } } diff --git a/src/Markdig/Renderers/Normalize/NormalizeRenderer.cs b/src/Markdig/Renderers/Normalize/NormalizeRenderer.cs index 585ad7f0..17d91189 100644 --- a/src/Markdig/Renderers/Normalize/NormalizeRenderer.cs +++ b/src/Markdig/Renderers/Normalize/NormalizeRenderer.cs @@ -46,6 +46,8 @@ namespace Markdig.Renderers.Normalize ObjectRenderers.Add(new LiteralInlineRenderer()); } + public bool CompactParagraph { get; set; } + ///// ///// Writes the attached on the specified . ///// diff --git a/src/Markdig/Renderers/Normalize/ParagraphRenderer.cs b/src/Markdig/Renderers/Normalize/ParagraphRenderer.cs index 81d747d5..755042a4 100644 --- a/src/Markdig/Renderers/Normalize/ParagraphRenderer.cs +++ b/src/Markdig/Renderers/Normalize/ParagraphRenderer.cs @@ -13,9 +13,16 @@ namespace Markdig.Renderers.Normalize { protected override void Write(NormalizeRenderer renderer, ParagraphBlock obj) { - renderer.EnsureLine(); + if (!renderer.CompactParagraph) + { + renderer.EnsureLine(); + } renderer.WriteLeafInline(obj); - renderer.WriteLine().WriteLine(); + if (!renderer.IsLastInContainer && !renderer.CompactParagraph) + { + renderer.WriteLine(); + renderer.WriteLine(); + } } } } \ No newline at end of file From d58db530bb5e95709c46625e0019da47ed49d608 Mon Sep 17 00:00:00 2001 From: Alexandre Mutel Date: Mon, 27 Jun 2016 22:25:32 +0900 Subject: [PATCH 04/14] wip normalize (issue #17) --- .../Renderers/Normalize/CodeBlockRenderer.cs | 52 +++ .../Renderers/Normalize/HeadingRenderer.cs | 35 ++ .../Normalize/NormalizeObjectRenderer.cs | 16 + .../Renderers/Normalize/NormalizeRenderer.cs | 323 ++++++++++++++++++ .../Renderers/Normalize/QuoteBlockRenderer.cs | 21 ++ src/Markdig/Renderers/TextRendererBase.cs | 33 ++ 6 files changed, 480 insertions(+) create mode 100644 src/Markdig/Renderers/Normalize/CodeBlockRenderer.cs create mode 100644 src/Markdig/Renderers/Normalize/HeadingRenderer.cs create mode 100644 src/Markdig/Renderers/Normalize/NormalizeObjectRenderer.cs create mode 100644 src/Markdig/Renderers/Normalize/NormalizeRenderer.cs create mode 100644 src/Markdig/Renderers/Normalize/QuoteBlockRenderer.cs diff --git a/src/Markdig/Renderers/Normalize/CodeBlockRenderer.cs b/src/Markdig/Renderers/Normalize/CodeBlockRenderer.cs new file mode 100644 index 00000000..4dce78cc --- /dev/null +++ b/src/Markdig/Renderers/Normalize/CodeBlockRenderer.cs @@ -0,0 +1,52 @@ +// Copyright (c) Alexandre Mutel. All rights reserved. +// This file is licensed under the BSD-Clause 2 license. +// See the license.txt file in the project root for more information. + +using Markdig.Renderers.Html; +using Markdig.Syntax; + +namespace Markdig.Renderers.Normalize +{ + /// + /// An Normalize renderer for a and . + /// + /// + public class CodeBlockRenderer : NormalizeObjectRenderer + { + public bool OutputAttributesOnPre { get; set; } + + protected override void Write(NormalizeRenderer renderer, CodeBlock obj) + { + var fencedCodeBlock = obj as FencedCodeBlock; + if (fencedCodeBlock != null) + { + var opening = new string(fencedCodeBlock.FencedChar, fencedCodeBlock.FencedCharCount); + renderer.Write(opening); + if (fencedCodeBlock.Info != null) + { + renderer.Write(fencedCodeBlock.Info); + } + if (fencedCodeBlock.Arguments != null) + { + renderer.Write(" ").Write(fencedCodeBlock.Arguments); + } + + var attributes = obj.TryGetAttributes(); + if (attributes != null) + { + renderer.Write(" "); + renderer.Write(attributes); + } + renderer.WriteLine(); + + renderer.WriteLeafRawLines(obj, true, false); + renderer.WriteLine(opening); + } + else + { + renderer.WriteLeafRawLines(obj, true, false, true); + renderer.WriteLine(); + } + } + } +} \ No newline at end of file diff --git a/src/Markdig/Renderers/Normalize/HeadingRenderer.cs b/src/Markdig/Renderers/Normalize/HeadingRenderer.cs new file mode 100644 index 00000000..9554eb7a --- /dev/null +++ b/src/Markdig/Renderers/Normalize/HeadingRenderer.cs @@ -0,0 +1,35 @@ +// Copyright (c) Alexandre Mutel. All rights reserved. +// This file is licensed under the BSD-Clause 2 license. +// See the license.txt file in the project root for more information. +using System.Globalization; +using Markdig.Syntax; + +namespace Markdig.Renderers.Normalize +{ + /// + /// An Normalize renderer for a . + /// + /// + public class HeadingRenderer : NormalizeObjectRenderer + { + private static readonly string[] HeadingTexts = { + "#", + "##", + "###", + "####", + "#####", + "######", + }; + + protected override void Write(NormalizeRenderer renderer, HeadingBlock obj) + { + var headingText = obj.Level > 0 && obj.Level <= 6 + ? HeadingTexts[obj.Level - 1] + : new string('#', obj.Level); + + renderer.Write(headingText).Write(' '); + renderer.WriteLeafInline(obj); + renderer.WriteLine(); + } + } +} \ No newline at end of file diff --git a/src/Markdig/Renderers/Normalize/NormalizeObjectRenderer.cs b/src/Markdig/Renderers/Normalize/NormalizeObjectRenderer.cs new file mode 100644 index 00000000..f24daef2 --- /dev/null +++ b/src/Markdig/Renderers/Normalize/NormalizeObjectRenderer.cs @@ -0,0 +1,16 @@ +// Copyright (c) Alexandre Mutel. All rights reserved. +// This file is licensed under the BSD-Clause 2 license. +// See the license.txt file in the project root for more information. +using Markdig.Syntax; + +namespace Markdig.Renderers.Normalize +{ + /// + /// A base class for Normalize rendering and Markdown objects. + /// + /// The type of the object. + /// + public abstract class NormalizeObjectRenderer : MarkdownObjectRenderer where TObject : MarkdownObject + { + } +} \ No newline at end of file diff --git a/src/Markdig/Renderers/Normalize/NormalizeRenderer.cs b/src/Markdig/Renderers/Normalize/NormalizeRenderer.cs new file mode 100644 index 00000000..6b79d028 --- /dev/null +++ b/src/Markdig/Renderers/Normalize/NormalizeRenderer.cs @@ -0,0 +1,323 @@ +// Copyright (c) Alexandre Mutel. All rights reserved. +// This file is licensed under the BSD-Clause 2 license. +// See the license.txt file in the project root for more information. + +using System; +using System.IO; +using System.Runtime.CompilerServices; +using System.Text; +using Markdig.Helpers; +using Markdig.Renderers.Html; +using Markdig.Syntax; + +namespace Markdig.Renderers.Normalize +{ + /// + /// Default HTML renderer for a Markdown object. + /// + /// + public class NormalizeRenderer : TextRendererBase + { + /// + /// Initializes a new instance of the class. + /// + /// The writer. + public NormalizeRenderer(TextWriter writer) : base(writer) + { + // Default block renderers + ObjectRenderers.Add(new CodeBlockRenderer()); + //ObjectRenderers.Add(new ListRenderer()); + ObjectRenderers.Add(new HeadingRenderer()); + //ObjectRenderers.Add(new HtmlBlockRenderer()); + //ObjectRenderers.Add(new ParagraphRenderer()); + ObjectRenderers.Add(new QuoteBlockRenderer()); + //ObjectRenderers.Add(new ThematicBreakRenderer()); + + // Default inline renderers + //ObjectRenderers.Add(new AutolinkInlineRenderer()); + //ObjectRenderers.Add(new CodeInlineRenderer()); + //ObjectRenderers.Add(new DelimiterInlineRenderer()); + //ObjectRenderers.Add(new EmphasisInlineRenderer()); + //ObjectRenderers.Add(new LineBreakInlineRenderer()); + //ObjectRenderers.Add(new HtmlInlineRenderer()); + //ObjectRenderers.Add(new HtmlEntityInlineRenderer()); + //ObjectRenderers.Add(new LinkInlineRenderer()); + //ObjectRenderers.Add(new LiteralInlineRenderer()); + + EnableHtmlForInline = true; + EnableHtmlEscape = true; + } + + /// + /// Gets or sets a value indicating whether to ouput HTML tags when rendering. See remarks. + /// + /// + /// This is used by some renderers to disable HTML tags when rendering some inlines (for image links). + /// + public bool EnableHtmlForInline { get; set; } + + public bool EnableHtmlEscape { get; set; } + + /// + /// Gets or sets a value indicating whether to use implicit paragraph (optional <p>) + /// + public bool ImplicitParagraph { get; set; } + + /// + /// Writes the content escaped for HTML. + /// + /// The content. + /// This instance + [MethodImpl(MethodImplOptionPortable.AggressiveInlining)] + public NormalizeRenderer WriteEscape(string content) + { + if (string.IsNullOrEmpty(content)) + return this; + + WriteEscape(content, 0, content.Length); + return this; + } + + /// + /// Writes the content escaped for HTML. + /// + /// The slice. + /// This instance + [MethodImpl(MethodImplOptionPortable.AggressiveInlining)] + public NormalizeRenderer WriteEscape(ref StringSlice slice) + { + if (slice.Start > slice.End) + { + return this; + } + return WriteEscape(slice.Text, slice.Start, slice.Length); + } + + /// + /// Writes the content escaped for HTML. + /// + /// The slice. + /// This instance + [MethodImpl(MethodImplOptionPortable.AggressiveInlining)] + public NormalizeRenderer WriteEscape(StringSlice slice) + { + return WriteEscape(ref slice); + } + + /// + /// Writes the content escaped for HTML. + /// + /// The content. + /// The offset. + /// The length. + /// This instance + public NormalizeRenderer WriteEscape(string content, int offset, int length) + { + if (string.IsNullOrEmpty(content) || length == 0) + return this; + + var end = offset + length; + int previousOffset = offset; + for (;offset < end; offset++) + { + switch (content[offset]) + { + case '<': + Write(content, previousOffset, offset - previousOffset); + if (EnableHtmlEscape) + { + Write("<"); + } + previousOffset = offset + 1; + break; + case '>': + Write(content, previousOffset, offset - previousOffset); + if (EnableHtmlEscape) + { + Write(">"); + } + previousOffset = offset + 1; + break; + case '&': + Write(content, previousOffset, offset - previousOffset); + if (EnableHtmlEscape) + { + Write("&"); + } + previousOffset = offset + 1; + break; + case '"': + Write(content, previousOffset, offset - previousOffset); + if (EnableHtmlEscape) + { + Write("""); + } + previousOffset = offset + 1; + break; + } + } + + Write(content, previousOffset, end - previousOffset); + return this; + } + + /// + /// Writes the URL escaped for HTML. + /// + /// The content. + /// This instance + public NormalizeRenderer WriteEscapeUrl(string content) + { + if (content == null) + return this; + + int previousPosition = 0; + int length = content.Length; + + for (var i = 0; i < length; i++) + { + var c = content[i]; + + if (c < 128) + { + var escape = HtmlHelper.EscapeUrlCharacter(c); + if (escape != null) + { + Write(content, previousPosition, i - previousPosition); + previousPosition = i + 1; + Write(escape); + } + } + else + { + Write(content, previousPosition, i - previousPosition); + previousPosition = i + 1; + + byte[] bytes; + if (c >= '\ud800' && c <= '\udfff' && previousPosition < length) + { + bytes = Encoding.UTF8.GetBytes(new[] { c, content[previousPosition] }); + // Skip next char as it is decoded above + i++; + previousPosition = i + 1; + } + else + { + bytes = Encoding.UTF8.GetBytes(new[] { c }); + } + + for (var j = 0; j < bytes.Length; j++) + { + Write($"%{bytes[j]:X2}"); + } + } + } + + Write(content, previousPosition, length - previousPosition); + return this; + } + + /// + /// Writes the attached on the specified . + /// + /// The object. + /// + public NormalizeRenderer WriteAttributes(MarkdownObject obj) + { + if (obj == null) throw new ArgumentNullException(nameof(obj)); + return WriteAttributes(obj.TryGetAttributes()); + } + + /// + /// Writes the specified . + /// + /// The attributes to render. + /// This instance + public NormalizeRenderer WriteAttributes(HtmlAttributes attributes) + { + if (attributes == null) + { + return this; + } + + if (attributes.Id != null) + { + Write(" id=\"").WriteEscape(attributes.Id).Write("\""); + } + + if (attributes.Classes != null && attributes.Classes.Count > 0) + { + Write(" class=\""); + for (int i = 0; i < attributes.Classes.Count; i++) + { + var cssClass = attributes.Classes[i]; + if (i > 0) + { + Write(" "); + } + WriteEscape(cssClass); + } + Write("\""); + } + + if (attributes.Properties != null && attributes.Properties.Count > 0) + { + foreach (var property in attributes.Properties) + { + Write(" ").Write(property.Key); + if (property.Value != null) + { + Write("=").Write("\""); + WriteEscape(property.Value); + Write("\""); + } + } + } + + return this; + } + + /// + /// Writes the lines of a + /// + /// The leaf block. + /// if set to true write end of lines. + /// if set to true escape the content for HTML + /// This instance + public NormalizeRenderer WriteLeafRawLines(LeafBlock leafBlock, bool writeEndOfLines, bool escape, bool indent = false) + { + if (leafBlock == null) throw new ArgumentNullException(nameof(leafBlock)); + if (leafBlock.Lines.Lines != null) + { + var lines = leafBlock.Lines; + var slices = lines.Lines; + for (int i = 0; i < lines.Count; i++) + { + if (!writeEndOfLines && i > 0) + { + WriteLine(); + } + + if (indent) + { + Write(" "); + } + + if (escape) + { + WriteEscape(ref slices[i].Slice); + } + else + { + Write(ref slices[i].Slice); + } + if (writeEndOfLines) + { + WriteLine(); + } + } + } + return this; + } + } +} \ No newline at end of file diff --git a/src/Markdig/Renderers/Normalize/QuoteBlockRenderer.cs b/src/Markdig/Renderers/Normalize/QuoteBlockRenderer.cs new file mode 100644 index 00000000..bd4329fe --- /dev/null +++ b/src/Markdig/Renderers/Normalize/QuoteBlockRenderer.cs @@ -0,0 +1,21 @@ +// Copyright (c) Alexandre Mutel. All rights reserved. +// This file is licensed under the BSD-Clause 2 license. +// See the license.txt file in the project root for more information. +using Markdig.Syntax; + +namespace Markdig.Renderers.Normalize +{ + /// + /// A Normalize renderer for a . + /// + /// + public class QuoteBlockRenderer : NormalizeObjectRenderer + { + protected override void Write(NormalizeRenderer renderer, QuoteBlock obj) + { + renderer.PushIndent(obj.QuoteChar + " "); + renderer.WriteChildren(obj); + renderer.PopIndent(); + } + } +} \ No newline at end of file diff --git a/src/Markdig/Renderers/TextRendererBase.cs b/src/Markdig/Renderers/TextRendererBase.cs index b4ac3649..8c24758b 100644 --- a/src/Markdig/Renderers/TextRendererBase.cs +++ b/src/Markdig/Renderers/TextRendererBase.cs @@ -2,6 +2,7 @@ // This file is licensed under the BSD-Clause 2 license. // See the license.txt file in the project root for more information. using System; +using System.Collections.Generic; using System.IO; using System.Runtime.CompilerServices; using Markdig.Helpers; @@ -70,6 +71,7 @@ namespace Markdig.Renderers { private bool previousWasLine; private char[] buffer; + private readonly List indents; /// /// Initializes a new instance of the class. @@ -80,6 +82,7 @@ namespace Markdig.Renderers buffer = new char[1024]; // We assume that we are starting as if we had previously a newline previousWasLine = true; + indents = new List(); } /// @@ -95,6 +98,31 @@ namespace Markdig.Renderers return (T)this; } + public void PushIndent(string indent) + { + if (indent == null) throw new ArgumentNullException(nameof(indent)); + indents.Add(indent); + } + + public void PopIndent() + { + // TODO: Check + indents.RemoveAt(indents.Count - 1); + } + + private void WriteIndent() + { + if (previousWasLine) + { + previousWasLine = false; + for (int i = 0; i < indents.Count; i++) + { + Writer.Write(indents[i]); + } + } + } + + /// /// Writes the specified content. /// @@ -103,6 +131,7 @@ namespace Markdig.Renderers [MethodImpl(MethodImplOptionPortable.AggressiveInlining)] public T Write(string content) { + WriteIndent(); previousWasLine = false; Writer.Write(content); return (T) this; @@ -142,6 +171,7 @@ namespace Markdig.Renderers [MethodImpl(MethodImplOptionPortable.AggressiveInlining)] public T Write(char content) { + WriteIndent(); previousWasLine = content == '\n'; Writer.Write(content); return (T) this; @@ -161,6 +191,7 @@ namespace Markdig.Renderers return (T) this; } + WriteIndent(); previousWasLine = false; if (offset == 0 && content.Length == length) { @@ -189,6 +220,7 @@ namespace Markdig.Renderers [MethodImpl(MethodImplOptionPortable.AggressiveInlining)] public T WriteLine() { + WriteIndent(); Writer.WriteLine(); previousWasLine = true; return (T) this; @@ -202,6 +234,7 @@ namespace Markdig.Renderers [MethodImpl(MethodImplOptionPortable.AggressiveInlining)] public T WriteLine(string content) { + WriteIndent(); previousWasLine = true; Writer.WriteLine(content); return (T) this; From 3cc405b05bce3bcbc2b3a8bbbc27734c64304273 Mon Sep 17 00:00:00 2001 From: Alexandre Mutel Date: Tue, 28 Jun 2016 23:37:52 +0900 Subject: [PATCH 05/14] Add normalize renderers for core CommonMark components (wip #17) --- src/Markdig.Tests/Markdig.Tests.csproj | 1 + src/Markdig.Tests/TestNormalize.cs | 121 +++++++ src/Markdig/Markdown.cs | 37 ++ src/Markdig/Parsers/ThematicBreakParser.cs | 4 +- .../Renderers/Normalize/CodeBlockRenderer.cs | 4 +- .../Renderers/Normalize/HeadingRenderer.cs | 2 +- .../Inlines/AutolinkInlineRenderer.cs | 19 ++ .../Normalize/Inlines/CodeInlineRenderer.cs | 21 ++ .../Inlines/DelimiterInlineRenderer.cs | 20 ++ .../Inlines/EmphasisInlineRenderer.cs | 22 ++ .../Inlines/LineBreakInlineRenderer.cs | 25 ++ .../Normalize/Inlines/LinkInlineRenderer.cs | 38 +++ .../Inlines/LiteralInlineRenderer.cs | 19 ++ .../NormalizeHtmlEntityInlineRenderer.cs | 18 + .../Inlines/NormalizeHtmlInlineRenderer.cs | 18 + .../Renderers/Normalize/ListRenderer.cs | 73 ++++ .../Renderers/Normalize/NormalizeRenderer.cs | 320 ++++-------------- .../Renderers/Normalize/ParagraphRenderer.cs | 21 ++ .../Normalize/ThematicBreakRenderer.cs | 19 ++ src/Markdig/Syntax/ThematicBreakBlock.cs | 4 + 20 files changed, 553 insertions(+), 253 deletions(-) create mode 100644 src/Markdig.Tests/TestNormalize.cs create mode 100644 src/Markdig/Renderers/Normalize/Inlines/AutolinkInlineRenderer.cs create mode 100644 src/Markdig/Renderers/Normalize/Inlines/CodeInlineRenderer.cs create mode 100644 src/Markdig/Renderers/Normalize/Inlines/DelimiterInlineRenderer.cs create mode 100644 src/Markdig/Renderers/Normalize/Inlines/EmphasisInlineRenderer.cs create mode 100644 src/Markdig/Renderers/Normalize/Inlines/LineBreakInlineRenderer.cs create mode 100644 src/Markdig/Renderers/Normalize/Inlines/LinkInlineRenderer.cs create mode 100644 src/Markdig/Renderers/Normalize/Inlines/LiteralInlineRenderer.cs create mode 100644 src/Markdig/Renderers/Normalize/Inlines/NormalizeHtmlEntityInlineRenderer.cs create mode 100644 src/Markdig/Renderers/Normalize/Inlines/NormalizeHtmlInlineRenderer.cs create mode 100644 src/Markdig/Renderers/Normalize/ListRenderer.cs create mode 100644 src/Markdig/Renderers/Normalize/ParagraphRenderer.cs create mode 100644 src/Markdig/Renderers/Normalize/ThematicBreakRenderer.cs diff --git a/src/Markdig.Tests/Markdig.Tests.csproj b/src/Markdig.Tests/Markdig.Tests.csproj index a506836a..d5cd3b3f 100644 --- a/src/Markdig.Tests/Markdig.Tests.csproj +++ b/src/Markdig.Tests/Markdig.Tests.csproj @@ -62,6 +62,7 @@ + diff --git a/src/Markdig.Tests/TestNormalize.cs b/src/Markdig.Tests/TestNormalize.cs new file mode 100644 index 00000000..269c7467 --- /dev/null +++ b/src/Markdig.Tests/TestNormalize.cs @@ -0,0 +1,121 @@ +// Copyright (c) Alexandre Mutel. All rights reserved. +// This file is licensed under the BSD-Clause 2 license. +// See the license.txt file in the project root for more information. + +using System; +using NUnit.Framework; + +namespace Markdig.Tests +{ + [TestFixture] + public class TestNormalize + { + + [Test] + public void TestParagraph() + { + AssertNormalize("This is a plain paragraph"); + AssertNormalize(@"This +is +a +plain +paragraph"); + } + + [Test] + public void TestParagraphMulti() + { + AssertNormalize(@"line1 + +line2 + +line3"); + } + + [Test] + public void TestListUnordered() + { + AssertNormalize(@" +- a +- b +- c +"); + } + + [Test] + public void TestListOrdered() + { + AssertNormalize(@" +1. a +2. b +3. c +"); + } + + [Test] + public void TestHeaderAndParagraph() + { + AssertNormalize(@" +# heading + +paragraph +"); + } + + + [Test] + public void TestQuote() + { + AssertNormalize(@" +> test1 +> +> test2 +"); + } + + + [Test] + public void TestEmphasis() + { + AssertNormalize("This is a plain **paragraph**"); + AssertNormalize("This is a plain *paragraph*"); + AssertNormalize("This is a plain _paragraph_"); + AssertNormalize("This is a plain __paragraph__"); + AssertNormalize("This is a pl*ai*n **paragraph**"); + } + + [Test] + public void TestLinks() + { + AssertNormalize("This is a [link](http://company.com)"); + AssertNormalize("This is an ![image](http://company.com)"); + } + + + public void AssertNormalize(string input, string expected = null) + { + expected = expected ?? input; + input = NormText(input); + expected = NormText(expected); + + var result = Markdown.Normalize(input); + result = NormText(result); + + Console.WriteLine("```````````````````Source"); + Console.WriteLine(TestParser.DisplaySpaceAndTabs(input)); + Console.WriteLine("```````````````````Result"); + Console.WriteLine(TestParser.DisplaySpaceAndTabs(result)); + Console.WriteLine("```````````````````Expected"); + Console.WriteLine(TestParser.DisplaySpaceAndTabs(expected)); + Console.WriteLine("```````````````````"); + Console.WriteLine(); + + TextAssert.AreEqual(expected, result); + } + + private static string NormText(string text) + { + return text.Trim().Replace("\r\n", "\n").Replace('\r', '\n'); + } + } +} \ No newline at end of file diff --git a/src/Markdig/Markdown.cs b/src/Markdig/Markdown.cs index 61cc8f32..406a7557 100644 --- a/src/Markdig/Markdown.cs +++ b/src/Markdig/Markdown.cs @@ -7,6 +7,7 @@ using System.Reflection; using Markdig.Extensions.SelfPipeline; using Markdig.Parsers; using Markdig.Renderers; +using Markdig.Renderers.Normalize; using Markdig.Syntax; namespace Markdig @@ -22,6 +23,42 @@ namespace Markdig public static readonly string Version = ((AssemblyFileVersionAttribute) typeof(Markdown).Assembly.GetCustomAttributes(typeof(AssemblyFileVersionAttribute), false)[0]).Version; #endif + /// + /// Normalizes the specified markdown to a normalized markdown text. + /// + /// The markdown. + /// The pipeline. + /// A normalized markdown text. + public static string Normalize(string markdown, MarkdownPipeline pipeline = null) + { + var writer = new StringWriter(); + Normalize(markdown, writer, pipeline); + return writer.ToString(); + } + + /// + /// Normalizes the specified markdown to a normalized markdown text. + /// + /// The markdown. + /// The destination that will receive the result of the conversion. + /// The pipeline. + /// A normalized markdown text. + public static MarkdownDocument Normalize(string markdown, TextWriter writer, MarkdownPipeline pipeline = null) + { + pipeline = pipeline ?? new MarkdownPipelineBuilder().Build(); + pipeline = CheckForSelfPipeline(pipeline, markdown); + + // We override the renderer with our own writer + var renderer = new NormalizeRenderer(writer); + pipeline.Setup(renderer); + + var document = Parse(markdown, pipeline); + renderer.Render(document); + writer.Flush(); + + return document; + } + /// /// Converts a Markdown string to HTML. /// diff --git a/src/Markdig/Parsers/ThematicBreakParser.cs b/src/Markdig/Parsers/ThematicBreakParser.cs index f73eece2..f0f45fee 100644 --- a/src/Markdig/Parsers/ThematicBreakParser.cs +++ b/src/Markdig/Parsers/ThematicBreakParser.cs @@ -88,7 +88,9 @@ namespace Markdig.Parsers processor.NewBlocks.Push(new ThematicBreakBlock(this) { Column = processor.Column, - Span = new SourceSpan(startPosition, line.End) + Span = new SourceSpan(startPosition, line.End), + ThematicChar = breakChar, + ThematicCharCount = breakCharCount }); return BlockState.BreakDiscard; } diff --git a/src/Markdig/Renderers/Normalize/CodeBlockRenderer.cs b/src/Markdig/Renderers/Normalize/CodeBlockRenderer.cs index 4dce78cc..c7ab8f60 100644 --- a/src/Markdig/Renderers/Normalize/CodeBlockRenderer.cs +++ b/src/Markdig/Renderers/Normalize/CodeBlockRenderer.cs @@ -39,12 +39,12 @@ namespace Markdig.Renderers.Normalize } renderer.WriteLine(); - renderer.WriteLeafRawLines(obj, true, false); + renderer.WriteLeafRawLines(obj, true); renderer.WriteLine(opening); } else { - renderer.WriteLeafRawLines(obj, true, false, true); + renderer.WriteLeafRawLines(obj, true, true); renderer.WriteLine(); } } diff --git a/src/Markdig/Renderers/Normalize/HeadingRenderer.cs b/src/Markdig/Renderers/Normalize/HeadingRenderer.cs index 9554eb7a..ee7c91d3 100644 --- a/src/Markdig/Renderers/Normalize/HeadingRenderer.cs +++ b/src/Markdig/Renderers/Normalize/HeadingRenderer.cs @@ -29,7 +29,7 @@ namespace Markdig.Renderers.Normalize renderer.Write(headingText).Write(' '); renderer.WriteLeafInline(obj); - renderer.WriteLine(); + renderer.WriteLine().WriteLine(); } } } \ No newline at end of file diff --git a/src/Markdig/Renderers/Normalize/Inlines/AutolinkInlineRenderer.cs b/src/Markdig/Renderers/Normalize/Inlines/AutolinkInlineRenderer.cs new file mode 100644 index 00000000..6dede810 --- /dev/null +++ b/src/Markdig/Renderers/Normalize/Inlines/AutolinkInlineRenderer.cs @@ -0,0 +1,19 @@ +// Copyright (c) Alexandre Mutel. All rights reserved. +// This file is licensed under the BSD-Clause 2 license. +// See the license.txt file in the project root for more information. +using Markdig.Syntax.Inlines; + +namespace Markdig.Renderers.Normalize.Inlines +{ + /// + /// A Normalize renderer for an . + /// + /// + public class AutolinkInlineRenderer : NormalizeObjectRenderer + { + protected override void Write(NormalizeRenderer renderer, AutolinkInline obj) + { + renderer.Write('<').Write(obj.Url).Write('>'); + } + } +} \ No newline at end of file diff --git a/src/Markdig/Renderers/Normalize/Inlines/CodeInlineRenderer.cs b/src/Markdig/Renderers/Normalize/Inlines/CodeInlineRenderer.cs new file mode 100644 index 00000000..7eace1e4 --- /dev/null +++ b/src/Markdig/Renderers/Normalize/Inlines/CodeInlineRenderer.cs @@ -0,0 +1,21 @@ +// Copyright (c) Alexandre Mutel. All rights reserved. +// This file is licensed under the BSD-Clause 2 license. +// See the license.txt file in the project root for more information. +using Markdig.Syntax.Inlines; + +namespace Markdig.Renderers.Normalize.Inlines +{ + /// + /// A Normalize renderer for a . + /// + /// + public class CodeInlineRenderer : NormalizeObjectRenderer + { + protected override void Write(NormalizeRenderer renderer, CodeInline obj) + { + renderer.Write(obj.Delimiter); + renderer.Write(obj.Content); // TODO: escape ` + renderer.Write(obj.Delimiter); + } + } +} \ No newline at end of file diff --git a/src/Markdig/Renderers/Normalize/Inlines/DelimiterInlineRenderer.cs b/src/Markdig/Renderers/Normalize/Inlines/DelimiterInlineRenderer.cs new file mode 100644 index 00000000..54709ea4 --- /dev/null +++ b/src/Markdig/Renderers/Normalize/Inlines/DelimiterInlineRenderer.cs @@ -0,0 +1,20 @@ +// Copyright (c) Alexandre Mutel. All rights reserved. +// This file is licensed under the BSD-Clause 2 license. +// See the license.txt file in the project root for more information. +using Markdig.Syntax.Inlines; + +namespace Markdig.Renderers.Normalize.Inlines +{ + /// + /// A Normalize renderer for a . + /// + /// + public class DelimiterInlineRenderer : NormalizeObjectRenderer + { + protected override void Write(NormalizeRenderer renderer, DelimiterInline obj) + { + renderer.Write(obj.ToLiteral()); + renderer.WriteChildren(obj); + } + } +} \ No newline at end of file diff --git a/src/Markdig/Renderers/Normalize/Inlines/EmphasisInlineRenderer.cs b/src/Markdig/Renderers/Normalize/Inlines/EmphasisInlineRenderer.cs new file mode 100644 index 00000000..36633f99 --- /dev/null +++ b/src/Markdig/Renderers/Normalize/Inlines/EmphasisInlineRenderer.cs @@ -0,0 +1,22 @@ +// Copyright (c) Alexandre Mutel. All rights reserved. +// This file is licensed under the BSD-Clause 2 license. +// See the license.txt file in the project root for more information. +using Markdig.Syntax.Inlines; + +namespace Markdig.Renderers.Normalize.Inlines +{ + /// + /// A Normalize renderer for an . + /// + /// + public class EmphasisInlineRenderer : NormalizeObjectRenderer + { + protected override void Write(NormalizeRenderer renderer, EmphasisInline obj) + { + var emphasisText = new string(obj.DelimiterChar, obj.IsDouble ? 2 : 1); + renderer.Write(emphasisText); + renderer.WriteChildren(obj); + renderer.Write(emphasisText); + } + } +} \ No newline at end of file diff --git a/src/Markdig/Renderers/Normalize/Inlines/LineBreakInlineRenderer.cs b/src/Markdig/Renderers/Normalize/Inlines/LineBreakInlineRenderer.cs new file mode 100644 index 00000000..4cdad0fe --- /dev/null +++ b/src/Markdig/Renderers/Normalize/Inlines/LineBreakInlineRenderer.cs @@ -0,0 +1,25 @@ +// Copyright (c) Alexandre Mutel. All rights reserved. +// This file is licensed under the BSD-Clause 2 license. +// See the license.txt file in the project root for more information. +using Markdig.Syntax.Inlines; + +namespace Markdig.Renderers.Normalize.Inlines +{ + /// + /// A Normalize renderer for a . + /// + /// + public class LineBreakInlineRenderer : NormalizeObjectRenderer + { + /// + /// Gets or sets a value indicating whether to render this softline break as a Normalize hardline break tag (<br />) + /// + public bool RenderAsHardlineBreak { get; set; } + + protected override void Write(NormalizeRenderer renderer, LineBreakInline obj) + { + // TODO: handle hard + renderer.WriteLine(); + } + } +} \ No newline at end of file diff --git a/src/Markdig/Renderers/Normalize/Inlines/LinkInlineRenderer.cs b/src/Markdig/Renderers/Normalize/Inlines/LinkInlineRenderer.cs new file mode 100644 index 00000000..a2dddac8 --- /dev/null +++ b/src/Markdig/Renderers/Normalize/Inlines/LinkInlineRenderer.cs @@ -0,0 +1,38 @@ +// Copyright (c) Alexandre Mutel. All rights reserved. +// This file is licensed under the BSD-Clause 2 license. +// See the license.txt file in the project root for more information. +using Markdig.Syntax.Inlines; + +namespace Markdig.Renderers.Normalize.Inlines +{ + /// + /// A Normalize renderer for a . + /// + /// + public class LinkInlineRenderer : NormalizeObjectRenderer + { + protected override void Write(NormalizeRenderer renderer, LinkInline link) + { + if (link.IsImage) + { + renderer.Write('!'); + } + renderer.Write('['); + renderer.WriteChildren(link); + renderer.Write(']'); + if (!string.IsNullOrEmpty(link.Url)) + { + renderer.Write('(').Write(link.Url); + + if (!string.IsNullOrEmpty(link.Title)) + { + renderer.Write(" \""); + renderer.Write(link.Title); // TODO: escape " + renderer.Write("\""); + } + + renderer.Write(')'); + } + } + } +} \ No newline at end of file diff --git a/src/Markdig/Renderers/Normalize/Inlines/LiteralInlineRenderer.cs b/src/Markdig/Renderers/Normalize/Inlines/LiteralInlineRenderer.cs new file mode 100644 index 00000000..3b4e410f --- /dev/null +++ b/src/Markdig/Renderers/Normalize/Inlines/LiteralInlineRenderer.cs @@ -0,0 +1,19 @@ +// Copyright (c) Alexandre Mutel. All rights reserved. +// This file is licensed under the BSD-Clause 2 license. +// See the license.txt file in the project root for more information. +using Markdig.Syntax.Inlines; + +namespace Markdig.Renderers.Normalize.Inlines +{ + /// + /// A Normalize renderer for a . + /// + /// + public class LiteralInlineRenderer : NormalizeObjectRenderer + { + protected override void Write(NormalizeRenderer renderer, LiteralInline obj) + { + renderer.Write(ref obj.Content); + } + } +} \ No newline at end of file diff --git a/src/Markdig/Renderers/Normalize/Inlines/NormalizeHtmlEntityInlineRenderer.cs b/src/Markdig/Renderers/Normalize/Inlines/NormalizeHtmlEntityInlineRenderer.cs new file mode 100644 index 00000000..2d7883c7 --- /dev/null +++ b/src/Markdig/Renderers/Normalize/Inlines/NormalizeHtmlEntityInlineRenderer.cs @@ -0,0 +1,18 @@ +// Copyright (c) Alexandre Mutel. All rights reserved. +// This file is licensed under the BSD-Clause 2 license. +// See the license.txt file in the project root for more information. +using Markdig.Syntax.Inlines; + +namespace Markdig.Renderers.Normalize.Inlines +{ + /// + /// A Normalize renderer for a . + /// + public class NormalizeHtmlEntityInlineRenderer : NormalizeObjectRenderer + { + protected override void Write(NormalizeRenderer renderer, HtmlEntityInline obj) + { + renderer.Write(obj.Transcoded); + } + } +} \ No newline at end of file diff --git a/src/Markdig/Renderers/Normalize/Inlines/NormalizeHtmlInlineRenderer.cs b/src/Markdig/Renderers/Normalize/Inlines/NormalizeHtmlInlineRenderer.cs new file mode 100644 index 00000000..33bc8536 --- /dev/null +++ b/src/Markdig/Renderers/Normalize/Inlines/NormalizeHtmlInlineRenderer.cs @@ -0,0 +1,18 @@ +// Copyright (c) Alexandre Mutel. All rights reserved. +// This file is licensed under the BSD-Clause 2 license. +// See the license.txt file in the project root for more information. +using Markdig.Syntax.Inlines; + +namespace Markdig.Renderers.Normalize.Inlines +{ + /// + /// A Normalize renderer for a . + /// + public class NormalizeHtmlInlineRenderer : NormalizeObjectRenderer + { + protected override void Write(NormalizeRenderer renderer, HtmlInline obj) + { + renderer.Write(obj.Tag); + } + } +} \ No newline at end of file diff --git a/src/Markdig/Renderers/Normalize/ListRenderer.cs b/src/Markdig/Renderers/Normalize/ListRenderer.cs new file mode 100644 index 00000000..bf204740 --- /dev/null +++ b/src/Markdig/Renderers/Normalize/ListRenderer.cs @@ -0,0 +1,73 @@ +// Copyright (c) Alexandre Mutel. All rights reserved. +// This file is licensed under the BSD-Clause 2 license. +// See the license.txt file in the project root for more information. +using System.Globalization; +using Markdig.Syntax; + +namespace Markdig.Renderers.Normalize +{ + /// + /// A Normalize renderer for a . + /// + /// + public class ListRenderer : NormalizeObjectRenderer + { + protected override void Write(NormalizeRenderer renderer, ListBlock listBlock) + { + renderer.EnsureLine(); + if (listBlock.IsOrdered) + { + int index = 0; + if (listBlock.OrderedStart != null) + { + switch (listBlock.BulletType) + { + case '1': + int.TryParse(listBlock.OrderedStart, out index); + break; + } + } + foreach (var item in listBlock) + { + var listItem = (ListItemBlock)item; + renderer.EnsureLine(); + + renderer.Write(index + ""); + renderer.Write(listBlock.OrderedDelimiter); + renderer.Write(' '); + renderer.PushIndent(" "); // TODO: output accurate indent + renderer.WriteChildren(listItem); + renderer.PopIndent(); + if (!listBlock.IsLoose) + { + renderer.WriteLine(); + } + + switch (listBlock.BulletType) + { + case '1': + index++; + break; + } + } + } + else + { + foreach (var item in listBlock) + { + var listItem = (ListItemBlock)item; + renderer.EnsureLine(); + renderer.Write("- "); + renderer.PushIndent(" "); + renderer.WriteChildren(listItem); + renderer.PopIndent(); + if (!listBlock.IsLoose) + { + renderer.WriteLine(); + } + } + } + renderer.WriteLine(); + } + } +} \ No newline at end of file diff --git a/src/Markdig/Renderers/Normalize/NormalizeRenderer.cs b/src/Markdig/Renderers/Normalize/NormalizeRenderer.cs index 6b79d028..585ad7f0 100644 --- a/src/Markdig/Renderers/Normalize/NormalizeRenderer.cs +++ b/src/Markdig/Renderers/Normalize/NormalizeRenderer.cs @@ -9,6 +9,7 @@ using System.Text; using Markdig.Helpers; using Markdig.Renderers.Html; using Markdig.Syntax; +using Markdig.Renderers.Normalize.Inlines; namespace Markdig.Renderers.Normalize { @@ -26,265 +27,92 @@ namespace Markdig.Renderers.Normalize { // Default block renderers ObjectRenderers.Add(new CodeBlockRenderer()); - //ObjectRenderers.Add(new ListRenderer()); + ObjectRenderers.Add(new ListRenderer()); ObjectRenderers.Add(new HeadingRenderer()); - //ObjectRenderers.Add(new HtmlBlockRenderer()); - //ObjectRenderers.Add(new ParagraphRenderer()); + ObjectRenderers.Add(new HtmlBlockRenderer()); + ObjectRenderers.Add(new ParagraphRenderer()); ObjectRenderers.Add(new QuoteBlockRenderer()); - //ObjectRenderers.Add(new ThematicBreakRenderer()); + ObjectRenderers.Add(new ThematicBreakRenderer()); // Default inline renderers - //ObjectRenderers.Add(new AutolinkInlineRenderer()); - //ObjectRenderers.Add(new CodeInlineRenderer()); - //ObjectRenderers.Add(new DelimiterInlineRenderer()); - //ObjectRenderers.Add(new EmphasisInlineRenderer()); - //ObjectRenderers.Add(new LineBreakInlineRenderer()); - //ObjectRenderers.Add(new HtmlInlineRenderer()); - //ObjectRenderers.Add(new HtmlEntityInlineRenderer()); - //ObjectRenderers.Add(new LinkInlineRenderer()); - //ObjectRenderers.Add(new LiteralInlineRenderer()); - - EnableHtmlForInline = true; - EnableHtmlEscape = true; + ObjectRenderers.Add(new AutolinkInlineRenderer()); + ObjectRenderers.Add(new CodeInlineRenderer()); + ObjectRenderers.Add(new DelimiterInlineRenderer()); + ObjectRenderers.Add(new EmphasisInlineRenderer()); + ObjectRenderers.Add(new LineBreakInlineRenderer()); + ObjectRenderers.Add(new NormalizeHtmlInlineRenderer()); + ObjectRenderers.Add(new NormalizeHtmlEntityInlineRenderer()); + ObjectRenderers.Add(new LinkInlineRenderer()); + ObjectRenderers.Add(new LiteralInlineRenderer()); } - /// - /// Gets or sets a value indicating whether to ouput HTML tags when rendering. See remarks. - /// - /// - /// This is used by some renderers to disable HTML tags when rendering some inlines (for image links). - /// - public bool EnableHtmlForInline { get; set; } + ///// + ///// Writes the attached on the specified . + ///// + ///// The object. + ///// + //public NormalizeRenderer WriteAttributes(MarkdownObject obj) + //{ + // if (obj == null) throw new ArgumentNullException(nameof(obj)); + // return WriteAttributes(obj.TryGetAttributes()); + //} - public bool EnableHtmlEscape { get; set; } + ///// + ///// Writes the specified . + ///// + ///// The attributes to render. + ///// This instance + //public NormalizeRenderer WriteAttributes(HtmlAttributes attributes) + //{ + // if (attributes == null) + // { + // return this; + // } - /// - /// Gets or sets a value indicating whether to use implicit paragraph (optional <p>) - /// - public bool ImplicitParagraph { get; set; } + // if (attributes.Id != null) + // { + // Write(" id=\"").WriteEscape(attributes.Id).Write("\""); + // } - /// - /// Writes the content escaped for HTML. - /// - /// The content. - /// This instance - [MethodImpl(MethodImplOptionPortable.AggressiveInlining)] - public NormalizeRenderer WriteEscape(string content) - { - if (string.IsNullOrEmpty(content)) - return this; + // if (attributes.Classes != null && attributes.Classes.Count > 0) + // { + // Write(" class=\""); + // for (int i = 0; i < attributes.Classes.Count; i++) + // { + // var cssClass = attributes.Classes[i]; + // if (i > 0) + // { + // Write(" "); + // } + // WriteEscape(cssClass); + // } + // Write("\""); + // } - WriteEscape(content, 0, content.Length); - return this; - } + // if (attributes.Properties != null && attributes.Properties.Count > 0) + // { + // foreach (var property in attributes.Properties) + // { + // Write(" ").Write(property.Key); + // if (property.Value != null) + // { + // Write("=").Write("\""); + // WriteEscape(property.Value); + // Write("\""); + // } + // } + // } - /// - /// Writes the content escaped for HTML. - /// - /// The slice. - /// This instance - [MethodImpl(MethodImplOptionPortable.AggressiveInlining)] - public NormalizeRenderer WriteEscape(ref StringSlice slice) - { - if (slice.Start > slice.End) - { - return this; - } - return WriteEscape(slice.Text, slice.Start, slice.Length); - } - - /// - /// Writes the content escaped for HTML. - /// - /// The slice. - /// This instance - [MethodImpl(MethodImplOptionPortable.AggressiveInlining)] - public NormalizeRenderer WriteEscape(StringSlice slice) - { - return WriteEscape(ref slice); - } - - /// - /// Writes the content escaped for HTML. - /// - /// The content. - /// The offset. - /// The length. - /// This instance - public NormalizeRenderer WriteEscape(string content, int offset, int length) - { - if (string.IsNullOrEmpty(content) || length == 0) - return this; - - var end = offset + length; - int previousOffset = offset; - for (;offset < end; offset++) - { - switch (content[offset]) - { - case '<': - Write(content, previousOffset, offset - previousOffset); - if (EnableHtmlEscape) - { - Write("<"); - } - previousOffset = offset + 1; - break; - case '>': - Write(content, previousOffset, offset - previousOffset); - if (EnableHtmlEscape) - { - Write(">"); - } - previousOffset = offset + 1; - break; - case '&': - Write(content, previousOffset, offset - previousOffset); - if (EnableHtmlEscape) - { - Write("&"); - } - previousOffset = offset + 1; - break; - case '"': - Write(content, previousOffset, offset - previousOffset); - if (EnableHtmlEscape) - { - Write("""); - } - previousOffset = offset + 1; - break; - } - } - - Write(content, previousOffset, end - previousOffset); - return this; - } - - /// - /// Writes the URL escaped for HTML. - /// - /// The content. - /// This instance - public NormalizeRenderer WriteEscapeUrl(string content) - { - if (content == null) - return this; - - int previousPosition = 0; - int length = content.Length; - - for (var i = 0; i < length; i++) - { - var c = content[i]; - - if (c < 128) - { - var escape = HtmlHelper.EscapeUrlCharacter(c); - if (escape != null) - { - Write(content, previousPosition, i - previousPosition); - previousPosition = i + 1; - Write(escape); - } - } - else - { - Write(content, previousPosition, i - previousPosition); - previousPosition = i + 1; - - byte[] bytes; - if (c >= '\ud800' && c <= '\udfff' && previousPosition < length) - { - bytes = Encoding.UTF8.GetBytes(new[] { c, content[previousPosition] }); - // Skip next char as it is decoded above - i++; - previousPosition = i + 1; - } - else - { - bytes = Encoding.UTF8.GetBytes(new[] { c }); - } - - for (var j = 0; j < bytes.Length; j++) - { - Write($"%{bytes[j]:X2}"); - } - } - } - - Write(content, previousPosition, length - previousPosition); - return this; - } - - /// - /// Writes the attached on the specified . - /// - /// The object. - /// - public NormalizeRenderer WriteAttributes(MarkdownObject obj) - { - if (obj == null) throw new ArgumentNullException(nameof(obj)); - return WriteAttributes(obj.TryGetAttributes()); - } - - /// - /// Writes the specified . - /// - /// The attributes to render. - /// This instance - public NormalizeRenderer WriteAttributes(HtmlAttributes attributes) - { - if (attributes == null) - { - return this; - } - - if (attributes.Id != null) - { - Write(" id=\"").WriteEscape(attributes.Id).Write("\""); - } - - if (attributes.Classes != null && attributes.Classes.Count > 0) - { - Write(" class=\""); - for (int i = 0; i < attributes.Classes.Count; i++) - { - var cssClass = attributes.Classes[i]; - if (i > 0) - { - Write(" "); - } - WriteEscape(cssClass); - } - Write("\""); - } - - if (attributes.Properties != null && attributes.Properties.Count > 0) - { - foreach (var property in attributes.Properties) - { - Write(" ").Write(property.Key); - if (property.Value != null) - { - Write("=").Write("\""); - WriteEscape(property.Value); - Write("\""); - } - } - } - - return this; - } + // return this; + //} /// /// Writes the lines of a /// /// The leaf block. /// if set to true write end of lines. - /// if set to true escape the content for HTML /// This instance - public NormalizeRenderer WriteLeafRawLines(LeafBlock leafBlock, bool writeEndOfLines, bool escape, bool indent = false) + public NormalizeRenderer WriteLeafRawLines(LeafBlock leafBlock, bool writeEndOfLines, bool indent = false) { if (leafBlock == null) throw new ArgumentNullException(nameof(leafBlock)); if (leafBlock.Lines.Lines != null) @@ -303,14 +131,8 @@ namespace Markdig.Renderers.Normalize Write(" "); } - if (escape) - { - WriteEscape(ref slices[i].Slice); - } - else - { - Write(ref slices[i].Slice); - } + Write(ref slices[i].Slice); + if (writeEndOfLines) { WriteLine(); diff --git a/src/Markdig/Renderers/Normalize/ParagraphRenderer.cs b/src/Markdig/Renderers/Normalize/ParagraphRenderer.cs new file mode 100644 index 00000000..81d747d5 --- /dev/null +++ b/src/Markdig/Renderers/Normalize/ParagraphRenderer.cs @@ -0,0 +1,21 @@ +// Copyright (c) Alexandre Mutel. All rights reserved. +// This file is licensed under the BSD-Clause 2 license. +// See the license.txt file in the project root for more information. +using Markdig.Syntax; + +namespace Markdig.Renderers.Normalize +{ + /// + /// A Normalize renderer for a . + /// + /// + public class ParagraphRenderer : NormalizeObjectRenderer + { + protected override void Write(NormalizeRenderer renderer, ParagraphBlock obj) + { + renderer.EnsureLine(); + renderer.WriteLeafInline(obj); + renderer.WriteLine().WriteLine(); + } + } +} \ No newline at end of file diff --git a/src/Markdig/Renderers/Normalize/ThematicBreakRenderer.cs b/src/Markdig/Renderers/Normalize/ThematicBreakRenderer.cs new file mode 100644 index 00000000..2aa90c15 --- /dev/null +++ b/src/Markdig/Renderers/Normalize/ThematicBreakRenderer.cs @@ -0,0 +1,19 @@ +// Copyright (c) Alexandre Mutel. All rights reserved. +// This file is licensed under the BSD-Clause 2 license. +// See the license.txt file in the project root for more information. +using Markdig.Syntax; + +namespace Markdig.Renderers.Normalize +{ + /// + /// A Normalize renderer for a . + /// + /// + public class ThematicBreakRenderer : NormalizeObjectRenderer + { + protected override void Write(NormalizeRenderer renderer, ThematicBreakBlock obj) + { + renderer.WriteLine(new string(obj.ThematicChar, obj.ThematicCharCount)); + } + } +} \ No newline at end of file diff --git a/src/Markdig/Syntax/ThematicBreakBlock.cs b/src/Markdig/Syntax/ThematicBreakBlock.cs index ebf66bb1..c6839373 100644 --- a/src/Markdig/Syntax/ThematicBreakBlock.cs +++ b/src/Markdig/Syntax/ThematicBreakBlock.cs @@ -17,5 +17,9 @@ namespace Markdig.Syntax public ThematicBreakBlock(BlockParser parser) : base(parser) { } + + public char ThematicChar { get; set; } + + public int ThematicCharCount { get; set; } } } \ No newline at end of file From 218a094f0d08cc4859cc9b7d43dd1887381ea70f Mon Sep 17 00:00:00 2001 From: Alexandre Mutel Date: Tue, 28 Jun 2016 23:55:01 +0900 Subject: [PATCH 06/14] Try to workaround tight/loose lists and paragraphs (wip #17) --- src/Markdig.Tests/TestNormalize.cs | 2 +- src/Markdig/Renderers/Normalize/ListRenderer.cs | 13 ++++--------- .../Renderers/Normalize/NormalizeRenderer.cs | 2 ++ .../Renderers/Normalize/ParagraphRenderer.cs | 11 +++++++++-- 4 files changed, 16 insertions(+), 12 deletions(-) diff --git a/src/Markdig.Tests/TestNormalize.cs b/src/Markdig.Tests/TestNormalize.cs index 269c7467..fae3f763 100644 --- a/src/Markdig.Tests/TestNormalize.cs +++ b/src/Markdig.Tests/TestNormalize.cs @@ -68,7 +68,7 @@ paragraph { AssertNormalize(@" > test1 -> +> > test2 "); } diff --git a/src/Markdig/Renderers/Normalize/ListRenderer.cs b/src/Markdig/Renderers/Normalize/ListRenderer.cs index bf204740..a60c8cea 100644 --- a/src/Markdig/Renderers/Normalize/ListRenderer.cs +++ b/src/Markdig/Renderers/Normalize/ListRenderer.cs @@ -15,6 +15,8 @@ namespace Markdig.Renderers.Normalize protected override void Write(NormalizeRenderer renderer, ListBlock listBlock) { renderer.EnsureLine(); + var compact = renderer.CompactParagraph; + renderer.CompactParagraph = !listBlock.IsLoose; if (listBlock.IsOrdered) { int index = 0; @@ -38,11 +40,6 @@ namespace Markdig.Renderers.Normalize renderer.PushIndent(" "); // TODO: output accurate indent renderer.WriteChildren(listItem); renderer.PopIndent(); - if (!listBlock.IsLoose) - { - renderer.WriteLine(); - } - switch (listBlock.BulletType) { case '1': @@ -61,12 +58,10 @@ namespace Markdig.Renderers.Normalize renderer.PushIndent(" "); renderer.WriteChildren(listItem); renderer.PopIndent(); - if (!listBlock.IsLoose) - { - renderer.WriteLine(); - } } } + + renderer.CompactParagraph = compact; renderer.WriteLine(); } } diff --git a/src/Markdig/Renderers/Normalize/NormalizeRenderer.cs b/src/Markdig/Renderers/Normalize/NormalizeRenderer.cs index 585ad7f0..17d91189 100644 --- a/src/Markdig/Renderers/Normalize/NormalizeRenderer.cs +++ b/src/Markdig/Renderers/Normalize/NormalizeRenderer.cs @@ -46,6 +46,8 @@ namespace Markdig.Renderers.Normalize ObjectRenderers.Add(new LiteralInlineRenderer()); } + public bool CompactParagraph { get; set; } + ///// ///// Writes the attached on the specified . ///// diff --git a/src/Markdig/Renderers/Normalize/ParagraphRenderer.cs b/src/Markdig/Renderers/Normalize/ParagraphRenderer.cs index 81d747d5..755042a4 100644 --- a/src/Markdig/Renderers/Normalize/ParagraphRenderer.cs +++ b/src/Markdig/Renderers/Normalize/ParagraphRenderer.cs @@ -13,9 +13,16 @@ namespace Markdig.Renderers.Normalize { protected override void Write(NormalizeRenderer renderer, ParagraphBlock obj) { - renderer.EnsureLine(); + if (!renderer.CompactParagraph) + { + renderer.EnsureLine(); + } renderer.WriteLeafInline(obj); - renderer.WriteLine().WriteLine(); + if (!renderer.IsLastInContainer && !renderer.CompactParagraph) + { + renderer.WriteLine(); + renderer.WriteLine(); + } } } } \ No newline at end of file From 0c408951b8181dfe3cbbfec6bead9eed7223edde Mon Sep 17 00:00:00 2001 From: "T. Thiery" Date: Mon, 18 Sep 2017 20:42:50 +0200 Subject: [PATCH 07/14] Add straight forward unit tests. --- src/Markdig.Tests/TestNormalize.cs | 100 +++++++++++++++++++++++++++-- 1 file changed, 93 insertions(+), 7 deletions(-) diff --git a/src/Markdig.Tests/TestNormalize.cs b/src/Markdig.Tests/TestNormalize.cs index fae3f763..2008ab7a 100644 --- a/src/Markdig.Tests/TestNormalize.cs +++ b/src/Markdig.Tests/TestNormalize.cs @@ -1,4 +1,4 @@ -// Copyright (c) Alexandre Mutel. All rights reserved. +// Copyright (c) Alexandre Mutel. All rights reserved. // This file is licensed under the BSD-Clause 2 license. // See the license.txt file in the project root for more information. @@ -11,6 +11,36 @@ namespace Markdig.Tests public class TestNormalize { + [Test] + public void TestCodeBlock() + { + AssertNormalizeNoTrim(" public void HelloWorld();\n {\n }\n\n"); + AssertNormalizeNoTrim("```` \npublic void HelloWorld();\n{\n}\n````\n"); //TODO: Bug? Space after the fence + AssertNormalizeNoTrim("````csharp \npublic void HelloWorld();\n{\n}\n````\n"); //TODO: Bug? two spaces after the language + AssertNormalizeNoTrim("````csharp hideNewKeyword=true \npublic void HelloWorld();\n{\n}\n````\n"); //TODO: Bug? space after the attributes + } + + [Test] + public void TestHeading() + { + AssertNormalizeNoTrim("# Heading\n\n"); + AssertNormalizeNoTrim("## Heading\n\n"); + AssertNormalizeNoTrim("### Heading\n\n"); + AssertNormalizeNoTrim("#### Heading\n\n"); + AssertNormalizeNoTrim("##### Heading\n\n"); + AssertNormalizeNoTrim("###### Heading\n\n"); + + AssertNormalizeNoTrim("Heading\n=======\n\n", "# Heading\n\n"); + } + + [Test] + public void TestHtml() + { + /*AssertNormalizeNoTrim(@"
+");*/ // TODO: Bug: Throws Exception during emit + } + [Test] public void TestParagraph() { @@ -52,6 +82,25 @@ line3"); "); } + + [Test] + public void TestListOrderedAndIntended() + { + AssertNormalize(@" +1. a +2. b + - foo + - bar +3. c +", @" +1. a +2. b + - foo + - bar +3. c +"); // TODO: Bug: intend is always stripped a space. + } + [Test] public void TestHeaderAndParagraph() { @@ -73,6 +122,25 @@ paragraph "); } + [Test] + public void TestThematicBreak() + { + AssertNormalizeNoTrim("***\n"); + + AssertNormalizeNoTrim("* * *\n", "***\n"); + } + + [Test] + public void TestAutolinkInline() + { + AssertNormalizeNoTrim("This has a "); + } + + [Test] + public void TestCodeInline() + { + AssertNormalizeNoTrim("This has a `HelloWorld()` in it"); + } [Test] public void TestEmphasis() @@ -91,15 +159,29 @@ paragraph AssertNormalize("This is an ![image](http://company.com)"); } + [Test] + public void TestHtmlEntity() + { + AssertNormalizeNoTrim("This is a ä blank", "This is a ä blank"); //TODO: bug? + } - public void AssertNormalize(string input, string expected = null) + [Test] + public void TestHtmlInline() + { + AssertNormalizeNoTrim("foo
bar"); + } + + public void AssertNormalizeNoTrim(string input, string expected = null) + => AssertNormalize(input, expected, false); + + public void AssertNormalize(string input, string expected = null, bool trim = true) { expected = expected ?? input; - input = NormText(input); - expected = NormText(expected); + input = NormText(input, trim); + expected = NormText(expected, trim); var result = Markdown.Normalize(input); - result = NormText(result); + result = NormText(result, trim); Console.WriteLine("```````````````````Source"); Console.WriteLine(TestParser.DisplaySpaceAndTabs(input)); @@ -113,9 +195,13 @@ paragraph TextAssert.AreEqual(expected, result); } - private static string NormText(string text) + private static string NormText(string text, bool trim) { - return text.Trim().Replace("\r\n", "\n").Replace('\r', '\n'); + if (trim) + { + text = text.Trim(); + } + return text.Replace("\r\n", "\n").Replace('\r', '\n'); } } } \ No newline at end of file From 1bb35c5fc10e58ad6c617596b9926dc777947efa Mon Sep 17 00:00:00 2001 From: "T. Thiery" Date: Mon, 18 Sep 2017 22:16:50 +0200 Subject: [PATCH 08/14] Fixed issues found in straight forward normalization test cases - Code fences with attributes - Escaping inline code - Escaping link titles - Encode hard line breaks - HTML Entity emitting - List intend. --- src/Markdig.Tests/TestNormalize.cs | 41 ++++++++++++++----- .../Renderers/Normalize/CodeBlockRenderer.cs | 4 +- .../Normalize/Inlines/CodeInlineRenderer.cs | 8 ++-- .../Inlines/LineBreakInlineRenderer.cs | 6 ++- .../Normalize/Inlines/LinkInlineRenderer.cs | 2 +- .../NormalizeHtmlEntityInlineRenderer.cs | 2 +- .../Renderers/Normalize/ListRenderer.cs | 14 ++++++- 7 files changed, 58 insertions(+), 19 deletions(-) diff --git a/src/Markdig.Tests/TestNormalize.cs b/src/Markdig.Tests/TestNormalize.cs index 2008ab7a..8a552781 100644 --- a/src/Markdig.Tests/TestNormalize.cs +++ b/src/Markdig.Tests/TestNormalize.cs @@ -15,9 +15,9 @@ namespace Markdig.Tests public void TestCodeBlock() { AssertNormalizeNoTrim(" public void HelloWorld();\n {\n }\n\n"); - AssertNormalizeNoTrim("```` \npublic void HelloWorld();\n{\n}\n````\n"); //TODO: Bug? Space after the fence - AssertNormalizeNoTrim("````csharp \npublic void HelloWorld();\n{\n}\n````\n"); //TODO: Bug? two spaces after the language - AssertNormalizeNoTrim("````csharp hideNewKeyword=true \npublic void HelloWorld();\n{\n}\n````\n"); //TODO: Bug? space after the attributes + AssertNormalizeNoTrim("````\npublic void HelloWorld();\n{\n}\n````\n"); + AssertNormalizeNoTrim("````csharp\npublic void HelloWorld();\n{\n}\n````\n"); + AssertNormalizeNoTrim("````csharp hideNewKeyword=true\npublic void HelloWorld();\n{\n}\n````\n"); } [Test] @@ -91,14 +91,21 @@ line3"); 2. b - foo - bar + a) 1234 + b) 1324 3. c -", @" -1. a -2. b - - foo - - bar -3. c -"); // TODO: Bug: intend is always stripped a space. +4. c +5. c +6. c +7. c +8. c +9. c +10. c + - Foo + - Bar +11. c +12. c +"); } [Test] @@ -140,6 +147,7 @@ paragraph public void TestCodeInline() { AssertNormalizeNoTrim("This has a `HelloWorld()` in it"); + AssertNormalizeNoTrim(@"This has a ``Hello`World()`` in it"); } [Test] @@ -152,23 +160,34 @@ paragraph AssertNormalize("This is a pl*ai*n **paragraph**"); } + [Test] + public void TestLineBreak() + { + AssertNormalizeNoTrim("normal\nline break"); + AssertNormalizeNoTrim("hard \nline break"); + } + [Test] public void TestLinks() { AssertNormalize("This is a [link](http://company.com)"); AssertNormalize("This is an ![image](http://company.com)"); + + AssertNormalize(@"This is a [link](http://company.com ""Crazy Company"")"); + AssertNormalize(@"This is a [link](http://company.com ""Crazy \"" Company"")"); } [Test] public void TestHtmlEntity() { - AssertNormalizeNoTrim("This is a ä blank", "This is a ä blank"); //TODO: bug? + AssertNormalizeNoTrim("This is a ä blank"); } [Test] public void TestHtmlInline() { AssertNormalizeNoTrim("foo
bar"); + AssertNormalizeNoTrim(@"foo
bar"); } public void AssertNormalizeNoTrim(string input, string expected = null) diff --git a/src/Markdig/Renderers/Normalize/CodeBlockRenderer.cs b/src/Markdig/Renderers/Normalize/CodeBlockRenderer.cs index c7ab8f60..f43e3de2 100644 --- a/src/Markdig/Renderers/Normalize/CodeBlockRenderer.cs +++ b/src/Markdig/Renderers/Normalize/CodeBlockRenderer.cs @@ -26,17 +26,19 @@ namespace Markdig.Renderers.Normalize { renderer.Write(fencedCodeBlock.Info); } - if (fencedCodeBlock.Arguments != null) + if (string.IsNullOrEmpty(fencedCodeBlock.Arguments) == false) { renderer.Write(" ").Write(fencedCodeBlock.Arguments); } + /* TODO do we need this causes a empty space and would render html attributes to markdown. var attributes = obj.TryGetAttributes(); if (attributes != null) { renderer.Write(" "); renderer.Write(attributes); } + */ renderer.WriteLine(); renderer.WriteLeafRawLines(obj, true); diff --git a/src/Markdig/Renderers/Normalize/Inlines/CodeInlineRenderer.cs b/src/Markdig/Renderers/Normalize/Inlines/CodeInlineRenderer.cs index 7eace1e4..e213fe98 100644 --- a/src/Markdig/Renderers/Normalize/Inlines/CodeInlineRenderer.cs +++ b/src/Markdig/Renderers/Normalize/Inlines/CodeInlineRenderer.cs @@ -13,9 +13,11 @@ namespace Markdig.Renderers.Normalize.Inlines { protected override void Write(NormalizeRenderer renderer, CodeInline obj) { - renderer.Write(obj.Delimiter); - renderer.Write(obj.Content); // TODO: escape ` - renderer.Write(obj.Delimiter); + var delimiter = obj.Content.Contains(obj.Delimiter + "") ? new string(obj.Delimiter, 2) : obj.Delimiter + ""; + + renderer.Write(delimiter); + renderer.Write(obj.Content); + renderer.Write(delimiter); } } } \ No newline at end of file diff --git a/src/Markdig/Renderers/Normalize/Inlines/LineBreakInlineRenderer.cs b/src/Markdig/Renderers/Normalize/Inlines/LineBreakInlineRenderer.cs index 4cdad0fe..7a6670b0 100644 --- a/src/Markdig/Renderers/Normalize/Inlines/LineBreakInlineRenderer.cs +++ b/src/Markdig/Renderers/Normalize/Inlines/LineBreakInlineRenderer.cs @@ -18,7 +18,11 @@ namespace Markdig.Renderers.Normalize.Inlines protected override void Write(NormalizeRenderer renderer, LineBreakInline obj) { - // TODO: handle hard + if (obj.IsHard) + { + renderer.Write(" "); + } + renderer.WriteLine(); } } diff --git a/src/Markdig/Renderers/Normalize/Inlines/LinkInlineRenderer.cs b/src/Markdig/Renderers/Normalize/Inlines/LinkInlineRenderer.cs index a2dddac8..046aed0b 100644 --- a/src/Markdig/Renderers/Normalize/Inlines/LinkInlineRenderer.cs +++ b/src/Markdig/Renderers/Normalize/Inlines/LinkInlineRenderer.cs @@ -27,7 +27,7 @@ namespace Markdig.Renderers.Normalize.Inlines if (!string.IsNullOrEmpty(link.Title)) { renderer.Write(" \""); - renderer.Write(link.Title); // TODO: escape " + renderer.Write(link.Title.Replace(@"""", @"\""")); renderer.Write("\""); } diff --git a/src/Markdig/Renderers/Normalize/Inlines/NormalizeHtmlEntityInlineRenderer.cs b/src/Markdig/Renderers/Normalize/Inlines/NormalizeHtmlEntityInlineRenderer.cs index 2d7883c7..54ea1c51 100644 --- a/src/Markdig/Renderers/Normalize/Inlines/NormalizeHtmlEntityInlineRenderer.cs +++ b/src/Markdig/Renderers/Normalize/Inlines/NormalizeHtmlEntityInlineRenderer.cs @@ -12,7 +12,7 @@ namespace Markdig.Renderers.Normalize.Inlines { protected override void Write(NormalizeRenderer renderer, HtmlEntityInline obj) { - renderer.Write(obj.Transcoded); + renderer.Write(obj.Original); } } } \ No newline at end of file diff --git a/src/Markdig/Renderers/Normalize/ListRenderer.cs b/src/Markdig/Renderers/Normalize/ListRenderer.cs index a60c8cea..bd97d410 100644 --- a/src/Markdig/Renderers/Normalize/ListRenderer.cs +++ b/src/Markdig/Renderers/Normalize/ListRenderer.cs @@ -37,7 +37,7 @@ namespace Markdig.Renderers.Normalize renderer.Write(index + ""); renderer.Write(listBlock.OrderedDelimiter); renderer.Write(' '); - renderer.PushIndent(" "); // TODO: output accurate indent + renderer.PushIndent(new string(' ', IntLog10Fast(index) + 3)); renderer.WriteChildren(listItem); renderer.PopIndent(); switch (listBlock.BulletType) @@ -64,5 +64,17 @@ namespace Markdig.Renderers.Normalize renderer.CompactParagraph = compact; renderer.WriteLine(); } + + + public int IntLog10Fast(int input) => + (input < 10) ? 0 : + (input < 100) ? 1 : + (input < 1000) ? 2 : + (input < 10000) ? 3 : + (input < 100000) ? 4 : + (input < 1000000) ? 5 : + (input < 10000000) ? 6 : + (input < 100000000) ? 7 : + (input < 1000000000) ? 8 : 9; } } \ No newline at end of file From 34579b51a1abe10b180ffb8734346bbb1f23a65b Mon Sep 17 00:00:00 2001 From: "T. Thiery" Date: Mon, 18 Sep 2017 23:04:08 +0200 Subject: [PATCH 09/14] Relabeled unit tests. --- src/Markdig.Tests/TestNormalize.cs | 97 +++++++++---------- .../Renderers/Normalize/ListRenderer.cs | 7 +- .../Renderers/Normalize/QuoteBlockRenderer.cs | 6 ++ 3 files changed, 60 insertions(+), 50 deletions(-) diff --git a/src/Markdig.Tests/TestNormalize.cs b/src/Markdig.Tests/TestNormalize.cs index 8a552781..46f40314 100644 --- a/src/Markdig.Tests/TestNormalize.cs +++ b/src/Markdig.Tests/TestNormalize.cs @@ -10,9 +10,8 @@ namespace Markdig.Tests [TestFixture] public class TestNormalize { - [Test] - public void TestCodeBlock() + public void TestNormalizeCodeBlock() { AssertNormalizeNoTrim(" public void HelloWorld();\n {\n }\n\n"); AssertNormalizeNoTrim("````\npublic void HelloWorld();\n{\n}\n````\n"); @@ -21,7 +20,7 @@ namespace Markdig.Tests } [Test] - public void TestHeading() + public void TestNormalizeHeading() { AssertNormalizeNoTrim("# Heading\n\n"); AssertNormalizeNoTrim("## Heading\n\n"); @@ -34,7 +33,7 @@ namespace Markdig.Tests } [Test] - public void TestHtml() + public void TestNormalizeHtml() { /*AssertNormalizeNoTrim(@"
@@ -42,10 +41,10 @@ namespace Markdig.Tests } [Test] - public void TestParagraph() + public void TestNormalizeParagraph() { - AssertNormalize("This is a plain paragraph"); - AssertNormalize(@"This + AssertNormalizeNoTrim("This is a plain paragraph"); + AssertNormalizeNoTrim(@"This is a plain @@ -53,9 +52,9 @@ paragraph"); } [Test] - public void TestParagraphMulti() + public void TestNormalizeParagraphMulti() { - AssertNormalize(@"line1 + AssertNormalizeNoTrim(@"line1 line2 @@ -63,31 +62,26 @@ line3"); } [Test] - public void TestListUnordered() + public void TestNormalizeListUnordered() { - AssertNormalize(@" -- a + AssertNormalizeNoTrim(@"- a - b -- c -"); +- c"); } [Test] - public void TestListOrdered() + public void TestNormalizeListOrdered() { - AssertNormalize(@" -1. a + AssertNormalizeNoTrim(@"1. a 2. b -3. c -"); +3. c"); } [Test] - public void TestListOrderedAndIntended() + public void TestNormalizeListOrderedAndIntended() { - AssertNormalize(@" -1. a + AssertNormalizeNoTrim(@"1. a 2. b - foo - bar @@ -104,33 +98,38 @@ line3"); - Foo - Bar 11. c -12. c -"); +12. c"); } [Test] - public void TestHeaderAndParagraph() + public void TestNormalizeHeaderAndParagraph() { - AssertNormalize(@" -# heading + AssertNormalizeNoTrim(@"# heading paragraph -"); + +paragraph2 without newlines"); } [Test] - public void TestQuote() + public void TestNormalizeQuoteBlock() { - AssertNormalize(@" -> test1 + AssertNormalizeNoTrim(@"> test1 > +> test2"); + + AssertNormalizeNoTrim(@"> test1 +> -foobar + +asdf + > test2 -"); +> -foobar sen."); } [Test] - public void TestThematicBreak() + public void TestNormalizeThematicBreak() { AssertNormalizeNoTrim("***\n"); @@ -138,53 +137,53 @@ paragraph } [Test] - public void TestAutolinkInline() + public void TestNormalizeAutolinkInline() { AssertNormalizeNoTrim("This has a "); } [Test] - public void TestCodeInline() + public void TestNormalizeCodeInline() { AssertNormalizeNoTrim("This has a `HelloWorld()` in it"); AssertNormalizeNoTrim(@"This has a ``Hello`World()`` in it"); } [Test] - public void TestEmphasis() + public void TestNormalizeEmphasisInline() { - AssertNormalize("This is a plain **paragraph**"); - AssertNormalize("This is a plain *paragraph*"); - AssertNormalize("This is a plain _paragraph_"); - AssertNormalize("This is a plain __paragraph__"); - AssertNormalize("This is a pl*ai*n **paragraph**"); + AssertNormalizeNoTrim("This is a plain **paragraph**"); + AssertNormalizeNoTrim("This is a plain *paragraph*"); + AssertNormalizeNoTrim("This is a plain _paragraph_"); + AssertNormalizeNoTrim("This is a plain __paragraph__"); + AssertNormalizeNoTrim("This is a pl*ai*n **paragraph**"); } [Test] - public void TestLineBreak() + public void TestNormalizeLineBreakInline() { AssertNormalizeNoTrim("normal\nline break"); AssertNormalizeNoTrim("hard \nline break"); } [Test] - public void TestLinks() + public void TestNormalizeLinkInline() { - AssertNormalize("This is a [link](http://company.com)"); - AssertNormalize("This is an ![image](http://company.com)"); + AssertNormalizeNoTrim("This is a [link](http://company.com)"); + AssertNormalizeNoTrim("This is an ![image](http://company.com)"); - AssertNormalize(@"This is a [link](http://company.com ""Crazy Company"")"); - AssertNormalize(@"This is a [link](http://company.com ""Crazy \"" Company"")"); + AssertNormalizeNoTrim(@"This is a [link](http://company.com ""Crazy Company"")"); + AssertNormalizeNoTrim(@"This is a [link](http://company.com ""Crazy \"" Company"")"); } [Test] - public void TestHtmlEntity() + public void TestNormalizeHtmlEntityInline() { AssertNormalizeNoTrim("This is a ä blank"); } [Test] - public void TestHtmlInline() + public void TestNormalizeHtmlInline() { AssertNormalizeNoTrim("foo
bar"); AssertNormalizeNoTrim(@"foo
bar"); diff --git a/src/Markdig/Renderers/Normalize/ListRenderer.cs b/src/Markdig/Renderers/Normalize/ListRenderer.cs index bd97d410..b9a5b643 100644 --- a/src/Markdig/Renderers/Normalize/ListRenderer.cs +++ b/src/Markdig/Renderers/Normalize/ListRenderer.cs @@ -62,7 +62,12 @@ namespace Markdig.Renderers.Normalize } renderer.CompactParagraph = compact; - renderer.WriteLine(); + + if (!renderer.IsLastInContainer && !renderer.CompactParagraph) + { + renderer.WriteLine(); + renderer.WriteLine(); + } } diff --git a/src/Markdig/Renderers/Normalize/QuoteBlockRenderer.cs b/src/Markdig/Renderers/Normalize/QuoteBlockRenderer.cs index bd4329fe..22a9168b 100644 --- a/src/Markdig/Renderers/Normalize/QuoteBlockRenderer.cs +++ b/src/Markdig/Renderers/Normalize/QuoteBlockRenderer.cs @@ -16,6 +16,12 @@ namespace Markdig.Renderers.Normalize renderer.PushIndent(obj.QuoteChar + " "); renderer.WriteChildren(obj); renderer.PopIndent(); + + if (!renderer.IsLastInContainer && !renderer.CompactParagraph) + { + renderer.WriteLine(); + renderer.WriteLine(); + } } } } \ No newline at end of file From c63392657d653a750a2b7cb4cdf06e21b98c37d2 Mon Sep 17 00:00:00 2001 From: "T. Thiery" Date: Mon, 18 Sep 2017 23:28:34 +0200 Subject: [PATCH 10/14] Add finish block method and adjusted naming in test suite. --- src/Markdig.Tests/TestNormalize.cs | 61 ++++++++++--------- .../Renderers/Normalize/CodeBlockRenderer.cs | 9 ++- .../Renderers/Normalize/HeadingRenderer.cs | 3 +- .../Renderers/Normalize/ListRenderer.cs | 6 +- .../Renderers/Normalize/NormalizeRenderer.cs | 9 +++ .../Renderers/Normalize/ParagraphRenderer.cs | 7 +-- .../Renderers/Normalize/QuoteBlockRenderer.cs | 6 +- .../Normalize/ThematicBreakRenderer.cs | 2 + 8 files changed, 55 insertions(+), 48 deletions(-) diff --git a/src/Markdig.Tests/TestNormalize.cs b/src/Markdig.Tests/TestNormalize.cs index 46f40314..60e42b9f 100644 --- a/src/Markdig.Tests/TestNormalize.cs +++ b/src/Markdig.Tests/TestNormalize.cs @@ -4,6 +4,7 @@ using System; using NUnit.Framework; +using Markdig.Syntax; namespace Markdig.Tests { @@ -11,29 +12,31 @@ namespace Markdig.Tests public class TestNormalize { [Test] - public void TestNormalizeCodeBlock() + public void TestNormalizeRoundtripCodeBlock() { - AssertNormalizeNoTrim(" public void HelloWorld();\n {\n }\n\n"); - AssertNormalizeNoTrim("````\npublic void HelloWorld();\n{\n}\n````\n"); - AssertNormalizeNoTrim("````csharp\npublic void HelloWorld();\n{\n}\n````\n"); - AssertNormalizeNoTrim("````csharp hideNewKeyword=true\npublic void HelloWorld();\n{\n}\n````\n"); + AssertNormalizeNoTrim(" public void HelloWorld();\n {\n }"); + AssertNormalizeNoTrim(" public void HelloWorld();\n {\n }\n\ntext after two newlines"); + AssertNormalizeNoTrim("````\npublic void HelloWorld();\n{\n}\n````\n\ntext after two newlines"); + AssertNormalizeNoTrim("````csharp\npublic void HelloWorld();\n{\n}\n````"); + AssertNormalizeNoTrim("````csharp hideNewKeyword=true\npublic void HelloWorld();\n{\n}\n````"); } [Test] - public void TestNormalizeHeading() + public void TestNormalizeRoundtripHeading() { - AssertNormalizeNoTrim("# Heading\n\n"); - AssertNormalizeNoTrim("## Heading\n\n"); - AssertNormalizeNoTrim("### Heading\n\n"); - AssertNormalizeNoTrim("#### Heading\n\n"); - AssertNormalizeNoTrim("##### Heading\n\n"); - AssertNormalizeNoTrim("###### Heading\n\n"); + AssertNormalizeNoTrim("# Heading"); + AssertNormalizeNoTrim("## Heading"); + AssertNormalizeNoTrim("### Heading"); + AssertNormalizeNoTrim("#### Heading"); + AssertNormalizeNoTrim("##### Heading"); + AssertNormalizeNoTrim("###### Heading"); + AssertNormalizeNoTrim("###### Heading\n\ntext after two newlines"); - AssertNormalizeNoTrim("Heading\n=======\n\n", "# Heading\n\n"); + AssertNormalizeNoTrim("Heading\n=======\n\ntext after two newlines", "# Heading\n\ntext after two newlines"); } [Test] - public void TestNormalizeHtml() + public void TestNormalizeRoundtripHtml() { /*AssertNormalizeNoTrim(@"
@@ -41,7 +44,7 @@ namespace Markdig.Tests } [Test] - public void TestNormalizeParagraph() + public void TestNormalizeRoundtripParagraph() { AssertNormalizeNoTrim("This is a plain paragraph"); AssertNormalizeNoTrim(@"This @@ -52,7 +55,7 @@ paragraph"); } [Test] - public void TestNormalizeParagraphMulti() + public void TestNormalizeRoundtripParagraphMulti() { AssertNormalizeNoTrim(@"line1 @@ -62,7 +65,7 @@ line3"); } [Test] - public void TestNormalizeListUnordered() + public void TestNormalizeRoundtripListUnordered() { AssertNormalizeNoTrim(@"- a - b @@ -70,7 +73,7 @@ line3"); } [Test] - public void TestNormalizeListOrdered() + public void TestNormalizeRoundtripListOrdered() { AssertNormalizeNoTrim(@"1. a 2. b @@ -79,7 +82,7 @@ line3"); [Test] - public void TestNormalizeListOrderedAndIntended() + public void TestNormalizeRoundtripListOrderedAndIntended() { AssertNormalizeNoTrim(@"1. a 2. b @@ -102,7 +105,7 @@ line3"); } [Test] - public void TestNormalizeHeaderAndParagraph() + public void TestNormalizeRoundtripHeaderAndParagraph() { AssertNormalizeNoTrim(@"# heading @@ -113,7 +116,7 @@ paragraph2 without newlines"); [Test] - public void TestNormalizeQuoteBlock() + public void TestNormalizeRoundtripQuoteBlock() { AssertNormalizeNoTrim(@"> test1 > @@ -129,7 +132,7 @@ asdf } [Test] - public void TestNormalizeThematicBreak() + public void TestNormalizeRoundtripThematicBreak() { AssertNormalizeNoTrim("***\n"); @@ -137,20 +140,20 @@ asdf } [Test] - public void TestNormalizeAutolinkInline() + public void TestNormalizeRoundtripAutolinkInline() { AssertNormalizeNoTrim("This has a "); } [Test] - public void TestNormalizeCodeInline() + public void TestNormalizeRoundtripCodeInline() { AssertNormalizeNoTrim("This has a `HelloWorld()` in it"); AssertNormalizeNoTrim(@"This has a ``Hello`World()`` in it"); } [Test] - public void TestNormalizeEmphasisInline() + public void TestNormalizeRoundtripEmphasisInline() { AssertNormalizeNoTrim("This is a plain **paragraph**"); AssertNormalizeNoTrim("This is a plain *paragraph*"); @@ -160,14 +163,14 @@ asdf } [Test] - public void TestNormalizeLineBreakInline() + public void TestNormalizeRoundtripLineBreakInline() { AssertNormalizeNoTrim("normal\nline break"); AssertNormalizeNoTrim("hard \nline break"); } [Test] - public void TestNormalizeLinkInline() + public void TestNormalizeRoundtripLinkInline() { AssertNormalizeNoTrim("This is a [link](http://company.com)"); AssertNormalizeNoTrim("This is an ![image](http://company.com)"); @@ -177,13 +180,13 @@ asdf } [Test] - public void TestNormalizeHtmlEntityInline() + public void TestNormalizeRoundtripHtmlEntityInline() { AssertNormalizeNoTrim("This is a ä blank"); } [Test] - public void TestNormalizeHtmlInline() + public void TestNormalizeRoundtripHtmlInline() { AssertNormalizeNoTrim("foo
bar"); AssertNormalizeNoTrim(@"foo
bar"); diff --git a/src/Markdig/Renderers/Normalize/CodeBlockRenderer.cs b/src/Markdig/Renderers/Normalize/CodeBlockRenderer.cs index f43e3de2..3c92121c 100644 --- a/src/Markdig/Renderers/Normalize/CodeBlockRenderer.cs +++ b/src/Markdig/Renderers/Normalize/CodeBlockRenderer.cs @@ -42,12 +42,15 @@ namespace Markdig.Renderers.Normalize renderer.WriteLine(); renderer.WriteLeafRawLines(obj, true); - renderer.WriteLine(opening); + renderer.Write(opening); + + renderer.FinishBlock(); } else { - renderer.WriteLeafRawLines(obj, true, true); - renderer.WriteLine(); + renderer.WriteLeafRawLines(obj, false, true); + + renderer.FinishBlock(); } } } diff --git a/src/Markdig/Renderers/Normalize/HeadingRenderer.cs b/src/Markdig/Renderers/Normalize/HeadingRenderer.cs index ee7c91d3..6a467a4a 100644 --- a/src/Markdig/Renderers/Normalize/HeadingRenderer.cs +++ b/src/Markdig/Renderers/Normalize/HeadingRenderer.cs @@ -29,7 +29,8 @@ namespace Markdig.Renderers.Normalize renderer.Write(headingText).Write(' '); renderer.WriteLeafInline(obj); - renderer.WriteLine().WriteLine(); + + renderer.FinishBlock(); } } } \ No newline at end of file diff --git a/src/Markdig/Renderers/Normalize/ListRenderer.cs b/src/Markdig/Renderers/Normalize/ListRenderer.cs index b9a5b643..81960847 100644 --- a/src/Markdig/Renderers/Normalize/ListRenderer.cs +++ b/src/Markdig/Renderers/Normalize/ListRenderer.cs @@ -63,11 +63,7 @@ namespace Markdig.Renderers.Normalize renderer.CompactParagraph = compact; - if (!renderer.IsLastInContainer && !renderer.CompactParagraph) - { - renderer.WriteLine(); - renderer.WriteLine(); - } + renderer.FinishBlock(); } diff --git a/src/Markdig/Renderers/Normalize/NormalizeRenderer.cs b/src/Markdig/Renderers/Normalize/NormalizeRenderer.cs index 17d91189..cc833c75 100644 --- a/src/Markdig/Renderers/Normalize/NormalizeRenderer.cs +++ b/src/Markdig/Renderers/Normalize/NormalizeRenderer.cs @@ -48,6 +48,15 @@ namespace Markdig.Renderers.Normalize public bool CompactParagraph { get; set; } + public void FinishBlock() + { + if (!IsLastInContainer && !CompactParagraph) + { + WriteLine(); + WriteLine(); + } + } + ///// ///// Writes the attached on the specified . ///// diff --git a/src/Markdig/Renderers/Normalize/ParagraphRenderer.cs b/src/Markdig/Renderers/Normalize/ParagraphRenderer.cs index 755042a4..d0a5cef6 100644 --- a/src/Markdig/Renderers/Normalize/ParagraphRenderer.cs +++ b/src/Markdig/Renderers/Normalize/ParagraphRenderer.cs @@ -18,11 +18,8 @@ namespace Markdig.Renderers.Normalize renderer.EnsureLine(); } renderer.WriteLeafInline(obj); - if (!renderer.IsLastInContainer && !renderer.CompactParagraph) - { - renderer.WriteLine(); - renderer.WriteLine(); - } + + renderer.FinishBlock(); } } } \ No newline at end of file diff --git a/src/Markdig/Renderers/Normalize/QuoteBlockRenderer.cs b/src/Markdig/Renderers/Normalize/QuoteBlockRenderer.cs index 22a9168b..ef478522 100644 --- a/src/Markdig/Renderers/Normalize/QuoteBlockRenderer.cs +++ b/src/Markdig/Renderers/Normalize/QuoteBlockRenderer.cs @@ -17,11 +17,7 @@ namespace Markdig.Renderers.Normalize renderer.WriteChildren(obj); renderer.PopIndent(); - if (!renderer.IsLastInContainer && !renderer.CompactParagraph) - { - renderer.WriteLine(); - renderer.WriteLine(); - } + renderer.FinishBlock(); } } } \ No newline at end of file diff --git a/src/Markdig/Renderers/Normalize/ThematicBreakRenderer.cs b/src/Markdig/Renderers/Normalize/ThematicBreakRenderer.cs index 2aa90c15..aee32e0c 100644 --- a/src/Markdig/Renderers/Normalize/ThematicBreakRenderer.cs +++ b/src/Markdig/Renderers/Normalize/ThematicBreakRenderer.cs @@ -14,6 +14,8 @@ namespace Markdig.Renderers.Normalize protected override void Write(NormalizeRenderer renderer, ThematicBreakBlock obj) { renderer.WriteLine(new string(obj.ThematicChar, obj.ThematicCharCount)); + + renderer.FinishBlock(); } } } \ No newline at end of file From 600219529cd4682f27160a96e575dff49b85aa3b Mon Sep 17 00:00:00 2001 From: "T. Thiery" Date: Fri, 20 Oct 2017 16:10:02 +0200 Subject: [PATCH 11/14] Add test approach for AST based arrange. --- src/Markdig.Tests/TestNormalize.cs | 96 ++++++++++++++++++++++++++++++ 1 file changed, 96 insertions(+) diff --git a/src/Markdig.Tests/TestNormalize.cs b/src/Markdig.Tests/TestNormalize.cs index 60e42b9f..bfea758e 100644 --- a/src/Markdig.Tests/TestNormalize.cs +++ b/src/Markdig.Tests/TestNormalize.cs @@ -5,12 +5,86 @@ using System; using NUnit.Framework; using Markdig.Syntax; +using Markdig.Syntax.Inlines; +using System.IO; +using Markdig.Renderers.Normalize; +using Markdig.Helpers; namespace Markdig.Tests { [TestFixture] public class TestNormalize { + [Test] + public void TestNormalizeSyntaxCodeBlock() + { + AssertSyntax("````csharp\npublic void HelloWorld()\n{\n}\n````", new FencedCodeBlock(null) + { + FencedChar = '`', + FencedCharCount = 4, + Info = "csharp", + Lines = new StringLineGroup(4) + { + new StringSlice("public void HelloWorld()"), + new StringSlice("{"), + new StringSlice("}"), + } + }); + + AssertSyntax(" public void HelloWorld()\n {\n }", new CodeBlock(null) + { + Lines = new StringLineGroup(4) + { + new StringSlice("public void HelloWorld()"), + new StringSlice("{"), + new StringSlice("}"), + } + }); + } + + [Test] + public void TestNormalizeSyntaxHeadline() + { + AssertSyntax("## Headline", new HeadingBlock(null) + { + HeaderChar = '#', + Level = 2, + Inline = new ContainerInline().AppendChild(new LiteralInline("Headline")), + }); + } + + [Test] + public void TestNormalizeSyntaxParagraph() + { + AssertSyntax("This is a normal paragraph", new ParagraphBlock() + { + Inline = new ContainerInline() + .AppendChild(new LiteralInline("This is a normal paragraph")), + }); + + AssertSyntax("This is a\nnormal\nparagraph", new ParagraphBlock() + { + Inline = new ContainerInline() + .AppendChild(new LiteralInline("This is a")) + .AppendChild(new LineBreakInline()) + .AppendChild(new LiteralInline("normal")) + .AppendChild(new LineBreakInline()) + .AppendChild(new LiteralInline("paragraph")), + }); + } + + [Test] + public void TestNormalizeSyntaxUnorderedList() + { + AssertSyntax("- Foo\n- Bar\n- Foobar", new ListBlock(null) + { + IsOrdered = false, + BulletType = '-', + + new ContainerInline().AppendChild(new LiteralInline("Foo")), + }); + } + [Test] public void TestNormalizeRoundtripCodeBlock() { @@ -192,6 +266,28 @@ asdf AssertNormalizeNoTrim(@"foo
bar"); } + + + private static void AssertSyntax(string expected, MarkdownObject syntax) + { + var writer = new StringWriter(); + var normalizer = new NormalizeRenderer(writer); + var document = new MarkdownDocument(); + if (syntax is Block) + { + document.Add(syntax as Block); + } + else + { + throw new InvalidOperationException(); + } + normalizer.Render(document); + + var actual = writer.ToString(); + + Assert.AreEqual(expected, actual); + } + public void AssertNormalizeNoTrim(string input, string expected = null) => AssertNormalize(input, expected, false); From 7174e32b7a7341d1c924f445b853cd52ad71728e Mon Sep 17 00:00:00 2001 From: "T. Thiery" Date: Tue, 24 Oct 2017 15:51:13 +0200 Subject: [PATCH 12/14] Remove incomplete UnorderedList syntax test case --- src/Markdig.Tests/TestNormalize.cs | 12 ------------ 1 file changed, 12 deletions(-) diff --git a/src/Markdig.Tests/TestNormalize.cs b/src/Markdig.Tests/TestNormalize.cs index bfea758e..acbeb2ef 100644 --- a/src/Markdig.Tests/TestNormalize.cs +++ b/src/Markdig.Tests/TestNormalize.cs @@ -73,18 +73,6 @@ namespace Markdig.Tests }); } - [Test] - public void TestNormalizeSyntaxUnorderedList() - { - AssertSyntax("- Foo\n- Bar\n- Foobar", new ListBlock(null) - { - IsOrdered = false, - BulletType = '-', - - new ContainerInline().AppendChild(new LiteralInline("Foo")), - }); - } - [Test] public void TestNormalizeRoundtripCodeBlock() { From 72c2c06fcb16c846d505e59df9108781b7df1a3d Mon Sep 17 00:00:00 2001 From: "T. Thiery" Date: Tue, 24 Oct 2017 15:58:44 +0200 Subject: [PATCH 13/14] Add normalization tests for space between leaves. --- src/Markdig.Tests/TestNormalize.cs | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/src/Markdig.Tests/TestNormalize.cs b/src/Markdig.Tests/TestNormalize.cs index acbeb2ef..f4802479 100644 --- a/src/Markdig.Tests/TestNormalize.cs +++ b/src/Markdig.Tests/TestNormalize.cs @@ -255,6 +255,33 @@ asdf } + [Test] + public void TestNormalizeRoundtripSpaceBetweenNodes() + { + AssertNormalizeNoTrim("# Hello World\nFoobar is a better bar.", + "# Hello World\n\nFoobar is a better bar."); + } + + [Test] + public void TestNormalizeRoundtripSpaceBetweenNodesEvenForHeadlines() + { + AssertNormalizeNoTrim("# Hello World\n## Chapter 1\nFoobar is a better bar.", + "# Hello World\n\n## Chapter 1\n\nFoobar is a better bar."); + } + + [Test] + public void TestNormalizeRoundtripSpaceRemoveAtStartAndEnd() + { + AssertNormalizeNoTrim("\n\n# Hello World\n## Chapter 1\nFoobar is a better bar.\n\n", + "# Hello World\n\n## Chapter 1\n\nFoobar is a better bar."); + } + + [Test] + public void TestNormalizeRoundtripSpaceShortenBetweenNodes() + { + AssertNormalizeNoTrim("# Hello World\n\n\n\nFoobar is a better bar.", + "# Hello World\n\nFoobar is a better bar."); + } private static void AssertSyntax(string expected, MarkdownObject syntax) { From 59630aec8e486d9d805a3681ff25978b3631a056 Mon Sep 17 00:00:00 2001 From: "T. Thiery" Date: Tue, 24 Oct 2017 17:27:42 +0200 Subject: [PATCH 14/14] Review Fix: Make IntLog10Fast method private static. --- src/Markdig/Renderers/Normalize/ListRenderer.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Markdig/Renderers/Normalize/ListRenderer.cs b/src/Markdig/Renderers/Normalize/ListRenderer.cs index 81960847..c898f590 100644 --- a/src/Markdig/Renderers/Normalize/ListRenderer.cs +++ b/src/Markdig/Renderers/Normalize/ListRenderer.cs @@ -67,7 +67,7 @@ namespace Markdig.Renderers.Normalize } - public int IntLog10Fast(int input) => + private static int IntLog10Fast(int input) => (input < 10) ? 0 : (input < 100) ? 1 : (input < 1000) ? 2 :