au.com.integradev.delphi.checks.TrailingWhitespaceCheck Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of delphi-checks Show documentation
There is a newer version: 1.12.1
/*
 * Sonar Delphi Plugin
 * Copyright (C) 2019 Integrated Application Development
 *
 * 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  02
 */
package au.com.integradev.delphi.checks;

import static java.util.regex.Pattern.compile;

import com.google.common.base.Splitter;
import java.util.regex.Pattern;
import org.apache.commons.lang3.StringUtils;
import org.sonar.check.Rule;
import org.sonar.plugins.communitydelphi.api.check.DelphiCheck;
import org.sonar.plugins.communitydelphi.api.check.DelphiCheckContext;
import org.sonar.plugins.communitydelphi.api.check.FilePosition;
import org.sonar.plugins.communitydelphi.api.token.DelphiToken;
import org.sonarsource.analyzer.commons.annotations.DeprecatedRuleKey;

@DeprecatedRuleKey(ruleKey = "TrailingWhitespaceRule", repositoryKey = "delph")
@Rule(key = "TrailingWhitespace")
public class TrailingWhitespaceCheck extends DelphiCheck {
  private static final String MESSAGE = "Remove this trailing whitespace.";

  private static final Pattern NEW_LINE_DELIMITER = compile("\r\n?|\n");

  @Override
  public void visitToken(DelphiToken token, DelphiCheckContext context) {
    if (!token.isWhitespace()) {
      return;
    }

    if (!NEW_LINE_DELIMITER.matcher(token.getImage()).find()) {
      return;
    }

    int line = token.getBeginLine();
    int column = token.getBeginColumn();

    String image = StringUtils.stripEnd(token.getImage(), " \t\f");
    var parts = Splitter.on(NEW_LINE_DELIMITER).split(image);
    for (String whitespace : parts) {
      if (!whitespace.isEmpty()) {
        context
            .newIssue()
            .onFilePosition(FilePosition.from(line, column, line, column + whitespace.length()))
            .withMessage(MESSAGE)
            .report();
      }
      ++line;
      column = 0;
    }
  }
}