[Dependency Scanning] Change C API prefix to: swiftscan from ds and adopt query method naming scheme of:

`<prefix>_<object>_<action>`

Author: artemcm

include/swift-c/DependencyScan/DSString.h

@@ -10,41 +10,41 @@
 //
 //===----------------------------------------------------------------------===//
 
-#ifndef SWIFT_C_DSSTRING_H
-#define SWIFT_C_DSSTRING_H
+#ifndef SWIFT_C_SWIFTSCANSTRING_H
+#define SWIFT_C_SWIFTSCANSTRING_H
 
 #include "DependencyScanMacros.h"
 
-DEPSCAN_BEGIN_DECLS
+SWIFTSCAN_BEGIN_DECLS
 
 /**
  * A character string used to pass around dependency scan result metadata.
  * A slightly-reduced variation of clang's CXString
- * 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.
+ * Use \c swiftscan_get_C_string() to retrieve the string data and, once finished
+ * with the string data, call \c swiftscan_dispose_string() to free the string.
  */
 typedef struct {
   const void *data;
   unsigned private_flags;
-} ds_string_t;
+} swiftscan_string_t;
 
 typedef struct {
-  ds_string_t *strings;
+  swiftscan_string_t *strings;
   unsigned count;
-} ds_string_set_t;
+} swiftscan_string_set_t;
 
 //=== Public API ----------------------------------------------------------===//
 /// Retrieve the character data associated with the given string.
-DEPSCAN_PUBLIC const char *ds_get_C_string(ds_string_t string);
+SWIFTSCAN_PUBLIC const char *swiftscan_get_C_string(swiftscan_string_t string);
 
 
 /// Free the given string.
-DEPSCAN_PUBLIC void ds_string_dispose(ds_string_t string);
+SWIFTSCAN_PUBLIC void swiftscan_string_dispose(swiftscan_string_t string);
 
 
 /// Free the given string set.
-DEPSCAN_PUBLIC void ds_string_set_dispose(ds_string_set_t *set);
+SWIFTSCAN_PUBLIC void swiftscan_string_set_dispose(swiftscan_string_set_t *set);
 
-DEPSCAN_END_DECLS
+SWIFTSCAN_END_DECLS
 
-#endif // SWIFT_C_DSSTRING_H
+#endif // SWIFT_C_SWIFTSCANSTRING_H

include/swift-c/DependencyScan/DependencyScan.h

@@ -25,24 +25,24 @@
 #include <stdint.h>
 
 /// The version constants for the SwiftDependencyScan C API.
-/// DEPSCAN_VERSION_MINOR should increase when there are API additions.
-/// DEPSCAN_VERSION_MAJOR is intended for "major" source/ABI breaking changes.
-#define DEPSCAN_VERSION_MAJOR 0
-#define DEPSCAN_VERSION_MINOR 1
+/// SWIFTSCAN_VERSION_MINOR should increase when there are API additions.
+/// SWIFTSCAN_VERSION_MAJOR is intended for "major" source/ABI breaking changes.
+#define SWIFTSCAN_VERSION_MAJOR 0
+#define SWIFTSCAN_VERSION_MINOR 1
 
-DEPSCAN_BEGIN_DECLS
+SWIFTSCAN_BEGIN_DECLS
 
 //=== 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
-} ds_dependency_info_kind_t;
+  SWIFTSCAN_DEPENDENCY_INFO_SWIFT_TEXTUAL = 0,
+  SWIFTSCAN_DEPENDENCY_INFO_SWIFT_BINARY = 1,
+  SWIFTSCAN_DEPENDENCY_INFO_SWIFT_PLACEHOLDER = 2,
+  SWIFTSCAN_DEPENDENCY_INFO_CLANG = 3
+} swiftscan_dependency_info_kind_t;
 
 /// Opaque container of the details specific to a given module dependency.
