com.facebook.buck.cli

Class BuckQueryEnvironment

java.lang.Object

com.facebook.buck.cli.BuckQueryEnvironment

All Implemented Interfaces:

QueryEnvironment<QueryBuildTarget>

public class BuckQueryEnvironment
extends Object
implements QueryEnvironment<QueryBuildTarget>

The environment of a Buck query that can evaluate queries to produce a result.

The query language is documented at docs/command/query.soy

Nested Class Summary

Nested classes/interfaces inherited from interface com.facebook.buck.query.QueryEnvironment

QueryEnvironment.Argument<ENV_NODE_TYPE>, QueryEnvironment.ArgumentType, QueryEnvironment.QueryFunction<OUTPUT_TYPE extends QueryTarget,ENV_NODE_TYPE>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BuckQueryEnvironment(Cell rootCell, com.facebook.buck.cli.OwnersReport.Builder ownersReportBuilder, Parser parser, PerBuildState parserState, com.facebook.buck.cli.TargetPatternEvaluator targetPatternEvaluator, BuckEventBus eventBus, TypeCoercerFactory typeCoercerFactory)

Method Summary

Modifier and Type	Method and Description
void	buildTransitiveClosure(Set<? extends QueryTarget> targets, int maxDepth) Construct the dependency graph for a depth-bounded forward transitive closure of all nodes in "targetNodes".
Set<QueryTarget>	evaluateQuery(QueryExpression<QueryBuildTarget> expr) Evaluate the specified query expression in this environment.
Set<QueryTarget>	evaluateQuery(String query)
com.google.common.collect.ImmutableSet<Object>	filterAttributeContents(QueryBuildTarget target, String attribute, java.util.function.Predicate<Object> predicate) Returns the objects in the `attribute` of the given `target` that satisfy `predicate`
static BuckQueryEnvironment	from(Cell rootCell, com.facebook.buck.cli.OwnersReport.Builder ownersReportBuilder, Parser parser, PerBuildState parserState, com.facebook.buck.cli.TargetPatternEvaluator targetPatternEvaluator, BuckEventBus eventBus, TypeCoercerFactory typeCoercerFactory)
static BuckQueryEnvironment	from(CommandRunnerParams params, PerBuildState parserState, ParsingContext parsingContext)
com.google.common.collect.ImmutableSet<QueryFileTarget>	getBuildFiles(Set<QueryBuildTarget> targets) Returns the build files that define the given targets.
com.google.common.collect.ImmutableSet<QueryBuildTarget>	getFileOwners(com.google.common.collect.ImmutableList<String> files) Returns the targets that own one or more of the given files.
Iterable<QueryEnvironment.QueryFunction<? extends QueryTarget,QueryBuildTarget>>	getFunctions() Returns the set of query functions implemented by this query environment.
com.google.common.collect.ImmutableSet<QueryBuildTarget>	getFwdDeps(Iterable<QueryBuildTarget> targets) Returns the direct forward dependencies of the specified targets.
Set<QueryFileTarget>	getInputs(QueryBuildTarget target)
com.google.common.collect.ImmutableSet<TargetNode<?>>	getNodesFromQueryTargets(Collection<QueryBuildTarget> input)
PerBuildState	getParserState()
Set<QueryBuildTarget>	getReverseDeps(Iterable<QueryBuildTarget> targets) Returns the direct reverse dependencies of the specified targets.
QueryEnvironment.TargetEvaluator	getTargetEvaluator() Returns an evaluator for target patterns.
DirectedAcyclicGraph<TargetNode<?>>	getTargetGraph()
String	getTargetKind(QueryBuildTarget target)
com.google.common.collect.ImmutableSet<QueryBuildTarget>	getTargetsFromBuildTargets(Iterable<BuildTarget> buildTargets)
com.google.common.collect.ImmutableSet<QueryBuildTarget>	getTargetsFromTargetNodes(Iterable<TargetNode<?>> targetNodes)
com.google.common.collect.ImmutableSet<? extends QueryTarget>	getTargetsInAttribute(QueryBuildTarget target, String attribute) Returns the existing targets in the value of `attribute` of the given `target`.
com.google.common.collect.ImmutableSet<QueryBuildTarget>	getTestsForTarget(QueryBuildTarget target) Returns the tests associated with the given target.
com.google.common.collect.ImmutableSet<QueryBuildTarget>	getTransitiveClosure(Set<QueryBuildTarget> targets) Returns the forward transitive closure of all of the targets in "targets".
void	preloadTargetPatterns(Iterable<String> patterns)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.facebook.buck.query.QueryEnvironment

