jsni.h

Go to the documentation of this file.

// JavaScript Native Interface Release License.
//
// Copyright (c) 2015-2017 Alibaba Group. All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//     * Redistributions of source code must retain the above copyright
//       notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above copyright
//       notice, this list of conditions and the following disclaimer in the
//       documentation and/or other materials provided with the distribution.
//     * Neither the name of the Alibaba Group nor the
//       names of its contributors may be used to endorse or promote products
//       derived from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
// DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
// (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
// LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
// ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


#ifndef INCLUDE_JSNI_H_
#define INCLUDE_JSNI_H_

// For size_t.
#include <stddef.h>
// For bool.
#include <stdbool.h>
// For uint16_t.
#include <stdint.h>

typedef struct _JSValueRef* JSValueRef;

typedef struct _JSNIEnv JSNIEnv;

typedef void (*JSNIGCCallback)(JSNIEnv*, void*);

typedef struct _JSNICallbackInfo* JSNICallbackInfo;

typedef void (*JSNICallback)(JSNIEnv*, const JSNICallbackInfo);

typedef struct _JSGlobalValueRef* JSGlobalValueRef;

typedef enum {
  JsArrayTypeNone,
  JsArrayTypeInt8,
  JsArrayTypeUint8,
  JsArrayTypeUint8Clamped,
  JsArrayTypeInt16,
  JsArrayTypeUint16,
  JsArrayTypeInt32,
  JsArrayTypeUint32,
  JsArrayTypeFloat32,
  JsArrayTypeFloat64
} JsTypedArrayType;

typedef enum {
  JSNINone       = 0,
  JSNIReadOnly   = 1 << 0,
  JSNIDontEnum   = 1 << 1,
  JSNIDontDelete = 1 << 2
} JSNIPropertyAttributes;

typedef struct {
  JSValueRef value;
  JSNIPropertyAttributes attributes;
} JSNIDataPropertyDescriptor;

typedef struct {
  JSNICallback getter;
  JSNICallback setter;
  JSNIPropertyAttributes attributes;
  void* data;
} JSNIAccessorPropertyDescriptor;

typedef struct {
  JSNIDataPropertyDescriptor* data_attributes;
  JSNIAccessorPropertyDescriptor* accessor_attributes;
} JSNIPropertyDescriptor;

typedef enum {
  JSNIOK,
  JSNIERR
} JSNIErrorCode;

typedef struct {
  const char* msg;
  JSNIErrorCode error_code;
} JSNIErrorInfo;


