[Dependency Scanning] Make the prescan dependency scan result (import set) an opaque structure

Author: artemcm

include/swift-c/DependencyScan/DependencyScan.h

@@ -50,17 +50,15 @@ typedef void *swiftscan_dependency_info_t;
 /// Opaque container to an overall result of a dependency scan.
 typedef void *swiftscan_dependency_result_t;
 
+/// Opaque container to contain the result of a dependency prescan.
+typedef void *swiftscan_prescan_result_t;
+
 /// Full Dependency Graph (Result)
 typedef struct {
   int count;
   swiftscan_dependency_info_t *modules;
 } swiftscan_dependency_set_t;
 
-typedef struct {
-  /// The complete list of imports discovered
-  swiftscan_string_set_t *import_set;
-} swiftscan_prescan_result_t;
-
 //=== Batch Scan Input Specification --------------------------------------===//
 
 /// Opaque container to a container of batch scan entry information.
@@ -194,6 +192,11 @@ swiftscan_batch_scan_entry_get_arguments(swiftscan_batch_scan_entry_t entry);
 SWIFTSCAN_PUBLIC bool
 swiftscan_batch_scan_entry_get_is_swift(swiftscan_batch_scan_entry_t entry);
 
+//=== Prescan Result Functions --------------------------------------------===//
+
+SWIFTSCAN_PUBLIC swiftscan_string_set_t *
+swiftscan_prescan_result_get_import_set(swiftscan_prescan_result_t result);
+
 //=== Cleanup Functions ---------------------------------------------------===//
 
 SWIFTSCAN_PUBLIC void
@@ -209,7 +212,7 @@ SWIFTSCAN_PUBLIC void
 swiftscan_dependency_result_dispose(swiftscan_dependency_result_t result);
 
 SWIFTSCAN_PUBLIC void
-swiftscan_prescan_result_dispose(swiftscan_prescan_result_t *result);
+swiftscan_prescan_result_dispose(swiftscan_prescan_result_t result);
 
 SWIFTSCAN_PUBLIC void
 swiftscan_batch_scan_entry_dispose(swiftscan_batch_scan_entry_t entry);
@@ -241,7 +244,7 @@ swiftscan_batch_scan_dependencies(swiftscan_scanner_t *scanner,
                                   swiftscan_batch_scan_input_t *batch_input,
                                   int argc, const char *const *argv);
 
-SWIFTSCAN_PUBLIC swiftscan_prescan_result_t *
+SWIFTSCAN_PUBLIC swiftscan_prescan_result_t
 swiftscan_prescan_dependencies(swiftscan_scanner_t *scanner,
                                const char *working_directory, int argc,
                                const char *const *argv);

include/swift/DependencyScan/DependencyScanImpl.h

@@ -141,6 +141,11 @@ typedef struct {
   bool is_swift;
 } swiftscan_impl_batch_scan_entry_t;
 
+typedef struct {
+  /// The complete list of imports discovered
+  swiftscan_string_set_t *import_set;
+} swiftscan_impl_prescan_result_t;
+
 inline swift::dependencies::DependencyScanningTool *
 unwrap_scanner(swiftscan_scanner_t P) {
   return reinterpret_cast<swift::dependencies::DependencyScanningTool *>(P);
@@ -185,6 +190,17 @@ wrap_result(const swiftscan_impl_dependency_result_t *P) {
       const_cast<swiftscan_impl_dependency_result_t *>(P));
 }
 