forEachFwdDep, getTargetsMatchingPattern, resolveTargetVariable

Constructor Detail

BuckQueryEnvironment

protected BuckQueryEnvironment(Cell rootCell,
                               com.facebook.buck.cli.OwnersReport.Builder ownersReportBuilder,
                               Parser parser,
                               PerBuildState parserState,
                               com.facebook.buck.cli.TargetPatternEvaluator targetPatternEvaluator,
                               BuckEventBus eventBus,
                               TypeCoercerFactory typeCoercerFactory)

Method Detail

from

public static BuckQueryEnvironment from(Cell rootCell,
                                        com.facebook.buck.cli.OwnersReport.Builder ownersReportBuilder,
                                        Parser parser,
                                        PerBuildState parserState,
                                        com.facebook.buck.cli.TargetPatternEvaluator targetPatternEvaluator,
                                        BuckEventBus eventBus,
                                        TypeCoercerFactory typeCoercerFactory)

from

public static BuckQueryEnvironment from(CommandRunnerParams params,
                                        PerBuildState parserState,
                                        ParsingContext parsingContext)

getTargetGraph

public DirectedAcyclicGraph<TargetNode<?>> getTargetGraph()

getParserState

public PerBuildState getParserState()

preloadTargetPatterns

public void preloadTargetPatterns(Iterable<String> patterns)
                           throws QueryException,
                                  InterruptedException

Throws:

QueryException

InterruptedException

evaluateQuery

public Set<QueryTarget> evaluateQuery(QueryExpression<QueryBuildTarget> expr)
                               throws QueryException,
                                      InterruptedException

Evaluate the specified query expression in this environment.

Returns:

the resulting set of targets.

Throws:

QueryException - if the evaluation failed.

InterruptedException

evaluateQuery

public Set<QueryTarget> evaluateQuery(String query)
                               throws QueryException,
                                      InterruptedException

Throws:

QueryException

InterruptedException

getTargetsFromTargetNodes

public com.google.common.collect.ImmutableSet<QueryBuildTarget> getTargetsFromTargetNodes(Iterable<TargetNode<?>> targetNodes)

getTargetsFromBuildTargets

public com.google.common.collect.ImmutableSet<QueryBuildTarget> getTargetsFromBuildTargets(Iterable<BuildTarget> buildTargets)

getNodesFromQueryTargets

public com.google.common.collect.ImmutableSet<TargetNode<?>> getNodesFromQueryTargets(Collection<QueryBuildTarget> input)
                                                                               throws QueryException

Throws:

QueryException

getFwdDeps

public com.google.common.collect.ImmutableSet<QueryBuildTarget> getFwdDeps(Iterable<QueryBuildTarget> targets)
                                                                    throws QueryException

Description copied from interface: QueryEnvironment

Returns the direct forward dependencies of the specified targets.

Specified by:

getFwdDeps in interface QueryEnvironment<QueryBuildTarget>

Throws:

QueryException

getReverseDeps

public Set<QueryBuildTarget> getReverseDeps(Iterable<QueryBuildTarget> targets)
                                     throws QueryException

Description copied from interface: QueryEnvironment

Returns the direct reverse dependencies of the specified targets.

Specified by:

getReverseDeps in interface QueryEnvironment<QueryBuildTarget>

Throws:

QueryException

getInputs

public Set<QueryFileTarget> getInputs(QueryBuildTarget target)
                               throws QueryException

Specified by:

getInputs in interface QueryEnvironment<QueryBuildTarget>

Throws:

