swift-api-checker: teach the script to collect all frameworks with Swift overlay in SDKs

Author: nkcsgexi

utils/api_checker/sdk-module-lists/infer-imports.py

@@ -57,6 +57,18 @@ def get_frameworks(sdk_path, swift_frameworks_only):
     return names
 
 
+def get_overlays(sdk_path):
+    overlay_path = sdk_path + "/usr/lib/swift/"
+    names = []
+    for overlay in os.listdir(overlay_path):
+        if overlay.endswith(".swiftmodule"):
+            overlay = overlay[:-len(".swiftmodule")]
+            if overlay in blacklist:
+                continue
+            names.append(overlay)
+    return names
+
+
 def should_exclude_framework(frame_path):
     module_map_path = frame_path + '/Modules/module.modulemap'
     if not os.path.exists(module_map_path):
@@ -99,6 +111,7 @@ def main():
                       type=str, dest="out_mode", default="list")
     parser.add_option("--hash", action="store_true", dest="use_hash")
     parser.add_option("--swift-frameworks-only", action="store_true")
+    parser.add_option("--swift-overlay-only", action="store_true")
     parser.add_option("--v", action="store_true")
     (opts, cmd) = parser.parse_args()
 
@@ -109,7 +122,10 @@ def main():
         parser.error(
             "output mode not specified: 'clang-import'/'swift-import'/'list'")
 
-    frames = get_frameworks(opts.sdk, opts.swift_frameworks_only)
+    if opts.swift_overlay_only:
+        frames = get_overlays(opts.sdk)
+    else:
+        frames = get_frameworks(opts.sdk, opts.swift_frameworks_only)
     if opts.v:
         for name in frames:
             print >>sys.stderr, 'Including: ', name

utils/api_checker/swift-api-checker.py

@@ -47,15 +47,15 @@ def get_sdk_path(platform):
     return check_output(['xcrun', '-sdk', platform, '-show-sdk-path'])
 
 
-def prepare_module_list(platform, file, verbose, swift_frameworks_only):
+def prepare_module_list(platform, file, verbose, module_filter_flags,
+                        include_fixed_modules):
     cmd = [INFER_IMPORT_PATH, '-s', get_sdk_path(platform)]
-    if swift_frameworks_only:
-        cmd.extend(['--swift-frameworks-only'])
+    cmd.extend(module_filter_flags)
     if verbose:
         cmd.extend(['--v'])
     check_call(cmd, output=file)
     # The fixed modules are all objc frameworks.
-    if swift_frameworks_only:
+    if not include_fixed_modules:
         return
     with open(INFER_IMPORT_DIR + '/fixed-modules-common.txt', 'r') as extra:
         file.write(extra.read())
@@ -92,7 +92,7 @@ def __init__(self, tool_path, platform):
             os.path.realpath(self.sdk + '/../../Library/Frameworks/')]
 
     def run(self, output, module, swift_ver, opts, verbose,
-            swift_frameworks_only, separate_by_module):
+            module_filter_flags, include_fixed_modules, separate_by_module):
         cmd = [self.tool_path, '-sdk', self.sdk, '-target',
                self.target, '-dump-sdk', '-module-cache-path',
                '/tmp/ModuleCache', '-swift-version',
@@ -109,7 +109,7 @@ def run(self, output, module, swift_ver, opts, verbose,
         else:
             with tempfile.NamedTemporaryFile() as tmp:
                 prepare_module_list(self.platform, tmp, verbose,
-                                    swift_frameworks_only)
+                                    module_filter_flags, include_fixed_modules)
                 if separate_by_module:
                     tmp.seek(0)
                     create_directory(output)
@@ -177,9 +177,9 @@ def main():
         name of the module/framework to generate baseline, e.g. Foundation
         ''')
 
-    basic_group.add_argument('--swift-frameworks-only',
-                             action='store_true',
-                             help='Only include Swift frameworks in the dump')
+    basic_group.add_argument('--module-filter', default='', help='''
+        the action to perform for swift-api-digester
+        ''')
 
     basic_group.add_argument('--opts', nargs='+', default=[], help='''
         additional flags to pass to swift-api-digester
@@ -206,16 +206,29 @@ def main():
                              help='When importing entire SDK, dump content '
                                   'seprately by module names')
     args = parser.parse_args(sys.argv[1:])
+
     if args.action == 'dump':
         if not args.target:
             fatal_error("Need to specify --target")
         if not args.output:
             fatal_error("Need to specify --output")
+        if args.module_filter == '':
+            module_filter_flags = []
+            include_fixed_modules = True
+        elif args.module_filter == 'swift-frameworks-only':
+            module_filter_flags = ['--swift-frameworks-only']
+            include_fixed_modules = False
+        elif args.module_filter == 'swift-overlay-only':
+            module_filter_flags = ['--swift-overlay-only']
+            include_fixed_modules = False
+        else:
+            fatal_error("cannot recognize --module-filter")
         runner = DumpConfig(tool_path=args.tool_path, platform=args.target)
         runner.run(output=args.output, module=args.module,
                    swift_ver=args.swift_version, opts=args.opts,
                    verbose=args.v,
-                   swift_frameworks_only=args.swift_frameworks_only,
+                   module_filter_flags=module_filter_flags,
+                   include_fixed_modules=include_fixed_modules,
                    separate_by_module=args.separate_by_module)
     elif args.action == 'diagnose':
         if not args.dump_before: