// Copyright 2014 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; import static com.google.devtools.build.lib.syntax.SkylarkType.castList; import com.google.common.collect.Iterables; import com.google.devtools.build.lib.cmdline.Label; import com.google.devtools.build.lib.packages.Attribute; import com.google.devtools.build.lib.packages.Attribute.AllowedValueSet; import com.google.devtools.build.lib.packages.Attribute.ConfigurationTransition; import com.google.devtools.build.lib.packages.Attribute.SkylarkLateBound; import com.google.devtools.build.lib.packages.BuildType; 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.EvalUtils; import com.google.devtools.build.lib.syntax.FuncallExpression; import com.google.devtools.build.lib.syntax.Runtime; import com.google.devtools.build.lib.syntax.SkylarkCallbackFunction; import com.google.devtools.build.lib.syntax.SkylarkList; import com.google.devtools.build.lib.syntax.SkylarkModule; import com.google.devtools.build.lib.syntax.SkylarkSignature; import com.google.devtools.build.lib.syntax.SkylarkSignature.Param; import com.google.devtools.build.lib.syntax.SkylarkSignatureProcessor; import com.google.devtools.build.lib.syntax.Type; import com.google.devtools.build.lib.syntax.Type.ConversionException; import com.google.devtools.build.lib.syntax.UserDefinedFunction; import com.google.devtools.build.lib.util.FileTypeSet; import java.util.Map; /** * A helper class to provide Attr module in Skylark. * *

