blob: 02b23ef79f877218d47e04f7487c4d3333b7988d [file] [log] [blame]
// 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.packages;
import com.google.common.collect.ImmutableMap;
import com.google.devtools.build.lib.analysis.RuleDefinitionEnvironment;
import com.google.devtools.build.lib.cmdline.Label;
import com.google.devtools.build.lib.packages.RuleClass.Builder.ThirdPartyLicenseExistencePolicy;
import com.google.devtools.build.lib.vfs.Root;
import java.util.Map;
/**
* The collection of the supported build rules. Provides an StarlarkThread for Starlark rule
* creation.
*/
public interface RuleClassProvider extends RuleDefinitionEnvironment {
/** Label referencing the prelude file. */
Label getPreludeLabel();
/** The default runfiles prefix (may be overwritten by the WORKSPACE file). */
String getRunfilesPrefix();
/**
* Where the bundled builtins bzl files are located. These are the builtins files used if {@code
* --experimental_builtins_bzl_path} is set to {@code %bundled%}. Note that this root lives in a
* separate {@link InMemoryFileSystem}.
*
* <p>May be null in tests, in which case {@code --experimental_builtins_bzl_path} must point to
* the builtins root to be used.
*/
Root getBundledBuiltinsRoot();
/**
* The relative location of the builtins_bzl directory within a Bazel source tree.
*
* <p>May be null in tests, in which case --experimental_builtins_bzl_path may not be
* "%workspace%".
*/
String getBuiltinsBzlPackagePathInSource();
/** Returns a map from rule names to rule class objects. */
Map<String, RuleClass> getRuleClassMap();
/**
* Returns all the predeclared top-level symbols (for .bzl files) that belong to native rule sets,
* and hence are allowed to be overridden by builtins-injection.
*
* <p>For example, {@code CcInfo} is included, but {@code rule()} is not.
*
* @see StarlarkBuiltinsFunction
*/
ImmutableMap<String, Object> getNativeRuleSpecificBindings();
/**
* Returns the set of symbols to be made available to {@code @_builtins} .bzl files under the
* _builtins.internal object.
*
* <p>These symbols are not exposed to user .bzl code and do not constitute a public or stable API
* (unless exposed through another means).
*/
ImmutableMap<String, Object> getStarlarkBuiltinsInternals();
/**
* Returns the Starlark builtins registered with this RuleClassProvider.
*
* <p>Does not account for builtins injection. Excludes universal bindings (e.g. True, len).
*
* <p>See {@link BazelStarlarkEnvironment#getUninjectedBuildBzlNativeBindings} for the canonical
* determination of the bzl environment (before injection).
*/
ImmutableMap<String, Object> getEnvironment();
/** Returns a map from aspect names to aspect factory objects. */
Map<String, NativeAspectClass> getNativeAspectClassMap();
/**
* Returns the default content that should be added at the beginning of the WORKSPACE file.
*
* <p>Used to provide external dependencies for built-in rules. Rules defined here can be
* overwritten in the WORKSPACE file in the actual workspace.
*/
String getDefaultWorkspacePrefix();
/**
* Returns the default content that should be added at the end of the WORKSPACE file.
*
* <p>Used to load Starlark repository in the bazel_tools repository.
*/
String getDefaultWorkspaceSuffix();
/** Retrieves an aspect from the aspect factory map using the key provided */
NativeAspectClass getNativeAspectClass(String key);
/**
* Retrieves a {@link Map} from Starlark configuration fragment name to configuration fragment
* class.
*/
ImmutableMap<String, Class<?>> getConfigurationFragmentMap();
/** Returns the policy on checking that third-party rules have licenses. */
ThirdPartyLicenseExistencePolicy getThirdPartyLicenseExistencePolicy();
}