iosmacostvoswatchos" + "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_deviceios_simulatormacostvos_devicetvos_simulatorwatchos_devicewatchos_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 AppleStaticLibraryInfo.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 = "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 ImmutableMapdict 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();
}
@SkylarkCallable(
name = "new_objc_provider",
doc = "Creates a new ObjcProvider instance.",
parameters = {
@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
)
// This method is registered statically for skylark, and never called directly.
public ObjcProvider newObjcProvider(
Boolean usesSwift,
SkylarkDict kwargs,
Environment environment) {
boolean disableObjcResourceKeys =
environment.getSemantics().incompatibleDisableObjcProviderResources();
ObjcProvider.Builder resultBuilder = new ObjcProvider.Builder(environment.getSemantics());
if (usesSwift) {
resultBuilder.add(ObjcProvider.FLAG, ObjcProvider.Flag.USES_SWIFT);
}
for (Map.Entry entry : kwargs.entrySet()) {
Key key = ObjcProvider.getSkylarkKeyForString((String) 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 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 | ActionConflictException 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"
+ "