ParserConfig (Buck)

java.lang.Object
- com.facebook.buck.parser.config.ParserConfig

All Implemented Interfaces:: ConfigView<BuckConfig>

public abstract class ParserConfig
extends Object
implements ConfigView<BuckConfig>

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ParserConfig.AllowSymlinks`
`static class`	`ParserConfig.ApplyDefaultFlavorsMode` Controls whether default flavors should be applied to unflavored targets.
`static class`	`ParserConfig.BuildFileSearchMethod`
`static class`	`ParserConfig.GlobHandler`
`static class`	`ParserConfig.PackageBoundaryEnforcement` How package boundary violation should be enforced
`static class`	`ParserConfig.SkylarkGlobHandler` Glob handler supported by Skylark parser.
`static class`	`ParserConfig.WatchmanGlobSanityCheck`

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`BUILDFILE_SECTION_NAME`
`static boolean`	`DEFAULT_ALLOW_EMPTY_GLOBS`
`static String`	`DEFAULT_BUILD_FILE_NAME`
`static String`	`INCLUDES_PROPERTY_NAME`
`static String`	`PACKAGE_INCLUDES_PROPERTY_NAME`

Constructor Summary

Constructors
Constructor and Description

ParserConfig()

Constructors
Constructor and Description
`ParserConfig()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`AbsPath`	`getAbsolutePathToBuildFile(Cell cell, UnconfiguredBuildTarget target)`
`AbsPath`	`getAbsolutePathToBuildFileUnsafe(Cell cell, UnconfiguredBuildTarget target)` For use in performance-sensitive code or if you don't care if the build file actually exists, otherwise prefer `getAbsolutePathToBuildFile(com.facebook.buck.core.cell.Cell, com.facebook.buck.core.model.UnconfiguredBuildTarget)`.
`boolean`	`getAllowEmptyGlobs()`
`ParserConfig.AllowSymlinks`	`getAllowSymlinks()`
`com.google.common.collect.ImmutableList<Path>`	`getBuckPackageBoundaryExceptions()` A list of absolute paths under which buck package boundary checks should not be performed.
`com.google.common.collect.ImmutableList<String>`	`getBuildFileImportWhitelist()`
`String`	`getBuildFileName()`
`ParserConfig.BuildFileSearchMethod`	`getBuildFileSearchMethod()`
`Syntax`	`getDefaultBuildFileSyntax()`
`ParserConfig.ApplyDefaultFlavorsMode`	`getDefaultFlavorsMode()`
`Iterable<String>`	`getDefaultIncludes()` A (possibly empty) sequence of paths to files that should be included by default when evaluating a build file.
`abstract BuckConfig`	`getDelegate()`
`boolean`	`getEnablePackageFiles()`
`boolean`	`getEnableParallelParsing()`
`boolean`	`getEnableTargetCompatibilityChecks()`
`boolean`	`getEnforceBuckPackageBoundary()`
`ParserConfig.GlobHandler`	`getGlobHandler()`
`Optional<String>`	`getHostPlatform()`
`ImplicitNativeRulesState`	`getImplicitNativeRulesState()`
`boolean`	`getLogPackageBoundaryExceptionViolations()`
`int`	`getMissingTargetLevenshteinDistance()`
`int`	`getNumParsingThreads()`
`ParserConfig.PackageBoundaryEnforcement`	`getPackageBoundaryEnforcementPolicy(Path path)` Whether the cell is enforcing buck package boundaries for the package at the passed path.
`com.google.common.collect.ImmutableMap<String,ImplicitInclude>`	`getPackageImplicitIncludes()`
`Optional<String>`	`getParserPythonInterpreterPath()`
`int`	`getParserTargetThreshold()`
`Optional<String>`	`getPythonModuleSearchPath()` Returns the module search path PYTHONPATH to set for the parser, as specified by the 'python_path' key of the 'parser' section.
`Optional<com.google.common.collect.ImmutableList<Path>>`	`getReadOnlyPaths()`
`boolean`	`getRequireTargetPlatform()` When set, requested target node will fail to configure if platform is not specified either per-target with `default_target_platform` or globally with `--target-platforms=` command line flag.
`ParserConfig.SkylarkGlobHandler`	`getSkylarkGlobHandler()`
`String`	`getTargetPlatformDetectorSpec()`
`Optional<String>`	`getTargetPlatforms()`
`UserDefinedRulesState`	`getUserDefinedRulesState()`
`boolean`	`getWatchCells()`
`WatchmanWatcher.CursorType`	`getWatchmanCursor()`
`ParserConfig.WatchmanGlobSanityCheck`	`getWatchmanGlobSanityCheck()`
`Optional<Long>`	`getWatchmanQueryTimeoutMs()`
`boolean`	`isPolyglotParsingEnabled()`
`boolean`	`isWarnAboutDeprecatedSyntax()`
`static ParserConfig`	`of(BuckConfig delegate)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_ALLOW_EMPTY_GLOBS
```
public static final boolean DEFAULT_ALLOW_EMPTY_GLOBS
```
    See Also:
    
    Constant Field Values
  - DEFAULT_BUILD_FILE_NAME
```
public static final String DEFAULT_BUILD_FILE_NAME
```
    See Also:
    
    Constant Field Values
  - BUILDFILE_SECTION_NAME
```
public static final String BUILDFILE_SECTION_NAME
```
    See Also:
    
    Constant Field Values
  - INCLUDES_PROPERTY_NAME
```
public static final String INCLUDES_PROPERTY_NAME
```
    See Also:
    
    Constant Field Values
  - PACKAGE_INCLUDES_PROPERTY_NAME
```
public static final String PACKAGE_INCLUDES_PROPERTY_NAME
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ParserConfig
```
public ParserConfig()
```
- Method Detail
  - getDelegate
