Migrate struct() to skylarkbuildapi
RELNOTES: None.
PiperOrigin-RevId: 197915097
diff --git a/src/main/java/com/google/devtools/build/lib/packages/Attribute.java b/src/main/java/com/google/devtools/build/lib/packages/Attribute.java
index 933790f..0bc32e42 100644
--- a/src/main/java/com/google/devtools/build/lib/packages/Attribute.java
+++ b/src/main/java/com/google/devtools/build/lib/packages/Attribute.java
@@ -1513,7 +1513,7 @@
private Object invokeCallback(EventHandler eventHandler, Map<String, Object> attrValues)
throws EvalException, InterruptedException {
ClassObject attrs =
- NativeProvider.STRUCT.create(
+ StructProvider.STRUCT.create(
attrValues, "No such regular (non computed) attribute '%s'.");
Object result = callback.call(eventHandler, attrs);
try {
diff --git a/src/main/java/com/google/devtools/build/lib/packages/ImplicitOutputsFunction.java b/src/main/java/com/google/devtools/build/lib/packages/ImplicitOutputsFunction.java
index 33bc2cf..96388f2 100644
--- a/src/main/java/com/google/devtools/build/lib/packages/ImplicitOutputsFunction.java
+++ b/src/main/java/com/google/devtools/build/lib/packages/ImplicitOutputsFunction.java
@@ -105,7 +105,7 @@
}
}
ClassObject attrs =
- NativeProvider.STRUCT.create(
+ StructProvider.STRUCT.create(
attrValues,
"Attribute '%s' either doesn't exist "
+ "or uses a select() (i.e. could have multiple values)");
diff --git a/src/main/java/com/google/devtools/build/lib/packages/NativeProvider.java b/src/main/java/com/google/devtools/build/lib/packages/NativeProvider.java
index 20e649b..c59d81e 100644
--- a/src/main/java/com/google/devtools/build/lib/packages/NativeProvider.java
+++ b/src/main/java/com/google/devtools/build/lib/packages/NativeProvider.java
@@ -13,7 +13,6 @@
// limitations under the License.
package com.google.devtools.build.lib.packages;
-import com.google.common.collect.ImmutableMap;
import com.google.devtools.build.lib.concurrent.ThreadSafety.Immutable;
import com.google.devtools.build.lib.events.Location;
import com.google.devtools.build.lib.skyframe.serialization.autocodec.AutoCodec;
@@ -23,7 +22,6 @@
import com.google.devtools.build.lib.syntax.FunctionSignature;
import com.google.devtools.build.lib.syntax.SkylarkType;
import com.google.devtools.build.lib.util.Pair;
-import java.util.Map;
import javax.annotation.Nullable;
/**
@@ -40,8 +38,7 @@
* </pre>
*
* To allow construction from Skylark and custom construction logic, override {@link
- * Provider#createInstanceFromSkylark(Object[], Environment, Location)} (see {@link #STRUCT} for an
- * example.
+ * ProviderFromFunction#createInstanceFromSkylark(Object[], Environment, Location)}.
*
* @deprecated use {@link BuiltinProvider} instead.
*/
@@ -51,9 +48,6 @@
private final NativeKey key;
private final String errorMessageFormatForUnknownField;
- /** "struct" function. */
- public static final StructProvider STRUCT = new StructProvider();
-
private final Class<V> valueClass;
public Class<V> getValueClass() {
@@ -72,42 +66,6 @@
String getSkylarkName();
}
- /**
- * The provider for the built-in type {@code struct}.
- *
- * <p>Its singleton instance is {@link #STRUCT}.
- */
- public static final class StructProvider extends NativeProvider<Info> {
- private StructProvider() {
- super(Info.class, "struct");
- }
-
- @Override
- protected Info createInstanceFromSkylark(Object[] args, Environment env, Location loc) {
- @SuppressWarnings("unchecked")
- Map<String, Object> kwargs = (Map<String, Object>) args[0];
- return SkylarkInfo.createSchemaless(this, kwargs, loc);
- }
-
- /**
- * Creates a struct with the he given field values and message format for unknown fields.
- *
- * <p>The custom message is useful for objects that have fields but aren't exactly used as
- * providers, such as the {@code native} object, and the struct fields of {@code ctx} like
- * {@code ctx.attr}.
- * */
- public SkylarkInfo create(
- Map<String, Object> values, String errorMessageFormatForUnknownField) {
- return SkylarkInfo.createSchemalessWithCustomMessage(
- this, values, errorMessageFormatForUnknownField);
- }
-
- /** Creates an empty struct with the given location. */
- public SkylarkInfo createEmpty(Location loc) {
- return SkylarkInfo.createSchemaless(this, ImmutableMap.of(), loc);
- }
- }
-
private static final FunctionSignature.WithValues<Object, SkylarkType> SIGNATURE =
FunctionSignature.WithValues.create(FunctionSignature.KWARGS);
diff --git a/src/main/java/com/google/devtools/build/lib/packages/PackageFactory.java b/src/main/java/com/google/devtools/build/lib/packages/PackageFactory.java
index ad682b6..71bf904 100644
--- a/src/main/java/com/google/devtools/build/lib/packages/PackageFactory.java
+++ b/src/main/java/com/google/devtools/build/lib/packages/PackageFactory.java
@@ -1514,7 +1514,7 @@
builder.put(function.getName(), function);
}
}
- return NativeProvider.STRUCT.create(builder.build(), "no native function or rule '%s'");
+ return StructProvider.STRUCT.create(builder.build(), "no native function or rule '%s'");
}
private void buildPkgEnv(
diff --git a/src/main/java/com/google/devtools/build/lib/packages/StructProvider.java b/src/main/java/com/google/devtools/build/lib/packages/StructProvider.java
new file mode 100644
index 0000000..21f8475
--- /dev/null
+++ b/src/main/java/com/google/devtools/build/lib/packages/StructProvider.java
@@ -0,0 +1,62 @@
+// 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.packages;
+
+import com.google.common.collect.ImmutableMap;
+import com.google.devtools.build.lib.events.Location;
+import com.google.devtools.build.lib.skylarkbuildapi.StructApi;
+import com.google.devtools.build.lib.syntax.EvalException;
+import com.google.devtools.build.lib.syntax.SkylarkDict;
+import java.util.Map;
+
+/**
+ * The provider for the built-in type {@code struct}.
+ *
+ * <p>Its singleton instance is {@link StructProvider#STRUCT}.
+ */
+public final class StructProvider extends BuiltinProvider<Info>
+ implements StructApi.StructProviderApi {
+
+ /** "struct" function. */
+ public static final StructProvider STRUCT = new StructProvider();
+
+ StructProvider() {
+ super("struct", Info.class);
+ }
+
+ @Override
+ public Info createStruct(SkylarkDict<?, ?> kwargs, Location loc) throws EvalException {
+ return SkylarkInfo.createSchemaless(
+ this, kwargs.getContents(String.class, Object.class, "kwargs"), loc);
+ }
+
+ /**
+ * Creates a struct with the he given field values and message format for unknown fields.
+ *
+ * <p>The custom message is useful for objects that have fields but aren't exactly used as
+ * providers, such as the {@code native} object, and the struct fields of {@code ctx} like
+ * {@code ctx.attr}.
+ * */
+ public SkylarkInfo create(
+ Map<String, Object> values, String errorMessageFormatForUnknownField) {
+ return SkylarkInfo.createSchemalessWithCustomMessage(
+ this, values, errorMessageFormatForUnknownField);
+ }
+
+ /** Creates an empty struct with the given location. */
+ public SkylarkInfo createEmpty(Location loc) {
+ return SkylarkInfo.createSchemaless(this, ImmutableMap.of(), loc);
+ }
+}
diff --git a/src/main/java/com/google/devtools/build/lib/packages/WorkspaceFactory.java b/src/main/java/com/google/devtools/build/lib/packages/WorkspaceFactory.java
index 5d55d31..b9d86ad 100644
--- a/src/main/java/com/google/devtools/build/lib/packages/WorkspaceFactory.java
+++ b/src/main/java/com/google/devtools/build/lib/packages/WorkspaceFactory.java
@@ -569,7 +569,7 @@
}
builder.put("bazel_version", version);
- return NativeProvider.STRUCT.create(builder.build(), "no native function or rule '%s'");
+ return StructProvider.STRUCT.create(builder.build(), "no native function or rule '%s'");
}
static ClassObject newNativeModule(RuleClassProvider ruleClassProvider, String version) {
