com.facebook.buck.parser

Interface Parser

public interface Parser

High-level build file parsing machinery. Primarily responsible for producing a TargetGraph based on a set of targets. Caches build rules to minimise the number of calls to build file interpreter and processes filesystem events to invalidate the cache as files change.

Method Summary

Modifier and Type	Method and Description
TargetGraphCreationResult	buildTargetGraph(ParsingContext parsingContext, com.google.common.collect.ImmutableSet<BuildTarget> toExplore)
TargetGraphCreationResult	buildTargetGraphWithoutTopLevelConfigurationTargets(ParsingContext parsingContext, Iterable<? extends TargetNodeSpec> targetNodeSpecs, Optional<TargetConfiguration> targetConfiguration)
TargetGraphCreationResult	buildTargetGraphWithTopLevelConfigurationTargets(ParsingContext parsingContext, Iterable<? extends TargetNodeSpec> targetNodeSpecs, Optional<TargetConfiguration> targetConfiguration)
com.google.common.collect.ImmutableList<TargetNodeMaybeIncompatible>	getAllTargetNodes(PerBuildState perBuildState, Cell cell, AbsPath buildFile, Optional<TargetConfiguration> targetConfiguration)
com.google.common.collect.ImmutableList<TargetNode<?>>	getAllTargetNodesWithTargetCompatibilityFiltering(PerBuildState state, Cell cell, AbsPath buildFile, Optional<TargetConfiguration> targetConfiguration)
PerBuildStateFactory	getPerBuildStateFactory()
DaemonicParserState	getPermState()
TargetNode<?>	getTargetNodeAssertCompatible(ParsingContext parsingContext, BuildTarget target, DependencyStack dependencyStack)
TargetNode<?>	getTargetNodeAssertCompatible(PerBuildState perBuildState, BuildTarget target, DependencyStack dependencyStack)
com.google.common.util.concurrent.ListenableFuture<TargetNode<?>>	getTargetNodeJobAssertCompatible(PerBuildState perBuildState, BuildTarget target, DependencyStack dependencyStack)
SortedMap<String,Object>	getTargetNodeRawAttributes(ParsingContext parsingContext, TargetNode<?> targetNode, DependencyStack dependencyStack) Deprecated. Prefer getTargetNodeRawAttributes(PerBuildState, Cell, TargetNode, DependencyStack) and reusing a PerBuildState instance, especially when calling in a loop.
SortedMap<String,Object>	getTargetNodeRawAttributes(PerBuildState state, Cell cell, TargetNode<?> targetNode, DependencyStack dependencyStack)
com.google.common.util.concurrent.ListenableFuture<SortedMap<String,Object>>	getTargetNodeRawAttributesJob(PerBuildState state, Cell cell, TargetNode<?> targetNode, DependencyStack dependencyStack)
com.google.common.collect.ImmutableList<com.google.common.collect.ImmutableSet<BuildTarget>>	resolveTargetSpecs(ParsingContext parsingContext, Iterable<? extends TargetNodeSpec> specs, Optional<TargetConfiguration> targetConfiguration)

Method Detail

getPermState

DaemonicParserState getPermState()

getPerBuildStateFactory

PerBuildStateFactory getPerBuildStateFactory()

getTargetNodeAssertCompatible

TargetNode<?> getTargetNodeAssertCompatible(ParsingContext parsingContext,
                                            BuildTarget target,
                                            DependencyStack dependencyStack)
                                     throws BuildFileParseException

Throws:

BuildFileParseException

getAllTargetNodes

com.google.common.collect.ImmutableList<TargetNodeMaybeIncompatible> getAllTargetNodes(PerBuildState perBuildState,
                                                                                       Cell cell,
                                                                                       AbsPath buildFile,
                                                                                       Optional<TargetConfiguration> targetConfiguration)
                                                                                throws BuildFileParseException

Throws:

BuildFileParseException

getAllTargetNodesWithTargetCompatibilityFiltering

com.google.common.collect.ImmutableList<TargetNode<?>> getAllTargetNodesWithTargetCompatibilityFiltering(PerBuildState state,
                                                                                                         Cell cell,
                                                                                                         AbsPath buildFile,
                                                                                                         Optional<TargetConfiguration> targetConfiguration)
                                                                                                  throws BuildFileParseException