It exposes functions (e.g. 'attr.string', 'attr.label_list', etc.) to Skylark * users. The functions are executed through reflection. As everywhere in Skylark, * arguments are type-checked with the signature and cannot be null. */ @SkylarkModule( name = "attr", namespace = true, doc = "Module for creating new attributes. " + "They are only for use with the rule function." ) public final class SkylarkAttr { // Arguments private static final String ALLOW_FILES_ARG = "allow_files"; private static final String ALLOW_FILES_DOC = "whether File targets are allowed. Can be True, False (default), or " + "a FileType filter."; private static final String ALLOW_RULES_ARG = "allow_rules"; private static final String ALLOW_RULES_DOC = "which rule targets (name of the classes) are allowed. This is deprecated (kept only for " + "compatiblity), use providers instead."; private static final String CONFIGURATION_ARG = "cfg"; private static final String CONFIGURATION_DOC = "configuration of the attribute. " + "For example, use DATA_CFG or HOST_CFG."; private static final String DEFAULT_ARG = "default"; private static final String DEFAULT_DOC = "the default value of the attribute."; private static final String EXECUTABLE_ARG = "executable"; private static final String EXECUTABLE_DOC = "True if the labels have to be executable. This means the label must refer to an " + "executable file, or to a rule that outputs an executable file. Access the labels " + "with ctx.executable.<attribute_name>."; private static final String FLAGS_ARG = "flags"; private static final String FLAGS_DOC = "deprecated, will be removed"; private static final String MANDATORY_ARG = "mandatory"; private static final String MANDATORY_DOC = "True if the value must be explicitly specified"; private static final String NON_EMPTY_ARG = "non_empty"; private static final String NON_EMPTY_DOC = "True if the attribute must not be empty"; private static final String PROVIDERS_ARG = "providers"; private static final String SINGLE_FILE_ARG = "single_file"; private static final String VALUES_ARG = "values"; private static final String VALUES_DOC = "the list of allowed values for the attribute. An error is raised if any other " + "value is given."; private static boolean containsNonNoneKey(Map arguments, String key) { return arguments.containsKey(key) && arguments.get(key) != Runtime.NONE; } private static Attribute.Builder createAttribute( Type type, Map arguments, FuncallExpression ast, Environment env) throws EvalException, ConversionException { // We use an empty name now so that we can set it later. // This trick makes sense only in the context of Skylark (builtin rules should not use it). Attribute.Builder builder = Attribute.attr("", type); Object defaultValue = arguments.get(DEFAULT_ARG); if (!EvalUtils.isNullOrNone(defaultValue)) { if (defaultValue instanceof UserDefinedFunction) { // Late bound attribute. Non label type attributes already caused a type check error. builder.value( new SkylarkLateBound( new SkylarkCallbackFunction((UserDefinedFunction) defaultValue, ast, env))); } else { builder.defaultValue(defaultValue); } } for (String flag : castList(arguments.get(FLAGS_ARG), String.class)) { builder.setPropertyFlag(flag); } if (containsNonNoneKey(arguments, MANDATORY_ARG) && (Boolean) arguments.get(MANDATORY_ARG)) { builder.setPropertyFlag("MANDATORY"); } if (containsNonNoneKey(arguments, NON_EMPTY_ARG) && (Boolean) arguments.get(NON_EMPTY_ARG)) { builder.setPropertyFlag("NON_EMPTY"); } if (containsNonNoneKey(arguments, EXECUTABLE_ARG) && (Boolean) arguments.get(EXECUTABLE_ARG)) { builder.setPropertyFlag("EXECUTABLE"); } if (containsNonNoneKey(arguments, SINGLE_FILE_ARG) && (Boolean) arguments.get(SINGLE_FILE_ARG)) { builder.setPropertyFlag("SINGLE_ARTIFACT"); } if (containsNonNoneKey(arguments, ALLOW_FILES_ARG)) { Object fileTypesObj = arguments.get(ALLOW_FILES_ARG); if (fileTypesObj == Boolean.TRUE) { builder.allowedFileTypes(FileTypeSet.ANY_FILE); } else if (fileTypesObj == Boolean.FALSE) { builder.allowedFileTypes(FileTypeSet.NO_FILE); } else if (fileTypesObj instanceof SkylarkFileType) { builder.allowedFileTypes(((SkylarkFileType) fileTypesObj).getFileTypeSet()); } else { throw new EvalException( ast.getLocation(), "allow_files should be a boolean or a filetype object."); } } else if (type.equals(BuildType.LABEL) || type.equals(BuildType.LABEL_LIST)) { builder.allowedFileTypes(FileTypeSet.NO_FILE); } Object ruleClassesObj = arguments.get(ALLOW_RULES_ARG); if (ruleClassesObj != null && ruleClassesObj != Runtime.NONE) { builder.allowedRuleClasses( castList(ruleClassesObj, String.class, "allowed rule classes for attribute definition")); } Iterable values = castList(arguments.get(VALUES_ARG), Object.class); if (!Iterables.isEmpty(values)) { builder.allowedValues(new AllowedValueSet(values)); } if (containsNonNoneKey(arguments, PROVIDERS_ARG)) { builder.mandatoryProviders(castList(arguments.get(PROVIDERS_ARG), String.class)); } if (containsNonNoneKey(arguments, CONFIGURATION_ARG)) { builder.cfg((ConfigurationTransition) arguments.get(CONFIGURATION_ARG)); } return builder; } private static Attribute.Builder createAttribute( Map kwargs, Type type, FuncallExpression ast, Environment env) throws EvalException { try { return createAttribute(type, kwargs, ast, env); } catch (ConversionException e) { throw new EvalException(ast.getLocation(), e.getMessage()); } } @SkylarkSignature( name = "int", doc = "Creates an attribute of type int.", objectType = SkylarkAttr.class, returnType = Attribute.Builder.class, optionalNamedOnly = { @Param( name = DEFAULT_ARG, type = Integer.class, defaultValue = "0", doc = DEFAULT_DOC + " If not specified, default is 0." ), @Param(name = MANDATORY_ARG, type = Boolean.class, defaultValue = "False", doc = MANDATORY_DOC ), @Param( name = VALUES_ARG, type = SkylarkList.class, generic1 = Integer.class, defaultValue = "[]", doc = VALUES_DOC ) }, useAst = true, useEnvironment = true ) private static BuiltinFunction integer = new BuiltinFunction("int") { public Attribute.Builder invoke( Integer defaultInt, Boolean mandatory, SkylarkList values, FuncallExpression ast, Environment env) throws EvalException { // TODO(bazel-team): Replace literal strings with constants. env.checkLoadingPhase("attr.int", ast.getLocation()); return createAttribute( EvalUtils.optionMap( DEFAULT_ARG, defaultInt, MANDATORY_ARG, mandatory, VALUES_ARG, values), Type.INTEGER, ast, env); } }; @SkylarkSignature( name = "string", doc = "Creates an attribute of type string.", objectType = SkylarkAttr.class, returnType = Attribute.Builder.class, optionalNamedOnly = { @Param( name = DEFAULT_ARG, type = String.class, defaultValue = "''", doc = DEFAULT_DOC + " If not specified, default is \"\"." ), @Param(name = MANDATORY_ARG, type = Boolean.class, defaultValue = "False", doc = MANDATORY_DOC ), @Param( name = VALUES_ARG, type = SkylarkList.class, generic1 = String.class, defaultValue = "[]", doc = VALUES_DOC ) }, useAst = true, useEnvironment = true ) private static BuiltinFunction string = new BuiltinFunction("string") { public Attribute.Builder invoke( String defaultString, Boolean mandatory, SkylarkList values, FuncallExpression ast, Environment env) throws EvalException { env.checkLoadingPhase("attr.string", ast.getLocation()); return createAttribute( EvalUtils.optionMap( DEFAULT_ARG, defaultString, MANDATORY_ARG, mandatory, VALUES_ARG, values), Type.STRING, ast, env); } }; @SkylarkSignature( name = "label", doc = "Creates an attribute of type Label. " + "It is the only way to specify a dependency to another target. " + "If you need a dependency that the user cannot overwrite, make the attribute " + "private (starts with _).", objectType = SkylarkAttr.class, returnType = Attribute.Builder.class, optionalNamedOnly = { @Param( name = DEFAULT_ARG, type = Label.class, callbackEnabled = true, noneable = true, defaultValue = "None", doc = DEFAULT_DOC + " If not specified, default is None. " + "Use the Label function to specify a default value." ), @Param( name = EXECUTABLE_ARG, type = Boolean.class, defaultValue = "False", doc = EXECUTABLE_DOC ), @Param(name = ALLOW_FILES_ARG, defaultValue = "False", doc = ALLOW_FILES_DOC), @Param(name = MANDATORY_ARG, type = Boolean.class, defaultValue = "False", doc = MANDATORY_DOC ), @Param( name = PROVIDERS_ARG, type = SkylarkList.class, generic1 = String.class, defaultValue = "[]", doc = "mandatory providers every dependency has to have" ), @Param( name = ALLOW_RULES_ARG, type = SkylarkList.class, generic1 = String.class, noneable = true, defaultValue = "None", doc = ALLOW_RULES_DOC ), @Param( name = SINGLE_FILE_ARG, type = Boolean.class, defaultValue = "False", doc = "if True, the label must correspond to a single File. " + "Access it through ctx.file.<attribute_name>." ), @Param( name = CONFIGURATION_ARG, type = ConfigurationTransition.class, noneable = true, defaultValue = "None", doc = CONFIGURATION_DOC ) }, useAst = true, useEnvironment = true ) private static BuiltinFunction label = new BuiltinFunction("label") { public Attribute.Builder invoke( Object defaultO, Boolean executable, Object allowFiles, Boolean mandatory, SkylarkList providers, Object allowRules, Boolean singleFile, Object cfg, FuncallExpression ast, Environment env) throws EvalException { env.checkLoadingPhase("attr.label", ast.getLocation()); return createAttribute( EvalUtils.optionMap( DEFAULT_ARG, defaultO, EXECUTABLE_ARG, executable, ALLOW_FILES_ARG, allowFiles, MANDATORY_ARG, mandatory, PROVIDERS_ARG, providers, ALLOW_RULES_ARG, allowRules, SINGLE_FILE_ARG, singleFile, CONFIGURATION_ARG, cfg), BuildType.LABEL, ast, env); } }; @SkylarkSignature( name = "string_list", doc = "Creates an attribute of type list of strings", objectType = SkylarkAttr.class, returnType = Attribute.Builder.class, optionalPositionals = { @Param( name = DEFAULT_ARG, type = SkylarkList.class, generic1 = String.class, defaultValue = "[]", doc = DEFAULT_DOC + " If not specified, default is []." ), @Param(name = MANDATORY_ARG, type = Boolean.class, defaultValue = "False", doc = MANDATORY_DOC ), @Param(name = NON_EMPTY_ARG, type = Boolean.class, defaultValue = "False", doc = NON_EMPTY_DOC ) }, useAst = true, useEnvironment = true ) private static BuiltinFunction stringList = new BuiltinFunction("string_list") { public Attribute.Builder invoke( SkylarkList defaultList, Boolean mandatory, Boolean nonEmpty, FuncallExpression ast, Environment env) throws EvalException { env.checkLoadingPhase("attr.string_list", ast.getLocation()); return createAttribute( EvalUtils.optionMap( DEFAULT_ARG, defaultList, MANDATORY_ARG, mandatory, NON_EMPTY_ARG, nonEmpty), Type.STRING_LIST, ast, env); } }; @SkylarkSignature( name = "int_list", doc = "Creates an attribute of type list of ints", objectType = SkylarkAttr.class, returnType = Attribute.Builder.class, optionalPositionals = { @Param( name = DEFAULT_ARG, type = SkylarkList.class, generic1 = Integer.class, defaultValue = "[]", doc = DEFAULT_DOC + " If not specified, default is []." ), @Param(name = MANDATORY_ARG, type = Boolean.class, defaultValue = "False", doc = MANDATORY_DOC ), @Param(name = NON_EMPTY_ARG, type = Boolean.class, defaultValue = "False", doc = NON_EMPTY_DOC ) }, useAst = true, useEnvironment = true ) private static BuiltinFunction intList = new BuiltinFunction("int_list") { public Attribute.Builder invoke( SkylarkList defaultList, Boolean mandatory, Boolean nonEmpty, FuncallExpression ast, Environment env) throws EvalException { env.checkLoadingPhase("attr.int_list", ast.getLocation()); return createAttribute( EvalUtils.optionMap( DEFAULT_ARG, defaultList, MANDATORY_ARG, mandatory, NON_EMPTY_ARG, nonEmpty), Type.INTEGER_LIST, ast, env); } }; @SkylarkSignature( name = "label_list", doc = "Creates an attribute of type list of labels. " + "See label for more information.", objectType = SkylarkAttr.class, returnType = Attribute.Builder.class, optionalNamedOnly = { @Param( name = DEFAULT_ARG, type = SkylarkList.class, generic1 = Label.class, callbackEnabled = true, defaultValue = "[]", doc = DEFAULT_DOC + " If not specified, default is []. " + "Use the Label function to specify a default value." ), @Param( name = ALLOW_FILES_ARG, // bool or FileType filter defaultValue = "False", doc = ALLOW_FILES_DOC ), @Param( name = ALLOW_RULES_ARG, type = SkylarkList.class, generic1 = String.class, noneable = true, defaultValue = "None", doc = ALLOW_RULES_DOC ), @Param( name = PROVIDERS_ARG, type = SkylarkList.class, generic1 = String.class, defaultValue = "[]", doc = "mandatory providers every dependency has to have" ), @Param( name = FLAGS_ARG, type = SkylarkList.class, generic1 = String.class, defaultValue = "[]", doc = FLAGS_DOC ), @Param(name = MANDATORY_ARG, type = Boolean.class, defaultValue = "False", doc = MANDATORY_DOC ), @Param(name = NON_EMPTY_ARG, type = Boolean.class, defaultValue = "False", doc = NON_EMPTY_DOC ), @Param( name = CONFIGURATION_ARG, type = ConfigurationTransition.class, noneable = true, defaultValue = "None", doc = CONFIGURATION_DOC ) }, useAst = true, useEnvironment = true ) private static BuiltinFunction labelList = new BuiltinFunction("label_list") { public Attribute.Builder invoke( Object defaultList, Object allowFiles, Object allowRules, SkylarkList providers, SkylarkList flags, Boolean mandatory, Boolean nonEmpty, Object cfg, FuncallExpression ast, Environment env) throws EvalException { env.checkLoadingPhase("attr.label_list", ast.getLocation()); return createAttribute( EvalUtils.optionMap( DEFAULT_ARG, defaultList, ALLOW_FILES_ARG, allowFiles, ALLOW_RULES_ARG, allowRules, PROVIDERS_ARG, providers, FLAGS_ARG, flags, MANDATORY_ARG, mandatory, NON_EMPTY_ARG, nonEmpty, CONFIGURATION_ARG, cfg), BuildType.LABEL_LIST, ast, env); } }; @SkylarkSignature( name = "bool", doc = "Creates an attribute of type bool. Its default value is False.", objectType = SkylarkAttr.class, returnType = Attribute.Builder.class, optionalNamedOnly = { @Param(name = DEFAULT_ARG, type = Boolean.class, defaultValue = "False", doc = DEFAULT_DOC), @Param(name = MANDATORY_ARG, type = Boolean.class, defaultValue = "False", doc = MANDATORY_DOC ) }, useAst = true, useEnvironment = true ) private static BuiltinFunction bool = new BuiltinFunction("bool") { public Attribute.Builder invoke( Boolean defaultO, Boolean mandatory, FuncallExpression ast, Environment env) throws EvalException { env.checkLoadingPhase("attr.bool", ast.getLocation()); return createAttribute( EvalUtils.optionMap(DEFAULT_ARG, defaultO, MANDATORY_ARG, mandatory), Type.BOOLEAN, ast, env); } }; @SkylarkSignature( name = "output", doc = "Creates an attribute of type output. Its default value is None. " + "The user provides a file name (string) and the rule must create an action that " + "generates the file.", objectType = SkylarkAttr.class, returnType = Attribute.Builder.class, optionalNamedOnly = { @Param( name = DEFAULT_ARG, type = Label.class, noneable = true, defaultValue = "None", doc = DEFAULT_DOC ), @Param(name = MANDATORY_ARG, type = Boolean.class, defaultValue = "False", doc = MANDATORY_DOC ) }, useAst = true, useEnvironment = true ) private static BuiltinFunction output = new BuiltinFunction("output") { public Attribute.Builder invoke( Object defaultO, Boolean mandatory, FuncallExpression ast, Environment env) throws EvalException { env.checkLoadingPhase("attr.output", ast.getLocation()); return createAttribute( EvalUtils.optionMap(DEFAULT_ARG, defaultO, MANDATORY_ARG, mandatory), BuildType.OUTPUT, ast, env); } }; @SkylarkSignature( name = "output_list", doc = "Creates an attribute of type list of outputs. Its default value is []. " + "See output above for more information.", objectType = SkylarkAttr.class, returnType = Attribute.Builder.class, optionalNamedOnly = { @Param( name = DEFAULT_ARG, type = SkylarkList.class, generic1 = Label.class, defaultValue = "[]", doc = DEFAULT_DOC ), @Param(name = MANDATORY_ARG, type = Boolean.class, defaultValue = "False", doc = MANDATORY_DOC ), @Param(name = NON_EMPTY_ARG, type = Boolean.class, defaultValue = "False", doc = NON_EMPTY_DOC ) }, useAst = true, useEnvironment = true ) private static BuiltinFunction outputList = new BuiltinFunction("output_list") { public Attribute.Builder invoke( SkylarkList defaultList, Boolean mandatory, Boolean nonEmpty, FuncallExpression ast, Environment env) throws EvalException { env.checkLoadingPhase("attr.output_list", ast.getLocation()); return createAttribute( EvalUtils.optionMap( DEFAULT_ARG, defaultList, MANDATORY_ARG, mandatory, NON_EMPTY_ARG, nonEmpty), BuildType.OUTPUT_LIST, ast, env); } }; @SkylarkSignature( name = "string_dict", doc = "Creates an attribute of type dictionary, mapping from string to string. " + "Its default value is dict().", objectType = SkylarkAttr.class, returnType = Attribute.Builder.class, optionalNamedOnly = { @Param(name = DEFAULT_ARG, type = Map.class, defaultValue = "{}", doc = DEFAULT_DOC), @Param(name = MANDATORY_ARG, type = Boolean.class, defaultValue = "False", doc = MANDATORY_DOC ), @Param(name = NON_EMPTY_ARG, type = Boolean.class, defaultValue = "False", doc = NON_EMPTY_DOC ) }, useAst = true, useEnvironment = true ) private static BuiltinFunction stringDict = new BuiltinFunction("string_dict") { public Attribute.Builder invoke( Map defaultO, Boolean mandatory, Boolean nonEmpty, FuncallExpression ast, Environment env) throws EvalException { env.checkLoadingPhase("attr.string_dict", ast.getLocation()); return createAttribute( EvalUtils.optionMap( DEFAULT_ARG, defaultO, MANDATORY_ARG, mandatory, NON_EMPTY_ARG, nonEmpty), Type.STRING_DICT, ast, env); } }; @SkylarkSignature( name = "license", doc = "Creates an attribute of type license. Its default value is NO_LICENSE.", // TODO(bazel-team): Implement proper license support for Skylark. objectType = SkylarkAttr.class, returnType = Attribute.Builder.class, optionalNamedOnly = { // TODO(bazel-team): ensure this is the correct default value @Param(name = DEFAULT_ARG, defaultValue = "None", noneable = true, doc = DEFAULT_DOC), @Param(name = MANDATORY_ARG, type = Boolean.class, defaultValue = "False", doc = MANDATORY_DOC ) }, useAst = true, useEnvironment = true ) private static BuiltinFunction license = new BuiltinFunction("license") { public Attribute.Builder invoke( Object defaultO, Boolean mandatory, FuncallExpression ast, Environment env) throws EvalException { env.checkLoadingPhase("attr.license", ast.getLocation()); return createAttribute( EvalUtils.optionMap(DEFAULT_ARG, defaultO, MANDATORY_ARG, mandatory), BuildType.LICENSE, ast, env); } }; static { SkylarkSignatureProcessor.configureSkylarkFunctions(SkylarkAttr.class); } }