Move Symbol API to SPI
[WebKit-https.git] / Source / JavaScriptCore / API / JSValuePrivate.h
1 /*
2  * Copyright (C) 2018 Apple 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  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #if JSC_OBJC_API_ENABLED
27
28 #import <JavaScriptCore/JavaScriptCore.h>
29
30 @interface JSValue(JSPrivate)
31
32 #if (defined(__MAC_OS_X_VERSION_MIN_REQUIRED) && __MAC_OS_X_VERSION_MIN_REQUIRED < JSC_MAC_VERSION_TBA) || (defined(__IPHONE_OS_VERSION_MIN_REQUIRED) && __IPHONE_OS_VERSION_MIN_REQUIRED < JSC_IOS_VERSION_TBA)
33 typedef NSString *JSValueProperty;
34 #else
35 typedef id JSValueProperty;
36 #endif
37
38 /*!
39  @method
40  @abstract Create a new, unique, symbol object.
41  @param description The description of the symbol object being created.
42  @param context The JSContext to which the resulting JSValue belongs.
43  @result The JSValue representing a unique JavaScript value with type symbol.
44  */
45 + (JSValue *)valueWithNewSymbolFromDescription:(NSString *)description inContext:(JSContext *)context JSC_API_AVAILABLE(macosx(JSC_MAC_TBA), ios(JSC_IOS_TBA));
46
47 /*!
48  @method
49  @abstract Access a property of a JSValue.
50  @result The JSValue for the requested property or the JSValue <code>undefined</code>
51  if the property does not exist.
52  @discussion Corresponds to the JavaScript operation <code>object[property]</code>. After macOS TBA and iOS TBA, 'property' can be any 'id' and will be converted to a JSValue using the conversion rules of <code>valueWithObject:inContext:</code>. Prior to macOS TBA and iOS TBA, 'property' was expected to be an NSString *.
53  */
54 - (JSValue *)valueForProperty:(JSValueProperty)property;
55
56 /*!
57  @method
58  @abstract Set a property on a JSValue.
59  @discussion Corresponds to the JavaScript operation <code>object[property] = value</code>. After macOS TBA and iOS TBA, 'property' can be any 'id' and will be converted to a JSValue using the conversion rules of <code>valueWithObject:inContext:</code>. Prior to macOS TBA and iOS TBA, 'property' was expected to be an NSString *.
60  */
61 - (void)setValue:(id)value forProperty:(JSValueProperty)property;
62
63 /*!
64  @method
65  @abstract Delete a property from a JSValue.
66  @result YES if deletion is successful, NO otherwise.
67  @discussion Corresponds to the JavaScript operation <code>delete object[property]</code>. After macOS TBA and iOS TBA, 'property' can be any 'id' and will be converted to a JSValue using the conversion rules of <code>valueWithObject:inContext:</code>. Prior to macOS TBA and iOS TBA, 'property' was expected to be an NSString *.
68  */
69 - (BOOL)deleteProperty:(JSValueProperty)property;
70
71 /*!
72  @method
73  @abstract Check if a JSValue has a property.
74  @discussion This method has the same function as the JavaScript operator <code>in</code>.
75  @result Returns YES if property is present on the value.
76  @discussion Corresponds to the JavaScript operation <code>property in object</code>. After macOS TBA and iOS TBA, 'property' can be any 'id' and will be converted to a JSValue using the conversion rules of <code>valueWithObject:inContext:</code>. Prior to macOS TBA and iOS TBA, 'property' was expected to be an NSString *.
77  */
78 - (BOOL)hasProperty:(JSValueProperty)property;
79
80 /*!
81  @method
82  @abstract Define properties with custom descriptors on JSValues.
83  @discussion This method may be used to create a data or accessor property on an object.
84  This method operates in accordance with the Object.defineProperty method in the JavaScript language. After macOS TBA and iOS TBA, 'property' can be any 'id' and will be converted to a JSValue using the conversion rules of <code>valueWithObject:inContext:</code>. Prior to macOS TBA and iOS TBA, 'property' was expected to be an NSString *.
85  */
86 - (void)defineProperty:(JSValueProperty)property descriptor:(id)descriptor;
87
88 /*!
89  @property
90  @abstract Check if a JSValue is a symbol.
91  */
92 @property (readonly) BOOL isSymbol JSC_API_AVAILABLE(macosx(JSC_MAC_TBA), ios(JSC_IOS_TBA));
93
94 /*!
95  @method
96  @abstract Create a new promise object using the provided executor callback.
97  @param callback A callback block invoked while the promise object is
98  being initialized. The resolve and reject parameters are functions that
99  can be called to notify any pending reactions about the state of the
100  new promise object.
101  @param context The JSContext to which the resulting JSValue belongs.
102  @result The JSValue representing a new promise JavaScript object.
103  @discussion This method is equivalent to calling the Promise constructor in JavaScript.
104  the resolve and reject callbacks each normally take a single value, which they
105  forward to all relevent pending reactions. While inside the executor callback context will act
106  as if it were in any other callback, except calleeFunction will be <code>nil</code>. This also means
107  means the new promise object may be accessed via <code>[context thisValue]</code>.
108  */
109 + (JSValue *)valueWithNewPromiseInContext:(JSContext *)context fromExecutor:(void (^)(JSValue *resolve, JSValue *reject))callback JSC_API_AVAILABLE(macosx(JSC_MAC_TBA), ios(JSC_IOS_TBA));
110
111 /*!
112  @method
113  @abstract Create a new resolved promise object with the provided value.
114  @param result The result value to be passed to any reactions.
115  @param context The JSContext to which the resulting JSValue belongs.
116  @result The JSValue representing a new promise JavaScript object.
117  @discussion This method is equivalent to calling <code>[JSValue valueWithNewPromiseFromExecutor:^(JSValue *resolve, JSValue *reject) { [resolve callWithArguments:@[result]]; } inContext:context]</code>
118  */
119 + (JSValue *)valueWithNewPromiseResolvedWithResult:(id)result inContext:(JSContext *)context JSC_API_AVAILABLE(macosx(JSC_MAC_TBA), ios(JSC_IOS_TBA));
120
121 /*!
122  @method
123  @abstract Create a new rejected promise object with the provided value.
124  @param reason The result value to be passed to any reactions.
125  @param context The JSContext to which the resulting JSValue belongs.
126  @result The JSValue representing a new promise JavaScript object.
127  @discussion This method is equivalent to calling <code>[JSValue valueWithNewPromiseFromExecutor:^(JSValue *resolve, JSValue *reject) { [reject callWithArguments:@[reason]]; } inContext:context]</code>
128  */
129 + (JSValue *)valueWithNewPromiseRejectedWithReason:(id)reason inContext:(JSContext *)context JSC_API_AVAILABLE(macosx(JSC_MAC_TBA), ios(JSC_IOS_TBA));
130
131 @end
132
133 /*!
134  @category
135  @discussion Instances of JSValue implement the following methods in order to enable
136  support for subscript access by key and index, for example:
137
138  @textblock
139  JSValue *objectA, *objectB;
140  JSValue *v1 = object[@"X"]; // Get value for property "X" from 'object'.
141  JSValue *v2 = object[42];   // Get value for index 42 from 'object'.
142  object[@"Y"] = v1;          // Assign 'v1' to property "Y" of 'object'.
143  object[101] = v2;           // Assign 'v2' to index 101 of 'object'.
144  @/textblock
145
146  An object key passed as a subscript will be converted to a JavaScript value,
147  and then the value using the same rules as <code>valueWithObject:inContext:</code>. In macOS
148  TBA and iOS TBA and below, the <code>key</code> argument of
149  <code>setObject:object forKeyedSubscript:key</code> was restricted to an
150  <code>NSString <NSCopying> *</code> but that restriction was never used.
151  */
152 @interface JSValue (SubscriptSupportPrivate)
153
154 - (JSValue *)objectForKeyedSubscript:(JSValueProperty)key;
155 - (JSValue *)objectAtIndexedSubscript:(NSUInteger)index;
156 - (void)setObject:(id)object forKeyedSubscript:(JSValueProperty)key;
157 - (void)setObject:(id)object atIndexedSubscript:(NSUInteger)index;
158
159 @end
160
161 #endif // JSC_OBJC_API_ENABLED