sonarqube/sonar-batch/src/main/java/org/sonar/batch/source/CodeColorizers.java

/*
 * SonarQube, open source software quality management tool.
 * Copyright (C) 2008-2014 SonarSource
 * mailto:contact AT sonarsource DOT com
 *
 * SonarQube 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.
 *
 * SonarQube 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.batch.source;

import com.google.common.collect.Lists;
import java.io.BufferedReader;
import java.io.File;
import java.io.FileInputStream;
import java.io.InputStreamReader;
import java.io.Reader;
import java.nio.charset.Charset;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import javax.annotation.CheckForNull;
import org.apache.commons.io.input.BOMInputStream;
import org.apache.commons.lang.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.sonar.api.batch.BatchSide;
import org.sonar.api.batch.sensor.highlighting.NewHighlighting;
import org.sonar.api.web.CodeColorizerFormat;
import org.sonar.colorizer.JavaTokenizers;
import org.sonar.colorizer.Tokenizer;

/**
 * Central point for sonar-colorizer extensions
 */
@BatchSide
public class CodeColorizers {

  private static final Logger LOG = LoggerFactory.getLogger(CodeColorizers.class);

  private final Map<String, CodeColorizerFormat> byLang;

  public CodeColorizers(List<CodeColorizerFormat> formats) {
    byLang = new HashMap<>();
    for (CodeColorizerFormat format : formats) {
      byLang.put(format.getLanguageKey(), format);
    }

    LOG.debug("Code colorizer, supported languages: " + StringUtils.join(byLang.keySet(), ","));
  }

  /**
   * Used when no plugin is defining some CodeColorizerFormat
   */
  public CodeColorizers() {
    this(Lists.<CodeColorizerFormat>newArrayList());
  }

  @CheckForNull
  public void toSyntaxHighlighting(File file, Charset charset, String language, NewHighlighting highlighting) {
    CodeColorizerFormat format = byLang.get(language);
    List<Tokenizer> tokenizers;
    if (format == null) {
      // Workaround for Java test code since Java plugin only provides highlighting for main source and no colorizer
      // TODO can be dropped when Java plugin embed its own CodeColorizerFormat of (better) provides highlighting for tests
      // See SONARJAVA-830
      if ("java".equals(language)) {
        tokenizers = JavaTokenizers.forHtml();
      } else {
        return;
      }
    } else {
      tokenizers = format.getTokenizers();
    }
    try (Reader reader = new BufferedReader(new InputStreamReader(new BOMInputStream(new FileInputStream(file)), charset))) {
      new HighlightingRenderer().render(reader, tokenizers, highlighting);
    } catch (Exception e) {
      LOG.warn("Unable to perform colorization of file " + file, e);
    }
  }
}