// Copyright 2015 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.apple;
import static com.google.devtools.build.lib.packages.Attribute.attr;
import static com.google.devtools.build.lib.syntax.Type.STRING;
import static com.google.devtools.build.lib.syntax.Type.STRING_LIST;
import com.google.devtools.build.lib.analysis.BaseRuleClasses;
import com.google.devtools.build.lib.analysis.RuleDefinition;
import com.google.devtools.build.lib.analysis.RuleDefinitionEnvironment;
import com.google.devtools.build.lib.packages.RuleClass;
/**
* Rule definition for {@code xcode_version} rule.
*/
public class XcodeVersionRule implements RuleDefinition {
static final String VERSION_ATTR_NAME = "version";
static final String ALIASES_ATTR_NAME = "aliases";
static final String DEFAULT_IOS_SDK_VERSION_ATTR_NAME = "default_ios_sdk_version";
static final String DEFAULT_WATCHOS_SDK_VERSION_ATTR_NAME = "default_watchos_sdk_version";
static final String DEFAULT_TVOS_SDK_VERSION_ATTR_NAME = "default_tvos_sdk_version";
static final String DEFAULT_MACOS_SDK_VERSION_ATTR_NAME = "default_macos_sdk_version";
@Override
public RuleClass build(RuleClass.Builder builder, RuleDefinitionEnvironment env) {
return builder
.requiresConfigurationFragments(AppleConfiguration.class)
.exemptFromConstraintChecking(
"this rule refines configuration variables and does not build actual content")
/*
The official version number of a version of Xcode.
*/
.add(attr(VERSION_ATTR_NAME, STRING)
.mandatory()
.nonconfigurable("this rule determines configuration"))
/*
Accepted aliases for this version of Xcode.
If the value of the xcode_version
build flag matches any of the given
alias strings, this xcode version will be used.
*/
.add(attr(ALIASES_ATTR_NAME, STRING_LIST)
.nonconfigurable("this rule determines configuration"))
/*
The ios sdk version that is used by default when this version of xcode is being used.
The ios_sdk_version
build flag will override the value specified here.
*/
.add(attr(DEFAULT_IOS_SDK_VERSION_ATTR_NAME, STRING)
.nonconfigurable("this rule determines configuration"))
/*
The watchos sdk version that is used by default when this version of xcode is being used.
The watchos_sdk_version
build flag will override the value specified here.
*/
.add(attr(DEFAULT_WATCHOS_SDK_VERSION_ATTR_NAME, STRING)
.nonconfigurable("this rule determines configuration"))
/*
The tvos sdk version that is used by default when this version of xcode is being used.
The tvos_sdk_version
build flag will override the value specified here.
*/
.add(attr(DEFAULT_TVOS_SDK_VERSION_ATTR_NAME, STRING)
.nonconfigurable("this rule determines configuration"))
/*
The macosx sdk version that is used by default when this version of xcode is being used.
The macos_sdk_version
build flag will override the value specified here.
*/
.add(attr(DEFAULT_MACOS_SDK_VERSION_ATTR_NAME, STRING)
.nonconfigurable("this rule determines configuration"))
.build();
}
@Override
public Metadata getMetadata() {
return RuleDefinition.Metadata.builder()
.name("xcode_version")
.ancestors(BaseRuleClasses.BaseRule.class)
.factoryClass(XcodeVersion.class)
.build();
}
}
/*
Represents a single official xcode version with acceptable aliases for that xcode version.
See the xcode_config
rule.