Reviewed by Darin.
[WebKit-https.git] / JavaScriptGlue / JavaScriptGlue.h
1 /*
2  * Copyright (C) 2005 Apple Computer, Inc.  All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
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  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission. 
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #ifndef JAVASCRIPTGLUE_H
30 #define JAVASCRIPTGLUE_H
31
32 #ifndef __CORESERVICES__
33 #include <CoreServices/CoreServices.h>
34 #endif
35
36 #ifdef __cplusplus
37 extern "C" {
38 #endif
39
40 /* typedefs/structs */
41 typedef enum {
42     kJSFlagNone = 0,
43     kJSFlagDebug = 1 << 0,
44     kJSFlagConvertAssociativeArray = 1 << 1 /* associative arrays will be converted to dictionaries */
45 } JSFlags;
46
47 typedef struct OpaqueJSTypeRef *JSTypeRef;
48 typedef JSTypeRef JSObjectRef;
49 typedef JSTypeRef JSRunRef;
50 typedef CFTypeID JSTypeID;
51
52 typedef void (*JSObjectDisposeProcPtr)(void *data);
53 typedef CFArrayRef (*JSObjectCopyPropertyNamesProcPtr)(void *data);
54 typedef JSObjectRef (*JSObjectCopyPropertyProcPtr)(void *data, CFStringRef propertyName);
55 typedef void (*JSObjectSetPropertyProcPtr)(void *data, CFStringRef propertyName, JSObjectRef jsValue);
56 typedef JSObjectRef (*JSObjectCallFunctionProcPtr)(void *data, JSObjectRef thisObj, CFArrayRef args);
57 typedef CFTypeRef (*JSObjectCopyCFValueProcPtr)(void *data);
58 typedef UInt8 (*JSObjectEqualProcPtr)(void *data1, void *data2);
59
60 struct JSObjectCallBacks {
61     JSObjectDisposeProcPtr dispose;
62     JSObjectEqualProcPtr equal;
63     JSObjectCopyCFValueProcPtr copyCFValue;
64     JSObjectCopyPropertyProcPtr copyProperty;
65     JSObjectSetPropertyProcPtr setProperty;
66     JSObjectCallFunctionProcPtr callFunction;
67     JSObjectCopyPropertyNamesProcPtr copyPropertyNames;
68 };
69 typedef struct JSObjectCallBacks JSObjectCallBacks, *JSObjectCallBacksPtr;
70
71 void JSSetCFNull(CFTypeRef nullRef);
72 CFTypeRef JSGetCFNull(void);
73
74 JSTypeRef JSRetain(JSTypeRef ref);
75 void JSRelease(JSTypeRef ref);
76 JSTypeID JSGetTypeID(JSTypeRef ref);
77 CFIndex JSGetRetainCount(JSTypeRef ref);
78 CFStringRef JSCopyDescription(JSTypeRef ref);
79 UInt8 JSEqual(JSTypeRef ref1, JSTypeRef ref2);
80
81 JSObjectRef JSObjectCreate(void *data, JSObjectCallBacksPtr callBacks);
82 JSObjectRef JSObjectCreateWithCFType(CFTypeRef inRef);
83 CFTypeRef JSObjectCopyCFValue(JSObjectRef ref);
84 void *JSObjectGetData(JSObjectRef ref);
85
86 CFArrayRef JSObjectCopyPropertyNames(JSObjectRef ref);
87 JSObjectRef JSObjectCopyProperty(JSObjectRef ref, CFStringRef propertyName);
88 void JSObjectSetProperty(JSObjectRef ref, CFStringRef propertyName, JSObjectRef value);
89 JSObjectRef JSObjectCallFunction(JSObjectRef ref, JSObjectRef thisObj, CFArrayRef args);
90
91 JSRunRef JSRunCreate(CFStringRef jsSource, JSFlags inFlags);
92 CFStringRef JSRunCopySource(JSRunRef ref);
93 JSObjectRef JSRunCopyGlobalObject(JSRunRef ref);
94 JSObjectRef JSRunEvaluate(JSRunRef ref);
95 bool JSRunCheckSyntax(JSRunRef ref);
96
97 void JSCollect(void);
98
99 void JSTypeGetCFArrayCallBacks(CFArrayCallBacks *outCallBacks);
100
101 CFMutableArrayRef JSCreateCFArrayFromJSArray(CFArrayRef array);
102 CFMutableArrayRef JSCreateJSArrayFromCFArray(CFArrayRef array);
103
104 void JSLockInterpreter(void);
105 void JSUnlockInterpreter(void);
106
107 #ifdef __cplusplus
108 }
109 #endif
110
111 #endif