com.facebook.buck.skylark.parser

Class SkylarkProjectBuildFileParser

java.lang.Object

com.facebook.buck.skylark.parser.SkylarkProjectBuildFileParser

All Implemented Interfaces:

FileParser<BuildFileManifest>, ProjectBuildFileParser, UserDefinedRuleLoader, AutoCloseable

public class SkylarkProjectBuildFileParser
extends Object
implements ProjectBuildFileParser, UserDefinedRuleLoader

Parser for build files written using Skylark syntax.

NOTE: This parser is still a work in progress and does not support some functions provided by Python DSL parser like include_defs, so use in production at your own risk.

Field Summary

Fields

Modifier and Type	Field and Description
protected BuckGlobals	buckGlobals
protected com.google.devtools.build.lib.events.EventHandler	eventHandler
protected com.google.devtools.build.lib.vfs.FileSystem	fileSystem
protected ProjectBuildFileParserOptions	options

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SkylarkProjectBuildFileParser(SkylarkProjectBuildFileParser other)

Method Summary

Modifier and Type	Method and Description
protected com.facebook.buck.skylark.parser.ExtensionData	buildExtensionData(com.facebook.buck.skylark.parser.AbstractSkylarkFileParser.ExtensionLoadState load) Given fully loaded extension represented by ExtensionLoadState, evaluates extension and returns ExtensionData
void	close()
protected com.google.devtools.build.lib.cmdline.Label	createContainingLabel(String basePath)
com.google.common.collect.ImmutableSortedSet<String>	getIncludedFiles(Path parseFile) 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.
protected com.google.common.collect.ImmutableList<com.facebook.buck.skylark.parser.ExtensionData>	loadExtensions(com.google.devtools.build.lib.cmdline.Label containingLabel, com.google.common.collect.ImmutableList<com.google.devtools.build.lib.syntax.SkylarkImport> skylarkImports) Loads all extensions identified by corresponding SkylarkImports.
void	loadExtensionsForUserDefinedRules(Path buildFile, BuildFileManifest manifest) Loads all of the extensions mentioned in a build manifest
protected ParseResult	parse(Path parseFile)
protected com.google.devtools.build.lib.syntax.BuildFileAST	readSkylarkAST(com.google.devtools.build.lib.vfs.Path path, FileKind fileKind) Reads file and returns abstract syntax tree for that file.
void	reportProfile() Reports profile information captured while parsing build files.
static SkylarkProjectBuildFileParser	using(ProjectBuildFileParserOptions options, BuckEventBus buckEventBus, com.google.devtools.build.lib.vfs.FileSystem fileSystem, BuckGlobals buckGlobals, com.google.devtools.build.lib.events.EventHandler eventHandler, GlobberFactory globberFactory) Create an instance of Skylark project build file parser using provided options.

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.parser.api.FileParser

close, getIncludedFiles

Field Detail

fileSystem

protected final com.google.devtools.build.lib.vfs.FileSystem fileSystem

options

protected final ProjectBuildFileParserOptions options

eventHandler

protected final com.google.devtools.build.lib.events.EventHandler eventHandler

buckGlobals

protected final BuckGlobals buckGlobals

Constructor Detail

SkylarkProjectBuildFileParser

protected SkylarkProjectBuildFileParser(SkylarkProjectBuildFileParser other)

Method Detail

using

public static SkylarkProjectBuildFileParser using(ProjectBuildFileParserOptions options,
                                                  BuckEventBus buckEventBus,
                                                  com.google.devtools.build.lib.vfs.FileSystem fileSystem,
                                                  BuckGlobals buckGlobals,
                                                  com.google.devtools.build.lib.events.EventHandler eventHandler,
                                                  GlobberFactory globberFactory)

Create an instance of Skylark project build file parser using provided options.

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()

Description copied from interface: ProjectBuildFileParser

Reports profile information captured while parsing build files.

Specified by:

reportProfile in interface ProjectBuildFileParser

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

loadExtensionsForUserDefinedRules

public void loadExtensionsForUserDefinedRules(Path buildFile,
                                              BuildFileManifest manifest)

Description copied from interface: UserDefinedRuleLoader

Loads all of the extensions mentioned in a build manifest

Specified by:

loadExtensionsForUserDefinedRules in interface UserDefinedRuleLoader

Parameters:

buildFile - The full path to the build file

manifest - The manifest from parsing a build file

parse

protected ParseResult parse(Path parseFile)
                     throws IOException,
                            BuildFileParseException,
                            InterruptedException

Returns:

The parsed result defined in parseFile.

Throws:

IOException

BuildFileParseException

InterruptedException

createContainingLabel

protected com.google.devtools.build.lib.cmdline.Label createContainingLabel(String basePath)

readSkylarkAST

protected com.google.devtools.build.lib.syntax.BuildFileAST readSkylarkAST(com.google.devtools.build.lib.vfs.Path path,
                                                                           FileKind fileKind)
                                                                    throws IOException

Reads file and returns abstract syntax tree for that file.

Parameters:

path - file path to read the data from.

Returns:

abstract syntax tree; does not handle any errors.

Throws:

IOException

loadExtensions

protected com.google.common.collect.ImmutableList<com.facebook.buck.skylark.parser.ExtensionData> loadExtensions(com.google.devtools.build.lib.cmdline.Label containingLabel,
                                                                                                                 com.google.common.collect.ImmutableList<com.google.devtools.build.lib.syntax.SkylarkImport> skylarkImports)
                                                                                                          throws BuildFileParseException,
                                                                                                                 IOException,
                                                                                                                 InterruptedException

Loads all extensions identified by corresponding SkylarkImports.

Throws:

BuildFileParseException

IOException

InterruptedException

buildExtensionData

protected com.facebook.buck.skylark.parser.ExtensionData buildExtensionData(com.facebook.buck.skylark.parser.AbstractSkylarkFileParser.ExtensionLoadState load)
                                                                     throws InterruptedException

Given fully loaded extension represented by ExtensionLoadState, evaluates extension and returns ExtensionData

Parameters:

load - ExtensionLoadState representing loaded extension

Throws:

InterruptedException

getIncludedFiles

public com.google.common.collect.ImmutableSortedSet<String> getIncludedFiles(Path parseFile)
                                                                      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<T extends FileManifest>

Parameters:

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

Throws:

BuildFileParseException

InterruptedException

IOException

close

public void close()
           throws BuildFileParseException

Specified by:

close in interface FileParser<T extends FileManifest>

Specified by:

close in interface AutoCloseable

Throws:

BuildFileParseException