org.sonar.markdown.HtmlMultilineCodeChannel Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of sonarlint-core Show documentation

Common library used by some SonarLint flavors

There is a newer version: 10.5.0.78949

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

  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("");
    output.append(regexpMatcher.group(2));
    output.append("
");
  }
}