com.facebook.buck.skylark.parser.context

Class ParseContext

java.lang.Object

com.facebook.buck.skylark.parser.context.ParseContext

public class ParseContext
extends Object

Tracks parse context.

This class provides API to record information retrieved while parsing a build or package file like parsed rules or a package definition.

Constructor Summary

Constructors

Constructor and Description
ParseContext(PackageContext packageContext)

Method Summary

Modifier and Type	Method and Description
com.google.common.collect.ImmutableMap<String,com.google.common.collect.ImmutableMap<String,Optional<String>>>	getAccessedConfigurationOptions()
PackageMetadata	getPackage()
PackageContext	getPackageContext() Returns a context of the package currently being parsed.
static ParseContext	getParseContext(com.google.devtools.build.lib.syntax.Environment env, com.google.devtools.build.lib.syntax.FuncallExpression ast) Get the ParseContext by looking up in the environment.
com.google.common.collect.ImmutableMap<String,com.google.common.collect.ImmutableMap<String,Object>>	getRecordedRules()
boolean	hasRule(String name)
void	recordPackage(PackageMetadata pkg, com.google.devtools.build.lib.syntax.FuncallExpression ast) Records the parsed rawPackage.
void	recordReadConfigurationOption(String section, String key, String value) Records an accessed section.key configuration and its returned value.
void	recordRule(com.google.common.collect.ImmutableMap<String,Object> rawRule, com.google.devtools.build.lib.syntax.FuncallExpression ast) Records the parsed rawRule.
void	setup(com.google.devtools.build.lib.syntax.Environment env)

Methods inherited from class java.lang.Object

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

Constructor Detail

ParseContext

public ParseContext(PackageContext packageContext)

Method Detail

recordPackage

public void recordPackage(PackageMetadata pkg,
                          com.google.devtools.build.lib.syntax.FuncallExpression ast)
                   throws com.google.devtools.build.lib.syntax.EvalException

Records the parsed rawPackage.

Throws:

com.google.devtools.build.lib.syntax.EvalException

recordRule

public void recordRule(com.google.common.collect.ImmutableMap<String,Object> rawRule,
                       com.google.devtools.build.lib.syntax.FuncallExpression ast)
                throws com.google.devtools.build.lib.syntax.EvalException

Records the parsed rawRule.

Throws:

com.google.devtools.build.lib.syntax.EvalException

recordReadConfigurationOption

public void recordReadConfigurationOption(String section,
                                          String key,
                                          @Nullable
                                          String value)

Records an accessed section.key configuration and its returned value.

It's safe to not have to override existing values because configuration options are frozen for the duration of build file parsing.

getPackage

public PackageMetadata getPackage()

Returns:

The package in the parsed package file if defined.

getRecordedRules

public com.google.common.collect.ImmutableMap<String,com.google.common.collect.ImmutableMap<String,Object>> getRecordedRules()

Returns:

The list of raw build rules discovered in parsed build file. Raw rule is presented as a map with attributes as keys and parameters as values.

hasRule

public boolean hasRule(String name)

Returns:

true if the rule with provided name exists, false otherwise.

getAccessedConfigurationOptions

public com.google.common.collect.ImmutableMap<String,com.google.common.collect.ImmutableMap<String,Optional<String>>> getAccessedConfigurationOptions()

getPackageContext

public PackageContext getPackageContext()

Returns a context of the package currently being parsed.

getParseContext

public static ParseContext getParseContext(com.google.devtools.build.lib.syntax.Environment env,
                                           com.google.devtools.build.lib.syntax.FuncallExpression ast)
                                    throws com.google.devtools.build.lib.syntax.EvalException

Get the ParseContext by looking up in the environment.

Throws:

com.google.devtools.build.lib.syntax.EvalException

setup

public void setup(com.google.devtools.build.lib.syntax.Environment env)