From cd4a931a8de29b68aa3bdfedd2f030c00a369ae0 Mon Sep 17 00:00:00 2001 From: Fabrice Bellingard Date: Thu, 16 Feb 2012 19:01:04 +0100 Subject: SONAR-3269 Add multiline code support on Sonar markdown --- .../sonar/markdown/HtmlMultilineCodeChannel.java | 47 ++++++++++++++++++++++ .../src/main/java/org/sonar/markdown/Markdown.java | 1 + 2 files changed, 48 insertions(+) create mode 100644 sonar-markdown/src/main/java/org/sonar/markdown/HtmlMultilineCodeChannel.java (limited to 'sonar-markdown/src/main') diff --git a/sonar-markdown/src/main/java/org/sonar/markdown/HtmlMultilineCodeChannel.java b/sonar-markdown/src/main/java/org/sonar/markdown/HtmlMultilineCodeChannel.java new file mode 100644 index 00000000000..1b032126031 --- /dev/null +++ b/sonar-markdown/src/main/java/org/sonar/markdown/HtmlMultilineCodeChannel.java @@ -0,0 +1,47 @@ +/* + * Sonar, open source software quality management tool. + * Copyright (C) 2008-2012 SonarSource + * mailto:contact AT sonarsource DOT com + * + * Sonar is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 3 of the License, or (at your option) any later version. + * + * Sonar is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with Sonar; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02 + */ +package org.sonar.markdown; + +import org.sonar.channel.RegexChannel; + +/** + * Markdown treats double backtick quote (``) as indicators of code. Text wrapped with two `` and that spans on multiple lines will be wrapped with + * an HTML {@literal
} tag.
+ * 
+ * E.g., the input:
+ * ``This code
+ *   spans on 2 lines`` 
+ * will produce:
+ * {@literal
}{@literal}This code
+ * spans on 2 lines{@literal}{@literal
} + */ +class HtmlMultilineCodeChannel extends RegexChannel { + + public HtmlMultilineCodeChannel() { + super("``[\\s\\S]+?``"); + } + + @Override + protected void consume(CharSequence token, MarkdownOutput output) { + output.append("
");
+    output.append(token.subSequence(2, token.length() - 2));
+    output.append("
"); + } +} diff --git a/sonar-markdown/src/main/java/org/sonar/markdown/Markdown.java b/sonar-markdown/src/main/java/org/sonar/markdown/Markdown.java index e04060508d3..4e16fffb261 100644 --- a/sonar-markdown/src/main/java/org/sonar/markdown/Markdown.java +++ b/sonar-markdown/src/main/java/org/sonar/markdown/Markdown.java @@ -36,6 +36,7 @@ public final class Markdown { .addChannel(new HtmlEmphasisChannel()) .addChannel(new HtmlListChannel()) .addChannel(new HtmlCodeChannel()) + .addChannel(new HtmlMultilineCodeChannel()) .addChannel(new IdentifierAndNumberChannel()) .addChannel(new BlackholeChannel()) .build(); -- cgit v1.2.3