| // Copyright 2016 The Bazel Authors. All rights reserved. |
| // |
| // Licensed under the Apache License, Version 2.0 (the "License"); |
| // you may not use this file except in compliance with the License. |
| // You may obtain a copy of the License at |
| // |
| // http://www.apache.org/licenses/LICENSE-2.0 |
| // |
| // Unless required by applicable law or agreed to in writing, software |
| // distributed under the License is distributed on an "AS IS" BASIS, |
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| // See the License for the specific language governing permissions and |
| // limitations under the License. |
| |
| package com.google.devtools.build.lib.rules.objc; |
| |
| import com.google.common.annotations.VisibleForTesting; |
| import com.google.common.collect.ImmutableMap; |
| import com.google.common.collect.Iterables; |
| import com.google.devtools.build.lib.actions.Artifact; |
| import com.google.devtools.build.lib.actions.MutableActionGraph.ActionConflictException; |
| import com.google.devtools.build.lib.analysis.RuleContext; |
| import com.google.devtools.build.lib.analysis.skylark.SkylarkRuleContext; |
| import com.google.devtools.build.lib.collect.nestedset.NestedSet; |
| import com.google.devtools.build.lib.collect.nestedset.NestedSetBuilder; |
| import com.google.devtools.build.lib.collect.nestedset.Order; |
| import com.google.devtools.build.lib.packages.Attribute.SplitTransitionProvider; |
| import com.google.devtools.build.lib.packages.Info; |
| import com.google.devtools.build.lib.packages.NativeInfo; |
| import com.google.devtools.build.lib.packages.Provider; |
| import com.google.devtools.build.lib.packages.RuleClass.ConfiguredTargetFactory.RuleErrorException; |
| import com.google.devtools.build.lib.packages.SkylarkAspect; |
| import com.google.devtools.build.lib.rules.apple.AppleConfiguration; |
| import com.google.devtools.build.lib.rules.apple.ApplePlatform; |
| import com.google.devtools.build.lib.rules.apple.ApplePlatform.PlatformType; |
| import com.google.devtools.build.lib.rules.apple.AppleToolchain; |
| import com.google.devtools.build.lib.rules.apple.DottedVersion; |
| import com.google.devtools.build.lib.rules.apple.XcodeConfigProvider; |
| import com.google.devtools.build.lib.rules.apple.XcodeVersionProperties; |
| import com.google.devtools.build.lib.rules.objc.AppleBinary.AppleBinaryOutput; |
| import com.google.devtools.build.lib.rules.objc.ObjcProvider.Key; |
| import com.google.devtools.build.lib.skylarkinterface.Param; |
| import com.google.devtools.build.lib.skylarkinterface.SkylarkCallable; |
| import com.google.devtools.build.lib.skylarkinterface.SkylarkModule; |
| import com.google.devtools.build.lib.skylarkinterface.SkylarkSignature; |
| import com.google.devtools.build.lib.syntax.BuiltinFunction; |
| import com.google.devtools.build.lib.syntax.Environment; |
| import com.google.devtools.build.lib.syntax.EvalException; |
| import com.google.devtools.build.lib.syntax.Runtime; |
| import com.google.devtools.build.lib.syntax.SkylarkDict; |
| import com.google.devtools.build.lib.syntax.SkylarkNestedSet; |
| import com.google.devtools.build.lib.syntax.SkylarkSignatureProcessor; |
| import com.google.devtools.build.lib.vfs.PathFragment; |
| import java.util.Map.Entry; |
| import javax.annotation.Nullable; |
| |
| /** |
| * A class that exposes apple rule implementation internals to skylark. |
| */ |
| @SkylarkModule( |
| name = "apple_common", |
| doc = "Functions for skylark to access internals of the apple rule implementations." |
| ) |
| public class AppleSkylarkCommon { |
| |
| @VisibleForTesting |
| public static final String BAD_KEY_ERROR = "Argument %s not a recognized key, 'providers'," |
| + " or 'direct_dep_providers'."; |
| |
| @VisibleForTesting |
| public static final String BAD_SET_TYPE_ERROR = |
| "Value for key %s must be a set of %s, instead found set of %s."; |
| |
| @VisibleForTesting |
| public static final String BAD_PROVIDERS_ITER_ERROR = |
| "Value for argument 'providers' must be a list of ObjcProvider instances, instead found %s."; |
| |
| @VisibleForTesting |
| public static final String BAD_PROVIDERS_ELEM_ERROR = |
| "Value for argument 'providers' must be a list of ObjcProvider instances, instead found " |
| + "iterable with %s."; |
| |
| @VisibleForTesting |
| public static final String NOT_SET_ERROR = "Value for key %s must be a set, instead found %s."; |
| |
| @VisibleForTesting |
| public static final String MISSING_KEY_ERROR = "No value for required key %s was present."; |
| |
| @Nullable private Info platformType; |
| @Nullable private Info platform; |
| |
| private ObjcProtoAspect objcProtoAspect; |
| |
| public AppleSkylarkCommon(ObjcProtoAspect objcProtoAspect) { |
| this.objcProtoAspect = objcProtoAspect; |
| } |
| |
| @SkylarkCallable( |
| name = "apple_toolchain", |
| doc = "Utilities for resolving items from the apple toolchain." |
| ) |
| public AppleToolchain getAppleToolchain() { |
| return new AppleToolchain(); |
| } |
| |
| @SkylarkCallable( |
| name = "platform_type", |
| doc = |
| "An enum-like struct that contains the following fields corresponding to Apple platform " |
| + "types:<br><ul>" |
| + "<li><code>ios</code></li>" |
| + "<li><code>macos</code></li>" |
| + "<li><code>tvos</code></li>" |
| + "<li><code>watchos</code></li>" |
| + "</ul><p>" |
| + "These values can be passed to methods that expect a platform type, like the 'apple' " |
| + "configuration fragment's " |
| + "<a href='apple.html#multi_arch_platform'>multi_arch_platform</a> method.<p>" |
| + "Example:<p>" |
| + "<pre class='language-python'>\n" |
| + "ctx.fragments.apple.multi_arch_platform(apple_common.platform_type.ios)\n" |
| + "</pre>", |
| structField = true |
| ) |
| public Info getPlatformTypeStruct() { |
| if (platformType == null) { |
| platformType = PlatformType.getSkylarkStruct(); |
| } |
| return platformType; |
| } |
| |
| @SkylarkCallable( |
| name = "platform", |
| doc = |
| "An enum-like struct that contains the following fields corresponding to Apple " |
| + "platforms:<br><ul>" |
| + "<li><code>ios_device</code></li>" |
| + "<li><code>ios_simulator</code></li>" |
| + "<li><code>macos</code></li>" |
| + "<li><code>tvos_device</code></li>" |
| + "<li><code>tvos_simulator</code></li>" |
| + "<li><code>watchos_device</code></li>" |
| + "<li><code>watchos_device</code></li>" |
| + "</ul><p>" |
| + "These values can be passed to methods that expect a platform, like " |
| + "<a href='apple.html#sdk_version_for_platform'>apple.sdk_version_for_platform</a>.", |
| structField = true |
| ) |
| public Info getPlatformStruct() { |
| if (platform == null) { |
| platform = ApplePlatform.getSkylarkStruct(); |
| } |
| return platform; |
| } |
| |
| @SkylarkCallable( |
| name = XcodeVersionProperties.SKYLARK_NAME, |
| doc = |
| "The constructor/key for the <code>XcodeVersionProperties</code> provider.<p>" |
| + "If a target propagates the <code>XcodeVersionProperties</code> provider," |
| + " use this as the key with which to retrieve it. Example:<br>" |
| + "<pre class='language-python'>\n" |
| + "dep = ctx.attr.deps[0]\n" |
| + "p = dep[apple_common.XcodeVersionProperties]\n" |
| + "</pre>", |
| structField = true |
| ) |
| public Provider getXcodeVersionPropertiesConstructor() { |
| return XcodeVersionProperties.SKYLARK_CONSTRUCTOR; |
| } |
| |
| @SkylarkCallable( |
| name = XcodeConfigProvider.SKYLARK_NAME, |
| doc = "The constructor/key for the <code>XcodeVersionConfig</code> provider.", |
| structField = true |
| ) |
| public Provider getXcodeVersionConfigConstructor() { |
| return XcodeConfigProvider.PROVIDER; |
| } |
| |
| @SkylarkCallable( |
| // TODO(b/63899207): This currently does not match ObjcProvider.SKYLARK_NAME as it requires |
| // a migration of existing skylark rules. |
| name = "Objc", |
| doc = |
| "The constructor/key for the <code>Objc</code> provider.<p>" |
| + "If a target propagates the <code>Objc</code> provider, use this as the " |
| + "key with which to retrieve it. Example:<br>" |
| + "<pre class='language-python'>\n" |
| + "dep = ctx.attr.deps[0]\n" |
| + "p = dep[apple_common.Objc]\n" |
| + "</pre>", |
| structField = true |
| ) |
| public Provider getObjcProviderConstructor() { |
| return ObjcProvider.SKYLARK_CONSTRUCTOR; |
| } |
| |
| @SkylarkCallable( |
| name = AppleDynamicFrameworkInfo.SKYLARK_NAME, |
| doc = |
| "The constructor/key for the <code>AppleDynamicFramework</code> provider.<p>" |
| + "If a target propagates the <code>AppleDynamicFramework</code> provider, use this " |
| + "as the key with which to retrieve it. Example:<br>" |
| + "<pre class='language-python'>\n" |
| + "dep = ctx.attr.deps[0]\n" |
| + "p = dep[apple_common.AppleDynamicFramework]\n" |
| + "</pre>", |
| structField = true |
| ) |
| public Provider getAppleDynamicFrameworkConstructor() { |
| return AppleDynamicFrameworkInfo.SKYLARK_CONSTRUCTOR; |
| } |
| |
| @SkylarkCallable( |
| name = AppleDylibBinaryInfo.SKYLARK_NAME, |
| doc = |
| "The constructor/key for the <code>AppleDylibBinary</code> provider.<p>" |
| + "If a target propagates the <code>AppleDylibBinary</code> provider, use this as the " |
| + "key with which to retrieve it. Example:<br>" |
| + "<pre class='language-python'>\n" |
| + "dep = ctx.attr.deps[0]\n" |
| + "p = dep[apple_common.AppleDylibBinary]\n" |
| + "</pre>", |
| structField = true |
| ) |
| public Provider getAppleDylibBinaryConstructor() { |
| return AppleDylibBinaryInfo.SKYLARK_CONSTRUCTOR; |
| } |
| |
| @SkylarkCallable( |
| name = AppleExecutableBinaryInfo.SKYLARK_NAME, |
| doc = |
| "The constructor/key for the <code>AppleExecutableBinary</code> provider.<p>" |
| + "If a target propagates the <code>AppleExecutableBinary</code> provider," |
| + " use this as the key with which to retrieve it. Example:<br>" |
| + "<pre class='language-python'>\n" |
| + "dep = ctx.attr.deps[0]\n" |
| + "p = dep[apple_common.AppleExecutableBinary]\n" |
| + "</pre>", |
| structField = true |
| ) |
| public Provider getAppleExecutableBinaryConstructor() { |
| return AppleExecutableBinaryInfo.SKYLARK_CONSTRUCTOR; |
| } |
| |
| @SkylarkCallable( |
| name = AppleStaticLibraryInfo.SKYLARK_NAME, |
| doc = |
| "The constructor/key for the <code>AppleStaticLibrary</code> provider.<p>" |
| + "If a target propagates the <code>AppleStaticLibrary</code> provider, use " |
| + "this as the key with which to retrieve it. Example:<br>" |
| + "<pre class='language-python'>\n" |
| + "dep = ctx.attr.deps[0]\n" |
| + "p = dep[apple_common.AppleStaticLibrary]\n" |
| + "</pre>", |
| structField = true |
| ) |
| public Provider getAppleStaticLibraryProvider() { |
| return AppleStaticLibraryInfo.SKYLARK_CONSTRUCTOR; |
| } |
| |
| @SkylarkCallable( |
| name = AppleDebugOutputsInfo.SKYLARK_NAME, |
| doc = |
| "The constructor/key for the <code>AppleDebugOutputs</code> provider.<p>" |
| + "If a target propagates the <code>AppleDebugOutputs</code> provider, use this as the " |
| + "key with which to retrieve it. Example:<br>" |
| + "<pre class='language-python'>\n" |
| + "dep = ctx.attr.deps[0]\n" |
| + "p = dep[apple_common.AppleDebugOutputs]\n" |
| + "</pre>", |
| structField = true |
| ) |
| public Provider getAppleDebugOutputsConstructor() { |
| return AppleDebugOutputsInfo.SKYLARK_CONSTRUCTOR; |
| } |
| |
| @SkylarkCallable( |
| name = AppleLoadableBundleBinaryInfo.SKYLARK_NAME, |
| doc = |
| "The constructor/key for the <code>AppleLoadableBundleBinary</code> provider.<p>" |
| + "If a target propagates the <code>AppleLoadableBundleBinary</code> provider, " |
| + "use this as the key with which to retrieve it. Example:<br>" |
| + "<pre class='language-python'>\n" |
| + "dep = ctx.attr.deps[0]\n" |
| + "p = dep[apple_common.AppleLoadableBundleBinary]\n" |
| + "</pre>", |
| structField = true |
| ) |
| public Provider getAppleLoadableBundleBinaryConstructor() { |
| return AppleLoadableBundleBinaryInfo.SKYLARK_CONSTRUCTOR; |
| } |
| |
| @SkylarkCallable( |
| name = IosDeviceProvider.SKYLARK_NAME, |
| doc = |
| "<b>Deprecated. Use the new Skylark testing rules instead.</b> Returns the provider " |
| + "constructor for IosDeviceProvider. Use this as a key to access the attributes " |
| + "exposed by ios_device.", |
| structField = true |
| ) |
| public Provider getIosDeviceProviderConstructor() { |
| return IosDeviceProvider.SKYLARK_CONSTRUCTOR; |
| } |
| |
| @SkylarkCallable( |
| name = "apple_host_system_env", |
| doc = |
| "Returns a <a href='dict.html'>dict</a> of environment variables that should be set " |
| + "for actions that need to run build tools on an Apple host system, such as the " |
| + " version of Xcode that should be used. The keys are variable names and the values " |
| + " are their corresponding values." |
| ) |
| public ImmutableMap<String, String> getAppleHostSystemEnv(XcodeConfigProvider xcodeConfig) { |
| return AppleConfiguration.getXcodeVersionEnv(xcodeConfig.getXcodeVersion()); |
| } |
| |
| @SkylarkCallable( |
| name = "target_apple_env", |
| doc = |
| "Returns a <code>dict</code> of environment variables that should be set for actions " |
| + "that build targets of the given Apple platform type. For example, this dictionary " |
| + "contains variables that denote the platform name and SDK version with which to " |
| + "build. The keys are variable names and the values are their corresponding values." |
| ) |
| public ImmutableMap<String, String> getTargetAppleEnvironment( |
| XcodeConfigProvider xcodeConfig, ApplePlatform platform) { |
| return AppleConfiguration.appleTargetPlatformEnv( |
| platform, xcodeConfig.getSdkVersionForPlatform(platform)); |
| } |
| |
| @SkylarkCallable( |
| name = "multi_arch_split", |
| doc = "A configuration transition for rule attributes to build dependencies in one or" |
| + " more Apple platforms. " |
| + "<p>Use of this transition requires that the 'platform_type' and 'minimum_os_version'" |
| + " string attributes are defined and mandatory on the rule.</p>" |
| + "<p>The value of the platform_type attribute will dictate the target architectures " |
| + " for which dependencies along this configuration transition will be built.</p>" |
| + "<p>Options are:</p>" |
| + "<ul>" |
| + "<li><code>ios</code>: architectures gathered from <code>--ios_multi_cpus</code>.</li>" |
| + "<li><code>macos</code>: architectures gathered from <code>--macos_cpus</code>.</li>" |
| + "<li><code>tvos</code>: architectures gathered from <code>--tvos_cpus</code>.</li>" |
| + "<li><code>watchos</code>: architectures gathered from <code>--watchos_cpus</code>." |
| + "</li></ul>" |
| + "<p>minimum_os_version should be a dotted version string such as '7.3', and is used to" |
| + " set the minimum operating system on the configuration similarly based on platform" |
| + " type. For example, specifying platform_type 'ios' and minimum_os_version '8.0' will" |
| + " ensure that dependencies are built with minimum iOS version '8.0'.", |
| structField = true |
| ) |
| public SplitTransitionProvider getMultiArchSplitProvider() { |
| return new MultiArchSplitTransitionProvider(); |
| } |
| |
| @SkylarkSignature( |
| name = "new_objc_provider", |
| objectType = AppleSkylarkCommon.class, |
| returnType = ObjcProvider.class, |
| doc = "Creates a new ObjcProvider instance.", |
| parameters = { |
| @Param(name = "self", type = AppleSkylarkCommon.class, doc = "The apple_common instance."), |
| @Param( |
| name = "uses_swift", |
| type = Boolean.class, |
| defaultValue = "False", |
| named = true, |
| positional = false, |
| doc = "Whether this provider should enable Swift support." |
| ) |
| }, |
| extraKeywords = |
| @Param( |
| name = "kwargs", |
| type = SkylarkDict.class, |
| defaultValue = "{}", |
| doc = "Dictionary of arguments." |
| ), |
| useEnvironment = true |
| ) |
| public static final BuiltinFunction NEW_OBJC_PROVIDER = |
| new BuiltinFunction("new_objc_provider") { |
| @SuppressWarnings("unused") |
| // This method is registered statically for skylark, and never called directly. |
| public ObjcProvider invoke( |
| AppleSkylarkCommon self, Boolean usesSwift, SkylarkDict<String, Object> kwargs, |
| Environment environment) { |
| boolean disableObjcResourceKeys = |
| environment.getSemantics().incompatibleDisableObjcProviderResources(); |
| ObjcProvider.Builder resultBuilder = new ObjcProvider.Builder(); |
| if (usesSwift) { |
| resultBuilder.add(ObjcProvider.FLAG, ObjcProvider.Flag.USES_SWIFT); |
| } |
| for (Entry<String, Object> entry : kwargs.entrySet()) { |
| Key<?> key = ObjcProvider.getSkylarkKeyForString(entry.getKey()); |
| if (key != null) { |
| if (disableObjcResourceKeys && ObjcProvider.isDeprecatedResourceKey(key)) { |
| throw new IllegalArgumentException(String.format(BAD_KEY_ERROR, entry.getKey())); |
| } |
| resultBuilder.addElementsFromSkylark(key, entry.getValue()); |
| } else if (entry.getKey().equals("providers")) { |
| resultBuilder.addProvidersFromSkylark(entry.getValue()); |
| } else if (entry.getKey().equals("direct_dep_providers")) { |
| resultBuilder.addDirectDepProvidersFromSkylark(entry.getValue()); |
| } else { |
| throw new IllegalArgumentException(String.format(BAD_KEY_ERROR, entry.getKey())); |
| } |
| } |
| return resultBuilder.build(); |
| } |
| }; |
| |
| @SkylarkCallable( |
| name = "new_dynamic_framework_provider", |
| doc = "Creates a new AppleDynamicFramework provider instance.", |
| parameters = { |
| @Param( |
| name = AppleDynamicFrameworkInfo.DYLIB_BINARY_FIELD_NAME, |
| type = Artifact.class, |
| named = true, |
| positional = false, |
| doc = "The dylib binary artifact of the dynamic framework." |
| ), |
| @Param( |
| name = AppleDynamicFrameworkInfo.OBJC_PROVIDER_FIELD_NAME, |
| type = ObjcProvider.class, |
| named = true, |
| positional = false, |
| doc = |
| "An ObjcProvider which contains information about the transitive " |
| + "dependencies linked into the binary." |
| ), |
| @Param( |
| name = AppleDynamicFrameworkInfo.FRAMEWORK_DIRS_FIELD_NAME, |
| type = SkylarkNestedSet.class, |
| generic1 = String.class, |
| named = true, |
| noneable = true, |
| positional = false, |
| defaultValue = "None", |
| doc = |
| "The framework path names used as link inputs in order to link against the dynamic " |
| + "framework." |
| ), |
| @Param( |
| name = AppleDynamicFrameworkInfo.FRAMEWORK_FILES_FIELD_NAME, |
| type = SkylarkNestedSet.class, |
| generic1 = Artifact.class, |
| named = true, |
| noneable = true, |
| positional = false, |
| defaultValue = "None", |
| doc = |
| "The full set of artifacts that should be included as inputs to link against the " |
| + "dynamic framework" |
| ) |
| } |
| ) |
| public AppleDynamicFrameworkInfo newDynamicFrameworkProvider( |
| Artifact dylibBinary, |
| ObjcProvider depsObjcProvider, |
| Object dynamicFrameworkDirs, |
| Object dynamicFrameworkFiles) { |
| NestedSet<PathFragment> frameworkDirs; |
| if (dynamicFrameworkDirs == Runtime.NONE) { |
| frameworkDirs = NestedSetBuilder.<PathFragment>emptySet(Order.STABLE_ORDER); |
| } else { |
| Iterable<String> pathStrings = |
| ((SkylarkNestedSet) dynamicFrameworkDirs).getSet(String.class); |
| frameworkDirs = |
| NestedSetBuilder.<PathFragment>stableOrder() |
| .addAll(Iterables.transform(pathStrings, PathFragment::create)) |
| .build(); |
| } |
| NestedSet<Artifact> frameworkFiles = |
| dynamicFrameworkFiles != Runtime.NONE |
| ? ((SkylarkNestedSet) dynamicFrameworkFiles).getSet(Artifact.class) |
| : NestedSetBuilder.<Artifact>emptySet(Order.STABLE_ORDER); |
| return new AppleDynamicFrameworkInfo( |
| dylibBinary, depsObjcProvider, frameworkDirs, frameworkFiles); |
| } |
| |
| @SkylarkCallable( |
| name = "link_multi_arch_binary", |
| doc = "Links a (potentially multi-architecture) binary targeting Apple platforms. This " |
| + "method comprises a bulk of the logic of the <code>apple_binary</code> rule, and is " |
| + "exposed as an API to iterate on migration of <code>apple_binary</code> to skylark.\n" |
| + "<p>This API is <b>highly experimental</b> and subject to change at any time. Do not " |
| + "depend on the stability of this function at this time.", |
| mandatoryPositionals = 1 // The SkylarkRuleContext. |
| ) |
| // TODO(b/70937317): Iterate on, improve, and solidify this API. |
| public NativeInfo linkMultiArchBinary(SkylarkRuleContext skylarkRuleContext) |
| throws EvalException, InterruptedException { |
| try { |
| RuleContext ruleContext = skylarkRuleContext.getRuleContext(); |
| AppleBinaryOutput appleBinaryOutput = AppleBinary.linkMultiArchBinary(ruleContext); |
| return appleBinaryOutput.getBinaryInfoProvider(); |
| } catch (RuleErrorException | ActionConflictException exception) { |
| throw new EvalException(null, exception); |
| } |
| } |
| |
| @SkylarkCallable( |
| name = "dotted_version", |
| doc = "Creates a new <a href=\"DottedVersion.html\">DottedVersion</a> instance.", |
| parameters = { |
| @Param( |
| name = "version", |
| type = String.class, |
| doc = "The string representation of the DottedVersion." |
| ) |
| } |
| ) |
| public DottedVersion dottedVersion(String version) { |
| return DottedVersion.fromString(version); |
| } |
| |
| @SkylarkCallable( |
| name = "objc_proto_aspect", |
| doc = |
| "objc_proto_aspect gathers the proto dependencies of the attached rule target," |
| + "and propagates the proto values of its dependencies through the ObjcProto provider.", |
| structField = true |
| ) |
| public SkylarkAspect getObjcProtoAspect() { |
| return objcProtoAspect; |
| } |
| |
| static { |
| SkylarkSignatureProcessor.configureSkylarkFunctions(AppleSkylarkCommon.class); |
| } |
| } |