Merge pull request #1650 from ivangalkin/preprocessor_includes_alt

CxxPreprocessor: collect missing includes conditionally

Author: guwirth

cxx-sensors/src/main/java/org/sonar/cxx/sensors/squid/CxxSquidSensor.java

@@ -46,6 +46,7 @@
 import org.sonar.cxx.CxxLanguage;
 import org.sonar.cxx.CxxMetricsFactory;
 import org.sonar.cxx.api.CxxMetric;
+import org.sonar.cxx.checks.error.MissingIncludeFileCheck;
 import org.sonar.cxx.sensors.utils.CxxReportSensor;
 import org.sonar.cxx.sensors.utils.JsonCompilationDatabase;
 import org.sonar.cxx.sensors.visitors.CxxCpdVisitor;
@@ -139,6 +140,7 @@ public void execute(SensorContext context) {
         this.language.getBooleanOption(CPD_IGNORE_IDENTIFIERS_KEY).orElse(Boolean.FALSE)));
 
     CxxConfiguration cxxConf = createConfiguration(context.fileSystem(), context);
+    cxxConf.setCollectMissingIncludes(visitors.stream().anyMatch(v -> v instanceof MissingIncludeFileCheck));
     AstScanner<Grammar> scanner = CxxAstScanner.create(this.language, cxxConf,
       visitors.toArray(new SquidAstVisitor[visitors.size()]));
 

cxx-squid/src/main/java/org/sonar/cxx/CxxConfiguration.java

@@ -53,6 +53,7 @@ public class CxxConfiguration extends SquidConfiguration {
   private String jsonCompilationDatabaseFile;
   private CxxCompilationUnitSettings globalCompilationUnitSettings;
   private final Map<String, CxxCompilationUnitSettings> compilationUnitSettings = new HashMap<>();
+  private boolean collectMissingIncludes = false;
 
   private final CxxVCppBuildLogParser cxxVCppParser;
 
@@ -84,6 +85,14 @@ public boolean getIgnoreHeaderComments() {
     return ignoreHeaderComments;
   }
 
+  public boolean doCollectMissingIncludes() {
+    return collectMissingIncludes;
+  }
+
+  public void setCollectMissingIncludes(boolean collectMissingIncludes) {
+    this.collectMissingIncludes = collectMissingIncludes;
+  }
+
   public void setDefines(@Nullable String[] defines) {
     if (defines == null) {
       return;

cxx-squid/src/main/java/org/sonar/cxx/parser/CxxParser.java

@@ -22,6 +22,7 @@
 import com.sonar.sslr.api.Grammar;
 import com.sonar.sslr.impl.Parser;
 import java.io.File;
+import java.lang.ref.WeakReference;
 import java.util.Collection;
 import org.sonar.cxx.CxxConfiguration;
 import org.sonar.cxx.CxxLanguage;
@@ -34,21 +35,17 @@
 
 public final class CxxParser {
 
-  private static CxxPreprocessor cxxpp;
+  private static WeakReference<CxxPreprocessor> currentPreprocessorInstance;
 
   private CxxParser() {
   }
 
   public static void finishedParsing(File path) {
-    cxxpp.finishedPreprocessing(path);
-  }
-
-  public static Collection<CxxPreprocessor.Include> getIncludedFiles(File path) {
-    return cxxpp.getIncludedFiles(path);
+    currentPreprocessorInstance.get().finishedPreprocessing(path);
   }
 
   public static Collection<CxxPreprocessor.Include> getMissingIncludeFiles(File path) {
-    return cxxpp.getMissingIncludeFiles(path);
+    return currentPreprocessorInstance.get().getMissingIncludeFiles(path);
   }
 
   public static Parser<Grammar> create(CxxLanguage language) {
@@ -62,7 +59,8 @@ public static Parser<Grammar> create(CxxLanguage language, SquidAstVisitorContex
 
   public static Parser<Grammar> create(SquidAstVisitorContext<Grammar> context, CxxConfiguration conf,
     CxxLanguage language) {
-    cxxpp = new CxxPreprocessor(context, conf, language);
+    final CxxPreprocessor cxxpp = new CxxPreprocessor(context, conf, language);
+    currentPreprocessorInstance = new WeakReference<CxxPreprocessor>(cxxpp);
     return Parser.builder(CxxGrammarImpl.create(conf))
       .withLexer(CxxLexer.create(conf, cxxpp, new JoinStringsPreprocessor()))
       .build();

cxx-squid/src/main/java/org/sonar/cxx/preprocessor/CxxPreprocessor.java

@@ -101,7 +101,6 @@ public class CxxPreprocessor extends Preprocessor {
   private final List<String> cFilesPatterns;
   private final CxxConfiguration conf;
   private CxxCompilationUnitSettings compilationUnitSettings;
-  private final Multimap<String, Include> includedFiles = HashMultimap.create();
   private final Multimap<String, Include> missingIncludeFiles = HashMultimap.create();
   private boolean ctorInProgress = true;
 
@@ -441,10 +440,6 @@ private static String stripQuotes(String str) {
     return str.substring(1, str.length() - 1);
   }
 
-  public Collection<Include> getIncludedFiles(File file) {
-    return includedFiles.get(file.getPath());
-  }
-
   public Collection<Include> getMissingIncludeFiles(File file) {
     return missingIncludeFiles.get(file.getPath());
   }
@@ -1075,19 +1070,16 @@ PreprocessorAction handleIncludeLine(AstNode ast, Token token, String filename,
     // c) if not done yet, process it using a special lexer, which calls back only
     //    if it finds relevant preprocessor directives (currently: include's and define's)
 
-    File includedFile = findIncludedFile(ast, token, filename);
-
-    File currentFile = this.getFileUnderAnalysis();
-    if (includedFile != null) {
-      includedFiles.put(currentFile.getPath(), new Include(token.getLine(), includedFile.getAbsolutePath()));
-    }
-
+    final File includedFile = findIncludedFile(ast, token, filename);
     if (includedFile == null) {
       missingIncludeFilesCounter++;
       if (LOG.isDebugEnabled()) {
         LOG.debug("[" + filename + ":" + token.getLine() + "]: cannot find include file '" + token.getValue() + "'");
       }
-      missingIncludeFiles.put(currentFile.getPath(), new Include(token.getLine(), token.getValue()));
+      if (conf.doCollectMissingIncludes()) {
+        final File currentFile = this.getFileUnderAnalysis();
+        missingIncludeFiles.put(currentFile.getPath(), new Include(token.getLine(), token.getValue()));
+      }
     } else if (analysedFiles.add(includedFile.getAbsoluteFile())) {
       if (LOG.isTraceEnabled()) {
         LOG.trace("[{}:{}]: processing {}, resolved to file '{}'",