[clang][ScanDeps] Use an options struct for the scanning service

Upcoming patches will be adding more options to this constructor which
will end up requiring lots of test changes to handle new default
arguments. This uses a struct instead so that only the settings
relevant to the test can be set. This also avoids the problem of the
meaning of a bool argument changing.

Author: Bigcheese

clang/include/clang/Tooling/DependencyScanning/DependencyScanningService.h

@@ -78,50 +78,56 @@ enum class ScanningOptimizations {
 
 #undef DSS_LAST_BITMASK_ENUM
 
+struct DependencyScanningServiceOptions {
+  DependencyScanningServiceOptions(ScanningMode Mode,
+                                   ScanningOutputFormat Format)
+      : Mode(Mode), Format(Format) {}
+
+  ScanningMode Mode;
+  ScanningOutputFormat Format;
+  /// How to optimize the modules' command-line arguments.
+  ScanningOptimizations OptimizeArgs = ScanningOptimizations::Default;
+  /// Whether to set up command-lines to load PCM files eagerly.
+  bool EagerLoadModules = false;
+  /// Whether to trace VFS accesses.
+  bool TraceVFS = false;
+  std::time_t BuildSessionTimestamp =
+      llvm::sys::toTimeT(std::chrono::system_clock::now());
+};
+
 /// The dependency scanning service contains shared configuration and state that
 /// is used by the individual dependency scanning workers.
 class DependencyScanningService {
 public:
-  DependencyScanningService(
-      ScanningMode Mode, ScanningOutputFormat Format,
-      ScanningOptimizations OptimizeArgs = ScanningOptimizations::Default,
-      bool EagerLoadModules = false, bool TraceVFS = false,
-      std::time_t BuildSessionTimestamp =
-          llvm::sys::toTimeT(std::chrono::system_clock::now()));
+  DependencyScanningService(const DependencyScanningServiceOptions &Options);
 
-  ScanningMode getMode() const { return Mode; }
+  ScanningMode getMode() const { return Options.Mode; }
 
-  ScanningOutputFormat getFormat() const { return Format; }
+  ScanningOutputFormat getFormat() const { return Options.Format; }
 
-  ScanningOptimizations getOptimizeArgs() const { return OptimizeArgs; }
+  ScanningOptimizations getOptimizeArgs() const { return Options.OptimizeArgs; }
 
-  bool shouldEagerLoadModules() const { return EagerLoadModules; }
+  bool shouldEagerLoadModules() const { return Options.EagerLoadModules; }
 
-  bool shouldTraceVFS() const { return TraceVFS; }
+  bool shouldTraceVFS() const { return Options.TraceVFS; }
 
   DependencyScanningFilesystemSharedCache &getSharedCache() {
     return SharedCache;
   }
 
   ModuleCacheEntries &getModuleCacheEntries() { return ModCacheEntries; }
 
-  std::time_t getBuildSessionTimestamp() const { return BuildSessionTimestamp; }
+  std::time_t getBuildSessionTimestamp() const {
+    return Options.BuildSessionTimestamp;
+  }
 
 private:
-  const ScanningMode Mode;
-  const ScanningOutputFormat Format;
-  /// Whether to optimize the modules' command-line arguments.
-  const ScanningOptimizations OptimizeArgs;
-  /// Whether to set up command-lines to load PCM files eagerly.
-  const bool EagerLoadModules;
-  /// Whether to trace VFS accesses.
-  const bool TraceVFS;
+  const DependencyScanningServiceOptions Options;
+
   /// The global file system cache.
   DependencyScanningFilesystemSharedCache SharedCache;
   /// The global module cache entries.
   ModuleCacheEntries ModCacheEntries;
-  /// The build session timestamp.
-  std::time_t BuildSessionTimestamp;
 };
 
 } // end namespace dependencies

clang/lib/Tooling/DependencyScanning/DependencyScanningService.cpp

@@ -13,9 +13,5 @@ using namespace tooling;
 using namespace dependencies;
 
 DependencyScanningService::DependencyScanningService(
-    ScanningMode Mode, ScanningOutputFormat Format,
-    ScanningOptimizations OptimizeArgs, bool EagerLoadModules, bool TraceVFS,
-    std::time_t BuildSessionTimestamp)
-    : Mode(Mode), Format(Format), OptimizeArgs(OptimizeArgs),
-      EagerLoadModules(EagerLoadModules), TraceVFS(TraceVFS),
-      BuildSessionTimestamp(BuildSessionTimestamp) {}
+    const DependencyScanningServiceOptions &Options)
+    : Options(Options) {}

clang/tools/clang-scan-deps/ClangScanDeps.cpp

@@ -1171,8 +1171,11 @@ int clang_scan_deps_main(int argc, char **argv, const llvm::ToolContext &) {
     });
   };
 
-  DependencyScanningService Service(ScanMode, Format, OptimizeArgs,
-                                    EagerLoadModules, /*TraceVFS=*/Verbose);
+  DependencyScanningServiceOptions Options{ScanMode, Format};
+  Options.OptimizeArgs = OptimizeArgs;
+  Options.EagerLoadModules = EagerLoadModules;
+  Options.TraceVFS = Verbose;
+  DependencyScanningService Service(Options);
 
   llvm::Timer T;
   T.startTimer();

clang/unittests/Tooling/DependencyScanning/DependencyScannerTest.cpp

@@ -231,8 +231,8 @@ TEST(DependencyScanner, ScanDepsWithFS) {
   VFS->addFile(TestPath, 0,
                llvm::MemoryBuffer::getMemBuffer("#include \"header.h\"\n"));
 
-  DependencyScanningService Service(ScanningMode::DependencyDirectivesScan,
-                                    ScanningOutputFormat::Make);
+  DependencyScanningService Service(
+      {ScanningMode::DependencyDirectivesScan, ScanningOutputFormat::Make});
   DependencyScanningTool ScanTool(Service, VFS);
 
   std::string DepFile;
@@ -289,8 +289,8 @@ TEST(DependencyScanner, ScanDepsWithModuleLookup) {
 
   auto InterceptFS = llvm::makeIntrusiveRefCnt<InterceptorFS>(VFS);
 
-  DependencyScanningService Service(ScanningMode::DependencyDirectivesScan,
-                                    ScanningOutputFormat::Make);
+  DependencyScanningService Service(
+      {ScanningMode::DependencyDirectivesScan, ScanningOutputFormat::Make});
   DependencyScanningTool ScanTool(Service, InterceptFS);
 
   // This will fail with "fatal error: module 'Foo' not found" but it doesn't
@@ -321,8 +321,8 @@ TEST(DependencyScanner, ScanDepsWithDiagConsumer) {
                llvm::MemoryBuffer::getMemBuffer("#include \"header.h\"\n"));
   VFS->addFile(AsmPath, 0, llvm::MemoryBuffer::getMemBuffer(""));
 
-  DependencyScanningService Service(ScanningMode::DependencyDirectivesScan,
-                                    ScanningOutputFormat::Make);
+  DependencyScanningService Service(
+      {ScanningMode::DependencyDirectivesScan, ScanningOutputFormat::Make});
   DependencyScanningWorker Worker(Service, VFS);
 
   llvm::DenseSet<ModuleID> AlreadySeen;