QueryException

getTransitiveClosure

public com.google.common.collect.ImmutableSet<QueryBuildTarget> getTransitiveClosure(Set<QueryBuildTarget> targets)
                                                                              throws QueryException

Description copied from interface: QueryEnvironment

Returns the forward transitive closure of all of the targets in "targets". Callers must ensure that QueryEnvironment.buildTransitiveClosure(java.util.Set<? extends com.facebook.buck.core.model.QueryTarget>, int) has been called for the relevant subgraph.

Specified by:

getTransitiveClosure in interface QueryEnvironment<QueryBuildTarget>

Throws:

QueryException

buildTransitiveClosure

public void buildTransitiveClosure(Set<? extends QueryTarget> targets,
                                   int maxDepth)
                            throws QueryException

Description copied from interface: QueryEnvironment

Construct the dependency graph for a depth-bounded forward transitive closure of all nodes in "targetNodes". The identity of the calling expression is required to produce error messages.

If a larger transitive closure was already built, returns it to improve incrementality, since all depth-constrained methods filter it after it is built anyway.

Specified by:

buildTransitiveClosure in interface QueryEnvironment<QueryBuildTarget>

Throws:

QueryException

getTestsForTarget

public com.google.common.collect.ImmutableSet<QueryBuildTarget> getTestsForTarget(QueryBuildTarget target)
                                                                           throws QueryException

Description copied from interface: QueryEnvironment

Returns the tests associated with the given target.

Specified by:

getTestsForTarget in interface QueryEnvironment<QueryBuildTarget>

Throws:

QueryException

getBuildFiles

public com.google.common.collect.ImmutableSet<QueryFileTarget> getBuildFiles(Set<QueryBuildTarget> targets)

Description copied from interface: QueryEnvironment

Returns the build files that define the given targets.

Specified by:

getBuildFiles in interface QueryEnvironment<QueryBuildTarget>

getFileOwners

public com.google.common.collect.ImmutableSet<QueryBuildTarget> getFileOwners(com.google.common.collect.ImmutableList<String> files)

Description copied from interface: QueryEnvironment

Returns the targets that own one or more of the given files.

Specified by:

getFileOwners in interface QueryEnvironment<QueryBuildTarget>

getTargetKind

public String getTargetKind(QueryBuildTarget target)
                     throws QueryException

Specified by:

getTargetKind in interface QueryEnvironment<QueryBuildTarget>

Throws:

QueryException

getTargetsInAttribute

public com.google.common.collect.ImmutableSet<? extends QueryTarget> getTargetsInAttribute(QueryBuildTarget target,
                                                                                           String attribute)
                                                                                    throws QueryException

Description copied from interface: QueryEnvironment

Returns the existing targets in the value of `attribute` of the given `target`.

Note that unlike most methods in this interface, this method can return a heterogeneous collection of objects that implement QueryTarget.

Specified by:

getTargetsInAttribute in interface QueryEnvironment<QueryBuildTarget>

Throws:

QueryException

filterAttributeContents

public com.google.common.collect.ImmutableSet<Object> filterAttributeContents(QueryBuildTarget target,
                                                                              String attribute,
                                                                              java.util.function.Predicate<Object> predicate)
                                                                       throws QueryException

Description copied from interface: QueryEnvironment

Returns the objects in the `attribute` of the given `target` that satisfy `predicate`

Specified by:

filterAttributeContents in interface QueryEnvironment<QueryBuildTarget>

Throws:

QueryException

getFunctions

public Iterable<QueryEnvironment.QueryFunction<? extends QueryTarget,QueryBuildTarget>> getFunctions()

Description copied from interface: QueryEnvironment

Returns the set of query functions implemented by this query environment.

Specified by:

getFunctions in interface QueryEnvironment<QueryBuildTarget>

getTargetEvaluator

public QueryEnvironment.TargetEvaluator getTargetEvaluator()

Description copied from interface: QueryEnvironment

Returns an evaluator for target patterns.

Specified by:

getTargetEvaluator in interface QueryEnvironment<QueryBuildTarget>