Merge pull request #35690 from cachemeifyoucan/swift-api-extract-json

swift-api-extract to generate JSON API information

Author: cachemeifyoucan

include/swift/AST/DiagnosticsFrontend.def

@@ -132,6 +132,7 @@ ERROR(cannot_emit_ir_skipping_function_bodies,none,
 WARNING(emit_reference_dependencies_without_primary_file,none,
         "ignoring -emit-reference-dependencies (requires -primary-file)", ())
 
+ERROR(error_module_name_required,none, "-module-name is required", ())
 ERROR(error_bad_module_name,none,
       "module name \"%0\" is not a valid identifier"
       "%select{|; use -module-name flag to specify an alternate name}1",

include/swift/AST/TBDGenRequests.h

@@ -41,6 +41,10 @@ namespace swift {
 class FileUnit;
 class ModuleDecl;
 
+namespace apigen {
+class API;
+} // end namespace apigen
+
 class TBDGenDescriptor final {
   using FileOrModule = llvm::PointerUnion<FileUnit *, ModuleDecl *>;
   FileOrModule Input;
@@ -120,6 +124,21 @@ class PublicSymbolsRequest
   evaluate(Evaluator &evaluator, TBDGenDescriptor desc) const;
 };
 
+/// Retrieve API information for a file or module.
+class APIGenRequest
+    : public SimpleRequest<APIGenRequest,
+                           apigen::API(TBDGenDescriptor),
+                           RequestFlags::Uncached> {
+public:
+  using SimpleRequest::SimpleRequest;
+
+private:
+  friend SimpleRequest;
+
+  // Evaluation.
+  apigen::API evaluate(Evaluator &evaluator, TBDGenDescriptor desc) const;
+};
+
 /// Describes the origin of a particular symbol, including the stage of
 /// compilation it is introduced, as well as information on what decl introduces
 /// it.

include/swift/AST/TBDGenTypeIDZone.def

@@ -22,3 +22,5 @@ SWIFT_REQUEST(TBDGen, PublicSymbolsRequest,
 SWIFT_REQUEST(TBDGen, SymbolSourceMapRequest,
               SymbolSourceMap(TBDGenDescriptor),
               Cached, NoLocationInfo)
+SWIFT_REQUEST(TBDGen, APIGenRequest, apigen::API(TBDGenDescriptor), Uncached,
+              NoLocationInfo)

include/swift/Driver/Driver.h

@@ -166,7 +166,8 @@ class Driver {
     Batch,           // swiftc
     AutolinkExtract, // swift-autolink-extract
     SwiftIndent,     // swift-indent
-    SymbolGraph      // swift-symbolgraph
+    SymbolGraph,     // swift-symbolgraph
+    APIExtract       // swift-api-extract
   };
 
   class InputInfoMap;

include/swift/Option/Options.h

@@ -37,6 +37,7 @@ namespace options {
     ArgumentIsPath = (1 << 12),
     ModuleInterfaceOption = (1 << 13),
     SupplementaryOutput = (1 << 14),
+    SwiftAPIExtractOption = (1 << 15),
   };
 
   enum ID {

include/swift/Option/Options.td

@@ -55,6 +55,9 @@ def ModuleInterfaceOption : OptionFlag;
 // for a supplementary output. E.g., `-emit-module` and `-emit-module-path`.
 def SupplementaryOutput : OptionFlag;
 
+// The option should be accepted by swift-api-extract.
+def SwiftAPIExtractOption : OptionFlag;
+
 /////////
 // Options
 
@@ -169,7 +172,8 @@ def driver_mode : Joined<["--"], "driver-mode=">, Flags<[HelpHidden]>,
   HelpText<"Set the driver mode to either 'swift' or 'swiftc'">;
 
 def help : Flag<["-", "--"], "help">,
-  Flags<[FrontendOption, AutolinkExtractOption, ModuleWrapOption, SwiftIndentOption]>,
+  Flags<[FrontendOption, AutolinkExtractOption, ModuleWrapOption,
+         SwiftIndentOption, SwiftAPIExtractOption]>,
   HelpText<"Display available options">;
 def h : Flag<["-"], "h">, Alias<help>;
 def help_hidden : Flag<["-", "--"], "help-hidden">,
@@ -191,16 +195,17 @@ def _DASH_DASH : Option<["--"], "", KIND_REMAINING_ARGS>,
 
 def o : JoinedOrSeparate<["-"], "o">,
   Flags<[FrontendOption, AutolinkExtractOption, ModuleWrapOption,
-         NoInteractiveOption, SwiftIndentOption, ArgumentIsPath]>,
+         NoInteractiveOption, SwiftIndentOption, ArgumentIsPath,
+         SwiftAPIExtractOption]>,
   HelpText<"Write output to <file>">, MetaVarName<"<file>">;
 
 def j : JoinedOrSeparate<["-"], "j">, Flags<[DoesNotAffectIncrementalBuild]>,
   HelpText<"Number of commands to execute in parallel">, MetaVarName<"<n>">;
 
-def sdk : Separate<["-"], "sdk">, Flags<[FrontendOption, ArgumentIsPath]>,
+def sdk : Separate<["-"], "sdk">, Flags<[FrontendOption, ArgumentIsPath, SwiftAPIExtractOption]>,
   HelpText<"Compile against <sdk>">, MetaVarName<"<sdk>">;
 
-def swift_version : Separate<["-"], "swift-version">, Flags<[FrontendOption, ModuleInterfaceOption]>,
+def swift_version : Separate<["-"], "swift-version">, Flags<[FrontendOption, ModuleInterfaceOption, SwiftAPIExtractOption]>,
   HelpText<"Interpret input according to a specific Swift language version number">,
   MetaVarName<"<vers>">;
 
@@ -217,16 +222,16 @@ def tools_directory : Separate<["-"], "tools-directory">,
 def D : JoinedOrSeparate<["-"], "D">, Flags<[FrontendOption]>,
   HelpText<"Marks a conditional compilation flag as true">;
 
-def F : JoinedOrSeparate<["-"], "F">, Flags<[FrontendOption, ArgumentIsPath]>,
+def F : JoinedOrSeparate<["-"], "F">, Flags<[FrontendOption, ArgumentIsPath, SwiftAPIExtractOption]>,
   HelpText<"Add directory to framework search path">;
 def F_EQ : Joined<["-"], "F=">, Flags<[FrontendOption, ArgumentIsPath]>,
   Alias<F>;
 
 def Fsystem : Separate<["-"], "Fsystem">,
-  Flags<[FrontendOption, ArgumentIsPath]>,
+  Flags<[FrontendOption, ArgumentIsPath, SwiftAPIExtractOption]>,
   HelpText<"Add directory to system framework search path">;
 
-def I : JoinedOrSeparate<["-"], "I">, Flags<[FrontendOption, ArgumentIsPath]>,
+def I : JoinedOrSeparate<["-"], "I">, Flags<[FrontendOption, ArgumentIsPath, SwiftAPIExtractOption]>,
   HelpText<"Add directory to the import search path">;
 def I_EQ : Joined<["-"], "I=">, Flags<[FrontendOption, ArgumentIsPath]>,
   Alias<I>;
@@ -372,7 +377,7 @@ def localization_path : Separate<["-"], "localization-path">,
   MetaVarName<"<path>">;
 
 def module_cache_path : Separate<["-"], "module-cache-path">,
-  Flags<[FrontendOption, DoesNotAffectIncrementalBuild, ArgumentIsPath]>,
+  Flags<[FrontendOption, DoesNotAffectIncrementalBuild, ArgumentIsPath, SwiftAPIExtractOption]>,
   HelpText<"Specifies the Clang module cache path">;
 
 def enable_library_evolution : Flag<["-"], "enable-library-evolution">,
@@ -393,7 +398,7 @@ def define_availability : Separate<["-"], "define-availability">,
   MetaVarName<"<macro>">;
 
 def module_name : Separate<["-"], "module-name">,
-  Flags<[FrontendOption, ModuleInterfaceOption]>,
+  Flags<[FrontendOption, ModuleInterfaceOption, SwiftAPIExtractOption]>,
   HelpText<"Name of the module to build">;
 def module_name_EQ : Joined<["-"], "module-name=">, Flags<[FrontendOption]>,
   Alias<module_name>;
@@ -663,7 +668,7 @@ def framework : Separate<["-"], "framework">, Group<linker_option_Group>,
   HelpText<"Specifies a framework which should be linked against">;
 
 def L : JoinedOrSeparate<["-"], "L">, Group<linker_option_Group>,
-  Flags<[FrontendOption, DoesNotAffectIncrementalBuild, ArgumentIsPath]>,
+  Flags<[FrontendOption, DoesNotAffectIncrementalBuild, ArgumentIsPath, SwiftAPIExtractOption]>,
   HelpText<"Add directory to library link search path">;
 def L_EQ : Joined<["-"], "L=">, Group<linker_option_Group>,
   Flags<[FrontendOption, DoesNotAffectIncrementalBuild, ArgumentIsPath]>,
@@ -1027,7 +1032,7 @@ def resource_dir : Separate<["-"], "resource-dir">,
   HelpText<"The directory that holds the compiler resource files">;
 
 def target : Separate<["-"], "target">,
-  Flags<[FrontendOption, ModuleWrapOption, ModuleInterfaceOption]>,
+  Flags<[FrontendOption, ModuleWrapOption, ModuleInterfaceOption, SwiftAPIExtractOption]>,
   HelpText<"Generate code for the given target <triple>, such as x86_64-apple-macos10.9">, MetaVarName<"<triple>">;
 def target_legacy_spelling : Joined<["--"], "target=">,
   Flags<[FrontendOption]>, Alias<target>;
@@ -1146,7 +1151,7 @@ def working_directory_EQ : Joined<["-"], "working-directory=">,
 // VFS
 
 def vfsoverlay : JoinedOrSeparate<["-"], "vfsoverlay">,
-  Flags<[FrontendOption, ArgumentIsPath]>,
+  Flags<[FrontendOption, ArgumentIsPath, SwiftAPIExtractOption]>,
   HelpText<"Add directory to VFS overlay file">;
 def vfsoverlay_EQ : Joined<["-"], "vfsoverlay=">,
   Alias<vfsoverlay>;
@@ -1177,4 +1182,8 @@ def emit_symbol_graph_dir : Separate<["-"], "emit-symbol-graph-dir">,
   HelpText<"Emit a symbol graph to directory <dir>">,
   MetaVarName<"<dir>">;
 
+// Swift API Extraction only options
+def pretty_print: Flag<["-"], "pretty-print">, Flags<[SwiftAPIExtractOption]>,
+  HelpText<"Pretty-print the output JSON">;
+
 include "FrontendOptions.td"

include/swift/TBDGen/TBDGen.h

@@ -99,6 +99,8 @@ std::vector<std::string> getPublicSymbols(TBDGenDescriptor desc);
 void writeTBDFile(ModuleDecl *M, llvm::raw_ostream &os,
                   const TBDGenOptions &opts);
 
+void writeAPIJSONFile(ModuleDecl *M, llvm::raw_ostream &os, bool PrettyPrint);
+
 } // end namespace swift
 
 #endif

lib/Driver/Driver.cpp

@@ -102,6 +102,7 @@ void Driver::parseDriverKind(ArrayRef<const char *> Args) {
   .Case("swift-autolink-extract", DriverKind::AutolinkExtract)
   .Case("swift-indent", DriverKind::SwiftIndent)
   .Case("swift-symbolgraph-extract", DriverKind::SymbolGraph)
+  .Case("swift-api-extract", DriverKind::APIExtract)
   .Default(None);
 
   if (Kind.hasValue())
@@ -3467,6 +3468,7 @@ void Driver::printHelp(bool ShowHidden) const {
   case DriverKind::AutolinkExtract:
   case DriverKind::SwiftIndent:
   case DriverKind::SymbolGraph:
+  case DriverKind::APIExtract:
     ExcludedFlagsBitmask |= options::NoBatchOption;
     break;
   }

lib/TBDGen/APIGen.cpp

@@ -0,0 +1,173 @@
+//===--- APIGen.cpp - Swift API Generation --------------------------------===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2014 - 2017 Apple Inc. and the Swift project authors
+// Licensed under Apache License v2.0 with Runtime Library Exception
+//
+// See https://swift.org/LICENSE.txt for license information
+// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+//
+//===----------------------------------------------------------------------===//
+//
+//  This file implements the entrypoints into API file generation.
+//
+//===----------------------------------------------------------------------===//
+
+
+#include "llvm/ADT/StringSwitch.h"
+#include "llvm/Support/JSON.h"
+#include "llvm/Support/raw_ostream.h"
+
+#include "APIGen.h"
+
+namespace swift {
+namespace apigen {
+
+void API::addSymbol(llvm::StringRef symbol, APILoc loc, APILinkage linkage,
+                    APIFlags flags, APIAccess access,
+                    APIAvailability availability) {
+  globals.emplace_back(symbol, loc, linkage, flags, access, GVKind::Function,
+                       availability);
+}
+
+ObjCInterfaceRecord *API::addObjCClass(llvm::StringRef name, APILinkage linkage,
+                                       APILoc loc, APIAccess access,
+                                       APIAvailability availability,
+                                       llvm::StringRef superClassName) {
+  interfaces.emplace_back(name, linkage, loc, access, availability,
+                          superClassName);
+  return &interfaces.back();
+}
+
+void API::addObjCMethod(ObjCInterfaceRecord *cls, llvm::StringRef name,
+                        APILoc loc, APIAccess access, bool isInstanceMethod,
+                        bool isOptional, APIAvailability availability) {
+  cls->methods.emplace_back(name, loc, access, isInstanceMethod, isOptional,
+                            availability);
+}
+
+static void serialize(llvm::json::OStream &OS, APIAccess access) {
+  switch (access) {
+  case APIAccess::Public:
+    OS.attribute("access", "public");
+    break;
+  case APIAccess::Private:
+    OS.attribute("access", "private");
+    break;
+  case APIAccess::Project:
+    OS.attribute("access", "project");
+    break;
+  case APIAccess::Unknown:
+    break;
+  }
+}
+
+static void serialize(llvm::json::OStream &OS, APIAvailability availability) {
+  if (availability.empty())
+    return;
+  if (!availability.introduced.empty())
+    OS.attribute("introduced", availability.introduced);
+  if (!availability.obsoleted.empty())
+    OS.attribute("obsoleted", availability.obsoleted);
+  if (availability.unavailable)
+    OS.attribute("unavailable", availability.unavailable);
+}
+
+static void serialize(llvm::json::OStream &OS, APILinkage linkage) {
+  switch (linkage) {
+  case APILinkage::Exported:
+    OS.attribute("linkage", "exported");
+    break;
+  case APILinkage::Reexported:
+    OS.attribute("linkage", "re-exported");
+    break;
+  case APILinkage::Internal:
+    OS.attribute("linkage", "internal");
+    break;
+  case APILinkage::External:
+    OS.attribute("linkage", "external");
+    break;
+  case APILinkage::Unknown:
+    // do nothing;
+    break;
+  }
+}
+
+static void serialize(llvm::json::OStream &OS, APILoc loc) {
+  OS.attribute("file", loc.getFilename());
+}
+
+static void serialize(llvm::json::OStream &OS, const GlobalRecord &record) {
+  OS.object([&]() {
+    OS.attribute("name", record.name);
+    serialize(OS, record.access);
+    serialize(OS, record.loc);
+    serialize(OS, record.linkage);
+    serialize(OS, record.availability);
+  });
+}
+
+static void serialize(llvm::json::OStream &OS, const ObjCMethodRecord &record) {
+  OS.object([&]() {
+    OS.attribute("name", record.name);
+    serialize(OS, record.access);
+    serialize(OS, record.loc);
+    serialize(OS, record.linkage);
+    serialize(OS, record.availability);
+    if (record.isOptional)
+      OS.attribute("optional", record.isOptional);
+  });
+}
+
+static void serialize(llvm::json::OStream &OS,
+                      const ObjCInterfaceRecord &record) {
+  OS.object([&]() {
+    OS.attribute("name", record.name);
+    serialize(OS, record.access);
+    serialize(OS, record.loc);
+    serialize(OS, record.linkage);
+    serialize(OS, record.availability);
+    OS.attribute("super", record.superClassName);
+    OS.attributeArray("instanceMethods", [&]() {
+      for (auto &method : record.methods) {
+        if (method.isInstanceMethod)
+          serialize(OS, method);
+      }
+    });
+    OS.attributeArray("classMethods", [&]() {
+      for (auto &method : record.methods) {
+        if (!method.isInstanceMethod)
+          serialize(OS, method);
+      }
+    });
+  });
+}
+
+static bool sortAPIRecords(const APIRecord &base, const APIRecord &compare) {
+  return base.name < compare.name;
+}
+
+void API::writeAPIJSONFile(llvm::raw_ostream &os, bool PrettyPrint) {
+  unsigned indentSize = PrettyPrint ? 2 : 0;
+  llvm::json::OStream JSON(os, indentSize);
+
+  // FIXME: only write PublicSDKContentRoot now.
+  JSON.object([&]() {
+    JSON.attribute("target", target.str());
+    JSON.attributeArray("globals", [&]() {
+      llvm::sort(globals, sortAPIRecords);
+      for (const auto &g : globals)
+        serialize(JSON, g);
+    });
+    JSON.attributeArray("interfaces", [&]() {
+      llvm::sort(interfaces, sortAPIRecords);
+      for (const auto &i : interfaces)
+        serialize(JSON, i);
+    });
+    JSON.attribute("version", "1.0");
+  });
+}
+
+} // end namespace apigen
+} // end namespace swift