-typedef void *ds_module_details_t;
+typedef void *swiftscan_module_details_t;
 
 typedef struct {
   /// The module's name
@@ -53,176 +53,195 @@ typedef struct {
   /// "swiftBinary"
   /// "swiftPlaceholder"
   /// "clang""
-  ds_string_t module_name;
+  swiftscan_string_t module_name;
 
   /// The path for the module.
-  ds_string_t module_path;
+  swiftscan_string_t module_path;
 
   /// The source files used to build this module.
-  ds_string_set_t *source_files;
+  swiftscan_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;
+  swiftscan_string_set_t *direct_dependencies;
 
   /// Specific details of a particular kind of module.
-  ds_module_details_t details;
-} ds_dependency_info_t;
+  swiftscan_module_details_t details;
+} swiftscan_dependency_info_t;
 
 /// Full Dependency Graph (Result)
 
 typedef struct {
   int count;
-  ds_dependency_info_t *modules;
-} ds_dependency_set_t;
+  swiftscan_dependency_info_t *modules;
+} swiftscan_dependency_set_t;
 
 typedef struct {
   /// The name of the main module for this dependency graph (root node)
-  ds_string_t main_module_name;
+  swiftscan_string_t main_module_name;
 
   /// The complete list of modules discovered
-  ds_dependency_set_t *module_set;
-} ds_dependency_result_t;
+  swiftscan_dependency_set_t *module_set;
+} swiftscan_dependency_result_t;
 
 typedef struct {
   /// The complete list of imports discovered
-  ds_string_set_t *import_set;
-} ds_prescan_result_t;
+  swiftscan_string_set_t *import_set;
+} swiftscan_prescan_result_t;
 
 //=== Batch Scan Input Specification --------------------------------------===//
 
 typedef struct {
-  ds_string_t module_name;
-  ds_string_t arguments;
+  swiftscan_string_t module_name;
+  swiftscan_string_t arguments;
   bool is_swift;
-} ds_batch_scan_entry_t;
+} swiftscan_batch_scan_entry_t;
 
 typedef struct {
   int count;
-  ds_batch_scan_entry_t *modules;
-} ds_batch_scan_input_t;
+  swiftscan_batch_scan_entry_t *modules;
+} swiftscan_batch_scan_input_t;
 
 typedef struct {
   int count;
-  ds_dependency_result_t **results;
-} ds_batch_scan_result_t;
+  swiftscan_dependency_result_t **results;
+} swiftscan_batch_scan_result_t;
 
 //=== Dependency Result Functions -----------------------------------------===//
 
-DEPSCAN_PUBLIC ds_dependency_info_kind_t
-ds_get_module_detail_kind(ds_module_details_t details);
+SWIFTSCAN_PUBLIC swiftscan_dependency_info_kind_t
+swiftscan_get_module_detail_kind(swiftscan_module_details_t details);
 
 //=== Swift Textual Module Details query APIs -----------------------------===//
-DEPSCAN_PUBLIC ds_string_t
-ds_get_swift_textual_detail_module_interface_path(ds_module_details_t details);
+SWIFTSCAN_PUBLIC swiftscan_string_t
+swiftscan_swift_textual_detail_get_module_interface_path(
+    swiftscan_module_details_t details);
 
-DEPSCAN_PUBLIC ds_string_set_t *
-ds_get_swift_textual_detail_compiled_module_candidates(
-    ds_module_details_t details);
+SWIFTSCAN_PUBLIC swiftscan_string_set_t *
+swiftscan_swift_textual_detail_get_compiled_module_candidates(
+    swiftscan_module_details_t details);
 
-DEPSCAN_PUBLIC ds_string_t
-ds_get_swift_textual_detail_bridging_header_path(ds_module_details_t details);
+SWIFTSCAN_PUBLIC swiftscan_string_t
+swiftscan_swift_textual_detail_get_bridging_header_path(
+    swiftscan_module_details_t details);
 
-DEPSCAN_PUBLIC ds_string_set_t *
-ds_get_swift_textual_detail_bridging_source_files(ds_module_details_t details);
+SWIFTSCAN_PUBLIC swiftscan_string_set_t *
+swiftscan_swift_textual_detail_get_bridging_source_files(
+    swiftscan_module_details_t details);
 
