| 1 | // -*- mode: c++; c-basic-offset: 4 -*-
|
|---|
| 2 | /*
|
|---|
| 3 | * Copyright (C) 2006 Apple Computer, Inc. All rights reserved.
|
|---|
| 4 | *
|
|---|
| 5 | * Redistribution and use in source and binary forms, with or without
|
|---|
| 6 | * modification, are permitted provided that the following conditions
|
|---|
| 7 | * are met:
|
|---|
| 8 | * 1. Redistributions of source code must retain the above copyright
|
|---|
| 9 | * notice, this list of conditions and the following disclaimer.
|
|---|
| 10 | * 2. Redistributions in binary form must reproduce the above copyright
|
|---|
| 11 | * notice, this list of conditions and the following disclaimer in the
|
|---|
| 12 | * documentation and/or other materials provided with the distribution.
|
|---|
| 13 | *
|
|---|
| 14 | * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
|
|---|
| 15 | * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|---|
| 16 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
|---|
| 17 | * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE COMPUTER, INC. OR
|
|---|
| 18 | * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
|
|---|
| 19 | * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
|
|---|
| 20 | * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
|
|---|
| 21 | * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
|
|---|
| 22 | * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|---|
| 23 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|---|
| 24 | * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|---|
| 25 | */
|
|---|
| 26 |
|
|---|
| 27 | #ifndef JSContextRef_h
|
|---|
| 28 | #define JSContextRef_h
|
|---|
| 29 |
|
|---|
| 30 | #include <JavaScriptCore/JSObjectRef.h>
|
|---|
| 31 | #include <JavaScriptCore/JSValueRef.h>
|
|---|
| 32 |
|
|---|
| 33 | #include <stdbool.h>
|
|---|
| 34 |
|
|---|
| 35 | #ifdef __cplusplus
|
|---|
| 36 | extern "C" {
|
|---|
| 37 | #endif
|
|---|
| 38 |
|
|---|
| 39 | /*!
|
|---|
| 40 | @function
|
|---|
| 41 | @abstract Creates a global JavaScript execution context.
|
|---|
| 42 | @discussion JSGlobalContextCreate allocates a global object and populates it with all the
|
|---|
| 43 | built-in JavaScript objects, such as Object, Function, String, and Array.
|
|---|
| 44 | @param globalObjectClass The class to use when creating the global object. Pass
|
|---|
| 45 | NULL to use the default object class.
|
|---|
| 46 | @result A JSGlobalContext with a global object of class globalObjectClass.
|
|---|
| 47 | */
|
|---|
| 48 | JS_EXPORT JSGlobalContextRef JSGlobalContextCreate(JSClassRef globalObjectClass);
|
|---|
| 49 |
|
|---|
| 50 | /*!
|
|---|
| 51 | @function
|
|---|
| 52 | @abstract Retains a global JavaScript execution context.
|
|---|
| 53 | @param ctx The JSGlobalContext to retain.
|
|---|
| 54 | @result A JSGlobalContext that is the same as ctx.
|
|---|
| 55 | */
|
|---|
| 56 | JS_EXPORT JSGlobalContextRef JSGlobalContextRetain(JSGlobalContextRef ctx);
|
|---|
| 57 |
|
|---|
| 58 | /*!
|
|---|
| 59 | @function
|
|---|
| 60 | @abstract Releases a global JavaScript execution context.
|
|---|
| 61 | @param ctx The JSGlobalContext to release.
|
|---|
| 62 | */
|
|---|
| 63 | JS_EXPORT void JSGlobalContextRelease(JSGlobalContextRef ctx);
|
|---|
| 64 |
|
|---|
| 65 | /*!
|
|---|
| 66 | @function
|
|---|
| 67 | @abstract Gets the global object of a JavaScript execution context.
|
|---|
| 68 | @param ctx The JSContext whose global object you want to get.
|
|---|
| 69 | @result ctx's global object.
|
|---|
| 70 | */
|
|---|
| 71 | JS_EXPORT JSObjectRef JSContextGetGlobalObject(JSContextRef ctx);
|
|---|
| 72 |
|
|---|
| 73 | #ifdef __cplusplus
|
|---|
| 74 | }
|
|---|
| 75 | #endif
|
|---|
| 76 |
|
|---|
| 77 | #endif // JSContextRef_h
|
|---|
