// Copyright 2017 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.devtools.build.lib.concurrent.ThreadSafety.Immutable;
import com.google.devtools.build.lib.events.Location;
import com.google.devtools.build.lib.skyframe.serialization.autocodec.AutoCodec;
import com.google.devtools.build.lib.skyframe.serialization.autocodec.AutoCodec.VisibleForSerialization;
import com.google.devtools.build.lib.syntax.Environment;
import com.google.devtools.build.lib.syntax.EvalException;
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 javax.annotation.Nullable;
/**
* Base class for declared providers {@see Provider} defined in native code.
*
*
Every non-abstract derived class of {@link NativeProvider} corresponds to a single declared
* provider. This is enforced by final {@link #equals(Object)} and {@link #hashCode()}.
*
*
Typical implementation of a non-constructable from Skylark declared provider is as follows:
*
*
* public static final Provider PROVIDER =
* new NativeProvider("link_params") { };
*
*
* To allow construction from Skylark and custom construction logic, override {@link
* ProviderFromFunction#createInstanceFromSkylark(Object[], Environment, Location)}.
*
* @deprecated use {@link BuiltinProvider} instead.
*/
@Immutable
@Deprecated
public abstract class NativeProvider extends ProviderFromFunction {
private final NativeKey key;
private final String errorMessageFormatForUnknownField;
private final Class valueClass;
public Class getValueClass() {
return valueClass;
}
/**
* Implement this to mark that a native provider should be exported with certain name to Skylark.
* Broken: only works for rules, not for aspects. DO NOT USE FOR NEW CODE!
*
*
Use native declared providers mechanism exclusively to expose providers to both native and
* Skylark code.
*/
@Deprecated
public interface WithLegacySkylarkName {
String getSkylarkName();
}
private static final FunctionSignature.WithValues