mirror of https://github.com/ImVexed/muon.git
145 lines
7.2 KiB
C
145 lines
7.2 KiB
C
|
/*
|
||
|
|
* Copyright (C) 2006 Apple Inc. All rights reserved.
|
||
|
|
*
|
||
|
|
* Redistribution and use in source and binary forms, with or without
|
||
|
|
* modification, are permitted provided that the following conditions
|
||
|
|
* are met:
|
||
|
|
* 1. Redistributions of source code must retain the above copyright
|
||
|
|
* notice, this list of conditions and the following disclaimer.
|
||
|
|
* 2. 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.
|
||
|
|
*
|
||
|
|
* THIS SOFTWARE IS PROVIDED BY APPLE INC. ``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 APPLE INC. OR
|
||
|
|
* CONTRIBUTORS 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 JSBase_h
|
||
|
|
#define JSBase_h
|
||
|
|
|
||
|
|
#ifndef __cplusplus
|
||
|
|
#include <stdbool.h>
|
||
|
|
#endif
|
||
|
|
|
||
|
|
#ifdef __OBJC__
|
||
|
|
#import <Foundation/Foundation.h>
|
||
|
|
#endif
|
||
|
|
|
||
|
|
/* JavaScript engine interface */
|
||
|
|
|
||
|
|
/*! @typedef JSContextGroupRef A group that associates JavaScript contexts with one another. Contexts in the same group may share and exchange JavaScript objects. */
|
||
|
|
typedef const struct OpaqueJSContextGroup* JSContextGroupRef;
|
||
|
|
|
||
|
|
/*! @typedef JSContextRef A JavaScript execution context. Holds the global object and other execution state. */
|
||
|
|
typedef const struct OpaqueJSContext* JSContextRef;
|
||
|
|
|
||
|
|
/*! @typedef JSGlobalContextRef A global JavaScript execution context. A JSGlobalContext is a JSContext. */
|
||
|
|
typedef struct OpaqueJSContext* JSGlobalContextRef;
|
||
|
|
|
||
|
|
/*! @typedef JSStringRef A UTF16 character buffer. The fundamental string representation in JavaScript. */
|
||
|
|
typedef struct OpaqueJSString* JSStringRef;
|
||
|
|
|
||
|
|
/*! @typedef JSClassRef A JavaScript class. Used with JSObjectMake to construct objects with custom behavior. */
|
||
|
|
typedef struct OpaqueJSClass* JSClassRef;
|
||
|
|
|
||
|
|
/*! @typedef JSPropertyNameArrayRef An array of JavaScript property names. */
|
||
|
|
typedef struct OpaqueJSPropertyNameArray* JSPropertyNameArrayRef;
|
||
|
|
|
||
|
|
/*! @typedef JSPropertyNameAccumulatorRef An ordered set used to collect the names of a JavaScript object's properties. */
|
||
|
|
typedef struct OpaqueJSPropertyNameAccumulator* JSPropertyNameAccumulatorRef;
|
||
|
|
|
||
|
|
/*! @typedef JSTypedArrayBytesDeallocator A function used to deallocate bytes passed to a Typed Array constructor. The function should take two arguments. The first is a pointer to the bytes that were originally passed to the Typed Array constructor. The second is a pointer to additional information desired at the time the bytes are to be freed. */
|
||
|
|
typedef void (*JSTypedArrayBytesDeallocator)(void* bytes, void* deallocatorContext);
|
||
|
|
|
||
|
|
/* JavaScript data types */
|
||
|
|
|
||
|
|
/*! @typedef JSValueRef A JavaScript value. The base type for all JavaScript values, and polymorphic functions on them. */
|
||
|
|
typedef const struct OpaqueJSValue* JSValueRef;
|
||
|
|
|
||
|
|
/*! @typedef JSObjectRef A JavaScript object. A JSObject is a JSValue. */
|
||
|
|
typedef struct OpaqueJSValue* JSObjectRef;
|
||
|
|
|
||
|
|
/* JavaScript symbol exports */
|
||
|
|
/* These rules should stay the same as in WebKit2/Shared/API/c/WKBase.h */
|
||
|
|
|
||
|
|
#undef JS_EXPORT
|
||
|
|
#if defined(JS_NO_EXPORT)
|
||
|
|
#define JS_EXPORT
|
||
|
|
#elif defined(__GNUC__) && !defined(__CC_ARM) && !defined(__ARMCC__)
|
||
|
|
#define JS_EXPORT __attribute__((visibility("default")))
|
||
|
|
#elif defined(WIN32) || defined(_WIN32) || defined(_WIN32_WCE) || defined(__CC_ARM) || defined(__ARMCC__)
|
||
|
|
#if defined(BUILDING_JavaScriptCore) || defined(STATICALLY_LINKED_WITH_JavaScriptCore)
|
||
|
|
#define JS_EXPORT __declspec(dllexport)
|
||
|
|
#else
|
||
|
|
#define JS_EXPORT __declspec(dllimport)
|
||
|
|
#endif
|
||
|
|
#else /* !defined(JS_NO_EXPORT) */
|
||
|
|
#define JS_EXPORT
|
||
|
|
#endif /* defined(JS_NO_EXPORT) */
|
||
|
|
|
||
|
|
#ifdef __cplusplus
|
||
|
|
extern "C" {
|
||
|
|
#endif
|
||
|
|
|
||
|
|
/* Script Evaluation */
|
||
|
|
|
||
|
|
/*!
|
||
|
|
@function JSEvaluateScript
|
||
|
|
@abstract Evaluates a string of JavaScript.
|
||
|
|
@param ctx The execution context to use.
|
||
|
|
@param script A JSString containing the script to evaluate.
|
||
|
|
@param thisObject The object to use as "this," or NULL to use the global object as "this."
|
||
|
|
@param sourceURL A JSString containing a URL for the script's source file. This is used by debuggers and when reporting exceptions. Pass NULL if you do not care to include source file information.
|
||
|
|
@param startingLineNumber An integer value specifying the script's starting line number in the file located at sourceURL. This is only used when reporting exceptions. The value is one-based, so the first line is line 1 and invalid values are clamped to 1.
|
||
|
|
@param exception A pointer to a JSValueRef in which to store an exception, if any. Pass NULL if you do not care to store an exception.
|
||
|
|
@result The JSValue that results from evaluating script, or NULL if an exception is thrown.
|
||
|
|
*/
|
||
|
|
JS_EXPORT JSValueRef JSEvaluateScript(JSContextRef ctx, JSStringRef script, JSObjectRef thisObject, JSStringRef sourceURL, int startingLineNumber, JSValueRef* exception);
|
||
|
|
|
||
|
|
/*!
|
||
|
|
@function JSCheckScriptSyntax
|
||
|
|
@abstract Checks for syntax errors in a string of JavaScript.
|
||
|
|
@param ctx The execution context to use.
|
||
|
|
@param script A JSString containing the script to check for syntax errors.
|
||
|
|
@param sourceURL A JSString containing a URL for the script's source file. This is only used when reporting exceptions. Pass NULL if you do not care to include source file information in exceptions.
|
||
|
|
@param startingLineNumber An integer value specifying the script's starting line number in the file located at sourceURL. This is only used when reporting exceptions. The value is one-based, so the first line is line 1 and invalid values are clamped to 1.
|
||
|
|
@param exception A pointer to a JSValueRef in which to store a syntax error exception, if any. Pass NULL if you do not care to store a syntax error exception.
|
||
|
|
@result true if the script is syntactically correct, otherwise false.
|
||
|
|
*/
|
||
|
|
JS_EXPORT bool JSCheckScriptSyntax(JSContextRef ctx, JSStringRef script, JSStringRef sourceURL, int startingLineNumber, JSValueRef* exception);
|
||
|
|
|
||
|
|
/*!
|
||
|
|
@function JSGarbageCollect
|
||
|
|
@abstract Performs a JavaScript garbage collection.
|
||
|
|
@param ctx The execution context to use.
|
||
|
|
@discussion JavaScript values that are on the machine stack, in a register,
|
||
|
|
protected by JSValueProtect, set as the global object of an execution context,
|
||
|
|
or reachable from any such value will not be collected.
|
||
|
|
|
||
|
|
During JavaScript execution, you are not required to call this function; the
|
||
|
|
JavaScript engine will garbage collect as needed. JavaScript values created
|
||
|
|
within a context group are automatically destroyed when the last reference
|
||
|
|
to the context group is released.
|
||
|
|
*/
|
||
|
|
JS_EXPORT void JSGarbageCollect(JSContextRef ctx);
|
||
|
|
|
||
|
|
#ifdef __cplusplus
|
||
|
|
}
|
||
|
|
#endif
|
||
|
|
|
||
|
|
/* Enable the Objective-C API for platforms with a modern runtime. */
|
||
|
|
#if !defined(JSC_OBJC_API_ENABLED)
|
||
|
|
#define JSC_OBJC_API_ENABLED (defined(__clang__) && defined(__APPLE__) && ((defined(__MAC_OS_X_VERSION_MIN_REQUIRED) && !defined(__i386__)) || (defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE)))
|
||
|
|
#endif
|
||
|
|
|
||
|
|
#endif /* JSBase_h */
|