```
public abstract BuckConfig getDelegate()
```
    Specified by:
    
    getDelegate in interface ConfigView<BuckConfig>
  - of
```
public static ParserConfig of(BuckConfig delegate)
```
  - getAllowEmptyGlobs
```
@Value.Lazy
public boolean getAllowEmptyGlobs()
```
  - getBuildFileName
```
@Value.Lazy
public String getBuildFileName()
```
  - getDefaultIncludes
```
@Value.Lazy
public Iterable<String> getDefaultIncludes()
```
    A (possibly empty) sequence of paths to files that should be included by default when evaluating a build file.
  - getPackageImplicitIncludes
```
@Value.Lazy
public com.google.common.collect.ImmutableMap<String,ImplicitInclude> getPackageImplicitIncludes()
```
  - getEnforceBuckPackageBoundary
```
@Value.Lazy
public boolean getEnforceBuckPackageBoundary()
```
  - getBuckPackageBoundaryExceptions
```
@Value.Lazy
public com.google.common.collect.ImmutableList<Path> getBuckPackageBoundaryExceptions()
```
    A list of absolute paths under which buck package boundary checks should not be performed.
  - getReadOnlyPaths
```
@Value.Lazy
public Optional<com.google.common.collect.ImmutableList<Path>> getReadOnlyPaths()
```
  - getAllowSymlinks
```
@Value.Lazy
public ParserConfig.AllowSymlinks getAllowSymlinks()
```
  - getBuildFileSearchMethod
```
@Value.Lazy
public ParserConfig.BuildFileSearchMethod getBuildFileSearchMethod()
```
  - getGlobHandler
```
@Value.Lazy
public ParserConfig.GlobHandler getGlobHandler()
```
  - getWatchmanGlobSanityCheck
```
@Value.Lazy
public ParserConfig.WatchmanGlobSanityCheck getWatchmanGlobSanityCheck()
```
  - getWatchmanQueryTimeoutMs
```
@Value.Lazy
public Optional<Long> getWatchmanQueryTimeoutMs()
```
  - getWatchCells
```
@Value.Lazy
public boolean getWatchCells()
```
  - getWatchmanCursor
```
@Value.Lazy
public WatchmanWatcher.CursorType getWatchmanCursor()
```
  - getEnableParallelParsing
```
@Value.Lazy
public boolean getEnableParallelParsing()
```
  - getNumParsingThreads
```
@Value.Lazy
public int getNumParsingThreads()
```
  - getDefaultFlavorsMode
```
@Value.Lazy
public ParserConfig.ApplyDefaultFlavorsMode getDefaultFlavorsMode()
```
  - getBuildFileImportWhitelist
```
@Value.Lazy
public com.google.common.collect.ImmutableList<String> getBuildFileImportWhitelist()
```
  - getParserPythonInterpreterPath
```
@Value.Lazy
public Optional<String> getParserPythonInterpreterPath()
```
  - getPythonModuleSearchPath
```
@Value.Lazy
public Optional<String> getPythonModuleSearchPath()
```
    Returns the module search path PYTHONPATH to set for the parser, as specified by the 'python_path' key of the 'parser' section.
    
    Returns:
    
    The PYTHONPATH value or an empty string if not set.
  - isPolyglotParsingEnabled
```
@Value.Lazy
public boolean isPolyglotParsingEnabled()
```
    Returns:
    
    boolean flag indicating whether support for parsing build files using non default syntax (currently Python DSL).
    For a list of supported syntax see Syntax.
  - getDefaultBuildFileSyntax
```
@Value.Lazy
public Syntax getDefaultBuildFileSyntax()
```
    Returns:
    
    a syntax to assume for build files without explicit build file syntax marker. *
    For a list of supported syntax see Syntax.
  - getImplicitNativeRulesState
```
@Value.Lazy
public ImplicitNativeRulesState getImplicitNativeRulesState()
```
    Returns:
    
    whether native build rules are available for users in build files. If not, they are only accessible in extension files under the 'native' object
  - isWarnAboutDeprecatedSyntax
```
@Value.Lazy
public boolean isWarnAboutDeprecatedSyntax()
```
    Returns:
    
    whether Buck should warn about deprecated syntax.
  - getSkylarkGlobHandler
```
@Value.Lazy
public ParserConfig.SkylarkGlobHandler getSkylarkGlobHandler()
```
    Returns:
    
    the type of the glob handler used by the Skylark parser.
  - getParserTargetThreshold
