794da83c8dcc067467471a8a782e7f8a8a39fb6a
[WebKit-https.git] / JavaScriptCore / API / JSBase.h
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 JSBase_h
28 #define JSBase_h
29
30 /* JS runtime interface types */
31 typedef struct __JSContext* JSContextRef;
32 typedef struct __JSCharBuffer* JSCharBufferRef;
33 typedef struct __JSPropertyList* JSPropertyListRef;
34 typedef struct __JSPropertyListEnumerator* JSPropertyListEnumeratorRef;
35
36 /* Base type of all JS values, and polymorphic functions on them */
37 typedef void* JSValueRef;
38
39 typedef struct __JSObject* JSObjectRef;
40
41 #ifdef __cplusplus
42 extern "C" {
43 #endif
44
45 // Returns true for successful execution, false for uncaught exception. 
46 // returnValue will contain value of last evaluated statement or exception value.
47 bool JSEvaluate(JSContextRef context, JSValueRef thisValue, JSCharBufferRef script, JSCharBufferRef sourceURL, int startingLineNumber, JSValueRef* returnValue);
48 bool JSCheckSyntax(JSContextRef context, JSCharBufferRef script);
49
50 // Garbage collection
51 void JSGCProtect(JSValueRef value);
52 void JSGCUnprotect(JSValueRef value);
53 void JSGCCollect(void);
54
55 #ifdef __cplusplus
56 }
57 #endif
58
59 #endif // JSBase_h