35c09cd6a6f2266e7b1a7cd1d0f0fb557da9d9a4
[WebKit-https.git] / Source / WebCore / bindings / scripts / test / TestObj.idl
1 /*
2  * Copyright (C) 2009 Google Inc. All rights reserved.
3  * Copyright (C) 2010 Apple Inc. All rights reserved.
4  *
5  * Redistribution and use in source and binary formstrArg, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1.  Redistributions of source code must retain the above copyright
10  *     notice, this list of conditions and the following disclaimer.
11  * 2.  Redistributions in binary form must reproduce the above copyright
12  *     notice, this list of conditions and the following disclaimer in the
13  *     documentation and/or other materials provided with the distribution.
14  * 3.  Neither the name of Apple Inc. ("Apple") nor the names of
15  *     its contributors may be used to endorse or promote products derived
16  *     from this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
19  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
22  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
25  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  */
29
30 // This IDL file is for testing the bindings code generator and for tracking
31 // changes in its ouput.
32
33 enum TestEnumType { "", "EnumValue1", "EnumValue2", "EnumValue3" };
34
35 // Leading underscore on an enum should be removed.
36 enum _optional { "", "OptionalValue1", "OptionalValue2", "OptionalValue3" };
37
38 [
39     Constructor(TestCallback testCallback, TestCallbackFunction testCallbackFunction),
40     InterfaceName=TestObject
41 ] interface TestObj {
42     // Attributes
43     readonly attribute long            readOnlyLongAttr;
44     readonly attribute DOMString       readOnlyStringAttr;
45     readonly attribute TestObj         readOnlyTestObjAttr;
46     static readonly attribute long     staticReadOnlyLongAttr;
47     static attribute DOMString         staticStringAttr;
48     static readonly attribute TestSubObjConstructor TestSubObj;
49     [EnabledBySetting=TestSetting] attribute TestSubObjConstructor TestSubObjEnabledBySetting;
50     attribute TestEnumType             enumAttr;
51     attribute byte                     byteAttr;
52     attribute octet                    octetAttr;
53     attribute short                    shortAttr;
54     attribute unsigned short           unsignedShortAttr;
55     attribute long                     longAttr;
56     attribute long long                longLongAttr;
57     attribute unsigned long long       unsignedLongLongAttr;
58     attribute DOMString                stringAttr;
59     attribute TestObj testObjAttr;
60
61     // WK_ucfirst, WK_lcfirst exceptional cases.
62     attribute TestObj                  XMLObjAttr;
63     attribute boolean                  create;
64
65     // Reflected DOM attributes
66     [Reflect] attribute DOMString reflectedStringAttr;
67     [Reflect] attribute long reflectedIntegralAttr;
68     [Reflect] attribute unsigned long reflectedUnsignedIntegralAttr;
69     [Reflect] attribute boolean reflectedBooleanAttr;
70     [Reflect, URL] attribute DOMString reflectedURLAttr;
71     [Reflect=customContentStringAttr] attribute DOMString reflectedStringAttr;
72     [Reflect=customContentIntegralAttr] attribute long reflectedCustomIntegralAttr;
73     [Reflect=customContentBooleanAttr] attribute boolean reflectedCustomBooleanAttr;
74     [Reflect=customContentURLAttr, URL] attribute DOMString reflectedCustomURLAttr;
75
76     // TypedArray attribute
77     attribute Float32Array typedArrayAttr;
78
79     // Methods
80     void    voidMethod();
81     void    voidMethodWithArgs(long longArg, DOMString strArg, TestObj objArg);
82     byte    byteMethod();
83     byte    byteMethodWithArgs(byte byteArg, DOMString strArg, TestObj objArg);
84     octet   octetMethod();
85     octet   octetMethodWithArgs(octet octetArg, DOMString strArg, TestObj objArg);
86     long    longMethod();
87     long    longMethodWithArgs(long longArg, DOMString strArg, TestObj objArg);
88     TestObj objMethod();
89     TestObj objMethodWithArgs(long longArg, DOMString strArg, TestObj objArg);
90
91     void methodWithSequenceArg(sequence<ScriptProfile> sequenceArg);
92     sequence<ScriptProfile> methodReturningSequence(long longArg);
93
94     void methodWithEnumArg(TestEnumType enumArg);
95     void methodWithOptionalEnumArgAndDefaultValue(optional TestEnumType enumArg = "EnumValue1");
96     [RaisesException] TestObj methodThatRequiresAllArgsAndThrows(DOMString strArg, TestObj objArg);
97
98     void serializedValue(SerializedScriptValue serializedArg);
99     void optionsObject(Dictionary oo, optional Dictionary ooo);
100
101     // Exceptions
102     [RaisesException] void methodWithException();
103     [GetterRaisesException] attribute long attrWithGetterException;
104     [SetterRaisesException] attribute long attrWithSetterException;
105     [GetterRaisesException] attribute DOMString stringAttrWithGetterException;
106     [SetterRaisesException] attribute DOMString stringAttrWithSetterException;
107
108     // Strict type checking.
109     [StrictTypeChecking] attribute TestObj strictTypeCheckingAttribute;
110
111     // 'Custom' extended attribute
112     [Custom] attribute long            customAttr;
113     [Custom] void customMethod();
114     [Custom] void customMethodWithArgs(long longArg, DOMString strArg, TestObj objArg);
115
116     // 'CustomBinding' extended attribute
117     [CustomBinding] void customBindingMethod();
118     [CustomBinding] void customBindingMethodWithArgs(long longArg, DOMString strArg, TestObj objArg);
119
120     void addEventListener(DOMString type, EventListener listener, optional boolean useCapture);
121     void removeEventListener(DOMString type, EventListener listener, optional boolean useCapture);
122     attribute EventHandler onfoo;
123
124     // 'CallWith' extended attribute
125     [CallWith=ScriptState] void withScriptStateVoid();
126     [CallWith=ScriptState] TestObj withScriptStateObj();
127     [CallWith=ScriptState, RaisesException] void withScriptStateVoidException();
128     [CallWith=ScriptState, RaisesException] TestObj withScriptStateObjException();
129     [CallWith=ScriptExecutionContext] void withScriptExecutionContext();
130     [CallWith=ScriptExecutionContext&ScriptState] void withScriptExecutionContextAndScriptState();
131     [CallWith=ScriptExecutionContext&ScriptState, RaisesException] TestObj withScriptExecutionContextAndScriptStateObjException();
132     [CallWith=  ScriptExecutionContext  &  ScriptState  ] TestObj withScriptExecutionContextAndScriptStateWithSpaces();
133     [CallWith=ScriptArguments&CallStack] void withScriptArgumentsAndCallStack();
134
135     [CallWith=ScriptState] attribute long withScriptStateAttribute;
136     [CallWith=ScriptState, SetterCallWith=ActiveWindow&FirstWindow] attribute long withCallWithAndSetterCallWithAttribute;
137     [CallWith=ScriptExecutionContext] attribute TestObj withScriptExecutionContextAttribute;
138     [CallWith=ScriptState, GetterRaisesException] attribute TestObj withScriptStateAttributeRaises;
139     [CallWith=ScriptExecutionContext, GetterRaisesException] attribute TestObj withScriptExecutionContextAttributeRaises;
140     [CallWith=ScriptExecutionContext&ScriptState] attribute TestObj withScriptExecutionContextAndScriptStateAttribute;
141     [CallWith=ScriptExecutionContext&ScriptState,GetterRaisesException] attribute TestObj withScriptExecutionContextAndScriptStateAttributeRaises;
142     [CallWith=  ScriptExecutionContext  &  ScriptState  ] attribute TestObj withScriptExecutionContextAndScriptStateWithSpacesAttribute;
143     [CallWith=ScriptArguments&CallStack] attribute TestObj withScriptArgumentsAndCallStackAttribute;
144
145     // Optional parameters.
146     void    methodWithOptionalArg(optional long opt);
147     void    methodWithOptionalArgAndDefaultValue(optional long opt = 666);
148     void    methodWithNonOptionalArgAndOptionalArg(long nonOpt, optional long opt);
149     void    methodWithNonOptionalArgAndTwoOptionalArgs(long nonOpt, optional long opt1, optional long opt2);
150     void    methodWithOptionalString(optional DOMString str);
151     void    methodWithOptionalStringAndDefaultValue(optional DOMString str = "foo");
152     void    methodWithOptionalStringIsUndefined([Default=Undefined] optional DOMString str);
153     void    methodWithOptionalStringIsNullString([Default=NullString] optional DOMString str);
154
155 #if defined(TESTING_JS)
156     // Callback interface parameters.
157     void    methodWithCallbackArg(TestCallback callback);
158     void    methodWithNonCallbackArgAndCallbackArg(long nonCallback, TestCallback callback);
159     void    methodWithCallbackAndOptionalArg(optional TestCallback callback);
160
161     // Callback function parameters.
162     void    methodWithCallbackFunctionArg(TestCallbackFunction callback);
163     void    methodWithNonCallbackArgAndCallbackFunctionArg(long nonCallback, TestCallbackFunction callback);
164     void    methodWithCallbackFunctionAndOptionalArg(optional TestCallbackFunction callback);
165
166     // static methods with 'Callback' extended attribute
167     static void    staticMethodWithCallbackAndOptionalArg(optional TestCallback callback);
168     static void    staticMethodWithCallbackArg(TestCallback callback);
169 #endif
170
171     // 'Conditional' extended attribute
172     [Conditional=Condition1] attribute long conditionalAttr1;
173     [Conditional=Condition1&Condition2] attribute long conditionalAttr2;
174     [Conditional=Condition1|Condition2] attribute long conditionalAttr3;
175
176     // 'Conditional' extended method
177     [Conditional=Condition1] DOMString conditionalMethod1();
178     [Conditional=Condition1&Condition2] void conditionalMethod2();
179     [Conditional=Condition1|Condition2] void conditionalMethod3();
180
181     [Conditional=Condition1] attribute TestObjectAConstructor conditionalAttr4;
182     [Conditional=Condition1&Condition2] attribute TestObjectBConstructor conditionalAttr5;
183     [Conditional=Condition1|Condition2] attribute TestObjectCConstructor conditionalAttr6;
184
185     [Conditional=Condition1] const unsigned short CONDITIONAL_CONST = 0;
186
187 #if defined(TESTING_JS)
188     [CachedAttribute] readonly attribute any cachedAttribute1;
189     [CachedAttribute] readonly attribute any cachedAttribute2;
190 #endif
191     
192     attribute any anyAttribute;
193
194 #if defined(TESTING_JS)
195     // Overloads
196     void    overloadedMethod(TestObj? objArg, [StrictTypeChecking] DOMString strArg);
197     void    overloadedMethod(TestObj? objArg, optional long longArg);
198     void    overloadedMethod([StrictTypeChecking] DOMString strArg);
199     void    overloadedMethod(long longArg);
200     void    overloadedMethod(TestCallback callback);
201     void    overloadedMethod(DOMStringList? listArg);
202     void    overloadedMethod(DOMString[]? arrayArg);
203     void    overloadedMethod(TestObj objArg);
204     void    overloadedMethod(DOMString[] arrayArg);
205     void    overloadedMethod(sequence<unsigned long> arrayArg);
206     void    overloadedMethod(DOMString strArg);
207
208     // FIXME: Implement support for overloaded functions with variadic arguments.
209     void    overloadedMethod(Blob... blobArgs);
210
211     void overloadedMethodWithOptionalParameter(TestObj? objArg1, optional TestObj? objArg2);
212     void overloadedMethodWithOptionalParameter(TestObj? objArg, optional long longArg);
213 #endif
214
215     // Class methods within JavaScript (like what's used for IDBKeyRange).
216     static void classMethod();
217     static long classMethodWithOptional(optional long arg);
218     [Custom] static void classMethod2(long arg);
219
220     // Static method with conditional on overloaded methods
221     [Conditional=Condition1] static void overloadedMethod1(long arg);
222     [Conditional=Condition1] static void overloadedMethod1([StrictTypeChecking] DOMString type);
223
224     void classMethodWithClamp([Clamp] unsigned short objArgsShort, [Clamp] unsigned long objArgsLong);
225
226 #if defined(TESTING_JS)
227     void methodWithUnsignedLongSequence(sequence<unsigned long> unsignedLongSequence);
228     [RaisesException] DOMString[] stringArrayFunction(DOMString[] values);
229     [RaisesException] DOMStringList domStringListFunction(DOMStringList values);
230
231     void methodWithAndWithoutNullableSequence(sequence<unsigned long> arrayArg, sequence<unsigned long>? nullableArrayArg);
232     void methodWithAndWithoutNullableSequence2(unsigned long[] arrayArg, unsigned long[]? nullableArrayArg);
233 #endif
234
235     [CheckSecurityForNode] readonly attribute Document contentDocument;
236     [CheckSecurityForNode, RaisesException] SVGDocument getSVGDocument();
237
238     void convert1([TreatReturnedNullStringAs=Null] TestNode value);
239     void convert2([TreatReturnedNullStringAs=Undefined] TestNode value);
240     void convert4([TreatNullAs=NullString] TestNode value);
241     void convert5([TreatNullAs=NullString, TreatUndefinedAs=NullString] TestNode value);
242
243     attribute SVGPoint mutablePoint;
244     [Immutable] attribute SVGPoint immutablePoint;
245     SVGPoint mutablePointFunction();
246     [Immutable] SVGPoint immutablePointFunction();
247
248     [ImplementedAs=banana] void orange();
249     [ImplementedAs=blueberry] attribute long strawberry;
250
251     [StrictTypeChecking] attribute unrestricted float strictFloat;
252     [StrictTypeChecking, RaisesException] bool strictFunction(DOMString str, unrestricted float a, long b);
253
254     [StrictTypeChecking, RaisesException] bool strictFunctionWithSequence(TestObj objArg, sequence<unsigned long> a);
255     [StrictTypeChecking, RaisesException] bool strictFunctionWithArray(TestObj objArg, long[] array);
256
257     // ObjectiveC reserved words.
258     readonly attribute long      description;
259     attribute long               id;
260     readonly attribute DOMString hash;
261
262     // Check constants and enums.
263     const unsigned short CONST_VALUE_0 = 0;
264     const unsigned short CONST_VALUE_1 = 1;
265     const unsigned short CONST_VALUE_2 = 2;
266     const unsigned short CONST_VALUE_4 = 4;
267     const unsigned short CONST_VALUE_8 = 8;
268     const short CONST_VALUE_9 = -1;
269     const unsigned short CONST_VALUE_11 = 0xffffffff;
270     const unsigned short CONST_VALUE_12 = 0x01;
271     const unsigned short CONST_VALUE_13 = 0X20;
272     const unsigned short CONST_VALUE_14 = 0x1abc;
273     [Reflect=CONST_IMPL] const unsigned short CONST_JAVASCRIPT = 15;
274
275     [Replaceable] readonly attribute long replaceableAttribute;
276
277     void variadicStringMethod(DOMString head, DOMString... tail);
278     void variadicDoubleMethod(unrestricted double head, unrestricted double... tail);
279     void variadicNodeMethod(Node head, Node... tail);
280
281     // Nullable attributes.
282     readonly attribute unrestricted double? nullableDoubleAttribute;
283     readonly attribute long? nullableLongAttribute;
284     readonly attribute boolean? nullableBooleanAttribute;
285     readonly attribute DOMString? nullableStringAttribute;
286
287     attribute long? nullableLongSettableAttribute;
288
289     [GetterRaisesException] attribute long? nullableStringValue;
290
291     // Identifiers with a leading underscore, which should be removed.
292     const unsigned short               _readonly = 0;
293     readonly attribute DOMString       _attribute;
294     attribute _optional                attributeWithReservedEnumType;
295     void _any(unrestricted float a, long b);
296
297     // Promise function
298     Promise testPromiseFunction();
299     Promise testPromiseFunctionWithFloatArgument(float a);
300     [RaisesException] Promise testPromiseFunctionWithException();
301     Promise testPromiseFunctionWithOptionalIntArgument(optional long a);
302
303     // PutForwards
304     [PutForwards=name] readonly attribute TestNode putForwardsAttribute;
305 };
306
307 // The following comment should not generate any code.
308 // TestObj implements TestImplements;
309