-
Notifications
You must be signed in to change notification settings - Fork 4.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Create new config module that is responsible for creating BuildSettin…
…g descriptor objects. Build settings are units of configuration i.e. a key/value pair of a setting (e.g. cpu) and a value (e.g. ppc). A build setting descriptor is used to describe what kind of build setting a skylark rule is (if any at all). The BuildSettingDescriptor implementation of the API describes two facets of the build setting rule: the type of the value and whether or not the setting is settable on the command line. The methods exposed here will eventually be hooked up to a new parameter in the <code> rule() </code> function. Validation for these restrictions will also happen in a later CL attached to the same bug. Add a new test config_apis_test for skylark config apis which will be more populated as this work continues. PiperOrigin-RevId: 214991588
- Loading branch information
Showing
11 changed files
with
345 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
89 changes: 89 additions & 0 deletions
89
src/main/java/com/google/devtools/build/lib/analysis/skylark/SkylarkConfig.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,89 @@ | ||
| // Copyright 2018 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.analysis.skylark; | ||
|
|
||
| import static com.google.devtools.build.lib.packages.BuildType.LABEL; | ||
| import static com.google.devtools.build.lib.packages.BuildType.LABEL_LIST; | ||
| import static com.google.devtools.build.lib.syntax.Type.BOOLEAN; | ||
| import static com.google.devtools.build.lib.syntax.Type.INTEGER; | ||
| 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.skylarkbuildapi.SkylarkConfigApi; | ||
| import com.google.devtools.build.lib.skylarkinterface.SkylarkPrinter; | ||
| import com.google.devtools.build.lib.syntax.Type; | ||
|
|
||
| /** | ||
| * Skylark namespace for creating build setting descriptors. | ||
| */ | ||
| public class SkylarkConfig implements SkylarkConfigApi { | ||
|
|
||
| @Override | ||
| public BuildSettingDescriptor intSetting(Boolean flag) { | ||
| return new BuildSettingDescriptor(flag, INTEGER); | ||
| } | ||
|
|
||
| @Override | ||
| public BuildSettingDescriptor boolSetting(Boolean flag) { | ||
| return new BuildSettingDescriptor(flag, BOOLEAN); | ||
| } | ||
|
|
||
| @Override | ||
| public BuildSettingDescriptor stringSetting(Boolean flag) { | ||
| return new BuildSettingDescriptor(flag, STRING); | ||
| } | ||
|
|
||
| @Override | ||
| public BuildSettingDescriptor stringListSetting(Boolean flag) { | ||
| return new BuildSettingDescriptor(flag, STRING_LIST); | ||
| } | ||
|
|
||
| @Override | ||
| public BuildSettingDescriptor labelSetting(Boolean flag) { | ||
| return new BuildSettingDescriptor(flag, LABEL); | ||
| } | ||
|
|
||
| @Override | ||
| public BuildSettingDescriptor labelListSetting(Boolean flag) { | ||
| return new BuildSettingDescriptor(flag, LABEL_LIST); | ||
| } | ||
|
|
||
| @Override | ||
| public void repr(SkylarkPrinter printer) { | ||
| printer.append("<config>"); | ||
| } | ||
|
|
||
| /** | ||
| * An object that describes what time of build setting a skylark rule is (if any type). | ||
| */ | ||
| private static final class BuildSettingDescriptor implements SkylarkConfigApi.BuildSettingApi { | ||
| private final boolean isFlag; | ||
| private final Type<?> type; | ||
|
|
||
| BuildSettingDescriptor(boolean isFlag, Type<?> type) { | ||
| this.isFlag = isFlag; | ||
| this.type = type; | ||
| } | ||
|
|
||
| public Type<?> getType() { | ||
| return type; | ||
| } | ||
|
|
||
| @Override | ||
| public void repr(SkylarkPrinter printer) { | ||
| printer.append("<build_setting." + type.toString() + ">"); | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
148 changes: 148 additions & 0 deletions
148
src/main/java/com/google/devtools/build/lib/skylarkbuildapi/SkylarkConfigApi.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,148 @@ | ||
| // Copyright 2018 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.skylarkbuildapi; | ||
|
|
||
| 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.SkylarkModuleCategory; | ||
| import com.google.devtools.build.lib.skylarkinterface.SkylarkValue; | ||
|
|
||
|
|
||
| /** | ||
| * The "config" module of the Build API. | ||
| * | ||
| * This exposes methods to describe what kind of build setting (if any) a skylark rule is using | ||
| * the {@code build_setting} attr of the {@code rule(...)} function. | ||
| */ | ||
| @SkylarkModule( | ||
| name = "config", | ||
| namespace = true, | ||
| category = SkylarkModuleCategory.BUILTIN, | ||
| doc = "Note: This API is experimental and may change at any time." | ||
| + "" | ||
| + "<p>This is a top-level module for creating build setting descriptors which describe " | ||
| + "what kind of build setting (if any) a skylark rule is. " | ||
| + "" | ||
| + "<p>ex: the following rule is marked as a build setting by setting the " | ||
| + "<code>build_setting</code> parameter of the <code>rule()</code> function. Specifically " | ||
| + "it is a build setting of type <code>int</code> and is a <code>flag</code> which means " | ||
| + "this build setting is callable on the command line.<br><pre class=language-python>" | ||
| + " my_rule = rule(\n" | ||
| + " implementation = _impl,\n" | ||
| + " build_setting = config.int(flag = True),\n" | ||
| + " ...\n" | ||
| + " )</pre>") | ||
| //TODO(juliexxia): Create formal documentation for skylark build configuration efforts (b/112545834) | ||
| public interface SkylarkConfigApi extends SkylarkValue { | ||
|
|
||
| static final String FLAG_ARG = "flag"; | ||
| static final String FLAG_ARG_DOC = | ||
| "Whether or not this build setting is callable on the command line."; | ||
|
|
||
| @SkylarkCallable( | ||
| name = "int", | ||
| doc = "An integer-typed build setting", | ||
| parameters = { | ||
| @Param( | ||
| name = FLAG_ARG, | ||
| type = Boolean.class, | ||
| defaultValue = "False", | ||
| doc = FLAG_ARG_DOC, | ||
| named = true, | ||
| positional = false) | ||
| }) | ||
| BuildSettingApi intSetting(Boolean flag); | ||
|
|
||
| @SkylarkCallable( | ||
| name = "bool", | ||
| doc = "A bool-typed build setting", | ||
| parameters = { | ||
| @Param( | ||
| name = FLAG_ARG, | ||
| type = Boolean.class, | ||
| defaultValue = "False", | ||
| doc = FLAG_ARG_DOC, | ||
| named = true, | ||
| positional = false) | ||
| }) | ||
| BuildSettingApi boolSetting(Boolean flag); | ||
|
|
||
| @SkylarkCallable( | ||
| name = "string", | ||
| doc = "A string-typed build setting", | ||
| parameters = { | ||
| @Param( | ||
| name = FLAG_ARG, | ||
| type = Boolean.class, | ||
| defaultValue = "False", | ||
| doc = FLAG_ARG_DOC, | ||
| named = true, | ||
| positional = false) | ||
| }) | ||
| BuildSettingApi stringSetting(Boolean flag); | ||
|
|
||
| @SkylarkCallable( | ||
| name = "string_list", | ||
| doc = "A string list-typed build setting", | ||
| parameters = { | ||
| @Param( | ||
| name = FLAG_ARG, | ||
| type = Boolean.class, | ||
| defaultValue = "False", | ||
| doc = FLAG_ARG_DOC, | ||
| named = true, | ||
| positional = false) | ||
| }) | ||
| BuildSettingApi stringListSetting(Boolean flag); | ||
|
|
||
| @SkylarkCallable( | ||
| name = "label", | ||
| doc = "A label typed build setting", | ||
| parameters = { | ||
| @Param( | ||
| name = FLAG_ARG, | ||
| type = Boolean.class, | ||
| defaultValue = "False", | ||
| doc = FLAG_ARG_DOC, | ||
| named = true, | ||
| positional = false) | ||
| }) | ||
| BuildSettingApi labelSetting(Boolean flag); | ||
|
|
||
| @SkylarkCallable( | ||
| name = "label_list", | ||
| doc = "A label list-typed build setting", | ||
| parameters = { | ||
| @Param( | ||
| name = FLAG_ARG, | ||
| type = Boolean.class, | ||
| defaultValue = "False", | ||
| doc = FLAG_ARG_DOC, | ||
| named = true, | ||
| positional = false) | ||
| }) | ||
| BuildSettingApi labelListSetting(Boolean flag); | ||
|
|
||
| /** The API for build setting descriptors. */ | ||
| @SkylarkModule( | ||
| name = "BuildSetting", | ||
| category = SkylarkModuleCategory.NONE, | ||
| doc = | ||
| "The descriptor for a single piece of configuration information. If configuration is a " | ||
| + "key-value map of settings like {'cpu': 'ppc', 'copt': '-DFoo'}, this describes a " | ||
| + "single entry in that map.") | ||
| interface BuildSettingApi extends SkylarkValue {} | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
26 changes: 26 additions & 0 deletions
26
src/main/java/com/google/devtools/build/skydoc/fakebuildapi/FakeBuildSettingDescriptor.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| // Copyright 2018 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.skydoc.fakebuildapi; | ||
|
|
||
| import com.google.devtools.build.lib.skylarkbuildapi.SkylarkConfigApi.BuildSettingApi; | ||
| import com.google.devtools.build.lib.skylarkinterface.SkylarkPrinter; | ||
|
|
||
| /** | ||
| * Fake implementation of {@link BuildSettingApi}. | ||
| */ | ||
| public class FakeBuildSettingDescriptor implements BuildSettingApi { | ||
| @Override | ||
| public void repr(SkylarkPrinter printer) {} | ||
| } |
Oops, something went wrong.