[Dependency Scanning] Use an opaque type for dependency module details with API query functions for individual fields

Author: artemcm

include/swift-c/DependencyScan/DSString.h

@@ -20,8 +20,8 @@ DEPSCAN_BEGIN_DECLS
 /**
  * A character string used to pass around dependency scan result metadata.
  * A slightly-reduced variation of clang's CXString
- * Use \c depscan_get_C_string() to retrieve the string data and, once finished
- * with the string data, call \c depscan_dispose_string() to free the string.
+ * Use \c ds_get_C_string() to retrieve the string data and, once finished
+ * with the string data, call \c ds_dispose_string() to free the string.
  */
 typedef struct {
   const void *data;
@@ -35,15 +35,15 @@ typedef struct {
 
 //=== Public API ----------------------------------------------------------===//
 /// Retrieve the character data associated with the given string.
-DEPSCAN_PUBLIC const char *depscan_get_C_string(ds_string_t string);
+DEPSCAN_PUBLIC const char *ds_get_C_string(ds_string_t string);
 
 
 /// Free the given string.
-DEPSCAN_PUBLIC void depscan_string_dispose(ds_string_t string);
+DEPSCAN_PUBLIC void ds_string_dispose(ds_string_t string);
 
 
 /// Free the given string set.
-DEPSCAN_PUBLIC void depscan_string_set_dispose(ds_string_set_t *set);
+DEPSCAN_PUBLIC void ds_string_set_dispose(ds_string_set_t *set);
 
 DEPSCAN_END_DECLS
 

include/swift-c/DependencyScan/DependencyScan.h

@@ -18,8 +18,8 @@
 #ifndef SWIFT_C_DEPENDENCY_SCAN_H
 #define SWIFT_C_DEPENDENCY_SCAN_H
 
-#include "DependencyScanMacros.h"
 #include "DSString.h"
+#include "DependencyScanMacros.h"
 #include <stdbool.h>
 #include <stddef.h>
 #include <stdint.h>
@@ -32,94 +32,17 @@
 
 DEPSCAN_BEGIN_DECLS
 
-//=== Scanner Data Types --------------------------------------------------===//
+//=== Public Scanner Data Types -------------------------------------------===//
 
 typedef enum {
   DEPSCAN_DEPENDENCY_INFO_SWIFT_TEXTUAL = 0,
   DEPSCAN_DEPENDENCY_INFO_SWIFT_BINARY = 1,
   DEPSCAN_DEPENDENCY_INFO_SWIFT_PLACEHOLDER = 2,
   DEPSCAN_DEPENDENCY_INFO_CLANG = 3
-} depscan_dependency_info_kind_t;
-
-/// Swift modules to be built from a module interface, may have a bridging
-/// header.
-typedef struct {
-  /// The module interface from which this module was built, if any.
-  ds_string_t module_interface_path;
-
-  /// The paths of potentially ready-to-use compiled modules for the interface.
-  ds_string_set_t* compiled_module_candidates;
-
-  /// The bridging header, if any.
-  ds_string_t bridging_header_path;
-
-  /// The source files referenced by the bridging header.
-  ds_string_set_t* bridging_source_files;
+} ds_dependency_info_kind_t;
 
-  /// (Clang) modules on which the bridging header depends.
-  ds_string_set_t* bridging_module_dependencies;
-
-  /// Options to the compile command required to build this module interface
-  ds_string_set_t* command_line;
-
-  /// To build a PCM to be used by this Swift module, we need to append these
-  /// arguments to the generic PCM build arguments reported from the dependency
-  /// graph.
-  ds_string_set_t* extra_pcm_args;
-
-  /// The hash value that will be used for the generated module
-  ds_string_t context_hash;
-
-  /// A flag to indicate whether or not this module is a framework.
-  bool is_framework;
-} depscan_swift_textual_details_t;
-
-/// Swift modules with only a binary module file.
-typedef struct {
-  /// The path to the pre-compiled binary module
-  ds_string_t compiled_module_path;
-
-  /// The path to the .swiftModuleDoc file.
-  ds_string_t module_doc_path;
-
-  /// The path to the .swiftSourceInfo file.
-  ds_string_t module_source_info_path;
-} depscan_swift_binary_details_t;
-
-/// Swift placeholder modules carry additional details that specify their
-/// module doc path and source info paths.
-typedef struct {
-  /// The path to the pre-compiled binary module
-  ds_string_t compiled_module_path;
-
-  /// The path to the .swiftModuleDoc file.
-  ds_string_t module_doc_path;
-
-  /// The path to the .swiftSourceInfo file.
-  ds_string_t module_source_info_path;
-} depscan_swift_placeholder_details_t;
-
-/// Clang modules are built from a module map file.
-typedef struct {
-  /// The path to the module map used to build this module.
-  ds_string_t module_map_path;
-
-  /// clang-generated context hash
-  ds_string_t context_hash;
-
-  /// Options to the compile command required to build this clang modulemap
-  ds_string_set_t* command_line;
-} depscan_clang_details_t;
-
-typedef struct {
-  depscan_dependency_info_kind_t kind;
-  union {
-    depscan_swift_textual_details_t swift_textual_details;
-    depscan_swift_binary_details_t swift_binary_details;
-    depscan_swift_placeholder_details_t swift_placeholder_details;
-    depscan_clang_details_t clang_details;
-  };
-} depscan_module_details_t;
+/// Opaque container of the details specific to a given module dependency.
+typedef void *ds_module_details_t;
 
 typedef struct {
   /// The module's name
@@ -136,78 +59,139 @@ typedef struct {
   ds_string_t module_path;
 
   /// The source files used to build this module.
-  ds_string_set_t* source_files;
+  ds_string_set_t *source_files;
 
   /**
    * The list of modules which this module direct depends on.
    * The format is:
    * `<module-kind>:<module-name>`
    */
-  ds_string_set_t* direct_dependencies;
+  ds_string_set_t *direct_dependencies;
 
   /// Specific details of a particular kind of module.
-  depscan_module_details_t* details;
-} depscan_dependency_info_t;
+  ds_module_details_t details;
+} ds_dependency_info_t;
 
 /// Full Dependency Graph (Result)
 
 typedef struct {
   int count;
-  depscan_dependency_info_t *modules;
-} depscan_dependency_set_t;
+  ds_dependency_info_t *modules;
+} ds_dependency_set_t;
 
 typedef struct {
   /// The name of the main module for this dependency graph (root node)
   ds_string_t main_module_name;
 
   /// The complete list of modules discovered
-  depscan_dependency_set_t* module_set;
-} depscan_dependency_result_t;
+  ds_dependency_set_t *module_set;
+} ds_dependency_result_t;
 
 typedef struct {
   /// The complete list of imports discovered
-  ds_string_set_t* import_set;
-} depscan_prescan_result_t;
+  ds_string_set_t *import_set;
+} ds_prescan_result_t;
 
 //=== Dependency Result Functions -----------------------------------------===//
 
