// 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.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.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:
ios
macos
tvos
watchos
" + "These values can be passed to methods that expect a platform type, like the 'apple' " + "configuration fragment's " + "multi_arch_platform method.
" + "Example:
" + "
\n" + "ctx.fragments.apple.multi_arch_platform(apple_common.platform_type.ios)\n" + "", 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:
ios_device
ios_simulator
macos
tvos_device
tvos_simulator
watchos_device
watchos_device
"
+ "These values can be passed to methods that expect a platform, like "
+ "apple.sdk_version_for_platform.",
structField = true
)
public Info getPlatformStruct() {
if (platform == null) {
platform = ApplePlatform.getSkylarkStruct();
}
return platform;
}
@SkylarkCallable(
name = XcodeVersionProperties.SKYLARK_NAME,
doc =
"The constructor/key for the XcodeVersionProperties
provider.
"
+ "If a target propagates the XcodeVersionProperties
provider,"
+ " use this as the key with which to retrieve it. Example:
"
+ "
\n" + "dep = ctx.attr.deps[0]\n" + "p = dep[apple_common.XcodeVersionProperties]\n" + "", structField = true ) public Provider getXcodeVersionPropertiesConstructor() { return XcodeVersionProperties.SKYLARK_CONSTRUCTOR; } @SkylarkCallable( name = XcodeConfigProvider.SKYLARK_NAME, doc = "The constructor/key for the
XcodeVersionConfig
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 Objc
provider."
+ "If a target propagates the Objc
provider, use this as the "
+ "key with which to retrieve it. Example:
"
+ "
\n" + "dep = ctx.attr.deps[0]\n" + "p = dep[apple_common.Objc]\n" + "", structField = true ) public Provider getObjcProviderConstructor() { return ObjcProvider.SKYLARK_CONSTRUCTOR; } @SkylarkCallable( name = AppleDynamicFrameworkInfo.SKYLARK_NAME, doc = "The constructor/key for the
AppleDynamicFramework
provider."
+ "If a target propagates the AppleDynamicFramework
provider, use this "
+ "as the key with which to retrieve it. Example:
"
+ "
\n" + "dep = ctx.attr.deps[0]\n" + "p = dep[apple_common.AppleDynamicFramework]\n" + "", structField = true ) public Provider getAppleDynamicFrameworkConstructor() { return AppleDynamicFrameworkInfo.SKYLARK_CONSTRUCTOR; } @SkylarkCallable( name = AppleDylibBinaryInfo.SKYLARK_NAME, doc = "The constructor/key for the
AppleDylibBinary
provider."
+ "If a target propagates the AppleDylibBinary
provider, use this as the "
+ "key with which to retrieve it. Example:
"
+ "
\n" + "dep = ctx.attr.deps[0]\n" + "p = dep[apple_common.AppleDylibBinary]\n" + "", structField = true ) public Provider getAppleDylibBinaryConstructor() { return AppleDylibBinaryInfo.SKYLARK_CONSTRUCTOR; } @SkylarkCallable( name = AppleExecutableBinaryInfo.SKYLARK_NAME, doc = "The constructor/key for the
AppleExecutableBinary
provider."
+ "If a target propagates the AppleExecutableBinary
provider,"
+ " use this as the key with which to retrieve it. Example:
"
+ "
\n" + "dep = ctx.attr.deps[0]\n" + "p = dep[apple_common.AppleExecutableBinary]\n" + "", structField = true ) public Provider getAppleExecutableBinaryConstructor() { return AppleExecutableBinaryInfo.SKYLARK_CONSTRUCTOR; } @SkylarkCallable( name = AppleStaticLibraryInfo.SKYLARK_NAME, doc = "The constructor/key for the
AppleStaticLibrary
provider."
+ "If a target propagates the AppleStaticLibrary
provider, use "
+ "this as the key with which to retrieve it. Example:
"
+ "
\n" + "dep = ctx.attr.deps[0]\n" + "p = dep[apple_common.AppleStaticLibrary]\n" + "", structField = true ) public Provider getAppleStaticLibraryProvider() { return AppleStaticLibraryInfo.SKYLARK_CONSTRUCTOR; } @SkylarkCallable( name = AppleDebugOutputsInfo.SKYLARK_NAME, doc = "The constructor/key for the
AppleDebugOutputs
provider."
+ "If a target propagates the AppleDebugOutputs
provider, use this as the "
+ "key with which to retrieve it. Example:
"
+ "
\n" + "dep = ctx.attr.deps[0]\n" + "p = dep[apple_common.AppleDebugOutputs]\n" + "", structField = true ) public Provider getAppleDebugOutputsConstructor() { return AppleDebugOutputsInfo.SKYLARK_CONSTRUCTOR; } @SkylarkCallable( name = AppleLoadableBundleBinaryInfo.SKYLARK_NAME, doc = "The constructor/key for the
AppleLoadableBundleBinary
provider."
+ "If a target propagates the AppleLoadableBundleBinary
provider, "
+ "use this as the key with which to retrieve it. Example:
"
+ "
\n" + "dep = ctx.attr.deps[0]\n" + "p = dep[apple_common.AppleLoadableBundleBinary]\n" + "", structField = true ) public Provider getAppleLoadableBundleBinaryConstructor() { return AppleLoadableBundleBinaryInfo.SKYLARK_CONSTRUCTOR; } @SkylarkCallable( name = IosDeviceProvider.SKYLARK_NAME, doc = "Deprecated. Use the new Skylark testing rules instead. 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 dict 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
dict
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 ImmutableMapUse of this transition requires that the 'platform_type' and 'minimum_os_version'" + " string attributes are defined and mandatory on the rule.
" + "The value of the platform_type attribute will dictate the target architectures " + " for which dependencies along this configuration transition will be built.
" + "Options are:
" + "ios
: architectures gathered from --ios_multi_cpus
.macos
: architectures gathered from --macos_cpus
.tvos
: architectures gathered from --tvos_cpus
.watchos
: architectures gathered from --watchos_cpus
."
+ "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."
)
)
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 This API is highly experimental 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 exception) {
throw new EvalException(null, exception);
}
}
@SkylarkCallable(
name = "dotted_version",
doc = "Creates a new DottedVersion 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);
}
}
apple_binary
rule, and is "
+ "exposed as an API to iterate on migration of apple_binary
to skylark.\n"
+ "