View source for Function (extension point)

== Description ==
Using this extension plug-in can define JavaScript functions that will be available from JavaScipt shell. Plug-in functions will be shown under analyses/JavaScript/functions section in [[repository]] tree. Function help will be shown in [[information box]] when the function item will be selected in repository tree.

When the JavaScript function is called the specified by extension class method will be invoked. The METHOD must match one of two forms: with  fixed or variable number of arguments.

=== Fixed arguments number ===
The first form is a member with zero or more parameters of the following types: {{Class|org.mozilla.javascript.Scriptable}}, {{Class|java.lang.Object}}, {{Class|java.lang.String}}, boolean, byte, short, int, float, or double. The long type is not supported because the double representation of a long (which is the EMCA-mandated storage type for Numbers) may lose precision. The return value must be void or one of the types allowed for parameters.

The runtime will perform appropriate conversions based upon the type of the parameter. A parameter type of {{Class|java.lang.Object}} specifies that no conversions are to be done. A parameter of type {{Class|java.lang.String}} will use {{Method|org.mozilla.javascript.Context.toString}} to convert arguments. Similarly, parameters of type double, boolean, and {{Class|org.mozilla.javascript.Scriptable}} will cause {{Method|org.mozilla.javascript.Context.toNumber}}, {{Method|org.mozilla.javascript.Context.toBoolean}}, and {{Method|org.mozilla.javascript.Context.toObject}}, respectively, to be called.

If the method is not static, the Java 'this' value will correspond to the JavaScript 'this' value. Any attempt to call the function with a 'this' value that is not of the right Java type will result in an error.

=== Variable arguments number ===
The second form is the variable arguments (or "varargs") form. The method must be a static Java method with parameters:

 (Context cx, Scriptable thisObj, Object[] args, Function funObj) 

;args
:parameter contains the arguments
;thisObj
:is the JavaScript 'this' value
;funObj
:is the function object for the invoked function.

The Java method should return an {{Class|java.lang.Object}} result.