[Dependency Scanning] Make the overall dependency scan result (inter-module dependency graph) an opaque structure

Author: artemcm

include/swift-c/DependencyScan/DependencyScan.h

@@ -47,20 +47,15 @@ typedef void *swiftscan_module_details_t;
 /// Opaque container to a dependency info of a given module.
 typedef void *swiftscan_dependency_info_t;
 
+/// Opaque container to an overall result of a dependency scan.
+typedef void *swiftscan_dependency_result_t;
+
 /// Full Dependency Graph (Result)
 typedef struct {
   int count;
   swiftscan_dependency_info_t *modules;
 } swiftscan_dependency_set_t;
 
-typedef struct {
-  /// The name of the main module for this dependency graph (root node)
-  swiftscan_string_t main_module_name;
-
-  /// The complete list of modules discovered
-  swiftscan_dependency_set_t *module_set;
-} swiftscan_dependency_result_t;
-
 typedef struct {
   /// The complete list of imports discovered
   swiftscan_string_set_t *import_set;
@@ -81,11 +76,21 @@ typedef struct {
 
 typedef struct {
   int count;
-  swiftscan_dependency_result_t **results;
+  swiftscan_dependency_result_t *results;
 } swiftscan_batch_scan_result_t;
 
 //=== Dependency Result Functions -----------------------------------------===//
 
+SWIFTSCAN_PUBLIC swiftscan_string_t
+swiftscan_dependency_result_get_main_module_name(
+    swiftscan_dependency_result_t result);
+
+SWIFTSCAN_PUBLIC swiftscan_dependency_set_t *
+swiftscan_dependency_result_get_module_set(
+    swiftscan_dependency_result_t result);
+
+//=== Dependency Module Info Functions ------------------------------------===//
+
 SWIFTSCAN_PUBLIC swiftscan_string_t
 swiftscan_module_info_get_module_name(swiftscan_dependency_info_t info);
 
@@ -101,6 +106,8 @@ swiftscan_module_info_get_direct_dependencies(swiftscan_dependency_info_t info);
 SWIFTSCAN_PUBLIC swiftscan_module_details_t
 swiftscan_module_info_get_details(swiftscan_dependency_info_t info);
 
+//=== Dependency Module Info Details Functions ----------------------------===//
+
 SWIFTSCAN_PUBLIC swiftscan_dependency_info_kind_t
 swiftscan_module_detail_get_kind(swiftscan_module_details_t details);
 
@@ -215,7 +222,7 @@ SWIFTSCAN_PUBLIC swiftscan_scanner_t swiftscan_scanner_create(void);
 
 SWIFTSCAN_PUBLIC void swiftscan_scanner_dispose(swiftscan_scanner_t);
 
-SWIFTSCAN_PUBLIC swiftscan_dependency_result_t *
+SWIFTSCAN_PUBLIC swiftscan_dependency_result_t
 swiftscan_scan_dependencies(swiftscan_scanner_t *scanner,
                             const char *working_directory, int argc,
                             const char *const *argv);

include/swift/DependencyScan/DependencyScanImpl.h

@@ -19,6 +19,14 @@
 #include "swift-c/DependencyScan/DependencyScan.h"
 #include "swift/DependencyScan/DependencyScanningTool.h"
 
+typedef struct {
+  /// The name of the main module for this dependency graph (root node)
+  swiftscan_string_t main_module_name;
+
+  /// The complete list of modules discovered
+  swiftscan_dependency_set_t *module_set;
+} swiftscan_impl_dependency_result_t;
+
 typedef struct {
   /// The module's name
   /// The format is:
@@ -160,4 +168,15 @@ wrap_info(const swiftscan_impl_dependency_info_t *P) {
       const_cast<swiftscan_impl_dependency_info_t *>(P));
 }
 
+inline swiftscan_impl_dependency_result_t *
+unwrap_result(swiftscan_dependency_result_t P) {
+  return reinterpret_cast<swiftscan_impl_dependency_result_t *>(P);
+}
+
+inline swiftscan_dependency_result_t
+wrap_result(const swiftscan_impl_dependency_result_t *P) {
+  return reinterpret_cast<swiftscan_dependency_result_t>(
+      const_cast<swiftscan_impl_dependency_result_t *>(P));
+}
+
 #endif // SWIFT_C_DEPENDENCY_SCAN_IMPL_H

include/swift/DependencyScan/DependencyScanningTool.h

@@ -36,7 +36,7 @@ class DependencyScanningTool {
   ///
   /// \returns a \c StringError with the diagnostic output if errors
   /// occurred, \c swiftscan_dependency_result_t otherwise.
-  llvm::ErrorOr<swiftscan_dependency_result_t*>
+  llvm::ErrorOr<swiftscan_dependency_result_t>
   getDependencies(ArrayRef<const char *> Command,
                   const llvm::StringSet<> &PlaceholderModules);
 
@@ -52,7 +52,7 @@ class DependencyScanningTool {
   /// BatchScanInput-specified output locations.
   ///
   /// \returns a \c std::error_code if errors occured during scan.
-  std::vector<llvm::ErrorOr<swiftscan_dependency_result_t*>>
+  std::vector<llvm::ErrorOr<swiftscan_dependency_result_t>>
   getDependencies(ArrayRef<const char *> Command,
                   const std::vector<BatchScanInput> &BatchInput,
                   const llvm::StringSet<> &PlaceholderModules);

include/swift/DependencyScan/ScanDependencies.h

@@ -54,7 +54,7 @@ bool batchPrescanDependencies(CompilerInstance &instance,
 
 // MARK: Dependency scanning execution
 /// Scans the dependencies of the main module of \c instance.
-llvm::ErrorOr<swiftscan_dependency_result_t*>
+llvm::ErrorOr<swiftscan_dependency_result_t>
 performModuleScan(CompilerInstance &instance,
                   ModuleDependenciesCache &cache);
 
@@ -63,7 +63,7 @@ llvm::ErrorOr<swiftscan_prescan_result_t*>
 performModulePrescan(CompilerInstance &instance);
 
 /// Batch scan the dependencies for modules specified in \c batchInputFile.
-std::vector<llvm::ErrorOr<swiftscan_dependency_result_t*>>
+std::vector<llvm::ErrorOr<swiftscan_dependency_result_t>>
 performBatchModuleScan(CompilerInstance &instance,
                        ModuleDependenciesCache &cache, llvm::StringSaver &saver,
                        const std::vector<BatchScanInput> &BatchInput);