-DEPSCAN_PUBLIC void
-depscan_dependency_info_details_dispose(depscan_module_details_t *details);
+DEPSCAN_PUBLIC ds_dependency_info_kind_t
+ds_get_module_detail_kind(ds_module_details_t details);
 
-DEPSCAN_PUBLIC void
-depscan_dependency_info_dispose(depscan_dependency_info_t *info);
+//=== Swift Textual Module Details query APIs -----------------------------===//
+DEPSCAN_PUBLIC ds_string_t
+ds_get_swift_textual_detail_module_interface_path(ds_module_details_t details);
 
-DEPSCAN_PUBLIC void
-depscan_dependency_set_dispose(depscan_dependency_set_t *set);
+DEPSCAN_PUBLIC ds_string_set_t *
+ds_get_swift_textual_detail_compiled_module_candidates(
+    ds_module_details_t details);
+
+DEPSCAN_PUBLIC ds_string_t
+ds_get_swift_textual_detail_bridging_header_path(ds_module_details_t details);
+
+DEPSCAN_PUBLIC ds_string_set_t *
+ds_get_swift_textual_detail_bridging_source_files(ds_module_details_t details);
+
+DEPSCAN_PUBLIC ds_string_set_t *
+ds_get_swift_textual_detail_bridging_module_dependencies(
+    ds_module_details_t details);
+
+DEPSCAN_PUBLIC ds_string_set_t *
+ds_get_swift_textual_detail_command_line(ds_module_details_t details);
+
+DEPSCAN_PUBLIC ds_string_set_t *
+ds_get_swift_textual_detail_extra_pcm_args(ds_module_details_t details);
+
+DEPSCAN_PUBLIC ds_string_t
+ds_get_swift_textual_detail_context_hash(ds_module_details_t details);
+
+DEPSCAN_PUBLIC bool
+ds_get_swift_textual_detail_is_framework(ds_module_details_t details);
+
+//=== Swift Binary Module Details query APIs ------------------------------===//
+
+DEPSCAN_PUBLIC ds_string_t
+ds_get_swift_binary_detail_compiled_module_path(ds_module_details_t details);
+
+DEPSCAN_PUBLIC ds_string_t
+ds_get_swift_binary_detail_module_doc_path(ds_module_details_t details);
+
+DEPSCAN_PUBLIC ds_string_t ds_get_swift_binary_detail_module_source_info_path(
+    ds_module_details_t *details);
+
+//=== Swift Placeholder Module Details query APIs -------------------------===//
+
+DEPSCAN_PUBLIC ds_string_t ds_get_swift_placeholder_detail_compiled_module_path(
+    ds_module_details_t details);
+
+DEPSCAN_PUBLIC ds_string_t
+ds_get_swift_placeholder_detail_module_doc_path(ds_module_details_t details);
+
+DEPSCAN_PUBLIC ds_string_t
+ds_get_swift_placeholder_detail_module_source_info_path(
+    ds_module_details_t details);
+
+//=== Clang Module Details query APIs -------------------------------------===//
+
+DEPSCAN_PUBLIC ds_string_t
+ds_get_clang_detail_module_map_path(ds_module_details_t details);
+
+DEPSCAN_PUBLIC ds_string_t
+ds_get_clang_detail_context_hash(ds_module_details_t details);
+
+DEPSCAN_PUBLIC ds_string_set_t *
+ds_get_clang_detail_command_line(ds_module_details_t details);
+
+//=== Cleanup Functions ---------------------------------------------------===//
 
 DEPSCAN_PUBLIC void
