[WIP][Functional] Add example Siri Shortcut

.buckconfig

@@ -8,7 +8,7 @@
 
 [swift]
   version = 4.0
-  compiler_flags = -DBUCK -enable-testing -g -Onone -whole-module-optimization $(config custom.other_swift_compiler_flags)
+  compiler_flags = -DBUCK -enable-testing -g -Onone -whole-module-optimization $(config custom.other_swift_compiler_flags) -DDISABLE_SIRI_SHORTCUT
   use_filelist = true
 
 [apple]
@@ -41,4 +41,3 @@
   code_coverage_cxxflags = -fprofile-instr-generate -fcoverage-mapping
   code_coverage_ldflags = -fprofile-instr-generate
   code_coverage_swift_compiler_flags = -profile-generate -profile-coverage-mapping
-

.gitignore

@@ -10,7 +10,9 @@ tools/buck
 # Xcode
 **/xcuserdata/
 **/*.xcodeproj/
+!App/SiriShortcut/_IntentsCompiler/IntentsCompiler.xcodeproj
 **/*.xcworkspace/
+**/build/
 
 # Make
 *.d

App/AppDelegate.swift

@@ -13,10 +13,42 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
   let window = UIWindow(frame: UIScreen.main.bounds)
 
   func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: ArgType) -> Bool {
-  
+
     window.makeKeyAndVisible()
     window.rootViewController = ViewController()
 
     return true
   }
+
+  #if !DISABLE_SIRI_SHORTCUT
+  #if swift(>=4.2)
+  // Xcode 10
+  func application(
+    _ application: UIApplication,
+    continue userActivity: NSUserActivity,
+    restorationHandler: @escaping ([UIUserActivityRestoring]?) -> Void) -> Bool
+  {
+    return continueWithUserActivity(userActivity)
+  }
+  #endif
+  #endif
+
+  // MARK: Private
+
+  private func continueWithUserActivity(_ userActivity: NSUserActivity) -> Bool {
+    guard #available(iOS 12.0, *) else {
+      return false
+    }
+
+    #if !DISABLE_SIRI_SHORTCUT
+    if let buckPhotoIntent = userActivity.interaction?.intent as? BuckPhotoIntent {
+      print("Launched with BuckPhotoIntent: \(buckPhotoIntent)")
+      return true
+    } else {
+      return false
+    }
+    #else
+    return false
+    #endif
+  }
 }

App/BUCK

