com.facebook.buck.parser

Class HybridProjectBuildFileParser

java.lang.Object

com.facebook.buck.parser.HybridProjectBuildFileParser

All Implemented Interfaces:

FileParser<BuildFileManifest>, ProjectBuildFileParser, AutoCloseable

public class HybridProjectBuildFileParser
extends Object
implements ProjectBuildFileParser

Hybrid project build file parser that uses Python DSL, Skylark or any other Syntax depending on which one is requested for the individual build file.

The default syntax determines the syntax used in cases when marker is not used, but clients can explicitly request desired syntax by adding parser directive to the beginning of the build file followed by one of the supported Syntax values.

Note that default syntax is not used in cases when invalid syntax value is provided - instead in such cases an exception is thrown.

Method Summary

Modifier and Type	Method and Description
void	close()
com.google.common.collect.ImmutableSortedSet<String>	getIncludedFiles(Path buildFile) Collects the loaded files and extensions when parsing the parseFile build spec.
BuildFileManifest	getManifest(Path buildFile) Collect all information from a particular, along with metadata about the information, for example which other files were also parsed.
boolean	globResultsMatchCurrentState(Path buildFile, com.google.common.collect.ImmutableList<GlobSpecWithResult> existingGlobsWithResults) Checks if existing GlobSpecs with results are the same as current state in the file system.
void	reportProfile() Reports profile information captured while parsing build files.
static HybridProjectBuildFileParser	using(com.google.common.collect.ImmutableMap<Syntax,ProjectBuildFileParser> parsers, Syntax defaultSyntax)

Methods inherited from class java.lang.Object

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

Method Detail

getManifest

public BuildFileManifest getManifest(Path buildFile)
                              throws BuildFileParseException,
                                     InterruptedException,
                                     IOException

Description copied from interface: FileParser

Collect all information from a particular, along with metadata about the information, for example which other files were also parsed.

Specified by:

getManifest in interface FileParser<BuildFileManifest>

Parameters:

buildFile - should be an absolute path to a file. Must have rootPath as its prefix.

Throws:

BuildFileParseException

InterruptedException

IOException

reportProfile

public void reportProfile()
                   throws IOException

Description copied from interface: ProjectBuildFileParser

Reports profile information captured while parsing build files.

Specified by:

reportProfile in interface ProjectBuildFileParser

Throws:

IOException

getIncludedFiles

public com.google.common.collect.ImmutableSortedSet<String> getIncludedFiles(Path buildFile)
                                                                      throws BuildFileParseException,
                                                                             InterruptedException,
                                                                             IOException

Description copied from interface: FileParser

Collects the loaded files and extensions when parsing the parseFile build spec.

Specified by:

getIncludedFiles in interface FileParser<BuildFileManifest>

Parameters:

buildFile - should be an absolute path to a file. Must have rootPath as its prefix.

Throws:

BuildFileParseException

InterruptedException

IOException

globResultsMatchCurrentState

public boolean globResultsMatchCurrentState(Path buildFile,
                                            com.google.common.collect.ImmutableList<GlobSpecWithResult> existingGlobsWithResults)
                                     throws IOException,
                                            InterruptedException

Description copied from interface: ProjectBuildFileParser

Checks if existing GlobSpecs with results are the same as current state in the file system.

Specified by:

globResultsMatchCurrentState in interface ProjectBuildFileParser

Parameters:

buildFile - the buildFile location to be used by the Globber.

existingGlobsWithResults - the existing (deserialized) GlobSpecWithResult to check the file system state against.

Returns:

true if glob expansion produces results matching previously recorded ones, false otherwise.

Throws:

IOException

InterruptedException

close

public void close()
           throws BuildFileParseException,
                  InterruptedException,
                  IOException

Specified by:

close in interface FileParser<BuildFileManifest>

Specified by:

close in interface AutoCloseable

Throws:

BuildFileParseException

InterruptedException

IOException

using

public static HybridProjectBuildFileParser using(com.google.common.collect.ImmutableMap<Syntax,ProjectBuildFileParser> parsers,
                                                 Syntax defaultSyntax)

Returns:

The hybrid parser that supports Python DSL and Skylark syntax.