aboutsummaryrefslogtreecommitdiffstats
path: root/sonar-markdown/src/main/java/org/sonar/markdown/HtmlMultilineCodeChannel.java
blob: 4e95b2fa9a9efa9324c154a1a736e621bc344d62 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
/*
 * SonarQube
 * Copyright (C) 2009-2025 SonarSource SA
 * mailto:info AT sonarsource DOT com
 *
 * This program 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.
 *
 * This program 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 this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
package org.sonar.markdown;

import java.util.regex.Matcher;
import java.util.regex.Pattern;

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 <pre><code>} tag.
 * 
 * E.g., the input:
 * <pre>
 * ``
 * This code
 * spans on 2 lines
 * ``
 * </pre> 
 * will produce:
 * {@literal<pre>}{@literal<code>}This code
 * spans on 2 lines{@literal</code>}{@literal</pre>}
 *
 * @since 2.14
 */
class HtmlMultilineCodeChannel extends RegexChannel<MarkdownOutput> {

  private static final String NEWLINE = "(?:\\n\\r|\\r|\\n)";
  private static final String LANGUAGE = "([a-zA-Z][a-zA-Z0-9_]*+)?";
  private static final String DETECTION_REGEXP = "``" + LANGUAGE + NEWLINE + "([\\s\\S]+?)" + NEWLINE + "``";

  private final Matcher regexpMatcher;

  public HtmlMultilineCodeChannel() {
    super(DETECTION_REGEXP);
    regexpMatcher = Pattern.compile(DETECTION_REGEXP).matcher("");
  }

  @Override
  protected void consume(CharSequence token, MarkdownOutput output) {
    regexpMatcher.reset(token);
    regexpMatcher.matches();
    output.append("<pre");
    String language = regexpMatcher.group(1);
    if (language != null) {
      output.append(" lang=\"");
      output.append(language);
      output.append("\"");
    }
    output.append("><code>");
    output.append(regexpMatcher.group(2));
    output.append("</code></pre>");
  }
}