com.facebook.buck.core.starlark.compatible

Class BuckStarlarkFunction

java.lang.Object

com.facebook.buck.core.starlark.compatible.BuckStarlarkFunction

All Implemented Interfaces:

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

Direct Known Subclasses:

BuiltInProvider

public abstract class BuckStarlarkFunction
extends Object
implements com.google.devtools.build.lib.syntax.StarlarkFunction

Marker class that makes some method exposable to skylark.

This class currently doesn't handle optionals and other java/skylark object coercing.

Constructor Summary

Constructors

Constructor and Description
BuckStarlarkFunction(String methodName, Constructor<?> constructor, List<String> namedParams, List<String> defaultSkylarkValues, Set<String> noneableParams) Creates a new skylark callable function of the given name that invokes the method handle.
BuckStarlarkFunction(String methodName, Method method, List<String> namedParams, List<String> defaultSkylarkValues, Set<String> noneableParams) Creates a new skylark callable function of the given name that invokes the method handle.

Method Summary

Modifier and Type	Method and Description
Object	call(List<Object> args, Map<String,Object> kwargs, com.google.devtools.build.lib.syntax.FuncallExpression nullableAst, com.google.devtools.build.lib.syntax.Environment env)
String	getName()
void	repr(com.google.devtools.build.lib.skylarkinterface.SkylarkPrinter printer)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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, str

Constructor Detail

BuckStarlarkFunction

public BuckStarlarkFunction(String methodName,
                            Constructor<?> constructor,
                            List<String> namedParams,
                            List<String> defaultSkylarkValues,
                            Set<String> noneableParams)

Creates a new skylark callable function of the given name that invokes the method handle. The named parameters for skylark is the list of namedParams, which is mapped in order to the end of the parameter list for the method handle.

Parameters:

methodName - the function name exposed to skylark

constructor - the constructor that we will call as a method

namedParams - a list of named parameters for skylark. The names are mapped in order to the parameters of constructor

defaultSkylarkValues - a list of default values for parameters in skylark. The names are mapped in order to the parameters of constructor

BuckStarlarkFunction

public BuckStarlarkFunction(String methodName,
                            Method method,
                            List<String> namedParams,
                            List<String> defaultSkylarkValues,
                            Set<String> noneableParams)

Creates a new skylark callable function of the given name that invokes the method handle. The named parameters for skylark is the list of namedParams, which is mapped in order to the end of the parameter list for the method handle.

Parameters:

methodName - the function name exposed to skylark

method - a method that will eventually be called in call(List, Map, FuncallExpression, Environment)

namedParams - a list of named parameters for skylark. The names are mapped in order to the parameters of method

defaultSkylarkValues - a list of default values for parameters in skylark. The values are mapped in order to the parameters of method

Method Detail

call

public Object call(List<Object> args,
                   @Nullable
                   Map<String,Object> kwargs,
                   @Nullable
                   com.google.devtools.build.lib.syntax.FuncallExpression nullableAst,
                   com.google.devtools.build.lib.syntax.Environment env)
            throws com.google.devtools.build.lib.syntax.EvalException,
                   InterruptedException

Specified by:

call in interface com.google.devtools.build.lib.syntax.StarlarkFunction

Throws:

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

InterruptedException

repr

public void repr(com.google.devtools.build.lib.skylarkinterface.SkylarkPrinter printer)

Specified by:

repr in interface com.google.devtools.build.lib.skylarkinterface.SkylarkPrintable

getName

public String getName()