-DEPSCAN_PUBLIC ds_string_set_t *
-ds_get_swift_textual_detail_bridging_module_dependencies(
-    ds_module_details_t details);
+SWIFTSCAN_PUBLIC swiftscan_string_set_t *
+swiftscan_swift_textual_detail_get_bridging_module_dependencies(
+    swiftscan_module_details_t details);
 
-DEPSCAN_PUBLIC ds_string_set_t *
-ds_get_swift_textual_detail_command_line(ds_module_details_t details);
+SWIFTSCAN_PUBLIC swiftscan_string_set_t *
+swiftscan_swift_textual_detail_get_command_line(
+    swiftscan_module_details_t details);
 
-DEPSCAN_PUBLIC ds_string_set_t *
-ds_get_swift_textual_detail_extra_pcm_args(ds_module_details_t details);
+SWIFTSCAN_PUBLIC swiftscan_string_set_t *
+swiftscan_swift_textual_detail_get_extra_pcm_args(
+    swiftscan_module_details_t details);
 
-DEPSCAN_PUBLIC ds_string_t
-ds_get_swift_textual_detail_context_hash(ds_module_details_t details);
+SWIFTSCAN_PUBLIC swiftscan_string_t
+swiftscan_swift_textual_detail_get_context_hash(
+    swiftscan_module_details_t details);
 
-DEPSCAN_PUBLIC bool
-ds_get_swift_textual_detail_is_framework(ds_module_details_t details);
+SWIFTSCAN_PUBLIC bool swiftscan_swift_textual_detail_get_is_framework(
+    swiftscan_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);
+SWIFTSCAN_PUBLIC swiftscan_string_t
+swiftscan_swift_binary_detail_get_compiled_module_path(
+    swiftscan_module_details_t details);
 
-DEPSCAN_PUBLIC ds_string_t
-ds_get_swift_binary_detail_module_doc_path(ds_module_details_t details);
+SWIFTSCAN_PUBLIC swiftscan_string_t
+swiftscan_swift_binary_detail_get_module_doc_path(
+    swiftscan_module_details_t details);
 
-DEPSCAN_PUBLIC ds_string_t ds_get_swift_binary_detail_module_source_info_path(
-    ds_module_details_t *details);
+SWIFTSCAN_PUBLIC swiftscan_string_t
+swiftscan_swift_binary_detail_get_module_source_info_path(
+    swiftscan_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);
+SWIFTSCAN_PUBLIC swiftscan_string_t
+swiftscan_swift_placeholder_detail_get_compiled_module_path(
+    swiftscan_module_details_t details);
 
-DEPSCAN_PUBLIC ds_string_t
-ds_get_swift_placeholder_detail_module_doc_path(ds_module_details_t details);
+SWIFTSCAN_PUBLIC swiftscan_string_t
+swiftscan_swift_placeholder_detail_get_module_doc_path(
+    swiftscan_module_details_t details);
 
-DEPSCAN_PUBLIC ds_string_t
-ds_get_swift_placeholder_detail_module_source_info_path(
-    ds_module_details_t details);
+SWIFTSCAN_PUBLIC swiftscan_string_t
+swiftscan_swift_placeholder_detail_get_module_source_info_path(
+    swiftscan_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);
+SWIFTSCAN_PUBLIC swiftscan_string_t
+swiftscan_clang_detail_get_module_map_path(swiftscan_module_details_t details);
 
-DEPSCAN_PUBLIC ds_string_t
-ds_get_clang_detail_context_hash(ds_module_details_t details);
+SWIFTSCAN_PUBLIC swiftscan_string_t
+swiftscan_clang_detail_get_context_hash(swiftscan_module_details_t details);
 
-DEPSCAN_PUBLIC ds_string_set_t *
-ds_get_clang_detail_command_line(ds_module_details_t details);
+SWIFTSCAN_PUBLIC swiftscan_string_set_t *
+swiftscan_clang_detail_get_command_line(swiftscan_module_details_t details);
 
 //=== Cleanup Functions ---------------------------------------------------===//
 
