8ef1e6adcce0b5a5e61f5664f79ee57ccbae579f
[WebKit-https.git] / JavaScriptCore / API / JSValueRef.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 JSValueRef_h
28 #define JSValueRef_h
29
30 #include "JSBase.h"
31
32 // Value types
33 typedef enum {
34     kJSTypeUndefined,
35     kJSTypeNull,
36     kJSTypeBoolean,
37     kJSTypeNumber,
38     kJSTypeString,
39     kJSTypeObject
40 } JSTypeCode;
41
42 #ifdef __cplusplus
43 extern "C" {
44 #endif
45
46 JSTypeCode JSValueGetType(JSValueRef value);
47
48 bool JSValueIsUndefined(JSValueRef value);
49 bool JSValueIsNull(JSValueRef value);
50 bool JSValueIsBoolean(JSValueRef value);
51 bool JSValueIsNumber(JSValueRef value);
52 bool JSValueIsString(JSValueRef value);
53 bool JSValueIsObject(JSValueRef value);
54
55 // Comparing values
56 bool JSValueIsEqual(JSContextRef context, JSValueRef a, JSValueRef b);
57 bool JSValueIsStrictEqual(JSContextRef context, JSValueRef a, JSValueRef b);
58 bool JSValueIsInstanceOf(JSValueRef value, JSObjectRef object);
59
60 // Creating values
61 JSValueRef JSUndefinedMake(void);
62 JSValueRef JSNullMake(void);
63 JSValueRef JSBooleanMake(bool value);
64 JSValueRef JSNumberMake(double value);
65 JSValueRef JSStringMake(JSCharBufferRef buffer);
66
67 // Converting to primitive values
68 bool JSValueToBoolean(JSContextRef context, JSValueRef value);
69 double JSValueToNumber(JSContextRef context, JSValueRef value); // 0.0 if conversion fails
70 JSObjectRef JSValueToObject(JSContextRef context, JSValueRef value); // Error object if conversion fails
71 JSCharBufferRef JSValueCopyStringValue(JSContextRef context, JSValueRef value); // Empty string if conversion fails
72
73 #ifdef __cplusplus
74 }
75 #endif
76
77 #endif // JSValueRef_h