blob: fe9eeb68da6e4f3e86117eb734f219fdba33eaa6 [file] [log] [blame]
// Copyright 2015 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.query2;
import com.google.common.collect.Iterables;
import com.google.devtools.build.lib.packages.Target;
import com.google.devtools.build.lib.query2.engine.Callback;
import com.google.devtools.build.lib.query2.engine.QueryEnvironment;
import com.google.devtools.build.lib.query2.engine.QueryEnvironment.Argument;
import com.google.devtools.build.lib.query2.engine.QueryEnvironment.ArgumentType;
import com.google.devtools.build.lib.query2.engine.QueryEnvironment.QueryFunction;
import com.google.devtools.build.lib.query2.engine.QueryEnvironment.QueryTaskFuture;
import com.google.devtools.build.lib.query2.engine.QueryException;
import com.google.devtools.build.lib.query2.engine.QueryExpression;
import com.google.devtools.build.lib.query2.engine.QueryExpressionContext;
import com.google.devtools.build.lib.server.FailureDetails.Query;
import com.google.devtools.build.lib.vfs.PathFragment;
import java.util.List;
import java.util.stream.Collectors;
/**
* An "rbuildfiles" query expression, which computes the set of packages (as represented by their
* BUILD source file targets) that depend on the given set of files, either as BUILD files directly
* or as subincludes. Is morally the inverse of the "buildfiles" operator, although that operator
* takes targets and returns subinclude targets, while this takes files and returns BUILD file
* targets.
*
* <pre>expr ::= RBUILDFILES '(' WORD, ... ')'</pre>
*
* <p>This expression can only be used with SkyQueryEnvironment.
*/
public class RBuildFilesFunction implements QueryFunction {
@Override
public String getName() {
return "rbuildfiles";
}
@Override
public int getMandatoryArguments() {
return 1;
}
@Override
public Iterable<ArgumentType> getArgumentTypes() {
return Iterables.cycle(ArgumentType.WORD);
}
@Override
@SuppressWarnings("unchecked") // Cast from <T> to <Target>. This will only be used with <Target>.
public <T> QueryTaskFuture<Void> eval(
QueryEnvironment<T> env,
QueryExpressionContext<T> context,
QueryExpression expression,
List<Argument> args,
Callback<T> callback) {
if (!(env instanceof SkyQueryEnvironment)) {
return env.immediateFailedFuture(
new QueryException(
"rbuildfiles can only be used with SkyQueryEnvironment",
Query.Code.RBUILDFILES_FUNCTION_REQUIRES_SKYQUERY));
}
SkyQueryEnvironment skyEnv = ((SkyQueryEnvironment) env);
return skyEnv.getRBuildFiles(
args.stream()
.map(argument -> PathFragment.create(argument.getWord()))
.collect(Collectors.toList()),
(QueryExpressionContext<Target>) context,
(Callback<Target>) callback);
}
}