-depscan_dependency_result_dispose(depscan_dependency_result_t *result);
+ds_dependency_info_details_dispose(ds_module_details_t details);
+
+DEPSCAN_PUBLIC void ds_dependency_info_dispose(ds_dependency_info_t *info);
+
+DEPSCAN_PUBLIC void ds_dependency_set_dispose(ds_dependency_set_t *set);
 
 DEPSCAN_PUBLIC void
-depscan_prescan_result_dispose(depscan_prescan_result_t *result);
+ds_dependency_result_dispose(ds_dependency_result_t *result);
+
+DEPSCAN_PUBLIC void ds_prescan_result_dispose(ds_prescan_result_t *result);
 
 //=== Scanner Functions ---------------------------------------------------===//
 
-/// Container of the configuration state and shared cache for dependency scanning.
-typedef void *depscan_scanner_t;
+/// Container of the configuration state and shared cache for dependency
+/// scanning.
+typedef void *ds_scanner_t;
 
-DEPSCAN_PUBLIC depscan_scanner_t
-depscan_scanner_create(void);
+DEPSCAN_PUBLIC ds_scanner_t ds_scanner_create(void);
 
-DEPSCAN_PUBLIC void
-depscan_scanner_dispose(depscan_scanner_t);
-
-DEPSCAN_PUBLIC depscan_dependency_result_t*
-depscan_scan_dependencies(depscan_scanner_t* scanner,
-                          const char *working_directory,
-                          int argc,
-                          const char *const *argv);
-
-DEPSCAN_PUBLIC depscan_prescan_result_t*
-depscan_prescan_dependencies(depscan_scanner_t* scanner,
-                             const char *working_directory,
-                             int argc,
-                             const char *const *argv);
+DEPSCAN_PUBLIC void ds_scanner_dispose(ds_scanner_t);
+
+DEPSCAN_PUBLIC ds_dependency_result_t *
+ds_scan_dependencies(ds_scanner_t *scanner, const char *working_directory,
+                     int argc, const char *const *argv);
+
+DEPSCAN_PUBLIC ds_prescan_result_t *
+ds_prescan_dependencies(ds_scanner_t *scanner, const char *working_directory,
+                        int argc, const char *const *argv);
 
 DEPSCAN_END_DECLS