| /* |
| * Copyright (C) 2006 Apple Computer, 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 COMPUTER, 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 COMPUTER, 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 JSContextRef_h |
| #define JSContextRef_h |
| |
| #include <JavaScriptCore/JSObjectRef.h> |
| #include <JavaScriptCore/JSValueRef.h> |
| #include <JavaScriptCore/WebKitAvailability.h> |
| |
| #ifndef __cplusplus |
| #include <stdbool.h> |
| #endif |
| |
| #ifdef __cplusplus |
| extern "C" { |
| #endif |
| |
| /*! |
| @function |
| @abstract Creates a JavaScript context group. |
| @discussion A JSContextGroup associates JavaScript contexts with one another. |
| Contexts in the same group may share and exchange JavaScript objects. Sharing and/or exchanging |
| JavaScript objects between contexts in different groups will produce undefined behavior. |
| When objects from the same context group are used in multiple threads, explicit |
| synchronization is required. |
| @result The created JSContextGroup. |
| */ |
| JS_EXPORT JSContextGroupRef JSContextGroupCreate() AVAILABLE_IN_WEBKIT_VERSION_4_0; |
| |
| /*! |
| @function |
| @abstract Retains a JavaScript context group. |
| @param group The JSContextGroup to retain. |
| @result A JSContextGroup that is the same as group. |
| */ |
| JS_EXPORT JSContextGroupRef JSContextGroupRetain(JSContextGroupRef group) AVAILABLE_IN_WEBKIT_VERSION_4_0; |
| |
| /*! |
| @function |
| @abstract Releases a JavaScript context group. |
| @param group The JSContextGroup to release. |
| */ |
| JS_EXPORT void JSContextGroupRelease(JSContextGroupRef group) AVAILABLE_IN_WEBKIT_VERSION_4_0; |
| |
| #if !defined(__LB_SHELL__) && !OS(STARBOARD) |
| /*! |
| @function |
| @abstract Creates a global JavaScript execution context. |
| @discussion JSGlobalContextCreate allocates a global object and populates it with all the |
| built-in JavaScript objects, such as Object, Function, String, and Array. |
| |
| In WebKit version 4.0 and later, the context is created in a unique context group. |
| Therefore, scripts may execute in it concurrently with scripts executing in other contexts. |
| However, you may not use values created in the context in other contexts. |
| @param globalObjectClass The class to use when creating the global object. Pass |
| NULL to use the default object class. |
| @result A JSGlobalContext with a global object of class globalObjectClass. |
| */ |
| JS_EXPORT JSGlobalContextRef JSGlobalContextCreate(JSClassRef globalObjectClass) AVAILABLE_WEBKIT_VERSION_3_0_AND_LATER; |
| |
| /*! |
| @function |
| @abstract Creates a global JavaScript execution context in the context group provided. |
| @discussion JSGlobalContextCreateInGroup allocates a global object and populates it with |
| all the built-in JavaScript objects, such as Object, Function, String, and Array. |
| @param globalObjectClass The class to use when creating the global object. Pass |
| NULL to use the default object class. |
| @param group The context group to use. The created global context retains the group. |
| Pass NULL to create a unique group for the context. |
| @result A JSGlobalContext with a global object of class globalObjectClass and a context |
| group equal to group. |
| */ |
| JS_EXPORT JSGlobalContextRef JSGlobalContextCreateInGroup(JSContextGroupRef group, JSClassRef globalObjectClass) AVAILABLE_IN_WEBKIT_VERSION_4_0; |
| #endif |
| |
| /*! |
| @function |
| @abstract Retains a global JavaScript execution context. |
| @param ctx The JSGlobalContext to retain. |
| @result A JSGlobalContext that is the same as ctx. |
| */ |
| JS_EXPORT JSGlobalContextRef JSGlobalContextRetain(JSGlobalContextRef ctx); |
| |
| /*! |
| @function |
| @abstract Releases a global JavaScript execution context. |
| @param ctx The JSGlobalContext to release. |
| */ |
| JS_EXPORT void JSGlobalContextRelease(JSGlobalContextRef ctx); |
| |
| /*! |
| @function |
| @abstract Gets the global object of a JavaScript execution context. |
| @param ctx The JSContext whose global object you want to get. |
| @result ctx's global object. |
| */ |
| JS_EXPORT JSObjectRef JSContextGetGlobalObject(JSContextRef ctx); |
| |
| /*! |
| @function |
| @abstract Gets the context group to which a JavaScript execution context belongs. |
| @param ctx The JSContext whose group you want to get. |
| @result ctx's group. |
| */ |
| JS_EXPORT JSContextGroupRef JSContextGetGroup(JSContextRef ctx) AVAILABLE_IN_WEBKIT_VERSION_4_0; |
| |
| #ifdef __cplusplus |
| } |
| #endif |
| |
| #endif /* JSContextRef_h */ |