@@ -1,5 +1,5 @@
-load("//Config:configs.bzl", "app_binary_configs", "library_configs", "watch_binary_configs", "message_binary_configs", "pretty", "info_plist_substitutions", "bundle_identifier", "DEVELOPMENT_LANGUAGE")
-load("//Config:buck_rule_macros.bzl", "apple_lib", "apple_test_lib", "apple_test_all")
+load("//Config:configs.bzl", "app_binary_configs", "library_configs", "watch_binary_configs", "message_binary_configs", "intent_binary_configs", "pretty", "info_plist_substitutions", "bundle_identifier", "DEVELOPMENT_LANGUAGE")
+load("//Config:buck_rule_macros.bzl", "apple_lib", "apple_test_lib", "apple_test_all", "intent_interface")
 
 apple_asset_catalog(
     name = "ExampleAppAssets",
@@ -57,8 +57,10 @@ apple_library(
     swift_version = "4.0",
     srcs = [
         "ViewController.swift",
+        "ViewController+INUIAddVoiceShortcutViewControllerDelegate.swift",
         "AppDelegate.swift",
         "LocalizationHelper.swift",
+        ":BuckPhotoIntentInterface",
     ],
     tests = app_tests,
     deps = [
@@ -69,10 +71,16 @@ apple_library(
 
         # Resources
         "//App/Resources:ExampleAppStringResources",
+        "//App/Resources:IntentsDefinition",
+        "//App/Resources:IntentsStringResources",
         "//App/Resources:StoryboardResources",
     ]
     + first_party_library_dependencies
     + build_phase_scripts,
+    frameworks = [
+        "$SDKROOT/System/Library/Frameworks/Intents.framework",
+        "$SDKROOT/System/Library/Frameworks/IntentsUI.framework",
+    ],
 )
 
 apple_binary(
@@ -82,6 +90,7 @@ apple_binary(
         "//App/...",
     ],
     configs = app_binary_configs("ExampleApp"),
+    entitlements_file = "ExampleApp.entitlements",
     swift_version = "4.0",
     srcs = [
         "BuckSupportFiles/Dummy.swift",
@@ -148,7 +157,9 @@ apple_bundle(
     deps = [
         # For "#watch", https://buckbuild.com/rule/apple_bundle.html#deps
         ":ExampleWatchApp#watch",
-        ":ExampleMessageExtension"
+        ":ExampleMessageExtension",
+        ":ExampleIntentExtension",
+        ":ExampleIntentUIExtension",
     ]
     + prebuilt_frameworks,
 )
@@ -158,6 +169,129 @@ apple_package(
     bundle = ":ExampleApp",
 )
 
+### Siri Shortcut Begin ###
+
+# Set up `BuckPhotoIntent` by handling the .intentdefinition file.
+intent_interface(
+    "BuckPhotoIntentInterface",
+    "BuckPhoto",
+    "SiriShortcut/_IntentsCompiler/IntentsCompiler.xcodeproj")
+
+# The non-UI code for processing `BuckPhotoIntent`.
+intent_bundle_identifier = bundle_identifier("ExampleApp.IntentExtension")
+intent_binary_name = "ExampleIntentBinary"
+intent_bundle_name = "ExampleIntentExtension"
+intent_info_plist_substitutions = {
+    "DEVELOPMENT_LANGUAGE": "en-us",
+    "EXECUTABLE_NAME": intent_bundle_name,
+    "PRODUCT_BUNDLE_DISPLAY_NAME": intent_bundle_name,
+    "PRODUCT_BUNDLE_IDENTIFIER": intent_bundle_identifier,
+    "PRODUCT_NAME": intent_bundle_name,
+    # The Swift module name for `IntentHandler` is the binary name.
+    "NS_EXTENSION_PRINCIPAL_CLASS": "%s.IntentHandler" % intent_binary_name,
+}
+
+apple_binary(
+    name = intent_binary_name,
+    srcs = glob([
+        "SiriShortcut/ExampleIntent/**/*.swift",
+    ]) + [":BuckPhotoIntentInterface"],
+    configs = intent_binary_configs(intent_info_plist_substitutions),
+
+    # "-e _NSExtensionMain" tell linker this binary is app extension, so it won't fail due to
+    # missing _main "-Xlinker -rpath -Xlinker @executable_path/../../Frameworks" tells the
+    # executable binary to look for frameworks in ExampleApp.app/Frameworks instead of PlugIns, so
+    # that we don't need to have the libSwift*.dylib in ExampleApp.app/PlugIns/*.appex/Frameworks
+    linker_flags = [
+        "-e",
+        "_NSExtensionMain",
+        "-Xlinker",
+        "-rpath",
+        "-Xlinker",
+        "@executable_path/../../Frameworks",
+    ],
+    deps = [
+        "//App/Resources:IntentsDefinition",
+        "//App/Resources:IntentsStringResources",
+    ],
+    frameworks = [
+        "$SDKROOT/System/Library/Frameworks/Intents.framework",
+    ],
+)
+
+apple_bundle(
+    name = intent_bundle_name,
+    binary = ":" + intent_binary_name,
+    extension = "appex",
+    info_plist = "SiriShortcut/ExampleIntent/Info.plist",
+    info_plist_substitutions = intent_info_plist_substitutions,
+    xcode_product_type = "com.apple.product-type.app-extension",
+)
+
+# The UI code for displaying the response to `BuckPhotoIntent`.
+intentui_bundle_identifier = bundle_identifier("ExampleApp.IntentUIExtension")
+intentui_binary_name = "ExampleIntentUIBinary"
+intentui_bundle_name = "ExampleIntentUIExtension"
+intentui_resources_name = intentui_bundle_name + "Resources"
+intentui_info_plist_substitutions = {
+    "DEVELOPMENT_LANGUAGE": "en-us",
+    "EXECUTABLE_NAME": intentui_bundle_name,
+    "PRODUCT_BUNDLE_DISPLAY_NAME": intentui_bundle_name,
+    "PRODUCT_BUNDLE_IDENTIFIER": intentui_bundle_identifier,
+    "PRODUCT_NAME": intentui_bundle_name,
+}
+
+apple_binary(
+    name = intentui_binary_name,
+    srcs = glob([
+        "SiriShortcut/ExampleIntentUI/**/*.swift",
+    ]) + [":BuckPhotoIntentInterface"],
+    configs = intent_binary_configs(intentui_info_plist_substitutions),
+
+    # "-e _NSExtensionMain" tell linker this binary is app extension, so it won't fail due to
+    # missing _main "-Xlinker -rpath -Xlinker @executable_path/../../Frameworks" tells the
+    # executable binary to look for frameworks in ExampleApp.app/Frameworks instead of PlugIns, so
+    # that we don't need to have the libSwift*.dylib in ExampleApp.app/PlugIns/*.appex/Frameworks
+    linker_flags = [
+        "-e",
+        "_NSExtensionMain",
+        "-Xlinker",
+        "-rpath",
+        "-Xlinker",
+        "@executable_path/../../Frameworks",
+    ],
+    deps = [
+        "//App/Resources:IntentsDefinition",
+        "//App/Resources:IntentsStringResources",
+    ],
+    frameworks = [
+        "$SDKROOT/System/Library/Frameworks/Intents.framework",
+        "$SDKROOT/System/Library/Frameworks/IntentsUI.framework",
+    ],
+)
+
+apple_resource(
+    name = intentui_resources_name,
+    dirs = [],
+    # WORKAROUND: Buck CLI requires you to explicitly set the "Module Name" of the
+    # `IntentViewController` class to `ExampleIntentUIBinary` in MainInterface.storyboard.
+    files = glob(["SiriShortcut/ExampleIntentUI/**/*.storyboard"])
+)
+
+apple_bundle(
+    name = intentui_bundle_name,
+    binary = ":" + intentui_binary_name,
+    extension = "appex",
+    info_plist = "SiriShortcut/ExampleIntentUI/Info.plist",
+    info_plist_substitutions = intentui_info_plist_substitutions,
+    xcode_product_type = "com.apple.product-type.app-extension",
+    deps = [
+        ":" + intentui_resources_name,
+    ],
+)
+
+### Siri Shortcut End ###
+
 ### Watch App Begin ###
 # Define the watch app in the same BUCK file as the binary into which the watch app will be installed.
 # Xcode is finicky when it comes to how it embeds watch apps into main app bundles.  Watch apps are

App/ExampleApp.entitlements

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>com.apple.developer.siri</key>
+	<true/>
+</dict>
+</plist>

App/Info.plist

@@ -29,6 +29,10 @@
 	<string>1</string>
 	<key>LSRequiresIPhoneOS</key>
 	<true/>
+	<key>NSUserActivityTypes</key>
+	<array>
+		<string>BuckPhotoIntent</string>
+	</array>
 	<key>UILaunchStoryboardName</key>
 	<string>LaunchScreen</string>
 	<key>UIRequiredDeviceCapabilities</key>

App/Resources/BUCK

@@ -1,3 +1,5 @@
+load("//Config:buck_rule_macros.bzl", "intentdefinition_resource")
+
 apple_resource(
     name = "ExampleAppStringResources",
     visibility = ["//App:"],
@@ -7,10 +9,21 @@ apple_resource(
     ]),
 )
 
+apple_resource(
+    name = "IntentsStringResources",
+    visibility = ["//App:"],
+    files = [],
+    variants = glob([
+        "*.lproj/Intents.strings",
+    ]),
+)
+
 apple_resource(
     name = "StoryboardResources",
     visibility = ["//App:"],
     variants = glob([
         "*.lproj/*.storyboard",
     ]),
 )
+
+intentdefinition_resource("IntentsDefinition", "./en.lproj/", "Intents",  "en")

App/Resources/en.lproj/ExampleApp.strings

@@ -1,4 +1,4 @@
-/* 
+/*
   ExampleApp.strings
   ExampleApp
 
@@ -7,3 +7,4 @@
 */
 
 "Hello, world" = "Hello, world";
+"Show me a buck" = "Show me a buck";