// Copyright 2016 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.base.Joiner;
import com.google.common.base.Objects;
import com.google.common.base.Preconditions;
import com.google.common.collect.ImmutableCollection;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.Ordering;
import com.google.devtools.build.lib.events.Location;
import com.google.devtools.build.lib.skylarkinterface.SkylarkModule;
import com.google.devtools.build.lib.skylarkinterface.SkylarkModuleCategory;
import com.google.devtools.build.lib.skylarkinterface.SkylarkPrinter;
import com.google.devtools.build.lib.skylarkinterface.SkylarkValue;
import com.google.devtools.build.lib.syntax.ClassObject;
import com.google.devtools.build.lib.syntax.EvalException;
import com.google.devtools.build.lib.syntax.Printer;
import com.google.devtools.build.lib.syntax.SkylarkType;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import javax.annotation.Nullable;
/** An instance (in the Skylark sense, not Java) of a {@link Provider}. */
@SkylarkModule(
name = "struct",
category = SkylarkModuleCategory.BUILTIN,
doc =
"A generic object with fields. See the global struct"
+ "
function for more details."
+ "
Structs fields cannot be reassigned once the struct is created. Two structs are " + "equal if they have the same fields and if corresponding field values are equal." ) public abstract class Info implements ClassObject, SkylarkValue, Serializable { /** The {@link Provider} that describes the type of this instance. */ private final Provider provider; /** * The Skylark location where this provider instance was created. * *
Built-in provider instances may use {@link Location#BUILTIN}. */ private final Location creationLoc; /** * Formattable string with one {@code '%s'} placeholder for the missing field name. */ private final String errorMessageFormatForUnknownField; /** * Creates an empty struct with a given location. * *
If {@code location} is null, it defaults to {@link Location#BUILTIN}. */ public Info(Provider provider, @Nullable Location location) { this.provider = provider; this.creationLoc = location == null ? Location.BUILTIN : location; this.errorMessageFormatForUnknownField = provider.getErrorMessageFormatForUnknownField(); } /** Creates a built-in struct (i.e. without a Skylark creation location). */ public Info(Provider provider) { this.provider = provider; this.creationLoc = Location.BUILTIN; this.errorMessageFormatForUnknownField = provider.getErrorMessageFormatForUnknownField(); } /** * Creates a built-in struct (i.e. without creation location) that uses a specific error message * for missing fields. * *
Only used in {@link
* com.google.devtools.build.lib.packages.NativeProvider.StructConstructor#create(Map, String)}.
* If you need to override an error message, the preferred way is to create a new {@link
* NativeProvider} subclass.
*/
Info(Provider provider, String errorMessageFormatForUnknownField) {
this.provider = provider;
this.creationLoc = Location.BUILTIN;
this.errorMessageFormatForUnknownField =
Preconditions.checkNotNull(errorMessageFormatForUnknownField);
}
/**
* Preprocesses a map of field values to convert the field names and field values to
* Skylark-acceptable names and types.
*/
protected static ImmutableMap This conceptually extends the API for {@link ClassObject}.
*/
public abstract boolean hasField(String name);
/** Returns a value and try to cast it into specified type */
public Builtin provider instances may return {@link Location#BUILTIN}.
*/
public Location getCreationLoc() {
return creationLoc;
}
public Provider getProvider() {
return provider;
}
/**
* Returns the fields of this struct.
*
* Overrides {@link ClassObject#getFieldNames()}, but does not allow {@link EvalException} to
* be thrown.
*/
@Override
public abstract ImmutableCollection