com.facebook.buck.core.starlark.rule

Class SkylarkUserDefinedRule

java.lang.Object

com.google.devtools.build.lib.syntax.BaseFunction

com.facebook.buck.core.starlark.rule.SkylarkUserDefinedRule

All Implemented Interfaces:

com.google.devtools.build.lib.packages.SkylarkExportable, com.google.devtools.build.lib.skylarkinterface.SkylarkPrintable, com.google.devtools.build.lib.skylarkinterface.SkylarkValue, com.google.devtools.build.lib.syntax.StarlarkFunction

public class SkylarkUserDefinedRule
extends com.google.devtools.build.lib.syntax.BaseFunction
implements com.google.devtools.build.lib.packages.SkylarkExportable

The BaseFunction that is returned by `rule()`. Accepts user-specified parameters, and adds invocations to the parse context. Type checking is done with coercion later; it is not checked in this class.

Field Summary

Fields inherited from class com.google.devtools.build.lib.syntax.BaseFunction

enforcedArgumentTypes, location, objectType, paramDoc, signature

Method Summary

Modifier and Type	Method and Description
protected Object	call(Object[] args, com.google.devtools.build.lib.syntax.FuncallExpression ast, com.google.devtools.build.lib.syntax.Environment env)
void	export(com.google.devtools.build.lib.cmdline.Label extensionLabel, String exportedName)
com.google.common.collect.ImmutableMap<String,ParamInfo<?>>	getAllParamInfo() Get ParamInfo objects for all of the Attributes provided to this instance
com.google.common.collect.ImmutableMap<String,Attribute<?>>	getAttrs() The attributes that this function accepts
String	getExportedName() Get the exported name of the function within an extension file.
Set<String>	getHiddenImplicitAttributes()
com.google.devtools.build.lib.cmdline.Label	getLabel() Get the string representation of the label of extension file.
String	getName() Ensure that we only get our name after this function has been exported
boolean	isExported()
static SkylarkUserDefinedRule	of(com.google.devtools.build.lib.events.Location location, com.google.devtools.build.lib.syntax.BaseFunction implementation, com.google.common.collect.ImmutableMap<String,Attribute<?>> implicitAttributes, Set<String> hiddenImplicitAttributes, Map<String,AttributeHolder> attrs, boolean inferRunInfo, boolean test) Create an instance of SkylarkUserDefinedRule
boolean	shouldBeTestRule() Whether this rule is expected to be a test rule or not
boolean	shouldInferRunInfo() Whether RunInfo should be inferred for this rule
String	toString() Override the built-in signature printer, as it prints out '*' unconditionally if all arguments are kwargs

Methods inherited from class com.google.devtools.build.lib.syntax.BaseFunction

call, callWithArgArray, canonicalizeArguments, configure, configure, getArgArraySize, getEnforcedArgumentTypes, getFullName, getLocation, getObjectType, getObjectTypeString, getOrCreateChildEnvironment, getParamDoc, getShortSignature, getSignature, hasSelfArgument, isConfigured, isImmutable, printTypeString, processArguments, repr

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.devtools.build.lib.skylarkinterface.SkylarkValue

isHashable, isImmutable

Methods inherited from interface com.google.devtools.build.lib.skylarkinterface.SkylarkPrintable

debugPrint, repr, str

Method Detail

call

protected Object call(Object[] args,
                      @Nullable
                      com.google.devtools.build.lib.syntax.FuncallExpression ast,
                      com.google.devtools.build.lib.syntax.Environment env)
               throws com.google.devtools.build.lib.syntax.EvalException,
                      InterruptedException

Overrides:

call in class com.google.devtools.build.lib.syntax.BaseFunction

Throws:

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

InterruptedException

toString

public String toString()

Override the built-in signature printer, as it prints out '*' unconditionally if all arguments are kwargs

Overrides:

toString in class com.google.devtools.build.lib.syntax.BaseFunction

of

public static SkylarkUserDefinedRule of(com.google.devtools.build.lib.events.Location location,
                                        com.google.devtools.build.lib.syntax.BaseFunction implementation,
                                        com.google.common.collect.ImmutableMap<String,Attribute<?>> implicitAttributes,
                                        Set<String> hiddenImplicitAttributes,
                                        Map<String,AttributeHolder> attrs,
                                        boolean inferRunInfo,
                                        boolean test)
                                 throws com.google.devtools.build.lib.syntax.EvalException

Create an instance of SkylarkUserDefinedRule

Throws:

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

getName

public String getName()

Ensure that we only get our name after this function has been exported

Overrides:

getName in class com.google.devtools.build.lib.syntax.BaseFunction

getLabel

public com.google.devtools.build.lib.cmdline.Label getLabel()

Get the string representation of the label of extension file. Only may be called after calling export(Label, String)

Returns:

getExportedName

public String getExportedName()

Get the exported name of the function within an extension file. Only may be called after calling export(Label, String)

shouldInferRunInfo

public boolean shouldInferRunInfo()

Whether RunInfo should be inferred for this rule

shouldBeTestRule

public boolean shouldBeTestRule()

Whether this rule is expected to be a test rule or not

isExported

public boolean isExported()

Specified by:

isExported in interface com.google.devtools.build.lib.packages.SkylarkExportable

export

public void export(com.google.devtools.build.lib.cmdline.Label extensionLabel,
                   String exportedName)
            throws com.google.devtools.build.lib.syntax.EvalException

Specified by:

export in interface com.google.devtools.build.lib.packages.SkylarkExportable

Throws:

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

getAttrs

public com.google.common.collect.ImmutableMap<String,Attribute<?>> getAttrs()

The attributes that this function accepts

getAllParamInfo

public com.google.common.collect.ImmutableMap<String,ParamInfo<?>> getAllParamInfo()

Get ParamInfo objects for all of the Attributes provided to this instance

getHiddenImplicitAttributes

public Set<String> getHiddenImplicitAttributes()