org.sonar.plugins.cxx.CxxPlugin Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sonar-cxx-plugin Show documentation
C++ Plugin for Sonar (Community Edition)
The newest version!
/*
 * Sonar Cxx Plugin, open source software quality management tool.
 * Copyright (C) 2010 - 2011, Neticoa SAS France - Tous droits reserves.
 * Author(s) : Franck Bonin, Neticoa SAS France.
 *
 * Sonar Cxx Plugin 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 Cxx Plugin 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 Cxx Plugin; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
 */
package org.sonar.plugins.cxx;

import java.util.ArrayList;
import java.util.List;

import org.sonar.api.Extension;
import org.sonar.api.Properties;
import org.sonar.api.Property;
import org.sonar.api.SonarPlugin;
import org.sonar.plugins.cxx.coverage.CxxCoverageSensor;
import org.sonar.plugins.cxx.cppcheck.CxxCppCheckRuleRepository;
import org.sonar.plugins.cxx.cppcheck.CxxCppCheckSensor;
import org.sonar.plugins.cxx.cppncss.CxxCppNcssSensor;
import org.sonar.plugins.cxx.externalrules.CxxExternalRulesRuleRepository;
import org.sonar.plugins.cxx.externalrules.CxxExternalRulesSensor;
import org.sonar.plugins.cxx.pclint.CxxPCLintRuleRepository;
import org.sonar.plugins.cxx.pclint.CxxPCLintSensor;
import org.sonar.plugins.cxx.rats.CxxRatsRuleRepository;
import org.sonar.plugins.cxx.rats.CxxRatsSensor;
import org.sonar.plugins.cxx.squid.CxxSquidSensor;
import org.sonar.plugins.cxx.valgrind.CxxValgrindRuleRepository;
import org.sonar.plugins.cxx.valgrind.CxxValgrindSensor;
import org.sonar.plugins.cxx.veraxx.CxxVeraxxRuleRepository;
import org.sonar.plugins.cxx.veraxx.CxxVeraxxSensor;
import org.sonar.plugins.cxx.xunit.CxxXunitSensor;

@Properties({
    @Property(
      key = CxxPlugin.SOURCE_FILE_SUFFIXES_KEY,
      defaultValue = CxxLanguage.DEFAULT_SOURCE_SUFFIXES,
      name = "Source files suffixes",
      description = "Comma-separated list of suffixes for source files to analyze. Leave empty to use the default.",
      global = true,
      project = true),
    @Property(
        key = CxxPlugin.HEADER_FILE_SUFFIXES_KEY,
        defaultValue = CxxLanguage.DEFAULT_HEADER_SUFFIXES,
        name = "Header files suffixes",
        description = "Comma-separated list of suffixes for header files to analyze. Leave empty to use the default.",
        global = true,
        project = true),
    @Property(
      key = CxxCppCheckSensor.REPORT_PATH_KEY,
      defaultValue = "",
      name = "Path to cppcheck report(s)",
      description = "Relative to projects' root. Ant patterns are accepted",
      global = false,
      project = true),
    @Property(
      key = CxxPCLintSensor.REPORT_PATH_KEY,
      defaultValue = "",
      name = "Path to pclint report(s)",
      description = "Relative to projects' root. Ant patterns are accepted",
      global = false,
      project = true),
    @Property(
      key = CxxCppNcssSensor.REPORT_PATH_KEY,
      defaultValue = "",
      name = "Path to cppncss report(s)",
      description = "Relative to projects' root. Ant patterns are accepted",
      global = false,
      project = true),
    @Property(
      key = CxxCoverageSensor.REPORT_PATH_KEY,
      defaultValue = "",
      name = "Path to unit test coverage report(s)",
      description = "Relative to projects' root. Ant patterns are accepted",
      global = false,
      project = true),
    @Property(
      key = CxxCoverageSensor.IT_REPORT_PATH_KEY,
      defaultValue = "",
      name = "Path to integration test coverage report(s)",
      description = "Relative to projects' root. Ant patterns are accepted",
      global = false,
      project = true),
    @Property(
      key = CxxCoverageSensor.OVERALL_REPORT_PATH_KEY,
      defaultValue = "",
      name = "Path to overall test coverage report(s)",
      description = "Relative to projects' root. Ant patterns are accepted",
      global = false,
      project = true),
    @Property(
      key = CxxRatsSensor.REPORT_PATH_KEY,
      defaultValue = "",
      name = "Path to rats report(s)",
      description = "Relative to projects' root. Ant patterns are accepted",
      global = false,
      project = true),
    @Property(
      key = CxxValgrindSensor.REPORT_PATH_KEY,
      defaultValue = "",
      name = "Path to valgrind report(s)",
      description = "Relative to projects' root. Ant patterns are accepted",
      global = false,
      project = true),
    @Property(
      key = CxxVeraxxSensor.REPORT_PATH_KEY,
      defaultValue = "",
      name = "Path to vera++ report(s)",
      description = "Relative to projects' root. Ant patterns are accepted",
      global = false,
      project = true),
    @Property(
      key = CxxXunitSensor.REPORT_PATH_KEY,
      defaultValue = "",
      name = "Path to unit test execution report(s)",
      description = "Relative to projects' root. Ant patterns are accepted",
      global = false,
      project = true),
    @Property(
      key = CxxXunitSensor.XSLT_URL_KEY,
      defaultValue = "",
      name = "URL of the xslt transformer",
      description = "TODO",
      global = false,
      project = true)
      })
public final class CxxPlugin extends SonarPlugin {
  static final String SOURCE_FILE_SUFFIXES_KEY = "sonar.cxx.suffixes.sources";
  static final String HEADER_FILE_SUFFIXES_KEY = "sonar.cxx.suffixes.headers";

  /**
   * {@inheritDoc}
   */
  public List> getExtensions() {
    List> l = new ArrayList>();
    l.add(CxxLanguage.class);
    l.add(CxxSourceImporter.class);
    l.add(CxxColorizer.class);
    l.add(CxxSquidSensor.class);
    l.add(CxxCpdMapping.class);
    l.add(CxxRatsRuleRepository.class);
    l.add(CxxRatsSensor.class);
    l.add(CxxXunitSensor.class);
    l.add(CxxCoverageSensor.class);
    l.add(CxxCppCheckRuleRepository.class);
    l.add(CxxCppCheckSensor.class);
    l.add(CxxPCLintRuleRepository.class);
    l.add(CxxPCLintSensor.class);
    l.add(CxxCppNcssSensor.class);
    l.add(CxxVeraxxRuleRepository.class);
    l.add(CxxVeraxxSensor.class);
    l.add(CxxValgrindRuleRepository.class);
    l.add(CxxValgrindSensor.class);
    l.add(CxxDefaultProfile.class);
    l.add(CxxCommonRulesEngineProvider.class);
    l.add(CxxExternalRulesSensor.class);
    l.add(CxxExternalRulesRuleRepository.class);    

    return l;
  }

  @Override
  public String toString() {
    return getClass().getSimpleName();
  }
}