```
@Value.Lazy
public int getParserTargetThreshold()
```
    Returns:
    
    the parser target threshold. When the current targets produced exceed this value, a warning is emitted.
  - getEnableTargetCompatibilityChecks
```
@Value.Lazy
public boolean getEnableTargetCompatibilityChecks()
```
  - getRequireTargetPlatform
```
@Value.Lazy
public boolean getRequireTargetPlatform()
```
    When set, requested target node will fail to configure if platform is not specified either per-target with default_target_platform or globally with --target-platforms= command line flag.
  - getTargetPlatformDetectorSpec
```
@Value.Lazy
public String getTargetPlatformDetectorSpec()
```
  - getTargetPlatforms
```
@Value.Lazy
public Optional<String> getTargetPlatforms()
```
    Returns:
    
    a target that points to a platform rule that describes the target platforms. This is used when command-line argument is unspecified. Please do not use this option.
  - getHostPlatform
```
@Value.Lazy
public Optional<String> getHostPlatform()
```
    Returns:
    
    a target that points to a platform rule that describes the host platforms. This is used when command-line argument is unspecified. Please do not use this option.
  - getAbsolutePathToBuildFileUnsafe
```
public AbsPath getAbsolutePathToBuildFileUnsafe(Cell cell,
                                                UnconfiguredBuildTarget target)
```
    For use in performance-sensitive code or if you don't care if the build file actually exists, otherwise prefer getAbsolutePathToBuildFile(com.facebook.buck.core.cell.Cell, com.facebook.buck.core.model.UnconfiguredBuildTarget).
    
    Parameters:
    
    cell - the cell where the given target is defined
    
    target - target to look up
    
    Returns:
    
    path which may or may not exist.
  - getAbsolutePathToBuildFile
```
public AbsPath getAbsolutePathToBuildFile(Cell cell,
                                          UnconfiguredBuildTarget target)
                                   throws MissingBuildFileException
```
    Parameters:
    
    cell - the cell where the given target is defined
    
    target - target to look up
    
    Returns:
    
    an absolute path to a build file that contains the definition of the given target.
    
    Throws:
    
    MissingBuildFileException
  - getLogPackageBoundaryExceptionViolations
```
@Value.Lazy
public boolean getLogPackageBoundaryExceptionViolations()
```
  - getPackageBoundaryEnforcementPolicy
```
public ParserConfig.PackageBoundaryEnforcement getPackageBoundaryEnforcementPolicy(Path path)
```
    Whether the cell is enforcing buck package boundaries for the package at the passed path.
    
    Parameters:
    
    path - Path of package (or file in a package) relative to the cell root.
    
    Returns:
    
    How to enforce buck package boundaries for path
  - getUserDefinedRulesState
```
@Value.Lazy
public UserDefinedRulesState getUserDefinedRulesState()
```
    Returns:
    
    whether to enable user-defined rule in .bzl files and export various symbols (such as rule()) into the evaluation context. This is disabled if RuleAnalysisComputation is also disabled. This is in progress work, and experimental at this time.
  - getEnablePackageFiles
```
@Value.Lazy
public boolean getEnablePackageFiles()
```
    Returns:
    
    Whether to enable parsing of PACKAGE files and apply their attributes to nodes.
  - getMissingTargetLevenshteinDistance
```
@Value.Lazy
public int getMissingTargetLevenshteinDistance()
```

Class ParserConfig

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_ALLOW_EMPTY_GLOBS

DEFAULT_BUILD_FILE_NAME

BUILDFILE_SECTION_NAME

INCLUDES_PROPERTY_NAME

PACKAGE_INCLUDES_PROPERTY_NAME

Constructor Detail

ParserConfig

Method Detail

getDelegate

of

getAllowEmptyGlobs

getBuildFileName

getDefaultIncludes

getPackageImplicitIncludes

getEnforceBuckPackageBoundary

getBuckPackageBoundaryExceptions

getReadOnlyPaths

getAllowSymlinks

getBuildFileSearchMethod

getGlobHandler

getWatchmanGlobSanityCheck

getWatchmanQueryTimeoutMs

getWatchCells

getWatchmanCursor

getEnableParallelParsing

getNumParsingThreads

getDefaultFlavorsMode

getBuildFileImportWhitelist

getParserPythonInterpreterPath

getPythonModuleSearchPath

isPolyglotParsingEnabled

getDefaultBuildFileSyntax

getImplicitNativeRulesState

isWarnAboutDeprecatedSyntax

getSkylarkGlobHandler

getParserTargetThreshold

getEnableTargetCompatibilityChecks

getRequireTargetPlatform

getTargetPlatformDetectorSpec

getTargetPlatforms

getHostPlatform

getAbsolutePathToBuildFileUnsafe

getAbsolutePathToBuildFile

getLogPackageBoundaryExceptionViolations

getPackageBoundaryEnforcementPolicy

getUserDefinedRulesState

getEnablePackageFiles

getMissingTargetLevenshteinDistance