org.sonar.c.checks.ParsingErrorCheck Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sonar-c-rules-plugin Show documentation

Provide a C rule engine. This C-Rules plugin requires the C plugin to be installed in order to work.

There is a newer version: 0.4

/*
 * Sonar, open source software quality management tool.
 * Copyright (C) 2010 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.c.checks;

import java.io.PrintWriter;
import java.io.StringWriter;

import org.sonar.check.IsoCategory;
import org.sonar.check.Priority;
import org.sonar.check.Rule;

import com.sonar.sslr.api.AuditListener;
import com.sonar.sslr.api.RecognitionException;
import com.sonarsource.c.plugin.CCheck;

@Rule(key = "C.ParsingError", name = "C parser failure", isoCategory = IsoCategory.Maintainability, priority = Priority.MAJOR,
    description = "When the C parser fails, it is possible to record the failure as a violation on the file. This way, "
        + "not only it is possible to track the number of files that do not parse but also to easily find out why they do not parse.")
public class ParsingErrorCheck extends CCheck implements AuditListener {

  public void addException(Exception e) {
    StringWriter exception = new StringWriter();
    e.printStackTrace(new PrintWriter(exception));
    log(exception.toString(), 1);
  }

  public void addRecognitionException(RecognitionException e) {
    log(e.getMessage(), e.getLine());
  }
}