org.sonarsource.dotnet.shared.plugins.SensorContextUtils Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sonar-dotnet-shared-library Show documentation
Share code between C# and VB.NET plugins
There is a newer version: 9.32.0.97167
Show newest version
/*
 * SonarSource :: .NET :: Shared library
 * Copyright (C) 2014-2024 SonarSource SA
 * mailto:info AT sonarsource DOT com
 *
 * 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  02110-1301, USA.
 */
package org.sonarsource.dotnet.shared.plugins;

import javax.annotation.CheckForNull;
import org.sonar.api.batch.fs.FilePredicates;
import org.sonar.api.batch.fs.FileSystem;
import org.sonar.api.batch.fs.InputFile;
import org.sonar.api.batch.fs.TextRange;
import org.sonarsource.dotnet.protobuf.SonarAnalyzer;

import java.util.Optional;

import static org.sonar.api.batch.fs.InputFile.Type;

public final class SensorContextUtils {
  private SensorContextUtils() {
    // utility class, forbidden constructor
  }

  @CheckForNull
  public static InputFile toInputFile(FileSystem fs, String file) {
    return fs.inputFile(fs.predicates().hasPath(file));
  }

  public static boolean hasFilesOfType(FileSystem fs, Type fileType, String languageKey) {
    FilePredicates p = fs.predicates();
    return fs.inputFiles(p.and(p.hasType(fileType), p.hasLanguage(languageKey))).iterator().hasNext();
  }

  public static boolean hasFilesOfLanguage(FileSystem fs, String languageKey) {
    FilePredicates p = fs.predicates();
    return fs.inputFiles(p.hasLanguage(languageKey)).iterator().hasNext();
  }

  public static boolean hasAnyMainFiles(FileSystem fs) {
    return fs.inputFiles(fs.predicates().hasType(Type.MAIN)).iterator().hasNext();
  }

  public static Optional toTextRange(InputFile inputFile, SonarAnalyzer.TextRange pbTextRange) {
    // We accept data out of range due to the mapping issues on Roslyn side.
    // The strategy is to throw if the start offset is outside the line; otherwise, if only the end line is out of the range,
    // trim to the end of the line.
    // The range is discarded if trimming of the end has made it empty.
    // The wrong locations are caused by the following issues:
    // https://github.com/dotnet/roslyn/issues/69248
    // https://github.com/dotnet/razor/issues/9051
    // https://github.com/dotnet/razor/issues/9050
    int startLine = pbTextRange.getStartLine();
    int startLineOffset = pbTextRange.getStartOffset();
    int startLineLength = inputFile.selectLine(startLine).end().lineOffset();
    if (startLineOffset > startLineLength) {
      startLine++;
      startLineOffset = 0;
    }

    int endLine = pbTextRange.getEndLine();
    int endLineLength = inputFile.selectLine(endLine).end().lineOffset();
    int endLineOffset = pbTextRange.getEndOffset();
    if (endLineOffset > endLineLength) {
      endLineOffset = endLineLength;
    }

    return startLine < endLine || (startLine == endLine && startLineOffset < endLineOffset)
      ? Optional.of(inputFile.newRange(startLine, startLineOffset, endLine, endLineOffset))
      : Optional.empty();
  }
}