com.facebook.buck.skylark.function

Class SkylarkRuleFunctions

java.lang.Object

com.facebook.buck.skylark.function.SkylarkRuleFunctions

All Implemented Interfaces:

SkylarkRuleFunctionsApi

public class SkylarkRuleFunctions
extends Object
implements SkylarkRuleFunctionsApi

Provides APIs for creating build rules.

Field Summary

Fields

Modifier and Type	Field and Description
static Set<String>	HIDDEN_IMPLICIT_ATTRIBUTES The hidden attributes from IMPLICIT_ATTRIBUTES that are hidden from user's for user defined rules
static com.google.common.collect.ImmutableMap<String,Attribute<?>>	IMPLICIT_ATTRIBUTES The attributes that are applicable to all rules.
static com.google.common.collect.ImmutableMap<String,Attribute<?>>	IMPLICIT_TEST_ATTRIBUTES

Constructor Summary

Constructors

Constructor and Description
SkylarkRuleFunctions(com.google.common.cache.LoadingCache<String,com.google.devtools.build.lib.cmdline.Label> labelCache)

Method Summary

Modifier and Type	Method and Description
com.google.devtools.build.lib.cmdline.Label	label(String labelString, com.google.devtools.build.lib.events.Location loc, com.google.devtools.build.lib.syntax.Environment env, com.google.devtools.build.lib.skylarkinterface.StarlarkContext context)
UserDefinedProvider	provider(String doc, Object fields, com.google.devtools.build.lib.events.Location location)
SkylarkUserDefinedRule	rule(com.google.devtools.build.lib.syntax.BaseFunction implementation, com.google.devtools.build.lib.syntax.SkylarkDict<String,AttributeHolder> attrs, boolean inferRunInfo, boolean test, com.google.devtools.build.lib.events.Location loc, com.google.devtools.build.lib.syntax.FuncallExpression ast, 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

Field Detail

IMPLICIT_ATTRIBUTES

public static final com.google.common.collect.ImmutableMap<String,Attribute<?>> IMPLICIT_ATTRIBUTES

The attributes that are applicable to all rules. This will expand over time.

IMPLICIT_TEST_ATTRIBUTES

public static final com.google.common.collect.ImmutableMap<String,Attribute<?>> IMPLICIT_TEST_ATTRIBUTES

HIDDEN_IMPLICIT_ATTRIBUTES

public static final Set<String> HIDDEN_IMPLICIT_ATTRIBUTES

The hidden attributes from IMPLICIT_ATTRIBUTES that are hidden from user's for user defined rules

Constructor Detail

SkylarkRuleFunctions

public SkylarkRuleFunctions(com.google.common.cache.LoadingCache<String,com.google.devtools.build.lib.cmdline.Label> labelCache)

Method Detail

label

public com.google.devtools.build.lib.cmdline.Label label(String labelString,
                                                         com.google.devtools.build.lib.events.Location loc,
                                                         com.google.devtools.build.lib.syntax.Environment env,
                                                         com.google.devtools.build.lib.skylarkinterface.StarlarkContext context)
                                                  throws com.google.devtools.build.lib.syntax.EvalException

Specified by:

label in interface SkylarkRuleFunctionsApi

Throws:

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

rule

public SkylarkUserDefinedRule rule(com.google.devtools.build.lib.syntax.BaseFunction implementation,
                                   com.google.devtools.build.lib.syntax.SkylarkDict<String,AttributeHolder> attrs,
                                   boolean inferRunInfo,
                                   boolean test,
                                   com.google.devtools.build.lib.events.Location loc,
                                   com.google.devtools.build.lib.syntax.FuncallExpression ast,
                                   com.google.devtools.build.lib.syntax.Environment env)
                            throws com.google.devtools.build.lib.syntax.EvalException

Specified by:

rule in interface SkylarkRuleFunctionsApi

Throws:

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

provider

public UserDefinedProvider provider(String doc,
                                    Object fields,
                                    com.google.devtools.build.lib.events.Location location)
                             throws com.google.devtools.build.lib.syntax.EvalException

Specified by:

provider in interface SkylarkRuleFunctionsApi

Throws:

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