Register | Log in

Mozilla.com

  1. MDC
  2. Main Page
  3. SpiderMonkey
  4. JSAPI Reference
  5. JSFastNative
Table of contents
  1. 1. Syntax
  2. 2. Description
Redirected from En/JS ARGV

JSFastNative

Table of contents
  1. 1. Syntax
  2. 2. Description

JSFastNative is the type of fast native functions in the JSAPI. APIs such as JS_InitClass and JS_DefineFunctions can create custom methods that are implemented as C/C++ functions of this type, instead of JSNative.

The term "native" here refers to C/C++ code as opposed to JavaScript code.

Syntax

typedef JSBool (*JSFastNative)(JSContext *cx, uintN argc, jsval *vp);
Name Type Description
cx JSContext *

Pointer to the JS context in which execution is taking place.

Provides request. (In JS_THREADSAFE builds, the JS engine calls this callback only from within an active request on cx. The callback does not need to call JS_BeginRequest.)

argc uintN The number of arguments supplied to the function by the caller, as opposed to possibly the number of arguments the function is specified to take in its JSFunctionSpec.
vp jsval * The arguments, including the this argument, the return-value slot, and the callee Function object are accessible through this pointer using macros described below.

Description

The callback should use the following macros to access the fields of vp:

Macro name Description
JS_CALLEE(cx, vp) Returns the Function object that was called, as a jsval.

Native methods must not call JS_CALLEE after calling JS_SET_RVAL. (Otherwise the return value will be inspected instead of the callee function object.)
JS_THIS(cx, vp) Returns the this argument as a jsval, or NULL on error.
JS_THIS_OBJECT(cx, vp) Returns the this argument as a JSObject *.
JS_ARGV(cx, vp) Returns the argv pointer. This points to element 0 of an array of argc jsvals, the arguments supplied by the caller.
JS_RVAL(cx, vp) Returns the jsval that is currently in the return-value slot.
JS_SET_RVAL(cx, vp, value) Sets the return value of the native function. It is safe to call this multiple times within a single call to a JSFastNative. If the JSFastNative returns JS_TRUE, the last value passed to this macro will be returned to the caller.

On success, the callback must call JS_SET_RVAL (at least once) and return JS_TRUE. On error or exception, it must return JS_FALSE.

To create a JSFunctionSpec that points to a JSFastNative, use JS_FN.

Warning sign
Warning: When a JSFastNative is called, no stack frame is generated. This is what makes a fast native fast. It also means that applications that use SpiderMonkey's security features, particularly those that implement JSCheckAccessOp or JSCheckAccessIdOp in terms of APIs such as JS_FrameIterator and JS_StackFramePrincipals, must take extra care, as the native function's principals will be missing from the stack.

LXR ID Search for JSFastNative

Page last modified 20:09, 5 Sep 2008 by Jorend

Tags:

Files (0)