com.facebook.buck.rules.query

Class GraphEnhancementQueryEnvironment

java.lang.Object

com.facebook.buck.rules.query.GraphEnhancementQueryEnvironment

All Implemented Interfaces:

QueryEnvironment<QueryBuildTarget>

public class GraphEnhancementQueryEnvironment
extends Object
implements QueryEnvironment<QueryBuildTarget>

A query environment that can be used for graph-enhancement, including macro expansion or dynamic dependency resolution.

The query environment supports the following functions

  attrfilter
  deps
  inputs
  except
  inputs
  intersect
  filter
  kind
  rdeps
  set
  union
 

This query environment will only parse literal targets or the special macro '$declared_deps', so aliases and other patterns (such as ...) will throw an exception. The $declared_deps macro will evaluate to the declared dependencies passed into the constructor.

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>

Field Summary

Fields

Modifier and Type	Field and Description
static Iterable<QueryEnvironment.QueryFunction<? extends QueryTarget,QueryBuildTarget>>	QUERY_FUNCTIONS

Constructor Summary

Constructors

Constructor and Description
GraphEnhancementQueryEnvironment(Optional<ActionGraphBuilder> graphBuilder, Optional<TargetGraph> targetGraph, TypeCoercerFactory typeCoercerFactory, CellNameResolver cellNames, UnconfiguredBuildTargetViewFactory unconfiguredBuildTargetFactory, BaseName targetBaseName, Set<BuildTarget> declaredDeps, TargetConfiguration targetConfiguration)

Method Summary

Modifier and Type	Method and Description
void	buildTransitiveClosure(Set<? extends QueryTarget> targetNodes, int maxDepth) Construct the dependency graph for a depth-bounded forward transitive closure of all nodes in "targetNodes".
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`
void	forEachFwdDep(Iterable<QueryBuildTarget> targets, java.util.function.Consumer<QueryBuildTarget> action) Applies action to each forward dependencies of the specified targets.
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.
java.util.stream.Stream<QueryTarget>	getFirstOrderClasspath(Set<QueryTarget> targets)
Iterable<QueryEnvironment.QueryFunction<?,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)
Set<QueryBuildTarget>	getReverseDeps(Iterable<QueryBuildTarget> targets) Returns the direct reverse dependencies of the specified targets.
QueryEnvironment.TargetEvaluator	getTargetEvaluator() Returns an evaluator for target patterns.
String	getTargetKind(QueryBuildTarget target)
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.
Set<QueryBuildTarget>	getTransitiveClosure(Set<QueryBuildTarget> targets) Returns the forward transitive closure of all of the targets in "targets".
protected java.util.stream.Stream<QueryTarget>	restrictToInstancesOf(Set<QueryTarget> targets, Class<?> clazz)

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

getTargetsMatchingPattern, resolveTargetVariable

Field Detail

QUERY_FUNCTIONS

public static final Iterable<QueryEnvironment.QueryFunction<? extends QueryTarget,QueryBuildTarget>> QUERY_FUNCTIONS

Constructor Detail

GraphEnhancementQueryEnvironment

public GraphEnhancementQueryEnvironment(Optional<ActionGraphBuilder> graphBuilder,
                                        Optional<TargetGraph> targetGraph,
                                        TypeCoercerFactory typeCoercerFactory,
                                        CellNameResolver cellNames,
                                        UnconfiguredBuildTargetViewFactory unconfiguredBuildTargetFactory,
                                        BaseName targetBaseName,
                                        Set<BuildTarget> declaredDeps,
                                        TargetConfiguration targetConfiguration)

Method Detail

getTargetEvaluator

public QueryEnvironment.TargetEvaluator getTargetEvaluator()

Description copied from interface: QueryEnvironment

Returns an evaluator for target patterns.

Specified by:

getTargetEvaluator in interface QueryEnvironment<QueryBuildTarget>

getFwdDeps

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

Description copied from interface: QueryEnvironment

Returns the direct forward dependencies of the specified targets.

Specified by:

getFwdDeps in interface QueryEnvironment<QueryBuildTarget>

forEachFwdDep

public void forEachFwdDep(Iterable<QueryBuildTarget> targets,
                          java.util.function.Consumer<QueryBuildTarget> action)

Description copied from interface: QueryEnvironment

Applies action to each forward dependencies of the specified targets.

Might apply more than once to the same target, so action should be idempotent.

Specified by:

forEachFwdDep in interface QueryEnvironment<QueryBuildTarget>

getReverseDeps

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

Description copied from interface: QueryEnvironment

Returns the direct reverse dependencies of the specified targets.

Specified by:

getReverseDeps in interface QueryEnvironment<QueryBuildTarget>

getInputs

public Set<QueryFileTarget> getInputs(QueryBuildTarget target)

Specified by:

getInputs in interface QueryEnvironment<QueryBuildTarget>

getTransitiveClosure

public Set<QueryBuildTarget> getTransitiveClosure(Set<QueryBuildTarget> targets)

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>

buildTransitiveClosure

public void buildTransitiveClosure(Set<? extends QueryTarget> targetNodes,
                                   int maxDepth)

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>

getTargetKind

public String getTargetKind(QueryBuildTarget target)

Specified by:

getTargetKind in interface QueryEnvironment<QueryBuildTarget>

getTestsForTarget

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

Description copied from interface: QueryEnvironment

Returns the tests associated with the given target.

Specified by:

getTestsForTarget in interface QueryEnvironment<QueryBuildTarget>

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>

getTargetsInAttribute

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

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>

filterAttributeContents

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

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>

restrictToInstancesOf

protected java.util.stream.Stream<QueryTarget> restrictToInstancesOf(Set<QueryTarget> targets,
                                                                     Class<?> clazz)

Returns:

a filtered stream of targets where the rules they refer to are instances of the given clazz

getFirstOrderClasspath

public java.util.stream.Stream<QueryTarget> getFirstOrderClasspath(Set<QueryTarget> targets)

getFunctions

public Iterable<QueryEnvironment.QueryFunction<?,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>