+inline swiftscan_impl_prescan_result_t *
+unwrap_prescan_result(swiftscan_prescan_result_t P) {
+  return reinterpret_cast<swiftscan_impl_prescan_result_t *>(P);
+}
+
+inline swiftscan_prescan_result_t
+wrap_prescan_result(const swiftscan_impl_prescan_result_t *P) {
+  return reinterpret_cast<swiftscan_prescan_result_t>(
+      const_cast<swiftscan_impl_prescan_result_t *>(P));
+}
+
 inline swiftscan_impl_batch_scan_entry_t *
 unwrap_batch_entry(swiftscan_batch_scan_entry_t P) {
   return reinterpret_cast<swiftscan_impl_batch_scan_entry_t *>(P);

include/swift/DependencyScan/DependencyScanningTool.h

@@ -44,7 +44,7 @@ class DependencyScanningTool {
   ///
   /// \returns a \c StringError with the diagnostic output if errors
   /// occurred, \c swiftscan_prescan_result_t otherwise.
-  llvm::ErrorOr<swiftscan_prescan_result_t*>
+  llvm::ErrorOr<swiftscan_prescan_result_t>
   getImports(ArrayRef<const char *> Command);
 
   /// Collect the full module depenedency graph for the input collection of

include/swift/DependencyScan/ScanDependencies.h

@@ -59,7 +59,7 @@ performModuleScan(CompilerInstance &instance,
                   ModuleDependenciesCache &cache);
 
 /// Scans the main module of \c instance for all direct module imports
-llvm::ErrorOr<swiftscan_prescan_result_t*>
+llvm::ErrorOr<swiftscan_prescan_result_t>
 performModulePrescan(CompilerInstance &instance);
 
 /// Batch scan the dependencies for modules specified in \c batchInputFile.
@@ -69,7 +69,7 @@ performBatchModuleScan(CompilerInstance &instance,
                        const std::vector<BatchScanInput> &BatchInput);
 
 /// Batch prescan the imports of modules specified in \c batchInputFile.
-std::vector<llvm::ErrorOr<swiftscan_prescan_result_t*>>
+std::vector<llvm::ErrorOr<swiftscan_prescan_result_t>>
 performBatchModulePrescan(CompilerInstance &instance,
                           ModuleDependenciesCache &cache,
                           llvm::StringSaver &saver,

lib/DependencyScan/DependencyScanImpl.cpp

@@ -81,7 +81,7 @@ swiftscan_batch_scan_dependencies(swiftscan_scanner_t *scanner,
   return Result;
 }
 
-swiftscan_prescan_result_t *
+swiftscan_prescan_result_t
 swiftscan_prescan_dependencies(swiftscan_scanner_t *scanner,
                                const char *working_directory, int argc,
                                const char *const *argv) {
@@ -254,6 +254,13 @@ bool swiftscan_batch_scan_entry_get_is_swift(
   return unwrap_batch_entry(entry)->is_swift;
 }
 
+//=== Prescan Result Functions --------------------------------------------===//
+
+swiftscan_string_set_t *
+swiftscan_prescan_result_get_import_set(swiftscan_prescan_result_t result) {
+  return unwrap_prescan_result(result)->import_set;
+}
+
 //=== Cleanup Functions ---------------------------------------------------===//
 
 void swiftscan_dependency_info_details_dispose(
@@ -327,9 +334,10 @@ void swiftscan_dependency_result_dispose(swiftscan_dependency_result_t result) {
   delete result_impl;
 }
 
-void swiftscan_prescan_result_dispose(swiftscan_prescan_result_t *result) {
-  swiftscan_string_set_dispose(result->import_set);
-  delete result;
+void swiftscan_prescan_result_dispose(swiftscan_prescan_result_t result) {
+  swiftscan_impl_prescan_result_t *result_impl = unwrap_prescan_result(result);
+  swiftscan_string_set_dispose(result_impl->import_set);
+  delete result_impl;
 }
 
 void swiftscan_batch_scan_entry_dispose(swiftscan_batch_scan_entry_t entry) {
@@ -343,11 +351,15 @@ void swiftscan_batch_scan_input_dispose(swiftscan_batch_scan_input_t *input) {
   for (int i = 0; i < input->count; ++i) {
     swiftscan_batch_scan_entry_dispose(&input->modules[i]);
   }
+  delete[] input->modules;
+  delete input;
 }
 
 void swiftscan_batch_scan_result_dispose(
     swiftscan_batch_scan_result_t *result) {
   for (int i = 0; i < result->count; ++i) {
     swiftscan_dependency_result_dispose(result->results[i]);
   }
+  delete[] result->results;
+  delete result;
 }

lib/DependencyScan/DependencyScanningTool.cpp

@@ -47,7 +47,7 @@ DependencyScanningTool::getDependencies(
   return Dependencies;
 }
 
-llvm::ErrorOr<swiftscan_prescan_result_t *>
+llvm::ErrorOr<swiftscan_prescan_result_t>
 DependencyScanningTool::getImports(ArrayRef<const char *> Command) {
   // The primary instance used to scan the query Swift source-code
   auto InstanceOrErr = initCompilerInstanceForScan(Command);

lib/DependencyScan/ScanDependencies.cpp

@@ -479,7 +479,7 @@ getAsClangDependencyModule(swiftscan_module_details_t details) {
 }
 
 static void writePrescanJSON(llvm::raw_ostream &out,
-                             const swiftscan_prescan_result_t *importSet) {
+                             const swiftscan_prescan_result_t importSet) {
   // Write out a JSON containing all main module imports.
   out << "{\n";
   SWIFT_DEFER { out << "}\n"; };
@@ -1275,13 +1275,13 @@ swift::dependencies::performModuleScan(CompilerInstance &instance,
   return dependencyGraph;
 }
 
-llvm::ErrorOr<swiftscan_prescan_result_t *>
+llvm::ErrorOr<swiftscan_prescan_result_t>
 swift::dependencies::performModulePrescan(CompilerInstance &instance) {
   // Execute import prescan, and write JSON output to the output stream
   auto mainDependencies = identifyMainModuleDependencies(instance);
-  swiftscan_prescan_result_t *importSet = new swiftscan_prescan_result_t;
+  auto *importSet = new swiftscan_impl_prescan_result_t;
   importSet->import_set = create_set(mainDependencies.getModuleDependencies());
-  return importSet;
+  return wrap_prescan_result(importSet);
 }
 
 std::vector<llvm::ErrorOr<swiftscan_dependency_result_t>>
@@ -1353,11 +1353,11 @@ swift::dependencies::performBatchModuleScan(
   return batchScanResult;
 }
 
-std::vector<llvm::ErrorOr<swiftscan_prescan_result_t *>>
+std::vector<llvm::ErrorOr<swiftscan_prescan_result_t>>
 swift::dependencies::performBatchModulePrescan(
     CompilerInstance &instance, ModuleDependenciesCache &cache,
     llvm::StringSaver &saver, const std::vector<BatchScanInput> &batchInput) {
-  std::vector<llvm::ErrorOr<swiftscan_prescan_result_t *>> batchPrescanResult;
+  std::vector<llvm::ErrorOr<swiftscan_prescan_result_t>> batchPrescanResult;
 
   // Perform a full dependency scan for each batch entry module
   forEachBatchEntry(
@@ -1400,7 +1400,7 @@ swift::dependencies::performBatchModulePrescan(
           return;
         }
 
-        swiftscan_prescan_result_t *importSet = new swiftscan_prescan_result_t;
+        auto *importSet = new swiftscan_impl_prescan_result_t;
         importSet->import_set = create_set(rootDeps->getModuleDependencies());
         batchPrescanResult.push_back(importSet);
       });