org.sonar.plugins.communitydelphi.api.check.DelphiCheckContext Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of delphi-frontend Show documentation
The newest version!
/*
 * Sonar Delphi Plugin
 * Copyright (C) 2023 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 org.sonar.plugins.communitydelphi.api.check;

import au.com.integradev.delphi.preprocessor.CompilerSwitchRegistry;
import java.net.URI;
import java.util.List;
import java.util.Objects;
import org.sonar.api.batch.fs.InputFile;
import org.sonar.plugins.communitydelphi.api.ast.DelphiAst;
import org.sonar.plugins.communitydelphi.api.ast.DelphiNode;
import org.sonar.plugins.communitydelphi.api.directive.CompilerDirectiveParser;
import org.sonar.plugins.communitydelphi.api.reporting.DelphiIssueBuilder;
import org.sonar.plugins.communitydelphi.api.token.DelphiToken;
import org.sonar.plugins.communitydelphi.api.type.TypeFactory;

/** Context injected in check classes and used to report issues. */
public interface DelphiCheckContext {
  /**
   * Identifier of the file. The only guarantee is that it is unique in the project. You should not
   * assume it is a file:// URI.
   *
   * @return identifier of the file
   * @see InputFile#uri()
   */
  URI getUri();

  /**
   * Returns the parsed ast of the current file.
   *
   * @return parsed ast of the current file
   */
  DelphiAst getAst();

  /**
   * Returns the raw tokens of the current file.
   *
   * @return list of file tokens
   */
  List getTokens();

  /**
   * Returns the lines of the currently analyzed file.
   *
   * @return list of file lines
   */
  List getFileLines();

  /**
   * Returns the compiler switch registry
   *
   * @return compiler switch registry
   */
  CompilerSwitchRegistry getCompilerSwitchRegistry();

  /**
   * Returns a compiler directive parser
   *
   * @return compiler directive parser
   */
  CompilerDirectiveParser getCompilerDirectiveParser();

  /**
   * Returns the type factory
   *
   * @return type factory
   */
  TypeFactory getTypeFactory();

  /**
   * Creates and returns a new issue builder
   *
   * @return issue builder
   */
  DelphiIssueBuilder newIssue();

  final class Location {
    private final String message;
    private final FilePosition filePosition;

    public Location(String message, DelphiNode node) {
      this.message = message;
      this.filePosition = FilePosition.from(node);
    }

    public Location(String message, FilePosition filePosition) {
      this.message = message;
      this.filePosition = filePosition;
    }

    public String getMessage() {
      return message;
    }

    public FilePosition getFilePosition() {
      return filePosition;
    }

    @Override
    public boolean equals(Object other) {
      if (this == other) {
        return true;
      }
      if (!(other instanceof Location)) {
        return false;
      }
      Location location = (Location) other;
      return Objects.equals(message, location.message)
          && Objects.equals(filePosition, location.filePosition);
    }

    @Override
    public int hashCode() {
      return Objects.hash(message, filePosition);
    }
  }
}