[Dependency Scanning] Make a module's dependency info an opaque structure

Author: artemcm

include/swift-c/DependencyScan/DependencyScan.h

@@ -44,36 +44,10 @@ typedef enum {
 /// Opaque container of the details specific to a given module dependency.
 typedef void *swiftscan_module_details_t;
 
-typedef struct {
-  /// The module's name
-  /// The format is:
-  /// `<module-kind>:<module-name>`
-  /// where `module-kind` is one of:
-  /// "swiftTextual"
-  /// "swiftBinary"
-  /// "swiftPlaceholder"
-  /// "clang""
-  swiftscan_string_t module_name;
-
-  /// The path for the module.
-  swiftscan_string_t module_path;
-
-  /// The source files used to build this module.
-  swiftscan_string_set_t *source_files;
-
-  /**
-   * The list of modules which this module direct depends on.
-   * The format is:
-   * `<module-kind>:<module-name>`
-   */
-  swiftscan_string_set_t *direct_dependencies;
-
-  /// Specific details of a particular kind of module.
-  swiftscan_module_details_t details;
-} swiftscan_dependency_info_t;
+/// Opaque container to a dependency info of a given module.
+typedef void *swiftscan_dependency_info_t;
 
 /// Full Dependency Graph (Result)
-
 typedef struct {
   int count;
   swiftscan_dependency_info_t *modules;
@@ -112,8 +86,23 @@ typedef struct {
 
 //=== Dependency Result Functions -----------------------------------------===//
 
+SWIFTSCAN_PUBLIC swiftscan_string_t
+swiftscan_module_info_get_module_name(swiftscan_dependency_info_t info);
+
+SWIFTSCAN_PUBLIC swiftscan_string_t
+swiftscan_module_info_get_module_path(swiftscan_dependency_info_t info);
+
+SWIFTSCAN_PUBLIC swiftscan_string_set_t *
+swiftscan_module_info_get_source_files(swiftscan_dependency_info_t info);
+
+SWIFTSCAN_PUBLIC swiftscan_string_set_t *
+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);
+
 SWIFTSCAN_PUBLIC swiftscan_dependency_info_kind_t
-swiftscan_get_module_detail_kind(swiftscan_module_details_t details);
+swiftscan_module_detail_get_kind(swiftscan_module_details_t details);
 
 //=== Swift Textual Module Details query APIs -----------------------------===//
 SWIFTSCAN_PUBLIC swiftscan_string_t

include/swift/DependencyScan/DependencyScanImpl.h

@@ -19,6 +19,34 @@
 #include "swift-c/DependencyScan/DependencyScan.h"
 #include "swift/DependencyScan/DependencyScanningTool.h"
 
+typedef struct {
+  /// The module's name
+  /// The format is:
+  /// `<module-kind>:<module-name>`
+  /// where `module-kind` is one of:
+  /// "swiftTextual"
+  /// "swiftBinary"
+  /// "swiftPlaceholder"
+  /// "clang""
+  swiftscan_string_t module_name;
+
+  /// The path for the module.
+  swiftscan_string_t module_path;
+
+  /// The source files used to build this module.
+  swiftscan_string_set_t *source_files;
+
+  /**
+   * The list of modules which this module direct depends on.
+   * The format is:
+   * `<module-kind>:<module-name>`
+   */
+  swiftscan_string_set_t *direct_dependencies;
+
+  /// Specific details of a particular kind of module.
+  swiftscan_module_details_t details;
+} swiftscan_impl_dependency_info_t;
+
 /// Swift modules to be built from a module interface, may have a bridging
 /// header.
 typedef struct {
@@ -110,13 +138,26 @@ wrap_scanner(const swift::dependencies::DependencyScanningTool *P) {
       const_cast<swift::dependencies::DependencyScanningTool *>(P));
 }
 
-inline swiftscan_impl_module_details_t *unwrap_details(swiftscan_module_details_t P) {
+inline swiftscan_impl_module_details_t *
+unwrap_details(swiftscan_module_details_t P) {
   return reinterpret_cast<swiftscan_impl_module_details_t *>(P);
 }
 
-inline swiftscan_module_details_t wrap_details(const swiftscan_impl_module_details_t *P) {
+inline swiftscan_module_details_t
+wrap_details(const swiftscan_impl_module_details_t *P) {
   return reinterpret_cast<swiftscan_module_details_t>(
       const_cast<swiftscan_impl_module_details_t *>(P));
 }
 
+inline swiftscan_impl_dependency_info_t *
+unwrap_info(swiftscan_dependency_info_t P) {
+  return reinterpret_cast<swiftscan_impl_dependency_info_t *>(P);
+}
+
+inline swiftscan_dependency_info_t
+wrap_info(const swiftscan_impl_dependency_info_t *P) {
+  return reinterpret_cast<swiftscan_dependency_info_t>(
+      const_cast<swiftscan_impl_dependency_info_t *>(P));
+}
+
 #endif // SWIFT_C_DEPENDENCY_SCAN_IMPL_H

lib/DependencyScan/DependencyScanImpl.cpp

@@ -97,107 +97,134 @@ swiftscan_prescan_result_t *swiftscan_prescan_dependencies(swiftscan_scanner_t *
   return ImportSet;
 }
 
+//=== Module Dependency Info query APIs -----------------------------------===//
+
+swiftscan_string_t
+swiftscan_module_info_get_module_name(swiftscan_dependency_info_t info) {
+  return unwrap_info(info)->module_name;
+}
+
+swiftscan_string_t
+swiftscan_module_info_get_module_path(swiftscan_dependency_info_t info) {
+  return unwrap_info(info)->module_path;
+}
+
+swiftscan_string_set_t *
+swiftscan_module_info_get_source_files(swiftscan_dependency_info_t info) {
+  return unwrap_info(info)->source_files;
+}
+
+swiftscan_string_set_t *
+swiftscan_module_info_get_direct_dependencies(swiftscan_dependency_info_t info) {
+  return unwrap_info(info)->direct_dependencies;
+}
+
+swiftscan_module_details_t
+swiftscan_module_info_get_details(swiftscan_dependency_info_t info) {
+  return unwrap_info(info)->details;
+}
+
 //=== Swift Textual Module Details query APIs -----------------------------===//
 
 swiftscan_dependency_info_kind_t
-swiftscan_get_module_detail_kind(swiftscan_module_details_t details) {
+swiftscan_module_detail_get_kind(swiftscan_module_details_t details) {
   return unwrap_details(details)->kind;
 }
 
 swiftscan_string_t
-swiftscan_get_swift_textual_detail_module_interface_path(swiftscan_module_details_t details) {
+swiftscan_swift_textual_detail_get_module_interface_path(swiftscan_module_details_t details) {
   return unwrap_details(details)->swift_textual_details.module_interface_path;
 }
 
-swiftscan_string_set_t *swiftscan_get_swift_textual_detail_compiled_module_candidates(
+swiftscan_string_set_t *swiftscan_swift_textual_detail_get_compiled_module_candidates(
     swiftscan_module_details_t details) {
   return unwrap_details(details)
       ->swift_textual_details.compiled_module_candidates;
 }
 
 swiftscan_string_t
-swiftscan_get_swift_textual_detail_bridging_header_path(swiftscan_module_details_t details) {
+swiftscan_swift_textual_detail_get_bridging_header_path(swiftscan_module_details_t details) {
   return unwrap_details(details)->swift_textual_details.bridging_header_path;
 }
 
 swiftscan_string_set_t *
-swiftscan_get_swift_textual_detail_bridging_source_files(swiftscan_module_details_t details) {
+swiftscan_swift_textual_detail_get_bridging_source_files(swiftscan_module_details_t details) {
   return unwrap_details(details)->swift_textual_details.bridging_source_files;
 }
 
-swiftscan_string_set_t *swiftscan_get_swift_textual_detail_bridging_module_dependencies(
+swiftscan_string_set_t *swiftscan_swift_textual_detail_get_bridging_module_dependencies(
     swiftscan_module_details_t details) {
   return unwrap_details(details)
       ->swift_textual_details.bridging_module_dependencies;
 }
 
 swiftscan_string_set_t *
-swiftscan_get_swift_textual_detail_command_line(swiftscan_module_details_t details) {
+swiftscan_swift_textual_detail_get_command_line(swiftscan_module_details_t details) {
   return unwrap_details(details)->swift_textual_details.command_line;
 }
 
 swiftscan_string_set_t *
-swiftscan_get_swift_textual_detail_extra_pcm_args(swiftscan_module_details_t details) {
+swiftscan_swift_textual_detail_get_extra_pcm_args(swiftscan_module_details_t details) {
   return unwrap_details(details)->swift_textual_details.extra_pcm_args;
 }
 
 swiftscan_string_t
-swiftscan_get_swift_textual_detail_context_hash(swiftscan_module_details_t details) {
+swiftscan_swift_textual_detail_get_context_hash(swiftscan_module_details_t details) {
   return unwrap_details(details)->swift_textual_details.context_hash;
 }
 
-bool swiftscan_get_swift_textual_detail_is_framework(swiftscan_module_details_t details) {
+bool swiftscan_swift_textual_detail_get_is_framework(swiftscan_module_details_t details) {
   return unwrap_details(details)->swift_textual_details.is_framework;
 }
 
 //=== Swift Binary Module Details query APIs ------------------------------===//
 
 swiftscan_string_t
-swiftscan_get_swift_binary_detail_compiled_module_path(swiftscan_module_details_t details) {
+swiftscan_swift_binary_detail_get_compiled_module_path(swiftscan_module_details_t details) {
   return unwrap_details(details)->swift_binary_details.compiled_module_path;
 }
 
 swiftscan_string_t
-swiftscan_get_swift_binary_detail_module_doc_path(swiftscan_module_details_t details) {
+swiftscan_swift_binary_detail_get_module_doc_path(swiftscan_module_details_t details) {
   return unwrap_details(details)->swift_binary_details.module_doc_path;
 }
 
-swiftscan_string_t swiftscan_get_swift_binary_detail_module_source_info_path(
+swiftscan_string_t swiftscan_swift_binary_detail_get_module_source_info_path(
     swiftscan_module_details_t details) {
   return unwrap_details(details)->swift_binary_details.module_source_info_path;
 }
 
 //=== Swift Placeholder Module Details query APIs -------------------------===//
 
-swiftscan_string_t swiftscan_get_swift_placeholder_detail_compiled_module_path(
+swiftscan_string_t swiftscan_swift_placeholder_detail_get_compiled_module_path(
     swiftscan_module_details_t details) {
   return unwrap_details(details)
       ->swift_placeholder_details.module_source_info_path;
 }
 
 swiftscan_string_t
-swiftscan_get_swift_placeholder_detail_module_doc_path(swiftscan_module_details_t details) {
+swiftscan_swift_placeholder_detail_get_module_doc_path(swiftscan_module_details_t details) {
   return unwrap_details(details)
       ->swift_placeholder_details.module_source_info_path;
 }
 
-swiftscan_string_t swiftscan_get_swift_placeholder_detail_module_source_info_path(
+swiftscan_string_t swiftscan_swift_placeholder_detail_get_module_source_info_path(
     swiftscan_module_details_t details) {
   return unwrap_details(details)
       ->swift_placeholder_details.module_source_info_path;
 }
 
 //=== Clang Module Details query APIs -------------------------------------===//
 
-swiftscan_string_t swiftscan_get_clang_detail_module_map_path(swiftscan_module_details_t details) {
+swiftscan_string_t swiftscan_clang_detail_get_module_map_path(swiftscan_module_details_t details) {
   return unwrap_details(details)->clang_details.module_map_path;
 }
 
-swiftscan_string_t swiftscan_get_clang_detail_context_hash(swiftscan_module_details_t details) {
+swiftscan_string_t swiftscan_clang_detail_get_context_hash(swiftscan_module_details_t details) {
   return unwrap_details(details)->clang_details.context_hash;
 }
 
-swiftscan_string_set_t *swiftscan_get_clang_detail_command_line(swiftscan_module_details_t details) {
+swiftscan_string_set_t *swiftscan_clang_detail_get_command_line(swiftscan_module_details_t details) {
   return unwrap_details(details)->clang_details.command_line;
 }
 
@@ -243,11 +270,11 @@ void swiftscan_dependency_info_details_dispose(swiftscan_module_details_t detail
 }
 
 void swiftscan_dependency_info_dispose(swiftscan_dependency_info_t *info) {
-  swiftscan_string_dispose(info->module_name);
-  swiftscan_string_dispose(info->module_path);
-  swiftscan_string_set_dispose(info->source_files);
-  swiftscan_string_set_dispose(info->direct_dependencies);
-  swiftscan_dependency_info_details_dispose(info->details);
+  swiftscan_string_dispose(unwrap_info(info)->module_name);
+  swiftscan_string_dispose(unwrap_info(info)->module_path);
+  swiftscan_string_set_dispose(unwrap_info(info)->source_files);
+  swiftscan_string_set_dispose(unwrap_info(info)->direct_dependencies);
+  swiftscan_dependency_info_details_dispose(unwrap_info(info)->details);
 }
 
 void swiftscan_dependency_set_dispose(swiftscan_dependency_set_t *set) {

lib/DependencyScan/ScanDependencies.cpp

@@ -500,7 +500,7 @@ static void writeJSON(llvm::raw_ostream &out,
   SWIFT_DEFER { out << "  ]\n"; };
   const auto module_set = fullDependencies->module_set;
   for (int mi = 0; mi < module_set->count; ++mi) {
-    const auto &moduleInfo = module_set->modules[mi];
+    const auto &moduleInfo = *unwrap_info(module_set->modules[mi]);
     auto &directDependencies = moduleInfo.direct_dependencies;
     // The module we are describing.
     out.indent(2 * 2);
@@ -830,7 +830,7 @@ generateFullDependencyGraph(CompilerInstance &instance,
       return wrap_details(details);
     };
 
-    swiftscan_dependency_info_t &moduleInfo = dependencySet->modules[i];
+    auto &moduleInfo = *unwrap_info(dependencySet->modules[i]);
     moduleInfo.module_name =
         create_dup(createEncodedModuleKindAndName(module).c_str());
     moduleInfo.module_path = create_dup(modulePath.c_str());