#if defined(__cplusplus)
extern "C" {
#endif

int JSNIGetVersion(JSNIEnv* env);

bool JSNIRegisterMethod(JSNIEnv* env, const JSValueRef recv, const char* name, JSNICallback callback);

int JSNIGetArgsLengthOfCallback(JSNIEnv* env, JSNICallbackInfo info);

JSValueRef JSNIGetArgOfCallback(JSNIEnv* env, JSNICallbackInfo info, int id);

JSValueRef JSNIGetThisOfCallback(JSNIEnv* env, JSNICallbackInfo info);

void* JSNIGetDataOfCallback(JSNIEnv* env, JSNICallbackInfo info);

void JSNISetReturnValue(JSNIEnv* env, JSNICallbackInfo info, JSValueRef val);

bool JSNIIsUndefined(JSNIEnv* env, JSValueRef val);

JSValueRef JSNINewUndefined(JSNIEnv* env);

bool JSNIIsNull(JSNIEnv* env, JSValueRef val);

JSValueRef JSNINewNull(JSNIEnv* env);

bool JSNIIsBoolean(JSNIEnv* env, JSValueRef val);

bool JSNIToCBool(JSNIEnv* env, JSValueRef val);

JSValueRef JSNINewBoolean(JSNIEnv* env, bool val);

bool JSNIIsNumber(JSNIEnv* env, JSValueRef val);

JSValueRef JSNINewNumber(JSNIEnv* env, double val);

double JSNIToCDouble(JSNIEnv* env, JSValueRef val);

int32_t JSNIToInt32(JSNIEnv* env, JSValueRef val);

uint32_t JSNIToUint32(JSNIEnv* env, JSValueRef val);

int64_t JSNIToInt64(JSNIEnv* env, JSValueRef val);

bool JSNIIsSymbol(JSNIEnv* env, JSValueRef val);

JSValueRef JSNINewSymbol(JSNIEnv* env, JSValueRef val);

bool JSNIIsString(JSNIEnv* env, JSValueRef val);

JSValueRef JSNINewStringFromUtf8(JSNIEnv* env, const char* src, size_t length);

size_t JSNIGetStringUtf8Length(JSNIEnv* env, JSValueRef string);

size_t JSNIGetStringUtf8Chars(JSNIEnv* env, JSValueRef string, char* copy, size_t length);

JSValueRef JSNINewString(JSNIEnv* env, const uint16_t* src, size_t length);

size_t JSNIGetStringLength(JSNIEnv* env, JSValueRef string);

size_t JSNIGetString(JSNIEnv* env, JSValueRef string, uint16_t* copy, size_t length);

bool JSNIIsObject(JSNIEnv* env, JSValueRef val);

bool JSNIIsEmpty(JSNIEnv* env, JSValueRef val);

JSValueRef JSNINewObject(JSNIEnv* env);

bool JSNIHasProperty(JSNIEnv* env, JSValueRef object, const char* name);

JSValueRef JSNIGetProperty(JSNIEnv* env, JSValueRef object, const char* name);

bool JSNISetProperty(JSNIEnv* env, JSValueRef object, const char* name, JSValueRef property);

bool JSNIDefineProperty(JSNIEnv* env, JSValueRef object, const char* name, const JSNIPropertyDescriptor descriptor);

bool JSNIDeleteProperty(JSNIEnv* env, JSValueRef object, const char* name);

JSValueRef JSNIGetPrototype(JSNIEnv* env, JSValueRef object);

JSValueRef JSNINewObjectWithInternalField(JSNIEnv* env, int count);

int JSNIInternalFieldCount(JSNIEnv* env, JSValueRef object);

void JSNISetInternalField(JSNIEnv* env, JSValueRef object, int index, void* field);

void* JSNIGetInternalField(JSNIEnv* env, JSValueRef object, int index);

bool JSNIIsFunction(JSNIEnv* env, JSValueRef val);

JSValueRef JSNINewFunction(JSNIEnv* env, JSNICallback callback);

JSValueRef JSNICallFunction(JSNIEnv* env, JSValueRef func, JSValueRef recv, int argc, JSValueRef* argv);

bool JSNIIsArray(JSNIEnv* env, JSValueRef val);

size_t JSNIGetArrayLength(JSNIEnv* env, JSValueRef array);

JSValueRef JSNINewArray(JSNIEnv* env, size_t initial_length);

JSValueRef JSNIGetArrayElement(JSNIEnv* env, JSValueRef array, size_t index);

void JSNISetArrayElement(JSNIEnv* env, JSValueRef array, size_t index, JSValueRef value);

bool JSNIIsTypedArray(JSNIEnv* env, JSValueRef val);

JSValueRef JSNINewTypedArray(JSNIEnv* env, JsTypedArrayType type, void* data, size_t length);

JsTypedArrayType JSNIGetTypedArrayType(JSNIEnv* env, JSValueRef typed_array);

void* JSNIGetTypedArrayData(JSNIEnv* env, JSValueRef typed_array);

size_t JSNIGetTypedArrayLength(JSNIEnv* env, JSValueRef typed_array);

void JSNIPushLocalScope(JSNIEnv* env);

void JSNIPopLocalScope(JSNIEnv* env);

void JSNIPushEscapableLocalScope(JSNIEnv* env);

JSValueRef JSNIPopEscapableLocalScope(JSNIEnv* env, JSValueRef val);

JSGlobalValueRef JSNINewGlobalValue(JSNIEnv* env, JSValueRef val);

void JSNIDeleteGlobalValue(JSNIEnv* env, JSGlobalValueRef val);

size_t JSNIAcquireGlobalValue(JSNIEnv* env, JSGlobalValueRef val);

size_t JSNIReleaseGlobalValue(JSNIEnv* env, JSGlobalValueRef val);

JSValueRef JSNIGetGlobalValue(JSNIEnv* env, JSGlobalValueRef val);

void JSNISetGCCallback(JSNIEnv* env, JSGlobalValueRef val, void* args, JSNIGCCallback callback);

void JSNIThrowErrorException(JSNIEnv* env, const char* errmsg);

void JSNIThrowTypeErrorException(JSNIEnv* env, const char* errmsg);

void JSNIThrowRangeErrorException(JSNIEnv* env, const char* errmsg);

JSNIErrorInfo JSNIGetLastErrorInfo(JSNIEnv* env);

bool JSNIHasException(JSNIEnv* env);

void JSNIClearException(JSNIEnv* env);

JSValueRef JSNINewError(JSNIEnv* env, const char* errmsg);

JSValueRef JSNINewTypeError(JSNIEnv* env, const char* errmsg);

JSValueRef JSNINewRangeError(JSNIEnv* env, const char* errmsg);

void JSNIThrowErrorObject(JSNIEnv* env, JSValueRef error);

bool JSNIIsError(JSNIEnv* env, JSValueRef val);

JSValueRef JSNINewInstance(JSNIEnv* env, JSValueRef constructor, int argc, JSValueRef* argv);

bool JSNIInstanceOf(JSNIEnv* env, JSValueRef left, JSValueRef right);

JSValueRef JSNIGetNewTarget(JSNIEnv* env, JSNICallbackInfo info);

bool JSNIStrictEquals(JSNIEnv* env, JSValueRef left, JSValueRef right);

JSValueRef JSNINewArrayBuffer(JSNIEnv* env, size_t length);

JSValueRef JSNINewArrayBufferExternalized(JSNIEnv* env, void* data, size_t length);

bool JSNIIsArrayBuffer(JSNIEnv* env, JSValueRef val);

void* JSNIGetArrayBufferData(JSNIEnv* env, JSValueRef val);

size_t JSNIGetArrayBufferLength(JSNIEnv* env, JSValueRef val);

JSValueRef JSNIGetPropertyNames(JSNIEnv* env, JSValueRef val);

#if defined(__cplusplus)
}
#endif

struct _JSNIEnv {
  void* reserved;
};

// JSNI Versions.
#define JSNI_VERSION_1_0 0x00010000

#define JSNI_VERSION_1_1 0x00010001


#define JSNI_VERSION_2_0 0x00020000

#define JSNI_VERSION_2_1 0x00020001

#define JSNI_VERSION_2_2 0x00020002

#define JSNI_VERSION_2_3 0x00020003

#if defined(__cplusplus)
extern "C" {
#endif

int JSNIInit(JSNIEnv* env, JSValueRef exports);

#if defined(__cplusplus)
}
#endif

#endif  // INCLUDE_JSNI_H_