SONARJAVA-7300 Decouple the Sonar Java frontend from Eclipse JDT core

java-checks-common/src/main/java/org/sonar/java/checks/helpers/ExpressionsHelper.java

@@ -48,7 +48,7 @@
 
 import static org.sonar.java.checks.helpers.ReassignmentFinder.getInitializerOrExpression;
 import static org.sonar.java.checks.helpers.ReassignmentFinder.getReassignments;
-import static org.sonar.java.model.JUtils.hasUnknownTypeInHierarchy;
+import static org.sonar.java.model.SemanticUtils.hasUnknownTypeInHierarchy;
 
 public class ExpressionsHelper {
 

java-checks-common/src/test/java/org/sonar/java/checks/helpers/JParserTestUtils.java

@@ -17,15 +17,12 @@
 package org.sonar.java.checks.helpers;
 
 import com.google.common.io.Files;
-
 import java.io.File;
 import java.nio.charset.StandardCharsets;
 import java.util.Arrays;
 import java.util.List;
 import java.util.stream.Collectors;
-
-import org.sonar.java.model.JParser;
-import org.sonar.java.model.JParserConfig;
+import org.sonar.java.JavaParsers;
 import org.sonar.plugins.java.api.JavaVersion;
 import org.sonar.plugins.java.api.tree.*;
 
@@ -76,8 +73,8 @@ public static CompilationUnitTree parse(File file) {
 
   public static CompilationUnitTree parse(String source) {
     List<File> classpath = Arrays.asList(new File("target/test-classes"), new File("target/classes"));
-    JavaVersion version = JParserConfig.MAXIMUM_SUPPORTED_JAVA_VERSION;
-    return JParser.parse(JParserConfig.Mode.FILE_BY_FILE.create(version, classpath).astParser(), version.toString(), "test", source);
+    JavaVersion version = JavaParsers.MAXIMUM_SUPPORTED_JAVA_VERSION;
+    return JavaParsers.Mode.FILE_BY_FILE.create(version, classpath).parse("test", source);
   }
 
 }

java-checks/src/main/java/org/sonar/java/checks/AnnotationDefaultArgumentCheck.java

@@ -23,7 +23,7 @@
 import java.util.stream.Collectors;
 import javax.annotation.Nullable;
 import org.sonar.check.Rule;
-import org.sonar.java.model.JUtils;
+import org.sonar.java.model.SemanticUtils;
 import org.sonar.plugins.java.api.IssuableSubscriptionVisitor;
 import org.sonar.plugins.java.api.semantic.Symbol;
 import org.sonar.plugins.java.api.semantic.Symbol.TypeSymbol;
@@ -51,8 +51,8 @@ public void visitNode(Tree tree) {
     Map<String, Object> defaultValueByName = annotationSymbol.memberSymbols().stream()
       .filter(Symbol::isMethodSymbol)
       .map(Symbol.MethodSymbol.class::cast)
-      .filter(s -> JUtils.defaultValue(s) != null)
-      .collect(Collectors.toMap(Symbol::name, JUtils::defaultValue));
+      .filter(s -> SemanticUtils.annotationElementDefaultValue(s) != null)
+      .collect(Collectors.toMap(Symbol::name, SemanticUtils::annotationElementDefaultValue));
 
     for (ExpressionTree argument : annotationTree.arguments()) {
       ExpressionTree valueSet = argument;

java-checks/src/main/java/org/sonar/java/checks/ChangeMethodContractCheck.java

@@ -22,7 +22,7 @@
 import java.util.Optional;
 import org.sonar.check.Rule;
 import org.sonar.java.checks.helpers.MethodTreeUtils;
-import org.sonar.java.model.JUtils;
+import org.sonar.java.model.SemanticUtils;
 import org.sonar.plugins.java.api.IssuableSubscriptionVisitor;
 import org.sonar.plugins.java.api.JavaFileScannerContext;
 import org.sonar.plugins.java.api.semantic.Symbol;
@@ -67,7 +67,7 @@ private void checkContractChange(MethodTree methodTree, Symbol.MethodSymbol over
 
     for (int i = 0; i < methodTree.parameters().size(); i++) {
       VariableTree parameter = methodTree.parameters().get(i);
-      checkParameter(parameter, JUtils.parameterAnnotations(overridee, i));
+      checkParameter(parameter, SemanticUtils.parameterAnnotations(overridee, i));
     }
 
     // If the method from the parent claims to never return null, the method from the child

java-checks/src/main/java/org/sonar/java/checks/ClassWithOnlyStaticMethodsInstantiationCheck.java

@@ -16,9 +16,14 @@
  */
 package org.sonar.java.checks;
 
+import java.text.MessageFormat;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.List;
+import javax.annotation.Nullable;
 import org.sonar.check.Rule;
 import org.sonar.java.model.ExpressionUtils;
-import org.sonar.java.model.JUtils;
+import org.sonar.java.model.SemanticUtils;
 import org.sonar.plugins.java.api.IssuableSubscriptionVisitor;
 import org.sonar.plugins.java.api.semantic.Symbol;
 import org.sonar.plugins.java.api.semantic.Type;
@@ -30,13 +35,6 @@
 import org.sonar.plugins.java.api.tree.Tree.Kind;
 import org.sonar.plugins.java.api.tree.TypeTree;
 
-import javax.annotation.Nullable;
-
-import java.text.MessageFormat;
-import java.util.Collection;
-import java.util.Collections;
-import java.util.List;
-
 @Rule(key = "S2440")
 public class ClassWithOnlyStaticMethodsInstantiationCheck extends IssuableSubscriptionVisitor {
 
@@ -60,7 +58,7 @@ public void visitNode(Tree tree) {
   }
 
   private static boolean instantiateOwnClass(Tree identifier, Symbol.TypeSymbol newClassTypeSymbol) {
-    Symbol enclosingClass = JUtils.enclosingClass(identifier);
+    Symbol enclosingClass = SemanticUtils.enclosingClass(identifier);
     return enclosingClass != null && enclosingClass.type().equals(newClassTypeSymbol.type());
   }
 

java-checks/src/main/java/org/sonar/java/checks/MapKeyNotComparableCheck.java

@@ -20,7 +20,7 @@
 import java.util.List;
 import java.util.Optional;
 import org.sonar.check.Rule;
-import org.sonar.java.model.JUtils;
+import org.sonar.java.model.SemanticUtils;
 import org.sonar.plugins.java.api.IssuableSubscriptionVisitor;
 import org.sonar.plugins.java.api.semantic.Type;
 import org.sonar.plugins.java.api.tree.ParameterizedTypeTree;
@@ -45,7 +45,7 @@ public void visitNode(Tree tree) {
       getMapKeyTree(typeTree).ifPresent(mapKeyTree -> {
         if (!isGenericOrWildCard(mapKeyTree) &&
           !implementsComparable(mapKeyTree.symbolType()) &&
-          !JUtils.hasUnknownTypeInHierarchy(mapKeyTree.symbolType().symbol())) {
+          !SemanticUtils.hasUnknownTypeInHierarchy(mapKeyTree.symbolType().symbol())) {
           reportIssue(mapKeyTree, "The key type should implement Comparable.");
         }
       });

java-checks/src/main/java/org/sonar/java/checks/RedundantAbstractMethodCheck.java

@@ -20,7 +20,7 @@
 import java.util.HashSet;
 import java.util.List;
 import org.sonar.check.Rule;
-import org.sonar.java.model.JUtils;
+import org.sonar.java.model.SemanticUtils;
 import org.sonar.plugins.java.api.IssuableSubscriptionVisitor;
 import org.sonar.plugins.java.api.semantic.Symbol;
 import org.sonar.plugins.java.api.semantic.SymbolMetadata;
@@ -110,8 +110,8 @@ private static boolean useRawTypeOfParametrizedType(Type methodParam, Type overr
   private static boolean differentAnnotationsOnParameters(Symbol.MethodSymbol method, Symbol.MethodSymbol overridee) {
     for (int i = 0; i < method.parameterTypes().size(); i++) {
       if (differentAnnotations(
-        JUtils.parameterAnnotations(method, i),
-        JUtils.parameterAnnotations(overridee, i))) {
+        SemanticUtils.parameterAnnotations(method, i),
+        SemanticUtils.parameterAnnotations(overridee, i))) {
         return true;
       }
     }

java-checks/src/main/java/org/sonar/java/checks/ReplaceLambdaByMethodRefCheck.java

@@ -28,8 +28,8 @@
 import org.sonar.java.checks.helpers.ExpressionsHelper;
 import org.sonar.java.checks.helpers.QuickFixHelper;
 import org.sonar.java.model.ExpressionUtils;
-import org.sonar.java.model.JUtils;
 import org.sonar.java.model.LineUtils;
+import org.sonar.java.model.SemanticUtils;
 import org.sonar.java.reporting.JavaQuickFix;
 import org.sonar.java.reporting.JavaTextEdit;
 import org.sonar.plugins.java.api.IssuableSubscriptionVisitor;
@@ -395,6 +395,6 @@ public static Optional<ExpressionTree> expressionWithoutParentheses(@Nullable Tr
 
   private static boolean isArgumentCompatible(Type argumentType, Type parameterType) {
     return argumentType.isSubtypeOf(parameterType)
-      || JUtils.wrapTypeIfPrimitive(argumentType).equals(JUtils.wrapTypeIfPrimitive(parameterType));
+      || SemanticUtils.wrapTypeIfPrimitive(argumentType).equals(SemanticUtils.wrapTypeIfPrimitive(parameterType));
   }
 }

java-checks/src/main/java/org/sonar/java/checks/SortedCollectionWithNonComparableTypeCheck.java

@@ -21,7 +21,7 @@
 import java.util.Optional;
 import java.util.stream.Stream;
 import org.sonar.check.Rule;
-import org.sonar.java.model.JUtils;
+import org.sonar.java.model.SemanticUtils;
 import org.sonar.plugins.java.api.IssuableSubscriptionVisitor;
 import org.sonar.plugins.java.api.semantic.Type;
 import org.sonar.plugins.java.api.tree.CatchTree;
@@ -103,7 +103,7 @@ private static boolean isConcreteNonComparable(Type type) {
       !type.symbol().isInterface() &&
       !type.symbol().isAbstract() &&
       !hasCompatibleNaturalOrdering(type) &&
-      !JUtils.hasUnknownTypeInHierarchy(type.symbol());
+      !SemanticUtils.hasUnknownTypeInHierarchy(type.symbol());
   }
 
   private static boolean hasCompatibleNaturalOrdering(Type type) {

java-checks/src/test/java/org/sonar/java/checks/helpers/JParserTestUtils.java

@@ -22,8 +22,7 @@
 import java.util.Arrays;
 import java.util.List;
 import java.util.stream.Collectors;
-import org.sonar.java.model.JParser;
-import org.sonar.java.model.JParserConfig;
+import org.sonar.java.JavaParsers;
 import org.sonar.plugins.java.api.JavaVersion;
 import org.sonar.plugins.java.api.tree.AssignmentExpressionTree;
 import org.sonar.plugins.java.api.tree.ClassTree;
@@ -84,8 +83,8 @@ public static CompilationUnitTree parse(File file) {
 
   public static CompilationUnitTree parse(String source) {
     List<File> classpath = Arrays.asList(new File("target/test-classes"), new File("target/classes"));
-    JavaVersion version = JParserConfig.MAXIMUM_SUPPORTED_JAVA_VERSION;
-    return JParser.parse(JParserConfig.Mode.FILE_BY_FILE.create(version, classpath).astParser(), version.toString(), "test", source);
+    JavaVersion version = JavaParsers.MAXIMUM_SUPPORTED_JAVA_VERSION;
+    return JavaParsers.Mode.FILE_BY_FILE.create(version, classpath).parse("test", source);
   }
 
 }

java-checks/src/test/java/org/sonar/java/checks/helpers/SpringContextModelTestUtils.java

@@ -26,10 +26,9 @@
 import java.util.List;
 import java.util.function.UnaryOperator;
 import org.sonar.api.batch.fs.InputFile;
+import org.sonar.java.JavaParsers;
 import org.sonar.java.SonarComponents;
 import org.sonar.java.checks.verifier.TestUtils;
-import org.sonar.java.model.JParser;
-import org.sonar.java.model.JParserConfig;
 import org.sonar.java.model.VisitorsBridge;
 import org.sonar.java.model.springcontext.BeanDefinitionGatherer;
 import org.sonar.java.model.springcontext.BeanDefinitionHolder;
@@ -173,7 +172,7 @@ private static CompilationUnitTree parse(File file, List<File> classpath) {
     } catch (Exception e) {
       throw new IllegalStateException("Unable to read file '" + file.getAbsolutePath() + "'", e);
     }
-    JavaVersion version = JParserConfig.MAXIMUM_SUPPORTED_JAVA_VERSION;
-    return JParser.parse(JParserConfig.Mode.FILE_BY_FILE.create(version, classpath).astParser(), version.toString(), file.getName(), source);
+    JavaVersion version = JavaParsers.MAXIMUM_SUPPORTED_JAVA_VERSION;
+    return JavaParsers.Mode.FILE_BY_FILE.create(version, classpath).parse(file.getName(), source);
   }
 }

java-frontend/src/main/java/org/sonar/java/JavaFrontend.java

@@ -40,7 +40,6 @@
 import org.sonar.java.collections.CollectionUtils;
 import org.sonar.java.exceptions.ApiMismatchException;
 import org.sonar.java.filters.SonarJavaIssueFilter;
-import org.sonar.java.model.JParserConfig;
 import org.sonar.java.model.VisitorsBridge;
 import org.sonar.java.telemetry.Telemetry;
 import org.sonar.java.telemetry.TelemetryKey;
@@ -237,15 +236,15 @@ private void scanInBatches(BatchModeContext context, List<InputFile> allInputFil
   private <T extends InputFile> void scanBatch(BatchModeContext context, List<T> batchFiles, AnalysisProgress analysisProgress) {
     analysisProgress.startBatch(batchFiles.size());
     Set<Runnable> environmentsCleaners = new HashSet<>();
-    JParserConfig.Mode.BATCH
+    JavaParsers.Mode.BATCH
       .create(javaVersion, context.getClasspath(), sonarComponents.shouldIgnoreUnnamedModuleForSplitPackage())
       .parse(batchFiles, sonarComponents::analysisCancelled, analysisProgress, (input, result) -> scanAsBatchCallback(input, result, context, environmentsCleaners));
     // Due to a bug in ECJ, JAR files remain locked after the analysis on Windows, we unlock them manually, at the end of each batches. See SONARJAVA-3609.
     environmentsCleaners.forEach(Runnable::run);
     analysisProgress.endBatch();
   }
 
-  private static void scanAsBatchCallback(InputFile inputFile, JParserConfig.Result result, BatchModeContext context, Set<Runnable> environmentsCleaners) {
+  private static void scanAsBatchCallback(InputFile inputFile, ParseResult result, BatchModeContext context, Set<Runnable> environmentsCleaners) {
     JavaAstScanner scanner = context.selectScanner(inputFile);
     Duration duration = PerformanceMeasure.start(context.descriptor(inputFile));
     scanner.simpleScan(inputFile, result, ast ->

java-frontend/src/main/java/org/sonar/java/JavaParser.java

@@ -0,0 +1,30 @@
+/*
+ * SonarQube Java
+ * Copyright (C) SonarSource Sàrl
+ * mailto:info AT sonarsource DOT com
+ *
+ * You can redistribute and/or modify this program under the terms of
+ * the Sonar Source-Available License Version 1, as published by SonarSource Sàrl.
+ *
+ * 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 Sonar Source-Available License for more details.
+ *
+ * You should have received a copy of the Sonar Source-Available License
+ * along with this program; if not, see https://sonarsource.com/license/ssal/
+ */
+package org.sonar.java;
+
+import java.util.function.BiConsumer;
+import java.util.function.BooleanSupplier;
+import org.sonar.api.batch.fs.InputFile;
+import org.sonar.java.model.JavaTree;
+
+public interface JavaParser {
+
+  JavaTree.CompilationUnitTreeImpl parse(String unitName, String source);
+
+  void parse(Iterable<? extends InputFile> inputFiles, BooleanSupplier isCanceled, AnalysisProgress analysisProgress, BiConsumer<InputFile, ParseResult> action);
+
+}

java-frontend/src/main/java/org/sonar/java/JavaParsers.java

@@ -0,0 +1,45 @@
+/*
+ * SonarQube Java
+ * Copyright (C) SonarSource Sàrl
+ * mailto:info AT sonarsource DOT com
+ *
+ * You can redistribute and/or modify this program under the terms of
+ * the Sonar Source-Available License Version 1, as published by SonarSource Sàrl.
+ *
+ * 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 Sonar Source-Available License for more details.
+ *
+ * You should have received a copy of the Sonar Source-Available License
+ * along with this program; if not, see https://sonarsource.com/license/ssal/
+ */
+package org.sonar.java;
+
+import java.io.File;
+import java.util.List;
+import org.sonar.java.jdt.JParserConfig;
+import org.sonar.java.model.JavaVersionImpl;
+import org.sonar.plugins.java.api.JavaVersion;
+
+public final class JavaParsers {
+
+  public static final JavaVersion MAXIMUM_SUPPORTED_JAVA_VERSION = new JavaVersionImpl(JavaVersionImpl.MAX_SUPPORTED, true);
+
+  private JavaParsers() {
+  }
+
+  public enum Mode {
+    BATCH,
+    FILE_BY_FILE;
+
+    public JavaParser create(JavaVersion javaVersion, List<File> classpath) {
+      return create(javaVersion, classpath, false);
+    }
+
+    public JavaParser create(JavaVersion javaVersion, List<File> classpath, boolean shouldIgnoreUnnamedModuleForSplitPackage) {
+      return JParserConfig.create(this, javaVersion, classpath, shouldIgnoreUnnamedModuleForSplitPackage);
+    }
+  }
+
+}

java-frontend/src/main/java/org/sonar/java/ParseResult.java

@@ -0,0 +1,41 @@
+/*
+ * SonarQube Java
+ * Copyright (C) SonarSource Sàrl
+ * mailto:info AT sonarsource DOT com
+ *
+ * You can redistribute and/or modify this program under the terms of
+ * the Sonar Source-Available License Version 1, as published by SonarSource Sàrl.
+ *
+ * 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 Sonar Source-Available License for more details.
+ *
+ * You should have received a copy of the Sonar Source-Available License
+ * along with this program; if not, see https://sonarsource.com/license/ssal/
+ */
+package org.sonar.java;
+
+import org.sonar.java.model.JavaTree;
+
+public final class ParseResult {
+  private final Exception exception;
+  private final JavaTree.CompilationUnitTreeImpl tree;
+
+  public ParseResult(Exception exception) {
+    this.exception = exception;
+    this.tree = null;
+  }
+
+  public ParseResult(JavaTree.CompilationUnitTreeImpl tree) {
+    this.exception = null;
+    this.tree = tree;
+  }
+
+  public JavaTree.CompilationUnitTreeImpl get() throws Exception {
+    if (exception != null) {
+      throw exception;
+    }
+    return tree;
+  }
+}