com.facebook.buck.skylark.parser

Class SkylarkPackageFileParser

java.lang.Object

com.facebook.buck.skylark.parser.SkylarkPackageFileParser

All Implemented Interfaces:

FileParser<PackageFileManifest>, PackageFileParser, AutoCloseable

public class SkylarkPackageFileParser
extends Object
implements PackageFileParser

Parser for package files written using Skylark syntax.

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

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.
PackageFileManifest	getManifest(Path packageFile) Collect all information from a particular, along with metadata about the information, for example which other files were also parsed.
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.
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.
static SkylarkPackageFileParser	using(ProjectBuildFileParserOptions options, BuckEventBus buckEventBus, com.google.devtools.build.lib.vfs.FileSystem fileSystem, BuckGlobals buckGlobals, com.google.devtools.build.lib.events.EventHandler eventHandler) Create an instance of Skylark package 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

Method Detail

using

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

Create an instance of Skylark package file parser using provided options.

getManifest

public PackageFileManifest getManifest(Path packageFile)
                                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<PackageFileManifest>

Parameters:

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

Throws:

BuildFileParseException

InterruptedException

IOException

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