-DEPSCAN_PUBLIC void
-ds_dependency_info_details_dispose(ds_module_details_t details);
+SWIFTSCAN_PUBLIC void
+swiftscan_dependency_info_details_dispose(swiftscan_module_details_t details);
 
-DEPSCAN_PUBLIC void ds_dependency_info_dispose(ds_dependency_info_t *info);
+SWIFTSCAN_PUBLIC void
+swiftscan_dependency_info_dispose(swiftscan_dependency_info_t *info);
 
-DEPSCAN_PUBLIC void ds_dependency_set_dispose(ds_dependency_set_t *set);
+SWIFTSCAN_PUBLIC void
+swiftscan_dependency_set_dispose(swiftscan_dependency_set_t *set);
 
-DEPSCAN_PUBLIC void
-ds_dependency_result_dispose(ds_dependency_result_t *result);
+SWIFTSCAN_PUBLIC void
+swiftscan_dependency_result_dispose(swiftscan_dependency_result_t *result);
 
-DEPSCAN_PUBLIC void ds_prescan_result_dispose(ds_prescan_result_t *result);
+SWIFTSCAN_PUBLIC void
+swiftscan_prescan_result_dispose(swiftscan_prescan_result_t *result);
 
-DEPSCAN_PUBLIC void ds_batch_scan_entry_dispose(ds_batch_scan_entry_t *entry);
+SWIFTSCAN_PUBLIC void
+swiftscan_batch_scan_entry_dispose(swiftscan_batch_scan_entry_t *entry);
 
-DEPSCAN_PUBLIC void ds_batch_scan_input_dispose(ds_batch_scan_input_t *input);
+SWIFTSCAN_PUBLIC void
+swiftscan_batch_scan_input_dispose(swiftscan_batch_scan_input_t *input);
 
-DEPSCAN_PUBLIC void
-ds_batch_scan_result_dispose(ds_batch_scan_result_t *result);
+SWIFTSCAN_PUBLIC void
+swiftscan_batch_scan_result_dispose(swiftscan_batch_scan_result_t *result);
 
 //=== Scanner Functions ---------------------------------------------------===//
 
 /// Container of the configuration state and shared cache for dependency
 /// scanning.
-typedef void *ds_scanner_t;
+typedef void *swiftscan_scanner_t;
 
-DEPSCAN_PUBLIC ds_scanner_t ds_scanner_create(void);
+SWIFTSCAN_PUBLIC swiftscan_scanner_t swiftscan_scanner_create(void);
 
-DEPSCAN_PUBLIC void ds_scanner_dispose(ds_scanner_t);
+SWIFTSCAN_PUBLIC void swiftscan_scanner_dispose(swiftscan_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);
+SWIFTSCAN_PUBLIC swiftscan_dependency_result_t *
+swiftscan_scan_dependencies(swiftscan_scanner_t *scanner,
+                            const char *working_directory, int argc,
+                            const char *const *argv);
 
-DEPSCAN_PUBLIC ds_batch_scan_result_t *
-ds_batch_scan_dependencies(ds_scanner_t *scanner, const char *working_directory,
-                           ds_batch_scan_input_t *batch_input,
-                           int argc, const char *const *argv);
+SWIFTSCAN_PUBLIC swiftscan_batch_scan_result_t *
+swiftscan_batch_scan_dependencies(swiftscan_scanner_t *scanner,
+                                  const char *working_directory,
+                                  swiftscan_batch_scan_input_t *batch_input,
+                                  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);
+SWIFTSCAN_PUBLIC swiftscan_prescan_result_t *
+swiftscan_prescan_dependencies(swiftscan_scanner_t *scanner,
+                               const char *working_directory, int argc,
+                               const char *const *argv);
 
-DEPSCAN_END_DECLS
+SWIFTSCAN_END_DECLS
 
 #endif // SWIFT_C_DEPENDENCY_SCAN_H