Throws:

BuildFileParseException

getTargetNodeAssertCompatible

TargetNode<?> getTargetNodeAssertCompatible(PerBuildState perBuildState,
                                            BuildTarget target,
                                            DependencyStack dependencyStack)
                                     throws BuildFileParseException

Throws:

BuildFileParseException

getTargetNodeJobAssertCompatible

com.google.common.util.concurrent.ListenableFuture<TargetNode<?>> getTargetNodeJobAssertCompatible(PerBuildState perBuildState,
                                                                                                   BuildTarget target,
                                                                                                   DependencyStack dependencyStack)
                                                                                            throws BuildTargetException

Throws:

BuildTargetException

getTargetNodeRawAttributes

@Nullable
SortedMap<String,Object> getTargetNodeRawAttributes(PerBuildState state,
                                                              Cell cell,
                                                              TargetNode<?> targetNode,
                                                              DependencyStack dependencyStack)
                                                       throws BuildFileParseException

Throws:

BuildFileParseException

getTargetNodeRawAttributesJob

com.google.common.util.concurrent.ListenableFuture<SortedMap<String,Object>> getTargetNodeRawAttributesJob(PerBuildState state,
                                                                                                           Cell cell,
                                                                                                           TargetNode<?> targetNode,
                                                                                                           DependencyStack dependencyStack)
                                                                                                    throws BuildFileParseException

Throws:

BuildFileParseException

getTargetNodeRawAttributes

@Nullable
 @Deprecated
SortedMap<String,Object> getTargetNodeRawAttributes(ParsingContext parsingContext,
                                                                           TargetNode<?> targetNode,
                                                                           DependencyStack dependencyStack)
                                                                    throws BuildFileParseException

Deprecated. Prefer getTargetNodeRawAttributes(PerBuildState, Cell, TargetNode, DependencyStack) and reusing a PerBuildState instance, especially when calling in a loop.

Throws:

BuildFileParseException

buildTargetGraph

TargetGraphCreationResult buildTargetGraph(ParsingContext parsingContext,
                                           com.google.common.collect.ImmutableSet<BuildTarget> toExplore)
                                    throws IOException,
                                           InterruptedException,
                                           BuildFileParseException

Throws:

IOException

InterruptedException

BuildFileParseException

buildTargetGraphWithoutTopLevelConfigurationTargets

TargetGraphCreationResult buildTargetGraphWithoutTopLevelConfigurationTargets(ParsingContext parsingContext,
                                                                              Iterable<? extends TargetNodeSpec> targetNodeSpecs,
                                                                              Optional<TargetConfiguration> targetConfiguration)
                                                                       throws BuildFileParseException,
                                                                              IOException,
                                                                              InterruptedException

Parameters:

targetNodeSpecs - the specs representing the build targets to generate a target graph for.

targetConfiguration -

Returns:

the target graph containing the build targets and their related targets.

Throws:

BuildFileParseException

IOException

InterruptedException

buildTargetGraphWithTopLevelConfigurationTargets

TargetGraphCreationResult buildTargetGraphWithTopLevelConfigurationTargets(ParsingContext parsingContext,
                                                                           Iterable<? extends TargetNodeSpec> targetNodeSpecs,
                                                                           Optional<TargetConfiguration> targetConfiguration)
                                                                    throws BuildFileParseException,
                                                                           IOException,
                                                                           InterruptedException

Parameters:

targetNodeSpecs - the specs representing the build targets to generate a target graph for.

targetConfiguration -

Returns:

the target graph containing the build targets and their related targets.

Throws:

BuildFileParseException

IOException

InterruptedException

resolveTargetSpecs

com.google.common.collect.ImmutableList<com.google.common.collect.ImmutableSet<BuildTarget>> resolveTargetSpecs(ParsingContext parsingContext,
                                                                                                                Iterable<? extends TargetNodeSpec> specs,
                                                                                                                Optional<TargetConfiguration> targetConfiguration)
                                                                                                         throws BuildFileParseException,
                                                                                                                InterruptedException

Throws:

BuildFileParseException

InterruptedException