From 05673758e36dabdafd856fcff46dd4cc821e092e Mon Sep 17 00:00:00 2001 From: Alexandre Mutel Date: Fri, 24 Jun 2016 15:05:37 +0900 Subject: [PATCH] Add new SelfPipeline extension --- src/Markdig.Tests/TestParser.cs | 3 +- src/Markdig.Tests/TestPlayParser.cs | 27 +++++ .../SelfPipeline/SelfPipelineExtension.cs | 99 +++++++++++++++++++ src/Markdig/Markdown.cs | 14 +++ src/Markdig/MarkdownExtensions.cs | 23 ++++- src/Markdig/Parsers/HtmlBlockParser.cs | 2 - 6 files changed, 164 insertions(+), 4 deletions(-) create mode 100644 src/Markdig/Extensions/SelfPipeline/SelfPipelineExtension.cs diff --git a/src/Markdig.Tests/TestParser.cs b/src/Markdig.Tests/TestParser.cs index 150e4c6b..e164313c 100644 --- a/src/Markdig.Tests/TestParser.cs +++ b/src/Markdig.Tests/TestParser.cs @@ -64,7 +64,8 @@ namespace Markdig.Tests var extensionGroups = extensionsGroupText.Split(new[] { '|' }, StringSplitOptions.RemoveEmptyEntries); foreach (var extensionsText in extensionGroups) { - var pipeline = new MarkdownPipelineBuilder().Configure(extensionsText); + var builder = new MarkdownPipelineBuilder(); + var pipeline = extensionsText == "self" ? builder.UseSelfPipeline() : builder.Configure(extensionsText); yield return new KeyValuePair(extensionsText, pipeline.Build()); } } diff --git a/src/Markdig.Tests/TestPlayParser.cs b/src/Markdig.Tests/TestPlayParser.cs index 7bbf1c70..b8b3bca9 100644 --- a/src/Markdig.Tests/TestPlayParser.cs +++ b/src/Markdig.Tests/TestPlayParser.cs @@ -27,6 +27,33 @@ Later in a text we are using HTML and it becomes an abbr tag HTML Console.WriteLine(result); } + [Test] + public void TestSelfPipeline1() + { + var text = @" + +a | b +- | - +0 | 1 +"; + TestParser.TestSpec(text, @" + + + + + + + + + + + + + +
ab
01
+", "self"); + } + [Test] public void TestListBug() { diff --git a/src/Markdig/Extensions/SelfPipeline/SelfPipelineExtension.cs b/src/Markdig/Extensions/SelfPipeline/SelfPipelineExtension.cs new file mode 100644 index 00000000..5477976b --- /dev/null +++ b/src/Markdig/Extensions/SelfPipeline/SelfPipelineExtension.cs @@ -0,0 +1,99 @@ +// 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 Markdig.Renderers; + +namespace Markdig.Extensions.SelfPipeline +{ + /// + /// Extension to enable SelfPipeline, to configure a Markdown parsing/convertion to HTML automatically + /// from an embedded special tag in the input text <!--markdig:extensions--> where extensions is a string + /// that specifies the extensions to use for the pipeline as exposed by extension method + /// on the . This extension will invalidate all other extensions and will override them. + /// + public sealed class SelfPipelineExtension : IMarkdownExtension + { + public const string DefaultTag = "markdig"; + + /// + /// Initializes a new instance of the class. + /// + /// The matching start tag. + /// The default extensions. + /// Tag cannot contain `<` or `>` characters + public SelfPipelineExtension(string tag = null, string defaultExtensions = null) + { + tag = tag?.Trim(); + tag = string.IsNullOrEmpty(tag) ? DefaultTag : tag; + if (tag.IndexOfAny(new []{'<', '>'}) >= 0) + { + throw new ArgumentException("Tag cannot contain `<` or `>` characters", nameof(tag)); + } + + if (defaultExtensions != null) + { + // Check that this default pipeline is supported + // Will throw an ArgumentInvalidException if not + new MarkdownPipelineBuilder().Configure(defaultExtensions); + } + DefaultExtensions = defaultExtensions; + SelfPipelineHintTagStart = "", optionStart, StringComparison.OrdinalIgnoreCase); + if (endOfTag >= 0) + { + defaultConfig = inputText.Substring(optionStart, endOfTag - optionStart).Trim(); + } + } + + if (!string.IsNullOrEmpty(defaultConfig)) + { + builder.Configure(defaultConfig); + } + return builder.Build(); + } + } +} \ No newline at end of file diff --git a/src/Markdig/Markdown.cs b/src/Markdig/Markdown.cs index 7f10d8ed..ae030995 100644 --- a/src/Markdig/Markdown.cs +++ b/src/Markdig/Markdown.cs @@ -3,6 +3,7 @@ // See the license.txt file in the project root for more information. using System; using System.IO; +using Markdig.Extensions.SelfPipeline; using Markdig.Parsers; using Markdig.Renderers; using Markdig.Syntax; @@ -42,6 +43,7 @@ namespace Markdig if (markdown == null) throw new ArgumentNullException(nameof(markdown)); if (writer == null) throw new ArgumentNullException(nameof(writer)); pipeline = pipeline ?? new MarkdownPipelineBuilder().Build(); + pipeline = CheckForSelfPipeline(pipeline, markdown); // We override the renderer with our own writer var renderer = new HtmlRenderer(writer); @@ -67,6 +69,7 @@ namespace Markdig if (renderer == null) throw new ArgumentNullException(nameof(renderer)); pipeline = pipeline ?? new MarkdownPipelineBuilder().Build(); + pipeline = CheckForSelfPipeline(pipeline, markdown); var document = Parse(markdown, pipeline); pipeline.Setup(renderer); return renderer.Render(document); @@ -96,7 +99,18 @@ namespace Markdig if (markdown == null) throw new ArgumentNullException(nameof(markdown)); pipeline = pipeline ?? new MarkdownPipelineBuilder().Build(); + pipeline = CheckForSelfPipeline(pipeline, markdown); return MarkdownParser.Parse(markdown, pipeline); } + + private static MarkdownPipeline CheckForSelfPipeline(MarkdownPipeline pipeline, string markdown) + { + var selfPipeline = pipeline.Extensions.Find(); + if (selfPipeline != null) + { + return selfPipeline.CreatePipelineFromInput(markdown); + } + return pipeline; + } } } \ No newline at end of file diff --git a/src/Markdig/MarkdownExtensions.cs b/src/Markdig/MarkdownExtensions.cs index 1e5e2675..128d62c6 100644 --- a/src/Markdig/MarkdownExtensions.cs +++ b/src/Markdig/MarkdownExtensions.cs @@ -20,6 +20,7 @@ using Markdig.Extensions.ListExtras; using Markdig.Extensions.Mathematics; using Markdig.Extensions.MediaLinks; using Markdig.Extensions.PragmaLines; +using Markdig.Extensions.SelfPipeline; using Markdig.Extensions.SmartyPants; using Markdig.Extensions.Tables; using Markdig.Extensions.TaskLists; @@ -59,6 +60,24 @@ namespace Markdig .UseGenericAttributes(); // Must be last as it is one parser that is modifying other parsers } + /// + /// Uses the self pipeline extension that will detect the pipeline to use from the markdown input that contains a special tag. See + /// + /// The pipeline. + /// The default tag to use to match the self pipeline configuration. By default, , meaning that the HTML tag will be <--markdig:extensions--> + /// The default extensions to configure if no pipeline setup was found from the Markdown document + /// The modified pipeline + public static MarkdownPipelineBuilder UseSelfPipeline(this MarkdownPipelineBuilder pipeline, string defaultTag = SelfPipelineExtension.DefaultTag, string defaultExtensions = null) + { + if (pipeline.Extensions.Count != 0) + { + throw new InvalidOperationException("The SelfPipeline extension cannot be used with other extensions"); + } + + pipeline.Extensions.Add(new SelfPipelineExtension(defaultTag, defaultExtensions)); + return pipeline; + } + /// /// Uses pragma lines to output span with an id containing the line number (pragma-line#line_number_zero_based`) /// @@ -372,6 +391,8 @@ namespace Markdig { switch (extension.ToLowerInvariant()) { + case "common": + break; case "advanced": pipeline.UseAdvancedExtensions(); break; @@ -436,7 +457,7 @@ namespace Markdig pipeline.UseTaskLists(); break; default: - throw new ArgumentException($"unknown extension {extension}"); + throw new ArgumentException($"Invalid extension `{extension}` from `{extensions}`", nameof(extensions)); } } return pipeline; diff --git a/src/Markdig/Parsers/HtmlBlockParser.cs b/src/Markdig/Parsers/HtmlBlockParser.cs index 5c695fe5..7fb8867c 100644 --- a/src/Markdig/Parsers/HtmlBlockParser.cs +++ b/src/Markdig/Parsers/HtmlBlockParser.cs @@ -182,9 +182,7 @@ namespace Markdig.Parsers // Early exit if it is not starting by an HTML tag var line = state.Line; - var c = line.CurrentChar; var result = BlockState.Continue; - int endof; int index; switch (htmlBlock.Type) {